Commit | Line | Data |
---|---|---|
a47cbe72 MB |
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 */ | |
47db8e89 PM |
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 */ | |
a47cbe72 | 32 | #define SND_SOC_DAIFMT_AC97 5 /* AC97 */ |
be2500b8 | 33 | #define SND_SOC_DAIFMT_PDM 6 /* Pulse density modulation */ |
a47cbe72 MB |
34 | |
35 | /* left and right justified also known as MSB and LSB respectively */ | |
36 | #define SND_SOC_DAIFMT_MSB SND_SOC_DAIFMT_LEFT_J | |
37 | #define SND_SOC_DAIFMT_LSB SND_SOC_DAIFMT_RIGHT_J | |
38 | ||
39 | /* | |
40 | * DAI Clock gating. | |
41 | * | |
47db8e89 | 42 | * DAI bit clocks can be be gated (disabled) when the DAI is not |
a47cbe72 MB |
43 | * sending or receiving PCM data in a frame. This can be used to save power. |
44 | */ | |
45 | #define SND_SOC_DAIFMT_CONT (0 << 4) /* continuous clock */ | |
46 | #define SND_SOC_DAIFMT_GATED (1 << 4) /* clock is gated */ | |
47 | ||
a47cbe72 MB |
48 | /* |
49 | * DAI hardware signal inversions. | |
50 | * | |
51 | * Specifies whether the DAI can also support inverted clocks for the specified | |
52 | * format. | |
53 | */ | |
54 | #define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */ | |
47db8e89 PM |
55 | #define SND_SOC_DAIFMT_NB_IF (1 << 8) /* normal BCLK + inv FRM */ |
56 | #define SND_SOC_DAIFMT_IB_NF (2 << 8) /* invert BCLK + nor FRM */ | |
57 | #define SND_SOC_DAIFMT_IB_IF (3 << 8) /* invert BCLK + FRM */ | |
a47cbe72 MB |
58 | |
59 | /* | |
60 | * DAI hardware clock masters. | |
61 | * | |
62 | * This is wrt the codec, the inverse is true for the interface | |
47db8e89 | 63 | * i.e. if the codec is clk and FRM master then the interface is |
a47cbe72 MB |
64 | * clk and frame slave. |
65 | */ | |
47db8e89 PM |
66 | #define SND_SOC_DAIFMT_CBM_CFM (0 << 12) /* codec clk & FRM master */ |
67 | #define SND_SOC_DAIFMT_CBS_CFM (1 << 12) /* codec clk slave & FRM master */ | |
a47cbe72 | 68 | #define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */ |
47db8e89 | 69 | #define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & FRM slave */ |
a47cbe72 MB |
70 | |
71 | #define SND_SOC_DAIFMT_FORMAT_MASK 0x000f | |
72 | #define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0 | |
73 | #define SND_SOC_DAIFMT_INV_MASK 0x0f00 | |
74 | #define SND_SOC_DAIFMT_MASTER_MASK 0xf000 | |
75 | ||
76 | /* | |
77 | * Master Clock Directions | |
78 | */ | |
79 | #define SND_SOC_CLOCK_IN 0 | |
80 | #define SND_SOC_CLOCK_OUT 1 | |
81 | ||
8f738d58 MB |
82 | #define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S8 |\ |
83 | SNDRV_PCM_FMTBIT_S16_LE |\ | |
84 | SNDRV_PCM_FMTBIT_S16_BE |\ | |
85 | SNDRV_PCM_FMTBIT_S20_3LE |\ | |
86 | SNDRV_PCM_FMTBIT_S20_3BE |\ | |
87 | SNDRV_PCM_FMTBIT_S24_3LE |\ | |
88 | SNDRV_PCM_FMTBIT_S24_3BE |\ | |
d34c4307 JS |
89 | SNDRV_PCM_FMTBIT_S32_LE |\ |
90 | SNDRV_PCM_FMTBIT_S32_BE) | |
33f503c9 | 91 | |
f0fba2ad | 92 | struct snd_soc_dai_driver; |
a47cbe72 MB |
93 | struct snd_soc_dai; |
94 | struct snd_ac97_bus_ops; | |
95 | ||
9115171a | 96 | /* Digital Audio Interface registration */ |
f0fba2ad LG |
97 | int snd_soc_register_dai(struct device *dev, |
98 | struct snd_soc_dai_driver *dai_drv); | |
99 | void snd_soc_unregister_dai(struct device *dev); | |
100 | int snd_soc_register_dais(struct device *dev, | |
101 | struct snd_soc_dai_driver *dai_drv, size_t count); | |
102 | void snd_soc_unregister_dais(struct device *dev, size_t count); | |
9115171a | 103 | |
a47cbe72 MB |
104 | /* Digital Audio Interface clocking API.*/ |
105 | int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id, | |
106 | unsigned int freq, int dir); | |
107 | ||
108 | int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai, | |
109 | int div_id, int div); | |
110 | ||
111 | int snd_soc_dai_set_pll(struct snd_soc_dai *dai, | |
85488037 | 112 | int pll_id, int source, unsigned int freq_in, unsigned int freq_out); |
a47cbe72 MB |
113 | |
114 | /* Digital Audio interface formatting */ | |
115 | int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt); | |
116 | ||
117 | int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai, | |
a5479e38 | 118 | unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width); |
a47cbe72 | 119 | |
472df3cb BS |
120 | int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai, |
121 | unsigned int tx_num, unsigned int *tx_slot, | |
122 | unsigned int rx_num, unsigned int *rx_slot); | |
123 | ||
a47cbe72 MB |
124 | int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate); |
125 | ||
126 | /* Digital Audio Interface mute */ | |
127 | int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute); | |
128 | ||
a47cbe72 MB |
129 | struct snd_soc_dai_ops { |
130 | /* | |
131 | * DAI clocking configuration, all optional. | |
132 | * Called by soc_card drivers, normally in their hw_params. | |
133 | */ | |
134 | int (*set_sysclk)(struct snd_soc_dai *dai, | |
135 | int clk_id, unsigned int freq, int dir); | |
85488037 MB |
136 | int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source, |
137 | unsigned int freq_in, unsigned int freq_out); | |
a47cbe72 MB |
138 | int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div); |
139 | ||
140 | /* | |
141 | * DAI format configuration | |
142 | * Called by soc_card drivers, normally in their hw_params. | |
143 | */ | |
144 | int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt); | |
145 | int (*set_tdm_slot)(struct snd_soc_dai *dai, | |
a5479e38 DR |
146 | unsigned int tx_mask, unsigned int rx_mask, |
147 | int slots, int slot_width); | |
472df3cb BS |
148 | int (*set_channel_map)(struct snd_soc_dai *dai, |
149 | unsigned int tx_num, unsigned int *tx_slot, | |
150 | unsigned int rx_num, unsigned int *rx_slot); | |
a47cbe72 MB |
151 | int (*set_tristate)(struct snd_soc_dai *dai, int tristate); |
152 | ||
153 | /* | |
154 | * DAI digital mute - optional. | |
155 | * Called by soc-core to minimise any pops. | |
156 | */ | |
157 | int (*digital_mute)(struct snd_soc_dai *dai, int mute); | |
dee89c4d MB |
158 | |
159 | /* | |
160 | * ALSA PCM audio operations - all optional. | |
161 | * Called by soc-core during audio PCM operations. | |
162 | */ | |
163 | int (*startup)(struct snd_pcm_substream *, | |
164 | struct snd_soc_dai *); | |
165 | void (*shutdown)(struct snd_pcm_substream *, | |
166 | struct snd_soc_dai *); | |
167 | int (*hw_params)(struct snd_pcm_substream *, | |
168 | struct snd_pcm_hw_params *, struct snd_soc_dai *); | |
169 | int (*hw_free)(struct snd_pcm_substream *, | |
170 | struct snd_soc_dai *); | |
171 | int (*prepare)(struct snd_pcm_substream *, | |
172 | struct snd_soc_dai *); | |
173 | int (*trigger)(struct snd_pcm_substream *, int, | |
174 | struct snd_soc_dai *); | |
258020d0 PU |
175 | /* |
176 | * For hardware based FIFO caused delay reporting. | |
177 | * Optional. | |
178 | */ | |
179 | snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *, | |
180 | struct snd_soc_dai *); | |
a47cbe72 MB |
181 | }; |
182 | ||
183 | /* | |
f0fba2ad | 184 | * Digital Audio Interface Driver. |
a47cbe72 | 185 | * |
f0fba2ad LG |
186 | * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97 |
187 | * operations and capabilities. Codec and platform drivers will register this | |
188 | * structure for every DAI they have. | |
189 | * | |
190 | * This structure covers the clocking, formating and ALSA operations for each | |
191 | * interface. | |
a47cbe72 | 192 | */ |
f0fba2ad | 193 | struct snd_soc_dai_driver { |
a47cbe72 | 194 | /* DAI description */ |
f0fba2ad | 195 | const char *name; |
a47cbe72 | 196 | unsigned int id; |
3ba9e10a | 197 | int ac97_control; |
a47cbe72 | 198 | |
f0fba2ad LG |
199 | /* DAI driver callbacks */ |
200 | int (*probe)(struct snd_soc_dai *dai); | |
201 | int (*remove)(struct snd_soc_dai *dai); | |
dc7d7b83 MB |
202 | int (*suspend)(struct snd_soc_dai *dai); |
203 | int (*resume)(struct snd_soc_dai *dai); | |
a47cbe72 MB |
204 | |
205 | /* ops */ | |
1ee46ebd | 206 | const struct snd_soc_dai_ops *ops; |
a47cbe72 MB |
207 | |
208 | /* DAI capabilities */ | |
209 | struct snd_soc_pcm_stream capture; | |
210 | struct snd_soc_pcm_stream playback; | |
06f409d7 | 211 | unsigned int symmetric_rates:1; |
f0fba2ad LG |
212 | }; |
213 | ||
214 | /* | |
215 | * Digital Audio Interface runtime data. | |
216 | * | |
217 | * Holds runtime data for a DAI. | |
218 | */ | |
219 | struct snd_soc_dai { | |
220 | const char *name; | |
221 | int id; | |
222 | struct device *dev; | |
223 | void *ac97_pdata; /* platform_data for the ac97 codec */ | |
224 | ||
225 | /* driver ops */ | |
226 | struct snd_soc_dai_driver *driver; | |
a47cbe72 MB |
227 | |
228 | /* DAI runtime info */ | |
f0fba2ad LG |
229 | unsigned int capture_active:1; /* stream is in use */ |
230 | unsigned int playback_active:1; /* stream is in use */ | |
231 | unsigned int symmetric_rates:1; | |
232 | struct snd_pcm_runtime *runtime; | |
a47cbe72 MB |
233 | unsigned int active; |
234 | unsigned char pop_wait:1; | |
f0fba2ad | 235 | unsigned char probed:1; |
a47cbe72 | 236 | |
f0fba2ad LG |
237 | /* DAI DMA data */ |
238 | void *playback_dma_data; | |
239 | void *capture_dma_data; | |
a47cbe72 | 240 | |
f0fba2ad LG |
241 | /* parent platform/codec */ |
242 | union { | |
243 | struct snd_soc_platform *platform; | |
244 | struct snd_soc_codec *codec; | |
245 | }; | |
246 | struct snd_soc_card *card; | |
a47cbe72 MB |
247 | |
248 | struct list_head list; | |
f0fba2ad | 249 | struct list_head card_list; |
a47cbe72 MB |
250 | }; |
251 | ||
fd23b7de DM |
252 | static inline void *snd_soc_dai_get_dma_data(const struct snd_soc_dai *dai, |
253 | const struct snd_pcm_substream *ss) | |
254 | { | |
255 | return (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) ? | |
f0fba2ad | 256 | dai->playback_dma_data : dai->capture_dma_data; |
fd23b7de DM |
257 | } |
258 | ||
259 | static inline void snd_soc_dai_set_dma_data(struct snd_soc_dai *dai, | |
260 | const struct snd_pcm_substream *ss, | |
261 | void *data) | |
262 | { | |
263 | if (ss->stream == SNDRV_PCM_STREAM_PLAYBACK) | |
f0fba2ad | 264 | dai->playback_dma_data = data; |
fd23b7de | 265 | else |
f0fba2ad LG |
266 | dai->capture_dma_data = data; |
267 | } | |
268 | ||
269 | static inline void snd_soc_dai_set_drvdata(struct snd_soc_dai *dai, | |
270 | void *data) | |
271 | { | |
272 | dev_set_drvdata(dai->dev, data); | |
273 | } | |
274 | ||
275 | static inline void *snd_soc_dai_get_drvdata(struct snd_soc_dai *dai) | |
276 | { | |
277 | return dev_get_drvdata(dai->dev); | |
fd23b7de DM |
278 | } |
279 | ||
a47cbe72 | 280 | #endif |