blob: b8bac6ae62441129d62635f2ed10a3c005f5c70e [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/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100172 * Simplified versions of above macros, declaring a struct and calculating
173 * ARRAY_SIZE internally
174 */
175#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
176 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
177 ARRAY_SIZE(xtexts), xtexts)
178#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
179 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
180#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
181 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
182#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
183 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
184 ARRAY_SIZE(xtexts), xtexts, xvalues)
185#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
186 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
187
188/*
Mark Brown0be98982008-05-19 12:31:28 +0200189 * Bias levels
190 *
191 * @ON: Bias is fully on for audio playback and capture operations.
192 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
193 * stream start and stop operations.
194 * @STANDBY: Low power standby state when no playback/capture operations are
195 * in progress. NOTE: The transition time between STANDBY and ON
196 * should be as fast as possible and no longer than 10ms.
197 * @OFF: Power Off. No restrictions on transition times.
198 */
199enum snd_soc_bias_level {
200 SND_SOC_BIAS_ON,
201 SND_SOC_BIAS_PREPARE,
202 SND_SOC_BIAS_STANDBY,
203 SND_SOC_BIAS_OFF,
204};
205
Mark Brown8a2cd612009-01-07 17:31:10 +0000206struct snd_jack;
207struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200208struct snd_soc_device;
209struct snd_soc_pcm_stream;
210struct snd_soc_ops;
211struct snd_soc_dai_mode;
212struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100213struct snd_soc_dai;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000214struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900215struct snd_soc_dai_link;
Richard Purdie808db4a2006-10-06 18:20:14 +0200216struct snd_soc_codec;
Richard Purdie808db4a2006-10-06 18:20:14 +0200217struct soc_enum;
218struct snd_soc_ac97_ops;
Mark Brown8a2cd612009-01-07 17:31:10 +0000219struct snd_soc_jack;
220struct snd_soc_jack_pin;
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600221#ifdef CONFIG_GPIOLIB
222struct snd_soc_jack_gpio;
223#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200224
225typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200226
227extern struct snd_ac97_bus_ops soc_ac97_ops;
228
Mark Brown7084a422009-07-10 22:24:27 +0100229enum snd_soc_control_type {
230 SND_SOC_CUSTOM,
231 SND_SOC_I2C,
232 SND_SOC_SPI,
233};
234
Mark Brown12a48a8c2008-12-03 19:40:30 +0000235int snd_soc_register_platform(struct snd_soc_platform *platform);
236void snd_soc_unregister_platform(struct snd_soc_platform *platform);
Mark Brown0d0cf002008-12-10 14:32:45 +0000237int snd_soc_register_codec(struct snd_soc_codec *codec);
238void snd_soc_unregister_codec(struct snd_soc_codec *codec);
Mark Brown096e49d2009-07-05 15:12:22 +0100239int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100240int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100241 int addr_bits, int data_bits,
242 enum snd_soc_control_type control);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000243
Richard Purdie808db4a2006-10-06 18:20:14 +0200244/* pcm <-> DAI connect */
245void snd_soc_free_pcms(struct snd_soc_device *socdev);
246int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid);
Richard Purdie808db4a2006-10-06 18:20:14 +0200247
Mark Brown7aae8162009-11-10 16:08:04 +0000248/* Utility functions to get clock rates from various things */
249int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
250int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000251int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000252int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
253
Richard Purdie808db4a2006-10-06 18:20:14 +0200254/* set runtime hw params */
255int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
256 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200257
Mark Brown8a2cd612009-01-07 17:31:10 +0000258/* Jack reporting */
259int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
260 struct snd_soc_jack *jack);
261void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
262int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
263 struct snd_soc_jack_pin *pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600264#ifdef CONFIG_GPIOLIB
265int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
266 struct snd_soc_jack_gpio *gpios);
267void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
268 struct snd_soc_jack_gpio *gpios);
269#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000270
Richard Purdie808db4a2006-10-06 18:20:14 +0200271/* codec register bit access */
272int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300273 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000274int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
275 unsigned short reg, unsigned int mask,
276 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200277int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300278 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200279
280int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
281 struct snd_ac97_bus_ops *ops, int num);
282void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
283
284/*
285 *Controls
286 */
287struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
288 void *data, char *long_name);
Ian Molton3e8e1952009-01-09 00:23:21 +0000289int snd_soc_add_controls(struct snd_soc_codec *codec,
290 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200291int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
292 struct snd_ctl_elem_info *uinfo);
293int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
294 struct snd_ctl_elem_info *uinfo);
295int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
296 struct snd_ctl_elem_value *ucontrol);
297int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
298 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200299int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
300 struct snd_ctl_elem_value *ucontrol);
301int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
302 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200303int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
304 struct snd_ctl_elem_info *uinfo);
305int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
306 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200307#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200308int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
309 struct snd_ctl_elem_value *ucontrol);
310int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
311 struct snd_ctl_elem_value *ucontrol);
312int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
313 struct snd_ctl_elem_info *uinfo);
314int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
315 struct snd_ctl_elem_value *ucontrol);
316int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
317 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100318int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
319 struct snd_ctl_elem_info *uinfo);
320int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
321 struct snd_ctl_elem_value *ucontrol);
322int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
323 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200324
Mark Brown8a2cd612009-01-07 17:31:10 +0000325/**
326 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
327 *
328 * @pin: name of the pin to update
329 * @mask: bits to check for in reported jack status
330 * @invert: if non-zero then pin is enabled when status is not reported
331 */
332struct snd_soc_jack_pin {
333 struct list_head list;
334 const char *pin;
335 int mask;
336 bool invert;
337};
338
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600339/**
340 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
341 *
342 * @gpio: gpio number
343 * @name: gpio name
344 * @report: value to report when jack detected
345 * @invert: report presence in low state
346 * @debouce_time: debouce time in ms
347 */
348#ifdef CONFIG_GPIOLIB
349struct snd_soc_jack_gpio {
350 unsigned int gpio;
351 const char *name;
352 int report;
353 int invert;
354 int debounce_time;
355 struct snd_soc_jack *jack;
356 struct work_struct work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900357
358 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600359};
360#endif
361
Mark Brown8a2cd612009-01-07 17:31:10 +0000362struct snd_soc_jack {
363 struct snd_jack *jack;
364 struct snd_soc_card *card;
365 struct list_head pins;
366 int status;
367};
368
Richard Purdie808db4a2006-10-06 18:20:14 +0200369/* SoC PCM stream information */
370struct snd_soc_pcm_stream {
371 char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100372 u64 formats; /* SNDRV_PCM_FMTBIT_* */
373 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200374 unsigned int rate_min; /* min rate */
375 unsigned int rate_max; /* max rate */
376 unsigned int channels_min; /* min channels */
377 unsigned int channels_max; /* max channels */
Jassi Brar14dc5732010-02-26 09:12:32 +0900378 unsigned int active; /* num of active users of the stream */
Daniel Mackfd23b7d2010-03-19 14:52:55 +0000379 void *dma_data; /* used by platform code */
Richard Purdie808db4a2006-10-06 18:20:14 +0200380};
381
382/* SoC audio ops */
383struct snd_soc_ops {
384 int (*startup)(struct snd_pcm_substream *);
385 void (*shutdown)(struct snd_pcm_substream *);
386 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
387 int (*hw_free)(struct snd_pcm_substream *);
388 int (*prepare)(struct snd_pcm_substream *);
389 int (*trigger)(struct snd_pcm_substream *, int);
390};
391
Richard Purdie808db4a2006-10-06 18:20:14 +0200392/* SoC Audio Codec */
393struct snd_soc_codec {
394 char *name;
395 struct module *owner;
396 struct mutex mutex;
Mark Brown0d0cf002008-12-10 14:32:45 +0000397 struct device *dev;
Mark Brown452c5ea2009-05-17 21:41:23 +0100398 struct snd_soc_device *socdev;
Mark Brown0d0cf002008-12-10 14:32:45 +0000399
400 struct list_head list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200401
402 /* callbacks */
Mark Brown0be98982008-05-19 12:31:28 +0200403 int (*set_bias_level)(struct snd_soc_codec *,
404 enum snd_soc_bias_level level);
Richard Purdie808db4a2006-10-06 18:20:14 +0200405
406 /* runtime */
407 struct snd_card *card;
408 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
409 unsigned int active;
410 unsigned int pcm_devs;
411 void *private_data;
412
413 /* codec IO */
414 void *control_data; /* codec control (i2c/3wire) data */
415 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
416 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Mark Brown58cd33c2008-07-29 11:42:25 +0100417 int (*display_register)(struct snd_soc_codec *, char *,
418 size_t, unsigned int);
Mark Brown096e49d2009-07-05 15:12:22 +0100419 int (*volatile_register)(unsigned int);
Mark Brown77ee09c2009-07-31 18:26:51 +0100420 int (*readable_register)(unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200421 hw_write_t hw_write;
Mark Brownafa2f102009-07-10 23:11:24 +0100422 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200423 void *reg_cache;
424 short reg_cache_size;
425 short reg_cache_step;
426
Mark Browna96ca332010-01-19 22:49:43 +0000427 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
Mark Brown8c961bc2010-02-01 18:46:10 +0000428 unsigned int cache_only:1; /* Suppress writes to hardware */
Mark Browna3032b42010-02-01 18:48:03 +0000429 unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
Mark Browna96ca332010-01-19 22:49:43 +0000430
Richard Purdie808db4a2006-10-06 18:20:14 +0200431 /* dapm */
Troy Kisky12ef1932008-10-13 17:42:14 -0700432 u32 pop_time;
Richard Purdie808db4a2006-10-06 18:20:14 +0200433 struct list_head dapm_widgets;
434 struct list_head dapm_paths;
Mark Brown0be98982008-05-19 12:31:28 +0200435 enum snd_soc_bias_level bias_level;
436 enum snd_soc_bias_level suspend_bias_level;
Takashi Iwai1321b162006-12-21 11:02:06 +0100437 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200438
439 /* codec DAI's */
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100440 struct snd_soc_dai *dai;
Richard Purdie808db4a2006-10-06 18:20:14 +0200441 unsigned int num_dai;
Mark Brown384c89e2008-12-03 17:34:03 +0000442
443#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300444 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000445 struct dentry *debugfs_reg;
446 struct dentry *debugfs_pop_time;
Mark Brown79fb9382009-08-21 16:38:13 +0100447 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000448#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200449};
450
451/* codec device */
452struct snd_soc_codec_device {
453 int (*probe)(struct platform_device *pdev);
454 int (*remove)(struct platform_device *pdev);
455 int (*suspend)(struct platform_device *pdev, pm_message_t state);
456 int (*resume)(struct platform_device *pdev);
457};
458
459/* SoC platform interface */
460struct snd_soc_platform {
461 char *name;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000462 struct list_head list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200463
464 int (*probe)(struct platform_device *pdev);
465 int (*remove)(struct platform_device *pdev);
jassi brard273ebe2010-02-22 15:58:04 +0900466 int (*suspend)(struct snd_soc_dai_link *dai_link);
467 int (*resume)(struct snd_soc_dai_link *dai_link);
Richard Purdie808db4a2006-10-06 18:20:14 +0200468
469 /* pcm creation and destruction */
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100470 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
Richard Purdie808db4a2006-10-06 18:20:14 +0200471 struct snd_pcm *);
472 void (*pcm_free)(struct snd_pcm *);
473
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200474 /*
475 * For platform caused delay reporting.
476 * Optional.
477 */
478 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
479 struct snd_soc_dai *);
480
Richard Purdie808db4a2006-10-06 18:20:14 +0200481 /* platform stream ops */
482 struct snd_pcm_ops *pcm_ops;
483};
484
485/* SoC machine DAI configuration, glues a codec and cpu DAI together */
486struct snd_soc_dai_link {
487 char *name; /* Codec name */
488 char *stream_name; /* Stream name */
489
490 /* DAI */
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100491 struct snd_soc_dai *codec_dai;
492 struct snd_soc_dai *cpu_dai;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100493
494 /* machine stream operations */
495 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200496
497 /* codec/machine specific init - e.g. add machine controls */
498 int (*init)(struct snd_soc_codec *codec);
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100499
Mark Brown06f409d2009-04-07 18:10:13 +0100500 /* Symmetry requirements */
501 unsigned int symmetric_rates:1;
502
503 /* Symmetry data - only valid if symmetry is being enforced */
504 unsigned int rate;
505
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100506 /* DAI pcm */
507 struct snd_pcm *pcm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200508};
509
Mark Brown87506542008-11-18 20:50:34 +0000510/* SoC card */
511struct snd_soc_card {
Richard Purdie808db4a2006-10-06 18:20:14 +0200512 char *name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000513 struct device *dev;
514
515 struct list_head list;
516
517 int instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200518
519 int (*probe)(struct platform_device *pdev);
520 int (*remove)(struct platform_device *pdev);
521
522 /* the pre and post PM functions are used to do any PM work before and
523 * after the codec and DAI's do any PM work. */
524 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
525 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
526 int (*resume_pre)(struct platform_device *pdev);
527 int (*resume_post)(struct platform_device *pdev);
528
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100529 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000530 int (*set_bias_level)(struct snd_soc_card *,
Mark Brown0be98982008-05-19 12:31:28 +0200531 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100532
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000533 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000534
Richard Purdie808db4a2006-10-06 18:20:14 +0200535 /* CPU <--> Codec DAI links */
536 struct snd_soc_dai_link *dai_link;
537 int num_links;
Mark Brown63084192008-12-02 15:08:03 +0000538
539 struct snd_soc_device *socdev;
540
Mark Brown6627a652009-01-23 22:55:23 +0000541 struct snd_soc_codec *codec;
542
Mark Brown87689d52008-12-02 16:01:14 +0000543 struct snd_soc_platform *platform;
Mark Brown63084192008-12-02 15:08:03 +0000544 struct delayed_work delayed_work;
545 struct work_struct deferred_resume_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200546};
547
548/* SoC Device - the audio subsystem */
549struct snd_soc_device {
550 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +0000551 struct snd_soc_card *card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200552 struct snd_soc_codec_device *codec_dev;
Richard Purdie808db4a2006-10-06 18:20:14 +0200553 void *codec_data;
554};
555
556/* runtime channel data */
557struct snd_soc_pcm_runtime {
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100558 struct snd_soc_dai_link *dai;
Richard Purdie808db4a2006-10-06 18:20:14 +0200559 struct snd_soc_device *socdev;
560};
561
Jon Smirl4eaa9812008-07-29 11:42:26 +0100562/* mixer control */
563struct soc_mixer_control {
564 int min, max;
Jon Smirl815ecf8d2008-07-29 10:22:24 -0400565 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100566};
567
Richard Purdie808db4a2006-10-06 18:20:14 +0200568/* enumerated kcontrol */
569struct soc_enum {
570 unsigned short reg;
571 unsigned short reg2;
572 unsigned char shift_l;
573 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100574 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200575 unsigned int mask;
576 const char **texts;
577 const unsigned int *values;
578 void *dapm;
579};
580
Mark Brown5c82f562009-05-22 09:41:30 +0100581/* codec IO */
582static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
583 unsigned int reg)
584{
585 return codec->read(codec, reg);
586}
587
588static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
589 unsigned int reg, unsigned int val)
590{
591 return codec->write(codec, reg, val);
592}
593
Mark Browna47cbe72008-07-23 14:03:07 +0100594#include <sound/soc-dai.h>
595
Richard Purdie808db4a2006-10-06 18:20:14 +0200596#endif