FILE
soc-component.h
File preview with syntax highlighting.
linux-6.19.14/include/sound/soc-component.h
1/* SPDX-License-Identifier: GPL-2.0 2 * 3 * soc-component.h 4 * 5 * Copyright (C) 2019 Renesas Electronics Corp. 6 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com> 7 */ 8#ifndef __SOC_COMPONENT_H 9#define __SOC_COMPONENT_H 10 11#include <sound/soc.h> 12 13/* 14 * Component probe and remove ordering levels for components with runtime 15 * dependencies. 16 */ 17#define SND_SOC_COMP_ORDER_FIRST -2 18#define SND_SOC_COMP_ORDER_EARLY -1 19#define SND_SOC_COMP_ORDER_NORMAL 0 20#define SND_SOC_COMP_ORDER_LATE 1 21#define SND_SOC_COMP_ORDER_LAST 2 22 23#define for_each_comp_order(order) \ 24 for (order = SND_SOC_COMP_ORDER_FIRST; \ 25 order <= SND_SOC_COMP_ORDER_LAST; \ 26 order++) 27 28/* component interface */ 29struct snd_compress_ops { 30 int (*open)(struct snd_soc_component *component, 31 struct snd_compr_stream *stream); 32 int (*free)(struct snd_soc_component *component, 33 struct snd_compr_stream *stream); 34 int (*set_params)(struct snd_soc_component *component, 35 struct snd_compr_stream *stream, 36 struct snd_compr_params *params); 37 int (*get_params)(struct snd_soc_component *component, 38 struct snd_compr_stream *stream, 39 struct snd_codec *params); 40 int (*set_metadata)(struct snd_soc_component *component, 41 struct snd_compr_stream *stream, 42 struct snd_compr_metadata *metadata); 43 int (*get_metadata)(struct snd_soc_component *component, 44 struct snd_compr_stream *stream, 45 struct snd_compr_metadata *metadata); 46 int (*trigger)(struct snd_soc_component *component, 47 struct snd_compr_stream *stream, int cmd); 48 int (*pointer)(struct snd_soc_component *component, 49 struct snd_compr_stream *stream, 50 struct snd_compr_tstamp64 *tstamp); 51 int (*copy)(struct snd_soc_component *component, 52 struct snd_compr_stream *stream, char __user *buf, 53 size_t count); 54 int (*mmap)(struct snd_soc_component *component, 55 struct snd_compr_stream *stream, 56 struct vm_area_struct *vma); 57 int (*ack)(struct snd_soc_component *component, 58 struct snd_compr_stream *stream, size_t bytes); 59 int (*get_caps)(struct snd_soc_component *component, 60 struct snd_compr_stream *stream, 61 struct snd_compr_caps *caps); 62 int (*get_codec_caps)(struct snd_soc_component *component, 63 struct snd_compr_stream *stream, 64 struct snd_compr_codec_caps *codec); 65}; 66 67struct snd_soc_component_driver { 68 const char *name; 69 70 /* Default control and setup, added after probe() is run */ 71 const struct snd_kcontrol_new *controls; 72 unsigned int num_controls; 73 const struct snd_soc_dapm_widget *dapm_widgets; 74 unsigned int num_dapm_widgets; 75 const struct snd_soc_dapm_route *dapm_routes; 76 unsigned int num_dapm_routes; 77 78 int (*probe)(struct snd_soc_component *component); 79 void (*remove)(struct snd_soc_component *component); 80 int (*suspend)(struct snd_soc_component *component); 81 int (*resume)(struct snd_soc_component *component); 82 83 unsigned int (*read)(struct snd_soc_component *component, 84 unsigned int reg); 85 int (*write)(struct snd_soc_component *component, 86 unsigned int reg, unsigned int val); 87 88 /* pcm creation and destruction */ 89 int (*pcm_construct)(struct snd_soc_component *component, 90 struct snd_soc_pcm_runtime *rtd); 91 void (*pcm_destruct)(struct snd_soc_component *component, 92 struct snd_pcm *pcm); 93 94 /* component wide operations */ 95 int (*set_sysclk)(struct snd_soc_component *component, 96 int clk_id, int source, unsigned int freq, int dir); 97 int (*set_pll)(struct snd_soc_component *component, int pll_id, 98 int source, unsigned int freq_in, unsigned int freq_out); 99 int (*set_jack)(struct snd_soc_component *component, 100 struct snd_soc_jack *jack, void *data); 101 int (*get_jack_type)(struct snd_soc_component *component); 102 103 /* DT */ 104 int (*of_xlate_dai_name)(struct snd_soc_component *component, 105 const struct of_phandle_args *args, 106 const char **dai_name); 107 int (*of_xlate_dai_id)(struct snd_soc_component *comment, 108 struct device_node *endpoint); 109 void (*seq_notifier)(struct snd_soc_component *component, 110 enum snd_soc_dapm_type type, int subseq); 111 int (*stream_event)(struct snd_soc_component *component, int event); 112 int (*set_bias_level)(struct snd_soc_component *component, 113 enum snd_soc_bias_level level); 114 115 int (*open)(struct snd_soc_component *component, 116 struct snd_pcm_substream *substream); 117 int (*close)(struct snd_soc_component *component, 118 struct snd_pcm_substream *substream); 119 int (*ioctl)(struct snd_soc_component *component, 120 struct snd_pcm_substream *substream, 121 unsigned int cmd, void *arg); 122 int (*hw_params)(struct snd_soc_component *component, 123 struct snd_pcm_substream *substream, 124 struct snd_pcm_hw_params *params); 125 int (*hw_free)(struct snd_soc_component *component, 126 struct snd_pcm_substream *substream); 127 int (*prepare)(struct snd_soc_component *component, 128 struct snd_pcm_substream *substream); 129 int (*trigger)(struct snd_soc_component *component, 130 struct snd_pcm_substream *substream, int cmd); 131 int (*sync_stop)(struct snd_soc_component *component, 132 struct snd_pcm_substream *substream); 133 snd_pcm_uframes_t (*pointer)(struct snd_soc_component *component, 134 struct snd_pcm_substream *substream); 135 int (*get_time_info)(struct snd_soc_component *component, 136 struct snd_pcm_substream *substream, struct timespec64 *system_ts, 137 struct timespec64 *audio_ts, 138 struct snd_pcm_audio_tstamp_config *audio_tstamp_config, 139 struct snd_pcm_audio_tstamp_report *audio_tstamp_report); 140 int (*copy)(struct snd_soc_component *component, 141 struct snd_pcm_substream *substream, int channel, 142 unsigned long pos, struct iov_iter *iter, 143 unsigned long bytes); 144 struct page *(*page)(struct snd_soc_component *component, 145 struct snd_pcm_substream *substream, 146 unsigned long offset); 147 int (*mmap)(struct snd_soc_component *component, 148 struct snd_pcm_substream *substream, 149 struct vm_area_struct *vma); 150 int (*ack)(struct snd_soc_component *component, 151 struct snd_pcm_substream *substream); 152 snd_pcm_sframes_t (*delay)(struct snd_soc_component *component, 153 struct snd_pcm_substream *substream); 154 155 const struct snd_compress_ops *compress_ops; 156 157 /* probe ordering - for components with runtime dependencies */ 158 int probe_order; 159 int remove_order; 160 161 /* 162 * soc_pcm_trigger() start/stop sequence. 163 * see also 164 * snd_soc_dai_link 165 * soc_pcm_trigger() 166 */ 167 enum snd_soc_trigger_order trigger_start; 168 enum snd_soc_trigger_order trigger_stop; 169 170 /* 171 * signal if the module handling the component should not be removed 172 * if a pcm is open. Setting this would prevent the module 173 * refcount being incremented in probe() but allow it be incremented 174 * when a pcm is opened and decremented when it is closed. 175 */ 176 unsigned int module_get_upon_open:1; 177 178 /* bits */ 179 unsigned int idle_bias_on:1; 180 unsigned int suspend_bias_off:1; 181 unsigned int use_pmdown_time:1; /* care pmdown_time at stop */ 182 /* 183 * Indicates that the component does not care about the endianness of 184 * PCM audio data and the core will ensure that both LE and BE variants 185 * of each used format are present. Typically this is because the 186 * component sits behind a bus that abstracts away the endian of the 187 * original data, ie. one for which the transmission endian is defined 188 * (I2S/SLIMbus/SoundWire), or the concept of endian doesn't exist (PDM, 189 * analogue). 190 */ 191 unsigned int endianness:1; 192 unsigned int legacy_dai_naming:1; 193 194 /* this component uses topology and ignore machine driver FEs */ 195 const char *ignore_machine; 196 const char *topology_name_prefix; 197 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd, 198 struct snd_pcm_hw_params *params); 199 bool use_dai_pcm_id; /* use DAI link PCM ID as PCM device number */ 200 int be_pcm_base; /* base device ID for all BE PCMs */ 201 202#ifdef CONFIG_DEBUG_FS 203 const char *debugfs_prefix; 204#endif 205}; 206 207struct snd_soc_component { 208 const char *name; 209 const char *name_prefix; 210 struct device *dev; 211 struct snd_soc_card *card; 212 213 unsigned int active; 214 215 unsigned int suspended:1; /* is in suspend PM state */ 216 217 struct list_head list; 218 struct list_head card_aux_list; /* for auxiliary bound components */ 219 struct list_head card_list; 220 221 const struct snd_soc_component_driver *driver; 222 223 struct list_head dai_list; 224 int num_dai; 225 226 struct regmap *regmap; 227 int val_bytes; 228 229 struct mutex io_mutex; 230 231 /* attached dynamic objects */ 232 struct list_head dobj_list; 233 234 /* 235 * DO NOT use any of the fields below in drivers, they are temporary and 236 * are going to be removed again soon. If you use them in driver code 237 * the driver will be marked as BROKEN when these fields are removed. 238 */ 239 240 /* Don't use these, use snd_soc_component_get_dapm() */ 241 struct snd_soc_dapm_context dapm; 242 243 /* machine specific init */ 244 int (*init)(struct snd_soc_component *component); 245 246 /* function mark */ 247 void *mark_module; 248 struct snd_pcm_substream *mark_open; 249 struct snd_pcm_substream *mark_hw_params; 250 struct snd_pcm_substream *mark_trigger; 251 struct snd_compr_stream *mark_compr_open; 252 void *mark_pm; 253 254 struct dentry *debugfs_root; 255 const char *debugfs_prefix; 256}; 257 258#define for_each_component_dais(component, dai)\ 259 list_for_each_entry(dai, &(component)->dai_list, list) 260#define for_each_component_dais_safe(component, dai, _dai)\ 261 list_for_each_entry_safe(dai, _dai, &(component)->dai_list, list) 262 263/** 264 * snd_soc_component_to_dapm() - Returns the DAPM context associated with a 265 * component 266 * @component: The component for which to get the DAPM context 267 */ 268static inline struct snd_soc_dapm_context *snd_soc_component_to_dapm( 269 struct snd_soc_component *component) 270{ 271 return &component->dapm; 272} 273 274// FIXME 275#define snd_soc_component_get_dapm snd_soc_component_to_dapm 276 277/** 278 * snd_soc_component_cache_sync() - Sync the register cache with the hardware 279 * @component: COMPONENT to sync 280 * 281 * Note: This function will call regcache_sync() 282 */ 283static inline int snd_soc_component_cache_sync( 284 struct snd_soc_component *component) 285{ 286 return regcache_sync(component->regmap); 287} 288 289void snd_soc_component_set_aux(struct snd_soc_component *component, 290 struct snd_soc_aux_dev *aux); 291int snd_soc_component_init(struct snd_soc_component *component); 292int snd_soc_component_is_dummy(struct snd_soc_component *component); 293 294/* component IO */ 295unsigned int snd_soc_component_read(struct snd_soc_component *component, 296 unsigned int reg); 297int snd_soc_component_write(struct snd_soc_component *component, 298 unsigned int reg, unsigned int val); 299int snd_soc_component_update_bits(struct snd_soc_component *component, 300 unsigned int reg, unsigned int mask, 301 unsigned int val); 302int snd_soc_component_update_bits_async(struct snd_soc_component *component, 303 unsigned int reg, unsigned int mask, 304 unsigned int val); 305void snd_soc_component_async_complete(struct snd_soc_component *component); 306int snd_soc_component_test_bits(struct snd_soc_component *component, 307 unsigned int reg, unsigned int mask, 308 unsigned int value); 309 310unsigned int snd_soc_component_read_field(struct snd_soc_component *component, 311 unsigned int reg, unsigned int mask); 312int snd_soc_component_write_field(struct snd_soc_component *component, 313 unsigned int reg, unsigned int mask, 314 unsigned int val); 315 316/* component wide operations */ 317int snd_soc_component_set_sysclk(struct snd_soc_component *component, 318 int clk_id, int source, 319 unsigned int freq, int dir); 320int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id, 321 int source, unsigned int freq_in, 322 unsigned int freq_out); 323int snd_soc_component_set_jack(struct snd_soc_component *component, 324 struct snd_soc_jack *jack, void *data); 325int snd_soc_component_get_jack_type(struct snd_soc_component *component); 326 327void snd_soc_component_seq_notifier(struct snd_soc_component *component, 328 enum snd_soc_dapm_type type, int subseq); 329int snd_soc_component_stream_event(struct snd_soc_component *component, 330 int event); 331int snd_soc_component_set_bias_level(struct snd_soc_component *component, 332 enum snd_soc_bias_level level); 333 334void snd_soc_component_setup_regmap(struct snd_soc_component *component); 335#ifdef CONFIG_REGMAP 336void snd_soc_component_init_regmap(struct snd_soc_component *component, 337 struct regmap *regmap); 338void snd_soc_component_exit_regmap(struct snd_soc_component *component); 339#endif 340 341#define snd_soc_component_module_get_when_probe(component)\ 342 snd_soc_component_module_get(component, NULL, 0) 343#define snd_soc_component_module_get_when_open(component, substream) \ 344 snd_soc_component_module_get(component, substream, 1) 345int snd_soc_component_module_get(struct snd_soc_component *component, 346 void *mark, int upon_open); 347#define snd_soc_component_module_put_when_remove(component) \ 348 snd_soc_component_module_put(component, NULL, 0, 0) 349#define snd_soc_component_module_put_when_close(component, substream, rollback) \ 350 snd_soc_component_module_put(component, substream, 1, rollback) 351void snd_soc_component_module_put(struct snd_soc_component *component, 352 void *mark, int upon_open, int rollback); 353 354static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c, 355 void *data) 356{ 357 dev_set_drvdata(c->dev, data); 358} 359 360static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c) 361{ 362 return dev_get_drvdata(c->dev); 363} 364 365static inline unsigned int 366snd_soc_component_active(struct snd_soc_component *component) 367{ 368 return component->active; 369} 370 371/* component pin */ 372int snd_soc_component_enable_pin(struct snd_soc_component *component, 373 const char *pin); 374int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component, 375 const char *pin); 376int snd_soc_component_disable_pin(struct snd_soc_component *component, 377 const char *pin); 378int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component, 379 const char *pin); 380int snd_soc_component_nc_pin(struct snd_soc_component *component, 381 const char *pin); 382int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component, 383 const char *pin); 384int snd_soc_component_get_pin_status(struct snd_soc_component *component, 385 const char *pin); 386int snd_soc_component_force_enable_pin(struct snd_soc_component *component, 387 const char *pin); 388int snd_soc_component_force_enable_pin_unlocked( 389 struct snd_soc_component *component, 390 const char *pin); 391 392/* component controls */ 393struct snd_kcontrol *snd_soc_component_get_kcontrol(struct snd_soc_component *component, 394 const char * const ctl); 395int snd_soc_component_notify_control(struct snd_soc_component *component, 396 const char * const ctl); 397 398/* component driver ops */ 399int snd_soc_component_open(struct snd_soc_component *component, 400 struct snd_pcm_substream *substream); 401int snd_soc_component_close(struct snd_soc_component *component, 402 struct snd_pcm_substream *substream, 403 int rollback); 404void snd_soc_component_suspend(struct snd_soc_component *component); 405void snd_soc_component_resume(struct snd_soc_component *component); 406int snd_soc_component_is_suspended(struct snd_soc_component *component); 407int snd_soc_component_probe(struct snd_soc_component *component); 408void snd_soc_component_remove(struct snd_soc_component *component); 409int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component, 410 struct device_node *ep); 411int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component, 412 const struct of_phandle_args *args, 413 const char **dai_name); 414int snd_soc_component_compr_open(struct snd_soc_component *component, 415 struct snd_compr_stream *cstream); 416void snd_soc_component_compr_free(struct snd_soc_component *component, 417 struct snd_compr_stream *cstream, 418 int rollback); 419int snd_soc_component_compr_trigger(struct snd_compr_stream *cstream, int cmd); 420int snd_soc_component_compr_set_params(struct snd_compr_stream *cstream, 421 struct snd_compr_params *params); 422int snd_soc_component_compr_get_params(struct snd_compr_stream *cstream, 423 struct snd_codec *params); 424int snd_soc_component_compr_get_caps(struct snd_compr_stream *cstream, 425 struct snd_compr_caps *caps); 426int snd_soc_component_compr_get_codec_caps(struct snd_compr_stream *cstream, 427 struct snd_compr_codec_caps *codec); 428int snd_soc_component_compr_ack(struct snd_compr_stream *cstream, size_t bytes); 429int snd_soc_component_compr_pointer(struct snd_compr_stream *cstream, 430 struct snd_compr_tstamp64 *tstamp); 431int snd_soc_component_compr_copy(struct snd_compr_stream *cstream, 432 char __user *buf, size_t count); 433int snd_soc_component_compr_set_metadata(struct snd_compr_stream *cstream, 434 struct snd_compr_metadata *metadata); 435int snd_soc_component_compr_get_metadata(struct snd_compr_stream *cstream, 436 struct snd_compr_metadata *metadata); 437 438int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream); 439int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream, 440 unsigned int cmd, void *arg); 441int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream); 442int snd_soc_pcm_component_copy(struct snd_pcm_substream *substream, 443 int channel, unsigned long pos, 444 struct iov_iter *iter, unsigned long bytes); 445struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream, 446 unsigned long offset); 447int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream, 448 struct vm_area_struct *vma); 449int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd); 450void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd); 451int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream); 452int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream, 453 struct snd_pcm_hw_params *params); 454void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream, 455 int rollback); 456int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream, 457 int cmd, int rollback); 458int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd, 459 void *stream); 460void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd, 461 void *stream, int rollback); 462int snd_soc_pcm_component_ack(struct snd_pcm_substream *substream); 463void snd_soc_pcm_component_delay(struct snd_pcm_substream *substream, 464 snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay); 465 466#endif /* __SOC_COMPONENT_H */
~/
Read-only file preview.