blob: ed4929859e31ecff628dd19fc8d54a981d4e6083 [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 {
Mark Browne9c03902011-06-13 19:05:58 +0100251 SND_SOC_I2C = 1,
Mark Brown7084a422009-07-10 22:24:27 +0100252 SND_SOC_SPI,
253};
254
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000255enum snd_soc_compress_type {
Dimitris Papastamos119bd782010-12-02 14:53:02 +0000256 SND_SOC_FLAT_COMPRESSION = 1,
Dimitris Papastamosa7f387d2010-11-11 10:04:59 +0000257 SND_SOC_LZO_COMPRESSION,
258 SND_SOC_RBTREE_COMPRESSION
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000259};
260
Mark Brownec4ee522011-03-07 20:58:11 +0000261int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
262 unsigned int freq, int dir);
263int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
264 unsigned int freq_in, unsigned int freq_out);
265
Vinod Koul70a7ca32011-01-14 19:22:48 +0530266int snd_soc_register_card(struct snd_soc_card *card);
267int snd_soc_unregister_card(struct snd_soc_card *card);
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000268int snd_soc_suspend(struct device *dev);
269int snd_soc_resume(struct device *dev);
270int snd_soc_poweroff(struct device *dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000271int snd_soc_register_platform(struct device *dev,
272 struct snd_soc_platform_driver *platform_drv);
273void snd_soc_unregister_platform(struct device *dev);
274int snd_soc_register_codec(struct device *dev,
Mark Brown001ae4c2010-12-02 16:21:08 +0000275 const struct snd_soc_codec_driver *codec_drv,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000276 struct snd_soc_dai_driver *dai_drv, int num_dai);
277void snd_soc_unregister_codec(struct device *dev);
Mark Brown181e0552011-01-24 14:05:25 +0000278int snd_soc_codec_volatile_register(struct snd_soc_codec *codec,
279 unsigned int reg);
Dimitris Papastamos239c9702011-03-24 13:45:18 +0000280int snd_soc_codec_readable_register(struct snd_soc_codec *codec,
281 unsigned int reg);
282int snd_soc_codec_writable_register(struct snd_soc_codec *codec,
283 unsigned int reg);
Mark Brown17a52fd2009-07-05 17:24:50 +0100284int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec,
Mark Brown7084a422009-07-10 22:24:27 +0100285 int addr_bits, int data_bits,
286 enum snd_soc_control_type control);
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000287int snd_soc_cache_sync(struct snd_soc_codec *codec);
288int snd_soc_cache_init(struct snd_soc_codec *codec);
289int snd_soc_cache_exit(struct snd_soc_codec *codec);
290int snd_soc_cache_write(struct snd_soc_codec *codec,
291 unsigned int reg, unsigned int value);
292int snd_soc_cache_read(struct snd_soc_codec *codec,
293 unsigned int reg, unsigned int *value);
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000294int snd_soc_default_volatile_register(struct snd_soc_codec *codec,
295 unsigned int reg);
296int snd_soc_default_readable_register(struct snd_soc_codec *codec,
297 unsigned int reg);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000298int snd_soc_default_writable_register(struct snd_soc_codec *codec,
299 unsigned int reg);
Mark Brown12a48a8c2008-12-03 19:40:30 +0000300
Mark Brown7aae8162009-11-10 16:08:04 +0000301/* Utility functions to get clock rates from various things */
302int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
303int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
Mark Brownc0fa59d2009-11-19 11:36:10 +0000304int snd_soc_calc_bclk(int fs, int sample_size, int channels, int tdm_slots);
Mark Brown7aae8162009-11-10 16:08:04 +0000305int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms);
306
Richard Purdie808db4a2006-10-06 18:20:14 +0200307/* set runtime hw params */
308int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream,
309 const struct snd_pcm_hardware *hw);
Richard Purdie808db4a2006-10-06 18:20:14 +0200310
Mark Brown8a2cd612009-01-07 17:31:10 +0000311/* Jack reporting */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000312int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +0000313 struct snd_soc_jack *jack);
314void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask);
315int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
316 struct snd_soc_jack_pin *pins);
Mark Brownd5021ec2010-03-22 12:06:30 +0000317void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
318 struct notifier_block *nb);
319void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
320 struct notifier_block *nb);
Vinod Koulfa9879e2011-02-09 14:44:17 +0530321int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
322 struct snd_soc_jack_zone *zones);
323int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600324#ifdef CONFIG_GPIOLIB
325int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
326 struct snd_soc_jack_gpio *gpios);
327void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
328 struct snd_soc_jack_gpio *gpios);
329#endif
Mark Brown8a2cd612009-01-07 17:31:10 +0000330
Richard Purdie808db4a2006-10-06 18:20:14 +0200331/* codec register bit access */
332int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300333 unsigned int mask, unsigned int value);
Mark Browndd1b3d52009-12-04 14:22:03 +0000334int snd_soc_update_bits_locked(struct snd_soc_codec *codec,
335 unsigned short reg, unsigned int mask,
336 unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200337int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg,
Daniel Ribeiro46f58222009-06-07 02:49:11 -0300338 unsigned int mask, unsigned int value);
Richard Purdie808db4a2006-10-06 18:20:14 +0200339
340int snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
341 struct snd_ac97_bus_ops *ops, int num);
342void snd_soc_free_ac97_codec(struct snd_soc_codec *codec);
343
344/*
345 *Controls
346 */
347struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
Mark Brownefb7ac32011-03-08 17:23:24 +0000348 void *data, char *long_name,
349 const char *prefix);
Ian Molton3e8e1952009-01-09 00:23:21 +0000350int snd_soc_add_controls(struct snd_soc_codec *codec,
351 const struct snd_kcontrol_new *controls, int num_controls);
Richard Purdie808db4a2006-10-06 18:20:14 +0200352int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol,
353 struct snd_ctl_elem_info *uinfo);
354int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol,
355 struct snd_ctl_elem_info *uinfo);
356int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol,
357 struct snd_ctl_elem_value *ucontrol);
358int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol,
359 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200360int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol,
361 struct snd_ctl_elem_value *ucontrol);
362int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol,
363 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200364int snd_soc_info_volsw(struct snd_kcontrol *kcontrol,
365 struct snd_ctl_elem_info *uinfo);
366int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol,
367 struct snd_ctl_elem_info *uinfo);
Philipp Zabel392abe92008-05-13 14:03:40 +0200368#define snd_soc_info_bool_ext snd_ctl_boolean_mono_info
Richard Purdie808db4a2006-10-06 18:20:14 +0200369int snd_soc_get_volsw(struct snd_kcontrol *kcontrol,
370 struct snd_ctl_elem_value *ucontrol);
371int snd_soc_put_volsw(struct snd_kcontrol *kcontrol,
372 struct snd_ctl_elem_value *ucontrol);
373int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol,
374 struct snd_ctl_elem_info *uinfo);
375int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol,
376 struct snd_ctl_elem_value *ucontrol);
377int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol,
378 struct snd_ctl_elem_value *ucontrol);
Mark Browne13ac2e2008-05-28 17:58:05 +0100379int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol,
380 struct snd_ctl_elem_info *uinfo);
381int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol,
382 struct snd_ctl_elem_value *ucontrol);
383int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol,
384 struct snd_ctl_elem_value *ucontrol);
Peter Ujfalusi637d3842010-05-07 14:05:49 +0300385int snd_soc_limit_volume(struct snd_soc_codec *codec,
386 const char *name, int max);
apatard@mandriva.comb6f4bb32010-05-15 17:30:01 +0200387int snd_soc_info_volsw_2r_sx(struct snd_kcontrol *kcontrol,
388 struct snd_ctl_elem_info *uinfo);
389int snd_soc_get_volsw_2r_sx(struct snd_kcontrol *kcontrol,
390 struct snd_ctl_elem_value *ucontrol);
391int snd_soc_put_volsw_2r_sx(struct snd_kcontrol *kcontrol,
392 struct snd_ctl_elem_value *ucontrol);
Richard Purdie808db4a2006-10-06 18:20:14 +0200393
Mark Brown8a2cd612009-01-07 17:31:10 +0000394/**
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000395 * struct snd_soc_reg_access - Describes whether a given register is
396 * readable, writable or volatile.
397 *
398 * @reg: the register number
399 * @read: whether this register is readable
400 * @write: whether this register is writable
401 * @vol: whether this register is volatile
402 */
403struct snd_soc_reg_access {
404 u16 reg;
405 u16 read;
406 u16 write;
407 u16 vol;
408};
409
410/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000411 * struct snd_soc_jack_pin - Describes a pin to update based on jack detection
412 *
413 * @pin: name of the pin to update
414 * @mask: bits to check for in reported jack status
415 * @invert: if non-zero then pin is enabled when status is not reported
416 */
417struct snd_soc_jack_pin {
418 struct list_head list;
419 const char *pin;
420 int mask;
421 bool invert;
422};
423
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600424/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530425 * struct snd_soc_jack_zone - Describes voltage zones of jack detection
426 *
427 * @min_mv: start voltage in mv
428 * @max_mv: end voltage in mv
429 * @jack_type: type of jack that is expected for this voltage
430 * @debounce_time: debounce_time for jack, codec driver should wait for this
431 * duration before reading the adc for voltages
432 * @:list: list container
433 */
434struct snd_soc_jack_zone {
435 unsigned int min_mv;
436 unsigned int max_mv;
437 unsigned int jack_type;
438 unsigned int debounce_time;
439 struct list_head list;
440};
441
442/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600443 * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection
444 *
445 * @gpio: gpio number
446 * @name: gpio name
447 * @report: value to report when jack detected
448 * @invert: report presence in low state
449 * @debouce_time: debouce time in ms
Mark Brown7887ab32011-02-17 16:35:55 -0800450 * @wake: enable as wake source
Mark Brownfadddc82011-02-17 16:41:42 -0800451 * @jack_status_check: callback function which overrides the detection
452 * to provide more complex checks (eg, reading an
453 * ADC).
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600454 */
455#ifdef CONFIG_GPIOLIB
456struct snd_soc_jack_gpio {
457 unsigned int gpio;
458 const char *name;
459 int report;
460 int invert;
461 int debounce_time;
Mark Brown7887ab32011-02-17 16:35:55 -0800462 bool wake;
463
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600464 struct snd_soc_jack *jack;
Mark Brown4c14d782010-10-06 15:54:28 -0700465 struct delayed_work work;
Joonyoung Shimc871a052009-11-12 17:14:04 +0900466
467 int (*jack_status_check)(void);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600468};
469#endif
470
Mark Brown8a2cd612009-01-07 17:31:10 +0000471struct snd_soc_jack {
472 struct snd_jack *jack;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000473 struct snd_soc_codec *codec;
Mark Brown8a2cd612009-01-07 17:31:10 +0000474 struct list_head pins;
475 int status;
Mark Brownd5021ec2010-03-22 12:06:30 +0000476 struct blocking_notifier_head notifier;
Vinod Koulfa9879e2011-02-09 14:44:17 +0530477 struct list_head jack_zones;
Mark Brown8a2cd612009-01-07 17:31:10 +0000478};
479
Richard Purdie808db4a2006-10-06 18:20:14 +0200480/* SoC PCM stream information */
481struct snd_soc_pcm_stream {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000482 const char *stream_name;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100483 u64 formats; /* SNDRV_PCM_FMTBIT_* */
484 unsigned int rates; /* SNDRV_PCM_RATE_* */
Richard Purdie808db4a2006-10-06 18:20:14 +0200485 unsigned int rate_min; /* min rate */
486 unsigned int rate_max; /* max rate */
487 unsigned int channels_min; /* min channels */
488 unsigned int channels_max; /* max channels */
Richard Purdie808db4a2006-10-06 18:20:14 +0200489};
490
491/* SoC audio ops */
492struct snd_soc_ops {
493 int (*startup)(struct snd_pcm_substream *);
494 void (*shutdown)(struct snd_pcm_substream *);
495 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
496 int (*hw_free)(struct snd_pcm_substream *);
497 int (*prepare)(struct snd_pcm_substream *);
498 int (*trigger)(struct snd_pcm_substream *, int);
499};
500
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000501/* SoC cache ops */
502struct snd_soc_cache_ops {
Dimitris Papastamos0d735ea2010-12-06 09:51:57 +0000503 const char *name;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000504 enum snd_soc_compress_type id;
505 int (*init)(struct snd_soc_codec *codec);
506 int (*exit)(struct snd_soc_codec *codec);
507 int (*read)(struct snd_soc_codec *codec, unsigned int reg,
508 unsigned int *value);
509 int (*write)(struct snd_soc_codec *codec, unsigned int reg,
510 unsigned int value);
511 int (*sync)(struct snd_soc_codec *codec);
512};
513
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000514/* SoC Audio Codec device */
Richard Purdie808db4a2006-10-06 18:20:14 +0200515struct snd_soc_codec {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000516 const char *name;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200517 const char *name_prefix;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000518 int id;
Mark Brown0d0cf002008-12-10 14:32:45 +0000519 struct device *dev;
Mark Brown001ae4c2010-12-02 16:21:08 +0000520 const struct snd_soc_codec_driver *driver;
Mark Brown0d0cf002008-12-10 14:32:45 +0000521
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000522 struct mutex mutex;
523 struct snd_soc_card *card;
Mark Brown0d0cf002008-12-10 14:32:45 +0000524 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000525 struct list_head card_list;
526 int num_dai;
Dimitris Papastamos23bbce32010-12-02 14:53:01 +0000527 enum snd_soc_compress_type compress_type;
Dimitris Papastamosaea170a2011-01-12 10:38:58 +0000528 size_t reg_size; /* reg_cache_size * reg_word_size */
Dimitris Papastamos1500b7b2011-01-13 12:20:38 +0000529 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
530 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000531 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Richard Purdie808db4a2006-10-06 18:20:14 +0200532
533 /* runtime */
Richard Purdie808db4a2006-10-06 18:20:14 +0200534 struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */
535 unsigned int active;
Dimitris Papastamosdad8e7a2011-01-19 14:53:36 +0000536 unsigned int cache_bypass:1; /* Suppress access to the cache */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000537 unsigned int suspended:1; /* Codec is in suspend PM state */
538 unsigned int probed:1; /* Codec has been probed */
539 unsigned int ac97_registered:1; /* Codec has been AC97 registered */
Mika Westerberg0562f782010-10-13 11:30:32 +0300540 unsigned int ac97_created:1; /* Codec has been created by SoC */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000541 unsigned int sysfs_registered:1; /* codec has been sysfs registered */
Dimitris Papastamosfdf0f542010-12-02 16:11:06 +0000542 unsigned int cache_init:1; /* codec cache has been initialized */
Mark Brownaaee8ef2011-01-26 20:53:50 +0000543 u32 cache_only; /* Suppress writes to hardware */
544 u32 cache_sync; /* Cache needs to be synced to hardware */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000545
546 /* codec IO */
547 void *control_data; /* codec control (i2c/3wire) data */
Dimitris Papastamos67850a82011-03-22 10:36:57 +0000548 enum snd_soc_control_type control_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000549 hw_write_t hw_write;
550 unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int);
Mark Brownc3acec22010-12-02 16:15:29 +0000551 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
552 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000553 int (*bulk_write_raw)(struct snd_soc_codec *, unsigned int, const void *, size_t);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000554 void *reg_cache;
Dimitris Papastamos3335ddc2010-12-02 16:11:05 +0000555 const void *reg_def_copy;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000556 const struct snd_soc_cache_ops *cache_ops;
557 struct mutex cache_rw_mutex;
Mark Browna96ca332010-01-19 22:49:43 +0000558
Richard Purdie808db4a2006-10-06 18:20:14 +0200559 /* dapm */
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200560 struct snd_soc_dapm_context dapm;
Richard Purdie808db4a2006-10-06 18:20:14 +0200561
Mark Brown384c89e2008-12-03 17:34:03 +0000562#ifdef CONFIG_DEBUG_FS
Peter Ujfalusi88439ac2009-10-01 10:32:47 +0300563 struct dentry *debugfs_codec_root;
Mark Brown384c89e2008-12-03 17:34:03 +0000564 struct dentry *debugfs_reg;
Mark Brown79fb9382009-08-21 16:38:13 +0100565 struct dentry *debugfs_dapm;
Mark Brown384c89e2008-12-03 17:34:03 +0000566#endif
Richard Purdie808db4a2006-10-06 18:20:14 +0200567};
568
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000569/* codec driver */
570struct snd_soc_codec_driver {
571
572 /* driver ops */
573 int (*probe)(struct snd_soc_codec *);
574 int (*remove)(struct snd_soc_codec *);
575 int (*suspend)(struct snd_soc_codec *,
576 pm_message_t state);
577 int (*resume)(struct snd_soc_codec *);
578
Mark Brownb7af1da2011-04-07 19:18:44 +0900579 /* Default control and setup, added after probe() is run */
580 const struct snd_kcontrol_new *controls;
581 int num_controls;
Mark Brown89b95ac2011-03-07 16:38:44 +0000582 const struct snd_soc_dapm_widget *dapm_widgets;
583 int num_dapm_widgets;
584 const struct snd_soc_dapm_route *dapm_routes;
585 int num_dapm_routes;
586
Mark Brownec4ee522011-03-07 20:58:11 +0000587 /* codec wide operations */
588 int (*set_sysclk)(struct snd_soc_codec *codec,
589 int clk_id, unsigned int freq, int dir);
590 int (*set_pll)(struct snd_soc_codec *codec, int pll_id, int source,
591 unsigned int freq_in, unsigned int freq_out);
592
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000593 /* codec IO */
594 unsigned int (*read)(struct snd_soc_codec *, unsigned int);
595 int (*write)(struct snd_soc_codec *, unsigned int, unsigned int);
596 int (*display_register)(struct snd_soc_codec *, char *,
597 size_t, unsigned int);
Dimitris Papastamosd4754ec2011-01-13 12:20:37 +0000598 int (*volatile_register)(struct snd_soc_codec *, unsigned int);
599 int (*readable_register)(struct snd_soc_codec *, unsigned int);
Dimitris Papastamos80204542011-03-24 13:45:17 +0000600 int (*writable_register)(struct snd_soc_codec *, unsigned int);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000601 short reg_cache_size;
602 short reg_cache_step;
603 short reg_word_size;
604 const void *reg_cache_default;
Dimitris Papastamos066d16c2011-01-13 12:20:36 +0000605 short reg_access_size;
606 const struct snd_soc_reg_access *reg_access_default;
Dimitris Papastamos7a30a3d2010-11-11 10:04:57 +0000607 enum snd_soc_compress_type compress_type;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000608
609 /* codec bias level */
610 int (*set_bias_level)(struct snd_soc_codec *,
611 enum snd_soc_bias_level level);
Mark Brown474b62d2011-01-18 16:14:44 +0000612
613 void (*seq_notifier)(struct snd_soc_dapm_context *,
Mark Brownf85a9e02011-01-26 21:41:28 +0000614 enum snd_soc_dapm_type, int);
Liam Girdwood02184082011-03-30 23:26:53 +0100615
616 /* probe ordering - for components with runtime dependencies */
617 bool late_probe;
618 bool early_remove;
Richard Purdie808db4a2006-10-06 18:20:14 +0200619};
620
621/* SoC platform interface */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000622struct snd_soc_platform_driver {
Richard Purdie808db4a2006-10-06 18:20:14 +0200623
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000624 int (*probe)(struct snd_soc_platform *);
625 int (*remove)(struct snd_soc_platform *);
626 int (*suspend)(struct snd_soc_dai *dai);
627 int (*resume)(struct snd_soc_dai *dai);
Richard Purdie808db4a2006-10-06 18:20:14 +0200628
629 /* pcm creation and destruction */
Liam Girdwoodc6ac9842011-02-04 22:12:30 +0000630 int (*pcm_new)(struct snd_soc_pcm_runtime *);
Richard Purdie808db4a2006-10-06 18:20:14 +0200631 void (*pcm_free)(struct snd_pcm *);
632
Peter Ujfalusi258020d2010-03-03 15:08:07 +0200633 /*
634 * For platform caused delay reporting.
635 * Optional.
636 */
637 snd_pcm_sframes_t (*delay)(struct snd_pcm_substream *,
638 struct snd_soc_dai *);
639
Richard Purdie808db4a2006-10-06 18:20:14 +0200640 /* platform stream ops */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000641 struct snd_pcm_ops *ops;
Liam Girdwood02184082011-03-30 23:26:53 +0100642
643 /* probe ordering - for components with runtime dependencies */
644 bool late_probe;
645 bool early_remove;
Richard Purdie808db4a2006-10-06 18:20:14 +0200646};
647
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000648struct snd_soc_platform {
649 const char *name;
650 int id;
651 struct device *dev;
652 struct snd_soc_platform_driver *driver;
Richard Purdie808db4a2006-10-06 18:20:14 +0200653
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000654 unsigned int suspended:1; /* platform is suspended */
655 unsigned int probed:1;
Graeme Gregory1c433fb2007-02-02 17:13:05 +0100656
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000657 struct snd_soc_card *card;
658 struct list_head list;
659 struct list_head card_list;
660};
Richard Purdie808db4a2006-10-06 18:20:14 +0200661
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000662struct snd_soc_dai_link {
663 /* config - must be set by machine driver */
664 const char *name; /* Codec name */
665 const char *stream_name; /* Stream name */
666 const char *codec_name; /* for multi-codec */
667 const char *platform_name; /* for multi-platform */
668 const char *cpu_dai_name;
669 const char *codec_dai_name;
Liam Girdwood4ccab3e2008-01-10 14:39:01 +0100670
Mark Brown3efab7d2010-05-09 13:25:43 +0100671 /* Keep DAI active over suspend */
672 unsigned int ignore_suspend:1;
673
Mark Brown06f409d2009-04-07 18:10:13 +0100674 /* Symmetry requirements */
675 unsigned int symmetric_rates:1;
676
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000677 /* codec/machine specific init - e.g. add machine controls */
678 int (*init)(struct snd_soc_pcm_runtime *rtd);
Mark Brown06f409d2009-04-07 18:10:13 +0100679
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000680 /* machine stream operations */
681 struct snd_soc_ops *ops;
Richard Purdie808db4a2006-10-06 18:20:14 +0200682};
683
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000684struct snd_soc_codec_conf {
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200685 const char *dev_name;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000686
687 /*
688 * optional map of kcontrol, widget and path name prefixes that are
689 * associated per device
690 */
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200691 const char *name_prefix;
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000692
693 /*
694 * set this to the desired compression type if you want to
695 * override the one supplied in codec->driver->compress_type
696 */
697 enum snd_soc_compress_type compress_type;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200698};
699
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200700struct snd_soc_aux_dev {
701 const char *name; /* Codec name */
702 const char *codec_name; /* for multi-codec */
703
704 /* codec/machine specific init - e.g. add machine controls */
705 int (*init)(struct snd_soc_dapm_context *dapm);
706};
707
Mark Brown87506542008-11-18 20:50:34 +0000708/* SoC card */
709struct snd_soc_card {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000710 const char *name;
Liam Girdwood22de71b2011-05-12 16:14:04 +0100711 const char *long_name;
712 const char *driver_name;
Mark Brownc5af3a22008-11-28 13:29:45 +0000713 struct device *dev;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000714 struct snd_card *snd_card;
715 struct module *owner;
Mark Brownc5af3a22008-11-28 13:29:45 +0000716
717 struct list_head list;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000718 struct mutex mutex;
Mark Brownc5af3a22008-11-28 13:29:45 +0000719
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000720 bool instantiated;
Richard Purdie808db4a2006-10-06 18:20:14 +0200721
Mark Browne7361ec2011-01-26 14:17:20 +0000722 int (*probe)(struct snd_soc_card *card);
Mark Brown28e9ad92011-03-02 18:36:34 +0000723 int (*late_probe)(struct snd_soc_card *card);
Mark Browne7361ec2011-01-26 14:17:20 +0000724 int (*remove)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200725
726 /* the pre and post PM functions are used to do any PM work before and
727 * after the codec and DAI's do any PM work. */
Mark Brown70b2ac12011-01-26 14:05:25 +0000728 int (*suspend_pre)(struct snd_soc_card *card);
729 int (*suspend_post)(struct snd_soc_card *card);
730 int (*resume_pre)(struct snd_soc_card *card);
731 int (*resume_post)(struct snd_soc_card *card);
Richard Purdie808db4a2006-10-06 18:20:14 +0200732
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100733 /* callbacks */
Mark Brown87506542008-11-18 20:50:34 +0000734 int (*set_bias_level)(struct snd_soc_card *,
Mark Brown0be98982008-05-19 12:31:28 +0200735 enum snd_soc_bias_level level);
Mark Brown1badabd2010-12-04 12:41:04 +0000736 int (*set_bias_level_post)(struct snd_soc_card *,
737 enum snd_soc_bias_level level);
Liam Girdwood0b4d2212008-01-10 14:36:20 +0100738
Mark Brown6c5f1fe2010-02-17 14:30:44 +0000739 long pmdown_time;
Mark Brown96dd3622010-02-12 11:05:44 +0000740
Richard Purdie808db4a2006-10-06 18:20:14 +0200741 /* CPU <--> Codec DAI links */
742 struct snd_soc_dai_link *dai_link;
743 int num_links;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000744 struct snd_soc_pcm_runtime *rtd;
745 int num_rtd;
Mark Brown63084192008-12-02 15:08:03 +0000746
Dimitris Papastamosff819b82010-12-02 14:53:03 +0000747 /* optional codec specific configuration */
748 struct snd_soc_codec_conf *codec_conf;
749 int num_configs;
Jarkko Nikulaead9b912010-11-13 20:40:44 +0200750
Jarkko Nikula2eea3922010-11-25 17:47:38 +0200751 /*
752 * optional auxiliary devices such as amplifiers or codecs with DAI
753 * link unused
754 */
755 struct snd_soc_aux_dev *aux_dev;
756 int num_aux_devs;
757 struct snd_soc_pcm_runtime *rtd_aux;
758 int num_aux_rtd;
759
Mark Brownb7af1da2011-04-07 19:18:44 +0900760 const struct snd_kcontrol_new *controls;
761 int num_controls;
762
Mark Brownb8ad29d2011-03-02 18:35:51 +0000763 /*
764 * Card-specific routes and widgets.
765 */
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200766 const struct snd_soc_dapm_widget *dapm_widgets;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000767 int num_dapm_widgets;
Lars-Peter Clausend06e48d2011-04-12 19:31:01 +0200768 const struct snd_soc_dapm_route *dapm_routes;
Mark Brownb8ad29d2011-03-02 18:35:51 +0000769 int num_dapm_routes;
770
Mark Brown63084192008-12-02 15:08:03 +0000771 struct work_struct deferred_resume_work;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000772
773 /* lists of probed devices belonging to this card */
774 struct list_head codec_dev_list;
775 struct list_head platform_dev_list;
776 struct list_head dai_dev_list;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200777
Jarkko Nikula97c866d2010-12-14 12:18:31 +0200778 struct list_head widgets;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200779 struct list_head paths;
Jarkko Nikula7be31be82010-12-14 12:18:32 +0200780 struct list_head dapm_list;
Jarkko Nikula8ddab3f2010-12-14 12:18:30 +0200781
Mark Browne37a4972011-03-02 18:21:57 +0000782 /* Generic DAPM context for the card */
783 struct snd_soc_dapm_context dapm;
784
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200785#ifdef CONFIG_DEBUG_FS
786 struct dentry *debugfs_card_root;
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200787 struct dentry *debugfs_pop_time;
Jarkko Nikulaa6052152010-11-05 20:35:19 +0200788#endif
Jarkko Nikula3a45b862010-11-05 20:35:21 +0200789 u32 pop_time;
Mark Browndddf3e42011-01-28 13:11:47 +0000790
791 void *drvdata;
Richard Purdie808db4a2006-10-06 18:20:14 +0200792};
793
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000794/* SoC machine DAI configuration, glues a codec and cpu DAI together */
795struct snd_soc_pcm_runtime {
796 struct device dev;
Mark Brown87506542008-11-18 20:50:34 +0000797 struct snd_soc_card *card;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000798 struct snd_soc_dai_link *dai_link;
Richard Purdie808db4a2006-10-06 18:20:14 +0200799
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000800 unsigned int complete:1;
801 unsigned int dev_registered:1;
802
803 /* Symmetry data - only valid if symmetry is being enforced */
804 unsigned int rate;
805 long pmdown_time;
806
807 /* runtime devices */
808 struct snd_pcm *pcm;
809 struct snd_soc_codec *codec;
810 struct snd_soc_platform *platform;
811 struct snd_soc_dai *codec_dai;
812 struct snd_soc_dai *cpu_dai;
813
814 struct delayed_work delayed_work;
Richard Purdie808db4a2006-10-06 18:20:14 +0200815};
816
Jon Smirl4eaa9812008-07-29 11:42:26 +0100817/* mixer control */
818struct soc_mixer_control {
Peter Ujfalusid11bb4a2010-05-10 14:39:24 +0300819 int min, max, platform_max;
Jon Smirl815ecf82008-07-29 10:22:24 -0400820 unsigned int reg, rreg, shift, rshift, invert;
Jon Smirl4eaa9812008-07-29 11:42:26 +0100821};
822
Richard Purdie808db4a2006-10-06 18:20:14 +0200823/* enumerated kcontrol */
824struct soc_enum {
825 unsigned short reg;
826 unsigned short reg2;
827 unsigned char shift_l;
828 unsigned char shift_r;
Jon Smirlf8ba0b72008-07-29 11:42:27 +0100829 unsigned int max;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200830 unsigned int mask;
Takashi Iwai87023ff2011-05-03 12:50:29 +0200831 const char * const *texts;
Peter Ujfalusi2e72f8e2009-01-05 09:54:57 +0200832 const unsigned int *values;
833 void *dapm;
834};
835
Mark Brown5c82f562009-05-22 09:41:30 +0100836/* codec IO */
Mark Brownc3753702010-11-01 15:41:57 -0400837unsigned int snd_soc_read(struct snd_soc_codec *codec, unsigned int reg);
838unsigned int snd_soc_write(struct snd_soc_codec *codec,
839 unsigned int reg, unsigned int val);
Dimitris Papastamos5fb609d2011-03-22 10:37:03 +0000840unsigned int snd_soc_bulk_write_raw(struct snd_soc_codec *codec,
841 unsigned int reg, const void *data, size_t len);
Mark Brown5c82f562009-05-22 09:41:30 +0100842
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000843/* device driver data */
844
Mark Browndddf3e42011-01-28 13:11:47 +0000845static inline void snd_soc_card_set_drvdata(struct snd_soc_card *card,
846 void *data)
847{
848 card->drvdata = data;
849}
850
851static inline void *snd_soc_card_get_drvdata(struct snd_soc_card *card)
852{
853 return card->drvdata;
854}
855
Mark Brownb2c812e2010-04-14 15:35:19 +0900856static inline void snd_soc_codec_set_drvdata(struct snd_soc_codec *codec,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000857 void *data)
Mark Brownb2c812e2010-04-14 15:35:19 +0900858{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000859 dev_set_drvdata(codec->dev, data);
Mark Brownb2c812e2010-04-14 15:35:19 +0900860}
861
862static inline void *snd_soc_codec_get_drvdata(struct snd_soc_codec *codec)
863{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000864 return dev_get_drvdata(codec->dev);
865}
866
867static inline void snd_soc_platform_set_drvdata(struct snd_soc_platform *platform,
868 void *data)
869{
870 dev_set_drvdata(platform->dev, data);
871}
872
873static inline void *snd_soc_platform_get_drvdata(struct snd_soc_platform *platform)
874{
875 return dev_get_drvdata(platform->dev);
876}
877
878static inline void snd_soc_pcm_set_drvdata(struct snd_soc_pcm_runtime *rtd,
879 void *data)
880{
881 dev_set_drvdata(&rtd->dev, data);
882}
883
884static inline void *snd_soc_pcm_get_drvdata(struct snd_soc_pcm_runtime *rtd)
885{
886 return dev_get_drvdata(&rtd->dev);
Mark Brownb2c812e2010-04-14 15:35:19 +0900887}
888
Vinod Koul4e10bda2011-01-13 22:48:52 +0530889static inline void snd_soc_initialize_card_lists(struct snd_soc_card *card)
890{
891 INIT_LIST_HEAD(&card->dai_dev_list);
892 INIT_LIST_HEAD(&card->codec_dev_list);
893 INIT_LIST_HEAD(&card->platform_dev_list);
894 INIT_LIST_HEAD(&card->widgets);
895 INIT_LIST_HEAD(&card->paths);
896 INIT_LIST_HEAD(&card->dapm_list);
897}
898
Mark Brownfb257892011-04-28 10:57:54 +0100899int snd_soc_util_init(void);
900void snd_soc_util_exit(void);
901
Mark Browna47cbe72008-07-23 14:03:07 +0100902#include <sound/soc-dai.h>
903
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700904#ifdef CONFIG_DEBUG_FS
Mark Brown8a9dab12011-01-10 22:25:21 +0000905extern struct dentry *snd_soc_debugfs_root;
Stephen Warrenfaff4bb2011-01-07 22:36:11 -0700906#endif
907
Mark Brown6f8ab4a2011-01-26 14:59:27 +0000908extern const struct dev_pm_ops snd_soc_pm_ops;
909
Richard Purdie808db4a2006-10-06 18:20:14 +0200910#endif