Loading...
1// SPDX-License-Identifier: GPL-2.0
2//
3// soc-component.c
4//
5// Copyright 2009-2011 Wolfson Microelectronics PLC.
6// Copyright (C) 2019 Renesas Electronics Corp.
7//
8// Mark Brown <broonie@opensource.wolfsonmicro.com>
9// Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
10//
11#include <linux/module.h>
12#include <linux/pm_runtime.h>
13#include <sound/soc.h>
14#include <linux/bitops.h>
15
16#define soc_component_ret(dai, ret) _soc_component_ret(dai, __func__, ret, -1)
17#define soc_component_ret_reg_rw(dai, ret, reg) _soc_component_ret(dai, __func__, ret, reg)
18static inline int _soc_component_ret(struct snd_soc_component *component,
19 const char *func, int ret, int reg)
20{
21 /* Positive/Zero values are not errors */
22 if (ret >= 0)
23 return ret;
24
25 /* Negative values might be errors */
26 switch (ret) {
27 case -EPROBE_DEFER:
28 case -ENOTSUPP:
29 break;
30 default:
31 if (reg == -1)
32 dev_err(component->dev,
33 "ASoC: error at %s on %s: %d\n",
34 func, component->name, ret);
35 else
36 dev_err(component->dev,
37 "ASoC: error at %s on %s for register: [0x%08x] %d\n",
38 func, component->name, reg, ret);
39 }
40
41 return ret;
42}
43
44static inline int soc_component_field_shift(struct snd_soc_component *component,
45 unsigned int mask)
46{
47 if (!mask) {
48 dev_err(component->dev, "ASoC: error field mask is zero for %s\n",
49 component->name);
50 return 0;
51 }
52
53 return (ffs(mask) - 1);
54}
55
56/*
57 * We might want to check substream by using list.
58 * In such case, we can update these macros.
59 */
60#define soc_component_mark_push(component, substream, tgt) ((component)->mark_##tgt = substream)
61#define soc_component_mark_pop(component, substream, tgt) ((component)->mark_##tgt = NULL)
62#define soc_component_mark_match(component, substream, tgt) ((component)->mark_##tgt == substream)
63
64void snd_soc_component_set_aux(struct snd_soc_component *component,
65 struct snd_soc_aux_dev *aux)
66{
67 component->init = (aux) ? aux->init : NULL;
68}
69
70int snd_soc_component_init(struct snd_soc_component *component)
71{
72 int ret = 0;
73
74 if (component->init)
75 ret = component->init(component);
76
77 return soc_component_ret(component, ret);
78}
79
80/**
81 * snd_soc_component_set_sysclk - configure COMPONENT system or master clock.
82 * @component: COMPONENT
83 * @clk_id: DAI specific clock ID
84 * @source: Source for the clock
85 * @freq: new clock frequency in Hz
86 * @dir: new clock direction - input/output.
87 *
88 * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
89 */
90int snd_soc_component_set_sysclk(struct snd_soc_component *component,
91 int clk_id, int source, unsigned int freq,
92 int dir)
93{
94 int ret = -ENOTSUPP;
95
96 if (component->driver->set_sysclk)
97 ret = component->driver->set_sysclk(component, clk_id, source,
98 freq, dir);
99
100 return soc_component_ret(component, ret);
101}
102EXPORT_SYMBOL_GPL(snd_soc_component_set_sysclk);
103
104/*
105 * snd_soc_component_set_pll - configure component PLL.
106 * @component: COMPONENT
107 * @pll_id: DAI specific PLL ID
108 * @source: DAI specific source for the PLL
109 * @freq_in: PLL input clock frequency in Hz
110 * @freq_out: requested PLL output clock frequency in Hz
111 *
112 * Configures and enables PLL to generate output clock based on input clock.
113 */
114int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
115 int source, unsigned int freq_in,
116 unsigned int freq_out)
117{
118 int ret = -EINVAL;
119
120 if (component->driver->set_pll)
121 ret = component->driver->set_pll(component, pll_id, source,
122 freq_in, freq_out);
123
124 return soc_component_ret(component, ret);
125}
126EXPORT_SYMBOL_GPL(snd_soc_component_set_pll);
127
128void snd_soc_component_seq_notifier(struct snd_soc_component *component,
129 enum snd_soc_dapm_type type, int subseq)
130{
131 if (component->driver->seq_notifier)
132 component->driver->seq_notifier(component, type, subseq);
133}
134
135int snd_soc_component_stream_event(struct snd_soc_component *component,
136 int event)
137{
138 int ret = 0;
139
140 if (component->driver->stream_event)
141 ret = component->driver->stream_event(component, event);
142
143 return soc_component_ret(component, ret);
144}
145
146int snd_soc_component_set_bias_level(struct snd_soc_component *component,
147 enum snd_soc_bias_level level)
148{
149 int ret = 0;
150
151 if (component->driver->set_bias_level)
152 ret = component->driver->set_bias_level(component, level);
153
154 return soc_component_ret(component, ret);
155}
156
157int snd_soc_component_enable_pin(struct snd_soc_component *component,
158 const char *pin)
159{
160 struct snd_soc_dapm_context *dapm =
161 snd_soc_component_get_dapm(component);
162 return snd_soc_dapm_enable_pin(dapm, pin);
163}
164EXPORT_SYMBOL_GPL(snd_soc_component_enable_pin);
165
166int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
167 const char *pin)
168{
169 struct snd_soc_dapm_context *dapm =
170 snd_soc_component_get_dapm(component);
171 return snd_soc_dapm_enable_pin_unlocked(dapm, pin);
172}
173EXPORT_SYMBOL_GPL(snd_soc_component_enable_pin_unlocked);
174
175int snd_soc_component_disable_pin(struct snd_soc_component *component,
176 const char *pin)
177{
178 struct snd_soc_dapm_context *dapm =
179 snd_soc_component_get_dapm(component);
180 return snd_soc_dapm_disable_pin(dapm, pin);
181}
182EXPORT_SYMBOL_GPL(snd_soc_component_disable_pin);
183
184int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
185 const char *pin)
186{
187 struct snd_soc_dapm_context *dapm =
188 snd_soc_component_get_dapm(component);
189 return snd_soc_dapm_disable_pin_unlocked(dapm, pin);
190}
191EXPORT_SYMBOL_GPL(snd_soc_component_disable_pin_unlocked);
192
193int snd_soc_component_nc_pin(struct snd_soc_component *component,
194 const char *pin)
195{
196 struct snd_soc_dapm_context *dapm =
197 snd_soc_component_get_dapm(component);
198 return snd_soc_dapm_nc_pin(dapm, pin);
199}
200EXPORT_SYMBOL_GPL(snd_soc_component_nc_pin);
201
202int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
203 const char *pin)
204{
205 struct snd_soc_dapm_context *dapm =
206 snd_soc_component_get_dapm(component);
207 return snd_soc_dapm_nc_pin_unlocked(dapm, pin);
208}
209EXPORT_SYMBOL_GPL(snd_soc_component_nc_pin_unlocked);
210
211int snd_soc_component_get_pin_status(struct snd_soc_component *component,
212 const char *pin)
213{
214 struct snd_soc_dapm_context *dapm =
215 snd_soc_component_get_dapm(component);
216 return snd_soc_dapm_get_pin_status(dapm, pin);
217}
218EXPORT_SYMBOL_GPL(snd_soc_component_get_pin_status);
219
220int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
221 const char *pin)
222{
223 struct snd_soc_dapm_context *dapm =
224 snd_soc_component_get_dapm(component);
225 return snd_soc_dapm_force_enable_pin(dapm, pin);
226}
227EXPORT_SYMBOL_GPL(snd_soc_component_force_enable_pin);
228
229int snd_soc_component_force_enable_pin_unlocked(
230 struct snd_soc_component *component,
231 const char *pin)
232{
233 struct snd_soc_dapm_context *dapm =
234 snd_soc_component_get_dapm(component);
235 return snd_soc_dapm_force_enable_pin_unlocked(dapm, pin);
236}
237EXPORT_SYMBOL_GPL(snd_soc_component_force_enable_pin_unlocked);
238
239/**
240 * snd_soc_component_set_jack - configure component jack.
241 * @component: COMPONENTs
242 * @jack: structure to use for the jack
243 * @data: can be used if codec driver need extra data for configuring jack
244 *
245 * Configures and enables jack detection function.
246 */
247int snd_soc_component_set_jack(struct snd_soc_component *component,
248 struct snd_soc_jack *jack, void *data)
249{
250 int ret = -ENOTSUPP;
251
252 if (component->driver->set_jack)
253 ret = component->driver->set_jack(component, jack, data);
254
255 return soc_component_ret(component, ret);
256}
257EXPORT_SYMBOL_GPL(snd_soc_component_set_jack);
258
259int snd_soc_component_module_get(struct snd_soc_component *component,
260 void *mark, int upon_open)
261{
262 int ret = 0;
263
264 if (component->driver->module_get_upon_open == !!upon_open &&
265 !try_module_get(component->dev->driver->owner))
266 ret = -ENODEV;
267
268 /* mark module if succeeded */
269 if (ret == 0)
270 soc_component_mark_push(component, mark, module);
271
272 return soc_component_ret(component, ret);
273}
274
275void snd_soc_component_module_put(struct snd_soc_component *component,
276 void *mark, int upon_open, int rollback)
277{
278 if (rollback && !soc_component_mark_match(component, mark, module))
279 return;
280
281 if (component->driver->module_get_upon_open == !!upon_open)
282 module_put(component->dev->driver->owner);
283
284 /* remove the mark from module */
285 soc_component_mark_pop(component, mark, module);
286}
287
288int snd_soc_component_open(struct snd_soc_component *component,
289 struct snd_pcm_substream *substream)
290{
291 int ret = 0;
292
293 if (component->driver->open)
294 ret = component->driver->open(component, substream);
295
296 /* mark substream if succeeded */
297 if (ret == 0)
298 soc_component_mark_push(component, substream, open);
299
300 return soc_component_ret(component, ret);
301}
302
303int snd_soc_component_close(struct snd_soc_component *component,
304 struct snd_pcm_substream *substream,
305 int rollback)
306{
307 int ret = 0;
308
309 if (rollback && !soc_component_mark_match(component, substream, open))
310 return 0;
311
312 if (component->driver->close)
313 ret = component->driver->close(component, substream);
314
315 /* remove marked substream */
316 soc_component_mark_pop(component, substream, open);
317
318 return soc_component_ret(component, ret);
319}
320
321void snd_soc_component_suspend(struct snd_soc_component *component)
322{
323 if (component->driver->suspend)
324 component->driver->suspend(component);
325 component->suspended = 1;
326}
327
328void snd_soc_component_resume(struct snd_soc_component *component)
329{
330 if (component->driver->resume)
331 component->driver->resume(component);
332 component->suspended = 0;
333}
334
335int snd_soc_component_is_suspended(struct snd_soc_component *component)
336{
337 return component->suspended;
338}
339
340int snd_soc_component_probe(struct snd_soc_component *component)
341{
342 int ret = 0;
343
344 if (component->driver->probe)
345 ret = component->driver->probe(component);
346
347 return soc_component_ret(component, ret);
348}
349
350void snd_soc_component_remove(struct snd_soc_component *component)
351{
352 if (component->driver->remove)
353 component->driver->remove(component);
354}
355
356int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component,
357 struct device_node *ep)
358{
359 int ret = -ENOTSUPP;
360
361 if (component->driver->of_xlate_dai_id)
362 ret = component->driver->of_xlate_dai_id(component, ep);
363
364 return soc_component_ret(component, ret);
365}
366
367int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,
368 const struct of_phandle_args *args,
369 const char **dai_name)
370{
371 if (component->driver->of_xlate_dai_name)
372 return component->driver->of_xlate_dai_name(component,
373 args, dai_name);
374 /*
375 * Don't use soc_component_ret here because we may not want to report
376 * the error just yet. If a device has more than one component, the
377 * first may not match and we don't want spam the log with this.
378 */
379 return -ENOTSUPP;
380}
381
382void snd_soc_component_setup_regmap(struct snd_soc_component *component)
383{
384 int val_bytes = regmap_get_val_bytes(component->regmap);
385
386 /* Errors are legitimate for non-integer byte multiples */
387 if (val_bytes > 0)
388 component->val_bytes = val_bytes;
389}
390
391#ifdef CONFIG_REGMAP
392
393/**
394 * snd_soc_component_init_regmap() - Initialize regmap instance for the
395 * component
396 * @component: The component for which to initialize the regmap instance
397 * @regmap: The regmap instance that should be used by the component
398 *
399 * This function allows deferred assignment of the regmap instance that is
400 * associated with the component. Only use this if the regmap instance is not
401 * yet ready when the component is registered. The function must also be called
402 * before the first IO attempt of the component.
403 */
404void snd_soc_component_init_regmap(struct snd_soc_component *component,
405 struct regmap *regmap)
406{
407 component->regmap = regmap;
408 snd_soc_component_setup_regmap(component);
409}
410EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
411
412/**
413 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
414 * component
415 * @component: The component for which to de-initialize the regmap instance
416 *
417 * Calls regmap_exit() on the regmap instance associated to the component and
418 * removes the regmap instance from the component.
419 *
420 * This function should only be used if snd_soc_component_init_regmap() was used
421 * to initialize the regmap instance.
422 */
423void snd_soc_component_exit_regmap(struct snd_soc_component *component)
424{
425 regmap_exit(component->regmap);
426 component->regmap = NULL;
427}
428EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
429
430#endif
431
432int snd_soc_component_compr_open(struct snd_soc_component *component,
433 struct snd_compr_stream *cstream)
434{
435 int ret = 0;
436
437 if (component->driver->compress_ops &&
438 component->driver->compress_ops->open)
439 ret = component->driver->compress_ops->open(component, cstream);
440
441 /* mark substream if succeeded */
442 if (ret == 0)
443 soc_component_mark_push(component, cstream, compr_open);
444
445 return soc_component_ret(component, ret);
446}
447EXPORT_SYMBOL_GPL(snd_soc_component_compr_open);
448
449void snd_soc_component_compr_free(struct snd_soc_component *component,
450 struct snd_compr_stream *cstream,
451 int rollback)
452{
453 if (rollback && !soc_component_mark_match(component, cstream, compr_open))
454 return;
455
456 if (component->driver->compress_ops &&
457 component->driver->compress_ops->free)
458 component->driver->compress_ops->free(component, cstream);
459
460 /* remove marked substream */
461 soc_component_mark_pop(component, cstream, compr_open);
462}
463EXPORT_SYMBOL_GPL(snd_soc_component_compr_free);
464
465int snd_soc_component_compr_trigger(struct snd_compr_stream *cstream, int cmd)
466{
467 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
468 struct snd_soc_component *component;
469 int i, ret;
470
471 for_each_rtd_components(rtd, i, component) {
472 if (component->driver->compress_ops &&
473 component->driver->compress_ops->trigger) {
474 ret = component->driver->compress_ops->trigger(
475 component, cstream, cmd);
476 if (ret < 0)
477 return soc_component_ret(component, ret);
478 }
479 }
480
481 return 0;
482}
483EXPORT_SYMBOL_GPL(snd_soc_component_compr_trigger);
484
485int snd_soc_component_compr_set_params(struct snd_compr_stream *cstream,
486 struct snd_compr_params *params)
487{
488 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
489 struct snd_soc_component *component;
490 int i, ret;
491
492 for_each_rtd_components(rtd, i, component) {
493 if (component->driver->compress_ops &&
494 component->driver->compress_ops->set_params) {
495 ret = component->driver->compress_ops->set_params(
496 component, cstream, params);
497 if (ret < 0)
498 return soc_component_ret(component, ret);
499 }
500 }
501
502 return 0;
503}
504EXPORT_SYMBOL_GPL(snd_soc_component_compr_set_params);
505
506int snd_soc_component_compr_get_params(struct snd_compr_stream *cstream,
507 struct snd_codec *params)
508{
509 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
510 struct snd_soc_component *component;
511 int i, ret;
512
513 for_each_rtd_components(rtd, i, component) {
514 if (component->driver->compress_ops &&
515 component->driver->compress_ops->get_params) {
516 ret = component->driver->compress_ops->get_params(
517 component, cstream, params);
518 return soc_component_ret(component, ret);
519 }
520 }
521
522 return 0;
523}
524EXPORT_SYMBOL_GPL(snd_soc_component_compr_get_params);
525
526int snd_soc_component_compr_get_caps(struct snd_compr_stream *cstream,
527 struct snd_compr_caps *caps)
528{
529 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
530 struct snd_soc_component *component;
531 int i, ret = 0;
532
533 mutex_lock_nested(&rtd->card->pcm_mutex, rtd->card->pcm_subclass);
534
535 for_each_rtd_components(rtd, i, component) {
536 if (component->driver->compress_ops &&
537 component->driver->compress_ops->get_caps) {
538 ret = component->driver->compress_ops->get_caps(
539 component, cstream, caps);
540 break;
541 }
542 }
543
544 mutex_unlock(&rtd->card->pcm_mutex);
545
546 return soc_component_ret(component, ret);
547}
548EXPORT_SYMBOL_GPL(snd_soc_component_compr_get_caps);
549
550int snd_soc_component_compr_get_codec_caps(struct snd_compr_stream *cstream,
551 struct snd_compr_codec_caps *codec)
552{
553 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
554 struct snd_soc_component *component;
555 int i, ret = 0;
556
557 mutex_lock_nested(&rtd->card->pcm_mutex, rtd->card->pcm_subclass);
558
559 for_each_rtd_components(rtd, i, component) {
560 if (component->driver->compress_ops &&
561 component->driver->compress_ops->get_codec_caps) {
562 ret = component->driver->compress_ops->get_codec_caps(
563 component, cstream, codec);
564 break;
565 }
566 }
567
568 mutex_unlock(&rtd->card->pcm_mutex);
569
570 return soc_component_ret(component, ret);
571}
572EXPORT_SYMBOL_GPL(snd_soc_component_compr_get_codec_caps);
573
574int snd_soc_component_compr_ack(struct snd_compr_stream *cstream, size_t bytes)
575{
576 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
577 struct snd_soc_component *component;
578 int i, ret;
579
580 for_each_rtd_components(rtd, i, component) {
581 if (component->driver->compress_ops &&
582 component->driver->compress_ops->ack) {
583 ret = component->driver->compress_ops->ack(
584 component, cstream, bytes);
585 if (ret < 0)
586 return soc_component_ret(component, ret);
587 }
588 }
589
590 return 0;
591}
592EXPORT_SYMBOL_GPL(snd_soc_component_compr_ack);
593
594int snd_soc_component_compr_pointer(struct snd_compr_stream *cstream,
595 struct snd_compr_tstamp *tstamp)
596{
597 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
598 struct snd_soc_component *component;
599 int i, ret;
600
601 for_each_rtd_components(rtd, i, component) {
602 if (component->driver->compress_ops &&
603 component->driver->compress_ops->pointer) {
604 ret = component->driver->compress_ops->pointer(
605 component, cstream, tstamp);
606 return soc_component_ret(component, ret);
607 }
608 }
609
610 return 0;
611}
612EXPORT_SYMBOL_GPL(snd_soc_component_compr_pointer);
613
614int snd_soc_component_compr_copy(struct snd_compr_stream *cstream,
615 char __user *buf, size_t count)
616{
617 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
618 struct snd_soc_component *component;
619 int i, ret = 0;
620
621 mutex_lock_nested(&rtd->card->pcm_mutex, rtd->card->pcm_subclass);
622
623 for_each_rtd_components(rtd, i, component) {
624 if (component->driver->compress_ops &&
625 component->driver->compress_ops->copy) {
626 ret = component->driver->compress_ops->copy(
627 component, cstream, buf, count);
628 break;
629 }
630 }
631
632 mutex_unlock(&rtd->card->pcm_mutex);
633
634 return soc_component_ret(component, ret);
635}
636EXPORT_SYMBOL_GPL(snd_soc_component_compr_copy);
637
638int snd_soc_component_compr_set_metadata(struct snd_compr_stream *cstream,
639 struct snd_compr_metadata *metadata)
640{
641 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
642 struct snd_soc_component *component;
643 int i, ret;
644
645 for_each_rtd_components(rtd, i, component) {
646 if (component->driver->compress_ops &&
647 component->driver->compress_ops->set_metadata) {
648 ret = component->driver->compress_ops->set_metadata(
649 component, cstream, metadata);
650 if (ret < 0)
651 return soc_component_ret(component, ret);
652 }
653 }
654
655 return 0;
656}
657EXPORT_SYMBOL_GPL(snd_soc_component_compr_set_metadata);
658
659int snd_soc_component_compr_get_metadata(struct snd_compr_stream *cstream,
660 struct snd_compr_metadata *metadata)
661{
662 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
663 struct snd_soc_component *component;
664 int i, ret;
665
666 for_each_rtd_components(rtd, i, component) {
667 if (component->driver->compress_ops &&
668 component->driver->compress_ops->get_metadata) {
669 ret = component->driver->compress_ops->get_metadata(
670 component, cstream, metadata);
671 return soc_component_ret(component, ret);
672 }
673 }
674
675 return 0;
676}
677EXPORT_SYMBOL_GPL(snd_soc_component_compr_get_metadata);
678
679static unsigned int soc_component_read_no_lock(
680 struct snd_soc_component *component,
681 unsigned int reg)
682{
683 int ret;
684 unsigned int val = 0;
685
686 if (component->regmap)
687 ret = regmap_read(component->regmap, reg, &val);
688 else if (component->driver->read) {
689 ret = 0;
690 val = component->driver->read(component, reg);
691 }
692 else
693 ret = -EIO;
694
695 if (ret < 0)
696 return soc_component_ret_reg_rw(component, ret, reg);
697
698 return val;
699}
700
701/**
702 * snd_soc_component_read() - Read register value
703 * @component: Component to read from
704 * @reg: Register to read
705 *
706 * Return: read value
707 */
708unsigned int snd_soc_component_read(struct snd_soc_component *component,
709 unsigned int reg)
710{
711 unsigned int val;
712
713 mutex_lock(&component->io_mutex);
714 val = soc_component_read_no_lock(component, reg);
715 mutex_unlock(&component->io_mutex);
716
717 return val;
718}
719EXPORT_SYMBOL_GPL(snd_soc_component_read);
720
721static int soc_component_write_no_lock(
722 struct snd_soc_component *component,
723 unsigned int reg, unsigned int val)
724{
725 int ret = -EIO;
726
727 if (component->regmap)
728 ret = regmap_write(component->regmap, reg, val);
729 else if (component->driver->write)
730 ret = component->driver->write(component, reg, val);
731
732 return soc_component_ret_reg_rw(component, ret, reg);
733}
734
735/**
736 * snd_soc_component_write() - Write register value
737 * @component: Component to write to
738 * @reg: Register to write
739 * @val: Value to write to the register
740 *
741 * Return: 0 on success, a negative error code otherwise.
742 */
743int snd_soc_component_write(struct snd_soc_component *component,
744 unsigned int reg, unsigned int val)
745{
746 int ret;
747
748 mutex_lock(&component->io_mutex);
749 ret = soc_component_write_no_lock(component, reg, val);
750 mutex_unlock(&component->io_mutex);
751
752 return ret;
753}
754EXPORT_SYMBOL_GPL(snd_soc_component_write);
755
756static int snd_soc_component_update_bits_legacy(
757 struct snd_soc_component *component, unsigned int reg,
758 unsigned int mask, unsigned int val, bool *change)
759{
760 unsigned int old, new;
761 int ret = 0;
762
763 mutex_lock(&component->io_mutex);
764
765 old = soc_component_read_no_lock(component, reg);
766
767 new = (old & ~mask) | (val & mask);
768 *change = old != new;
769 if (*change)
770 ret = soc_component_write_no_lock(component, reg, new);
771
772 mutex_unlock(&component->io_mutex);
773
774 return soc_component_ret_reg_rw(component, ret, reg);
775}
776
777/**
778 * snd_soc_component_update_bits() - Perform read/modify/write cycle
779 * @component: Component to update
780 * @reg: Register to update
781 * @mask: Mask that specifies which bits to update
782 * @val: New value for the bits specified by mask
783 *
784 * Return: 1 if the operation was successful and the value of the register
785 * changed, 0 if the operation was successful, but the value did not change.
786 * Returns a negative error code otherwise.
787 */
788int snd_soc_component_update_bits(struct snd_soc_component *component,
789 unsigned int reg, unsigned int mask, unsigned int val)
790{
791 bool change;
792 int ret;
793
794 if (component->regmap)
795 ret = regmap_update_bits_check(component->regmap, reg, mask,
796 val, &change);
797 else
798 ret = snd_soc_component_update_bits_legacy(component, reg,
799 mask, val, &change);
800
801 if (ret < 0)
802 return soc_component_ret_reg_rw(component, ret, reg);
803 return change;
804}
805EXPORT_SYMBOL_GPL(snd_soc_component_update_bits);
806
807/**
808 * snd_soc_component_update_bits_async() - Perform asynchronous
809 * read/modify/write cycle
810 * @component: Component to update
811 * @reg: Register to update
812 * @mask: Mask that specifies which bits to update
813 * @val: New value for the bits specified by mask
814 *
815 * This function is similar to snd_soc_component_update_bits(), but the update
816 * operation is scheduled asynchronously. This means it may not be completed
817 * when the function returns. To make sure that all scheduled updates have been
818 * completed snd_soc_component_async_complete() must be called.
819 *
820 * Return: 1 if the operation was successful and the value of the register
821 * changed, 0 if the operation was successful, but the value did not change.
822 * Returns a negative error code otherwise.
823 */
824int snd_soc_component_update_bits_async(struct snd_soc_component *component,
825 unsigned int reg, unsigned int mask, unsigned int val)
826{
827 bool change;
828 int ret;
829
830 if (component->regmap)
831 ret = regmap_update_bits_check_async(component->regmap, reg,
832 mask, val, &change);
833 else
834 ret = snd_soc_component_update_bits_legacy(component, reg,
835 mask, val, &change);
836
837 if (ret < 0)
838 return soc_component_ret_reg_rw(component, ret, reg);
839 return change;
840}
841EXPORT_SYMBOL_GPL(snd_soc_component_update_bits_async);
842
843/**
844 * snd_soc_component_read_field() - Read register field value
845 * @component: Component to read from
846 * @reg: Register to read
847 * @mask: mask of the register field
848 *
849 * Return: read value of register field.
850 */
851unsigned int snd_soc_component_read_field(struct snd_soc_component *component,
852 unsigned int reg, unsigned int mask)
853{
854 unsigned int val;
855
856 val = snd_soc_component_read(component, reg);
857
858 val = (val & mask) >> soc_component_field_shift(component, mask);
859
860 return val;
861}
862EXPORT_SYMBOL_GPL(snd_soc_component_read_field);
863
864/**
865 * snd_soc_component_write_field() - write to register field
866 * @component: Component to write to
867 * @reg: Register to write
868 * @mask: mask of the register field to update
869 * @val: value of the field to write
870 *
871 * Return: 1 for change, otherwise 0.
872 */
873int snd_soc_component_write_field(struct snd_soc_component *component,
874 unsigned int reg, unsigned int mask,
875 unsigned int val)
876{
877
878 val = (val << soc_component_field_shift(component, mask)) & mask;
879
880 return snd_soc_component_update_bits(component, reg, mask, val);
881}
882EXPORT_SYMBOL_GPL(snd_soc_component_write_field);
883
884/**
885 * snd_soc_component_async_complete() - Ensure asynchronous I/O has completed
886 * @component: Component for which to wait
887 *
888 * This function blocks until all asynchronous I/O which has previously been
889 * scheduled using snd_soc_component_update_bits_async() has completed.
890 */
891void snd_soc_component_async_complete(struct snd_soc_component *component)
892{
893 if (component->regmap)
894 regmap_async_complete(component->regmap);
895}
896EXPORT_SYMBOL_GPL(snd_soc_component_async_complete);
897
898/**
899 * snd_soc_component_test_bits - Test register for change
900 * @component: component
901 * @reg: Register to test
902 * @mask: Mask that specifies which bits to test
903 * @value: Value to test against
904 *
905 * Tests a register with a new value and checks if the new value is
906 * different from the old value.
907 *
908 * Return: 1 for change, otherwise 0.
909 */
910int snd_soc_component_test_bits(struct snd_soc_component *component,
911 unsigned int reg, unsigned int mask, unsigned int value)
912{
913 unsigned int old, new;
914
915 old = snd_soc_component_read(component, reg);
916 new = (old & ~mask) | value;
917 return old != new;
918}
919EXPORT_SYMBOL_GPL(snd_soc_component_test_bits);
920
921int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream)
922{
923 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
924 struct snd_soc_component *component;
925 int i;
926
927 /* FIXME: use 1st pointer */
928 for_each_rtd_components(rtd, i, component)
929 if (component->driver->pointer)
930 return component->driver->pointer(component, substream);
931
932 return 0;
933}
934
935static bool snd_soc_component_is_codec_on_rtd(struct snd_soc_pcm_runtime *rtd,
936 struct snd_soc_component *component)
937{
938 struct snd_soc_dai *dai;
939 int i;
940
941 for_each_rtd_codec_dais(rtd, i, dai) {
942 if (dai->component == component)
943 return true;
944 }
945
946 return false;
947}
948
949void snd_soc_pcm_component_delay(struct snd_pcm_substream *substream,
950 snd_pcm_sframes_t *cpu_delay,
951 snd_pcm_sframes_t *codec_delay)
952{
953 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
954 struct snd_soc_component *component;
955 snd_pcm_sframes_t delay;
956 int i;
957
958 /*
959 * We're looking for the delay through the full audio path so it needs to
960 * be the maximum of the Components doing transmit and the maximum of the
961 * Components doing receive (ie, all CPUs and all CODECs) rather than
962 * just the maximum of all Components.
963 */
964 for_each_rtd_components(rtd, i, component) {
965 if (!component->driver->delay)
966 continue;
967
968 delay = component->driver->delay(component, substream);
969
970 if (snd_soc_component_is_codec_on_rtd(rtd, component))
971 *codec_delay = max(*codec_delay, delay);
972 else
973 *cpu_delay = max(*cpu_delay, delay);
974 }
975}
976
977int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream,
978 unsigned int cmd, void *arg)
979{
980 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
981 struct snd_soc_component *component;
982 int i;
983
984 /* FIXME: use 1st ioctl */
985 for_each_rtd_components(rtd, i, component)
986 if (component->driver->ioctl)
987 return soc_component_ret(
988 component,
989 component->driver->ioctl(component,
990 substream, cmd, arg));
991
992 return snd_pcm_lib_ioctl(substream, cmd, arg);
993}
994
995int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream)
996{
997 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
998 struct snd_soc_component *component;
999 int i, ret;
1000
1001 for_each_rtd_components(rtd, i, component) {
1002 if (component->driver->sync_stop) {
1003 ret = component->driver->sync_stop(component,
1004 substream);
1005 if (ret < 0)
1006 return soc_component_ret(component, ret);
1007 }
1008 }
1009
1010 return 0;
1011}
1012
1013int snd_soc_pcm_component_copy_user(struct snd_pcm_substream *substream,
1014 int channel, unsigned long pos,
1015 void __user *buf, unsigned long bytes)
1016{
1017 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1018 struct snd_soc_component *component;
1019 int i;
1020
1021 /* FIXME. it returns 1st copy now */
1022 for_each_rtd_components(rtd, i, component)
1023 if (component->driver->copy_user)
1024 return soc_component_ret(
1025 component,
1026 component->driver->copy_user(
1027 component, substream, channel,
1028 pos, buf, bytes));
1029
1030 return -EINVAL;
1031}
1032
1033struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream,
1034 unsigned long offset)
1035{
1036 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1037 struct snd_soc_component *component;
1038 struct page *page;
1039 int i;
1040
1041 /* FIXME. it returns 1st page now */
1042 for_each_rtd_components(rtd, i, component) {
1043 if (component->driver->page) {
1044 page = component->driver->page(component,
1045 substream, offset);
1046 if (page)
1047 return page;
1048 }
1049 }
1050
1051 return NULL;
1052}
1053
1054int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream,
1055 struct vm_area_struct *vma)
1056{
1057 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1058 struct snd_soc_component *component;
1059 int i;
1060
1061 /* FIXME. it returns 1st mmap now */
1062 for_each_rtd_components(rtd, i, component)
1063 if (component->driver->mmap)
1064 return soc_component_ret(
1065 component,
1066 component->driver->mmap(component,
1067 substream, vma));
1068
1069 return -EINVAL;
1070}
1071
1072int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd)
1073{
1074 struct snd_soc_component *component;
1075 int ret;
1076 int i;
1077
1078 for_each_rtd_components(rtd, i, component) {
1079 if (component->driver->pcm_construct) {
1080 ret = component->driver->pcm_construct(component, rtd);
1081 if (ret < 0)
1082 return soc_component_ret(component, ret);
1083 }
1084 }
1085
1086 return 0;
1087}
1088
1089void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd)
1090{
1091 struct snd_soc_component *component;
1092 int i;
1093
1094 if (!rtd->pcm)
1095 return;
1096
1097 for_each_rtd_components(rtd, i, component)
1098 if (component->driver->pcm_destruct)
1099 component->driver->pcm_destruct(component, rtd->pcm);
1100}
1101
1102int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream)
1103{
1104 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1105 struct snd_soc_component *component;
1106 int i, ret;
1107
1108 for_each_rtd_components(rtd, i, component) {
1109 if (component->driver->prepare) {
1110 ret = component->driver->prepare(component, substream);
1111 if (ret < 0)
1112 return soc_component_ret(component, ret);
1113 }
1114 }
1115
1116 return 0;
1117}
1118
1119int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream,
1120 struct snd_pcm_hw_params *params)
1121{
1122 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1123 struct snd_soc_component *component;
1124 int i, ret;
1125
1126 for_each_rtd_components(rtd, i, component) {
1127 if (component->driver->hw_params) {
1128 ret = component->driver->hw_params(component,
1129 substream, params);
1130 if (ret < 0)
1131 return soc_component_ret(component, ret);
1132 }
1133 /* mark substream if succeeded */
1134 soc_component_mark_push(component, substream, hw_params);
1135 }
1136
1137 return 0;
1138}
1139
1140void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream,
1141 int rollback)
1142{
1143 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1144 struct snd_soc_component *component;
1145 int i, ret;
1146
1147 for_each_rtd_components(rtd, i, component) {
1148 if (rollback && !soc_component_mark_match(component, substream, hw_params))
1149 continue;
1150
1151 if (component->driver->hw_free) {
1152 ret = component->driver->hw_free(component, substream);
1153 if (ret < 0)
1154 soc_component_ret(component, ret);
1155 }
1156
1157 /* remove marked substream */
1158 soc_component_mark_pop(component, substream, hw_params);
1159 }
1160}
1161
1162static int soc_component_trigger(struct snd_soc_component *component,
1163 struct snd_pcm_substream *substream,
1164 int cmd)
1165{
1166 int ret = 0;
1167
1168 if (component->driver->trigger)
1169 ret = component->driver->trigger(component, substream, cmd);
1170
1171 return soc_component_ret(component, ret);
1172}
1173
1174int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream,
1175 int cmd, int rollback)
1176{
1177 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1178 struct snd_soc_component *component;
1179 int i, r, ret = 0;
1180
1181 switch (cmd) {
1182 case SNDRV_PCM_TRIGGER_START:
1183 case SNDRV_PCM_TRIGGER_RESUME:
1184 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
1185 for_each_rtd_components(rtd, i, component) {
1186 ret = soc_component_trigger(component, substream, cmd);
1187 if (ret < 0)
1188 break;
1189 soc_component_mark_push(component, substream, trigger);
1190 }
1191 break;
1192 case SNDRV_PCM_TRIGGER_STOP:
1193 case SNDRV_PCM_TRIGGER_SUSPEND:
1194 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
1195 for_each_rtd_components(rtd, i, component) {
1196 if (rollback && !soc_component_mark_match(component, substream, trigger))
1197 continue;
1198
1199 r = soc_component_trigger(component, substream, cmd);
1200 if (r < 0)
1201 ret = r; /* use last ret */
1202 soc_component_mark_pop(component, substream, trigger);
1203 }
1204 }
1205
1206 return ret;
1207}
1208
1209int snd_soc_pcm_component_pm_runtime_get(struct snd_soc_pcm_runtime *rtd,
1210 void *stream)
1211{
1212 struct snd_soc_component *component;
1213 int i;
1214
1215 for_each_rtd_components(rtd, i, component) {
1216 int ret = pm_runtime_get_sync(component->dev);
1217 if (ret < 0 && ret != -EACCES) {
1218 pm_runtime_put_noidle(component->dev);
1219 return soc_component_ret(component, ret);
1220 }
1221 /* mark stream if succeeded */
1222 soc_component_mark_push(component, stream, pm);
1223 }
1224
1225 return 0;
1226}
1227
1228void snd_soc_pcm_component_pm_runtime_put(struct snd_soc_pcm_runtime *rtd,
1229 void *stream, int rollback)
1230{
1231 struct snd_soc_component *component;
1232 int i;
1233
1234 for_each_rtd_components(rtd, i, component) {
1235 if (rollback && !soc_component_mark_match(component, stream, pm))
1236 continue;
1237
1238 pm_runtime_mark_last_busy(component->dev);
1239 pm_runtime_put_autosuspend(component->dev);
1240
1241 /* remove marked stream */
1242 soc_component_mark_pop(component, stream, pm);
1243 }
1244}
1245
1246int snd_soc_pcm_component_ack(struct snd_pcm_substream *substream)
1247{
1248 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
1249 struct snd_soc_component *component;
1250 int i;
1251
1252 /* FIXME: use 1st pointer */
1253 for_each_rtd_components(rtd, i, component)
1254 if (component->driver->ack)
1255 return component->driver->ack(component, substream);
1256
1257 return 0;
1258}
1// SPDX-License-Identifier: GPL-2.0
2//
3// soc-component.c
4//
5// Copyright 2009-2011 Wolfson Microelectronics PLC.
6// Copyright (C) 2019 Renesas Electronics Corp.
7//
8// Mark Brown <broonie@opensource.wolfsonmicro.com>
9// Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
10//
11#include <linux/module.h>
12#include <sound/soc.h>
13
14#define soc_component_ret(dai, ret) _soc_component_ret(dai, __func__, ret)
15static inline int _soc_component_ret(struct snd_soc_component *component,
16 const char *func, int ret)
17{
18 /* Positive/Zero values are not errors */
19 if (ret >= 0)
20 return ret;
21
22 /* Negative values might be errors */
23 switch (ret) {
24 case -EPROBE_DEFER:
25 case -ENOTSUPP:
26 break;
27 default:
28 dev_err(component->dev,
29 "ASoC: error at %s on %s: %d\n",
30 func, component->name, ret);
31 }
32
33 return ret;
34}
35
36void snd_soc_component_set_aux(struct snd_soc_component *component,
37 struct snd_soc_aux_dev *aux)
38{
39 component->init = (aux) ? aux->init : NULL;
40}
41
42int snd_soc_component_init(struct snd_soc_component *component)
43{
44 int ret = 0;
45
46 if (component->init)
47 ret = component->init(component);
48
49 return soc_component_ret(component, ret);
50}
51
52/**
53 * snd_soc_component_set_sysclk - configure COMPONENT system or master clock.
54 * @component: COMPONENT
55 * @clk_id: DAI specific clock ID
56 * @source: Source for the clock
57 * @freq: new clock frequency in Hz
58 * @dir: new clock direction - input/output.
59 *
60 * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
61 */
62int snd_soc_component_set_sysclk(struct snd_soc_component *component,
63 int clk_id, int source, unsigned int freq,
64 int dir)
65{
66 int ret = -ENOTSUPP;
67
68 if (component->driver->set_sysclk)
69 ret = component->driver->set_sysclk(component, clk_id, source,
70 freq, dir);
71
72 return soc_component_ret(component, ret);
73}
74EXPORT_SYMBOL_GPL(snd_soc_component_set_sysclk);
75
76/*
77 * snd_soc_component_set_pll - configure component PLL.
78 * @component: COMPONENT
79 * @pll_id: DAI specific PLL ID
80 * @source: DAI specific source for the PLL
81 * @freq_in: PLL input clock frequency in Hz
82 * @freq_out: requested PLL output clock frequency in Hz
83 *
84 * Configures and enables PLL to generate output clock based on input clock.
85 */
86int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
87 int source, unsigned int freq_in,
88 unsigned int freq_out)
89{
90 int ret = -EINVAL;
91
92 if (component->driver->set_pll)
93 ret = component->driver->set_pll(component, pll_id, source,
94 freq_in, freq_out);
95
96 return soc_component_ret(component, ret);
97}
98EXPORT_SYMBOL_GPL(snd_soc_component_set_pll);
99
100void snd_soc_component_seq_notifier(struct snd_soc_component *component,
101 enum snd_soc_dapm_type type, int subseq)
102{
103 if (component->driver->seq_notifier)
104 component->driver->seq_notifier(component, type, subseq);
105}
106
107int snd_soc_component_stream_event(struct snd_soc_component *component,
108 int event)
109{
110 int ret = 0;
111
112 if (component->driver->stream_event)
113 ret = component->driver->stream_event(component, event);
114
115 return soc_component_ret(component, ret);
116}
117
118int snd_soc_component_set_bias_level(struct snd_soc_component *component,
119 enum snd_soc_bias_level level)
120{
121 int ret = 0;
122
123 if (component->driver->set_bias_level)
124 ret = component->driver->set_bias_level(component, level);
125
126 return soc_component_ret(component, ret);
127}
128
129static int soc_component_pin(struct snd_soc_component *component,
130 const char *pin,
131 int (*pin_func)(struct snd_soc_dapm_context *dapm,
132 const char *pin))
133{
134 struct snd_soc_dapm_context *dapm =
135 snd_soc_component_get_dapm(component);
136 char *full_name;
137 int ret;
138
139 if (!component->name_prefix) {
140 ret = pin_func(dapm, pin);
141 goto end;
142 }
143
144 full_name = kasprintf(GFP_KERNEL, "%s %s", component->name_prefix, pin);
145 if (!full_name) {
146 ret = -ENOMEM;
147 goto end;
148 }
149
150 ret = pin_func(dapm, full_name);
151 kfree(full_name);
152end:
153 return soc_component_ret(component, ret);
154}
155
156int snd_soc_component_enable_pin(struct snd_soc_component *component,
157 const char *pin)
158{
159 return soc_component_pin(component, pin, snd_soc_dapm_enable_pin);
160}
161EXPORT_SYMBOL_GPL(snd_soc_component_enable_pin);
162
163int snd_soc_component_enable_pin_unlocked(struct snd_soc_component *component,
164 const char *pin)
165{
166 return soc_component_pin(component, pin, snd_soc_dapm_enable_pin_unlocked);
167}
168EXPORT_SYMBOL_GPL(snd_soc_component_enable_pin_unlocked);
169
170int snd_soc_component_disable_pin(struct snd_soc_component *component,
171 const char *pin)
172{
173 return soc_component_pin(component, pin, snd_soc_dapm_disable_pin);
174}
175EXPORT_SYMBOL_GPL(snd_soc_component_disable_pin);
176
177int snd_soc_component_disable_pin_unlocked(struct snd_soc_component *component,
178 const char *pin)
179{
180 return soc_component_pin(component, pin, snd_soc_dapm_disable_pin_unlocked);
181}
182EXPORT_SYMBOL_GPL(snd_soc_component_disable_pin_unlocked);
183
184int snd_soc_component_nc_pin(struct snd_soc_component *component,
185 const char *pin)
186{
187 return soc_component_pin(component, pin, snd_soc_dapm_nc_pin);
188}
189EXPORT_SYMBOL_GPL(snd_soc_component_nc_pin);
190
191int snd_soc_component_nc_pin_unlocked(struct snd_soc_component *component,
192 const char *pin)
193{
194 return soc_component_pin(component, pin, snd_soc_dapm_nc_pin_unlocked);
195}
196EXPORT_SYMBOL_GPL(snd_soc_component_nc_pin_unlocked);
197
198int snd_soc_component_get_pin_status(struct snd_soc_component *component,
199 const char *pin)
200{
201 return soc_component_pin(component, pin, snd_soc_dapm_get_pin_status);
202}
203EXPORT_SYMBOL_GPL(snd_soc_component_get_pin_status);
204
205int snd_soc_component_force_enable_pin(struct snd_soc_component *component,
206 const char *pin)
207{
208 return soc_component_pin(component, pin, snd_soc_dapm_force_enable_pin);
209}
210EXPORT_SYMBOL_GPL(snd_soc_component_force_enable_pin);
211
212int snd_soc_component_force_enable_pin_unlocked(
213 struct snd_soc_component *component,
214 const char *pin)
215{
216 return soc_component_pin(component, pin, snd_soc_dapm_force_enable_pin_unlocked);
217}
218EXPORT_SYMBOL_GPL(snd_soc_component_force_enable_pin_unlocked);
219
220/**
221 * snd_soc_component_set_jack - configure component jack.
222 * @component: COMPONENTs
223 * @jack: structure to use for the jack
224 * @data: can be used if codec driver need extra data for configuring jack
225 *
226 * Configures and enables jack detection function.
227 */
228int snd_soc_component_set_jack(struct snd_soc_component *component,
229 struct snd_soc_jack *jack, void *data)
230{
231 int ret = -ENOTSUPP;
232
233 if (component->driver->set_jack)
234 ret = component->driver->set_jack(component, jack, data);
235
236 return soc_component_ret(component, ret);
237}
238EXPORT_SYMBOL_GPL(snd_soc_component_set_jack);
239
240int snd_soc_component_module_get(struct snd_soc_component *component,
241 int upon_open)
242{
243 int ret = 0;
244
245 if (component->driver->module_get_upon_open == !!upon_open &&
246 !try_module_get(component->dev->driver->owner))
247 ret = -ENODEV;
248
249 return soc_component_ret(component, ret);
250}
251
252void snd_soc_component_module_put(struct snd_soc_component *component,
253 int upon_open)
254{
255 if (component->driver->module_get_upon_open == !!upon_open)
256 module_put(component->dev->driver->owner);
257}
258
259int snd_soc_component_open(struct snd_soc_component *component,
260 struct snd_pcm_substream *substream)
261{
262 int ret = 0;
263
264 if (component->driver->open)
265 ret = component->driver->open(component, substream);
266
267 return soc_component_ret(component, ret);
268}
269
270int snd_soc_component_close(struct snd_soc_component *component,
271 struct snd_pcm_substream *substream)
272{
273 int ret = 0;
274
275 if (component->driver->close)
276 ret = component->driver->close(component, substream);
277
278 return soc_component_ret(component, ret);
279}
280
281void snd_soc_component_suspend(struct snd_soc_component *component)
282{
283 if (component->driver->suspend)
284 component->driver->suspend(component);
285 component->suspended = 1;
286}
287
288void snd_soc_component_resume(struct snd_soc_component *component)
289{
290 if (component->driver->resume)
291 component->driver->resume(component);
292 component->suspended = 0;
293}
294
295int snd_soc_component_is_suspended(struct snd_soc_component *component)
296{
297 return component->suspended;
298}
299
300int snd_soc_component_probe(struct snd_soc_component *component)
301{
302 int ret = 0;
303
304 if (component->driver->probe)
305 ret = component->driver->probe(component);
306
307 return soc_component_ret(component, ret);
308}
309
310void snd_soc_component_remove(struct snd_soc_component *component)
311{
312 if (component->driver->remove)
313 component->driver->remove(component);
314}
315
316int snd_soc_component_of_xlate_dai_id(struct snd_soc_component *component,
317 struct device_node *ep)
318{
319 int ret = -ENOTSUPP;
320
321 if (component->driver->of_xlate_dai_id)
322 ret = component->driver->of_xlate_dai_id(component, ep);
323
324 return soc_component_ret(component, ret);
325}
326
327int snd_soc_component_of_xlate_dai_name(struct snd_soc_component *component,
328 struct of_phandle_args *args,
329 const char **dai_name)
330{
331 if (component->driver->of_xlate_dai_name)
332 return component->driver->of_xlate_dai_name(component,
333 args, dai_name);
334 /*
335 * Don't use soc_component_ret here because we may not want to report
336 * the error just yet. If a device has more than one component, the
337 * first may not match and we don't want spam the log with this.
338 */
339 return -ENOTSUPP;
340}
341
342void snd_soc_component_setup_regmap(struct snd_soc_component *component)
343{
344 int val_bytes = regmap_get_val_bytes(component->regmap);
345
346 /* Errors are legitimate for non-integer byte multiples */
347 if (val_bytes > 0)
348 component->val_bytes = val_bytes;
349}
350
351#ifdef CONFIG_REGMAP
352
353/**
354 * snd_soc_component_init_regmap() - Initialize regmap instance for the
355 * component
356 * @component: The component for which to initialize the regmap instance
357 * @regmap: The regmap instance that should be used by the component
358 *
359 * This function allows deferred assignment of the regmap instance that is
360 * associated with the component. Only use this if the regmap instance is not
361 * yet ready when the component is registered. The function must also be called
362 * before the first IO attempt of the component.
363 */
364void snd_soc_component_init_regmap(struct snd_soc_component *component,
365 struct regmap *regmap)
366{
367 component->regmap = regmap;
368 snd_soc_component_setup_regmap(component);
369}
370EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
371
372/**
373 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
374 * component
375 * @component: The component for which to de-initialize the regmap instance
376 *
377 * Calls regmap_exit() on the regmap instance associated to the component and
378 * removes the regmap instance from the component.
379 *
380 * This function should only be used if snd_soc_component_init_regmap() was used
381 * to initialize the regmap instance.
382 */
383void snd_soc_component_exit_regmap(struct snd_soc_component *component)
384{
385 regmap_exit(component->regmap);
386 component->regmap = NULL;
387}
388EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
389
390#endif
391
392static unsigned int soc_component_read_no_lock(
393 struct snd_soc_component *component,
394 unsigned int reg)
395{
396 int ret;
397 unsigned int val = 0;
398
399 if (component->regmap)
400 ret = regmap_read(component->regmap, reg, &val);
401 else if (component->driver->read) {
402 ret = 0;
403 val = component->driver->read(component, reg);
404 }
405 else
406 ret = -EIO;
407
408 if (ret < 0)
409 return soc_component_ret(component, ret);
410
411 return val;
412}
413
414/**
415 * snd_soc_component_read() - Read register value
416 * @component: Component to read from
417 * @reg: Register to read
418 *
419 * Return: read value
420 */
421unsigned int snd_soc_component_read(struct snd_soc_component *component,
422 unsigned int reg)
423{
424 unsigned int val;
425
426 mutex_lock(&component->io_mutex);
427 val = soc_component_read_no_lock(component, reg);
428 mutex_unlock(&component->io_mutex);
429
430 return val;
431}
432EXPORT_SYMBOL_GPL(snd_soc_component_read);
433
434static int soc_component_write_no_lock(
435 struct snd_soc_component *component,
436 unsigned int reg, unsigned int val)
437{
438 int ret = -EIO;
439
440 if (component->regmap)
441 ret = regmap_write(component->regmap, reg, val);
442 else if (component->driver->write)
443 ret = component->driver->write(component, reg, val);
444
445 return soc_component_ret(component, ret);
446}
447
448/**
449 * snd_soc_component_write() - Write register value
450 * @component: Component to write to
451 * @reg: Register to write
452 * @val: Value to write to the register
453 *
454 * Return: 0 on success, a negative error code otherwise.
455 */
456int snd_soc_component_write(struct snd_soc_component *component,
457 unsigned int reg, unsigned int val)
458{
459 int ret;
460
461 mutex_lock(&component->io_mutex);
462 ret = soc_component_write_no_lock(component, reg, val);
463 mutex_unlock(&component->io_mutex);
464
465 return ret;
466}
467EXPORT_SYMBOL_GPL(snd_soc_component_write);
468
469static int snd_soc_component_update_bits_legacy(
470 struct snd_soc_component *component, unsigned int reg,
471 unsigned int mask, unsigned int val, bool *change)
472{
473 unsigned int old, new;
474 int ret = 0;
475
476 mutex_lock(&component->io_mutex);
477
478 old = soc_component_read_no_lock(component, reg);
479
480 new = (old & ~mask) | (val & mask);
481 *change = old != new;
482 if (*change)
483 ret = soc_component_write_no_lock(component, reg, new);
484
485 mutex_unlock(&component->io_mutex);
486
487 return soc_component_ret(component, ret);
488}
489
490/**
491 * snd_soc_component_update_bits() - Perform read/modify/write cycle
492 * @component: Component to update
493 * @reg: Register to update
494 * @mask: Mask that specifies which bits to update
495 * @val: New value for the bits specified by mask
496 *
497 * Return: 1 if the operation was successful and the value of the register
498 * changed, 0 if the operation was successful, but the value did not change.
499 * Returns a negative error code otherwise.
500 */
501int snd_soc_component_update_bits(struct snd_soc_component *component,
502 unsigned int reg, unsigned int mask, unsigned int val)
503{
504 bool change;
505 int ret;
506
507 if (component->regmap)
508 ret = regmap_update_bits_check(component->regmap, reg, mask,
509 val, &change);
510 else
511 ret = snd_soc_component_update_bits_legacy(component, reg,
512 mask, val, &change);
513
514 if (ret < 0)
515 return soc_component_ret(component, ret);
516 return change;
517}
518EXPORT_SYMBOL_GPL(snd_soc_component_update_bits);
519
520/**
521 * snd_soc_component_update_bits_async() - Perform asynchronous
522 * read/modify/write cycle
523 * @component: Component to update
524 * @reg: Register to update
525 * @mask: Mask that specifies which bits to update
526 * @val: New value for the bits specified by mask
527 *
528 * This function is similar to snd_soc_component_update_bits(), but the update
529 * operation is scheduled asynchronously. This means it may not be completed
530 * when the function returns. To make sure that all scheduled updates have been
531 * completed snd_soc_component_async_complete() must be called.
532 *
533 * Return: 1 if the operation was successful and the value of the register
534 * changed, 0 if the operation was successful, but the value did not change.
535 * Returns a negative error code otherwise.
536 */
537int snd_soc_component_update_bits_async(struct snd_soc_component *component,
538 unsigned int reg, unsigned int mask, unsigned int val)
539{
540 bool change;
541 int ret;
542
543 if (component->regmap)
544 ret = regmap_update_bits_check_async(component->regmap, reg,
545 mask, val, &change);
546 else
547 ret = snd_soc_component_update_bits_legacy(component, reg,
548 mask, val, &change);
549
550 if (ret < 0)
551 return soc_component_ret(component, ret);
552 return change;
553}
554EXPORT_SYMBOL_GPL(snd_soc_component_update_bits_async);
555
556/**
557 * snd_soc_component_async_complete() - Ensure asynchronous I/O has completed
558 * @component: Component for which to wait
559 *
560 * This function blocks until all asynchronous I/O which has previously been
561 * scheduled using snd_soc_component_update_bits_async() has completed.
562 */
563void snd_soc_component_async_complete(struct snd_soc_component *component)
564{
565 if (component->regmap)
566 regmap_async_complete(component->regmap);
567}
568EXPORT_SYMBOL_GPL(snd_soc_component_async_complete);
569
570/**
571 * snd_soc_component_test_bits - Test register for change
572 * @component: component
573 * @reg: Register to test
574 * @mask: Mask that specifies which bits to test
575 * @value: Value to test against
576 *
577 * Tests a register with a new value and checks if the new value is
578 * different from the old value.
579 *
580 * Return: 1 for change, otherwise 0.
581 */
582int snd_soc_component_test_bits(struct snd_soc_component *component,
583 unsigned int reg, unsigned int mask, unsigned int value)
584{
585 unsigned int old, new;
586
587 old = snd_soc_component_read(component, reg);
588 new = (old & ~mask) | value;
589 return old != new;
590}
591EXPORT_SYMBOL_GPL(snd_soc_component_test_bits);
592
593int snd_soc_pcm_component_pointer(struct snd_pcm_substream *substream)
594{
595 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
596 struct snd_soc_component *component;
597 int i;
598
599 /* FIXME: use 1st pointer */
600 for_each_rtd_components(rtd, i, component)
601 if (component->driver->pointer)
602 return component->driver->pointer(component, substream);
603
604 return 0;
605}
606
607int snd_soc_pcm_component_ioctl(struct snd_pcm_substream *substream,
608 unsigned int cmd, void *arg)
609{
610 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
611 struct snd_soc_component *component;
612 int i;
613
614 /* FIXME: use 1st ioctl */
615 for_each_rtd_components(rtd, i, component)
616 if (component->driver->ioctl)
617 return soc_component_ret(
618 component,
619 component->driver->ioctl(component,
620 substream, cmd, arg));
621
622 return snd_pcm_lib_ioctl(substream, cmd, arg);
623}
624
625int snd_soc_pcm_component_sync_stop(struct snd_pcm_substream *substream)
626{
627 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
628 struct snd_soc_component *component;
629 int i, ret;
630
631 for_each_rtd_components(rtd, i, component) {
632 if (component->driver->sync_stop) {
633 ret = component->driver->sync_stop(component,
634 substream);
635 if (ret < 0)
636 return soc_component_ret(component, ret);
637 }
638 }
639
640 return 0;
641}
642
643int snd_soc_pcm_component_copy_user(struct snd_pcm_substream *substream,
644 int channel, unsigned long pos,
645 void __user *buf, unsigned long bytes)
646{
647 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
648 struct snd_soc_component *component;
649 int i;
650
651 /* FIXME. it returns 1st copy now */
652 for_each_rtd_components(rtd, i, component)
653 if (component->driver->copy_user)
654 return soc_component_ret(
655 component,
656 component->driver->copy_user(
657 component, substream, channel,
658 pos, buf, bytes));
659
660 return -EINVAL;
661}
662
663struct page *snd_soc_pcm_component_page(struct snd_pcm_substream *substream,
664 unsigned long offset)
665{
666 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
667 struct snd_soc_component *component;
668 struct page *page;
669 int i;
670
671 /* FIXME. it returns 1st page now */
672 for_each_rtd_components(rtd, i, component) {
673 if (component->driver->page) {
674 page = component->driver->page(component,
675 substream, offset);
676 if (page)
677 return page;
678 }
679 }
680
681 return NULL;
682}
683
684int snd_soc_pcm_component_mmap(struct snd_pcm_substream *substream,
685 struct vm_area_struct *vma)
686{
687 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
688 struct snd_soc_component *component;
689 int i;
690
691 /* FIXME. it returns 1st mmap now */
692 for_each_rtd_components(rtd, i, component)
693 if (component->driver->mmap)
694 return soc_component_ret(
695 component,
696 component->driver->mmap(component,
697 substream, vma));
698
699 return -EINVAL;
700}
701
702int snd_soc_pcm_component_new(struct snd_soc_pcm_runtime *rtd)
703{
704 struct snd_soc_component *component;
705 int ret;
706 int i;
707
708 for_each_rtd_components(rtd, i, component) {
709 if (component->driver->pcm_construct) {
710 ret = component->driver->pcm_construct(component, rtd);
711 if (ret < 0)
712 return soc_component_ret(component, ret);
713 }
714 }
715
716 return 0;
717}
718
719void snd_soc_pcm_component_free(struct snd_soc_pcm_runtime *rtd)
720{
721 struct snd_soc_component *component;
722 int i;
723
724 if (!rtd->pcm)
725 return;
726
727 for_each_rtd_components(rtd, i, component)
728 if (component->driver->pcm_destruct)
729 component->driver->pcm_destruct(component, rtd->pcm);
730}
731
732int snd_soc_pcm_component_prepare(struct snd_pcm_substream *substream)
733{
734 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
735 struct snd_soc_component *component;
736 int i, ret;
737
738 for_each_rtd_components(rtd, i, component) {
739 if (component->driver->prepare) {
740 ret = component->driver->prepare(component, substream);
741 if (ret < 0)
742 return soc_component_ret(component, ret);
743 }
744 }
745
746 return 0;
747}
748
749int snd_soc_pcm_component_hw_params(struct snd_pcm_substream *substream,
750 struct snd_pcm_hw_params *params,
751 struct snd_soc_component **last)
752{
753 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
754 struct snd_soc_component *component;
755 int i, ret;
756
757 for_each_rtd_components(rtd, i, component) {
758 if (component->driver->hw_params) {
759 ret = component->driver->hw_params(component,
760 substream, params);
761 if (ret < 0) {
762 *last = component;
763 return soc_component_ret(component, ret);
764 }
765 }
766 }
767
768 *last = NULL;
769 return 0;
770}
771
772void snd_soc_pcm_component_hw_free(struct snd_pcm_substream *substream,
773 struct snd_soc_component *last)
774{
775 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
776 struct snd_soc_component *component;
777 int i, ret;
778
779 for_each_rtd_components(rtd, i, component) {
780 if (component == last)
781 break;
782
783 if (component->driver->hw_free) {
784 ret = component->driver->hw_free(component, substream);
785 if (ret < 0)
786 soc_component_ret(component, ret);
787 }
788 }
789}
790
791int snd_soc_pcm_component_trigger(struct snd_pcm_substream *substream,
792 int cmd)
793{
794 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
795 struct snd_soc_component *component;
796 int i, ret;
797
798 for_each_rtd_components(rtd, i, component) {
799 if (component->driver->trigger) {
800 ret = component->driver->trigger(component, substream, cmd);
801 if (ret < 0)
802 return soc_component_ret(component, ret);
803 }
804 }
805
806 return 0;
807}