ASoC: Provide API for reordering channels
[linux-2.6.git] / include / sound / soc-dai.h
1 /*
2  * linux/sound/soc-dai.h -- ALSA SoC Layer
3  *
4  * Copyright:   2005-2008 Wolfson Microelectronics. PLC.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * Digital Audio Interface (DAI) API.
11  */
12
13 #ifndef __LINUX_SND_SOC_DAI_H
14 #define __LINUX_SND_SOC_DAI_H
15
16
17 #include <linux/list.h>
18
19 struct snd_pcm_substream;
20
21 /*
22  * DAI hardware audio formats.
23  *
24  * Describes the physical PCM data formating and clocking. Add new formats
25  * to the end.
26  */
27 #define SND_SOC_DAIFMT_I2S              0 /* I2S mode */
28 #define SND_SOC_DAIFMT_RIGHT_J          1 /* Right Justified mode */
29 #define SND_SOC_DAIFMT_LEFT_J           2 /* Left Justified mode */
30 #define SND_SOC_DAIFMT_DSP_A            3 /* L data MSB after FRM LRC */
31 #define SND_SOC_DAIFMT_DSP_B            4 /* L data MSB during FRM LRC */
32 #define SND_SOC_DAIFMT_AC97             5 /* AC97 */
33
34 /* left and right justified also known as MSB and LSB respectively */
35 #define SND_SOC_DAIFMT_MSB              SND_SOC_DAIFMT_LEFT_J
36 #define SND_SOC_DAIFMT_LSB              SND_SOC_DAIFMT_RIGHT_J
37
38 /*
39  * DAI Clock gating.
40  *
41  * DAI bit clocks can be be gated (disabled) when the DAI is not
42  * sending or receiving PCM data in a frame. This can be used to save power.
43  */
44 #define SND_SOC_DAIFMT_CONT             (0 << 4) /* continuous clock */
45 #define SND_SOC_DAIFMT_GATED            (1 << 4) /* clock is gated */
46
47 /*
48  * DAI hardware signal inversions.
49  *
50  * Specifies whether the DAI can also support inverted clocks for the specified
51  * format.
52  */
53 #define SND_SOC_DAIFMT_NB_NF            (0 << 8) /* normal bit clock + frame */
54 #define SND_SOC_DAIFMT_NB_IF            (1 << 8) /* normal BCLK + inv FRM */
55 #define SND_SOC_DAIFMT_IB_NF            (2 << 8) /* invert BCLK + nor FRM */
56 #define SND_SOC_DAIFMT_IB_IF            (3 << 8) /* invert BCLK + FRM */
57
58 /*
59  * DAI hardware clock masters.
60  *
61  * This is wrt the codec, the inverse is true for the interface
62  * i.e. if the codec is clk and FRM master then the interface is
63  * clk and frame slave.
64  */
65 #define SND_SOC_DAIFMT_CBM_CFM          (0 << 12) /* codec clk & FRM master */
66 #define SND_SOC_DAIFMT_CBS_CFM          (1 << 12) /* codec clk slave & FRM master */
67 #define SND_SOC_DAIFMT_CBM_CFS          (2 << 12) /* codec clk master & frame slave */
68 #define SND_SOC_DAIFMT_CBS_CFS          (3 << 12) /* codec clk & FRM slave */
69
70 #define SND_SOC_DAIFMT_FORMAT_MASK      0x000f
71 #define SND_SOC_DAIFMT_CLOCK_MASK       0x00f0
72 #define SND_SOC_DAIFMT_INV_MASK         0x0f00
73 #define SND_SOC_DAIFMT_MASTER_MASK      0xf000
74
75 /*
76  * Master Clock Directions
77  */
78 #define SND_SOC_CLOCK_IN                0
79 #define SND_SOC_CLOCK_OUT               1
80
81 #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\
82                                SNDRV_PCM_FMTBIT_S16_LE |\
83                                SNDRV_PCM_FMTBIT_S16_BE |\
84                                SNDRV_PCM_FMTBIT_S20_3LE |\
85                                SNDRV_PCM_FMTBIT_S20_3BE |\
86                                SNDRV_PCM_FMTBIT_S24_3LE |\
87                                SNDRV_PCM_FMTBIT_S24_3BE |\
88                                SNDRV_PCM_FMTBIT_S32_LE |\
89                                SNDRV_PCM_FMTBIT_S32_BE)
90
91 struct snd_soc_dai_ops;
92 struct snd_soc_dai;
93 struct snd_ac97_bus_ops;
94
95 /* Digital Audio Interface registration */
96 int snd_soc_register_dai(struct snd_soc_dai *dai);
97 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
98 int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count);
99 void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count);
100
101 /* Digital Audio Interface clocking API.*/
102 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
103         unsigned int freq, int dir);
104
105 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
106         int div_id, int div);
107
108 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
109         int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
110
111 /* Digital Audio interface formatting */
112 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
113
114 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
115         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
116
117 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
118         unsigned int tx_num, unsigned int *tx_slot,
119         unsigned int rx_num, unsigned int *rx_slot);
120
121 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
122
123 /* Digital Audio Interface mute */
124 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
125
126 /*
127  * Digital Audio Interface.
128  *
129  * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
130  * operations and capabilities. Codec and platform drivers will register this
131  * structure for every DAI they have.
132  *
133  * This structure covers the clocking, formating and ALSA operations for each
134  * interface.
135  */
136 struct snd_soc_dai_ops {
137         /*
138          * DAI clocking configuration, all optional.
139          * Called by soc_card drivers, normally in their hw_params.
140          */
141         int (*set_sysclk)(struct snd_soc_dai *dai,
142                 int clk_id, unsigned int freq, int dir);
143         int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
144                 unsigned int freq_in, unsigned int freq_out);
145         int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
146
147         /*
148          * DAI format configuration
149          * Called by soc_card drivers, normally in their hw_params.
150          */
151         int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
152         int (*set_tdm_slot)(struct snd_soc_dai *dai,
153                 unsigned int tx_mask, unsigned int rx_mask,
154                 int slots, int slot_width);
155         int (*set_channel_map)(struct snd_soc_dai *dai,
156                 unsigned int tx_num, unsigned int *tx_slot,
157                 unsigned int rx_num, unsigned int *rx_slot);
158         int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
159
160         /*
161          * DAI digital mute - optional.
162          * Called by soc-core to minimise any pops.
163          */
164         int (*digital_mute)(struct snd_soc_dai *dai, int mute);
165
166         /*
167          * ALSA PCM audio operations - all optional.
168          * Called by soc-core during audio PCM operations.
169          */
170         int (*startup)(struct snd_pcm_substream *,
171                 struct snd_soc_dai *);
172         void (*shutdown)(struct snd_pcm_substream *,
173                 struct snd_soc_dai *);
174         int (*hw_params)(struct snd_pcm_substream *,
175                 struct snd_pcm_hw_params *, struct snd_soc_dai *);
176         int (*hw_free)(struct snd_pcm_substream *,
177                 struct snd_soc_dai *);
178         int (*prepare)(struct snd_pcm_substream *,
179                 struct snd_soc_dai *);
180         int (*trigger)(struct snd_pcm_substream *, int,
181                 struct snd_soc_dai *);
182 };
183
184 /*
185  * Digital Audio Interface runtime data.
186  *
187  * Holds runtime data for a DAI.
188  */
189 struct snd_soc_dai {
190         /* DAI description */
191         char *name;
192         unsigned int id;
193         int ac97_control;
194
195         struct device *dev;
196         void *ac97_pdata;       /* platform_data for the ac97 codec */
197
198         /* DAI callbacks */
199         int (*probe)(struct platform_device *pdev,
200                      struct snd_soc_dai *dai);
201         void (*remove)(struct platform_device *pdev,
202                        struct snd_soc_dai *dai);
203         int (*suspend)(struct snd_soc_dai *dai);
204         int (*resume)(struct snd_soc_dai *dai);
205
206         /* ops */
207         struct snd_soc_dai_ops *ops;
208
209         /* DAI capabilities */
210         struct snd_soc_pcm_stream capture;
211         struct snd_soc_pcm_stream playback;
212         unsigned int symmetric_rates:1;
213
214         /* DAI runtime info */
215         struct snd_pcm_runtime *runtime;
216         struct snd_soc_codec *codec;
217         unsigned int active;
218         unsigned char pop_wait:1;
219         void *dma_data;
220
221         /* DAI private data */
222         void *private_data;
223
224         /* parent platform */
225         struct snd_soc_platform *platform;
226
227         struct list_head list;
228 };
229
230 #endif