1 // SPDX-License-Identifier: GPL-2.0
5 // Copyright 2009-2011 Wolfson Microelectronics PLC.
6 // Copyright (C) 2019 Renesas Electronics Corp.
8 // Mark Brown <broonie@opensource.wolfsonmicro.com>
9 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
11 #include <linux/module.h>
12 #include <linux/pm_runtime.h>
13 #include <sound/soc.h>
15 #define soc_component_ret(dai, ret) _soc_component_ret(dai, __func__, ret)
16 static inline int _soc_component_ret(struct snd_soc_component *component,
17 const char *func, int ret)
19 /* Positive/Zero values are not errors */
23 /* Negative values might be errors */
29 dev_err(component->dev,
30 "ASoC: error at %s on %s: %d\n",
31 func, component->name, ret);
38 * We might want to check substream by using list.
39 * In such case, we can update these macros.
41 #define soc_component_mark_push(component, substream, tgt) ((component)->mark_##tgt = substream)
42 #define soc_component_mark_pop(component, substream, tgt) ((component)->mark_##tgt = NULL)
43 #define soc_component_mark_match(component, substream, tgt) ((component)->mark_##tgt == substream)
45 void snd_soc_component_set_aux(struct snd_soc_component *component,
46 struct snd_soc_aux_dev *aux)
48 component->init = (aux) ? aux->init : NULL;
51 int snd_soc_component_init(struct snd_soc_component *component)
56 ret = component->init(component);
58 return soc_component_ret(component, ret);
62 * snd_soc_component_set_sysclk - configure COMPONENT system or master clock.
63 * @component: COMPONENT
64 * @clk_id: DAI specific clock ID
65 * @source: Source for the clock
66 * @freq: new clock frequency in Hz
67 * @dir: new clock direction - input/output.
69 * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
71 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
72 int clk_id, int source, unsigned int freq,
77 if (component->driver->set_sysclk)
78 ret = component->driver->set_sysclk(component, clk_id, source,
81 return soc_component_ret(component, ret);
83 EXPORT_SYMBOL_GPL(snd_soc_component_set_sysclk);
86 * snd_soc_component_set_pll - configure component PLL.
87 * @component: COMPONENT
88 * @pll_id: DAI specific PLL ID
89 * @source: DAI specific source for the PLL
90 * @freq_in: PLL input clock frequency in Hz
91 * @freq_out: requested PLL output clock frequency in Hz
93 * Configures and enables PLL to generate output clock based on input clock.
95 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
96 int source, unsigned int freq_in,
97 unsigned int freq_out)
101 if (component->driver->set_pll)
102 ret = component->driver->set_pll(component, pll_id, source,
105 return soc_component_ret(component, ret);
107 EXPORT_SYMBOL_GPL(snd_soc_component_set_pll);
109 void snd_soc_component_seq_notifier(struct snd_soc_component *component,
110 enum snd_soc_dapm_type type, int subseq)
112 if (component->driver->seq_notifier)
113 component->driver->seq_notifier(component, type, subseq);
116 int snd_soc_component_stream_event(struct snd_soc_component *component,
121 if (component->driver->stream_event)
122 ret = component->driver->stream_event(component, event);
124 return soc_component_ret(component, ret);
127 int snd_soc_component_set_bias_level(struct snd_soc_component *component,
128 enum snd_soc_bias_level level)
132 if (component->driver->set_bias_level)
133 ret = component->driver->set_bias_level(component, level);
135 return soc_component_ret(component, ret);
138 static int soc_component_pin(struct snd_soc_component *component,
140 int (*pin_func)(struct snd_soc_dapm_context *dapm,
143 struct snd_soc_dapm_context *dapm =
144 snd_soc_component_get_dapm(component);
148 if (!component->name_prefix) {
149 ret = pin_func(dapm, pin);
153 full_name = kasprintf(GFP_KERNEL, "%s %s", component->name_prefix, pin);
159 ret = pin_func(dapm, full_name);
162 return soc_component_ret(component, ret);
165 int snd_soc_component_enable_pin(struct snd_soc_component *component,
168 return soc_component_pin(component, pin, snd_soc_dapm_enable_pin);
170 EXPORT_SYMBOL_GPL(snd_soc_component_enable_pin);
172 int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
175 return soc_component_pin(component, pin, snd_soc_dapm_enable_pin_unlocked);
177 EXPORT_SYMBOL_GPL(snd_soc_component_enable_pin_unlocked);
179 int snd_soc_component_disable_pin(struct snd_soc_component *component,
182 return soc_component_pin(component, pin, snd_soc_dapm_disable_pin);
184 EXPORT_SYMBOL_GPL(snd_soc_component_disable_pin);
186 int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
189 return soc_component_pin(component, pin, snd_soc_dapm_disable_pin_unlocked);
191 EXPORT_SYMBOL_GPL(snd_soc_component_disable_pin_unlocked);
193 int snd_soc_component_nc_pin(struct snd_soc_component *component,
196 return soc_component_pin(component, pin, snd_soc_dapm_nc_pin);
198 EXPORT_SYMBOL_GPL(snd_soc_component_nc_pin);
200 int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
203 return soc_component_pin(component, pin, snd_soc_dapm_nc_pin_unlocked);
205 EXPORT_SYMBOL_GPL(snd_soc_component_nc_pin_unlocked);
207 int snd_soc_component_get_pin_status(struct snd_soc_component *component,
210 return soc_component_pin(component, pin, snd_soc_dapm_get_pin_status);
212 EXPORT_SYMBOL_GPL(snd_soc_component_get_pin_status);
214 int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
217 return soc_component_pin(component, pin, snd_soc_dapm_force_enable_pin);
219 EXPORT_SYMBOL_GPL(snd_soc_component_force_enable_pin);
221 int snd_soc_component_force_enable_pin_unlocked(
222 struct snd_soc_component *component,
225 return soc_component_pin(component, pin, snd_soc_dapm_force_enable_pin_unlocked);
227 EXPORT_SYMBOL_GPL(snd_soc_component_force_enable_pin_unlocked);
230 * snd_soc_component_set_jack - configure component jack.
231 * @component: COMPONENTs
232 * @jack: structure to use for the jack
233 * @data: can be used if codec driver need extra data for configuring jack
235 * Configures and enables jack detection function.
237 int snd_soc_component_set_jack(struct snd_soc_component *component,
238 struct snd_soc_jack *jack, void *data)
242 if (component->driver->set_jack)
243 ret = component->driver->set_jack(component, jack, data);
245 return soc_component_ret(component, ret);
247 EXPORT_SYMBOL_GPL(snd_soc_component_set_jack);
249 int snd_soc_component_module_get(struct snd_soc_component *component,
250 struct snd_pcm_substream *substream,
255 if (component->driver->module_get_upon_open == !!upon_open &&
256 !try_module_get(component->dev->driver->owner))
259 /* mark substream if succeeded */
261 soc_component_mark_push(component, substream, module);
263 return soc_component_ret(component, ret);
266 void snd_soc_component_module_put(struct snd_soc_component *component,
267 struct snd_pcm_substream *substream,
268 int upon_open, int rollback)
270 if (rollback && !soc_component_mark_match(component, substream, module))
273 if (component->driver->module_get_upon_open == !!upon_open)
274 module_put(component->dev->driver->owner);
276 /* remove marked substream */
277 soc_component_mark_pop(component, substream, module);
280 int snd_soc_component_open(struct snd_soc_component *component,
281 struct snd_pcm_substream *substream)
285 if (component->driver->open)
286 ret = component->driver->open(component, substream);
288 /* mark substream if succeeded */
290 soc_component_mark_push(component, substream, open);
292 return soc_component_ret(component, ret);
295 int snd_soc_component_close(struct snd_soc_component *component,
296 struct snd_pcm_substream *substream,
301 if (rollback && !soc_component_mark_match(component, substream, open))
304 if (component->driver->close)
305 ret = component->driver->close(component, substream);
307 /* remove marked substream */
308 soc_component_mark_pop(component, substream, open);
310 return soc_component_ret(component, ret);
313 void snd_soc_component_suspend(struct snd_soc_component *component)
315 if (component->driver->suspend)
316 component->driver->suspend(component);
317 component->suspended = 1;
320 void snd_soc_component_resume(struct snd_soc_component *component)
322 if (component->driver->resume)
323 component->driver->resume(component);
324 component->suspended = 0;
327 int snd_soc_component_is_suspended(struct snd_soc_component *component)
329 return component->suspended;
332 int snd_soc_component_probe(struct snd_soc_component *component)
336 if (component->driver->probe)
337 ret = component->driver->probe(component);
339 return soc_component_ret(component, ret);
342 void snd_soc_component_remove(struct snd_soc_component *component)
344 if (component->driver->remove)
345 component->driver->remove(component);
348 int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component,
349 struct device_node *ep)
353 if (component->driver->of_xlate_dai_id)
354 ret = component->driver->of_xlate_dai_id(component, ep);
356 return soc_component_ret(component, ret);
359 int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,
360 struct of_phandle_args *args,
361 const char **dai_name)
363 if (component->driver->of_xlate_dai_name)
364 return component->driver->of_xlate_dai_name(component,
367 * Don't use soc_component_ret here because we may not want to report
368 * the error just yet. If a device has more than one component, the
369 * first may not match and we don't want spam the log with this.
374 void snd_soc_component_setup_regmap(struct snd_soc_component *component)
376 int val_bytes = regmap_get_val_bytes(component->regmap);
378 /* Errors are legitimate for non-integer byte multiples */
380 component->val_bytes = val_bytes;
386 * snd_soc_component_init_regmap() - Initialize regmap instance for the
388 * @component: The component for which to initialize the regmap instance
389 * @regmap: The regmap instance that should be used by the component
391 * This function allows deferred assignment of the regmap instance that is
392 * associated with the component. Only use this if the regmap instance is not
393 * yet ready when the component is registered. The function must also be called
394 * before the first IO attempt of the component.
396 void snd_soc_component_init_regmap(struct snd_soc_component *component,
397 struct regmap *regmap)
399 component->regmap = regmap;
400 snd_soc_component_setup_regmap(component);
402 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
405 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
407 * @component: The component for which to de-initialize the regmap instance
409 * Calls regmap_exit() on the regmap instance associated to the component and
410 * removes the regmap instance from the component.
412 * This function should only be used if snd_soc_component_init_regmap() was used
413 * to initialize the regmap instance.
415 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
417 regmap_exit(component->regmap);
418 component->regmap = NULL;
420 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
424 static unsigned int soc_component_read_no_lock(
425 struct snd_soc_component *component,
429 unsigned int val = 0;
431 if (component->regmap)
432 ret = regmap_read(component->regmap, reg, &val);
433 else if (component->driver->read) {
435 val = component->driver->read(component, reg);
441 return soc_component_ret(component, ret);
447 * snd_soc_component_read() - Read register value
448 * @component: Component to read from
449 * @reg: Register to read
453 unsigned int snd_soc_component_read(struct snd_soc_component *component,
458 mutex_lock(&component->io_mutex);
459 val = soc_component_read_no_lock(component, reg);
460 mutex_unlock(&component->io_mutex);
464 EXPORT_SYMBOL_GPL(snd_soc_component_read);
466 static int soc_component_write_no_lock(
467 struct snd_soc_component *component,
468 unsigned int reg, unsigned int val)
472 if (component->regmap)
473 ret = regmap_write(component->regmap, reg, val);
474 else if (component->driver->write)
475 ret = component->driver->write(component, reg, val);
477 return soc_component_ret(component, ret);
481 * snd_soc_component_write() - Write register value
482 * @component: Component to write to
483 * @reg: Register to write
484 * @val: Value to write to the register
486 * Return: 0 on success, a negative error code otherwise.
488 int snd_soc_component_write(struct snd_soc_component *component,
489 unsigned int reg, unsigned int val)
493 mutex_lock(&component->io_mutex);
494 ret = soc_component_write_no_lock(component, reg, val);
495 mutex_unlock(&component->io_mutex);
499 EXPORT_SYMBOL_GPL(snd_soc_component_write);
501 static int snd_soc_component_update_bits_legacy(
502 struct snd_soc_component *component, unsigned int reg,
503 unsigned int mask, unsigned int val, bool *change)
505 unsigned int old, new;
508 mutex_lock(&component->io_mutex);
510 old = soc_component_read_no_lock(component, reg);
512 new = (old & ~mask) | (val & mask);
513 *change = old != new;
515 ret = soc_component_write_no_lock(component, reg, new);
517 mutex_unlock(&component->io_mutex);
519 return soc_component_ret(component, ret);
523 * snd_soc_component_update_bits() - Perform read/modify/write cycle
524 * @component: Component to update
525 * @reg: Register to update
526 * @mask: Mask that specifies which bits to update
527 * @val: New value for the bits specified by mask
529 * Return: 1 if the operation was successful and the value of the register
530 * changed, 0 if the operation was successful, but the value did not change.
531 * Returns a negative error code otherwise.
533 int snd_soc_component_update_bits(struct snd_soc_component *component,
534 unsigned int reg, unsigned int mask, unsigned int val)
539 if (component->regmap)
540 ret = regmap_update_bits_check(component->regmap, reg, mask,
543 ret = snd_soc_component_update_bits_legacy(component, reg,
547 return soc_component_ret(component, ret);
550 EXPORT_SYMBOL_GPL(snd_soc_component_update_bits);
553 * snd_soc_component_update_bits_async() - Perform asynchronous
554 * read/modify/write cycle
555 * @component: Component to update
556 * @reg: Register to update
557 * @mask: Mask that specifies which bits to update
558 * @val: New value for the bits specified by mask
560 * This function is similar to snd_soc_component_update_bits(), but the update
561 * operation is scheduled asynchronously. This means it may not be completed
562 * when the function returns. To make sure that all scheduled updates have been
563 * completed snd_soc_component_async_complete() must be called.
565 * Return: 1 if the operation was successful and the value of the register
566 * changed, 0 if the operation was successful, but the value did not change.
567 * Returns a negative error code otherwise.
569 int snd_soc_component_update_bits_async(struct snd_soc_component *component,
570 unsigned int reg, unsigned int mask, unsigned int val)
575 if (component->regmap)
576 ret = regmap_update_bits_check_async(component->regmap, reg,
579 ret = snd_soc_component_update_bits_legacy(component, reg,
583 return soc_component_ret(component, ret);
586 EXPORT_SYMBOL_GPL(snd_soc_component_update_bits_async);
589 * snd_soc_component_async_complete() - Ensure asynchronous I/O has completed
590 * @component: Component for which to wait
592 * This function blocks until all asynchronous I/O which has previously been
593 * scheduled using snd_soc_component_update_bits_async() has completed.
595 void snd_soc_component_async_complete(struct snd_soc_component *component)
597 if (component->regmap)
598 regmap_async_complete(component->regmap);
600 EXPORT_SYMBOL_GPL(snd_soc_component_async_complete);
603 * snd_soc_component_test_bits - Test register for change
604 * @component: component
605 * @reg: Register to test
606 * @mask: Mask that specifies which bits to test
607 * @value: Value to test against
609 * Tests a register with a new value and checks if the new value is
610 * different from the old value.
612 * Return: 1 for change, otherwise 0.
614 int snd_soc_component_test_bits(struct snd_soc_component *component,
615 unsigned int reg, unsigned int mask, unsigned int value)
617 unsigned int old, new;
619 old = snd_soc_component_read(component, reg);
620 new = (old & ~mask) | value;
623 EXPORT_SYMBOL_GPL(snd_soc_component_test_bits);
625 int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream)
627 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
628 struct snd_soc_component *component;
631 /* FIXME: use 1st pointer */
632 for_each_rtd_components(rtd, i, component)
633 if (component->driver->pointer)
634 return component->driver->pointer(component, substream);
639 int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream,
640 unsigned int cmd, void *arg)
642 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
643 struct snd_soc_component *component;
646 /* FIXME: use 1st ioctl */
647 for_each_rtd_components(rtd, i, component)
648 if (component->driver->ioctl)
649 return soc_component_ret(
651 component->driver->ioctl(component,
652 substream, cmd, arg));
654 return snd_pcm_lib_ioctl(substream, cmd, arg);
657 int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream)
659 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
660 struct snd_soc_component *component;
663 for_each_rtd_components(rtd, i, component) {
664 if (component->driver->sync_stop) {
665 ret = component->driver->sync_stop(component,
668 return soc_component_ret(component, ret);
675 int snd_soc_pcm_component_copy_user(struct snd_pcm_substream *substream,
676 int channel, unsigned long pos,
677 void __user *buf, unsigned long bytes)
679 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
680 struct snd_soc_component *component;
683 /* FIXME. it returns 1st copy now */
684 for_each_rtd_components(rtd, i, component)
685 if (component->driver->copy_user)
686 return soc_component_ret(
688 component->driver->copy_user(
689 component, substream, channel,
695 struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream,
696 unsigned long offset)
698 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
699 struct snd_soc_component *component;
703 /* FIXME. it returns 1st page now */
704 for_each_rtd_components(rtd, i, component) {
705 if (component->driver->page) {
706 page = component->driver->page(component,
716 int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream,
717 struct vm_area_struct *vma)
719 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
720 struct snd_soc_component *component;
723 /* FIXME. it returns 1st mmap now */
724 for_each_rtd_components(rtd, i, component)
725 if (component->driver->mmap)
726 return soc_component_ret(
728 component->driver->mmap(component,
734 int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd)
736 struct snd_soc_component *component;
740 for_each_rtd_components(rtd, i, component) {
741 if (component->driver->pcm_construct) {
742 ret = component->driver->pcm_construct(component, rtd);
744 return soc_component_ret(component, ret);
751 void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd)
753 struct snd_soc_component *component;
759 for_each_rtd_components(rtd, i, component)
760 if (component->driver->pcm_destruct)
761 component->driver->pcm_destruct(component, rtd->pcm);
764 int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream)
766 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
767 struct snd_soc_component *component;
770 for_each_rtd_components(rtd, i, component) {
771 if (component->driver->prepare) {
772 ret = component->driver->prepare(component, substream);
774 return soc_component_ret(component, ret);
781 int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream,
782 struct snd_pcm_hw_params *params,
783 struct snd_soc_component **last)
785 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
786 struct snd_soc_component *component;
789 for_each_rtd_components(rtd, i, component) {
790 if (component->driver->hw_params) {
791 ret = component->driver->hw_params(component,
795 return soc_component_ret(component, ret);
804 void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream,
805 struct snd_soc_component *last)
807 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
808 struct snd_soc_component *component;
811 for_each_rtd_components(rtd, i, component) {
812 if (component == last)
815 if (component->driver->hw_free) {
816 ret = component->driver->hw_free(component, substream);
818 soc_component_ret(component, ret);
823 int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream,
826 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
827 struct snd_soc_component *component;
830 for_each_rtd_components(rtd, i, component) {
831 if (component->driver->trigger) {
832 ret = component->driver->trigger(component, substream, cmd);
834 return soc_component_ret(component, ret);
841 int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd,
844 struct snd_soc_component *component;
847 for_each_rtd_components(rtd, i, component) {
848 ret = pm_runtime_get_sync(component->dev);
849 if (ret < 0 && ret != -EACCES) {
850 pm_runtime_put_noidle(component->dev);
851 return soc_component_ret(component, ret);
853 /* mark stream if succeeded */
854 soc_component_mark_push(component, stream, pm);
860 void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd,
861 void *stream, int rollback)
863 struct snd_soc_component *component;
866 for_each_rtd_components(rtd, i, component) {
867 if (rollback && !soc_component_mark_match(component, stream, pm))
870 pm_runtime_mark_last_busy(component->dev);
871 pm_runtime_put_autosuspend(component->dev);
873 /* remove marked stream */
874 soc_component_mark_pop(component, stream, pm);