]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/sound/soc-dai.h
ASoC: CX20442: simplify codec controller usage
[mirror_ubuntu-jammy-kernel.git] / include / sound / soc-dai.h
CommitLineData
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
19struct 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
MB
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 *
47db8e89 41 * DAI bit clocks can be be gated (disabled) when the DAI is not
a47cbe72
MB
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
a47cbe72
MB
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 */
47db8e89
PM
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 */
a47cbe72
MB
57
58/*
59 * DAI hardware clock masters.
60 *
61 * This is wrt the codec, the inverse is true for the interface
47db8e89 62 * i.e. if the codec is clk and FRM master then the interface is
a47cbe72
MB
63 * clk and frame slave.
64 */
47db8e89
PM
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 */
a47cbe72 67#define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */
47db8e89 68#define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & FRM slave */
a47cbe72
MB
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
33f503c9 81#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S16_LE |\
d34c4307
JS
82 SNDRV_PCM_FMTBIT_S32_LE |\
83 SNDRV_PCM_FMTBIT_S32_BE)
33f503c9 84
a47cbe72
MB
85struct snd_soc_dai_ops;
86struct snd_soc_dai;
87struct snd_ac97_bus_ops;
88
9115171a
MB
89/* Digital Audio Interface registration */
90int snd_soc_register_dai(struct snd_soc_dai *dai);
91void snd_soc_unregister_dai(struct snd_soc_dai *dai);
92int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count);
93void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count);
94
a47cbe72
MB
95/* Digital Audio Interface clocking API.*/
96int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
97 unsigned int freq, int dir);
98
99int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
100 int div_id, int div);
101
102int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
103 int pll_id, unsigned int freq_in, unsigned int freq_out);
104
105/* Digital Audio interface formatting */
106int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
107
108int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
109 unsigned int mask, int slots);
110
111int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
112
113/* Digital Audio Interface mute */
114int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
115
116/*
117 * Digital Audio Interface.
118 *
47db8e89
PM
119 * Describes the Digital Audio Interface in terms of its ALSA, DAI and AC97
120 * operations and capabilities. Codec and platform drivers will register this
a47cbe72
MB
121 * structure for every DAI they have.
122 *
123 * This structure covers the clocking, formating and ALSA operations for each
47db8e89 124 * interface.
a47cbe72
MB
125 */
126struct snd_soc_dai_ops {
127 /*
128 * DAI clocking configuration, all optional.
129 * Called by soc_card drivers, normally in their hw_params.
130 */
131 int (*set_sysclk)(struct snd_soc_dai *dai,
132 int clk_id, unsigned int freq, int dir);
133 int (*set_pll)(struct snd_soc_dai *dai,
134 int pll_id, unsigned int freq_in, unsigned int freq_out);
135 int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);
136
137 /*
138 * DAI format configuration
139 * Called by soc_card drivers, normally in their hw_params.
140 */
141 int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
142 int (*set_tdm_slot)(struct snd_soc_dai *dai,
143 unsigned int mask, int slots);
144 int (*set_tristate)(struct snd_soc_dai *dai, int tristate);
145
146 /*
147 * DAI digital mute - optional.
148 * Called by soc-core to minimise any pops.
149 */
150 int (*digital_mute)(struct snd_soc_dai *dai, int mute);
dee89c4d
MB
151
152 /*
153 * ALSA PCM audio operations - all optional.
154 * Called by soc-core during audio PCM operations.
155 */
156 int (*startup)(struct snd_pcm_substream *,
157 struct snd_soc_dai *);
158 void (*shutdown)(struct snd_pcm_substream *,
159 struct snd_soc_dai *);
160 int (*hw_params)(struct snd_pcm_substream *,
161 struct snd_pcm_hw_params *, struct snd_soc_dai *);
162 int (*hw_free)(struct snd_pcm_substream *,
163 struct snd_soc_dai *);
164 int (*prepare)(struct snd_pcm_substream *,
165 struct snd_soc_dai *);
166 int (*trigger)(struct snd_pcm_substream *, int,
167 struct snd_soc_dai *);
a47cbe72
MB
168};
169
170/*
171 * Digital Audio Interface runtime data.
172 *
173 * Holds runtime data for a DAI.
174 */
175struct snd_soc_dai {
176 /* DAI description */
177 char *name;
178 unsigned int id;
3ba9e10a 179 int ac97_control;
a47cbe72 180
9115171a 181 struct device *dev;
474828a4 182 void *ac97_pdata; /* platform_data for the ac97 codec */
9115171a 183
a47cbe72
MB
184 /* DAI callbacks */
185 int (*probe)(struct platform_device *pdev,
186 struct snd_soc_dai *dai);
187 void (*remove)(struct platform_device *pdev,
188 struct snd_soc_dai *dai);
dc7d7b83
MB
189 int (*suspend)(struct snd_soc_dai *dai);
190 int (*resume)(struct snd_soc_dai *dai);
a47cbe72
MB
191
192 /* ops */
6335d055 193 struct snd_soc_dai_ops *ops;
a47cbe72
MB
194
195 /* DAI capabilities */
196 struct snd_soc_pcm_stream capture;
197 struct snd_soc_pcm_stream playback;
06f409d7 198 unsigned int symmetric_rates:1;
a47cbe72
MB
199
200 /* DAI runtime info */
201 struct snd_pcm_runtime *runtime;
202 struct snd_soc_codec *codec;
203 unsigned int active;
204 unsigned char pop_wait:1;
205 void *dma_data;
206
207 /* DAI private data */
208 void *private_data;
209
bbd99307
MB
210 /* parent platform */
211 struct snd_soc_platform *platform;
a47cbe72
MB
212
213 struct list_head list;
214};
215
216#endif