blob: 9348bed86b1e5cbe58ecbb89475fed7b90ed6c68 [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 Ujfalusi30d86ba2011-10-05 10:29:22 +030033 {.reg = xreg, .rreg = xreg, .shift = shift_left, \
34 .rshift = shift_right, .max = xmax, .platform_max = xmax, \
35 .invert = xinvert})
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030036#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
37 SOC_DOUBLE_VALUE(xreg, xshift, xshift, xmax, xinvert)
Jon Smirl4eaa9812008-07-29 11:42:26 +010038#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
39 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030040 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Peter Ujfalusicdffa772011-10-04 14:39:39 +030041#define SOC_DOUBLE_R_VALUE(xlreg, xrreg, xshift, xmax, xinvert) \
42 ((unsigned long)&(struct soc_mixer_control) \
43 {.reg = xlreg, .rreg = xrreg, .shift = xshift, .rshift = xshift, \
44 .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010045#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020046{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
47 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
48 .put = snd_soc_put_volsw, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010049 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
50#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
51{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
52 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
53 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
54 .tlv.p = (tlv_array), \
55 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
56 .put = snd_soc_put_volsw, \
57 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030058#define SOC_DOUBLE(xname, reg, shift_left, shift_right, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020059{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
60 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
61 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030062 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
63 max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010064#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020065{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +030066 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +030067 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +030068 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
69 xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030070#define SOC_DOUBLE_TLV(xname, reg, shift_left, shift_right, max, invert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010071{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
72 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
73 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
74 .tlv.p = (tlv_array), \
75 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
76 .put = snd_soc_put_volsw, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +030077 .private_value = SOC_DOUBLE_VALUE(reg, shift_left, shift_right, \
78 max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010079#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010080{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
81 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
82 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
83 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +030084 .info = snd_soc_info_volsw, \
Peter Ujfalusi974815b2011-10-05 10:29:25 +030085 .get = snd_soc_get_volsw, .put = snd_soc_put_volsw, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +030086 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
87 xmax, xinvert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010088#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +010089{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
90 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
91 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
92 .tlv.p = (tlv_array), \
93 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
94 .put = snd_soc_put_volsw_s8, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010095 .private_value = (unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030096 {.reg = xreg, .min = xmin, .max = xmax, \
97 .platform_max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +010098#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +020099{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100100 .max = xmax, .texts = xtexts }
101#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
102 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
103#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
104{ .max = xmax, .texts = xtexts }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200105#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
106{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
107 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
108#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
109 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
Richard Purdie808db4a2006-10-06 18:20:14 +0200110#define SOC_ENUM(xname, xenum) \
111{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
112 .info = snd_soc_info_enum_double, \
113 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
114 .private_value = (unsigned long)&xenum }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200115#define SOC_VALUE_ENUM(xname, xenum) \
116{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200117 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200118 .get = snd_soc_get_value_enum_double, \
119 .put = snd_soc_put_value_enum_double, \
120 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100121#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200122 xhandler_get, xhandler_put) \
123{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100124 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200125 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100126 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300127#define SOC_DOUBLE_EXT(xname, reg, shift_left, shift_right, max, invert,\
Daniel Mack7629ad22009-04-24 16:37:44 +0200128 xhandler_get, xhandler_put) \
129{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
130 .info = snd_soc_info_volsw, \
131 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300132 .private_value = \
133 SOC_DOUBLE_VALUE(reg, shift_left, shift_right, max, invert) }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100134#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100135 xhandler_get, xhandler_put, tlv_array) \
136{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
137 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
138 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
139 .tlv.p = (tlv_array), \
140 .info = snd_soc_info_volsw, \
141 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100142 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900143#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
144 xhandler_get, xhandler_put, tlv_array) \
145{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
146 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
147 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
148 .tlv.p = (tlv_array), \
149 .info = snd_soc_info_volsw, \
150 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusi460acbe2011-10-04 14:39:38 +0300151 .private_value = SOC_DOUBLE_VALUE(xreg, shift_left, shift_right, \
152 xmax, xinvert) }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900153#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
154 xhandler_get, xhandler_put, tlv_array) \
155{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
156 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
157 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
158 .tlv.p = (tlv_array), \
Peter Ujfalusie8f5a102011-10-05 10:29:23 +0300159 .info = snd_soc_info_volsw, \
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900160 .get = xhandler_get, .put = xhandler_put, \
Peter Ujfalusicdffa772011-10-04 14:39:39 +0300161 .private_value = SOC_DOUBLE_R_VALUE(reg_left, reg_right, xshift, \
162 xmax, xinvert) }
Richard Purdie808db4a2006-10-06 18:20:14 +0200163#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
164{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
165 .info = snd_soc_info_bool_ext, \
166 .get = xhandler_get, .put = xhandler_put, \
167 .private_value = xdata }
168#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
169{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
170 .info = snd_soc_info_enum_ext, \
171 .get = xhandler_get, .put = xhandler_put, \
172 .private_value = (unsigned long)&xenum }
173
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200174#define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
175 xmin, xmax, tlv_array) \
176{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
177 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
178 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
179 .tlv.p = (tlv_array), \
180 .info = snd_soc_info_volsw_2r_sx, \
181 .get = snd_soc_get_volsw_2r_sx, \
182 .put = snd_soc_put_volsw_2r_sx, \
183 .private_value = (unsigned long)&(struct soc_mixer_control) \
184 {.reg = xreg_left, \
185 .rreg = xreg_right, .shift = xshift, \
186 .min = xmin, .max = xmax} }
187
188
Richard Purdie808db4a2006-10-06 18:20:14 +0200189/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100190 * Simplified versions of above macros, declaring a struct and calculating
191 * ARRAY_SIZE internally
192 */
193#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
194 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
195 ARRAY_SIZE(xtexts), xtexts)
196#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
197 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
198#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
199 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
200#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
201 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
202 ARRAY_SIZE(xtexts), xtexts, xvalues)
203#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
204 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
205
206/*
Liam Girdwood0168bf02011-06-07 16:08:05 +0100207 * Component probe and remove ordering levels for components with runtime
208 * dependencies.
209 */
210#define SND_SOC_COMP_ORDER_FIRST -2
211#define SND_SOC_COMP_ORDER_EARLY -1
212#define SND_SOC_COMP_ORDER_NORMAL 0
213#define SND_SOC_COMP_ORDER_LATE 1
214#define SND_SOC_COMP_ORDER_LAST 2
215
216/*
Mark Brown0be98982008-05-19 12:31:28 +0200217 * Bias levels
218 *
219 * @ON: Bias is fully on for audio playback and capture operations.
220 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
221 * stream start and stop operations.
222 * @STANDBY: Low power standby state when no playback/capture operations are
223 * in progress. NOTE: The transition time between STANDBY and ON
224 * should be as fast as possible and no longer than 10ms.
225 * @OFF: Power Off. No restrictions on transition times.
226 */
227enum snd_soc_bias_level {
Mark Brown56fba412011-06-04 11:25:10 +0100228 SND_SOC_BIAS_OFF = 0,
229 SND_SOC_BIAS_STANDBY = 1,
230 SND_SOC_BIAS_PREPARE = 2,
231 SND_SOC_BIAS_ON = 3,
Mark Brown0be98982008-05-19 12:31:28 +0200232};
233
Stephen Warren5a504962011-12-21 10:40:59 -0700234struct device_node;
Mark Brown8a2cd612009-01-07 17:31:10 +0000235struct snd_jack;
236struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200237struct snd_soc_pcm_stream;
238struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200239struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100240struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000241struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000242struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900243struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000244struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200245struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000246struct snd_soc_codec_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200247struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000248struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530249struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000250struct snd_soc_jack_pin;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000251struct snd_soc_cache_ops;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200252#include <sound/soc-dapm.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000253
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600254#ifdef CONFIG_GPIOLIB
255struct snd_soc_jack_gpio;
256#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200257
258typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200259
260extern struct snd_ac97_bus_ops soc_ac97_ops;
261
Mark Brown7084a422009-07-10 22:24:27 +0100262enum snd_soc_control_type {
Mark Browne9c03902011-06-13 19:05:58 +0100263 SND_SOC_I2C = 1,
Mark Brown7084a422009-07-10 22:24:27 +0100264 SND_SOC_SPI,
Mark Brown0671da12011-07-24 12:23:37 +0100265 SND_SOC_REGMAP,
Mark Brown7084a422009-07-10 22:24:27 +0100266};
267
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000268enum snd_soc_compress_type {
Dimitris Papastamos119bd782010-12-02 14:53:02 +0000269 SND_SOC_FLAT_COMPRESSION = 1,
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 Brown354a2142011-12-22 12:16:39 +0000320int soc_new_pcm(struct snd_soc_pcm_runtime *rtd, int num);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000321
Mark Brown7aae8162009-11-10 16:08:04 +0000322/* Utility functions to get clock rates from various things */
323int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
324int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000325int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000326int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
327
Richard Purdie808db4a2006-10-06 18:20:14 +0200328/* set runtime hw params */
329int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
330 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200331
Mark Brown8a2cd612009-01-07 17:31:10 +0000332/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000333int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000334 struct snd_soc_jack *jack);
335void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
336int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
337 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000338void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
339 struct notifier_block *nb);
340void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
341 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530342int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
343 struct snd_soc_jack_zone *zones);
344int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600345#ifdef CONFIG_GPIOLIB
346int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
347 struct snd_soc_jack_gpio *gpios);
348void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
349 struct snd_soc_jack_gpio *gpios);
350#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000351
Richard Purdie808db4a2006-10-06 18:20:14 +0200352/* codec register bit access */
353int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300354 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000355int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
356 unsigned short reg, unsigned int mask,
357 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200358int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300359 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200360
361int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
362 struct snd_ac97_bus_ops *ops, int num);
363void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
364
365/*
366 *Controls
367 */
368struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brownefb7ac32011-03-08 17:23:24 +0000369 void *data, char *long_name,
370 const char *prefix);
Liam Girdwood022658b2012-02-03 17:43:09 +0000371int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
Ian Molton3e8e1952009-01-09 00:23:21 +0000372 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwooda491a5c2011-07-04 22:10:51 +0100373int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
374 const struct snd_kcontrol_new *controls, int num_controls);
Liam Girdwood022658b2012-02-03 17:43:09 +0000375int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
376 const struct snd_kcontrol_new *controls, int num_controls);
377int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
378 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200379int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
380 struct snd_ctl_elem_info *uinfo);
381int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
382 struct snd_ctl_elem_info *uinfo);
383int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *ucontrol);
385int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
386 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200387int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
388 struct snd_ctl_elem_value *ucontrol);
389int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
390 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200391int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
392 struct snd_ctl_elem_info *uinfo);
393int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
394 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200395#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200396int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
397 struct snd_ctl_elem_value *ucontrol);
398int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
399 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusia92f1392011-10-06 07:43:21 +0300400#define snd_soc_get_volsw_2r snd_soc_get_volsw
401#define snd_soc_put_volsw_2r snd_soc_put_volsw
Mark Browne13ac2e2008-05-28 17:58:05 +0100402int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
403 struct snd_ctl_elem_info *uinfo);
404int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
405 struct snd_ctl_elem_value *ucontrol);
406int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
407 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300408int snd_soc_limit_volume(struct snd_soc_codec *codec,
409 const char *name, int max);
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200410int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
411 struct snd_ctl_elem_info *uinfo);
412int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
413 struct snd_ctl_elem_value *ucontrol);
414int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
415 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200416
Mark Brown8a2cd612009-01-07 17:31:10 +0000417/**
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000418 * struct snd_soc_reg_access - Describes whether a given register is
419 * readable, writable or volatile.
420 *
421 * @reg: the register number
422 * @read: whether this register is readable
423 * @write: whether this register is writable
424 * @vol: whether this register is volatile
425 */
426struct snd_soc_reg_access {
427 u16 reg;
428 u16 read;
429 u16 write;
430 u16 vol;
431};
432
433/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000434 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
435 *
436 * @pin: name of the pin to update
437 * @mask: bits to check for in reported jack status
438 * @invert: if non-zero then pin is enabled when status is not reported
439 */
440struct snd_soc_jack_pin {
441 struct list_head list;
442 const char *pin;
443 int mask;
444 bool invert;
445};
446
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600447/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530448 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
449 *
450 * @min_mv: start voltage in mv
451 * @max_mv: end voltage in mv
452 * @jack_type: type of jack that is expected for this voltage
453 * @debounce_time: debounce_time for jack, codec driver should wait for this
454 * duration before reading the adc for voltages
455 * @:list: list container
456 */
457struct snd_soc_jack_zone {
458 unsigned int min_mv;
459 unsigned int max_mv;
460 unsigned int jack_type;
461 unsigned int debounce_time;
462 struct list_head list;
463};
464
465/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600466 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
467 *
468 * @gpio: gpio number
469 * @name: gpio name
470 * @report: value to report when jack detected
471 * @invert: report presence in low state
472 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800473 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800474 * @jack_status_check: callback function which overrides the detection
475 * to provide more complex checks (eg, reading an
476 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600477 */
478#ifdef CONFIG_GPIOLIB
479struct snd_soc_jack_gpio {
480 unsigned int gpio;
481 const char *name;
482 int report;
483 int invert;
484 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800485 bool wake;
486
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600487 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700488 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900489
490 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600491};
492#endif
493
Mark Brown8a2cd612009-01-07 17:31:10 +0000494struct snd_soc_jack {
495 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000496 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000497 struct list_head pins;
498 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000499 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530500 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000501};
502
Richard Purdie808db4a2006-10-06 18:20:14 +0200503/* SoC PCM stream information */
504struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000505 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100506 u64 formats; /* SNDRV_PCM_FMTBIT_* */
507 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200508 unsigned int rate_min; /* min rate */
509 unsigned int rate_max; /* max rate */
510 unsigned int channels_min; /* min channels */
511 unsigned int channels_max; /* max channels */
Mark Brown58ba9b22012-01-16 18:38:51 +0000512 unsigned int sig_bits; /* number of bits of content */
Richard Purdie808db4a2006-10-06 18:20:14 +0200513};
514
515/* SoC audio ops */
516struct snd_soc_ops {
517 int (*startup)(struct snd_pcm_substream *);
518 void (*shutdown)(struct snd_pcm_substream *);
519 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
520 int (*hw_free)(struct snd_pcm_substream *);
521 int (*prepare)(struct snd_pcm_substream *);
522 int (*trigger)(struct snd_pcm_substream *, int);
523};
524
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000525/* SoC cache ops */
526struct snd_soc_cache_ops {
Dimitris Papastamos0d735ea2010-12-06 09:51:57 +0000527 const char *name;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000528 enum snd_soc_compress_type id;
529 int (*init)(struct snd_soc_codec *codec);
530 int (*exit)(struct snd_soc_codec *codec);
531 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
532 unsigned int *value);
533 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
534 unsigned int value);
535 int (*sync)(struct snd_soc_codec *codec);
536};
537
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000538/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200539struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000540 const char *name;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200541 const char *name_prefix;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000542 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000543 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000544 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000545
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000546 struct mutex mutex;
547 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000548 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000549 struct list_head card_list;
550 int num_dai;
Dimitris Papastamos23bbce32010-12-02 14:53:01 +0000551 enum snd_soc_compress_type compress_type;
Dimitris Papastamosaea170a2011-01-12 10:38:58 +0000552 size_t reg_size; /* reg_cache_size * reg_word_size */
Dimitris Papastamos1500b7b2011-01-13 12:20:38 +0000553 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
554 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000555 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200556
557 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200558 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
559 unsigned int active;
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000560 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000561 unsigned int suspended:1; /* Codec is in suspend PM state */
562 unsigned int probed:1; /* Codec has been probed */
563 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300564 unsigned int ac97_created:1; /* Codec has been created by SoC */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000565 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000566 unsigned int cache_init:1; /* codec cache has been initialized */
Mark Brown8a713da2011-12-03 12:33:55 +0000567 unsigned int using_regmap:1; /* using regmap access */
Mark Brownaaee8ef2011-01-26 20:53:50 +0000568 u32 cache_only; /* Suppress writes to hardware */
569 u32 cache_sync; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000570
571 /* codec IO */
572 void *control_data; /* codec control (i2c/3wire) data */
Dimitris Papastamos67850a82011-03-22 10:36:57 +0000573 enum snd_soc_control_type control_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000574 hw_write_t hw_write;
575 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Mark Brownc3acec22010-12-02 16:15:29 +0000576 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
577 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000578 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000579 void *reg_cache;
Dimitris Papastamos3335ddc2010-12-02 16:11:05 +0000580 const void *reg_def_copy;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000581 const struct snd_soc_cache_ops *cache_ops;
582 struct mutex cache_rw_mutex;
Mark Brownbe3ea3b2011-06-13 19:35:29 +0100583 int val_bytes;
Mark Browna96ca332010-01-19 22:49:43 +0000584
Richard Purdie808db4a2006-10-06 18:20:14 +0200585 /* dapm */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200586 struct snd_soc_dapm_context dapm;
Peter Ujfalusi1d69c5c2011-10-14 14:43:33 +0300587 unsigned int ignore_pmdown_time:1; /* pmdown_time is ignored at stop */
Richard Purdie808db4a2006-10-06 18:20:14 +0200588
Mark Brown384c89e2008-12-03 17:34:03 +0000589#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300590 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000591 struct dentry *debugfs_reg;
Mark Brown79fb9382009-08-21 16:38:13 +0100592 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000593#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200594};
595
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000596/* codec driver */
597struct snd_soc_codec_driver {
598
599 /* driver ops */
600 int (*probe)(struct snd_soc_codec *);
601 int (*remove)(struct snd_soc_codec *);
Lars-Peter Clausen84b315e2011-12-02 10:18:28 +0100602 int (*suspend)(struct snd_soc_codec *);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000603 int (*resume)(struct snd_soc_codec *);
604
Mark Brownb7af1da2011-04-07 19:18:44 +0900605 /* Default control and setup, added after probe() is run */
606 const struct snd_kcontrol_new *controls;
607 int num_controls;
Mark Brown89b95ac2011-03-07 16:38:44 +0000608 const struct snd_soc_dapm_widget *dapm_widgets;
609 int num_dapm_widgets;
610 const struct snd_soc_dapm_route *dapm_routes;
611 int num_dapm_routes;
612
Mark Brownec4ee522011-03-07 20:58:11 +0000613 /* codec wide operations */
614 int (*set_sysclk)(struct snd_soc_codec *codec,
Mark Brownda1c6ea2011-08-24 20:09:01 +0100615 int clk_id, int source, unsigned int freq, int dir);
Mark Brownec4ee522011-03-07 20:58:11 +0000616 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
617 unsigned int freq_in, unsigned int freq_out);
618
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000619 /* codec IO */
620 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
621 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
622 int (*display_register)(struct snd_soc_codec *, char *,
623 size_t, unsigned int);
Dimitris Papastamosd4754ec2011-01-13 12:20:37 +0000624 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
625 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000626 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Mark Brown4a8923b2011-08-24 19:12:49 +0100627 unsigned int reg_cache_size;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000628 short reg_cache_step;
629 short reg_word_size;
630 const void *reg_cache_default;
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000631 short reg_access_size;
632 const struct snd_soc_reg_access *reg_access_default;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000633 enum snd_soc_compress_type compress_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000634
635 /* codec bias level */
636 int (*set_bias_level)(struct snd_soc_codec *,
637 enum snd_soc_bias_level level);
Mark Brown33c5f962011-08-22 18:40:30 +0100638 bool idle_bias_off;
Mark Brown474b62d2011-01-18 16:14:44 +0000639
640 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000641 enum snd_soc_dapm_type, int);
Liam Girdwood0168bf02011-06-07 16:08:05 +0100642
Liam Girdwood64a648c2011-07-25 11:15:15 +0100643 /* codec stream completion event */
644 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
645
Liam Girdwood0168bf02011-06-07 16:08:05 +0100646 /* probe ordering - for components with runtime dependencies */
647 int probe_order;
648 int remove_order;
Richard Purdie808db4a2006-10-06 18:20:14 +0200649};
650
651/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000652struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200653
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000654 int (*probe)(struct snd_soc_platform *);
655 int (*remove)(struct snd_soc_platform *);
656 int (*suspend)(struct snd_soc_dai *dai);
657 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200658
659 /* pcm creation and destruction */
Liam Girdwood552d1ef2011-06-07 16:08:33 +0100660 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200661 void (*pcm_free)(struct snd_pcm *);
662
Liam Girdwoodcb2cf612011-07-04 22:10:53 +0100663 /* Default control and setup, added after probe() is run */
664 const struct snd_kcontrol_new *controls;
665 int num_controls;
666 const struct snd_soc_dapm_widget *dapm_widgets;
667 int num_dapm_widgets;
668 const struct snd_soc_dapm_route *dapm_routes;
669 int num_dapm_routes;
670
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200671 /*
672 * For platform caused delay reporting.
673 * Optional.
674 */
675 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
676 struct snd_soc_dai *);
677
Richard Purdie808db4a2006-10-06 18:20:14 +0200678 /* platform stream ops */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000679 struct snd_pcm_ops *ops;
Liam Girdwood0168bf02011-06-07 16:08:05 +0100680
Liam Girdwood64a648c2011-07-25 11:15:15 +0100681 /* platform stream completion event */
682 int (*stream_event)(struct snd_soc_dapm_context *dapm, int event);
683
Liam Girdwood0168bf02011-06-07 16:08:05 +0100684 /* probe ordering - for components with runtime dependencies */
685 int probe_order;
686 int remove_order;
Liam Girdwoodf1442bc2011-07-04 11:10:15 +0100687
688 /* platform IO - used for platform DAPM */
689 unsigned int (*read)(struct snd_soc_platform *, unsigned int);
690 int (*write)(struct snd_soc_platform *, unsigned int, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200691};
692
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000693struct snd_soc_platform {
694 const char *name;
695 int id;
696 struct device *dev;
697 struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200698
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000699 unsigned int suspended:1; /* platform is suspended */
700 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100701
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000702 struct snd_soc_card *card;
703 struct list_head list;
704 struct list_head card_list;
Liam Girdwoodb7950642011-07-04 22:10:52 +0100705
706 struct snd_soc_dapm_context dapm;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000707};
Richard Purdie808db4a2006-10-06 18:20:14 +0200708
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000709struct snd_soc_dai_link {
710 /* config - must be set by machine driver */
711 const char *name; /* Codec name */
712 const char *stream_name; /* Stream name */
713 const char *codec_name; /* for multi-codec */
Stephen Warren5a504962011-12-21 10:40:59 -0700714 const struct device_node *codec_of_node;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000715 const char *platform_name; /* for multi-platform */
Stephen Warren5a504962011-12-21 10:40:59 -0700716 const struct device_node *platform_of_node;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000717 const char *cpu_dai_name;
Stephen Warren5a504962011-12-21 10:40:59 -0700718 const struct device_node *cpu_dai_of_node;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000719 const char *codec_dai_name;
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100720
Mark Brown75d9ac42011-09-27 16:41:01 +0100721 unsigned int dai_fmt; /* format to set on init */
722
Mark Brown3efab7d2010-05-09 13:25:43 +0100723 /* Keep DAI active over suspend */
724 unsigned int ignore_suspend:1;
725
Mark Brown06f409d2009-04-07 18:10:13 +0100726 /* Symmetry requirements */
727 unsigned int symmetric_rates:1;
728
ramesh.babu@linux.intel.come50fad42011-10-27 12:12:33 +0530729 /* pmdown_time is ignored at stop */
730 unsigned int ignore_pmdown_time:1;
731
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000732 /* codec/machine specific init - e.g. add machine controls */
733 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100734
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000735 /* machine stream operations */
736 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200737};
738
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000739struct snd_soc_codec_conf {
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200740 const char *dev_name;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000741
742 /*
743 * optional map of kcontrol, widget and path name prefixes that are
744 * associated per device
745 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200746 const char *name_prefix;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000747
748 /*
749 * set this to the desired compression type if you want to
750 * override the one supplied in codec->driver->compress_type
751 */
752 enum snd_soc_compress_type compress_type;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200753};
754
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200755struct snd_soc_aux_dev {
756 const char *name; /* Codec name */
757 const char *codec_name; /* for multi-codec */
758
759 /* codec/machine specific init - e.g. add machine controls */
760 int (*init)(struct snd_soc_dapm_context *dapm);
761};
762
Mark Brown87506542008-11-18 20:50:34 +0000763/* SoC card */
764struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000765 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +0100766 const char *long_name;
767 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000768 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000769 struct snd_card *snd_card;
770 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000771
772 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000773 struct mutex mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000774
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000775 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200776
Mark Browne7361ec2011-01-26 14:17:20 +0000777 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +0000778 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +0000779 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200780
781 /* the pre and post PM functions are used to do any PM work before and
782 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +0000783 int (*suspend_pre)(struct snd_soc_card *card);
784 int (*suspend_post)(struct snd_soc_card *card);
785 int (*resume_pre)(struct snd_soc_card *card);
786 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200787
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100788 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000789 int (*set_bias_level)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100790 struct snd_soc_dapm_context *dapm,
Mark Brown0be98982008-05-19 12:31:28 +0200791 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +0000792 int (*set_bias_level_post)(struct snd_soc_card *,
Mark Brownd4c60052011-06-06 19:13:23 +0100793 struct snd_soc_dapm_context *dapm,
Mark Brown1badabd2010-12-04 12:41:04 +0000794 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100795
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000796 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000797
Richard Purdie808db4a2006-10-06 18:20:14 +0200798 /* CPU <--> Codec DAI links */
799 struct snd_soc_dai_link *dai_link;
800 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000801 struct snd_soc_pcm_runtime *rtd;
802 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000803
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000804 /* optional codec specific configuration */
805 struct snd_soc_codec_conf *codec_conf;
806 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200807
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200808 /*
809 * optional auxiliary devices such as amplifiers or codecs with DAI
810 * link unused
811 */
812 struct snd_soc_aux_dev *aux_dev;
813 int num_aux_devs;
814 struct snd_soc_pcm_runtime *rtd_aux;
815 int num_aux_rtd;
816
Mark Brownb7af1da2011-04-07 19:18:44 +0900817 const struct snd_kcontrol_new *controls;
818 int num_controls;
819
Mark Brownb8ad29d2011-03-02 18:35:51 +0000820 /*
821 * Card-specific routes and widgets.
822 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200823 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000824 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200825 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000826 int num_dapm_routes;
Stephen Warren16332812011-11-23 12:42:04 -0700827 bool fully_routed;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000828
Mark Brown63084192008-12-02 15:08:03 +0000829 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000830
831 /* lists of probed devices belonging to this card */
832 struct list_head codec_dev_list;
833 struct list_head platform_dev_list;
834 struct list_head dai_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200835
Jarkko Nikula97c866d2010-12-14 12:18:31 +0200836 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200837 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200838 struct list_head dapm_list;
Mark Browndb432b42011-10-03 21:06:40 +0100839 struct list_head dapm_dirty;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200840
Mark Browne37a4972011-03-02 18:21:57 +0000841 /* Generic DAPM context for the card */
842 struct snd_soc_dapm_context dapm;
Mark Brownde02d072011-09-20 21:43:24 +0100843 struct snd_soc_dapm_stats dapm_stats;
Mark Browne37a4972011-03-02 18:21:57 +0000844
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200845#ifdef CONFIG_DEBUG_FS
846 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200847 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200848#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200849 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +0000850
851 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +0200852};
853
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000854/* SoC machine DAI configuration, glues a codec and cpu DAI together */
Mark Brownd66a3272011-11-10 11:46:13 +0000855struct snd_soc_pcm_runtime {
Mark Brown36ae1a92012-01-06 17:12:45 -0800856 struct device *dev;
Mark Brown87506542008-11-18 20:50:34 +0000857 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000858 struct snd_soc_dai_link *dai_link;
Liam Girdwoodb8c0dab2011-06-09 17:04:39 +0100859 struct mutex pcm_mutex;
860 enum snd_soc_pcm_subclass pcm_subclass;
861 struct snd_pcm_ops ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200862
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000863 unsigned int complete:1;
864 unsigned int dev_registered:1;
865
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000866 long pmdown_time;
867
868 /* runtime devices */
869 struct snd_pcm *pcm;
870 struct snd_soc_codec *codec;
871 struct snd_soc_platform *platform;
872 struct snd_soc_dai *codec_dai;
873 struct snd_soc_dai *cpu_dai;
874
875 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200876};
877
Jon Smirl4eaa9812008-07-29 11:42:26 +0100878/* mixer control */
879struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300880 int min, max, platform_max;
Jon Smirl815ecf82008-07-29 10:22:24 -0400881 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100882};
883
Richard Purdie808db4a2006-10-06 18:20:14 +0200884/* enumerated kcontrol */
885struct soc_enum {
886 unsigned short reg;
887 unsigned short reg2;
888 unsigned char shift_l;
889 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100890 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200891 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +0200892 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200893 const unsigned int *values;
894 void *dapm;
895};
896
Mark Brown5c82f562009-05-22 09:41:30 +0100897/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -0400898unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
899unsigned int snd_soc_write(struct snd_soc_codec *codec,
900 unsigned int reg, unsigned int val);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000901unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
902 unsigned int reg, const void *data, size_t len);
Mark Brown5c82f562009-05-22 09:41:30 +0100903
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000904/* device driver data */
905
Mark Browndddf3e42011-01-28 13:11:47 +0000906static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
907 void *data)
908{
909 card->drvdata = data;
910}
911
912static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
913{
914 return card->drvdata;
915}
916
Mark Brownb2c812e2010-04-14 15:35:19 +0900917static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000918 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +0900919{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000920 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +0900921}
922
923static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
924{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000925 return dev_get_drvdata(codec->dev);
926}
927
928static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
929 void *data)
930{
931 dev_set_drvdata(platform->dev, data);
932}
933
934static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
935{
936 return dev_get_drvdata(platform->dev);
937}
938
939static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
940 void *data)
941{
Mark Brown36ae1a92012-01-06 17:12:45 -0800942 dev_set_drvdata(rtd->dev, data);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000943}
944
945static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
946{
Mark Brown36ae1a92012-01-06 17:12:45 -0800947 return dev_get_drvdata(rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +0900948}
949
Vinod Koul4e10bda2011-01-13 22:48:52 +0530950static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
951{
952 INIT_LIST_HEAD(&card->dai_dev_list);
953 INIT_LIST_HEAD(&card->codec_dev_list);
954 INIT_LIST_HEAD(&card->platform_dev_list);
955 INIT_LIST_HEAD(&card->widgets);
956 INIT_LIST_HEAD(&card->paths);
957 INIT_LIST_HEAD(&card->dapm_list);
958}
959
Peter Ujfalusi30d86ba2011-10-05 10:29:22 +0300960static inline bool snd_soc_volsw_is_stereo(struct soc_mixer_control *mc)
961{
962 if (mc->reg == mc->rreg && mc->shift == mc->rshift)
963 return 0;
964 /*
965 * mc->reg == mc->rreg && mc->shift != mc->rshift, or
966 * mc->reg != mc->rreg means that the control is
967 * stereo (bits in one register or in two registers)
968 */
969 return 1;
970}
971
Mark Brownfb257892011-04-28 10:57:54 +0100972int snd_soc_util_init(void);
973void snd_soc_util_exit(void);
974
Stephen Warrenbec4fa02011-12-12 15:55:34 -0700975int snd_soc_of_parse_card_name(struct snd_soc_card *card,
976 const char *propname);
Stephen Warrena4a54dd2011-12-12 15:55:35 -0700977int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
978 const char *propname);
Stephen Warrenbec4fa02011-12-12 15:55:34 -0700979
Mark Browna47cbe72008-07-23 14:03:07 +0100980#include <sound/soc-dai.h>
981
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700982#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +0000983extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700984#endif
985
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000986extern const struct dev_pm_ops snd_soc_pm_ops;
987
Richard Purdie808db4a2006-10-06 18:20:14 +0200988#endif