projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'pull-work.iov_iter-rebased' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-block.git] / include / sound / soc-component.h
CommitLineData
4ff1fef1
KM		 1/* SPDX-License-Identifier: GPL-2.0
2 *
3 * soc-component.h
4 *
45108214
KM		 5 * Copyright (C) 2019 Renesas Electronics Corp.
6 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
4ff1fef1
KM		 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 */
c6cb522c
KM		 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_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
4ff1fef1
KM		 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 */
c64bfc90
KM		 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
4ff1fef1
KM		 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,
933f98be 104 const struct of_phandle_args *args,
4ff1fef1
KM		 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
e2cb4a14
KM		 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);
1e5ddb6b
TI		 130 int (*sync_stop)(struct snd_soc_component *component,
131 struct snd_pcm_substream *substream);
e2cb4a14
KM		 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,
fcae40c9
BW		 135 struct snd_pcm_substream *substream, struct timespec64 *system_ts,
136 struct timespec64 *audio_ts,
e2cb4a14
KM		 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);
8bdfc045
SW		 149 int (*ack)(struct snd_soc_component *component,
150 struct snd_pcm_substream *substream);
403f830e
KM		 151 snd_pcm_sframes_t (*delay)(struct snd_soc_component *component,
152 struct snd_pcm_substream *substream);
e2cb4a14 153
c6cb522c 154 const struct snd_compress_ops *compress_ops;
4ff1fef1
KM		 155
156 /* probe ordering - for components with runtime dependencies */
157 int probe_order;
158 int remove_order;
159
160 /*
161 * signal if the module handling the component should not be removed
162 * if a pcm is open. Setting this would prevent the module
163 * refcount being incremented in probe() but allow it be incremented
164 * when a pcm is opened and decremented when it is closed.
165 */
166 unsigned int module_get_upon_open:1;
167
168 /* bits */
169 unsigned int idle_bias_on:1;
170 unsigned int suspend_bias_off:1;
171 unsigned int use_pmdown_time:1; /* care pmdown_time at stop */
5c832efd
CK		 172 /*
173 * Indicates that the component does not care about the endianness of
174 * PCM audio data and the core will ensure that both LE and BE variants
175 * of each used format are present. Typically this is because the
176 * component sits behind a bus that abstracts away the endian of the
177 * original data, ie. one for which the transmission endian is defined
178 * (I2S/SLIMbus/SoundWire), or the concept of endian doesn't exist (PDM,
179 * analogue).
180 */
4ff1fef1 181 unsigned int endianness:1;
1c348f74 182 unsigned int legacy_dai_naming:1;
4ff1fef1
KM		 183
184 /* this component uses topology and ignore machine driver FEs */
185 const char *ignore_machine;
186 const char *topology_name_prefix;
187 int (*be_hw_params_fixup)(struct snd_soc_pcm_runtime *rtd,
188 struct snd_pcm_hw_params *params);
189 bool use_dai_pcm_id; /* use DAI link PCM ID as PCM device number */
190 int be_pcm_base; /* base device ID for all BE PCMs */
d462f6ed
HK		 191
192#ifdef CONFIG_DEBUG_FS
193 const char *debugfs_prefix;
194#endif
4ff1fef1
KM		 195};
196
197struct snd_soc_component {
198 const char *name;
199 int id;
200 const char *name_prefix;
201 struct device *dev;
202 struct snd_soc_card *card;
203
204 unsigned int active;
205
206 unsigned int suspended:1; /* is in suspend PM state */
207
208 struct list_head list;
209 struct list_head card_aux_list; /* for auxiliary bound components */
210 struct list_head card_list;
211
212 const struct snd_soc_component_driver *driver;
213
214 struct list_head dai_list;
215 int num_dai;
216
217 struct regmap *regmap;
218 int val_bytes;
219
220 struct mutex io_mutex;
221
222 /* attached dynamic objects */
223 struct list_head dobj_list;
224
225 /*
226 * DO NOT use any of the fields below in drivers, they are temporary and
227 * are going to be removed again soon. If you use them in driver code
228 * the driver will be marked as BROKEN when these fields are removed.
229 */
230
231 /* Don't use these, use snd_soc_component_get_dapm() */
232 struct snd_soc_dapm_context dapm;
233
234 /* machine specific init */
235 int (*init)(struct snd_soc_component *component);
236
51aff91a 237 /* function mark */
a739fdc2 238 void *mark_module;
51aff91a 239 struct snd_pcm_substream *mark_open;
3a36a64a 240 struct snd_pcm_substream *mark_hw_params;
6374f493 241 struct snd_pcm_substream *mark_trigger;
f94ba9ac 242 struct snd_compr_stream *mark_compr_open;
939a5cfb 243 void *mark_pm;
51aff91a 244
4ff1fef1
KM		 245 struct dentry *debugfs_root;
246 const char *debugfs_prefix;
4ff1fef1
KM		 247};
248
249#define for_each_component_dais(component, dai)\
250 list_for_each_entry(dai, &(component)->dai_list, list)
251#define for_each_component_dais_safe(component, dai, _dai)\
252 list_for_each_entry_safe(dai, _dai, &(component)->dai_list, list)
253
254/**
255 * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
256 * embedded in
257 * @dapm: The DAPM context to cast to the component
258 *
259 * This function must only be used on DAPM contexts that are known to be part of
260 * a component (e.g. in a component driver). Otherwise the behavior is
261 * undefined.
262 */
263static inline struct snd_soc_component *snd_soc_dapm_to_component(
264 struct snd_soc_dapm_context *dapm)
265{
266 return container_of(dapm, struct snd_soc_component, dapm);
267}
268
269/**
270 * snd_soc_component_get_dapm() - Returns the DAPM context associated with a
271 * component
272 * @component: The component for which to get the DAPM context
273 */
274static inline struct snd_soc_dapm_context *snd_soc_component_get_dapm(
275 struct snd_soc_component *component)
276{
277 return &component->dapm;
278}
279
280/**
281 * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level
282 * @component: The COMPONENT for which to initialize the DAPM bias level
283 * @level: The DAPM level to initialize to
284 *
285 * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level()
286 */
287static inline void
288snd_soc_component_init_bias_level(struct snd_soc_component *component,
289 enum snd_soc_bias_level level)
290{
291 snd_soc_dapm_init_bias_level(
292 snd_soc_component_get_dapm(component), level);
293}
294
295/**
296 * snd_soc_component_get_bias_level() - Get current COMPONENT DAPM bias level
297 * @component: The COMPONENT for which to get the DAPM bias level
298 *
299 * Returns: The current DAPM bias level of the COMPONENT.
300 */
301static inline enum snd_soc_bias_level
302snd_soc_component_get_bias_level(struct snd_soc_component *component)
303{
304 return snd_soc_dapm_get_bias_level(
305 snd_soc_component_get_dapm(component));
306}
307
308/**
309 * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level
310 * @component: The COMPONENT for which to set the level
311 * @level: The level to set to
312 *
313 * Forces the COMPONENT bias level to a specific state. See
314 * snd_soc_dapm_force_bias_level().
315 */
316static inline int
317snd_soc_component_force_bias_level(struct snd_soc_component *component,
318 enum snd_soc_bias_level level)
319{
320 return snd_soc_dapm_force_bias_level(
321 snd_soc_component_get_dapm(component),
322 level);
323}
324
325/**
326 * snd_soc_dapm_kcontrol_component() - Returns the component associated to a
327 * kcontrol
328 * @kcontrol: The kcontrol
329 *
330 * This function must only be used on DAPM contexts that are known to be part of
331 * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined
332 */
333static inline struct snd_soc_component *snd_soc_dapm_kcontrol_component(
334 struct snd_kcontrol *kcontrol)
335{
336 return snd_soc_dapm_to_component(snd_soc_dapm_kcontrol_dapm(kcontrol));
337}
338
339/**
340 * snd_soc_component_cache_sync() - Sync the register cache with the hardware
341 * @component: COMPONENT to sync
342 *
343 * Note: This function will call regcache_sync()
344 */
345static inline int snd_soc_component_cache_sync(
346 struct snd_soc_component *component)
347{
348 return regcache_sync(component->regmap);
349}
350
257c4dac
KM		 351void snd_soc_component_set_aux(struct snd_soc_component *component,
352 struct snd_soc_aux_dev *aux);
353int snd_soc_component_init(struct snd_soc_component *component);
8f1a1681 354int snd_soc_component_is_dummy(struct snd_soc_component *component);
536aba1d 355
4ff1fef1 356/* component IO */
cf6e26c7 357unsigned int snd_soc_component_read(struct snd_soc_component *component,
4ff1fef1
KM		 358 unsigned int reg);
359int snd_soc_component_write(struct snd_soc_component *component,
360 unsigned int reg, unsigned int val);
361int snd_soc_component_update_bits(struct snd_soc_component *component,
362 unsigned int reg, unsigned int mask,
363 unsigned int val);
364int snd_soc_component_update_bits_async(struct snd_soc_component *component,
365 unsigned int reg, unsigned int mask,
366 unsigned int val);
367void snd_soc_component_async_complete(struct snd_soc_component *component);
368int snd_soc_component_test_bits(struct snd_soc_component *component,
369 unsigned int reg, unsigned int mask,
370 unsigned int value);
371
1da0b989
SK		 372unsigned int snd_soc_component_read_field(struct snd_soc_component *component,
373 unsigned int reg, unsigned int mask);
374int snd_soc_component_write_field(struct snd_soc_component *component,
375 unsigned int reg, unsigned int mask,
376 unsigned int val);
377
4ff1fef1
KM		 378/* component wide operations */
379int snd_soc_component_set_sysclk(struct snd_soc_component *component,
380 int clk_id, int source,
381 unsigned int freq, int dir);
382int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
383 int source, unsigned int freq_in,
384 unsigned int freq_out);
385int snd_soc_component_set_jack(struct snd_soc_component *component,
386 struct snd_soc_jack *jack, void *data);
387
9d415fbf
KM		 388void snd_soc_component_seq_notifier(struct snd_soc_component *component,
389 enum snd_soc_dapm_type type, int subseq);
8e2a990d
KM		 390int snd_soc_component_stream_event(struct snd_soc_component *component,
391 int event);
7951b146
KM		 392int snd_soc_component_set_bias_level(struct snd_soc_component *component,
393 enum snd_soc_bias_level level);
9d415fbf 394
c7d75b59 395void snd_soc_component_setup_regmap(struct snd_soc_component *component);
4ff1fef1
KM		 396#ifdef CONFIG_REGMAP
397void snd_soc_component_init_regmap(struct snd_soc_component *component,
398 struct regmap *regmap);
399void snd_soc_component_exit_regmap(struct snd_soc_component *component);
400#endif
401
4a81e8f3 402#define snd_soc_component_module_get_when_probe(component)\
51aff91a
KM		 403 snd_soc_component_module_get(component, NULL, 0)
404#define snd_soc_component_module_get_when_open(component, substream) \
405 snd_soc_component_module_get(component, substream, 1)
4a81e8f3 406int snd_soc_component_module_get(struct snd_soc_component *component,
a739fdc2 407 void *mark, int upon_open);
4a81e8f3 408#define snd_soc_component_module_put_when_remove(component) \
51aff91a
KM		 409 snd_soc_component_module_put(component, NULL, 0, 0)
410#define snd_soc_component_module_put_when_close(component, substream, rollback) \
411 snd_soc_component_module_put(component, substream, 1, rollback)
4a81e8f3 412void snd_soc_component_module_put(struct snd_soc_component *component,
a739fdc2 413 void *mark, int upon_open, int rollback);
4a81e8f3 414
4ff1fef1
KM		 415static inline void snd_soc_component_set_drvdata(struct snd_soc_component *c,
416 void *data)
417{
418 dev_set_drvdata(c->dev, data);
419}
420
421static inline void *snd_soc_component_get_drvdata(struct snd_soc_component *c)
422{
423 return dev_get_drvdata(c->dev);
424}
425
488b2ca5
KM		 426static inline unsigned int
427snd_soc_component_active(struct snd_soc_component *component)
428{
429 return component->active;
430}
431
4ff1fef1
KM		 432/* component pin */
433int snd_soc_component_enable_pin(struct snd_soc_component *component,
434 const char *pin);
435int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
436 const char *pin);
437int snd_soc_component_disable_pin(struct snd_soc_component *component,
438 const char *pin);
439int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
440 const char *pin);
441int snd_soc_component_nc_pin(struct snd_soc_component *component,
442 const char *pin);
443int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
444 const char *pin);
445int snd_soc_component_get_pin_status(struct snd_soc_component *component,
446 const char *pin);
447int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
448 const char *pin);
449int snd_soc_component_force_enable_pin_unlocked(
450 struct snd_soc_component *component,
451 const char *pin);
452
ae2f4849
KM		 453/* component driver ops */
454int snd_soc_component_open(struct snd_soc_component *component,
455 struct snd_pcm_substream *substream);
3672beb8 456int snd_soc_component_close(struct snd_soc_component *component,
51aff91a
KM		 457 struct snd_pcm_substream *substream,
458 int rollback);
66c51573 459void snd_soc_component_suspend(struct snd_soc_component *component);
9a840cba 460void snd_soc_component_resume(struct snd_soc_component *component);
e40fadbc 461int snd_soc_component_is_suspended(struct snd_soc_component *component);
08e837dd 462int snd_soc_component_probe(struct snd_soc_component *component);
03b34dd7 463void snd_soc_component_remove(struct snd_soc_component *component);
2c7b1704
KM		 464int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component,
465 struct device_node *ep);
a2a34175 466int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,
933f98be 467 const struct of_phandle_args *args,
a2a34175 468 const char **dai_name);
cd46f382
PU		 469int snd_soc_component_compr_open(struct snd_soc_component *component,
470 struct snd_compr_stream *cstream);
471void snd_soc_component_compr_free(struct snd_soc_component *component,
472 struct snd_compr_stream *cstream,
f94ba9ac 473 int rollback);
08aee251 474int snd_soc_component_compr_trigger(struct snd_compr_stream *cstream, int cmd);
ff08cf80
KM		 475int snd_soc_component_compr_set_params(struct snd_compr_stream *cstream,
476 struct snd_compr_params *params);
77c221ec
KM		 477int snd_soc_component_compr_get_params(struct snd_compr_stream *cstream,
478 struct snd_codec *params);
d67fcb2d
KM		 479int snd_soc_component_compr_get_caps(struct snd_compr_stream *cstream,
480 struct snd_compr_caps *caps);
0f6fe097
KM		 481int snd_soc_component_compr_get_codec_caps(struct snd_compr_stream *cstream,
482 struct snd_compr_codec_caps *codec);
0506b885 483int snd_soc_component_compr_ack(struct snd_compr_stream *cstream, size_t bytes);
03ecea64
KM		 484int snd_soc_component_compr_pointer(struct snd_compr_stream *cstream,
485 struct snd_compr_tstamp *tstamp);
b5852e66
KM		 486int snd_soc_component_compr_copy(struct snd_compr_stream *cstream,
487 char __user *buf, size_t count);
1b308fb1
KM		 488int snd_soc_component_compr_set_metadata(struct snd_compr_stream *cstream,
489 struct snd_compr_metadata *metadata);
bab78c23
KM		 490int snd_soc_component_compr_get_metadata(struct snd_compr_stream *cstream,
491 struct snd_compr_metadata *metadata);
ae2f4849 492
0035e256 493int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream);
96a47908
KM		 494int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream,
495 unsigned int cmd, void *arg);
1e5ddb6b 496int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream);
82d81f5c
KM		 497int snd_soc_pcm_component_copy_user(struct snd_pcm_substream *substream,
498 int channel, unsigned long pos,
499 void __user *buf, unsigned long bytes);
9c712e4f
KM		 500struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream,
501 unsigned long offset);
205875e1
KM		 502int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream,
503 struct vm_area_struct *vma);
b2b2afbb
KM		 504int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd);
505void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd);
4f39514f 506int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream);
e1bafa82 507int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream,
3a36a64a 508 struct snd_pcm_hw_params *params);
04751119 509void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream,
3a36a64a 510 int rollback);
32fd1204 511int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream,
6374f493 512 int cmd, int rollback);
939a5cfb
KM		 513int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd,
514 void *stream);
515void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd,
516 void *stream, int rollback);
8bdfc045 517int snd_soc_pcm_component_ack(struct snd_pcm_substream *substream);
403f830e
KM		 518void snd_soc_pcm_component_delay(struct snd_pcm_substream *substream,
519 snd_pcm_sframes_t *cpu_delay, snd_pcm_sframes_t *codec_delay);
0035e256 520
4ff1fef1 521#endif /* __SOC_COMPONENT_H */
Linux 6.x block layer and io_uring tree(s)