soc-dapm.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. /*
  2. * linux/sound/soc-dapm.h -- ALSA SoC Dynamic Audio Power Management
  3. *
  4. * Author: Liam Girdwood
  5. * Created: Aug 11th 2005
  6. * Copyright: Wolfson Microelectronics. PLC.
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License version 2 as
  10. * published by the Free Software Foundation.
  11. */
  12. #ifndef __LINUX_SND_SOC_DAPM_H
  13. #define __LINUX_SND_SOC_DAPM_H
  14. #include <linux/device.h>
  15. #include <linux/types.h>
  16. #include <sound/control.h>
  17. #include <sound/soc.h>
  18. /* widget has no PM register bit */
  19. #define SND_SOC_NOPM -1
  20. /*
  21. * SoC dynamic audio power managment
  22. *
  23. * We can have upto 4 power domains
  24. * 1. Codec domain - VREF, VMID
  25. * Usually controlled at codec probe/remove, although can be set
  26. * at stream time if power is not needed for sidetone, etc.
  27. * 2. Platform/Machine domain - physically connected inputs and outputs
  28. * Is platform/machine and user action specific, is set in the machine
  29. * driver and by userspace e.g when HP are inserted
  30. * 3. Path domain - Internal codec path mixers
  31. * Are automatically set when mixer and mux settings are
  32. * changed by the user.
  33. * 4. Stream domain - DAC's and ADC's.
  34. * Enabled when stream playback/capture is started.
  35. */
  36. /* codec domain */
  37. #define SND_SOC_DAPM_VMID(wname) \
  38. { .id = snd_soc_dapm_vmid, .name = wname, .kcontrols = NULL, \
  39. .num_kcontrols = 0}
  40. /* platform domain */
  41. #define SND_SOC_DAPM_INPUT(wname) \
  42. { .id = snd_soc_dapm_input, .name = wname, .kcontrols = NULL, \
  43. .num_kcontrols = 0}
  44. #define SND_SOC_DAPM_OUTPUT(wname) \
  45. { .id = snd_soc_dapm_output, .name = wname, .kcontrols = NULL, \
  46. .num_kcontrols = 0}
  47. #define SND_SOC_DAPM_MIC(wname, wevent) \
  48. { .id = snd_soc_dapm_mic, .name = wname, .kcontrols = NULL, \
  49. .num_kcontrols = 0, .event = wevent, \
  50. .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD}
  51. #define SND_SOC_DAPM_HP(wname, wevent) \
  52. { .id = snd_soc_dapm_hp, .name = wname, .kcontrols = NULL, \
  53. .num_kcontrols = 0, .event = wevent, \
  54. .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  55. #define SND_SOC_DAPM_SPK(wname, wevent) \
  56. { .id = snd_soc_dapm_spk, .name = wname, .kcontrols = NULL, \
  57. .num_kcontrols = 0, .event = wevent, \
  58. .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  59. #define SND_SOC_DAPM_LINE(wname, wevent) \
  60. { .id = snd_soc_dapm_line, .name = wname, .kcontrols = NULL, \
  61. .num_kcontrols = 0, .event = wevent, \
  62. .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD}
  63. /* path domain */
  64. #define SND_SOC_DAPM_PGA(wname, wreg, wshift, winvert,\
  65. wcontrols, wncontrols) \
  66. { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
  67. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  68. #define SND_SOC_DAPM_MIXER(wname, wreg, wshift, winvert, \
  69. wcontrols, wncontrols)\
  70. { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
  71. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols}
  72. #define SND_SOC_DAPM_MICBIAS(wname, wreg, wshift, winvert) \
  73. { .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
  74. .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0}
  75. #define SND_SOC_DAPM_SWITCH(wname, wreg, wshift, winvert, wcontrols) \
  76. { .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
  77. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  78. #define SND_SOC_DAPM_MUX(wname, wreg, wshift, winvert, wcontrols) \
  79. { .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
  80. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1}
  81. /* path domain with event - event handler must return 0 for success */
  82. #define SND_SOC_DAPM_PGA_E(wname, wreg, wshift, winvert, wcontrols, \
  83. wncontrols, wevent, wflags) \
  84. { .id = snd_soc_dapm_pga, .name = wname, .reg = wreg, .shift = wshift, \
  85. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
  86. .event = wevent, .event_flags = wflags}
  87. #define SND_SOC_DAPM_MIXER_E(wname, wreg, wshift, winvert, wcontrols, \
  88. wncontrols, wevent, wflags) \
  89. { .id = snd_soc_dapm_mixer, .name = wname, .reg = wreg, .shift = wshift, \
  90. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = wncontrols, \
  91. .event = wevent, .event_flags = wflags}
  92. #define SND_SOC_DAPM_MICBIAS_E(wname, wreg, wshift, winvert, wevent, wflags) \
  93. { .id = snd_soc_dapm_micbias, .name = wname, .reg = wreg, .shift = wshift, \
  94. .invert = winvert, .kcontrols = NULL, .num_kcontrols = 0, \
  95. .event = wevent, .event_flags = wflags}
  96. #define SND_SOC_DAPM_SWITCH_E(wname, wreg, wshift, winvert, wcontrols, \
  97. wevent, wflags) \
  98. { .id = snd_soc_dapm_switch, .name = wname, .reg = wreg, .shift = wshift, \
  99. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1 \
  100. .event = wevent, .event_flags = wflags}
  101. #define SND_SOC_DAPM_MUX_E(wname, wreg, wshift, winvert, wcontrols, \
  102. wevent, wflags) \
  103. { .id = snd_soc_dapm_mux, .name = wname, .reg = wreg, .shift = wshift, \
  104. .invert = winvert, .kcontrols = wcontrols, .num_kcontrols = 1, \
  105. .event = wevent, .event_flags = wflags}
  106. /* events that are pre and post DAPM */
  107. #define SND_SOC_DAPM_PRE(wname, wevent) \
  108. { .id = snd_soc_dapm_pre, .name = wname, .kcontrols = NULL, \
  109. .num_kcontrols = 0, .event = wevent, \
  110. .event_flags = SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_PRE_PMD}
  111. #define SND_SOC_DAPM_POST(wname, wevent) \
  112. { .id = snd_soc_dapm_post, .name = wname, .kcontrols = NULL, \
  113. .num_kcontrols = 0, .event = wevent, \
  114. .event_flags = SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD}
  115. /* stream domain */
  116. #define SND_SOC_DAPM_DAC(wname, stname, wreg, wshift, winvert) \
  117. { .id = snd_soc_dapm_dac, .name = wname, .sname = stname, .reg = wreg, \
  118. .shift = wshift, .invert = winvert}
  119. #define SND_SOC_DAPM_ADC(wname, stname, wreg, wshift, winvert) \
  120. { .id = snd_soc_dapm_adc, .name = wname, .sname = stname, .reg = wreg, \
  121. .shift = wshift, .invert = winvert}
  122. /* dapm kcontrol types */
  123. #define SOC_DAPM_SINGLE(xname, reg, shift, mask, invert) \
  124. { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  125. .info = snd_soc_info_volsw, \
  126. .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
  127. .private_value = SOC_SINGLE_VALUE(reg, shift, mask, invert) }
  128. #define SOC_DAPM_DOUBLE(xname, reg, shift_left, shift_right, mask, invert, \
  129. power) \
  130. { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  131. .info = snd_soc_info_volsw, \
  132. .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
  133. .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
  134. ((mask) << 16) | ((invert) << 24) }
  135. #define SOC_DAPM_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
  136. { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  137. .info = snd_soc_info_volsw, \
  138. .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  139. .tlv.p = (tlv_array), \
  140. .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
  141. .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
  142. #define SOC_DAPM_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, \
  143. power, tlv_array) \
  144. { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
  145. .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,\
  146. .tlv.p = (tlv_array), \
  147. .info = snd_soc_info_volsw, \
  148. .get = snd_soc_dapm_get_volsw, .put = snd_soc_dapm_put_volsw, \
  149. .private_value = (reg) | ((shift_left) << 8) | ((shift_right) << 12) |\
  150. ((max) << 16) | ((invert) << 24) }
  151. #define SOC_DAPM_ENUM(xname, xenum) \
  152. { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
  153. .info = snd_soc_info_enum_double, \
  154. .get = snd_soc_dapm_get_enum_double, \
  155. .put = snd_soc_dapm_put_enum_double, \
  156. .private_value = (unsigned long)&xenum }
  157. /* dapm stream operations */
  158. #define SND_SOC_DAPM_STREAM_NOP 0x0
  159. #define SND_SOC_DAPM_STREAM_START 0x1
  160. #define SND_SOC_DAPM_STREAM_STOP 0x2
  161. #define SND_SOC_DAPM_STREAM_SUSPEND 0x4
  162. #define SND_SOC_DAPM_STREAM_RESUME 0x8
  163. #define SND_SOC_DAPM_STREAM_PAUSE_PUSH 0x10
  164. #define SND_SOC_DAPM_STREAM_PAUSE_RELEASE 0x20
  165. /* dapm event types */
  166. #define SND_SOC_DAPM_PRE_PMU 0x1 /* before widget power up */
  167. #define SND_SOC_DAPM_POST_PMU 0x2 /* after widget power up */
  168. #define SND_SOC_DAPM_PRE_PMD 0x4 /* before widget power down */
  169. #define SND_SOC_DAPM_POST_PMD 0x8 /* after widget power down */
  170. #define SND_SOC_DAPM_PRE_REG 0x10 /* before audio path setup */
  171. #define SND_SOC_DAPM_POST_REG 0x20 /* after audio path setup */
  172. /* convenience event type detection */
  173. #define SND_SOC_DAPM_EVENT_ON(e) \
  174. (e & (SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU))
  175. #define SND_SOC_DAPM_EVENT_OFF(e) \
  176. (e & (SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD))
  177. struct snd_soc_dapm_widget;
  178. enum snd_soc_dapm_type;
  179. struct snd_soc_dapm_path;
  180. struct snd_soc_dapm_pin;
  181. /* dapm controls */
  182. int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol,
  183. struct snd_ctl_elem_value *ucontrol);
  184. int snd_soc_dapm_get_volsw(struct snd_kcontrol *kcontrol,
  185. struct snd_ctl_elem_value *ucontrol);
  186. int snd_soc_dapm_get_enum_double(struct snd_kcontrol *kcontrol,
  187. struct snd_ctl_elem_value *ucontrol);
  188. int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol,
  189. struct snd_ctl_elem_value *ucontrol);
  190. int snd_soc_dapm_new_control(struct snd_soc_codec *codec,
  191. const struct snd_soc_dapm_widget *widget);
  192. /* dapm path setup */
  193. int snd_soc_dapm_connect_input(struct snd_soc_codec *codec,
  194. const char *sink_name, const char *control_name, const char *src_name);
  195. int snd_soc_dapm_new_widgets(struct snd_soc_codec *codec);
  196. void snd_soc_dapm_free(struct snd_soc_device *socdev);
  197. /* dapm events */
  198. int snd_soc_dapm_stream_event(struct snd_soc_codec *codec, char *stream,
  199. int event);
  200. /* dapm sys fs - used by the core */
  201. int snd_soc_dapm_sys_add(struct device *dev);
  202. /* dapm audio endpoint control */
  203. int snd_soc_dapm_set_endpoint(struct snd_soc_codec *codec,
  204. char *pin, int status);
  205. int snd_soc_dapm_sync_endpoints(struct snd_soc_codec *codec);
  206. /* dapm widget types */
  207. enum snd_soc_dapm_type {
  208. snd_soc_dapm_input = 0, /* input pin */
  209. snd_soc_dapm_output, /* output pin */
  210. snd_soc_dapm_mux, /* selects 1 analog signal from many inputs */
  211. snd_soc_dapm_mixer, /* mixes several analog signals together */
  212. snd_soc_dapm_pga, /* programmable gain/attenuation (volume) */
  213. snd_soc_dapm_adc, /* analog to digital converter */
  214. snd_soc_dapm_dac, /* digital to analog converter */
  215. snd_soc_dapm_micbias, /* microphone bias (power) */
  216. snd_soc_dapm_mic, /* microphone */
  217. snd_soc_dapm_hp, /* headphones */
  218. snd_soc_dapm_spk, /* speaker */
  219. snd_soc_dapm_line, /* line input/output */
  220. snd_soc_dapm_switch, /* analog switch */
  221. snd_soc_dapm_vmid, /* codec bias/vmid - to minimise pops */
  222. snd_soc_dapm_pre, /* machine specific pre widget - exec first */
  223. snd_soc_dapm_post, /* machine specific post widget - exec last */
  224. };
  225. /* dapm audio path between two widgets */
  226. struct snd_soc_dapm_path {
  227. char *name;
  228. char *long_name;
  229. /* source (input) and sink (output) widgets */
  230. struct snd_soc_dapm_widget *source;
  231. struct snd_soc_dapm_widget *sink;
  232. struct snd_kcontrol *kcontrol;
  233. /* status */
  234. u32 connect:1; /* source and sink widgets are connected */
  235. u32 walked:1; /* path has been walked */
  236. struct list_head list_source;
  237. struct list_head list_sink;
  238. struct list_head list;
  239. };
  240. /* dapm widget */
  241. struct snd_soc_dapm_widget {
  242. enum snd_soc_dapm_type id;
  243. char *name; /* widget name */
  244. char *sname; /* stream name */
  245. struct snd_soc_codec *codec;
  246. struct list_head list;
  247. /* dapm control */
  248. short reg; /* negative reg = no direct dapm */
  249. unsigned char shift; /* bits to shift */
  250. unsigned int saved_value; /* widget saved value */
  251. unsigned int value; /* widget current value */
  252. unsigned char power:1; /* block power status */
  253. unsigned char invert:1; /* invert the power bit */
  254. unsigned char active:1; /* active stream on DAC, ADC's */
  255. unsigned char connected:1; /* connected codec pin */
  256. unsigned char new:1; /* cnew complete */
  257. unsigned char ext:1; /* has external widgets */
  258. unsigned char muted:1; /* muted for pop reduction */
  259. unsigned char suspend:1; /* was active before suspend */
  260. unsigned char pmdown:1; /* waiting for timeout */
  261. /* external events */
  262. unsigned short event_flags; /* flags to specify event types */
  263. int (*event)(struct snd_soc_dapm_widget*, struct snd_kcontrol *, int);
  264. /* kcontrols that relate to this widget */
  265. int num_kcontrols;
  266. const struct snd_kcontrol_new *kcontrols;
  267. /* widget input and outputs */
  268. struct list_head sources;
  269. struct list_head sinks;
  270. };
  271. #endif