uml: 64-bit tlb fixes
[pv_ops_mirror.git] / Documentation / sound / alsa / soc / dapm.txt
blobc784a18b94dce93bdcb064b2ef6670d450846bd5
1 Dynamic Audio Power Management for Portable Devices
2 ===================================================
4 1. Description
5 ==============
7 Dynamic Audio Power Management (DAPM) is designed to allow portable
8 Linux devices to use the minimum amount of power within the audio
9 subsystem at all times. It is independent of other kernel PM and as
10 such, can easily co-exist with the other PM systems.
12 DAPM is also completely transparent to all user space applications as
13 all power switching is done within the ASoC core. No code changes or
14 recompiling are required for user space applications. DAPM makes power
15 switching decisions based upon any audio stream (capture/playback)
16 activity and audio mixer settings within the device.
18 DAPM spans the whole machine. It covers power control within the entire
19 audio subsystem, this includes internal codec power blocks and machine
20 level power systems.
22 There are 4 power domains within DAPM
24    1. Codec domain - VREF, VMID (core codec and audio power)
25       Usually controlled at codec probe/remove and suspend/resume, although
26       can be set at stream time if power is not needed for sidetone, etc.
28    2. Platform/Machine domain - physically connected inputs and outputs
29       Is platform/machine and user action specific, is configured by the
30       machine driver and responds to asynchronous events e.g when HP
31       are inserted
33    3. Path domain - audio susbsystem signal paths
34       Automatically set when mixer and mux settings are changed by the user.
35       e.g. alsamixer, amixer.
37    4. Stream domain - DACs and ADCs.
38       Enabled and disabled when stream playback/capture is started and
39       stopped respectively. e.g. aplay, arecord.
41 All DAPM power switching decisions are made automatically by consulting an audio
42 routing map of the whole machine. This map is specific to each machine and
43 consists of the interconnections between every audio component (including
44 internal codec components). All audio components that effect power are called
45 widgets hereafter.
48 2. DAPM Widgets
49 ===============
51 Audio DAPM widgets fall into a number of types:-
53  o Mixer      - Mixes several analog signals into a single analog signal.
54  o Mux        - An analog switch that outputs only one of many inputs.
55  o PGA        - A programmable gain amplifier or attenuation widget.
56  o ADC        - Analog to Digital Converter
57  o DAC        - Digital to Analog Converter
58  o Switch     - An analog switch
59  o Input      - A codec input pin
60  o Output     - A codec output pin
61  o Headphone  - Headphone (and optional Jack)
62  o Mic        - Mic (and optional Jack)
63  o Line       - Line Input/Output (and optional Jack)
64  o Speaker    - Speaker
65  o Pre        - Special PRE widget (exec before all others)
66  o Post       - Special POST widget (exec after all others)
68 (Widgets are defined in include/sound/soc-dapm.h)
70 Widgets are usually added in the codec driver and the machine driver. There are
71 convience macros defined in soc-dapm.h that can be used to quickly build a
72 list of widgets of the codecs and machines DAPM widgets.
74 Most widgets have a name, register, shift and invert. Some widgets have extra
75 parameters for stream name and kcontrols.
78 2.1 Stream Domain Widgets
79 -------------------------
81 Stream Widgets relate to the stream power domain and only consist of ADCs
82 (analog to digital converters) and DACs (digital to analog converters).
84 Stream widgets have the following format:-
86 SND_SOC_DAPM_DAC(name, stream name, reg, shift, invert),
88 NOTE: the stream name must match the corresponding stream name in your codec
89 snd_soc_codec_dai.
91 e.g. stream widgets for HiFi playback and capture
93 SND_SOC_DAPM_DAC("HiFi DAC", "HiFi Playback", REG, 3, 1),
94 SND_SOC_DAPM_ADC("HiFi ADC", "HiFi Capture", REG, 2, 1),
97 2.2 Path Domain Widgets
98 -----------------------
100 Path domain widgets have a ability to control or affect the audio signal or
101 audio paths within the audio subsystem. They have the following form:-
103 SND_SOC_DAPM_PGA(name, reg, shift, invert, controls, num_controls)
105 Any widget kcontrols can be set using the controls and num_controls members.
107 e.g. Mixer widget (the kcontrols are declared first)
109 /* Output Mixer */
110 static const snd_kcontrol_new_t wm8731_output_mixer_controls[] = {
111 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
112 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
113 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
116 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1, wm8731_output_mixer_controls,
117         ARRAY_SIZE(wm8731_output_mixer_controls)),
120 2.3 Platform/Machine domain Widgets
121 -----------------------------------
123 Machine widgets are different from codec widgets in that they don't have a
124 codec register bit associated with them. A machine widget is assigned to each
125 machine audio component (non codec) that can be independently powered. e.g.
127  o Speaker Amp
128  o Microphone Bias
129  o Jack connectors
131 A machine widget can have an optional call back.
133 e.g. Jack connector widget for an external Mic that enables Mic Bias
134 when the Mic is inserted:-
136 static int spitz_mic_bias(struct snd_soc_dapm_widget* w, int event)
138         if(SND_SOC_DAPM_EVENT_ON(event))
139                 set_scoop_gpio(&spitzscoop2_device.dev, SPITZ_SCP2_MIC_BIAS);
140         else
141                 reset_scoop_gpio(&spitzscoop2_device.dev, SPITZ_SCP2_MIC_BIAS);
143         return 0;
146 SND_SOC_DAPM_MIC("Mic Jack", spitz_mic_bias),
149 2.4 Codec Domain
150 ----------------
152 The codec power domain has no widgets and is handled by the codecs DAPM event
153 handler. This handler is called when the codec powerstate is changed wrt to any
154 stream event or by kernel PM events.
157 2.5 Virtual Widgets
158 -------------------
160 Sometimes widgets exist in the codec or machine audio map that don't have any
161 corresponding soft power control. In this case it is necessary to create
162 a virtual widget - a widget with no control bits e.g.
164 SND_SOC_DAPM_MIXER("AC97 Mixer", SND_SOC_DAPM_NOPM, 0, 0, NULL, 0),
166 This can be used to merge to signal paths together in software.
168 After all the widgets have been defined, they can then be added to the DAPM
169 subsystem individually with a call to snd_soc_dapm_new_control().
172 3. Codec Widget Interconnections
173 ================================
175 Widgets are connected to each other within the codec and machine by audio paths
176 (called interconnections). Each interconnection must be defined in order to
177 create a map of all audio paths between widgets.
179 This is easiest with a diagram of the codec (and schematic of the machine audio
180 system), as it requires joining widgets together via their audio signal paths.
182 e.g., from the WM8731 output mixer (wm8731.c)
184 The WM8731 output mixer has 3 inputs (sources)
186  1. Line Bypass Input
187  2. DAC (HiFi playback)
188  3. Mic Sidetone Input
190 Each input in this example has a kcontrol associated with it (defined in example
191 above) and is connected to the output mixer via it's kcontrol name. We can now
192 connect the destination widget (wrt audio signal) with it's source widgets.
194         /* output mixer */
195         {"Output Mixer", "Line Bypass Switch", "Line Input"},
196         {"Output Mixer", "HiFi Playback Switch", "DAC"},
197         {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
199 So we have :-
201         Destination Widget  <=== Path Name <=== Source Widget
203 Or:-
205         Sink, Path, Source
207 Or :-
209         "Output Mixer" is connected to the "DAC" via the "HiFi Playback Switch".
211 When there is no path name connecting widgets (e.g. a direct connection) we
212 pass NULL for the path name.
214 Interconnections are created with a call to:-
216 snd_soc_dapm_connect_input(codec, sink, path, source);
218 Finally, snd_soc_dapm_new_widgets(codec) must be called after all widgets and
219 interconnections have been registered with the core. This causes the core to
220 scan the codec and machine so that the internal DAPM state matches the
221 physical state of the machine.
224 3.1 Machine Widget Interconnections
225 -----------------------------------
226 Machine widget interconnections are created in the same way as codec ones and
227 directly connect the codec pins to machine level widgets.
229 e.g. connects the speaker out codec pins to the internal speaker.
231         /* ext speaker connected to codec pins LOUT2, ROUT2  */
232         {"Ext Spk", NULL , "ROUT2"},
233         {"Ext Spk", NULL , "LOUT2"},
235 This allows the DAPM to power on and off pins that are connected (and in use)
236 and pins that are NC respectively.
239 4 Endpoint Widgets
240 ===================
241 An endpoint is a start or end point (widget) of an audio signal within the
242 machine and includes the codec. e.g.
244  o Headphone Jack
245  o Internal Speaker
246  o Internal Mic
247  o Mic Jack
248  o Codec Pins
250 When a codec pin is NC it can be marked as not used with a call to
252 snd_soc_dapm_set_endpoint(codec, "Widget Name", 0);
254 The last argument is 0 for inactive and 1 for active. This way the pin and its
255 input widget will never be powered up and consume power.
257 This also applies to machine widgets. e.g. if a headphone is connected to a
258 jack then the jack can be marked active. If the headphone is removed, then
259 the headphone jack can be marked inactive.
262 5 DAPM Widget Events
263 ====================
265 Some widgets can register their interest with the DAPM core in PM events.
266 e.g. A Speaker with an amplifier registers a widget so the amplifier can be
267 powered only when the spk is in use.
269 /* turn speaker amplifier on/off depending on use */
270 static int corgi_amp_event(struct snd_soc_dapm_widget *w, int event)
272         if (SND_SOC_DAPM_EVENT_ON(event))
273                 set_scoop_gpio(&corgiscoop_device.dev, CORGI_SCP_APM_ON);
274         else
275                 reset_scoop_gpio(&corgiscoop_device.dev, CORGI_SCP_APM_ON);
277         return 0;
280 /* corgi machine dapm widgets */
281 static const struct snd_soc_dapm_widget wm8731_dapm_widgets =
282         SND_SOC_DAPM_SPK("Ext Spk", corgi_amp_event);
284 Please see soc-dapm.h for all other widgets that support events.
287 5.1 Event types
288 ---------------
290 The following event types are supported by event widgets.
292 /* dapm event types */
293 #define SND_SOC_DAPM_PRE_PMU    0x1     /* before widget power up */
294 #define SND_SOC_DAPM_POST_PMU   0x2             /* after widget power up */
295 #define SND_SOC_DAPM_PRE_PMD    0x4     /* before widget power down */
296 #define SND_SOC_DAPM_POST_PMD   0x8             /* after widget power down */
297 #define SND_SOC_DAPM_PRE_REG    0x10    /* before audio path setup */
298 #define SND_SOC_DAPM_POST_REG   0x20    /* after audio path setup */