blob: 8ab1cfed1067abe35a65ae11a5aef5b744aced37 [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>
Mark Brownbe3ea3b2011-06-13 19:35:29 +010022#include <linux/regmap.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020023#include <sound/core.h>
24#include <sound/pcm.h>
25#include <sound/control.h>
26#include <sound/ac97_codec.h>
27
Richard Purdie808db4a2006-10-06 18:20:14 +020028/*
29 * Convenience kcontrol builders
30 */
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030031#define SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, xmax, xinvert) \
Jon Smirl4eaa9812008-07-29 11:42:26 +010032 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030033 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
34 .max = xmax, .platform_max = xmax, .invert = xinvert})
35#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
36 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
Jon Smirl4eaa9812008-07-29 11:42:26 +010037#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
38 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030039 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Peter Ujfalusicdffa772011-10-04 14:39:39 +030040#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
41 ((unsigned long)&(struct soc_mixer_control) \
42 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
43 .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010044#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020045{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
46 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
47 .put = snd_soc_put_volsw, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010048 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
49#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
50{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
51 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
52 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
53 .tlv.p = (tlv_array), \
54 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
55 .put = snd_soc_put_volsw, \
56 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030057#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020058{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
59 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
60 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030061 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
62 max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010063#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020064{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
65 .info = snd_soc_info_volsw_2r, \
66 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +030067 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
68 xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030069#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010070{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
71 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
72 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
73 .tlv.p = (tlv_array), \
74 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
75 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030076 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
77 max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010078#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010079{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
80 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
81 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
82 .tlv.p = (tlv_array), \
83 .info = snd_soc_info_volsw_2r, \
84 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +030085 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
86 xmax, xinvert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010087#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +010088{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
89 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
90 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
91 .tlv.p = (tlv_array), \
92 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
93 .put = snd_soc_put_volsw_s8, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010094 .private_value = (unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030095 {.reg = xreg, .min = xmin, .max = xmax, \
96 .platform_max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +010097#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +020098{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +010099 .max = xmax, .texts = xtexts }
100#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
101 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
102#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
103{ .max = xmax, .texts = xtexts }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200104#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
105{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
106 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
107#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
108 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
Richard Purdie808db4a2006-10-06 18:20:14 +0200109#define SOC_ENUM(xname, xenum) \
110{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
111 .info = snd_soc_info_enum_double, \
112 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
113 .private_value = (unsigned long)&xenum }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200114#define SOC_VALUE_ENUM(xname, xenum) \
115{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200116 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200117 .get = snd_soc_get_value_enum_double, \
118 .put = snd_soc_put_value_enum_double, \
119 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100120#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200121 xhandler_get, xhandler_put) \
122{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100123 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200124 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100125 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300126#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
Daniel Mack7629ad22009-04-24 16:37:44 +0200127 xhandler_get, xhandler_put) \
128{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
129 .info = snd_soc_info_volsw, \
130 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300131 .private_value = \
132 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100133#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100134 xhandler_get, xhandler_put, tlv_array) \
135{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
136 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
137 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
138 .tlv.p = (tlv_array), \
139 .info = snd_soc_info_volsw, \
140 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100141 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900142#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
143 xhandler_get, xhandler_put, tlv_array) \
144{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
145 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
146 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
147 .tlv.p = (tlv_array), \
148 .info = snd_soc_info_volsw, \
149 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300150 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
151 xmax, xinvert) }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900152#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
153 xhandler_get, xhandler_put, tlv_array) \
154{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
155 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
156 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
157 .tlv.p = (tlv_array), \
158 .info = snd_soc_info_volsw_2r, \
159 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300160 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
161 xmax, 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/*
Liam Girdwood0168bf02011-06-07 16:08:05 +0100206 * Component probe and remove ordering levels for components with runtime
207 * dependencies.
208 */
209#define SND_SOC_COMP_ORDER_FIRST -2
210#define SND_SOC_COMP_ORDER_EARLY -1
211#define SND_SOC_COMP_ORDER_NORMAL 0
212#define SND_SOC_COMP_ORDER_LATE 1
213#define SND_SOC_COMP_ORDER_LAST 2
214
215/*
Mark Brown0be98982008-05-19 12:31:28 +0200216 * Bias levels
217 *
218 * @ON: Bias is fully on for audio playback and capture operations.
219 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
220 * stream start and stop operations.
221 * @STANDBY: Low power standby state when no playback/capture operations are
222 * in progress. NOTE: The transition time between STANDBY and ON
223 * should be as fast as possible and no longer than 10ms.
224 * @OFF: Power Off. No restrictions on transition times.
225 */
226enum snd_soc_bias_level {
Mark Brown56fba412011-06-04 11:25:10 +0100227 SND_SOC_BIAS_OFF = 0,
228 SND_SOC_BIAS_STANDBY = 1,
229 SND_SOC_BIAS_PREPARE = 2,
230 SND_SOC_BIAS_ON = 3,
Mark Brown0be98982008-05-19 12:31:28 +0200231};
232
Mark Brown8a2cd612009-01-07 17:31:10 +0000233struct snd_jack;
234struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200235struct snd_soc_pcm_stream;
236struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200237struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100238struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000239struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000240struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900241struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000242struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200243struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000244struct snd_soc_codec_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200245struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000246struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530247struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000248struct snd_soc_jack_pin;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000249struct snd_soc_cache_ops;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200250#include <sound/soc-dapm.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000251
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600252#ifdef CONFIG_GPIOLIB
253struct snd_soc_jack_gpio;
254#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200255
256typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200257
258extern struct snd_ac97_bus_ops soc_ac97_ops;
259
Mark Brown7084a422009-07-10 22:24:27 +0100260enum snd_soc_control_type {
Mark Browne9c03902011-06-13 19:05:58 +0100261 SND_SOC_I2C = 1,
Mark Brown7084a422009-07-10 22:24:27 +0100262 SND_SOC_SPI,
Mark Brown0671da12011-07-24 12:23:37 +0100263 SND_SOC_REGMAP,
Mark Brown7084a422009-07-10 22:24:27 +0100264};
265
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000266enum snd_soc_compress_type {
Dimitris Papastamos119bd782010-12-02 14:53:02 +0000267 SND_SOC_FLAT_COMPRESSION = 1,
Dimitris Papastamosa7f387d2010-11-11 10:04:59 +0000268 SND_SOC_LZO_COMPRESSION,
269 SND_SOC_RBTREE_COMPRESSION
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000270};
271
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100272enum snd_soc_pcm_subclass {
273 SND_SOC_PCM_CLASS_PCM = 0,
274 SND_SOC_PCM_CLASS_BE = 1,
275};
276
Mark Brownec4ee522011-03-07 20:58:11 +0000277int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100278 int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000279int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
280 unsigned int freq_in, unsigned int freq_out);
281
Vinod Koul70a7ca32011-01-14 19:22:48 +0530282int snd_soc_register_card(struct snd_soc_card *card);
283int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000284int snd_soc_suspend(struct device *dev);
285int snd_soc_resume(struct device *dev);
286int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000287int snd_soc_register_platform(struct device *dev,
288 struct snd_soc_platform_driver *platform_drv);
289void snd_soc_unregister_platform(struct device *dev);
290int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000291 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000292 struct snd_soc_dai_driver *dai_drv, int num_dai);
293void snd_soc_unregister_codec(struct device *dev);
Mark Brown181e0552011-01-24 14:05:25 +0000294int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
295 unsigned int reg);
Dimitris Papastamos239c9702011-03-24 13:45:18 +0000296int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
297 unsigned int reg);
298int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
299 unsigned int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100300int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100301 int addr_bits, int data_bits,
302 enum snd_soc_control_type control);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000303int snd_soc_cache_sync(struct snd_soc_codec *codec);
304int snd_soc_cache_init(struct snd_soc_codec *codec);
305int snd_soc_cache_exit(struct snd_soc_codec *codec);
306int snd_soc_cache_write(struct snd_soc_codec *codec,
307 unsigned int reg, unsigned int value);
308int snd_soc_cache_read(struct snd_soc_codec *codec,
309 unsigned int reg, unsigned int *value);
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000310int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
311 unsigned int reg);
312int snd_soc_default_readable_register(struct snd_soc_codec *codec,
313 unsigned int reg);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000314int snd_soc_default_writable_register(struct snd_soc_codec *codec,
315 unsigned int reg);
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100316int snd_soc_platform_read(struct snd_soc_platform *platform,
317 unsigned int reg);
318int snd_soc_platform_write(struct snd_soc_platform *platform,
319 unsigned int reg, unsigned int val);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000320
Mark Brown7aae8162009-11-10 16:08:04 +0000321/* Utility functions to get clock rates from various things */
322int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
323int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000324int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000325int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
326
Richard Purdie808db4a2006-10-06 18:20:14 +0200327/* set runtime hw params */
328int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
329 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200330
Mark Brown8a2cd612009-01-07 17:31:10 +0000331/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000332int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000333 struct snd_soc_jack *jack);
334void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
335int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
336 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000337void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
338 struct notifier_block *nb);
339void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
340 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530341int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
342 struct snd_soc_jack_zone *zones);
343int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600344#ifdef CONFIG_GPIOLIB
345int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
346 struct snd_soc_jack_gpio *gpios);
347void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
348 struct snd_soc_jack_gpio *gpios);
349#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000350
Richard Purdie808db4a2006-10-06 18:20:14 +0200351/* codec register bit access */
352int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300353 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000354int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
355 unsigned short reg, unsigned int mask,
356 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200357int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300358 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200359
360int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
361 struct snd_ac97_bus_ops *ops, int num);
362void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
363
364/*
365 *Controls
366 */
367struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brownefb7ac32011-03-08 17:23:24 +0000368 void *data, char *long_name,
369 const char *prefix);
Ian Molton3e8e1952009-01-09 00:23:21 +0000370int snd_soc_add_controls(struct snd_soc_codec *codec,
371 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwooda491a5c2011-07-04 22:10:51 +0100372int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
373 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200374int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
375 struct snd_ctl_elem_info *uinfo);
376int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
377 struct snd_ctl_elem_info *uinfo);
378int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
379 struct snd_ctl_elem_value *ucontrol);
380int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
381 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200382int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
383 struct snd_ctl_elem_value *ucontrol);
384int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
385 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200386int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
387 struct snd_ctl_elem_info *uinfo);
388int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
389 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200390#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200391int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
392 struct snd_ctl_elem_value *ucontrol);
393int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
394 struct snd_ctl_elem_value *ucontrol);
395int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
396 struct snd_ctl_elem_info *uinfo);
397int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
398 struct snd_ctl_elem_value *ucontrol);
399int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
400 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100401int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
402 struct snd_ctl_elem_info *uinfo);
403int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
404 struct snd_ctl_elem_value *ucontrol);
405int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
406 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300407int snd_soc_limit_volume(struct snd_soc_codec *codec,
408 const char *name, int max);
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200409int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
410 struct snd_ctl_elem_info *uinfo);
411int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
412 struct snd_ctl_elem_value *ucontrol);
413int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
414 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200415
Mark Brown8a2cd612009-01-07 17:31:10 +0000416/**
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000417 * struct snd_soc_reg_access - Describes whether a given register is
418 * readable, writable or volatile.
419 *
420 * @reg: the register number
421 * @read: whether this register is readable
422 * @write: whether this register is writable
423 * @vol: whether this register is volatile
424 */
425struct snd_soc_reg_access {
426 u16 reg;
427 u16 read;
428 u16 write;
429 u16 vol;
430};
431
432/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000433 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
434 *
435 * @pin: name of the pin to update
436 * @mask: bits to check for in reported jack status
437 * @invert: if non-zero then pin is enabled when status is not reported
438 */
439struct snd_soc_jack_pin {
440 struct list_head list;
441 const char *pin;
442 int mask;
443 bool invert;
444};
445
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600446/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530447 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
448 *
449 * @min_mv: start voltage in mv
450 * @max_mv: end voltage in mv
451 * @jack_type: type of jack that is expected for this voltage
452 * @debounce_time: debounce_time for jack, codec driver should wait for this
453 * duration before reading the adc for voltages
454 * @:list: list container
455 */
456struct snd_soc_jack_zone {
457 unsigned int min_mv;
458 unsigned int max_mv;
459 unsigned int jack_type;
460 unsigned int debounce_time;
461 struct list_head list;
462};
463
464/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600465 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
466 *
467 * @gpio: gpio number
468 * @name: gpio name
469 * @report: value to report when jack detected
470 * @invert: report presence in low state
471 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800472 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800473 * @jack_status_check: callback function which overrides the detection
474 * to provide more complex checks (eg, reading an
475 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600476 */
477#ifdef CONFIG_GPIOLIB
478struct snd_soc_jack_gpio {
479 unsigned int gpio;
480 const char *name;
481 int report;
482 int invert;
483 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800484 bool wake;
485
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600486 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700487 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900488
489 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600490};
491#endif
492
Mark Brown8a2cd612009-01-07 17:31:10 +0000493struct snd_soc_jack {
494 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000495 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000496 struct list_head pins;
497 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000498 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530499 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000500};
501
Richard Purdie808db4a2006-10-06 18:20:14 +0200502/* SoC PCM stream information */
503struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000504 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100505 u64 formats; /* SNDRV_PCM_FMTBIT_* */
506 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200507 unsigned int rate_min; /* min rate */
508 unsigned int rate_max; /* max rate */
509 unsigned int channels_min; /* min channels */
510 unsigned int channels_max; /* max channels */
Richard Purdie808db4a2006-10-06 18:20:14 +0200511};
512
513/* SoC audio ops */
514struct snd_soc_ops {
515 int (*startup)(struct snd_pcm_substream *);
516 void (*shutdown)(struct snd_pcm_substream *);
517 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
518 int (*hw_free)(struct snd_pcm_substream *);
519 int (*prepare)(struct snd_pcm_substream *);
520 int (*trigger)(struct snd_pcm_substream *, int);
521};
522
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000523/* SoC cache ops */
524struct snd_soc_cache_ops {
Dimitris Papastamos0d735ea2010-12-06 09:51:57 +0000525 const char *name;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000526 enum snd_soc_compress_type id;
527 int (*init)(struct snd_soc_codec *codec);
528 int (*exit)(struct snd_soc_codec *codec);
529 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
530 unsigned int *value);
531 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
532 unsigned int value);
533 int (*sync)(struct snd_soc_codec *codec);
534};
535
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000536/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200537struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000538 const char *name;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200539 const char *name_prefix;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000540 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000541 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000542 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000543
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000544 struct mutex mutex;
545 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000546 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000547 struct list_head card_list;
548 int num_dai;
Dimitris Papastamos23bbce32010-12-02 14:53:01 +0000549 enum snd_soc_compress_type compress_type;
Dimitris Papastamosaea170a2011-01-12 10:38:58 +0000550 size_t reg_size; /* reg_cache_size * reg_word_size */
Dimitris Papastamos1500b7b2011-01-13 12:20:38 +0000551 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
552 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000553 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200554
555 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200556 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
557 unsigned int active;
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000558 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000559 unsigned int suspended:1; /* Codec is in suspend PM state */
560 unsigned int probed:1; /* Codec has been probed */
561 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300562 unsigned int ac97_created:1; /* Codec has been created by SoC */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000563 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000564 unsigned int cache_init:1; /* codec cache has been initialized */
Mark Brownaaee8ef2011-01-26 20:53:50 +0000565 u32 cache_only; /* Suppress writes to hardware */
566 u32 cache_sync; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000567
568 /* codec IO */
569 void *control_data; /* codec control (i2c/3wire) data */
Dimitris Papastamos67850a82011-03-22 10:36:57 +0000570 enum snd_soc_control_type control_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000571 hw_write_t hw_write;
572 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Mark Brownc3acec22010-12-02 16:15:29 +0000573 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
574 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000575 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000576 void *reg_cache;
Dimitris Papastamos3335ddc2010-12-02 16:11:05 +0000577 const void *reg_def_copy;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000578 const struct snd_soc_cache_ops *cache_ops;
579 struct mutex cache_rw_mutex;
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100580 int val_bytes;
Mark Browna96ca332010-01-19 22:49:43 +0000581
Richard Purdie808db4a2006-10-06 18:20:14 +0200582 /* dapm */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200583 struct snd_soc_dapm_context dapm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200584
Mark Brown384c89e2008-12-03 17:34:03 +0000585#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300586 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000587 struct dentry *debugfs_reg;
Mark Brown79fb9382009-08-21 16:38:13 +0100588 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000589#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200590};
591
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000592/* codec driver */
593struct snd_soc_codec_driver {
594
595 /* driver ops */
596 int (*probe)(struct snd_soc_codec *);
597 int (*remove)(struct snd_soc_codec *);
598 int (*suspend)(struct snd_soc_codec *,
599 pm_message_t state);
600 int (*resume)(struct snd_soc_codec *);
601
Mark Brownb7af1da2011-04-07 19:18:44 +0900602 /* Default control and setup, added after probe() is run */
603 const struct snd_kcontrol_new *controls;
604 int num_controls;
Mark Brown89b95ac02011-03-07 16:38:44 +0000605 const struct snd_soc_dapm_widget *dapm_widgets;
606 int num_dapm_widgets;
607 const struct snd_soc_dapm_route *dapm_routes;
608 int num_dapm_routes;
609
Mark Brownec4ee522011-03-07 20:58:11 +0000610 /* codec wide operations */
611 int (*set_sysclk)(struct snd_soc_codec *codec,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100612 int clk_id, int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000613 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
614 unsigned int freq_in, unsigned int freq_out);
615
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000616 /* codec IO */
617 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
618 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
619 int (*display_register)(struct snd_soc_codec *, char *,
620 size_t, unsigned int);
Dimitris Papastamosd4754ec2011-01-13 12:20:37 +0000621 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
622 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000623 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Mark Brown4a8923b2011-08-24 19:12:49 +0100624 unsigned int reg_cache_size;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000625 short reg_cache_step;
626 short reg_word_size;
627 const void *reg_cache_default;
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000628 short reg_access_size;
629 const struct snd_soc_reg_access *reg_access_default;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000630 enum snd_soc_compress_type compress_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000631
632 /* codec bias level */
633 int (*set_bias_level)(struct snd_soc_codec *,
634 enum snd_soc_bias_level level);
Mark Brown33c5f962011-08-22 18:40:30 +0100635 bool idle_bias_off;
Mark Brown474b62d2011-01-18 16:14:44 +0000636
637 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000638 enum snd_soc_dapm_type, int);
Liam Girdwood0168bf02011-06-07 16:08:05 +0100639
Liam Girdwood64a648c2011-07-25 11:15:15 +0100640 /* codec stream completion event */
641 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
642
Liam Girdwood0168bf02011-06-07 16:08:05 +0100643 /* probe ordering - for components with runtime dependencies */
644 int probe_order;
645 int remove_order;
Richard Purdie808db4a2006-10-06 18:20:14 +0200646};
647
648/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000649struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200650
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000651 int (*probe)(struct snd_soc_platform *);
652 int (*remove)(struct snd_soc_platform *);
653 int (*suspend)(struct snd_soc_dai *dai);
654 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200655
656 /* pcm creation and destruction */
Liam Girdwood552d1ef2011-06-07 16:08:33 +0100657 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200658 void (*pcm_free)(struct snd_pcm *);
659
Liam Girdwoodcb2cf612011-07-04 22:10:53 +0100660 /* Default control and setup, added after probe() is run */
661 const struct snd_kcontrol_new *controls;
662 int num_controls;
663 const struct snd_soc_dapm_widget *dapm_widgets;
664 int num_dapm_widgets;
665 const struct snd_soc_dapm_route *dapm_routes;
666 int num_dapm_routes;
667
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200668 /*
669 * For platform caused delay reporting.
670 * Optional.
671 */
672 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
673 struct snd_soc_dai *);
674
Richard Purdie808db4a2006-10-06 18:20:14 +0200675 /* platform stream ops */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000676 struct snd_pcm_ops *ops;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100677
Liam Girdwood64a648c2011-07-25 11:15:15 +0100678 /* platform stream completion event */
679 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
680
Liam Girdwood0168bf02011-06-07 16:08:05 +0100681 /* probe ordering - for components with runtime dependencies */
682 int probe_order;
683 int remove_order;
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100684
685 /* platform IO - used for platform DAPM */
686 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
687 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200688};
689
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000690struct snd_soc_platform {
691 const char *name;
692 int id;
693 struct device *dev;
694 struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200695
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000696 unsigned int suspended:1; /* platform is suspended */
697 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100698
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000699 struct snd_soc_card *card;
700 struct list_head list;
701 struct list_head card_list;
Liam Girdwoodb7950642011-07-04 22:10:52 +0100702
703 struct snd_soc_dapm_context dapm;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000704};
Richard Purdie808db4a2006-10-06 18:20:14 +0200705
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000706struct snd_soc_dai_link {
707 /* config - must be set by machine driver */
708 const char *name; /* Codec name */
709 const char *stream_name; /* Stream name */
710 const char *codec_name; /* for multi-codec */
711 const char *platform_name; /* for multi-platform */
712 const char *cpu_dai_name;
713 const char *codec_dai_name;
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100714
Mark Brown75d9ac42011-09-27 16:41:01 +0100715 unsigned int dai_fmt; /* format to set on init */
716
Mark Brown3efab7d2010-05-09 13:25:43 +0100717 /* Keep DAI active over suspend */
718 unsigned int ignore_suspend:1;
719
Mark Brown06f409d2009-04-07 18:10:13 +0100720 /* Symmetry requirements */
721 unsigned int symmetric_rates:1;
722
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000723 /* codec/machine specific init - e.g. add machine controls */
724 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100725
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000726 /* machine stream operations */
727 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200728};
729
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000730struct snd_soc_codec_conf {
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200731 const char *dev_name;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000732
733 /*
734 * optional map of kcontrol, widget and path name prefixes that are
735 * associated per device
736 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200737 const char *name_prefix;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000738
739 /*
740 * set this to the desired compression type if you want to
741 * override the one supplied in codec->driver->compress_type
742 */
743 enum snd_soc_compress_type compress_type;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200744};
745
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200746struct snd_soc_aux_dev {
747 const char *name; /* Codec name */
748 const char *codec_name; /* for multi-codec */
749
750 /* codec/machine specific init - e.g. add machine controls */
751 int (*init)(struct snd_soc_dapm_context *dapm);
752};
753
Mark Brown87506542008-11-18 20:50:34 +0000754/* SoC card */
755struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000756 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +0100757 const char *long_name;
758 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000759 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000760 struct snd_card *snd_card;
761 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000762
763 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000764 struct mutex mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000765
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000766 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200767
Mark Browne7361ec2011-01-26 14:17:20 +0000768 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +0000769 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +0000770 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200771
772 /* the pre and post PM functions are used to do any PM work before and
773 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +0000774 int (*suspend_pre)(struct snd_soc_card *card);
775 int (*suspend_post)(struct snd_soc_card *card);
776 int (*resume_pre)(struct snd_soc_card *card);
777 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200778
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100779 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000780 int (*set_bias_level)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100781 struct snd_soc_dapm_context *dapm,
Mark Brown0be98982008-05-19 12:31:28 +0200782 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +0000783 int (*set_bias_level_post)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100784 struct snd_soc_dapm_context *dapm,
Mark Brown1badabd2010-12-04 12:41:04 +0000785 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100786
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000787 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000788
Richard Purdie808db4a2006-10-06 18:20:14 +0200789 /* CPU <--> Codec DAI links */
790 struct snd_soc_dai_link *dai_link;
791 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000792 struct snd_soc_pcm_runtime *rtd;
793 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000794
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000795 /* optional codec specific configuration */
796 struct snd_soc_codec_conf *codec_conf;
797 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200798
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200799 /*
800 * optional auxiliary devices such as amplifiers or codecs with DAI
801 * link unused
802 */
803 struct snd_soc_aux_dev *aux_dev;
804 int num_aux_devs;
805 struct snd_soc_pcm_runtime *rtd_aux;
806 int num_aux_rtd;
807
Mark Brownb7af1da2011-04-07 19:18:44 +0900808 const struct snd_kcontrol_new *controls;
809 int num_controls;
810
Mark Brownb8ad29d2011-03-02 18:35:51 +0000811 /*
812 * Card-specific routes and widgets.
813 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200814 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000815 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200816 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000817 int num_dapm_routes;
818
Mark Brown63084192008-12-02 15:08:03 +0000819 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000820
821 /* lists of probed devices belonging to this card */
822 struct list_head codec_dev_list;
823 struct list_head platform_dev_list;
824 struct list_head dai_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200825
Jarkko Nikula97c866d2010-12-14 12:18:31 +0200826 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200827 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200828 struct list_head dapm_list;
Mark Browndb432b42011-10-03 21:06:40 +0100829 struct list_head dapm_dirty;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200830
Mark Browne37a4972011-03-02 18:21:57 +0000831 /* Generic DAPM context for the card */
832 struct snd_soc_dapm_context dapm;
Mark Brownde02d072011-09-20 21:43:24 +0100833 struct snd_soc_dapm_stats dapm_stats;
Mark Browne37a4972011-03-02 18:21:57 +0000834
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200835#ifdef CONFIG_DEBUG_FS
836 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200837 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200838#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200839 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +0000840
841 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +0200842};
843
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000844/* SoC machine DAI configuration, glues a codec and cpu DAI together */
845struct snd_soc_pcm_runtime {
846 struct device dev;
Mark Brown87506542008-11-18 20:50:34 +0000847 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000848 struct snd_soc_dai_link *dai_link;
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100849 struct mutex pcm_mutex;
850 enum snd_soc_pcm_subclass pcm_subclass;
851 struct snd_pcm_ops ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200852
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000853 unsigned int complete:1;
854 unsigned int dev_registered:1;
855
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000856 long pmdown_time;
857
858 /* runtime devices */
859 struct snd_pcm *pcm;
860 struct snd_soc_codec *codec;
861 struct snd_soc_platform *platform;
862 struct snd_soc_dai *codec_dai;
863 struct snd_soc_dai *cpu_dai;
864
865 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200866};
867
Jon Smirl4eaa9812008-07-29 11:42:26 +0100868/* mixer control */
869struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300870 int min, max, platform_max;
Jon Smirl815ecf8d2008-07-29 10:22:24 -0400871 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100872};
873
Richard Purdie808db4a2006-10-06 18:20:14 +0200874/* enumerated kcontrol */
875struct soc_enum {
876 unsigned short reg;
877 unsigned short reg2;
878 unsigned char shift_l;
879 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100880 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200881 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +0200882 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200883 const unsigned int *values;
884 void *dapm;
885};
886
Mark Brown5c82f562009-05-22 09:41:30 +0100887/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -0400888unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
889unsigned int snd_soc_write(struct snd_soc_codec *codec,
890 unsigned int reg, unsigned int val);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000891unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
892 unsigned int reg, const void *data, size_t len);
Mark Brown5c82f562009-05-22 09:41:30 +0100893
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000894/* device driver data */
895
Mark Browndddf3e42011-01-28 13:11:47 +0000896static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
897 void *data)
898{
899 card->drvdata = data;
900}
901
902static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
903{
904 return card->drvdata;
905}
906
Mark Brownb2c812e2010-04-14 15:35:19 +0900907static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000908 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +0900909{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000910 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +0900911}
912
913static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
914{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000915 return dev_get_drvdata(codec->dev);
916}
917
918static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
919 void *data)
920{
921 dev_set_drvdata(platform->dev, data);
922}
923
924static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
925{
926 return dev_get_drvdata(platform->dev);
927}
928
929static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
930 void *data)
931{
932 dev_set_drvdata(&rtd->dev, data);
933}
934
935static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
936{
937 return dev_get_drvdata(&rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +0900938}
939
Vinod Koul4e10bda2011-01-13 22:48:52 +0530940static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
941{
942 INIT_LIST_HEAD(&card->dai_dev_list);
943 INIT_LIST_HEAD(&card->codec_dev_list);
944 INIT_LIST_HEAD(&card->platform_dev_list);
945 INIT_LIST_HEAD(&card->widgets);
946 INIT_LIST_HEAD(&card->paths);
947 INIT_LIST_HEAD(&card->dapm_list);
948}
949
Mark Brownfb257892011-04-28 10:57:54 +0100950int snd_soc_util_init(void);
951void snd_soc_util_exit(void);
952
Mark Browna47cbe72008-07-23 14:03:07 +0100953#include <sound/soc-dai.h>
954
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700955#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +0000956extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700957#endif
958
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000959extern const struct dev_pm_ops snd_soc_pm_ops;
960
Richard Purdie808db4a2006-10-06 18:20:14 +0200961#endif