blob: 5c3bce83f28ad1be248a35c89d190dcb1504c36e [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>
Mark Brownd5021ec2010-03-22 12:06:30 +000018#include <linux/notifier.h>
Andrew Morton4484bb22006-12-15 09:30:07 +010019#include <linux/workqueue.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060020#include <linux/interrupt.h>
21#include <linux/kernel.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020022#include <sound/core.h>
23#include <sound/pcm.h>
24#include <sound/control.h>
25#include <sound/ac97_codec.h>
26
Richard Purdie808db4a2006-10-06 18:20:14 +020027/*
28 * Convenience kcontrol builders
29 */
Jon Smirl4eaa9812008-07-29 11:42:26 +010030#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
31 ((unsigned long)&(struct soc_mixer_control) \
Mark Brown762b8df2008-10-30 12:37:08 +000032 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030033 .platform_max = xmax, .invert = xinvert})
Jon Smirl4eaa9812008-07-29 11:42:26 +010034#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
35 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030036 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010037#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020038{ .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, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010041 .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) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010050#define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020051{ .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, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010054 .private_value = (unsigned long)&(struct soc_mixer_control) \
55 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030056 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010057#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020058{ .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, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010061 .private_value = (unsigned long)&(struct soc_mixer_control) \
62 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030063 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010064#define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010065{ .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, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010071 .private_value = (unsigned long)&(struct soc_mixer_control) \
72 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030073 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010074#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010075{ .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, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010081 .private_value = (unsigned long)&(struct soc_mixer_control) \
82 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030083 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010084#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +010085{ .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, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010091 .private_value = (unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030092 {.reg = xreg, .min = xmin, .max = xmax, \
93 .platform_max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +010094#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +020095{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +010096 .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 }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200101#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)
Richard Purdie808db4a2006-10-06 18:20:14 +0200106#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 }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200111#define SOC_VALUE_ENUM(xname, xenum) \
112{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200113 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200114 .get = snd_soc_get_value_enum_double, \
115 .put = snd_soc_put_value_enum_double, \
116 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100117#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200118 xhandler_get, xhandler_put) \
119{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100120 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200121 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100122 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Daniel Mack7629ad22009-04-24 16:37:44 +0200123#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, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300130 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100131#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100132 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, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100139 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900140#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, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300150 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900151#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, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300161 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Richard Purdie808db4a2006-10-06 18:20:14 +0200162#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
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200173#define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
174 xmin, xmax, tlv_array) \
175{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
176 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
177 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
178 .tlv.p = (tlv_array), \
179 .info = snd_soc_info_volsw_2r_sx, \
180 .get = snd_soc_get_volsw_2r_sx, \
181 .put = snd_soc_put_volsw_2r_sx, \
182 .private_value = (unsigned long)&(struct soc_mixer_control) \
183 {.reg = xreg_left, \
184 .rreg = xreg_right, .shift = xshift, \
185 .min = xmin, .max = xmax} }
186
187
Richard Purdie808db4a2006-10-06 18:20:14 +0200188/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100189 * Simplified versions of above macros, declaring a struct and calculating
190 * ARRAY_SIZE internally
191 */
192#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
193 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
194 ARRAY_SIZE(xtexts), xtexts)
195#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
196 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
197#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
198 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
199#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
200 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
201 ARRAY_SIZE(xtexts), xtexts, xvalues)
202#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
203 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
204
205/*
Mark Brown0be98982008-05-19 12:31:28 +0200206 * Bias levels
207 *
208 * @ON: Bias is fully on for audio playback and capture operations.
209 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
210 * stream start and stop operations.
211 * @STANDBY: Low power standby state when no playback/capture operations are
212 * in progress. NOTE: The transition time between STANDBY and ON
213 * should be as fast as possible and no longer than 10ms.
214 * @OFF: Power Off. No restrictions on transition times.
215 */
216enum snd_soc_bias_level {
Mark Brown0be98982008-05-19 12:31:28 +0200217 SND_SOC_BIAS_OFF,
Jarkko Nikula4e485412010-08-31 14:52:35 +0300218 SND_SOC_BIAS_STANDBY,
219 SND_SOC_BIAS_PREPARE,
220 SND_SOC_BIAS_ON,
Mark Brown0be98982008-05-19 12:31:28 +0200221};
222
Mark Brown8a2cd612009-01-07 17:31:10 +0000223struct snd_jack;
224struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200225struct snd_soc_device;
226struct snd_soc_pcm_stream;
227struct snd_soc_ops;
228struct snd_soc_dai_mode;
229struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100230struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000231struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000232struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900233struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000234struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200235struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000236struct snd_soc_codec_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200237struct soc_enum;
238struct snd_soc_ac97_ops;
Mark Brown8a2cd612009-01-07 17:31:10 +0000239struct snd_soc_jack;
240struct snd_soc_jack_pin;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000241
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600242#ifdef CONFIG_GPIOLIB
243struct snd_soc_jack_gpio;
244#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200245
246typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200247
248extern struct snd_ac97_bus_ops soc_ac97_ops;
249
Mark Brown7084a422009-07-10 22:24:27 +0100250enum snd_soc_control_type {
251 SND_SOC_CUSTOM,
252 SND_SOC_I2C,
253 SND_SOC_SPI,
254};
255
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000256int snd_soc_register_platform(struct device *dev,
257 struct snd_soc_platform_driver *platform_drv);
258void snd_soc_unregister_platform(struct device *dev);
259int snd_soc_register_codec(struct device *dev,
260 struct snd_soc_codec_driver *codec_drv,
261 struct snd_soc_dai_driver *dai_drv, int num_dai);
262void snd_soc_unregister_codec(struct device *dev);
Mark Brown096e49d2009-07-05 15:12:22 +0100263int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100264int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100265 int addr_bits, int data_bits,
266 enum snd_soc_control_type control);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000267
Mark Brown7aae8162009-11-10 16:08:04 +0000268/* Utility functions to get clock rates from various things */
269int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
270int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000271int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000272int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
273
Richard Purdie808db4a2006-10-06 18:20:14 +0200274/* set runtime hw params */
275int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
276 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200277
Mark Brown8a2cd612009-01-07 17:31:10 +0000278/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000279int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000280 struct snd_soc_jack *jack);
281void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
282int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
283 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000284void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
285 struct notifier_block *nb);
286void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
287 struct notifier_block *nb);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600288#ifdef CONFIG_GPIOLIB
289int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
290 struct snd_soc_jack_gpio *gpios);
291void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
292 struct snd_soc_jack_gpio *gpios);
293#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000294
Richard Purdie808db4a2006-10-06 18:20:14 +0200295/* codec register bit access */
296int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300297 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000298int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
299 unsigned short reg, unsigned int mask,
300 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200301int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300302 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200303
304int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
305 struct snd_ac97_bus_ops *ops, int num);
306void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
307
308/*
309 *Controls
310 */
311struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
312 void *data, char *long_name);
Ian Molton3e8e1952009-01-09 00:23:21 +0000313int snd_soc_add_controls(struct snd_soc_codec *codec,
314 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200315int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
316 struct snd_ctl_elem_info *uinfo);
317int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
318 struct snd_ctl_elem_info *uinfo);
319int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
320 struct snd_ctl_elem_value *ucontrol);
321int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
322 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200323int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
324 struct snd_ctl_elem_value *ucontrol);
325int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
326 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200327int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
328 struct snd_ctl_elem_info *uinfo);
329int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
330 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200331#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200332int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
333 struct snd_ctl_elem_value *ucontrol);
334int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
335 struct snd_ctl_elem_value *ucontrol);
336int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
337 struct snd_ctl_elem_info *uinfo);
338int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
339 struct snd_ctl_elem_value *ucontrol);
340int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
341 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100342int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
343 struct snd_ctl_elem_info *uinfo);
344int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
345 struct snd_ctl_elem_value *ucontrol);
346int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
347 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300348int snd_soc_limit_volume(struct snd_soc_codec *codec,
349 const char *name, int max);
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200350int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
351 struct snd_ctl_elem_info *uinfo);
352int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
353 struct snd_ctl_elem_value *ucontrol);
354int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
355 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200356
Mark Brown8a2cd612009-01-07 17:31:10 +0000357/**
358 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
359 *
360 * @pin: name of the pin to update
361 * @mask: bits to check for in reported jack status
362 * @invert: if non-zero then pin is enabled when status is not reported
363 */
364struct snd_soc_jack_pin {
365 struct list_head list;
366 const char *pin;
367 int mask;
368 bool invert;
369};
370
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600371/**
372 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
373 *
374 * @gpio: gpio number
375 * @name: gpio name
376 * @report: value to report when jack detected
377 * @invert: report presence in low state
378 * @debouce_time: debouce time in ms
379 */
380#ifdef CONFIG_GPIOLIB
381struct snd_soc_jack_gpio {
382 unsigned int gpio;
383 const char *name;
384 int report;
385 int invert;
386 int debounce_time;
387 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700388 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900389
390 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600391};
392#endif
393
Mark Brown8a2cd612009-01-07 17:31:10 +0000394struct snd_soc_jack {
395 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000396 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000397 struct list_head pins;
398 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000399 struct blocking_notifier_head notifier;
Mark Brown8a2cd612009-01-07 17:31:10 +0000400};
401
Richard Purdie808db4a2006-10-06 18:20:14 +0200402/* SoC PCM stream information */
403struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000404 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100405 u64 formats; /* SNDRV_PCM_FMTBIT_* */
406 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200407 unsigned int rate_min; /* min rate */
408 unsigned int rate_max; /* max rate */
409 unsigned int channels_min; /* min channels */
410 unsigned int channels_max; /* max channels */
Richard Purdie808db4a2006-10-06 18:20:14 +0200411};
412
413/* SoC audio ops */
414struct snd_soc_ops {
415 int (*startup)(struct snd_pcm_substream *);
416 void (*shutdown)(struct snd_pcm_substream *);
417 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
418 int (*hw_free)(struct snd_pcm_substream *);
419 int (*prepare)(struct snd_pcm_substream *);
420 int (*trigger)(struct snd_pcm_substream *, int);
421};
422
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000423/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200424struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000425 const char *name;
426 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000427 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000428 struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000429
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000430 struct mutex mutex;
431 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000432 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000433 struct list_head card_list;
434 int num_dai;
Richard Purdie808db4a2006-10-06 18:20:14 +0200435
436 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200437 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
438 unsigned int active;
Mark Browna96ca332010-01-19 22:49:43 +0000439 unsigned int idle_bias_off:1; /* Use BIAS_OFF instead of STANDBY */
Mark Brown8c961bc2010-02-01 18:46:10 +0000440 unsigned int cache_only:1; /* Suppress writes to hardware */
Mark Browna3032b42010-02-01 18:48:03 +0000441 unsigned int cache_sync:1; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000442 unsigned int suspended:1; /* Codec is in suspend PM state */
443 unsigned int probed:1; /* Codec has been probed */
444 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300445 unsigned int ac97_created:1; /* Codec has been created by SoC */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000446 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
447
448 /* codec IO */
449 void *control_data; /* codec control (i2c/3wire) data */
450 hw_write_t hw_write;
451 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
452 void *reg_cache;
Mark Browna96ca332010-01-19 22:49:43 +0000453
Richard Purdie808db4a2006-10-06 18:20:14 +0200454 /* dapm */
Troy Kisky12ef1932008-10-13 17:42:14 -0700455 u32 pop_time;
Richard Purdie808db4a2006-10-06 18:20:14 +0200456 struct list_head dapm_widgets;
457 struct list_head dapm_paths;
Mark Brown0be98982008-05-19 12:31:28 +0200458 enum snd_soc_bias_level bias_level;
459 enum snd_soc_bias_level suspend_bias_level;
Takashi Iwai1321b162006-12-21 11:02:06 +0100460 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200461
Mark Brown384c89e2008-12-03 17:34:03 +0000462#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300463 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000464 struct dentry *debugfs_reg;
465 struct dentry *debugfs_pop_time;
Mark Brown79fb9382009-08-21 16:38:13 +0100466 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000467#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200468};
469
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000470/* codec driver */
471struct snd_soc_codec_driver {
472
473 /* driver ops */
474 int (*probe)(struct snd_soc_codec *);
475 int (*remove)(struct snd_soc_codec *);
476 int (*suspend)(struct snd_soc_codec *,
477 pm_message_t state);
478 int (*resume)(struct snd_soc_codec *);
479
480 /* codec IO */
481 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
482 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
483 int (*display_register)(struct snd_soc_codec *, char *,
484 size_t, unsigned int);
485 int (*volatile_register)(unsigned int);
486 int (*readable_register)(unsigned int);
487 short reg_cache_size;
488 short reg_cache_step;
489 short reg_word_size;
490 const void *reg_cache_default;
491
492 /* codec bias level */
493 int (*set_bias_level)(struct snd_soc_codec *,
494 enum snd_soc_bias_level level);
Richard Purdie808db4a2006-10-06 18:20:14 +0200495};
496
497/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000498struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200499
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000500 int (*probe)(struct snd_soc_platform *);
501 int (*remove)(struct snd_soc_platform *);
502 int (*suspend)(struct snd_soc_dai *dai);
503 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200504
505 /* pcm creation and destruction */
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100506 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
Richard Purdie808db4a2006-10-06 18:20:14 +0200507 struct snd_pcm *);
508 void (*pcm_free)(struct snd_pcm *);
509
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200510 /*
511 * For platform caused delay reporting.
512 * Optional.
513 */
514 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
515 struct snd_soc_dai *);
516
Richard Purdie808db4a2006-10-06 18:20:14 +0200517 /* platform stream ops */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000518 struct snd_pcm_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200519};
520
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000521struct snd_soc_platform {
522 const char *name;
523 int id;
524 struct device *dev;
525 struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200526
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000527 unsigned int suspended:1; /* platform is suspended */
528 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100529
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000530 struct snd_soc_card *card;
531 struct list_head list;
532 struct list_head card_list;
533};
Richard Purdie808db4a2006-10-06 18:20:14 +0200534
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000535struct snd_soc_dai_link {
536 /* config - must be set by machine driver */
537 const char *name; /* Codec name */
538 const char *stream_name; /* Stream name */
539 const char *codec_name; /* for multi-codec */
540 const char *platform_name; /* for multi-platform */
541 const char *cpu_dai_name;
542 const char *codec_dai_name;
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100543
Mark Brown3efab7d2010-05-09 13:25:43 +0100544 /* Keep DAI active over suspend */
545 unsigned int ignore_suspend:1;
546
Mark Brown06f409d2009-04-07 18:10:13 +0100547 /* Symmetry requirements */
548 unsigned int symmetric_rates:1;
549
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000550 /* codec/machine specific init - e.g. add machine controls */
551 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100552
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000553 /* machine stream operations */
554 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200555};
556
Mark Brown87506542008-11-18 20:50:34 +0000557/* SoC card */
558struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000559 const char *name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000560 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000561 struct snd_card *snd_card;
562 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000563
564 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000565 struct mutex mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000566
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000567 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200568
569 int (*probe)(struct platform_device *pdev);
570 int (*remove)(struct platform_device *pdev);
571
572 /* the pre and post PM functions are used to do any PM work before and
573 * after the codec and DAI's do any PM work. */
574 int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
575 int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
576 int (*resume_pre)(struct platform_device *pdev);
577 int (*resume_post)(struct platform_device *pdev);
578
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100579 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000580 int (*set_bias_level)(struct snd_soc_card *,
Mark Brown0be98982008-05-19 12:31:28 +0200581 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100582
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000583 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000584
Richard Purdie808db4a2006-10-06 18:20:14 +0200585 /* CPU <--> Codec DAI links */
586 struct snd_soc_dai_link *dai_link;
587 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000588 struct snd_soc_pcm_runtime *rtd;
589 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000590
Mark Brown63084192008-12-02 15:08:03 +0000591 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000592
593 /* lists of probed devices belonging to this card */
594 struct list_head codec_dev_list;
595 struct list_head platform_dev_list;
596 struct list_head dai_dev_list;
Richard Purdie808db4a2006-10-06 18:20:14 +0200597};
598
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000599/* SoC machine DAI configuration, glues a codec and cpu DAI together */
600struct snd_soc_pcm_runtime {
601 struct device dev;
Mark Brown87506542008-11-18 20:50:34 +0000602 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000603 struct snd_soc_dai_link *dai_link;
Richard Purdie808db4a2006-10-06 18:20:14 +0200604
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000605 unsigned int complete:1;
606 unsigned int dev_registered:1;
607
608 /* Symmetry data - only valid if symmetry is being enforced */
609 unsigned int rate;
610 long pmdown_time;
611
612 /* runtime devices */
613 struct snd_pcm *pcm;
614 struct snd_soc_codec *codec;
615 struct snd_soc_platform *platform;
616 struct snd_soc_dai *codec_dai;
617 struct snd_soc_dai *cpu_dai;
618
619 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200620};
621
Jon Smirl4eaa9812008-07-29 11:42:26 +0100622/* mixer control */
623struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300624 int min, max, platform_max;
Jon Smirl815ecf8d2008-07-29 10:22:24 -0400625 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100626};
627
Richard Purdie808db4a2006-10-06 18:20:14 +0200628/* enumerated kcontrol */
629struct soc_enum {
630 unsigned short reg;
631 unsigned short reg2;
632 unsigned char shift_l;
633 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100634 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200635 unsigned int mask;
636 const char **texts;
637 const unsigned int *values;
638 void *dapm;
639};
640
Mark Brown5c82f562009-05-22 09:41:30 +0100641/* codec IO */
642static inline unsigned int snd_soc_read(struct snd_soc_codec *codec,
643 unsigned int reg)
644{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000645 return codec->driver->read(codec, reg);
Mark Brown5c82f562009-05-22 09:41:30 +0100646}
647
648static inline unsigned int snd_soc_write(struct snd_soc_codec *codec,
649 unsigned int reg, unsigned int val)
650{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000651 return codec->driver->write(codec, reg, val);
Mark Brown5c82f562009-05-22 09:41:30 +0100652}
653
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000654/* device driver data */
655
Mark Brownb2c812e2010-04-14 15:35:19 +0900656static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000657 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +0900658{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000659 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +0900660}
661
662static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
663{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000664 return dev_get_drvdata(codec->dev);
665}
666
667static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
668 void *data)
669{
670 dev_set_drvdata(platform->dev, data);
671}
672
673static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
674{
675 return dev_get_drvdata(platform->dev);
676}
677
678static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
679 void *data)
680{
681 dev_set_drvdata(&rtd->dev, data);
682}
683
684static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
685{
686 return dev_get_drvdata(&rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +0900687}
688
Mark Browna47cbe72008-07-23 14:03:07 +0100689#include <sound/soc-dai.h>
690
Richard Purdie808db4a2006-10-06 18:20:14 +0200691#endif