2 * linux/sound/soc.h -- ALSA SoC Layer
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
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.
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
16 #include <linux/platform_device.h>
17 #include <linux/types.h>
18 #include <linux/workqueue.h>
19 #include <sound/core.h>
20 #include <sound/pcm.h>
21 #include <sound/control.h>
22 #include <sound/ac97_codec.h>
24 #define SND_SOC_VERSION "0.13.2"
27 * Convenience kcontrol builders
29 #define SOC_SINGLE_VALUE(reg, shift, max, invert) ((reg) | ((shift) << 8) |\
30 ((shift) << 12) | ((max) << 16) | ((invert) << 24))
31 #define SOC_SINGLE_VALUE_EXT(reg, max, invert) ((reg) | ((max) << 16) |\
33 #define SOC_SINGLE(xname, reg, shift, max, invert) \
34 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
35 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
36 .put = snd_soc_put_volsw, \
37 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
38 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
39 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
40 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
41 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
42 .tlv.p = (tlv_array), \
43 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
44 .put = snd_soc_put_volsw, \
45 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
46 #define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
47 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
48 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
49 .put = snd_soc_put_volsw, \
50 .private_value = (reg) | ((shift_left) << 8) | \
51 ((shift_right) << 12) | ((max) << 16) | ((invert) << 24) }
52 #define SOC_DOUBLE_R(xname, reg_left, reg_right, shift, max, invert) \
53 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
54 .info = snd_soc_info_volsw_2r, \
55 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
56 .private_value = (reg_left) | ((shift) << 8) | \
57 ((max) << 12) | ((invert) << 20) | ((reg_right) << 24) }
58 #define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
59 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
60 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
61 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
62 .tlv.p = (tlv_array), \
63 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
64 .put = snd_soc_put_volsw, \
65 .private_value = (reg) | ((shift_left) << 8) | \
66 ((shift_right) << 12) | ((max) << 16) | ((invert) << 24) }
67 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, shift, max, invert, tlv_array) \
68 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
69 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
70 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
71 .tlv.p = (tlv_array), \
72 .info = snd_soc_info_volsw_2r, \
73 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
74 .private_value = (reg_left) | ((shift) << 8) | \
75 ((max) << 12) | ((invert) << 20) | ((reg_right) << 24) }
76 #define SOC_DOUBLE_S8_TLV(xname, reg, min, max, tlv_array) \
77 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
78 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
79 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
80 .tlv.p = (tlv_array), \
81 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
82 .put = snd_soc_put_volsw_s8, \
83 .private_value = (reg) | (((signed char)max) << 16) | \
84 (((signed char)min) << 24) }
85 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xtexts) \
86 { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
87 .mask = xmask, .texts = xtexts }
88 #define SOC_ENUM_SINGLE(xreg, xshift, xmask, xtexts) \
89 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xtexts)
90 #define SOC_ENUM_SINGLE_EXT(xmask, xtexts) \
91 { .mask = xmask, .texts = xtexts }
92 #define SOC_ENUM(xname, xenum) \
93 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
94 .info = snd_soc_info_enum_double, \
95 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
96 .private_value = (unsigned long)&xenum }
97 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmask, xinvert,\
98 xhandler_get, xhandler_put) \
99 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
100 .info = snd_soc_info_volsw, \
101 .get = xhandler_get, .put = xhandler_put, \
102 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmask, xinvert) }
103 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmask, xinvert,\
104 xhandler_get, xhandler_put, tlv_array) \
105 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
106 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
107 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
108 .tlv.p = (tlv_array), \
109 .info = snd_soc_info_volsw, \
110 .get = xhandler_get, .put = xhandler_put, \
111 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmask, xinvert) }
112 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
113 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
114 .info = snd_soc_info_bool_ext, \
115 .get = xhandler_get, .put = xhandler_put, \
116 .private_value = xdata }
117 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
118 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
119 .info = snd_soc_info_enum_ext, \
120 .get = xhandler_get, .put = xhandler_put, \
121 .private_value = (unsigned long)&xenum }
126 * @ON: Bias is fully on for audio playback and capture operations.
127 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
128 * stream start and stop operations.
129 * @STANDBY: Low power standby state when no playback/capture operations are
130 * in progress. NOTE: The transition time between STANDBY and ON
131 * should be as fast as possible and no longer than 10ms.
132 * @OFF: Power Off. No restrictions on transition times.
134 enum snd_soc_bias_level {
136 SND_SOC_BIAS_PREPARE,
137 SND_SOC_BIAS_STANDBY,
142 * Digital Audio Interface (DAI) types
144 #define SND_SOC_DAI_AC97 0x1
145 #define SND_SOC_DAI_I2S 0x2
146 #define SND_SOC_DAI_PCM 0x4
147 #define SND_SOC_DAI_AC97_BUS 0x8 /* for custom i.e. non ac97_codec.c */
150 * DAI hardware audio formats
152 #define SND_SOC_DAIFMT_I2S 0 /* I2S mode */
153 #define SND_SOC_DAIFMT_RIGHT_J 1 /* Right justified mode */
154 #define SND_SOC_DAIFMT_LEFT_J 2 /* Left Justified mode */
155 #define SND_SOC_DAIFMT_DSP_A 3 /* L data msb after FRM or LRC */
156 #define SND_SOC_DAIFMT_DSP_B 4 /* L data msb during FRM or LRC */
157 #define SND_SOC_DAIFMT_AC97 5 /* AC97 */
159 #define SND_SOC_DAIFMT_MSB SND_SOC_DAIFMT_LEFT_J
160 #define SND_SOC_DAIFMT_LSB SND_SOC_DAIFMT_RIGHT_J
165 #define SND_SOC_DAIFMT_CONT (0 << 4) /* continuous clock */
166 #define SND_SOC_DAIFMT_GATED (1 << 4) /* clock is gated when not Tx/Rx */
170 * Synchronous LR (Left Right) clocks and Frame signals.
172 #define SND_SOC_DAIFMT_SYNC (0 << 5) /* Tx FRM = Rx FRM */
173 #define SND_SOC_DAIFMT_ASYNC (1 << 5) /* Tx FRM ~ Rx FRM */
178 #define SND_SOC_DAIFMT_TDM (1 << 6)
181 * DAI hardware signal inversions
183 #define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bclk + frm */
184 #define SND_SOC_DAIFMT_NB_IF (1 << 8) /* normal bclk + inv frm */
185 #define SND_SOC_DAIFMT_IB_NF (2 << 8) /* invert bclk + nor frm */
186 #define SND_SOC_DAIFMT_IB_IF (3 << 8) /* invert bclk + frm */
189 * DAI hardware clock masters
190 * This is wrt the codec, the inverse is true for the interface
191 * i.e. if the codec is clk and frm master then the interface is
192 * clk and frame slave.
194 #define SND_SOC_DAIFMT_CBM_CFM (0 << 12) /* codec clk & frm master */
195 #define SND_SOC_DAIFMT_CBS_CFM (1 << 12) /* codec clk slave & frm master */
196 #define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */
197 #define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & frm slave */
199 #define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
200 #define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
201 #define SND_SOC_DAIFMT_INV_MASK 0x0f00
202 #define SND_SOC_DAIFMT_MASTER_MASK 0xf000
206 * Master Clock Directions
208 #define SND_SOC_CLOCK_IN 0
209 #define SND_SOC_CLOCK_OUT 1
212 * AC97 codec ID's bitmask
214 #define SND_SOC_DAI_AC97_ID0 (1 << 0)
215 #define SND_SOC_DAI_AC97_ID1 (1 << 1)
216 #define SND_SOC_DAI_AC97_ID2 (1 << 2)
217 #define SND_SOC_DAI_AC97_ID3 (1 << 3)
219 struct snd_soc_device;
220 struct snd_soc_pcm_stream;
222 struct snd_soc_dai_mode;
223 struct snd_soc_pcm_runtime;
224 struct snd_soc_codec_dai;
225 struct snd_soc_cpu_dai;
226 struct snd_soc_codec;
227 struct snd_soc_machine_config;
229 struct snd_soc_ac97_ops;
230 struct snd_soc_clock_info;
232 typedef int (*hw_write_t)(void *,const char* ,int);
233 typedef int (*hw_read_t)(void *,char* ,int);
235 extern struct snd_ac97_bus_ops soc_ac97_ops;
237 /* pcm <-> DAI connect */
238 void snd_soc_free_pcms(struct snd_soc_device *socdev);
239 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
240 int snd_soc_register_card(struct snd_soc_device *socdev);
242 /* set runtime hw params */
243 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
244 const struct snd_pcm_hardware *hw);
247 #define snd_soc_read(codec, reg) codec->read(codec, reg)
248 #define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)
250 /* codec register bit access */
251 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
252 unsigned short mask, unsigned short value);
253 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
254 unsigned short mask, unsigned short value);
256 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
257 struct snd_ac97_bus_ops *ops, int num);
258 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
263 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
264 void *data, char *long_name);
265 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
266 struct snd_ctl_elem_info *uinfo);
267 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
268 struct snd_ctl_elem_info *uinfo);
269 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
270 struct snd_ctl_elem_value *ucontrol);
271 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
272 struct snd_ctl_elem_value *ucontrol);
273 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
274 struct snd_ctl_elem_info *uinfo);
275 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
276 struct snd_ctl_elem_info *uinfo);
277 #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
278 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
279 struct snd_ctl_elem_value *ucontrol);
280 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
281 struct snd_ctl_elem_value *ucontrol);
282 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
283 struct snd_ctl_elem_info *uinfo);
284 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
285 struct snd_ctl_elem_value *ucontrol);
286 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
287 struct snd_ctl_elem_value *ucontrol);
288 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
289 struct snd_ctl_elem_info *uinfo);
290 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
291 struct snd_ctl_elem_value *ucontrol);
292 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
293 struct snd_ctl_elem_value *ucontrol);
295 /* SoC PCM stream information */
296 struct snd_soc_pcm_stream {
298 u64 formats; /* SNDRV_PCM_FMTBIT_* */
299 unsigned int rates; /* SNDRV_PCM_RATE_* */
300 unsigned int rate_min; /* min rate */
301 unsigned int rate_max; /* max rate */
302 unsigned int channels_min; /* min channels */
303 unsigned int channels_max; /* max channels */
304 unsigned int active:1; /* stream is in use */
309 int (*startup)(struct snd_pcm_substream *);
310 void (*shutdown)(struct snd_pcm_substream *);
311 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
312 int (*hw_free)(struct snd_pcm_substream *);
313 int (*prepare)(struct snd_pcm_substream *);
314 int (*trigger)(struct snd_pcm_substream *, int);
318 struct snd_soc_dai_ops {
319 /* DAI clocking configuration */
320 int (*set_sysclk)(struct snd_soc_codec_dai *codec_dai,
321 int clk_id, unsigned int freq, int dir);
322 int (*set_pll)(struct snd_soc_codec_dai *codec_dai,
323 int pll_id, unsigned int freq_in, unsigned int freq_out);
324 int (*set_clkdiv)(struct snd_soc_codec_dai *codec_dai,
325 int div_id, int div);
327 /* DAI format configuration */
328 int (*set_fmt)(struct snd_soc_codec_dai *codec_dai,
330 int (*set_tdm_slot)(struct snd_soc_codec_dai *codec_dai,
331 unsigned int mask, int slots);
332 int (*set_tristate)(struct snd_soc_codec_dai *, int tristate);
335 int (*digital_mute)(struct snd_soc_codec_dai *, int mute);
339 struct snd_soc_codec_dai {
344 /* DAI capabilities */
345 struct snd_soc_pcm_stream playback;
346 struct snd_soc_pcm_stream capture;
348 /* DAI runtime info */
349 struct snd_soc_codec *codec;
351 unsigned char pop_wait:1;
354 struct snd_soc_ops ops;
355 struct snd_soc_dai_ops dai_ops;
357 /* DAI private data */
362 struct snd_soc_cpu_dai {
364 /* DAI description */
370 int (*probe)(struct platform_device *pdev,
371 struct snd_soc_cpu_dai *dai);
372 void (*remove)(struct platform_device *pdev,
373 struct snd_soc_cpu_dai *dai);
374 int (*suspend)(struct platform_device *pdev,
375 struct snd_soc_cpu_dai *cpu_dai);
376 int (*resume)(struct platform_device *pdev,
377 struct snd_soc_cpu_dai *cpu_dai);
380 struct snd_soc_ops ops;
381 struct snd_soc_dai_ops dai_ops;
383 /* DAI capabilities */
384 struct snd_soc_pcm_stream capture;
385 struct snd_soc_pcm_stream playback;
387 /* DAI runtime info */
388 struct snd_pcm_runtime *runtime;
389 unsigned char active:1;
392 /* DAI private data */
396 /* SoC Audio Codec */
397 struct snd_soc_codec {
399 struct module *owner;
403 int (*set_bias_level)(struct snd_soc_codec *,
404 enum snd_soc_bias_level level);
407 struct snd_card *card;
408 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
410 unsigned int pcm_devs;
414 void *control_data; /* codec control (i2c/3wire) data */
415 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
416 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
420 short reg_cache_size;
421 short reg_cache_step;
424 struct list_head dapm_widgets;
425 struct list_head dapm_paths;
426 enum snd_soc_bias_level bias_level;
427 enum snd_soc_bias_level suspend_bias_level;
428 struct delayed_work delayed_work;
431 struct snd_soc_codec_dai *dai;
432 unsigned int num_dai;
436 struct snd_soc_codec_device {
437 int (*probe)(struct platform_device *pdev);
438 int (*remove)(struct platform_device *pdev);
439 int (*suspend)(struct platform_device *pdev, pm_message_t state);
440 int (*resume)(struct platform_device *pdev);
443 /* SoC platform interface */
444 struct snd_soc_platform {
447 int (*probe)(struct platform_device *pdev);
448 int (*remove)(struct platform_device *pdev);
449 int (*suspend)(struct platform_device *pdev,
450 struct snd_soc_cpu_dai *cpu_dai);
451 int (*resume)(struct platform_device *pdev,
452 struct snd_soc_cpu_dai *cpu_dai);
454 /* pcm creation and destruction */
455 int (*pcm_new)(struct snd_card *, struct snd_soc_codec_dai *,
457 void (*pcm_free)(struct snd_pcm *);
459 /* platform stream ops */
460 struct snd_pcm_ops *pcm_ops;
463 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
464 struct snd_soc_dai_link {
465 char *name; /* Codec name */
466 char *stream_name; /* Stream name */
469 struct snd_soc_codec_dai *codec_dai;
470 struct snd_soc_cpu_dai *cpu_dai;
472 /* machine stream operations */
473 struct snd_soc_ops *ops;
475 /* codec/machine specific init - e.g. add machine controls */
476 int (*init)(struct snd_soc_codec *codec);
483 struct snd_soc_machine {
486 int (*probe)(struct platform_device *pdev);
487 int (*remove)(struct platform_device *pdev);
489 /* the pre and post PM functions are used to do any PM work before and
490 * after the codec and DAI's do any PM work. */
491 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
492 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
493 int (*resume_pre)(struct platform_device *pdev);
494 int (*resume_post)(struct platform_device *pdev);
497 int (*set_bias_level)(struct snd_soc_machine *,
498 enum snd_soc_bias_level level);
500 /* CPU <--> Codec DAI links */
501 struct snd_soc_dai_link *dai_link;
505 /* SoC Device - the audio subsystem */
506 struct snd_soc_device {
508 struct snd_soc_machine *machine;
509 struct snd_soc_platform *platform;
510 struct snd_soc_codec *codec;
511 struct snd_soc_codec_device *codec_dev;
512 struct delayed_work delayed_work;
516 /* runtime channel data */
517 struct snd_soc_pcm_runtime {
518 struct snd_soc_dai_link *dai;
519 struct snd_soc_device *socdev;
522 /* enumerated kcontrol */
526 unsigned char shift_l;
527 unsigned char shift_r;