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 */
29 struct 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_tstamp *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
67 struct 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
102 /* DT */
103 int (*of_xlate_dai_name)(struct snd_soc_component *component,
104 struct of_phandle_args *args,
105 const char **dai_name);
106 int (*of_xlate_dai_id)(struct snd_soc_component *comment,
107 struct device_node *endpoint);
108 void (*seq_notifier)(struct snd_soc_component *component,
109 enum snd_soc_dapm_type type, int subseq);
110 int (*stream_event)(struct snd_soc_component *component, int event);
111 int (*set_bias_level)(struct snd_soc_component *component,
112 enum snd_soc_bias_level level);
113
114 int (*open)(struct snd_soc_component *component,
115 struct snd_pcm_substream *substream);
116 int (*close)(struct snd_soc_component *component,
117 struct snd_pcm_substream *substream);
118 int (*ioctl)(struct snd_soc_component *component,
119 struct snd_pcm_substream *substream,
120 unsigned int cmd, void *arg);
121 int (*hw_params)(struct snd_soc_component *component,
122 struct snd_pcm_substream *substream,
123 struct snd_pcm_hw_params *params);
124 int (*hw_free)(struct snd_soc_component *component,
125 struct snd_pcm_substream *substream);
126 int (*prepare)(struct snd_soc_component *component,
127 struct snd_pcm_substream *substream);
128 int (*trigger)(struct snd_soc_component *component,
129 struct snd_pcm_substream *substream, int cmd);
130 int (*sync_stop)(struct snd_soc_component *component,
131 struct snd_pcm_substream *substream);
132 snd_pcm_uframes_t (*pointer)(struct snd_soc_component *component,
133 struct snd_pcm_substream *substream);
134 int (*get_time_info)(struct snd_soc_component *component,
135 struct snd_pcm_substream *substream, struct timespec64 *system_ts,
136 struct timespec64 *audio_ts,
137 struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
138 struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
139 int (*copy_user)(struct snd_soc_component *component,
140 struct snd_pcm_substream *substream, int channel,
141 unsigned long pos, void __user *buf,
142 unsigned long bytes);
143 struct page *(*page)(struct snd_soc_component *component,
144 struct snd_pcm_substream *substream,
145 unsigned long offset);
146 int (*mmap)(struct snd_soc_component *component,
147 struct snd_pcm_substream *substream,
148 struct vm_area_struct *vma);
149
150 const struct snd_compress_ops *compress_ops;
151
152 /* probe ordering - for components with runtime dependencies */
153 int probe_order;
154 int remove_order;
155
156 /*
157 * signal if the module handling the component should not be removed
158 * if a pcm is open. Setting this would prevent the module
159 * refcount being incremented in probe() but allow it be incremented
160 * when a pcm is opened and decremented when it is closed.
161 */
162 unsigned int module_get_upon_open:1;
163
164 /* bits */
165 unsigned int idle_bias_on:1;
166 unsigned int suspend_bias_off:1;
167 unsigned int use_pmdown_time:1; /* care pmdown_time at stop */
168 unsigned int endianness:1;
169 unsigned int non_legacy_dai_naming:1;
170
171 /* this component uses topology and ignore machine driver FEs */
172 const char *ignore_machine;
173 const char *topology_name_prefix;
174 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
175 struct snd_pcm_hw_params *params);
176 bool use_dai_pcm_id; /* use DAI link PCM ID as PCM device number */
177 int be_pcm_base; /* base device ID for all BE PCMs */
178 };
179
180 struct snd_soc_component {
181 const char *name;
182 int id;
183 const char *name_prefix;
184 struct device *dev;
185 struct snd_soc_card *card;
186
187 unsigned int active;
188
189 unsigned int suspended:1; /* is in suspend PM state */
190
191 struct list_head list;
192 struct list_head card_aux_list; /* for auxiliary bound components */
193 struct list_head card_list;
194
195 const struct snd_soc_component_driver *driver;
196
197 struct list_head dai_list;
198 int num_dai;
199
200 struct regmap *regmap;
201 int val_bytes;
202
203 struct mutex io_mutex;
204
205 /* attached dynamic objects */
206 struct list_head dobj_list;
207
208 /*
209 * DO NOT use any of the fields below in drivers, they are temporary and
210 * are going to be removed again soon. If you use them in driver code
211 * the driver will be marked as BROKEN when these fields are removed.
212 */
213
214 /* Don't use these, use snd_soc_component_get_dapm() */
215 struct snd_soc_dapm_context dapm;
216
217 /* machine specific init */
218 int (*init)(struct snd_soc_component *component);
219
220 /* function mark */
221 struct snd_pcm_substream *mark_module;
222 struct snd_pcm_substream *mark_open;
223 void *mark_pm;
224
225 #ifdef CONFIG_DEBUG_FS
226 struct dentry *debugfs_root;
227 const char *debugfs_prefix;
228 #endif
229 };
230
231 #define for_each_component_dais(component, dai)\
232 list_for_each_entry(dai, &(component)->dai_list, list)
233 #define for_each_component_dais_safe(component, dai, _dai)\
234 list_for_each_entry_safe(dai, _dai, &(component)->dai_list, list)
235
236 /**
237 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
238 * embedded in
239 * @dapm: The DAPM context to cast to the component
240 *
241 * This function must only be used on DAPM contexts that are known to be part of
242 * a component (e.g. in a component driver). Otherwise the behavior is
243 * undefined.
244 */
snd_soc_dapm_to_component(struct snd_soc_dapm_context * dapm)245 static inline struct snd_soc_component *snd_soc_dapm_to_component(
246 struct snd_soc_dapm_context *dapm)
247 {
248 return container_of(dapm, struct snd_soc_component, dapm);
249 }
250
251 /**
252 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
253 * component
254 * @component: The component for which to get the DAPM context
255 */
snd_soc_component_get_dapm(struct snd_soc_component * component)256 static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
257 struct snd_soc_component *component)
258 {
259 return &component->dapm;
260 }
261
262 /**
263 * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level
264 * @component: The COMPONENT for which to initialize the DAPM bias level
265 * @level: The DAPM level to initialize to
266 *
267 * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level()
268 */
269 static inline void
snd_soc_component_init_bias_level(struct snd_soc_component * component,enum snd_soc_bias_level level)270 snd_soc_component_init_bias_level(struct snd_soc_component *component,
271 enum snd_soc_bias_level level)
272 {
273 snd_soc_dapm_init_bias_level(
274 snd_soc_component_get_dapm(component), level);
275 }
276
277 /**
278 * snd_soc_component_get_bias_level() - Get current COMPONENT DAPM bias level
279 * @component: The COMPONENT for which to get the DAPM bias level
280 *
281 * Returns: The current DAPM bias level of the COMPONENT.
282 */
283 static inline enum snd_soc_bias_level
snd_soc_component_get_bias_level(struct snd_soc_component * component)284 snd_soc_component_get_bias_level(struct snd_soc_component *component)
285 {
286 return snd_soc_dapm_get_bias_level(
287 snd_soc_component_get_dapm(component));
288 }
289
290 /**
291 * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level
292 * @component: The COMPONENT for which to set the level
293 * @level: The level to set to
294 *
295 * Forces the COMPONENT bias level to a specific state. See
296 * snd_soc_dapm_force_bias_level().
297 */
298 static inline int
snd_soc_component_force_bias_level(struct snd_soc_component * component,enum snd_soc_bias_level level)299 snd_soc_component_force_bias_level(struct snd_soc_component *component,
300 enum snd_soc_bias_level level)
301 {
302 return snd_soc_dapm_force_bias_level(
303 snd_soc_component_get_dapm(component),
304 level);
305 }
306
307 /**
308 * snd_soc_dapm_kcontrol_component() - Returns the component associated to a
309 * kcontrol
310 * @kcontrol: The kcontrol
311 *
312 * This function must only be used on DAPM contexts that are known to be part of
313 * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined
314 */
snd_soc_dapm_kcontrol_component(struct snd_kcontrol * kcontrol)315 static inline struct snd_soc_component *snd_soc_dapm_kcontrol_component(
316 struct snd_kcontrol *kcontrol)
317 {
318 return snd_soc_dapm_to_component(snd_soc_dapm_kcontrol_dapm(kcontrol));
319 }
320
321 /**
322 * snd_soc_component_cache_sync() - Sync the register cache with the hardware
323 * @component: COMPONENT to sync
324 *
325 * Note: This function will call regcache_sync()
326 */
snd_soc_component_cache_sync(struct snd_soc_component * component)327 static inline int snd_soc_component_cache_sync(
328 struct snd_soc_component *component)
329 {
330 return regcache_sync(component->regmap);
331 }
332
333 void snd_soc_component_set_aux(struct snd_soc_component *component,
334 struct snd_soc_aux_dev *aux);
335 int snd_soc_component_init(struct snd_soc_component *component);
336
337 /* component IO */
338 unsigned int snd_soc_component_read(struct snd_soc_component *component,
339 unsigned int reg);
340 int snd_soc_component_write(struct snd_soc_component *component,
341 unsigned int reg, unsigned int val);
342 int snd_soc_component_update_bits(struct snd_soc_component *component,
343 unsigned int reg, unsigned int mask,
344 unsigned int val);
345 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
346 unsigned int reg, unsigned int mask,
347 unsigned int val);
348 void snd_soc_component_async_complete(struct snd_soc_component *component);
349 int snd_soc_component_test_bits(struct snd_soc_component *component,
350 unsigned int reg, unsigned int mask,
351 unsigned int value);
352
353 /* component wide operations */
354 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
355 int clk_id, int source,
356 unsigned int freq, int dir);
357 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
358 int source, unsigned int freq_in,
359 unsigned int freq_out);
360 int snd_soc_component_set_jack(struct snd_soc_component *component,
361 struct snd_soc_jack *jack, void *data);
362
363 void snd_soc_component_seq_notifier(struct snd_soc_component *component,
364 enum snd_soc_dapm_type type, int subseq);
365 int snd_soc_component_stream_event(struct snd_soc_component *component,
366 int event);
367 int snd_soc_component_set_bias_level(struct snd_soc_component *component,
368 enum snd_soc_bias_level level);
369
370 void snd_soc_component_setup_regmap(struct snd_soc_component *component);
371 #ifdef CONFIG_REGMAP
372 void snd_soc_component_init_regmap(struct snd_soc_component *component,
373 struct regmap *regmap);
374 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
375 #endif
376
377 #define snd_soc_component_module_get_when_probe(component)\
378 snd_soc_component_module_get(component, NULL, 0)
379 #define snd_soc_component_module_get_when_open(component, substream) \
380 snd_soc_component_module_get(component, substream, 1)
381 int snd_soc_component_module_get(struct snd_soc_component *component,
382 struct snd_pcm_substream *substream,
383 int upon_open);
384 #define snd_soc_component_module_put_when_remove(component) \
385 snd_soc_component_module_put(component, NULL, 0, 0)
386 #define snd_soc_component_module_put_when_close(component, substream, rollback) \
387 snd_soc_component_module_put(component, substream, 1, rollback)
388 void snd_soc_component_module_put(struct snd_soc_component *component,
389 struct snd_pcm_substream *substream,
390 int upon_open, int rollback);
391
snd_soc_component_set_drvdata(struct snd_soc_component * c,void * data)392 static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
393 void *data)
394 {
395 dev_set_drvdata(c->dev, data);
396 }
397
snd_soc_component_get_drvdata(struct snd_soc_component * c)398 static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
399 {
400 return dev_get_drvdata(c->dev);
401 }
402
403 static inline unsigned int
snd_soc_component_active(struct snd_soc_component * component)404 snd_soc_component_active(struct snd_soc_component *component)
405 {
406 return component->active;
407 }
408
409 /* component pin */
410 int snd_soc_component_enable_pin(struct snd_soc_component *component,
411 const char *pin);
412 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
413 const char *pin);
414 int snd_soc_component_disable_pin(struct snd_soc_component *component,
415 const char *pin);
416 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
417 const char *pin);
418 int snd_soc_component_nc_pin(struct snd_soc_component *component,
419 const char *pin);
420 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
421 const char *pin);
422 int snd_soc_component_get_pin_status(struct snd_soc_component *component,
423 const char *pin);
424 int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
425 const char *pin);
426 int snd_soc_component_force_enable_pin_unlocked(
427 struct snd_soc_component *component,
428 const char *pin);
429
430 /* component driver ops */
431 int snd_soc_component_open(struct snd_soc_component *component,
432 struct snd_pcm_substream *substream);
433 int snd_soc_component_close(struct snd_soc_component *component,
434 struct snd_pcm_substream *substream,
435 int rollback);
436 void snd_soc_component_suspend(struct snd_soc_component *component);
437 void snd_soc_component_resume(struct snd_soc_component *component);
438 int snd_soc_component_is_suspended(struct snd_soc_component *component);
439 int snd_soc_component_probe(struct snd_soc_component *component);
440 void snd_soc_component_remove(struct snd_soc_component *component);
441 int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component,
442 struct device_node *ep);
443 int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,
444 struct of_phandle_args *args,
445 const char **dai_name);
446
447 int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream);
448 int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream,
449 unsigned int cmd, void *arg);
450 int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream);
451 int snd_soc_pcm_component_copy_user(struct snd_pcm_substream *substream,
452 int channel, unsigned long pos,
453 void __user *buf, unsigned long bytes);
454 struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream,
455 unsigned long offset);
456 int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream,
457 struct vm_area_struct *vma);
458 int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd);
459 void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd);
460 int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream);
461 int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream,
462 struct snd_pcm_hw_params *params,
463 struct snd_soc_component **last);
464 void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream,
465 struct snd_soc_component *last);
466 int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream,
467 int cmd);
468 int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd,
469 void *stream);
470 void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd,
471 void *stream, int rollback);
472
473 #endif /* __SOC_COMPONENT_H */
474