ALSA: asoc: core - merge structs snd_soc_codec_dai and snd_soc_cpu_dai.
[linux-2.6] / include / sound / soc.h
1 /*
2  * linux/sound/soc.h -- ALSA SoC Layer
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
13 #ifndef __LINUX_SND_SOC_H
14 #define __LINUX_SND_SOC_H
15
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>
23
24 #define SND_SOC_VERSION "0.13.2"
25
26 /*
27  * Convenience kcontrol builders
28  */
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) |\
32         ((invert) << 31))
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 }
122
123 /*
124  * Bias levels
125  *
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.
133  */
134 enum snd_soc_bias_level {
135         SND_SOC_BIAS_ON,
136         SND_SOC_BIAS_PREPARE,
137         SND_SOC_BIAS_STANDBY,
138         SND_SOC_BIAS_OFF,
139 };
140
141 /*
142  * Digital Audio Interface (DAI) types
143  */
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 */
148
149 /*
150  * DAI hardware audio formats
151  */
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 */
158
159 #define SND_SOC_DAIFMT_MSB      SND_SOC_DAIFMT_LEFT_J
160 #define SND_SOC_DAIFMT_LSB      SND_SOC_DAIFMT_RIGHT_J
161
162 /*
163  * DAI Gating
164  */
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 */
167
168 /*
169  * DAI Sync
170  * Synchronous LR (Left Right) clocks and Frame signals.
171  */
172 #define SND_SOC_DAIFMT_SYNC             (0 << 5)        /* Tx FRM = Rx FRM */
173 #define SND_SOC_DAIFMT_ASYNC            (1 << 5)        /* Tx FRM ~ Rx FRM */
174
175 /*
176  * TDM
177  */
178 #define SND_SOC_DAIFMT_TDM              (1 << 6)
179
180 /*
181  * DAI hardware signal inversions
182  */
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 */
187
188 /*
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.
193  */
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 */
198
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
203
204
205 /*
206  * Master Clock Directions
207  */
208 #define SND_SOC_CLOCK_IN        0
209 #define SND_SOC_CLOCK_OUT       1
210
211 /*
212  * AC97 codec ID's bitmask
213  */
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)
218
219 struct snd_soc_device;
220 struct snd_soc_pcm_stream;
221 struct snd_soc_ops;
222 struct snd_soc_dai_mode;
223 struct snd_soc_pcm_runtime;
224 struct snd_soc_dai;
225 struct snd_soc_codec;
226 struct snd_soc_machine_config;
227 struct soc_enum;
228 struct snd_soc_ac97_ops;
229 struct snd_soc_clock_info;
230
231 typedef int (*hw_write_t)(void *,const char* ,int);
232 typedef int (*hw_read_t)(void *,char* ,int);
233
234 extern struct snd_ac97_bus_ops soc_ac97_ops;
235
236 /* pcm <-> DAI connect */
237 void snd_soc_free_pcms(struct snd_soc_device *socdev);
238 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
239 int snd_soc_register_card(struct snd_soc_device *socdev);
240
241 /* set runtime hw params */
242 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
243         const struct snd_pcm_hardware *hw);
244
245 /* codec IO */
246 #define snd_soc_read(codec, reg) codec->read(codec, reg)
247 #define snd_soc_write(codec, reg, value) codec->write(codec, reg, value)
248
249 /* codec register bit access */
250 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
251                                 unsigned short mask, unsigned short value);
252 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
253                                 unsigned short mask, unsigned short value);
254
255 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
256         struct snd_ac97_bus_ops *ops, int num);
257 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
258
259 /*
260  *Controls
261  */
262 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
263         void *data, char *long_name);
264 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
265         struct snd_ctl_elem_info *uinfo);
266 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
267         struct snd_ctl_elem_info *uinfo);
268 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
269         struct snd_ctl_elem_value *ucontrol);
270 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
271         struct snd_ctl_elem_value *ucontrol);
272 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
273         struct snd_ctl_elem_info *uinfo);
274 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
275         struct snd_ctl_elem_info *uinfo);
276 #define snd_soc_info_bool_ext           snd_ctl_boolean_mono_info
277 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
278         struct snd_ctl_elem_value *ucontrol);
279 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
280         struct snd_ctl_elem_value *ucontrol);
281 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
282         struct snd_ctl_elem_info *uinfo);
283 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
284         struct snd_ctl_elem_value *ucontrol);
285 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
286         struct snd_ctl_elem_value *ucontrol);
287 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
288         struct snd_ctl_elem_info *uinfo);
289 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
290         struct snd_ctl_elem_value *ucontrol);
291 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
292         struct snd_ctl_elem_value *ucontrol);
293
294 /* SoC PCM stream information */
295 struct snd_soc_pcm_stream {
296         char *stream_name;
297         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
298         unsigned int rates;             /* SNDRV_PCM_RATE_* */
299         unsigned int rate_min;          /* min rate */
300         unsigned int rate_max;          /* max rate */
301         unsigned int channels_min;      /* min channels */
302         unsigned int channels_max;      /* max channels */
303         unsigned int active:1;          /* stream is in use */
304 };
305
306 /* SoC audio ops */
307 struct snd_soc_ops {
308         int (*startup)(struct snd_pcm_substream *);
309         void (*shutdown)(struct snd_pcm_substream *);
310         int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
311         int (*hw_free)(struct snd_pcm_substream *);
312         int (*prepare)(struct snd_pcm_substream *);
313         int (*trigger)(struct snd_pcm_substream *, int);
314 };
315
316 /* ASoC DAI ops */
317 struct snd_soc_dai_ops {
318         /* DAI clocking configuration */
319         int (*set_sysclk)(struct snd_soc_dai *dai,
320                 int clk_id, unsigned int freq, int dir);
321         int (*set_pll)(struct snd_soc_dai *dai,
322                 int pll_id, unsigned int freq_in, unsigned int freq_out);
323         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
324
325         /* DAI format configuration */
326         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
327         int (*set_tdm_slot)(struct snd_soc_dai *dai,
328                 unsigned int mask, int slots);
329         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
330
331         /* digital mute */
332         int (*digital_mute)(struct snd_soc_dai *dai, int mute);
333 };
334
335 /* SoC  DAI (Digital Audio Interface) */
336 struct snd_soc_dai {
337         /* DAI description */
338         char *name;
339         unsigned int id;
340         unsigned char type;
341
342         /* DAI callbacks */
343         int (*probe)(struct platform_device *pdev,
344                      struct snd_soc_dai *dai);
345         void (*remove)(struct platform_device *pdev,
346                        struct snd_soc_dai *dai);
347         int (*suspend)(struct platform_device *pdev,
348                 struct snd_soc_dai *dai);
349         int (*resume)(struct platform_device *pdev,
350                 struct snd_soc_dai *dai);
351
352         /* ops */
353         struct snd_soc_ops ops;
354         struct snd_soc_dai_ops dai_ops;
355
356         /* DAI capabilities */
357         struct snd_soc_pcm_stream capture;
358         struct snd_soc_pcm_stream playback;
359
360         /* DAI runtime info */
361         struct snd_pcm_runtime *runtime;
362         struct snd_soc_codec *codec;
363         unsigned int active;
364         unsigned char pop_wait:1;
365         void *dma_data;
366
367         /* DAI private data */
368         void *private_data;
369 };
370
371 /* SoC Audio Codec */
372 struct snd_soc_codec {
373         char *name;
374         struct module *owner;
375         struct mutex mutex;
376
377         /* callbacks */
378         int (*set_bias_level)(struct snd_soc_codec *,
379                               enum snd_soc_bias_level level);
380
381         /* runtime */
382         struct snd_card *card;
383         struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
384         unsigned int active;
385         unsigned int pcm_devs;
386         void *private_data;
387
388         /* codec IO */
389         void *control_data; /* codec control (i2c/3wire) data */
390         unsigned int (*read)(struct snd_soc_codec *, unsigned int);
391         int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
392         hw_write_t hw_write;
393         hw_read_t hw_read;
394         void *reg_cache;
395         short reg_cache_size;
396         short reg_cache_step;
397
398         /* dapm */
399         struct list_head dapm_widgets;
400         struct list_head dapm_paths;
401         enum snd_soc_bias_level bias_level;
402         enum snd_soc_bias_level suspend_bias_level;
403         struct delayed_work delayed_work;
404
405         /* codec DAI's */
406         struct snd_soc_dai *dai;
407         unsigned int num_dai;
408 };
409
410 /* codec device */
411 struct snd_soc_codec_device {
412         int (*probe)(struct platform_device *pdev);
413         int (*remove)(struct platform_device *pdev);
414         int (*suspend)(struct platform_device *pdev, pm_message_t state);
415         int (*resume)(struct platform_device *pdev);
416 };
417
418 /* SoC platform interface */
419 struct snd_soc_platform {
420         char *name;
421
422         int (*probe)(struct platform_device *pdev);
423         int (*remove)(struct platform_device *pdev);
424         int (*suspend)(struct platform_device *pdev,
425                 struct snd_soc_dai *dai);
426         int (*resume)(struct platform_device *pdev,
427                 struct snd_soc_dai *dai);
428
429         /* pcm creation and destruction */
430         int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
431                 struct snd_pcm *);
432         void (*pcm_free)(struct snd_pcm *);
433
434         /* platform stream ops */
435         struct snd_pcm_ops *pcm_ops;
436 };
437
438 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
439 struct snd_soc_dai_link  {
440         char *name;                     /* Codec name */
441         char *stream_name;              /* Stream name */
442
443         /* DAI */
444         struct snd_soc_dai *codec_dai;
445         struct snd_soc_dai *cpu_dai;
446
447         /* machine stream operations */
448         struct snd_soc_ops *ops;
449
450         /* codec/machine specific init - e.g. add machine controls */
451         int (*init)(struct snd_soc_codec *codec);
452
453         /* DAI pcm */
454         struct snd_pcm *pcm;
455 };
456
457 /* SoC machine */
458 struct snd_soc_machine {
459         char *name;
460
461         int (*probe)(struct platform_device *pdev);
462         int (*remove)(struct platform_device *pdev);
463
464         /* the pre and post PM functions are used to do any PM work before and
465          * after the codec and DAI's do any PM work. */
466         int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
467         int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
468         int (*resume_pre)(struct platform_device *pdev);
469         int (*resume_post)(struct platform_device *pdev);
470
471         /* callbacks */
472         int (*set_bias_level)(struct snd_soc_machine *,
473                               enum snd_soc_bias_level level);
474
475         /* CPU <--> Codec DAI links  */
476         struct snd_soc_dai_link *dai_link;
477         int num_links;
478 };
479
480 /* SoC Device - the audio subsystem */
481 struct snd_soc_device {
482         struct device *dev;
483         struct snd_soc_machine *machine;
484         struct snd_soc_platform *platform;
485         struct snd_soc_codec *codec;
486         struct snd_soc_codec_device *codec_dev;
487         struct delayed_work delayed_work;
488         struct work_struct deferred_resume_work;
489         void *codec_data;
490 };
491
492 /* runtime channel data */
493 struct snd_soc_pcm_runtime {
494         struct snd_soc_dai_link *dai;
495         struct snd_soc_device *socdev;
496 };
497
498 /* enumerated kcontrol */
499 struct soc_enum {
500         unsigned short reg;
501         unsigned short reg2;
502         unsigned char shift_l;
503         unsigned char shift_r;
504         unsigned int mask;
505         const char **texts;
506         void *dapm;
507 };
508
509 #endif