3  * soc-component.h
14  * Component probe and remove ordering levels for components with runtime
28 /* component interface */
30 	int (*open)(struct snd_soc_component *component,
32 	int (*free)(struct snd_soc_component *component,
34 	int (*set_params)(struct snd_soc_component *component,
37 	int (*get_params)(struct snd_soc_component *component,
40 	int (*set_metadata)(struct snd_soc_component *component,
43 	int (*get_metadata)(struct snd_soc_component *component,
46 	int (*trigger)(struct snd_soc_component *component,
48 	int (*pointer)(struct snd_soc_component *component,
51 	int (*copy)(struct snd_soc_component *component,
54 	int (*mmap)(struct snd_soc_component *component,
57 	int (*ack)(struct snd_soc_component *component,
59 	int (*get_caps)(struct snd_soc_component *component,
62 	int (*get_codec_caps)(struct snd_soc_component *component,
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);
83 	unsigned int (*read)(struct snd_soc_component *component,
85 	int (*write)(struct snd_soc_component *component,
89 	int (*pcm_construct)(struct snd_soc_component *component,
91 	void (*pcm_destruct)(struct snd_soc_component *component,
94 	/* component wide operations */
95 	int (*set_sysclk)(struct snd_soc_component *component,
97 	int (*set_pll)(struct snd_soc_component *component, int pll_id,
99 	int (*set_jack)(struct snd_soc_component *component,
103 	int (*of_xlate_dai_name)(struct snd_soc_component *component,
108 	void (*seq_notifier)(struct snd_soc_component *component,
110 	int (*stream_event)(struct snd_soc_component *component, int event);
111 	int (*set_bias_level)(struct snd_soc_component *component,
114 	int (*open)(struct snd_soc_component *component,
116 	int (*close)(struct snd_soc_component *component,
118 	int (*ioctl)(struct snd_soc_component *component,
121 	int (*hw_params)(struct snd_soc_component *component,
124 	int (*hw_free)(struct snd_soc_component *component,
126 	int (*prepare)(struct snd_soc_component *component,
128 	int (*trigger)(struct snd_soc_component *component,
130 	int (*sync_stop)(struct snd_soc_component *component,
132 	snd_pcm_uframes_t (*pointer)(struct snd_soc_component *component,
134 	int (*get_time_info)(struct snd_soc_component *component,
139 	int (*copy_user)(struct snd_soc_component *component,
143 	struct page *(*page)(struct snd_soc_component *component,
146 	int (*mmap)(struct snd_soc_component *component,
157 	 * signal if the module handling the component should not be removed
171 	/* this component uses topology and ignore machine driver FEs */
218 	int (*init)(struct snd_soc_component *component);
231 #define for_each_component_dais(component, dai)\  argument
232 	list_for_each_entry(dai, &(component)->dai_list, list)
233 #define for_each_component_dais_safe(component, dai, _dai)\  argument
234 	list_for_each_entry_safe(dai, _dai, &(component)->dai_list, list)
237  * snd_soc_dapm_to_component() - Casts a DAPM context to the component it is
239  * @dapm: The DAPM context to cast to the component
242  * a component (e.g. in a component driver). Otherwise the behavior is
253  *  component
254  * @component: The component for which to get the DAPM context
257 	struct snd_soc_component *component)  in snd_soc_component_get_dapm()  argument
259 	return &component->dapm;  in snd_soc_component_get_dapm()
263  * snd_soc_component_init_bias_level() - Initialize COMPONENT DAPM bias level
264  * @component: The COMPONENT for which to initialize the DAPM bias level
267  * Initializes the COMPONENT DAPM bias level. See snd_soc_dapm_init_bias_level()
270 snd_soc_component_init_bias_level(struct snd_soc_component *component,  in snd_soc_component_init_bias_level()  argument
274 		snd_soc_component_get_dapm(component), level);  in snd_soc_component_init_bias_level()
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
281  * Returns: The current DAPM bias level of the COMPONENT.
284 snd_soc_component_get_bias_level(struct snd_soc_component *component)  in snd_soc_component_get_bias_level()  argument
287 		snd_soc_component_get_dapm(component));  in snd_soc_component_get_bias_level()
291  * snd_soc_component_force_bias_level() - Set the COMPONENT DAPM bias level
292  * @component: The COMPONENT for which to set the level
295  * Forces the COMPONENT bias level to a specific state. See
299 snd_soc_component_force_bias_level(struct snd_soc_component *component,  in snd_soc_component_force_bias_level()  argument
303 		snd_soc_component_get_dapm(component),  in snd_soc_component_force_bias_level()
308  * snd_soc_dapm_kcontrol_component() - Returns the component associated to a
313  * a COMPONENT (e.g. in a COMPONENT driver). Otherwise the behavior is undefined
323  * @component: COMPONENT to sync
328 	struct snd_soc_component *component)  in snd_soc_component_cache_sync()  argument
330 	return regcache_sync(component->regmap);  in snd_soc_component_cache_sync()
333 void snd_soc_component_set_aux(struct snd_soc_component *component,
335 int snd_soc_component_init(struct snd_soc_component *component);
337 /* component IO */
338 unsigned int snd_soc_component_read(struct snd_soc_component *component,
340 int snd_soc_component_write(struct snd_soc_component *component,
342 int snd_soc_component_update_bits(struct snd_soc_component *component,
345 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
348 void snd_soc_component_async_complete(struct snd_soc_component *component);
349 int snd_soc_component_test_bits(struct snd_soc_component *component,
353 /* component wide operations */
354 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
357 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
360 int snd_soc_component_set_jack(struct snd_soc_component *component,
363 void snd_soc_component_seq_notifier(struct snd_soc_component *component,
365 int snd_soc_component_stream_event(struct snd_soc_component *component,
367 int snd_soc_component_set_bias_level(struct snd_soc_component *component,
370 void snd_soc_component_setup_regmap(struct snd_soc_component *component);
372 void snd_soc_component_init_regmap(struct snd_soc_component *component,
374 void snd_soc_component_exit_regmap(struct snd_soc_component *component);
377 #define snd_soc_component_module_get_when_probe(component)\  argument
378 	snd_soc_component_module_get(component, NULL, 0)
379 #define snd_soc_component_module_get_when_open(component, substream)	\  argument
380 	snd_soc_component_module_get(component, substream, 1)
381 int snd_soc_component_module_get(struct snd_soc_component *component,
384 #define snd_soc_component_module_put_when_remove(component)	\  argument
385 	snd_soc_component_module_put(component, NULL, 0, 0)
386 #define snd_soc_component_module_put_when_close(component, substream, rollback) \  argument
387 	snd_soc_component_module_put(component, substream, 1, rollback)
388 void snd_soc_component_module_put(struct snd_soc_component *component,
404 snd_soc_component_active(struct snd_soc_component *component)  in snd_soc_component_active()  argument
406 	return component->active;  in snd_soc_component_active()
409 /* component pin */
410 int snd_soc_component_enable_pin(struct snd_soc_component *component,
412 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
414 int snd_soc_component_disable_pin(struct snd_soc_component *component,
416 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
418 int snd_soc_component_nc_pin(struct snd_soc_component *component,
420 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
422 int snd_soc_component_get_pin_status(struct snd_soc_component *component,
424 int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
427 	struct snd_soc_component *component,
430 /* component driver ops */
431 int snd_soc_component_open(struct snd_soc_component *component,
433 int snd_soc_component_close(struct snd_soc_component *component,
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,
443 int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,