xref: /linux/include/sound/soc.h (revision f8324e20f8289dffc646d64366332e05eaacab25)
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/notifier.h>
19 #include <linux/workqueue.h>
20 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/control.h>
25 #include <sound/ac97_codec.h>
26 
27 /*
28  * Convenience kcontrol builders
29  */
30 #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
31 	((unsigned long)&(struct soc_mixer_control) \
32 	{.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
33 	.platform_max = xmax, .invert = xinvert})
34 #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
35 	((unsigned long)&(struct soc_mixer_control) \
36 	{.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
37 #define SOC_SINGLE(xname, reg, shift, max, invert) \
38 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
39 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
40 	.put = snd_soc_put_volsw, \
41 	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
42 #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
43 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
44 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
45 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
46 	.tlv.p = (tlv_array), \
47 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
48 	.put = snd_soc_put_volsw, \
49 	.private_value =  SOC_SINGLE_VALUE(reg, shift, max, invert) }
50 #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
51 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
52 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
53 	.put = snd_soc_put_volsw, \
54 	.private_value = (unsigned long)&(struct soc_mixer_control) \
55 		{.reg = xreg, .shift = shift_left, .rshift = shift_right, \
56 		 .max = xmax, .platform_max = xmax, .invert = xinvert} }
57 #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
58 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
59 	.info = snd_soc_info_volsw_2r, \
60 	.get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
61 	.private_value = (unsigned long)&(struct soc_mixer_control) \
62 		{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
63 		.max = xmax, .platform_max = xmax, .invert = xinvert} }
64 #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
65 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
66 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
67 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
68 	.tlv.p = (tlv_array), \
69 	.info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
70 	.put = snd_soc_put_volsw, \
71 	.private_value = (unsigned long)&(struct soc_mixer_control) \
72 		{.reg = xreg, .shift = shift_left, .rshift = shift_right,\
73 		 .max = xmax, .platform_max = xmax, .invert = xinvert} }
74 #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
75 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
76 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
77 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
78 	.tlv.p = (tlv_array), \
79 	.info = snd_soc_info_volsw_2r, \
80 	.get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
81 	.private_value = (unsigned long)&(struct soc_mixer_control) \
82 		{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
83 		.max = xmax, .platform_max = xmax, .invert = xinvert} }
84 #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
85 {	.iface  = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
86 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87 		  SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88 	.tlv.p  = (tlv_array), \
89 	.info   = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
90 	.put    = snd_soc_put_volsw_s8, \
91 	.private_value = (unsigned long)&(struct soc_mixer_control) \
92 		{.reg = xreg, .min = xmin, .max = xmax, \
93 		 .platform_max = xmax} }
94 #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
95 {	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
96 	.max = xmax, .texts = xtexts }
97 #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
98 	SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
99 #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
100 {	.max = xmax, .texts = xtexts }
101 #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
102 {	.reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
103 	.mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
104 #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
105 	SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
106 #define SOC_ENUM(xname, xenum) \
107 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
108 	.info = snd_soc_info_enum_double, \
109 	.get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
110 	.private_value = (unsigned long)&xenum }
111 #define SOC_VALUE_ENUM(xname, xenum) \
112 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
113 	.info = snd_soc_info_enum_double, \
114 	.get = snd_soc_get_value_enum_double, \
115 	.put = snd_soc_put_value_enum_double, \
116 	.private_value = (unsigned long)&xenum }
117 #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
118 	 xhandler_get, xhandler_put) \
119 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
120 	.info = snd_soc_info_volsw, \
121 	.get = xhandler_get, .put = xhandler_put, \
122 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
123 #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
124 	 xhandler_get, xhandler_put) \
125 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126 	.info = snd_soc_info_volsw, \
127 	.get = xhandler_get, .put = xhandler_put, \
128 	.private_value = (unsigned long)&(struct soc_mixer_control) \
129 		{.reg = xreg, .shift = shift_left, .rshift = shift_right, \
130 		 .max = xmax, .platform_max = xmax, .invert = xinvert} }
131 #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
132 	 xhandler_get, xhandler_put, tlv_array) \
133 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
134 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
135 		 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
136 	.tlv.p = (tlv_array), \
137 	.info = snd_soc_info_volsw, \
138 	.get = xhandler_get, .put = xhandler_put, \
139 	.private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
140 #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
141 	 xhandler_get, xhandler_put, tlv_array) \
142 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
143 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
144 		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
145 	.tlv.p = (tlv_array), \
146 	.info = snd_soc_info_volsw, \
147 	.get = xhandler_get, .put = xhandler_put, \
148 	.private_value = (unsigned long)&(struct soc_mixer_control) \
149 		{.reg = xreg, .shift = shift_left, .rshift = shift_right, \
150 		.max = xmax, .platform_max = xmax, .invert = xinvert} }
151 #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
152 	 xhandler_get, xhandler_put, tlv_array) \
153 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
154 	.access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
155 		 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
156 	.tlv.p = (tlv_array), \
157 	.info = snd_soc_info_volsw_2r, \
158 	.get = xhandler_get, .put = xhandler_put, \
159 	.private_value = (unsigned long)&(struct soc_mixer_control) \
160 		{.reg = reg_left, .rreg = reg_right, .shift = xshift, \
161 		.max = xmax, .platform_max = xmax, .invert = xinvert} }
162 #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
163 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
164 	.info = snd_soc_info_bool_ext, \
165 	.get = xhandler_get, .put = xhandler_put, \
166 	.private_value = xdata }
167 #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
168 {	.iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
169 	.info = snd_soc_info_enum_ext, \
170 	.get = xhandler_get, .put = xhandler_put, \
171 	.private_value = (unsigned long)&xenum }
172 
173 /*
174  * Simplified versions of above macros, declaring a struct and calculating
175  * ARRAY_SIZE internally
176  */
177 #define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
178 	struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
179 						ARRAY_SIZE(xtexts), xtexts)
180 #define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
181 	SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
182 #define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
183 	struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
184 #define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
185 	struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
186 							ARRAY_SIZE(xtexts), xtexts, xvalues)
187 #define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
188 	SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
189 
190 /*
191  * Bias levels
192  *
193  * @ON:      Bias is fully on for audio playback and capture operations.
194  * @PREPARE: Prepare for audio operations. Called before DAPM switching for
195  *           stream start and stop operations.
196  * @STANDBY: Low power standby state when no playback/capture operations are
197  *           in progress. NOTE: The transition time between STANDBY and ON
198  *           should be as fast as possible and no longer than 10ms.
199  * @OFF:     Power Off. No restrictions on transition times.
200  */
201 enum snd_soc_bias_level {
202 	SND_SOC_BIAS_ON,
203 	SND_SOC_BIAS_PREPARE,
204 	SND_SOC_BIAS_STANDBY,
205 	SND_SOC_BIAS_OFF,
206 };
207 
208 struct snd_jack;
209 struct snd_soc_card;
210 struct snd_soc_device;
211 struct snd_soc_pcm_stream;
212 struct snd_soc_ops;
213 struct snd_soc_dai_mode;
214 struct snd_soc_pcm_runtime;
215 struct snd_soc_dai;
216 struct snd_soc_platform;
217 struct snd_soc_dai_link;
218 struct snd_soc_codec;
219 struct soc_enum;
220 struct snd_soc_ac97_ops;
221 struct snd_soc_jack;
222 struct snd_soc_jack_pin;
223 #ifdef CONFIG_GPIOLIB
224 struct snd_soc_jack_gpio;
225 #endif
226 
227 typedef int (*hw_write_t)(void *,const char* ,int);
228 
229 extern struct snd_ac97_bus_ops soc_ac97_ops;
230 
231 enum snd_soc_control_type {
232 	SND_SOC_CUSTOM,
233 	SND_SOC_I2C,
234 	SND_SOC_SPI,
235 };
236 
237 int snd_soc_register_platform(struct snd_soc_platform *platform);
238 void snd_soc_unregister_platform(struct snd_soc_platform *platform);
239 int snd_soc_register_codec(struct snd_soc_codec *codec);
240 void snd_soc_unregister_codec(struct snd_soc_codec *codec);
241 int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
242 int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
243 			       int addr_bits, int data_bits,
244 			       enum snd_soc_control_type control);
245 
246 /* pcm <-> DAI connect */
247 void snd_soc_free_pcms(struct snd_soc_device *socdev);
248 int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
249 
250 /* Utility functions to get clock rates from various things */
251 int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
252 int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
253 int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
254 int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
255 
256 /* set runtime hw params */
257 int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
258 	const struct snd_pcm_hardware *hw);
259 
260 /* Jack reporting */
261 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
262 		     struct snd_soc_jack *jack);
263 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
264 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
265 			  struct snd_soc_jack_pin *pins);
266 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
267 				    struct notifier_block *nb);
268 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
269 				      struct notifier_block *nb);
270 #ifdef CONFIG_GPIOLIB
271 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
272 			struct snd_soc_jack_gpio *gpios);
273 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
274 			struct snd_soc_jack_gpio *gpios);
275 #endif
276 
277 /* codec register bit access */
278 int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
279 				unsigned int mask, unsigned int value);
280 int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
281 			       unsigned short reg, unsigned int mask,
282 			       unsigned int value);
283 int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
284 				unsigned int mask, unsigned int value);
285 
286 int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
287 	struct snd_ac97_bus_ops *ops, int num);
288 void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
289 
290 /*
291  *Controls
292  */
293 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
294 	void *data, char *long_name);
295 int snd_soc_add_controls(struct snd_soc_codec *codec,
296 	const struct snd_kcontrol_new *controls, int num_controls);
297 int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
298 	struct snd_ctl_elem_info *uinfo);
299 int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
300 	struct snd_ctl_elem_info *uinfo);
301 int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
302 	struct snd_ctl_elem_value *ucontrol);
303 int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
304 	struct snd_ctl_elem_value *ucontrol);
305 int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
306 	struct snd_ctl_elem_value *ucontrol);
307 int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
308 	struct snd_ctl_elem_value *ucontrol);
309 int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
310 	struct snd_ctl_elem_info *uinfo);
311 int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
312 	struct snd_ctl_elem_info *uinfo);
313 #define snd_soc_info_bool_ext		snd_ctl_boolean_mono_info
314 int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
315 	struct snd_ctl_elem_value *ucontrol);
316 int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
317 	struct snd_ctl_elem_value *ucontrol);
318 int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
319 	struct snd_ctl_elem_info *uinfo);
320 int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
321 	struct snd_ctl_elem_value *ucontrol);
322 int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
323 	struct snd_ctl_elem_value *ucontrol);
324 int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
325 	struct snd_ctl_elem_info *uinfo);
326 int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
327 	struct snd_ctl_elem_value *ucontrol);
328 int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
329 	struct snd_ctl_elem_value *ucontrol);
330 int snd_soc_limit_volume(struct snd_soc_codec *codec,
331 	const char *name, int max);
332 
333 /**
334  * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
335  *
336  * @pin:    name of the pin to update
337  * @mask:   bits to check for in reported jack status
338  * @invert: if non-zero then pin is enabled when status is not reported
339  */
340 struct snd_soc_jack_pin {
341 	struct list_head list;
342 	const char *pin;
343 	int mask;
344 	bool invert;
345 };
346 
347 /**
348  * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
349  *
350  * @gpio:         gpio number
351  * @name:         gpio name
352  * @report:       value to report when jack detected
353  * @invert:       report presence in low state
354  * @debouce_time: debouce time in ms
355  */
356 #ifdef CONFIG_GPIOLIB
357 struct snd_soc_jack_gpio {
358 	unsigned int gpio;
359 	const char *name;
360 	int report;
361 	int invert;
362 	int debounce_time;
363 	struct snd_soc_jack *jack;
364 	struct work_struct work;
365 
366 	int (*jack_status_check)(void);
367 };
368 #endif
369 
370 struct snd_soc_jack {
371 	struct snd_jack *jack;
372 	struct snd_soc_card *card;
373 	struct list_head pins;
374 	int status;
375 	struct blocking_notifier_head notifier;
376 };
377 
378 /* SoC PCM stream information */
379 struct snd_soc_pcm_stream {
380 	char *stream_name;
381 	u64 formats;			/* SNDRV_PCM_FMTBIT_* */
382 	unsigned int rates;		/* SNDRV_PCM_RATE_* */
383 	unsigned int rate_min;		/* min rate */
384 	unsigned int rate_max;		/* max rate */
385 	unsigned int channels_min;	/* min channels */
386 	unsigned int channels_max;	/* max channels */
387 	unsigned int active;		/* stream is in use */
388 	void *dma_data;			/* used by platform code */
389 };
390 
391 /* SoC audio ops */
392 struct snd_soc_ops {
393 	int (*startup)(struct snd_pcm_substream *);
394 	void (*shutdown)(struct snd_pcm_substream *);
395 	int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
396 	int (*hw_free)(struct snd_pcm_substream *);
397 	int (*prepare)(struct snd_pcm_substream *);
398 	int (*trigger)(struct snd_pcm_substream *, int);
399 };
400 
401 /* SoC Audio Codec */
402 struct snd_soc_codec {
403 	char *name;
404 	struct module *owner;
405 	struct mutex mutex;
406 	struct device *dev;
407 	struct snd_soc_device *socdev;
408 
409 	struct list_head list;
410 
411 	/* callbacks */
412 	int (*set_bias_level)(struct snd_soc_codec *,
413 			      enum snd_soc_bias_level level);
414 
415 	/* runtime */
416 	struct snd_card *card;
417 	struct snd_ac97 *ac97;  /* for ad-hoc ac97 devices */
418 	unsigned int active;
419 	unsigned int pcm_devs;
420 	void *drvdata;
421 
422 	/* codec IO */
423 	void *control_data; /* codec control (i2c/3wire) data */
424 	unsigned int (*read)(struct snd_soc_codec *, unsigned int);
425 	int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
426 	int (*display_register)(struct snd_soc_codec *, char *,
427 				size_t, unsigned int);
428 	int (*volatile_register)(unsigned int);
429 	int (*readable_register)(unsigned int);
430 	hw_write_t hw_write;
431 	unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
432 	void *reg_cache;
433 	short reg_cache_size;
434 	short reg_cache_step;
435 
436 	unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
437 	unsigned int cache_only:1;  /* Suppress writes to hardware */
438 	unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
439 
440 	/* dapm */
441 	u32 pop_time;
442 	struct list_head dapm_widgets;
443 	struct list_head dapm_paths;
444 	enum snd_soc_bias_level bias_level;
445 	enum snd_soc_bias_level suspend_bias_level;
446 	struct delayed_work delayed_work;
447 
448 	/* codec DAI's */
449 	struct snd_soc_dai *dai;
450 	unsigned int num_dai;
451 
452 #ifdef CONFIG_DEBUG_FS
453 	struct dentry *debugfs_codec_root;
454 	struct dentry *debugfs_reg;
455 	struct dentry *debugfs_pop_time;
456 	struct dentry *debugfs_dapm;
457 #endif
458 };
459 
460 /* codec device */
461 struct snd_soc_codec_device {
462 	int (*probe)(struct platform_device *pdev);
463 	int (*remove)(struct platform_device *pdev);
464 	int (*suspend)(struct platform_device *pdev, pm_message_t state);
465 	int (*resume)(struct platform_device *pdev);
466 };
467 
468 /* SoC platform interface */
469 struct snd_soc_platform {
470 	char *name;
471 	struct list_head list;
472 
473 	int (*probe)(struct platform_device *pdev);
474 	int (*remove)(struct platform_device *pdev);
475 	int (*suspend)(struct snd_soc_dai_link *dai_link);
476 	int (*resume)(struct snd_soc_dai_link *dai_link);
477 
478 	/* pcm creation and destruction */
479 	int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
480 		struct snd_pcm *);
481 	void (*pcm_free)(struct snd_pcm *);
482 
483 	/*
484 	 * For platform caused delay reporting.
485 	 * Optional.
486 	 */
487 	snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
488 		struct snd_soc_dai *);
489 
490 	/* platform stream ops */
491 	struct snd_pcm_ops *pcm_ops;
492 };
493 
494 /* SoC machine DAI configuration, glues a codec and cpu DAI together */
495 struct snd_soc_dai_link  {
496 	char *name;			/* Codec name */
497 	char *stream_name;		/* Stream name */
498 
499 	/* DAI */
500 	struct snd_soc_dai *codec_dai;
501 	struct snd_soc_dai *cpu_dai;
502 
503 	/* machine stream operations */
504 	struct snd_soc_ops *ops;
505 
506 	/* codec/machine specific init - e.g. add machine controls */
507 	int (*init)(struct snd_soc_codec *codec);
508 
509 	/* Keep DAI active over suspend */
510 	unsigned int ignore_suspend:1;
511 
512 	/* Symmetry requirements */
513 	unsigned int symmetric_rates:1;
514 
515 	/* Symmetry data - only valid if symmetry is being enforced */
516 	unsigned int rate;
517 
518 	/* DAI pcm */
519 	struct snd_pcm *pcm;
520 };
521 
522 /* SoC card */
523 struct snd_soc_card {
524 	char *name;
525 	struct device *dev;
526 
527 	struct list_head list;
528 
529 	int instantiated;
530 
531 	int (*probe)(struct platform_device *pdev);
532 	int (*remove)(struct platform_device *pdev);
533 
534 	/* the pre and post PM functions are used to do any PM work before and
535 	 * after the codec and DAI's do any PM work. */
536 	int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
537 	int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
538 	int (*resume_pre)(struct platform_device *pdev);
539 	int (*resume_post)(struct platform_device *pdev);
540 
541 	/* callbacks */
542 	int (*set_bias_level)(struct snd_soc_card *,
543 			      enum snd_soc_bias_level level);
544 
545 	long pmdown_time;
546 
547 	/* CPU <--> Codec DAI links  */
548 	struct snd_soc_dai_link *dai_link;
549 	int num_links;
550 
551 	struct snd_soc_device *socdev;
552 
553 	struct snd_soc_codec *codec;
554 
555 	struct snd_soc_platform *platform;
556 	struct delayed_work delayed_work;
557 	struct work_struct deferred_resume_work;
558 };
559 
560 /* SoC Device - the audio subsystem */
561 struct snd_soc_device {
562 	struct device *dev;
563 	struct snd_soc_card *card;
564 	struct snd_soc_codec_device *codec_dev;
565 	void *codec_data;
566 };
567 
568 /* runtime channel data */
569 struct snd_soc_pcm_runtime {
570 	struct snd_soc_dai_link *dai;
571 	struct snd_soc_device *socdev;
572 };
573 
574 /* mixer control */
575 struct soc_mixer_control {
576 	int min, max, platform_max;
577 	unsigned int reg, rreg, shift, rshift, invert;
578 };
579 
580 /* enumerated kcontrol */
581 struct soc_enum {
582 	unsigned short reg;
583 	unsigned short reg2;
584 	unsigned char shift_l;
585 	unsigned char shift_r;
586 	unsigned int max;
587 	unsigned int mask;
588 	const char **texts;
589 	const unsigned int *values;
590 	void *dapm;
591 };
592 
593 /* codec IO */
594 static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
595 					unsigned int reg)
596 {
597 	return codec->read(codec, reg);
598 }
599 
600 static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
601 					 unsigned int reg, unsigned int val)
602 {
603 	return codec->write(codec, reg, val);
604 }
605 
606 static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
607 					     void *data)
608 {
609 	codec->drvdata = data;
610 }
611 
612 static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
613 {
614 	return codec->drvdata;
615 }
616 
617 #include <sound/soc-dai.h>
618 
619 #endif
620