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