perf, ARM: Modify kuser rmb() call to compile for Thumb-2
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / include / sound / soc-dai.h
blobca24e7f7a3f5b83551efa2b1c62cfaba5991dd28
1 /*
2 * linux/sound/soc-dai.h -- ALSA SoC Layer
4 * Copyright: 2005-2008 Wolfson Microelectronics. PLC.
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.
10 * Digital Audio Interface (DAI) API.
13 #ifndef __LINUX_SND_SOC_DAI_H
14 #define __LINUX_SND_SOC_DAI_H
17 #include <linux/list.h>
19 struct snd_pcm_substream;
22 * DAI hardware audio formats.
24 * Describes the physical PCM data formating and clocking. Add new formats
25 * to the end.
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 #define SND_SOC_DAIFMT_PDM 6 /* Pulse density modulation */
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
40 * DAI Clock gating.
42 * DAI bit clocks can be be gated (disabled) when the DAI is not
43 * sending or receiving PCM data in a frame. This can be used to save power.
45 #define SND_SOC_DAIFMT_CONT (0 << 4) /* continuous clock */
46 #define SND_SOC_DAIFMT_GATED (1 << 4) /* clock is gated */
49 * DAI hardware signal inversions.
51 * Specifies whether the DAI can also support inverted clocks for the specified
52 * format.
54 #define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
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 */
60 * DAI hardware clock masters.
62 * This is wrt the codec, the inverse is true for the interface
63 * i.e. if the codec is clk and FRM master then the interface is
64 * clk and frame slave.
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 */
68 #define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */
69 #define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & FRM slave */
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
77 * Master Clock Directions
79 #define SND_SOC_CLOCK_IN 0
80 #define SND_SOC_CLOCK_OUT 1
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 |\
89 SNDRV_PCM_FMTBIT_S32_LE |\
90 SNDRV_PCM_FMTBIT_S32_BE)
92 struct snd_soc_dai_ops;
93 struct snd_soc_dai;
94 struct snd_ac97_bus_ops;
96 /* Digital Audio Interface registration */
97 int snd_soc_register_dai(struct snd_soc_dai *dai);
98 void snd_soc_unregister_dai(struct snd_soc_dai *dai);
99 int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count);
100 void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count);
102 /* Digital Audio Interface clocking API.*/
103 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
104 unsigned int freq, int dir);
106 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
107 int div_id, int div);
109 int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
110 int pll_id, int source, unsigned int freq_in, unsigned int freq_out);
112 /* Digital Audio interface formatting */
113 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
115 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
116 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width);
118 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
119 unsigned int tx_num, unsigned int *tx_slot,
120 unsigned int rx_num, unsigned int *rx_slot);
122 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
124 /* Digital Audio Interface mute */
125 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
128 * Digital Audio Interface.
130 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
131 * operations and capabilities. Codec and platform drivers will register this
132 * structure for every DAI they have.
134 * This structure covers the clocking, formating and ALSA operations for each
135 * interface.
137 struct snd_soc_dai_ops {
139 * DAI clocking configuration, all optional.
140 * Called by soc_card drivers, normally in their hw_params.
142 int (*set_sysclk)(struct snd_soc_dai *dai,
143 int clk_id, unsigned int freq, int dir);
144 int (*set_pll)(struct snd_soc_dai *dai, int pll_id, int source,
145 unsigned int freq_in, unsigned int freq_out);
146 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
149 * DAI format configuration
150 * Called by soc_card drivers, normally in their hw_params.
152 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
153 int (*set_tdm_slot)(struct snd_soc_dai *dai,
154 unsigned int tx_mask, unsigned int rx_mask,
155 int slots, int slot_width);
156 int (*set_channel_map)(struct snd_soc_dai *dai,
157 unsigned int tx_num, unsigned int *tx_slot,
158 unsigned int rx_num, unsigned int *rx_slot);
159 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
162 * DAI digital mute - optional.
163 * Called by soc-core to minimise any pops.
165 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
168 * ALSA PCM audio operations - all optional.
169 * Called by soc-core during audio PCM operations.
171 int (*startup)(struct snd_pcm_substream *,
172 struct snd_soc_dai *);
173 void (*shutdown)(struct snd_pcm_substream *,
174 struct snd_soc_dai *);
175 int (*hw_params)(struct snd_pcm_substream *,
176 struct snd_pcm_hw_params *, struct snd_soc_dai *);
177 int (*hw_free)(struct snd_pcm_substream *,
178 struct snd_soc_dai *);
179 int (*prepare)(struct snd_pcm_substream *,
180 struct snd_soc_dai *);
181 int (*trigger)(struct snd_pcm_substream *, int,
182 struct snd_soc_dai *);
186 * Digital Audio Interface runtime data.
188 * Holds runtime data for a DAI.
190 struct snd_soc_dai {
191 /* DAI description */
192 char *name;
193 unsigned int id;
194 int ac97_control;
196 struct device *dev;
197 void *ac97_pdata; /* platform_data for the ac97 codec */
199 /* DAI callbacks */
200 int (*probe)(struct platform_device *pdev,
201 struct snd_soc_dai *dai);
202 void (*remove)(struct platform_device *pdev,
203 struct snd_soc_dai *dai);
204 int (*suspend)(struct snd_soc_dai *dai);
205 int (*resume)(struct snd_soc_dai *dai);
207 /* ops */
208 struct snd_soc_dai_ops *ops;
210 /* DAI capabilities */
211 struct snd_soc_pcm_stream capture;
212 struct snd_soc_pcm_stream playback;
213 unsigned int symmetric_rates:1;
215 /* DAI runtime info */
216 struct snd_pcm_runtime *runtime;
217 struct snd_soc_codec *codec;
218 unsigned int active;
219 unsigned char pop_wait:1;
220 void *dma_data;
222 /* DAI private data */
223 void *private_data;
225 /* parent platform */
226 struct snd_soc_platform *platform;
228 struct list_head list;
231 #endif