blob: 6f197589b6d7d0bcda99d8a20d52cb5188c0570a [file] [log] [blame]
Richard Purdie808db4a2006-10-06 18:20:14 +02001/*
2 * linux/sound/soc.h -- ALSA SoC Layer
3 *
4 * Author: Liam Girdwood
5 * Created: Aug 11th 2005
6 * Copyright: Wolfson Microelectronics. PLC.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef __LINUX_SND_SOC_H
14#define __LINUX_SND_SOC_H
15
16#include <linux/platform_device.h>
17#include <linux/types.h>
Mark Brownd5021ec2010-03-22 12:06:30 +000018#include <linux/notifier.h>
Andrew Morton4484bb22006-12-15 09:30:07 +010019#include <linux/workqueue.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060020#include <linux/interrupt.h>
21#include <linux/kernel.h>
Richard Purdie808db4a2006-10-06 18:20:14 +020022#include <sound/core.h>
23#include <sound/pcm.h>
24#include <sound/control.h>
25#include <sound/ac97_codec.h>
26
Richard Purdie808db4a2006-10-06 18:20:14 +020027/*
28 * Convenience kcontrol builders
29 */
Jon Smirl4eaa9812008-07-29 11:42:26 +010030#define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \
31 ((unsigned long)&(struct soc_mixer_control) \
Mark Brown762b8df2008-10-30 12:37:08 +000032 {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030033 .platform_max = xmax, .invert = xinvert})
Jon Smirl4eaa9812008-07-29 11:42:26 +010034#define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \
35 ((unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030036 {.reg = xreg, .max = xmax, .platform_max = xmax, .invert = xinvert})
Philipp Zabela7a4ac82008-01-10 14:37:42 +010037#define SOC_SINGLE(xname, reg, shift, max, invert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020038{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
39 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
40 .put = snd_soc_put_volsw, \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010041 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
42#define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \
43{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
44 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
45 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
46 .tlv.p = (tlv_array), \
47 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\
48 .put = snd_soc_put_volsw, \
49 .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) }
Jon Smirl4eaa9812008-07-29 11:42:26 +010050#define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020051{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
52 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
53 .put = snd_soc_put_volsw, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010054 .private_value = (unsigned long)&(struct soc_mixer_control) \
55 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030056 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010057#define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \
Richard Purdie808db4a2006-10-06 18:20:14 +020058{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
59 .info = snd_soc_info_volsw_2r, \
60 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010061 .private_value = (unsigned long)&(struct soc_mixer_control) \
62 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030063 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010064#define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010065{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
66 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
67 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
68 .tlv.p = (tlv_array), \
69 .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \
70 .put = snd_soc_put_volsw, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010071 .private_value = (unsigned long)&(struct soc_mixer_control) \
72 {.reg = xreg, .shift = shift_left, .rshift = shift_right,\
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030073 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010074#define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \
Philipp Zabela7a4ac82008-01-10 14:37:42 +010075{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
76 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
77 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
78 .tlv.p = (tlv_array), \
79 .info = snd_soc_info_volsw_2r, \
80 .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010081 .private_value = (unsigned long)&(struct soc_mixer_control) \
82 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030083 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirl4eaa9812008-07-29 11:42:26 +010084#define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \
Mark Browne13ac2e2008-05-28 17:58:05 +010085{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
86 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
87 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
88 .tlv.p = (tlv_array), \
89 .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \
90 .put = snd_soc_put_volsw_s8, \
Jon Smirl4eaa9812008-07-29 11:42:26 +010091 .private_value = (unsigned long)&(struct soc_mixer_control) \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +030092 {.reg = xreg, .min = xmin, .max = xmax, \
93 .platform_max = xmax} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +010094#define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \
Richard Purdie808db4a2006-10-06 18:20:14 +020095{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +010096 .max = xmax, .texts = xtexts }
97#define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \
98 SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts)
99#define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \
100{ .max = xmax, .texts = xtexts }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200101#define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \
102{ .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \
103 .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues}
104#define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \
105 SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues)
Richard Purdie808db4a2006-10-06 18:20:14 +0200106#define SOC_ENUM(xname, xenum) \
107{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
108 .info = snd_soc_info_enum_double, \
109 .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \
110 .private_value = (unsigned long)&xenum }
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200111#define SOC_VALUE_ENUM(xname, xenum) \
112{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\
Peter Ujfalusi74155552009-01-08 13:34:29 +0200113 .info = snd_soc_info_enum_double, \
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200114 .get = snd_soc_get_value_enum_double, \
115 .put = snd_soc_put_value_enum_double, \
116 .private_value = (unsigned long)&xenum }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100117#define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\
Richard Purdie808db4a2006-10-06 18:20:14 +0200118 xhandler_get, xhandler_put) \
119{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100120 .info = snd_soc_info_volsw, \
Richard Purdie808db4a2006-10-06 18:20:14 +0200121 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100122 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Daniel Mack7629ad22009-04-24 16:37:44 +0200123#define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\
124 xhandler_get, xhandler_put) \
125{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\
126 .info = snd_soc_info_volsw, \
127 .get = xhandler_get, .put = xhandler_put, \
128 .private_value = (unsigned long)&(struct soc_mixer_control) \
129 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300130 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100131#define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\
Mike Montour10144c02008-06-11 13:47:13 +0100132 xhandler_get, xhandler_put, tlv_array) \
133{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
134 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\
135 SNDRV_CTL_ELEM_ACCESS_READWRITE,\
136 .tlv.p = (tlv_array), \
137 .info = snd_soc_info_volsw, \
138 .get = xhandler_get, .put = xhandler_put, \
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100139 .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) }
Joonyoung Shimd0af93d2009-07-15 20:33:47 +0900140#define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\
141 xhandler_get, xhandler_put, tlv_array) \
142{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
143 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
144 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
145 .tlv.p = (tlv_array), \
146 .info = snd_soc_info_volsw, \
147 .get = xhandler_get, .put = xhandler_put, \
148 .private_value = (unsigned long)&(struct soc_mixer_control) \
149 {.reg = xreg, .shift = shift_left, .rshift = shift_right, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300150 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Joonyoung Shim3ce91d52009-07-15 20:33:50 +0900151#define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\
152 xhandler_get, xhandler_put, tlv_array) \
153{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
154 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
155 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
156 .tlv.p = (tlv_array), \
157 .info = snd_soc_info_volsw_2r, \
158 .get = xhandler_get, .put = xhandler_put, \
159 .private_value = (unsigned long)&(struct soc_mixer_control) \
160 {.reg = reg_left, .rreg = reg_right, .shift = xshift, \
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300161 .max = xmax, .platform_max = xmax, .invert = xinvert} }
Richard Purdie808db4a2006-10-06 18:20:14 +0200162#define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \
163{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
164 .info = snd_soc_info_bool_ext, \
165 .get = xhandler_get, .put = xhandler_put, \
166 .private_value = xdata }
167#define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \
168{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \
169 .info = snd_soc_info_enum_ext, \
170 .get = xhandler_get, .put = xhandler_put, \
171 .private_value = (unsigned long)&xenum }
172
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200173#define SOC_DOUBLE_R_SX_TLV(xname, xreg_left, xreg_right, xshift,\
174 xmin, xmax, tlv_array) \
175{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \
176 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \
177 SNDRV_CTL_ELEM_ACCESS_READWRITE, \
178 .tlv.p = (tlv_array), \
179 .info = snd_soc_info_volsw_2r_sx, \
180 .get = snd_soc_get_volsw_2r_sx, \
181 .put = snd_soc_put_volsw_2r_sx, \
182 .private_value = (unsigned long)&(struct soc_mixer_control) \
183 {.reg = xreg_left, \
184 .rreg = xreg_right, .shift = xshift, \
185 .min = xmin, .max = xmax} }
186
187
Richard Purdie808db4a2006-10-06 18:20:14 +0200188/*
Guennadi Liakhovetski6c2fb6a2010-01-21 22:04:03 +0100189 * Simplified versions of above macros, declaring a struct and calculating
190 * ARRAY_SIZE internally
191 */
192#define SOC_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xtexts) \
193 struct soc_enum name = SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, \
194 ARRAY_SIZE(xtexts), xtexts)
195#define SOC_ENUM_SINGLE_DECL(name, xreg, xshift, xtexts) \
196 SOC_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xtexts)
197#define SOC_ENUM_SINGLE_EXT_DECL(name, xtexts) \
198 struct soc_enum name = SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(xtexts), xtexts)
199#define SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift_l, xshift_r, xmask, xtexts, xvalues) \
200 struct soc_enum name = SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, \
201 ARRAY_SIZE(xtexts), xtexts, xvalues)
202#define SOC_VALUE_ENUM_SINGLE_DECL(name, xreg, xshift, xmask, xtexts, xvalues) \
203 SOC_VALUE_ENUM_DOUBLE_DECL(name, xreg, xshift, xshift, xmask, xtexts, xvalues)
204
205/*
Mark Brown0be98982008-05-19 12:31:28 +0200206 * Bias levels
207 *
208 * @ON: Bias is fully on for audio playback and capture operations.
209 * @PREPARE: Prepare for audio operations. Called before DAPM switching for
210 * stream start and stop operations.
211 * @STANDBY: Low power standby state when no playback/capture operations are
212 * in progress. NOTE: The transition time between STANDBY and ON
213 * should be as fast as possible and no longer than 10ms.
214 * @OFF: Power Off. No restrictions on transition times.
215 */
216enum snd_soc_bias_level {
Mark Brown0be98982008-05-19 12:31:28 +0200217 SND_SOC_BIAS_OFF,
Jarkko Nikula4e485412010-08-31 14:52:35 +0300218 SND_SOC_BIAS_STANDBY,
219 SND_SOC_BIAS_PREPARE,
220 SND_SOC_BIAS_ON,
Mark Brown0be98982008-05-19 12:31:28 +0200221};
222
Mark Brown8a2cd612009-01-07 17:31:10 +0000223struct snd_jack;
224struct snd_soc_card;
Richard Purdie808db4a2006-10-06 18:20:14 +0200225struct snd_soc_pcm_stream;
226struct snd_soc_ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200227struct snd_soc_pcm_runtime;
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100228struct snd_soc_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000229struct snd_soc_dai_driver;
Mark Brown12a48a8c2008-12-03 19:40:30 +0000230struct snd_soc_platform;
jassi brard273ebe2010-02-22 15:58:04 +0900231struct snd_soc_dai_link;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000232struct snd_soc_platform_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200233struct snd_soc_codec;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000234struct snd_soc_codec_driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200235struct soc_enum;
Mark Brown8a2cd612009-01-07 17:31:10 +0000236struct snd_soc_jack;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530237struct snd_soc_jack_zone;
Mark Brown8a2cd612009-01-07 17:31:10 +0000238struct snd_soc_jack_pin;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000239struct snd_soc_cache_ops;
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200240#include <sound/soc-dapm.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000241
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600242#ifdef CONFIG_GPIOLIB
243struct snd_soc_jack_gpio;
244#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200245
246typedef int (*hw_write_t)(void *,const char* ,int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200247
248extern struct snd_ac97_bus_ops soc_ac97_ops;
249
Mark Brown7084a422009-07-10 22:24:27 +0100250enum snd_soc_control_type {
251 SND_SOC_CUSTOM,
252 SND_SOC_I2C,
253 SND_SOC_SPI,
254};
255
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000256enum snd_soc_compress_type {
Dimitris Papastamos119bd782010-12-02 14:53:02 +0000257 SND_SOC_FLAT_COMPRESSION = 1,
Dimitris Papastamosa7f387d2010-11-11 10:04:59 +0000258 SND_SOC_LZO_COMPRESSION,
259 SND_SOC_RBTREE_COMPRESSION
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000260};
261
Vinod Koul70a7ca32011-01-14 19:22:48 +0530262int snd_soc_register_card(struct snd_soc_card *card);
263int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000264int snd_soc_suspend(struct device *dev);
265int snd_soc_resume(struct device *dev);
266int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000267int snd_soc_register_platform(struct device *dev,
268 struct snd_soc_platform_driver *platform_drv);
269void snd_soc_unregister_platform(struct device *dev);
270int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000271 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000272 struct snd_soc_dai_driver *dai_drv, int num_dai);
273void snd_soc_unregister_codec(struct device *dev);
Mark Brown181e0552011-01-24 14:05:25 +0000274int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
275 unsigned int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100276int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100277 int addr_bits, int data_bits,
278 enum snd_soc_control_type control);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000279int snd_soc_cache_sync(struct snd_soc_codec *codec);
280int snd_soc_cache_init(struct snd_soc_codec *codec);
281int snd_soc_cache_exit(struct snd_soc_codec *codec);
282int snd_soc_cache_write(struct snd_soc_codec *codec,
283 unsigned int reg, unsigned int value);
284int snd_soc_cache_read(struct snd_soc_codec *codec,
285 unsigned int reg, unsigned int *value);
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000286int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
287 unsigned int reg);
288int snd_soc_default_readable_register(struct snd_soc_codec *codec,
289 unsigned int reg);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000290
Mark Brown7aae8162009-11-10 16:08:04 +0000291/* Utility functions to get clock rates from various things */
292int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
293int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000294int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000295int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
296
Richard Purdie808db4a2006-10-06 18:20:14 +0200297/* set runtime hw params */
298int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
299 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200300
Mark Brown8a2cd612009-01-07 17:31:10 +0000301/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000302int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000303 struct snd_soc_jack *jack);
304void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
305int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
306 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000307void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
308 struct notifier_block *nb);
309void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
310 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530311int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
312 struct snd_soc_jack_zone *zones);
313int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600314#ifdef CONFIG_GPIOLIB
315int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
316 struct snd_soc_jack_gpio *gpios);
317void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
318 struct snd_soc_jack_gpio *gpios);
319#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000320
Richard Purdie808db4a2006-10-06 18:20:14 +0200321/* codec register bit access */
322int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300323 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000324int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
325 unsigned short reg, unsigned int mask,
326 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200327int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300328 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200329
330int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
331 struct snd_ac97_bus_ops *ops, int num);
332void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
333
334/*
335 *Controls
336 */
337struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
338 void *data, char *long_name);
Ian Molton3e8e1952009-01-09 00:23:21 +0000339int snd_soc_add_controls(struct snd_soc_codec *codec,
340 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200341int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
342 struct snd_ctl_elem_info *uinfo);
343int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
344 struct snd_ctl_elem_info *uinfo);
345int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
346 struct snd_ctl_elem_value *ucontrol);
347int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
348 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200349int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
350 struct snd_ctl_elem_value *ucontrol);
351int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
352 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200353int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
354 struct snd_ctl_elem_info *uinfo);
355int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
356 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200357#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200358int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
359 struct snd_ctl_elem_value *ucontrol);
360int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
361 struct snd_ctl_elem_value *ucontrol);
362int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
363 struct snd_ctl_elem_info *uinfo);
364int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
365 struct snd_ctl_elem_value *ucontrol);
366int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
367 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100368int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
369 struct snd_ctl_elem_info *uinfo);
370int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
371 struct snd_ctl_elem_value *ucontrol);
372int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
373 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300374int snd_soc_limit_volume(struct snd_soc_codec *codec,
375 const char *name, int max);
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200376int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
377 struct snd_ctl_elem_info *uinfo);
378int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
379 struct snd_ctl_elem_value *ucontrol);
380int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
381 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200382
Mark Brown8a2cd612009-01-07 17:31:10 +0000383/**
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000384 * struct snd_soc_reg_access - Describes whether a given register is
385 * readable, writable or volatile.
386 *
387 * @reg: the register number
388 * @read: whether this register is readable
389 * @write: whether this register is writable
390 * @vol: whether this register is volatile
391 */
392struct snd_soc_reg_access {
393 u16 reg;
394 u16 read;
395 u16 write;
396 u16 vol;
397};
398
399/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000400 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
401 *
402 * @pin: name of the pin to update
403 * @mask: bits to check for in reported jack status
404 * @invert: if non-zero then pin is enabled when status is not reported
405 */
406struct snd_soc_jack_pin {
407 struct list_head list;
408 const char *pin;
409 int mask;
410 bool invert;
411};
412
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600413/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530414 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
415 *
416 * @min_mv: start voltage in mv
417 * @max_mv: end voltage in mv
418 * @jack_type: type of jack that is expected for this voltage
419 * @debounce_time: debounce_time for jack, codec driver should wait for this
420 * duration before reading the adc for voltages
421 * @:list: list container
422 */
423struct snd_soc_jack_zone {
424 unsigned int min_mv;
425 unsigned int max_mv;
426 unsigned int jack_type;
427 unsigned int debounce_time;
428 struct list_head list;
429};
430
431/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600432 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
433 *
434 * @gpio: gpio number
435 * @name: gpio name
436 * @report: value to report when jack detected
437 * @invert: report presence in low state
438 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800439 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800440 * @jack_status_check: callback function which overrides the detection
441 * to provide more complex checks (eg, reading an
442 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600443 */
444#ifdef CONFIG_GPIOLIB
445struct snd_soc_jack_gpio {
446 unsigned int gpio;
447 const char *name;
448 int report;
449 int invert;
450 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800451 bool wake;
452
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600453 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700454 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900455
456 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600457};
458#endif
459
Mark Brown8a2cd612009-01-07 17:31:10 +0000460struct snd_soc_jack {
461 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000462 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000463 struct list_head pins;
464 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000465 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530466 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000467};
468
Richard Purdie808db4a2006-10-06 18:20:14 +0200469/* SoC PCM stream information */
470struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000471 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100472 u64 formats; /* SNDRV_PCM_FMTBIT_* */
473 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200474 unsigned int rate_min; /* min rate */
475 unsigned int rate_max; /* max rate */
476 unsigned int channels_min; /* min channels */
477 unsigned int channels_max; /* max channels */
Richard Purdie808db4a2006-10-06 18:20:14 +0200478};
479
480/* SoC audio ops */
481struct snd_soc_ops {
482 int (*startup)(struct snd_pcm_substream *);
483 void (*shutdown)(struct snd_pcm_substream *);
484 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
485 int (*hw_free)(struct snd_pcm_substream *);
486 int (*prepare)(struct snd_pcm_substream *);
487 int (*trigger)(struct snd_pcm_substream *, int);
488};
489
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000490/* SoC cache ops */
491struct snd_soc_cache_ops {
Dimitris Papastamos0d735ea2010-12-06 09:51:57 +0000492 const char *name;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000493 enum snd_soc_compress_type id;
494 int (*init)(struct snd_soc_codec *codec);
495 int (*exit)(struct snd_soc_codec *codec);
496 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
497 unsigned int *value);
498 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
499 unsigned int value);
500 int (*sync)(struct snd_soc_codec *codec);
501};
502
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000503/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200504struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000505 const char *name;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200506 const char *name_prefix;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000507 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000508 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000509 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000510
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000511 struct mutex mutex;
512 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000513 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000514 struct list_head card_list;
515 int num_dai;
Dimitris Papastamos23bbce32010-12-02 14:53:01 +0000516 enum snd_soc_compress_type compress_type;
Dimitris Papastamosaea170a2011-01-12 10:38:58 +0000517 size_t reg_size; /* reg_cache_size * reg_word_size */
Dimitris Papastamos1500b7b2011-01-13 12:20:38 +0000518 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
519 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200520
521 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200522 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
523 unsigned int active;
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000524 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000525 unsigned int suspended:1; /* Codec is in suspend PM state */
526 unsigned int probed:1; /* Codec has been probed */
527 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300528 unsigned int ac97_created:1; /* Codec has been created by SoC */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000529 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000530 unsigned int cache_init:1; /* codec cache has been initialized */
Mark Brownaaee8ef2011-01-26 20:53:50 +0000531 u32 cache_only; /* Suppress writes to hardware */
532 u32 cache_sync; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000533
534 /* codec IO */
535 void *control_data; /* codec control (i2c/3wire) data */
536 hw_write_t hw_write;
537 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Mark Brownc3acec22010-12-02 16:15:29 +0000538 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
539 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000540 void *reg_cache;
Dimitris Papastamos3335ddc2010-12-02 16:11:05 +0000541 const void *reg_def_copy;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000542 const struct snd_soc_cache_ops *cache_ops;
543 struct mutex cache_rw_mutex;
Mark Browna96ca332010-01-19 22:49:43 +0000544
Richard Purdie808db4a2006-10-06 18:20:14 +0200545 /* dapm */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200546 struct snd_soc_dapm_context dapm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200547
Mark Brown384c89e2008-12-03 17:34:03 +0000548#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300549 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000550 struct dentry *debugfs_reg;
Mark Brown79fb9382009-08-21 16:38:13 +0100551 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000552#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200553};
554
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000555/* codec driver */
556struct snd_soc_codec_driver {
557
558 /* driver ops */
559 int (*probe)(struct snd_soc_codec *);
560 int (*remove)(struct snd_soc_codec *);
561 int (*suspend)(struct snd_soc_codec *,
562 pm_message_t state);
563 int (*resume)(struct snd_soc_codec *);
564
Mark Brown89b95ac02011-03-07 16:38:44 +0000565 /* Default DAPM setup, added after probe() is run */
566 const struct snd_soc_dapm_widget *dapm_widgets;
567 int num_dapm_widgets;
568 const struct snd_soc_dapm_route *dapm_routes;
569 int num_dapm_routes;
570
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000571 /* codec IO */
572 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
573 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
574 int (*display_register)(struct snd_soc_codec *, char *,
575 size_t, unsigned int);
Dimitris Papastamosd4754ec2011-01-13 12:20:37 +0000576 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
577 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000578 short reg_cache_size;
579 short reg_cache_step;
580 short reg_word_size;
581 const void *reg_cache_default;
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000582 short reg_access_size;
583 const struct snd_soc_reg_access *reg_access_default;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000584 enum snd_soc_compress_type compress_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000585
586 /* codec bias level */
587 int (*set_bias_level)(struct snd_soc_codec *,
588 enum snd_soc_bias_level level);
Mark Brown474b62d2011-01-18 16:14:44 +0000589
590 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000591 enum snd_soc_dapm_type, int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200592};
593
594/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000595struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200596
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000597 int (*probe)(struct snd_soc_platform *);
598 int (*remove)(struct snd_soc_platform *);
599 int (*suspend)(struct snd_soc_dai *dai);
600 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200601
602 /* pcm creation and destruction */
Liam Girdwood3c4b2662008-07-07 16:07:17 +0100603 int (*pcm_new)(struct snd_card *, struct snd_soc_dai *,
Richard Purdie808db4a2006-10-06 18:20:14 +0200604 struct snd_pcm *);
605 void (*pcm_free)(struct snd_pcm *);
606
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200607 /*
608 * For platform caused delay reporting.
609 * Optional.
610 */
611 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
612 struct snd_soc_dai *);
613
Richard Purdie808db4a2006-10-06 18:20:14 +0200614 /* platform stream ops */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000615 struct snd_pcm_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200616};
617
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000618struct snd_soc_platform {
619 const char *name;
620 int id;
621 struct device *dev;
622 struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200623
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000624 unsigned int suspended:1; /* platform is suspended */
625 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100626
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000627 struct snd_soc_card *card;
628 struct list_head list;
629 struct list_head card_list;
630};
Richard Purdie808db4a2006-10-06 18:20:14 +0200631
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000632struct snd_soc_dai_link {
633 /* config - must be set by machine driver */
634 const char *name; /* Codec name */
635 const char *stream_name; /* Stream name */
636 const char *codec_name; /* for multi-codec */
637 const char *platform_name; /* for multi-platform */
638 const char *cpu_dai_name;
639 const char *codec_dai_name;
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100640
Mark Brown3efab7d2010-05-09 13:25:43 +0100641 /* Keep DAI active over suspend */
642 unsigned int ignore_suspend:1;
643
Mark Brown06f409d2009-04-07 18:10:13 +0100644 /* Symmetry requirements */
645 unsigned int symmetric_rates:1;
646
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000647 /* codec/machine specific init - e.g. add machine controls */
648 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100649
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000650 /* machine stream operations */
651 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200652};
653
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000654struct snd_soc_codec_conf {
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200655 const char *dev_name;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000656
657 /*
658 * optional map of kcontrol, widget and path name prefixes that are
659 * associated per device
660 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200661 const char *name_prefix;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000662
663 /*
664 * set this to the desired compression type if you want to
665 * override the one supplied in codec->driver->compress_type
666 */
667 enum snd_soc_compress_type compress_type;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200668};
669
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200670struct snd_soc_aux_dev {
671 const char *name; /* Codec name */
672 const char *codec_name; /* for multi-codec */
673
674 /* codec/machine specific init - e.g. add machine controls */
675 int (*init)(struct snd_soc_dapm_context *dapm);
676};
677
Mark Brown87506542008-11-18 20:50:34 +0000678/* SoC card */
679struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000680 const char *name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000681 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000682 struct snd_card *snd_card;
683 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000684
685 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000686 struct mutex mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000687
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000688 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200689
Mark Browne7361ec2011-01-26 14:17:20 +0000690 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +0000691 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +0000692 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200693
694 /* the pre and post PM functions are used to do any PM work before and
695 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +0000696 int (*suspend_pre)(struct snd_soc_card *card);
697 int (*suspend_post)(struct snd_soc_card *card);
698 int (*resume_pre)(struct snd_soc_card *card);
699 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200700
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100701 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000702 int (*set_bias_level)(struct snd_soc_card *,
Mark Brown0be98982008-05-19 12:31:28 +0200703 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +0000704 int (*set_bias_level_post)(struct snd_soc_card *,
705 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100706
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000707 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000708
Richard Purdie808db4a2006-10-06 18:20:14 +0200709 /* CPU <--> Codec DAI links */
710 struct snd_soc_dai_link *dai_link;
711 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000712 struct snd_soc_pcm_runtime *rtd;
713 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000714
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000715 /* optional codec specific configuration */
716 struct snd_soc_codec_conf *codec_conf;
717 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200718
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200719 /*
720 * optional auxiliary devices such as amplifiers or codecs with DAI
721 * link unused
722 */
723 struct snd_soc_aux_dev *aux_dev;
724 int num_aux_devs;
725 struct snd_soc_pcm_runtime *rtd_aux;
726 int num_aux_rtd;
727
Mark Brownb8ad29d2011-03-02 18:35:51 +0000728 /*
729 * Card-specific routes and widgets.
730 */
731 struct snd_soc_dapm_widget *dapm_widgets;
732 int num_dapm_widgets;
733 struct snd_soc_dapm_route *dapm_routes;
734 int num_dapm_routes;
735
Mark Brown63084192008-12-02 15:08:03 +0000736 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000737
738 /* lists of probed devices belonging to this card */
739 struct list_head codec_dev_list;
740 struct list_head platform_dev_list;
741 struct list_head dai_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200742
Jarkko Nikula97c866d2010-12-14 12:18:31 +0200743 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200744 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200745 struct list_head dapm_list;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200746
Mark Browne37a4972011-03-02 18:21:57 +0000747 /* Generic DAPM context for the card */
748 struct snd_soc_dapm_context dapm;
749
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200750#ifdef CONFIG_DEBUG_FS
751 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200752 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200753#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200754 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +0000755
756 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +0200757};
758
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000759/* SoC machine DAI configuration, glues a codec and cpu DAI together */
760struct snd_soc_pcm_runtime {
761 struct device dev;
Mark Brown87506542008-11-18 20:50:34 +0000762 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000763 struct snd_soc_dai_link *dai_link;
Richard Purdie808db4a2006-10-06 18:20:14 +0200764
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000765 unsigned int complete:1;
766 unsigned int dev_registered:1;
767
768 /* Symmetry data - only valid if symmetry is being enforced */
769 unsigned int rate;
770 long pmdown_time;
771
772 /* runtime devices */
773 struct snd_pcm *pcm;
774 struct snd_soc_codec *codec;
775 struct snd_soc_platform *platform;
776 struct snd_soc_dai *codec_dai;
777 struct snd_soc_dai *cpu_dai;
778
779 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200780};
781
Jon Smirl4eaa9812008-07-29 11:42:26 +0100782/* mixer control */
783struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300784 int min, max, platform_max;
Jon Smirl815ecf8d2008-07-29 10:22:24 -0400785 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100786};
787
Richard Purdie808db4a2006-10-06 18:20:14 +0200788/* enumerated kcontrol */
789struct soc_enum {
790 unsigned short reg;
791 unsigned short reg2;
792 unsigned char shift_l;
793 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100794 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200795 unsigned int mask;
796 const char **texts;
797 const unsigned int *values;
798 void *dapm;
799};
800
Mark Brown5c82f562009-05-22 09:41:30 +0100801/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -0400802unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
803unsigned int snd_soc_write(struct snd_soc_codec *codec,
804 unsigned int reg, unsigned int val);
Mark Brown5c82f562009-05-22 09:41:30 +0100805
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000806/* device driver data */
807
Mark Browndddf3e42011-01-28 13:11:47 +0000808static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
809 void *data)
810{
811 card->drvdata = data;
812}
813
814static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
815{
816 return card->drvdata;
817}
818
Mark Brownb2c812e2010-04-14 15:35:19 +0900819static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000820 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +0900821{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000822 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +0900823}
824
825static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
826{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000827 return dev_get_drvdata(codec->dev);
828}
829
830static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
831 void *data)
832{
833 dev_set_drvdata(platform->dev, data);
834}
835
836static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
837{
838 return dev_get_drvdata(platform->dev);
839}
840
841static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
842 void *data)
843{
844 dev_set_drvdata(&rtd->dev, data);
845}
846
847static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
848{
849 return dev_get_drvdata(&rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +0900850}
851
Vinod Koul4e10bda2011-01-13 22:48:52 +0530852static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
853{
854 INIT_LIST_HEAD(&card->dai_dev_list);
855 INIT_LIST_HEAD(&card->codec_dev_list);
856 INIT_LIST_HEAD(&card->platform_dev_list);
857 INIT_LIST_HEAD(&card->widgets);
858 INIT_LIST_HEAD(&card->paths);
859 INIT_LIST_HEAD(&card->dapm_list);
860}
861
Mark Browna47cbe72008-07-23 14:03:07 +0100862#include <sound/soc-dai.h>
863
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700864#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +0000865extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700866#endif
867
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000868extern const struct dev_pm_ops snd_soc_pm_ops;
869
Richard Purdie808db4a2006-10-06 18:20:14 +0200870#endif