| /* SPDX-License-Identifier: GPL-2.0 |
| * |
| * soc-component.h |
| * |
| * Copyright (C) 2019 Renesas Electronics Corp. |
| * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com> |
| */ |
| #ifndef __SOC_COMPONENT_H |
| #define __SOC_COMPONENT_H |
| |
| #include <sound/soc.h> |
| |
| /* |
| * Component probe and remove ordering levels for components with runtime |
| * dependencies. |
| */ |
| #define SND_SOC_COMP_ORDER_FIRST -2 |
| #define SND_SOC_COMP_ORDER_EARLY -1 |
| #define SND_SOC_COMP_ORDER_NORMAL 0 |
| #define SND_SOC_COMP_ORDER_LATE 1 |
| #define SND_SOC_COMP_ORDER_LAST 2 |
| |
| #define for_each_comp_order(order) \ |
| for (order = SND_SOC_COMP_ORDER_FIRST; \ |
| order <= SND_SOC_COMP_ORDER_LAST; \ |
| order++) |
| |
| /* component interface */ |
| struct snd_compress_ops { |
| int (*open)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream); |
| int (*free)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream); |
| int (*set_params)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_compr_params *params); |
| int (*get_params)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_codec *params); |
| int (*set_metadata)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_compr_metadata *metadata); |
| int (*get_metadata)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_compr_metadata *metadata); |
| int (*trigger)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, int cmd); |
| int (*pointer)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_compr_tstamp *tstamp); |
| int (*copy)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, char __user *buf, |
| size_t count); |
| int (*mmap)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct vm_area_struct *vma); |
| int (*ack)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, size_t bytes); |
| int (*get_caps)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_compr_caps *caps); |
| int (*get_codec_caps)(struct snd_soc_component *component, |
| struct snd_compr_stream *stream, |
| struct snd_compr_codec_caps *codec); |
| }; |
| |
| struct snd_soc_component_driver { |
| const char *name; |
| |
| /* Default control and setup, added after probe() is run */ |
| const struct snd_kcontrol_new *controls; |
| unsigned int num_controls; |
| const struct snd_soc_dapm_widget *dapm_widgets; |
| unsigned int num_dapm_widgets; |
| const struct snd_soc_dapm_route *dapm_routes; |
| unsigned int num_dapm_routes; |
| |
| int (*probe)(struct snd_soc_component *component); |
| void (*remove)(struct snd_soc_component *component); |
| int (*suspend)(struct snd_soc_component *component); |
| int (*resume)(struct snd_soc_component *component); |
| |
| unsigned int (*read)(struct snd_soc_component *component, |
| unsigned int reg); |
| int (*write)(struct snd_soc_component *component, |
| unsigned int reg, unsigned int val); |
| |
| /* pcm creation and destruction */ |
| int (*pcm_construct)(struct snd_soc_component *component, |
| struct snd_soc_pcm_runtime *rtd); |
| void (*pcm_destruct)(struct snd_soc_component *component, |
| struct snd_pcm *pcm); |
| |
| /* component wide operations */ |
| int (*set_sysclk)(struct snd_soc_component *component, |
| int clk_id, int source, unsigned int freq, int dir); |
| int (*set_pll)(struct snd_soc_component *component, int pll_id, |
| int source, unsigned int freq_in, unsigned int freq_out); |
| int (*set_jack)(struct snd_soc_component *component, |
| struct snd_soc_jack *jack, void *data); |
| int (*get_jack_type)(struct snd_soc_component *component); |
| |
| /* DT */ |
| int (*of_xlate_dai_name)(struct snd_soc_component *component, |
| const struct of_phandle_args *args, |
| const char **dai_name); |
| int (*of_xlate_dai_id)(struct snd_soc_component *comment, |
| struct device_node *endpoint); |
| void (*seq_notifier)(struct snd_soc_component *component, |
| enum snd_soc_dapm_type type, int subseq); |
| int (*stream_event)(struct snd_soc_component *component, int event); |
| int (*set_bias_level)(struct snd_soc_component *component, |
| enum snd_soc_bias_level level); |
| |
| int (*open)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| int (*close)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| int (*ioctl)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, |
| unsigned int cmd, void *arg); |
| int (*hw_params)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, |
| struct snd_pcm_hw_params *params); |
| int (*hw_free)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| int (*prepare)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| int (*trigger)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, int cmd); |
| int (*sync_stop)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| snd_pcm_uframes_t (*pointer)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| int (*get_time_info)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, struct timespec64 *system_ts, |
| struct timespec64 *audio_ts, |
| struct snd_pcm_audio_tstamp_config *audio_tstamp_config, |
| struct snd_pcm_audio_tstamp_report *audio_tstamp_report); |
| int (*copy)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, int channel, |
| unsigned long pos, struct iov_iter *iter, |
| unsigned long bytes); |
| struct page *(*page)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, |
| unsigned long offset); |
| int (*mmap)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, |
| struct vm_area_struct *vma); |
| int (*ack)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| snd_pcm_sframes_t (*delay)(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| |
| const struct snd_compress_ops *compress_ops; |
| |
| /* probe ordering - for components with runtime dependencies */ |
| int probe_order; |
| int remove_order; |
| |
| /* |
| * soc_pcm_trigger() start/stop sequence. |
| * see also |
| * snd_soc_dai_link |
| * soc_pcm_trigger() |
| */ |
| enum snd_soc_trigger_order trigger_start; |
| enum snd_soc_trigger_order trigger_stop; |
| |
| /* |
| * signal if the module handling the component should not be removed |
| * if a pcm is open. Setting this would prevent the module |
| * refcount being incremented in probe() but allow it be incremented |
| * when a pcm is opened and decremented when it is closed. |
| */ |
| unsigned int module_get_upon_open:1; |
| |
| /* bits */ |
| unsigned int idle_bias_on:1; |
| unsigned int suspend_bias_off:1; |
| unsigned int use_pmdown_time:1; /* care pmdown_time at stop */ |
| /* |
| * Indicates that the component does not care about the endianness of |
| * PCM audio data and the core will ensure that both LE and BE variants |
| * of each used format are present. Typically this is because the |
| * component sits behind a bus that abstracts away the endian of the |
| * original data, ie. one for which the transmission endian is defined |
| * (I2S/SLIMbus/SoundWire), or the concept of endian doesn't exist (PDM, |
| * analogue). |
| */ |
| unsigned int endianness:1; |
| unsigned int legacy_dai_naming:1; |
| |
| /* this component uses topology and ignore machine driver FEs */ |
| const char *ignore_machine; |
| const char *topology_name_prefix; |
| int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, |
| struct snd_pcm_hw_params *params); |
| bool use_dai_pcm_id; /* use DAI link PCM ID as PCM device number */ |
| int be_pcm_base; /* base device ID for all BE PCMs */ |
| |
| #ifdef CONFIG_DEBUG_FS |
| const char *debugfs_prefix; |
| #endif |
| }; |
| |
| struct snd_soc_component { |
| const char *name; |
| int id; |
| const char *name_prefix; |
| struct device *dev; |
| struct snd_soc_card *card; |
| |
| unsigned int active; |
| |
| unsigned int suspended:1; /* is in suspend PM state */ |
| |
| struct list_head list; |
| struct list_head card_aux_list; /* for auxiliary bound components */ |
| struct list_head card_list; |
| |
| const struct snd_soc_component_driver *driver; |
| |
| struct list_head dai_list; |
| int num_dai; |
| |
| struct regmap *regmap; |
| int val_bytes; |
| |
| struct mutex io_mutex; |
| |
| /* attached dynamic objects */ |
| struct list_head dobj_list; |
| |
| /* |
| * DO NOT use any of the fields below in drivers, they are temporary and |
| * are going to be removed again soon. If you use them in driver code |
| * the driver will be marked as BROKEN when these fields are removed. |
| */ |
| |
| /* Don't use these, use snd_soc_component_get_dapm() */ |
| struct snd_soc_dapm_context dapm; |
| |
| /* machine specific init */ |
| int (*init)(struct snd_soc_component *component); |
| |
| /* function mark */ |
| void *mark_module; |
| struct snd_pcm_substream *mark_open; |
| struct snd_pcm_substream *mark_hw_params; |
| struct snd_pcm_substream *mark_trigger; |
| struct snd_compr_stream *mark_compr_open; |
| void *mark_pm; |
| |
| struct dentry *debugfs_root; |
| const char *debugfs_prefix; |
| }; |
| |
| #define for_each_component_dais(component, dai)\ |
| list_for_each_entry(dai, &(component)->dai_list, list) |
| #define for_each_component_dais_safe(component, dai, _dai)\ |
| list_for_each_entry_safe(dai, _dai, &(component)->dai_list, list) |
| |
| /** |
| * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is |
| * embedded in |
| * @dapm: The DAPM context to cast to the component |
| * |
| * This function must only be used on DAPM contexts that are known to be part of |
| * a component (e.g. in a component driver). Otherwise the behavior is |
| * undefined. |
| */ |
| static inline struct snd_soc_component *snd_soc_dapm_to_component( |
| struct snd_soc_dapm_context *dapm) |
| { |
| return container_of(dapm, struct snd_soc_component, dapm); |
| } |
| |
| /** |
| * snd_soc_component_get_dapm() - Returns the DAPM context associated with a |
| * component |
| * @component: The component for which to get the DAPM context |
| */ |
| static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm( |
| struct snd_soc_component *component) |
| { |
| return &component->dapm; |
| } |
| |
| /** |
| * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level |
| * @component: The COMPONENT for which to initialize the DAPM bias level |
| * @level: The DAPM level to initialize to |
| * |
| * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level() |
| */ |
| static inline void |
| snd_soc_component_init_bias_level(struct snd_soc_component *component, |
| enum snd_soc_bias_level level) |
| { |
| snd_soc_dapm_init_bias_level( |
| snd_soc_component_get_dapm(component), level); |
| } |
| |
| /** |
| * snd_soc_component_get_bias_level() - Get current COMPONENT DAPM bias level |
| * @component: The COMPONENT for which to get the DAPM bias level |
| * |
| * Returns: The current DAPM bias level of the COMPONENT. |
| */ |
| static inline enum snd_soc_bias_level |
| snd_soc_component_get_bias_level(struct snd_soc_component *component) |
| { |
| return snd_soc_dapm_get_bias_level( |
| snd_soc_component_get_dapm(component)); |
| } |
| |
| /** |
| * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level |
| * @component: The COMPONENT for which to set the level |
| * @level: The level to set to |
| * |
| * Forces the COMPONENT bias level to a specific state. See |
| * snd_soc_dapm_force_bias_level(). |
| */ |
| static inline int |
| snd_soc_component_force_bias_level(struct snd_soc_component *component, |
| enum snd_soc_bias_level level) |
| { |
| return snd_soc_dapm_force_bias_level( |
| snd_soc_component_get_dapm(component), |
| level); |
| } |
| |
| /** |
| * snd_soc_dapm_kcontrol_component() - Returns the component associated to a |
| * kcontrol |
| * @kcontrol: The kcontrol |
| * |
| * This function must only be used on DAPM contexts that are known to be part of |
| * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined |
| */ |
| static inline struct snd_soc_component *snd_soc_dapm_kcontrol_component( |
| struct snd_kcontrol *kcontrol) |
| { |
| return snd_soc_dapm_to_component(snd_soc_dapm_kcontrol_dapm(kcontrol)); |
| } |
| |
| /** |
| * snd_soc_component_cache_sync() - Sync the register cache with the hardware |
| * @component: COMPONENT to sync |
| * |
| * Note: This function will call regcache_sync() |
| */ |
| static inline int snd_soc_component_cache_sync( |
| struct snd_soc_component *component) |
| { |
| return regcache_sync(component->regmap); |
| } |
| |
| void snd_soc_component_set_aux(struct snd_soc_component *component, |
| struct snd_soc_aux_dev *aux); |
| int snd_soc_component_init(struct snd_soc_component *component); |
| int snd_soc_component_is_dummy(struct snd_soc_component *component); |
| |
| /* component IO */ |
| unsigned int snd_soc_component_read(struct snd_soc_component *component, |
| unsigned int reg); |
| int snd_soc_component_write(struct snd_soc_component *component, |
| unsigned int reg, unsigned int val); |
| int snd_soc_component_update_bits(struct snd_soc_component *component, |
| unsigned int reg, unsigned int mask, |
| unsigned int val); |
| int snd_soc_component_update_bits_async(struct snd_soc_component *component, |
| unsigned int reg, unsigned int mask, |
| unsigned int val); |
| void snd_soc_component_async_complete(struct snd_soc_component *component); |
| int snd_soc_component_test_bits(struct snd_soc_component *component, |
| unsigned int reg, unsigned int mask, |
| unsigned int value); |
| |
| unsigned int snd_soc_component_read_field(struct snd_soc_component *component, |
| unsigned int reg, unsigned int mask); |
| int snd_soc_component_write_field(struct snd_soc_component *component, |
| unsigned int reg, unsigned int mask, |
| unsigned int val); |
| |
| /* component wide operations */ |
| int snd_soc_component_set_sysclk(struct snd_soc_component *component, |
| int clk_id, int source, |
| unsigned int freq, int dir); |
| int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id, |
| int source, unsigned int freq_in, |
| unsigned int freq_out); |
| int snd_soc_component_set_jack(struct snd_soc_component *component, |
| struct snd_soc_jack *jack, void *data); |
| int snd_soc_component_get_jack_type(struct snd_soc_component *component); |
| |
| void snd_soc_component_seq_notifier(struct snd_soc_component *component, |
| enum snd_soc_dapm_type type, int subseq); |
| int snd_soc_component_stream_event(struct snd_soc_component *component, |
| int event); |
| int snd_soc_component_set_bias_level(struct snd_soc_component *component, |
| enum snd_soc_bias_level level); |
| |
| void snd_soc_component_setup_regmap(struct snd_soc_component *component); |
| #ifdef CONFIG_REGMAP |
| void snd_soc_component_init_regmap(struct snd_soc_component *component, |
| struct regmap *regmap); |
| void snd_soc_component_exit_regmap(struct snd_soc_component *component); |
| #endif |
| |
| #define snd_soc_component_module_get_when_probe(component)\ |
| snd_soc_component_module_get(component, NULL, 0) |
| #define snd_soc_component_module_get_when_open(component, substream) \ |
| snd_soc_component_module_get(component, substream, 1) |
| int snd_soc_component_module_get(struct snd_soc_component *component, |
| void *mark, int upon_open); |
| #define snd_soc_component_module_put_when_remove(component) \ |
| snd_soc_component_module_put(component, NULL, 0, 0) |
| #define snd_soc_component_module_put_when_close(component, substream, rollback) \ |
| snd_soc_component_module_put(component, substream, 1, rollback) |
| void snd_soc_component_module_put(struct snd_soc_component *component, |
| void *mark, int upon_open, int rollback); |
| |
| static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c, |
| void *data) |
| { |
| dev_set_drvdata(c->dev, data); |
| } |
| |
| static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c) |
| { |
| return dev_get_drvdata(c->dev); |
| } |
| |
| static inline unsigned int |
| snd_soc_component_active(struct snd_soc_component *component) |
| { |
| return component->active; |
| } |
| |
| /* component pin */ |
| int snd_soc_component_enable_pin(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_disable_pin(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_nc_pin(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_get_pin_status(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_force_enable_pin(struct snd_soc_component *component, |
| const char *pin); |
| int snd_soc_component_force_enable_pin_unlocked( |
| struct snd_soc_component *component, |
| const char *pin); |
| |
| /* component controls */ |
| struct snd_kcontrol *snd_soc_component_get_kcontrol(struct snd_soc_component *component, |
| const char * const ctl); |
| struct snd_kcontrol * |
| snd_soc_component_get_kcontrol_locked(struct snd_soc_component *component, |
| const char * const ctl); |
| int snd_soc_component_notify_control(struct snd_soc_component *component, |
| const char * const ctl); |
| |
| /* component driver ops */ |
| int snd_soc_component_open(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream); |
| int snd_soc_component_close(struct snd_soc_component *component, |
| struct snd_pcm_substream *substream, |
| int rollback); |
| void snd_soc_component_suspend(struct snd_soc_component *component); |
| void snd_soc_component_resume(struct snd_soc_component *component); |
| int snd_soc_component_is_suspended(struct snd_soc_component *component); |
| int snd_soc_component_probe(struct snd_soc_component *component); |
| void snd_soc_component_remove(struct snd_soc_component *component); |
| int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component, |
| struct device_node *ep); |
| int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component, |
| const struct of_phandle_args *args, |
| const char **dai_name); |
| int snd_soc_component_compr_open(struct snd_soc_component *component, |
| struct snd_compr_stream *cstream); |
| void snd_soc_component_compr_free(struct snd_soc_component *component, |
| struct snd_compr_stream *cstream, |
| int rollback); |
| int snd_soc_component_compr_trigger(struct snd_compr_stream *cstream, int cmd); |
| int snd_soc_component_compr_set_params(struct snd_compr_stream *cstream, |
| struct snd_compr_params *params); |
| int snd_soc_component_compr_get_params(struct snd_compr_stream *cstream, |
| struct snd_codec *params); |
| int snd_soc_component_compr_get_caps(struct snd_compr_stream *cstream, |
| struct snd_compr_caps *caps); |
| int snd_soc_component_compr_get_codec_caps(struct snd_compr_stream *cstream, |
| struct snd_compr_codec_caps *codec); |
| int snd_soc_component_compr_ack(struct snd_compr_stream *cstream, size_t bytes); |
| int snd_soc_component_compr_pointer(struct snd_compr_stream *cstream, |
| struct snd_compr_tstamp *tstamp); |
| int snd_soc_component_compr_copy(struct snd_compr_stream *cstream, |
| char __user *buf, size_t count); |
| int snd_soc_component_compr_set_metadata(struct snd_compr_stream *cstream, |
| struct snd_compr_metadata *metadata); |
| int snd_soc_component_compr_get_metadata(struct snd_compr_stream *cstream, |
| struct snd_compr_metadata *metadata); |
| |
| int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream); |
| int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream, |
| unsigned int cmd, void *arg); |
| int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream); |
| int snd_soc_pcm_component_copy(struct snd_pcm_substream *substream, |
| int channel, unsigned long pos, |
| struct iov_iter *iter, unsigned long bytes); |
| struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream, |
| unsigned long offset); |
| int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream, |
| struct vm_area_struct *vma); |
| int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd); |
| void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd); |
| int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream); |
| int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream, |
| struct snd_pcm_hw_params *params); |
| void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream, |
| int rollback); |
| int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream, |
| int cmd, int rollback); |
| int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd, |
| void *stream); |
| void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd, |
| void *stream, int rollback); |
| int snd_soc_pcm_component_ack(struct snd_pcm_substream *substream); |
| void snd_soc_pcm_component_delay(struct snd_pcm_substream *substream, |
| snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay); |
| |
| #endif /* __SOC_COMPONENT_H */ |