blob: 475cb7ed6beccb8cadc8fd952aaf48516e766929 [file] [log] [blame]
Richard Purdie808db4a2006-10-06 18:20:14 +02001/*
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>
Andrew Morton4484bb22006-12-15 09:30:07 +010018#include <linux/workqueue.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060019#include <linux/interrupt.h>
20#include <linux/kernel.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020021#include <sound/core.h>
22#include <sound/pcm.h>
23#include <sound/control.h>
24#include <sound/ac97_codec.h>
25
Richard Purdie808db4a2006-10-06 18:20:14 +020026/*
27 * Convenience kcontrol builders
28 */
Jon Smirl4eaa9812008-07-29 11:42:26 +010029#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
30 ((unsigned long)&(struct soc_mixer_control) \
Mark Brown762b8df2008-10-30 12:37:08 +000031 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
32 .invert = xinvert})
Jon Smirl4eaa9812008-07-29 11:42:26 +010033#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
34 ((unsigned long)&(struct soc_mixer_control) \
35 {.reg = xreg, .max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010036#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020037{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
38 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
39 .put = snd_soc_put_volsw, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010040 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
41#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
42{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
43 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
44 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
45 .tlv.p = (tlv_array), \
46 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
47 .put = snd_soc_put_volsw, \
48 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010049#define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020050{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
51 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
52 .put = snd_soc_put_volsw, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010053 .private_value = (unsigned long)&(struct soc_mixer_control) \
54 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
55 .max = xmax, .invert = xinvert} }
56#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020057{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
58 .info = snd_soc_info_volsw_2r, \
59 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010060 .private_value = (unsigned long)&(struct soc_mixer_control) \
61 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
62 .max = xmax, .invert = xinvert} }
63#define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010064{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
65 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
66 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
67 .tlv.p = (tlv_array), \
68 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
69 .put = snd_soc_put_volsw, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010070 .private_value = (unsigned long)&(struct soc_mixer_control) \
71 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
72 .max = xmax, .invert = xinvert} }
73#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010074{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
75 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
76 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
77 .tlv.p = (tlv_array), \
78 .info = snd_soc_info_volsw_2r, \
79 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010080 .private_value = (unsigned long)&(struct soc_mixer_control) \
81 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
82 .max = xmax, .invert = xinvert} }
83#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +010084{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
85 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
86 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
87 .tlv.p = (tlv_array), \
88 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
89 .put = snd_soc_put_volsw_s8, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010090 .private_value = (unsigned long)&(struct soc_mixer_control) \
91 {.reg = xreg, .min = xmin, .max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +010092#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +020093{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +010094 .max = xmax, .texts = xtexts }
95#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
96 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
97#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
98{ .max = xmax, .texts = xtexts }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +020099#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
100{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
101 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
102#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
103 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
Richard Purdie808db4a2006-10-06 18:20:14 +0200104#define SOC_ENUM(xname, xenum) \
105{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
106 .info = snd_soc_info_enum_double, \
107 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
108 .private_value = (unsigned long)&xenum }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200109#define SOC_VALUE_ENUM(xname, xenum) \
110{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200111 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200112 .get = snd_soc_get_value_enum_double, \
113 .put = snd_soc_put_value_enum_double, \
114 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100115#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200116 xhandler_get, xhandler_put) \
117{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100118 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200119 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100120 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Daniel Mack7629ad22009-04-24 16:37:44 +0200121#define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
122 xhandler_get, xhandler_put) \
123{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
124 .info = snd_soc_info_volsw, \
125 .get = xhandler_get, .put = xhandler_put, \
126 .private_value = (unsigned long)&(struct soc_mixer_control) \
127 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
128 .max = xmax, .invert = xinvert} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100129#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100130 xhandler_get, xhandler_put, tlv_array) \
131{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
132 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
133 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
134 .tlv.p = (tlv_array), \
135 .info = snd_soc_info_volsw, \
136 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100137 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900138#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
139 xhandler_get, xhandler_put, tlv_array) \
140{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
141 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
142 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
143 .tlv.p = (tlv_array), \
144 .info = snd_soc_info_volsw, \
145 .get = xhandler_get, .put = xhandler_put, \
146 .private_value = (unsigned long)&(struct soc_mixer_control) \
147 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
148 .max = xmax, .invert = xinvert} }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900149#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
150 xhandler_get, xhandler_put, tlv_array) \
151{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
152 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
153 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
154 .tlv.p = (tlv_array), \
155 .info = snd_soc_info_volsw_2r, \
156 .get = xhandler_get, .put = xhandler_put, \
157 .private_value = (unsigned long)&(struct soc_mixer_control) \
158 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
159 .max = xmax, .invert = xinvert} }
Richard Purdie808db4a2006-10-06 18:20:14 +0200160#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
161{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
162 .info = snd_soc_info_bool_ext, \
163 .get = xhandler_get, .put = xhandler_put, \
164 .private_value = xdata }
165#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
166{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
167 .info = snd_soc_info_enum_ext, \
168 .get = xhandler_get, .put = xhandler_put, \
169 .private_value = (unsigned long)&xenum }
170
171/*
Mark Brown0be98982008-05-19 12:31:28 +0200172 * Bias levels
173 *
174 * @ON: Bias is fully on for audio playback and capture operations.
175 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
176 * stream start and stop operations.
177 * @STANDBY: Low power standby state when no playback/capture operations are
178 * in progress. NOTE: The transition time between STANDBY and ON
179 * should be as fast as possible and no longer than 10ms.
180 * @OFF: Power Off. No restrictions on transition times.
181 */
182enum snd_soc_bias_level {
183 SND_SOC_BIAS_ON,
184 SND_SOC_BIAS_PREPARE,
185 SND_SOC_BIAS_STANDBY,
186 SND_SOC_BIAS_OFF,
187};
188
Mark Brown8a2cd612009-01-07 17:31:10 +0000189struct snd_jack;
190struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200191struct snd_soc_device;
192struct snd_soc_pcm_stream;
193struct snd_soc_ops;
194struct snd_soc_dai_mode;
195struct snd_soc_pcm_runtime;
Liam Girdwood3c4b266f2008-07-07 16:07:17 +0100196struct snd_soc_dai;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000197struct snd_soc_platform;
Richard Purdie808db4a2006-10-06 18:20:14 +0200198struct snd_soc_codec;
Richard Purdie808db4a2006-10-06 18:20:14 +0200199struct soc_enum;
200struct snd_soc_ac97_ops;
Mark Brown8a2cd612009-01-07 17:31:10 +0000201struct snd_soc_jack;
202struct snd_soc_jack_pin;
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600203#ifdef CONFIG_GPIOLIB
204struct snd_soc_jack_gpio;
205#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200206
207typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200208
209extern struct snd_ac97_bus_ops soc_ac97_ops;
210
Mark Brown7084a422009-07-10 22:24:27 +0100211enum snd_soc_control_type {
212 SND_SOC_CUSTOM,
213 SND_SOC_I2C,
214 SND_SOC_SPI,
215};
216
Mark Brown12a48a8c2008-12-03 19:40:30 +0000217int snd_soc_register_platform(struct snd_soc_platform *platform);
218void snd_soc_unregister_platform(struct snd_soc_platform *platform);
Mark Brown0d0cf002008-12-10 14:32:45 +0000219int snd_soc_register_codec(struct snd_soc_codec *codec);
220void snd_soc_unregister_codec(struct snd_soc_codec *codec);
Mark Brown096e49d2009-07-05 15:12:22 +0100221int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100222int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100223 int addr_bits, int data_bits,
224 enum snd_soc_control_type control);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000225
Mark Brown831dc0f2009-06-13 19:55:02 +0100226#ifdef CONFIG_PM
227int snd_soc_suspend_device(struct device *dev);
228int snd_soc_resume_device(struct device *dev);
229#endif
230
Richard Purdie808db4a2006-10-06 18:20:14 +0200231/* pcm <-> DAI connect */
232void snd_soc_free_pcms(struct snd_soc_device *socdev);
233int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
Mark Brown968a6022008-11-28 11:49:07 +0000234int snd_soc_init_card(struct snd_soc_device *socdev);
Richard Purdie808db4a2006-10-06 18:20:14 +0200235
236/* set runtime hw params */
237int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
238 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200239
Mark Brown8a2cd612009-01-07 17:31:10 +0000240/* Jack reporting */
241int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
242 struct snd_soc_jack *jack);
243void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
244int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
245 struct snd_soc_jack_pin *pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600246#ifdef CONFIG_GPIOLIB
247int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
248 struct snd_soc_jack_gpio *gpios);
249void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
250 struct snd_soc_jack_gpio *gpios);
251#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000252
Richard Purdie808db4a2006-10-06 18:20:14 +0200253/* codec register bit access */
254int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300255 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200256int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300257 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200258
259int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
260 struct snd_ac97_bus_ops *ops, int num);
261void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
262
263/*
264 *Controls
265 */
266struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
267 void *data, char *long_name);
Ian Molton3e8e1952009-01-09 00:23:21 +0000268int snd_soc_add_controls(struct snd_soc_codec *codec,
269 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200270int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
271 struct snd_ctl_elem_info *uinfo);
272int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
273 struct snd_ctl_elem_info *uinfo);
274int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
275 struct snd_ctl_elem_value *ucontrol);
276int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
277 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200278int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
279 struct snd_ctl_elem_value *ucontrol);
280int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
281 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200282int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
283 struct snd_ctl_elem_info *uinfo);
284int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
285 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200286#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200287int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
288 struct snd_ctl_elem_value *ucontrol);
289int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
290 struct snd_ctl_elem_value *ucontrol);
291int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
292 struct snd_ctl_elem_info *uinfo);
293int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
294 struct snd_ctl_elem_value *ucontrol);
295int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
296 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100297int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
298 struct snd_ctl_elem_info *uinfo);
299int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
300 struct snd_ctl_elem_value *ucontrol);
301int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
302 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200303
Mark Brown8a2cd612009-01-07 17:31:10 +0000304/**
305 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
306 *
307 * @pin: name of the pin to update
308 * @mask: bits to check for in reported jack status
309 * @invert: if non-zero then pin is enabled when status is not reported
310 */
311struct snd_soc_jack_pin {
312 struct list_head list;
313 const char *pin;
314 int mask;
315 bool invert;
316};
317
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600318/**
319 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
320 *
321 * @gpio: gpio number
322 * @name: gpio name
323 * @report: value to report when jack detected
324 * @invert: report presence in low state
325 * @debouce_time: debouce time in ms
326 */
327#ifdef CONFIG_GPIOLIB
328struct snd_soc_jack_gpio {
329 unsigned int gpio;
330 const char *name;
331 int report;
332 int invert;
333 int debounce_time;
334 struct snd_soc_jack *jack;
335 struct work_struct work;
336};
337#endif
338
Mark Brown8a2cd612009-01-07 17:31:10 +0000339struct snd_soc_jack {
340 struct snd_jack *jack;
341 struct snd_soc_card *card;
342 struct list_head pins;
343 int status;
344};
345
Richard Purdie808db4a2006-10-06 18:20:14 +0200346/* SoC PCM stream information */
347struct snd_soc_pcm_stream {
348 char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100349 u64 formats; /* SNDRV_PCM_FMTBIT_* */
350 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200351 unsigned int rate_min; /* min rate */
352 unsigned int rate_max; /* max rate */
353 unsigned int channels_min; /* min channels */
354 unsigned int channels_max; /* max channels */
355 unsigned int active:1; /* stream is in use */
356};
357
358/* SoC audio ops */
359struct snd_soc_ops {
360 int (*startup)(struct snd_pcm_substream *);
361 void (*shutdown)(struct snd_pcm_substream *);
362 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
363 int (*hw_free)(struct snd_pcm_substream *);
364 int (*prepare)(struct snd_pcm_substream *);
365 int (*trigger)(struct snd_pcm_substream *, int);
366};
367
Richard Purdie808db4a2006-10-06 18:20:14 +0200368/* SoC Audio Codec */
369struct snd_soc_codec {
370 char *name;
371 struct module *owner;
372 struct mutex mutex;
Mark Brown0d0cf002008-12-10 14:32:45 +0000373 struct device *dev;
Mark Brown452c5ea2009-05-17 21:41:23 +0100374 struct snd_soc_device *socdev;
Mark Brown0d0cf002008-12-10 14:32:45 +0000375
376 struct list_head list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200377
378 /* callbacks */
Mark Brown0be98982008-05-19 12:31:28 +0200379 int (*set_bias_level)(struct snd_soc_codec *,
380 enum snd_soc_bias_level level);
Richard Purdie808db4a2006-10-06 18:20:14 +0200381
382 /* runtime */
383 struct snd_card *card;
384 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
385 unsigned int active;
386 unsigned int pcm_devs;
387 void *private_data;
388
389 /* codec IO */
390 void *control_data; /* codec control (i2c/3wire) data */
391 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
392 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Mark Brown58cd33c2008-07-29 11:42:25 +0100393 int (*display_register)(struct snd_soc_codec *, char *,
394 size_t, unsigned int);
Mark Brown096e49d2009-07-05 15:12:22 +0100395 int (*volatile_register)(unsigned int);
Mark Brown77ee09c2009-07-31 18:26:51 +0100396 int (*readable_register)(unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200397 hw_write_t hw_write;
Mark Brownafa2f102009-07-10 23:11:24 +0100398 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200399 void *reg_cache;
400 short reg_cache_size;
401 short reg_cache_step;
402
403 /* dapm */
Troy Kisky12ef1932008-10-13 17:42:14 -0700404 u32 pop_time;
Richard Purdie808db4a2006-10-06 18:20:14 +0200405 struct list_head dapm_widgets;
406 struct list_head dapm_paths;
Mark Brown0be98982008-05-19 12:31:28 +0200407 enum snd_soc_bias_level bias_level;
408 enum snd_soc_bias_level suspend_bias_level;
Takashi Iwai1321b162006-12-21 11:02:06 +0100409 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200410
411 /* codec DAI's */
Liam Girdwood3c4b266f2008-07-07 16:07:17 +0100412 struct snd_soc_dai *dai;
Richard Purdie808db4a2006-10-06 18:20:14 +0200413 unsigned int num_dai;
Mark Brown384c89e2008-12-03 17:34:03 +0000414
415#ifdef CONFIG_DEBUG_FS
416 struct dentry *debugfs_reg;
417 struct dentry *debugfs_pop_time;
Mark Brown79fb9382009-08-21 16:38:13 +0100418 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000419#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200420};
421
422/* codec device */
423struct snd_soc_codec_device {
424 int (*probe)(struct platform_device *pdev);
425 int (*remove)(struct platform_device *pdev);
426 int (*suspend)(struct platform_device *pdev, pm_message_t state);
427 int (*resume)(struct platform_device *pdev);
428};
429
430/* SoC platform interface */
431struct snd_soc_platform {
432 char *name;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000433 struct list_head list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200434
435 int (*probe)(struct platform_device *pdev);
436 int (*remove)(struct platform_device *pdev);
Mark Brown07c84d02008-12-03 18:17:28 +0000437 int (*suspend)(struct snd_soc_dai *dai);
438 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200439
440 /* pcm creation and destruction */
Liam Girdwood3c4b266f2008-07-07 16:07:17 +0100441 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
Richard Purdie808db4a2006-10-06 18:20:14 +0200442 struct snd_pcm *);
443 void (*pcm_free)(struct snd_pcm *);
444
445 /* platform stream ops */
446 struct snd_pcm_ops *pcm_ops;
447};
448
449/* SoC machine DAI configuration, glues a codec and cpu DAI together */
450struct snd_soc_dai_link {
451 char *name; /* Codec name */
452 char *stream_name; /* Stream name */
453
454 /* DAI */
Liam Girdwood3c4b266f2008-07-07 16:07:17 +0100455 struct snd_soc_dai *codec_dai;
456 struct snd_soc_dai *cpu_dai;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100457
458 /* machine stream operations */
459 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200460
461 /* codec/machine specific init - e.g. add machine controls */
462 int (*init)(struct snd_soc_codec *codec);
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100463
Mark Brown06f409d2009-04-07 18:10:13 +0100464 /* Symmetry requirements */
465 unsigned int symmetric_rates:1;
466
467 /* Symmetry data - only valid if symmetry is being enforced */
468 unsigned int rate;
469
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100470 /* DAI pcm */
471 struct snd_pcm *pcm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200472};
473
Mark Brown87506542008-11-18 20:50:34 +0000474/* SoC card */
475struct snd_soc_card {
Richard Purdie808db4a2006-10-06 18:20:14 +0200476 char *name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000477 struct device *dev;
478
479 struct list_head list;
480
481 int instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200482
483 int (*probe)(struct platform_device *pdev);
484 int (*remove)(struct platform_device *pdev);
485
486 /* the pre and post PM functions are used to do any PM work before and
487 * after the codec and DAI's do any PM work. */
488 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
489 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
490 int (*resume_pre)(struct platform_device *pdev);
491 int (*resume_post)(struct platform_device *pdev);
492
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100493 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000494 int (*set_bias_level)(struct snd_soc_card *,
Mark Brown0be98982008-05-19 12:31:28 +0200495 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100496
Richard Purdie808db4a2006-10-06 18:20:14 +0200497 /* CPU <--> Codec DAI links */
498 struct snd_soc_dai_link *dai_link;
499 int num_links;
Mark Brown63084192008-12-02 15:08:03 +0000500
501 struct snd_soc_device *socdev;
502
Mark Brown6627a652009-01-23 22:55:23 +0000503 struct snd_soc_codec *codec;
504
Mark Brown87689d52008-12-02 16:01:14 +0000505 struct snd_soc_platform *platform;
Mark Brown63084192008-12-02 15:08:03 +0000506 struct delayed_work delayed_work;
507 struct work_struct deferred_resume_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200508};
509
510/* SoC Device - the audio subsystem */
511struct snd_soc_device {
512 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +0000513 struct snd_soc_card *card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200514 struct snd_soc_codec_device *codec_dev;
Richard Purdie808db4a2006-10-06 18:20:14 +0200515 void *codec_data;
516};
517
518/* runtime channel data */
519struct snd_soc_pcm_runtime {
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100520 struct snd_soc_dai_link *dai;
Richard Purdie808db4a2006-10-06 18:20:14 +0200521 struct snd_soc_device *socdev;
522};
523
Jon Smirl4eaa9812008-07-29 11:42:26 +0100524/* mixer control */
525struct soc_mixer_control {
526 int min, max;
Jon Smirl815ecf8d2008-07-29 10:22:24 -0400527 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100528};
529
Richard Purdie808db4a2006-10-06 18:20:14 +0200530/* enumerated kcontrol */
531struct soc_enum {
532 unsigned short reg;
533 unsigned short reg2;
534 unsigned char shift_l;
535 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100536 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200537 unsigned int mask;
538 const char **texts;
539 const unsigned int *values;
540 void *dapm;
541};
542
Mark Brown5c82f562009-05-22 09:41:30 +0100543/* codec IO */
544static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
545 unsigned int reg)
546{
547 return codec->read(codec, reg);
548}
549
550static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
551 unsigned int reg, unsigned int val)
552{
553 return codec->write(codec, reg, val);
554}
555
Mark Browna47cbe72008-07-23 14:03:07 +0100556#include <sound/soc-dai.h>
557
Richard Purdie808db4a2006-10-06 18:20:14 +0200558#endif