1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>Chapter&#160;7.&#160;ASoC</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="The ALSA Driver API"><link rel="up" href="index.html" title="The ALSA Driver API"><link rel="prev" href="API-struct-snd-compr.html" title="struct snd_compr"><link rel="next" href="API-struct-snd-soc-jack-pin.html" title="struct snd_soc_jack_pin"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&#160;7.&#160;ASoC</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-struct-snd-compr.html">Prev</a>&#160;</td><th width="60%" align="center">&#160;</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-struct-snd-soc-jack-pin.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="idp1095226892"></a>Chapter&#160;7.&#160;ASoC</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="ch07.html#idp1095227164">ASoC Core API</a></span></dt><dt><span class="sect1"><a href="ch07s02.html">ASoC DAPM API</a></span></dt><dt><span class="sect1"><a href="ch07s03.html">ASoC DMA Engine API</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1095227164"></a>ASoC Core API</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="API-struct-snd-soc-jack-pin.html"><span class="phrase">struct snd_soc_jack_pin</span></a></span><span class="refpurpose"> &#8212; 
2  Describes a pin to update based on jack detection
3 </span></dt><dt><span class="refentrytitle"><a href="API-struct-snd-soc-jack-zone.html"><span class="phrase">struct snd_soc_jack_zone</span></a></span><span class="refpurpose"> &#8212; 
4     Describes voltage zones of jack detection
5 </span></dt><dt><span class="refentrytitle"><a href="API-struct-snd-soc-jack-gpio.html"><span class="phrase">struct snd_soc_jack_gpio</span></a></span><span class="refpurpose"> &#8212; 
6     Describes a gpio pin for jack detection
7 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-to-codec.html"><span class="phrase">snd_soc_component_to_codec</span></a></span><span class="refpurpose"> &#8212; 
8     Casts a component to the CODEC it is embedded in
9 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-to-platform.html"><span class="phrase">snd_soc_component_to_platform</span></a></span><span class="refpurpose"> &#8212; 
10     Casts a component to the platform it is embedded in
11 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dapm-to-component.html"><span class="phrase">snd_soc_dapm_to_component</span></a></span><span class="refpurpose"> &#8212; 
12     Casts a DAPM context to the component it is embedded in
13 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dapm-to-codec.html"><span class="phrase">snd_soc_dapm_to_codec</span></a></span><span class="refpurpose"> &#8212; 
14     Casts a DAPM context to the CODEC it is embedded in
15 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dapm-to-platform.html"><span class="phrase">snd_soc_dapm_to_platform</span></a></span><span class="refpurpose"> &#8212; 
16     Casts a DAPM context to the platform it is embedded in
17 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-get-dapm.html"><span class="phrase">snd_soc_component_get_dapm</span></a></span><span class="refpurpose"> &#8212; 
18     Returns the DAPM context associated with a component
19 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dapm-kcontrol-codec.html"><span class="phrase">snd_soc_dapm_kcontrol_codec</span></a></span><span class="refpurpose"> &#8212; 
20     Returns the codec associated to a kcontrol
21 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-cache-sync.html"><span class="phrase">snd_soc_cache_sync</span></a></span><span class="refpurpose"> &#8212; 
22     Sync the register cache with the hardware
23 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-codec-init-regmap.html"><span class="phrase">snd_soc_codec_init_regmap</span></a></span><span class="refpurpose"> &#8212; 
24     Initialize regmap instance for the CODEC
25 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-codec-exit-regmap.html"><span class="phrase">snd_soc_codec_exit_regmap</span></a></span><span class="refpurpose"> &#8212; 
26     De-initialize regmap instance for the CODEC
27 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-kcontrol-component.html"><span class="phrase">snd_soc_kcontrol_component</span></a></span><span class="refpurpose"> &#8212; 
28     Returns the component that registered the control
29 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-kcontrol-codec.html"><span class="phrase">snd_soc_kcontrol_codec</span></a></span><span class="refpurpose"> &#8212; 
30     Returns the CODEC that registered the control
31 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-kcontrol-platform.html"><span class="phrase">snd_soc_kcontrol_platform</span></a></span><span class="refpurpose"> &#8212; 
32     Returns the platform that registered the control
33 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-runtime-set-dai-fmt.html"><span class="phrase">snd_soc_runtime_set_dai_fmt</span></a></span><span class="refpurpose"> &#8212; 
34  Change DAI link format for a ASoC runtime
35 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-cnew.html"><span class="phrase">snd_soc_cnew</span></a></span><span class="refpurpose"> &#8212; 
36     create new control
37 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-add-component-controls.html"><span class="phrase">snd_soc_add_component_controls</span></a></span><span class="refpurpose"> &#8212; 
38     Add an array of controls to a component.
39 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-add-codec-controls.html"><span class="phrase">snd_soc_add_codec_controls</span></a></span><span class="refpurpose"> &#8212; 
40     add an array of controls to a codec. Convenience function to add a list of controls. Many codecs were duplicating this code.
41 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-add-platform-controls.html"><span class="phrase">snd_soc_add_platform_controls</span></a></span><span class="refpurpose"> &#8212; 
42     add an array of controls to a platform. Convenience function to add a list of controls.
43 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-add-card-controls.html"><span class="phrase">snd_soc_add_card_controls</span></a></span><span class="refpurpose"> &#8212; 
44     add an array of controls to a SoC card. Convenience function to add a list of controls.
45 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-add-dai-controls.html"><span class="phrase">snd_soc_add_dai_controls</span></a></span><span class="refpurpose"> &#8212; 
46     add an array of controls to a DAI. Convienience function to add a list of controls.
47 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-sysclk.html"><span class="phrase">snd_soc_dai_set_sysclk</span></a></span><span class="refpurpose"> &#8212; 
48     configure DAI system or master clock.
49 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-codec-set-sysclk.html"><span class="phrase">snd_soc_codec_set_sysclk</span></a></span><span class="refpurpose"> &#8212; 
50     configure CODEC system or master clock.
51 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-clkdiv.html"><span class="phrase">snd_soc_dai_set_clkdiv</span></a></span><span class="refpurpose"> &#8212; 
52     configure DAI clock dividers.
53 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-pll.html"><span class="phrase">snd_soc_dai_set_pll</span></a></span><span class="refpurpose"> &#8212; 
54     configure DAI PLL.
55 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-bclk-ratio.html"><span class="phrase">snd_soc_dai_set_bclk_ratio</span></a></span><span class="refpurpose"> &#8212; 
56     configure BCLK to sample rate ratio.
57 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-fmt.html"><span class="phrase">snd_soc_dai_set_fmt</span></a></span><span class="refpurpose"> &#8212; 
58     configure DAI hardware audio format.
59 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-tdm-slot.html"><span class="phrase">snd_soc_dai_set_tdm_slot</span></a></span><span class="refpurpose"> &#8212; 
60     Configures a DAI for TDM operation
61 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-channel-map.html"><span class="phrase">snd_soc_dai_set_channel_map</span></a></span><span class="refpurpose"> &#8212; 
62     configure DAI audio channel map
63 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-set-tristate.html"><span class="phrase">snd_soc_dai_set_tristate</span></a></span><span class="refpurpose"> &#8212; 
64     configure DAI system or master clock.
65 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-dai-digital-mute.html"><span class="phrase">snd_soc_dai_digital_mute</span></a></span><span class="refpurpose"> &#8212; 
66     configure DAI system or master clock.
67 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-register-card.html"><span class="phrase">snd_soc_register_card</span></a></span><span class="refpurpose"> &#8212; 
68     Register a card with the ASoC core
69 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-unregister-card.html"><span class="phrase">snd_soc_unregister_card</span></a></span><span class="refpurpose"> &#8212; 
70     Unregister a card with the ASoC core
71 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-init-regmap.html"><span class="phrase">snd_soc_component_init_regmap</span></a></span><span class="refpurpose"> &#8212; 
72     Initialize regmap instance for the component
73 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-exit-regmap.html"><span class="phrase">snd_soc_component_exit_regmap</span></a></span><span class="refpurpose"> &#8212; 
74     De-initialize regmap instance for the component
75 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-unregister-component.html"><span class="phrase">snd_soc_unregister_component</span></a></span><span class="refpurpose"> &#8212; 
76     Unregister a component from the ASoC core
77 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-add-platform.html"><span class="phrase">snd_soc_add_platform</span></a></span><span class="refpurpose"> &#8212; 
78     Add a platform to the ASoC core
79 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-register-platform.html"><span class="phrase">snd_soc_register_platform</span></a></span><span class="refpurpose"> &#8212; 
80     Register a platform with the ASoC core
81 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-remove-platform.html"><span class="phrase">snd_soc_remove_platform</span></a></span><span class="refpurpose"> &#8212; 
82     Remove a platform from the ASoC core
83 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-unregister-platform.html"><span class="phrase">snd_soc_unregister_platform</span></a></span><span class="refpurpose"> &#8212; 
84     Unregister a platform from the ASoC core
85 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-register-codec.html"><span class="phrase">snd_soc_register_codec</span></a></span><span class="refpurpose"> &#8212; 
86     Register a codec with the ASoC core
87 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-unregister-codec.html"><span class="phrase">snd_soc_unregister_codec</span></a></span><span class="refpurpose"> &#8212; 
88     Unregister a codec from the ASoC core
89 </span></dt><dt><span class="refentrytitle"><a href="re265.html">
90   .//sound/soc/soc-cache.c
91  </a></span><span class="refpurpose"> &#8212; 
92   Document generation inconsistency
93  </span></dt><dt><span class="refentrytitle"><a href="API-devm-snd-soc-register-component.html"><span class="phrase">devm_snd_soc_register_component</span></a></span><span class="refpurpose"> &#8212; 
94  resource managed component registration
95 </span></dt><dt><span class="refentrytitle"><a href="API-devm-snd-soc-register-platform.html"><span class="phrase">devm_snd_soc_register_platform</span></a></span><span class="refpurpose"> &#8212; 
96     resource managed platform registration
97 </span></dt><dt><span class="refentrytitle"><a href="API-devm-snd-soc-register-card.html"><span class="phrase">devm_snd_soc_register_card</span></a></span><span class="refpurpose"> &#8212; 
98     resource managed card registration
99 </span></dt><dt><span class="refentrytitle"><a href="API-devm-snd-dmaengine-pcm-register.html"><span class="phrase">devm_snd_dmaengine_pcm_register</span></a></span><span class="refpurpose"> &#8212; 
100     resource managed dmaengine PCM registration
101 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-read.html"><span class="phrase">snd_soc_component_read</span></a></span><span class="refpurpose"> &#8212; 
102  Read register value
103 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-write.html"><span class="phrase">snd_soc_component_write</span></a></span><span class="refpurpose"> &#8212; 
104     Write register value
105 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-update-bits.html"><span class="phrase">snd_soc_component_update_bits</span></a></span><span class="refpurpose"> &#8212; 
106     Perform read/modify/write cycle
107 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-update-bits-async.html"><span class="phrase">snd_soc_component_update_bits_async</span></a></span><span class="refpurpose"> &#8212; 
108     Perform asynchronous read/modify/write cycle
109 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-async-complete.html"><span class="phrase">snd_soc_component_async_complete</span></a></span><span class="refpurpose"> &#8212; 
110     Ensure asynchronous I/O has completed
111 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-component-test-bits.html"><span class="phrase">snd_soc_component_test_bits</span></a></span><span class="refpurpose"> &#8212; 
112     Test register for change
113 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-update-bits.html"><span class="phrase">snd_soc_update_bits</span></a></span><span class="refpurpose"> &#8212; 
114     update codec register bits
115 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-test-bits.html"><span class="phrase">snd_soc_test_bits</span></a></span><span class="refpurpose"> &#8212; 
116     test register for change
117 </span></dt><dt><span class="refentrytitle"><a href="API-snd-soc-set-runtime-hwparams.html"><span class="phrase">snd_soc_set_runtime_hwparams</span></a></span><span class="refpurpose"> &#8212; 
118  set the runtime hardware parameters
119 </span></dt></dl></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-struct-snd-compr.html">Prev</a>&#160;</td><td width="20%" align="center">&#160;</td><td width="40%" align="right">&#160;<a accesskey="n" href="API-struct-snd-soc-jack-pin.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">struct snd_compr</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">struct snd_soc_jack_pin</span></td></tr></table></div></body></html>
120