Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 1 | /* |
| 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> |
Andrew Morton | 4484bb2 | 2006-12-15 09:30:07 +0100 | [diff] [blame] | 18 | #include <linux/workqueue.h> |
Lopez Cruz, Misael | ec67624 | 2009-03-03 15:25:04 -0600 | [diff] [blame] | 19 | #include <linux/interrupt.h> |
| 20 | #include <linux/kernel.h> |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 21 | #include <sound/core.h> |
| 22 | #include <sound/pcm.h> |
| 23 | #include <sound/control.h> |
| 24 | #include <sound/ac97_codec.h> |
| 25 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 26 | /* |
| 27 | * Convenience kcontrol builders |
| 28 | */ |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 29 | #define SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) \ |
| 30 | ((unsigned long)&(struct soc_mixer_control) \ |
Mark Brown | 762b8df | 2008-10-30 12:37:08 +0000 | [diff] [blame] | 31 | {.reg = xreg, .shift = xshift, .rshift = xshift, .max = xmax, \ |
| 32 | .invert = xinvert}) |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 33 | #define SOC_SINGLE_VALUE_EXT(xreg, xmax, xinvert) \ |
| 34 | ((unsigned long)&(struct soc_mixer_control) \ |
| 35 | {.reg = xreg, .max = xmax, .invert = xinvert}) |
Philipp Zabel | a7a4ac8 | 2008-01-10 14:37:42 +0100 | [diff] [blame] | 36 | #define SOC_SINGLE(xname, reg, shift, max, invert) \ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 37 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ |
| 38 | .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ |
| 39 | .put = snd_soc_put_volsw, \ |
Philipp Zabel | a7a4ac8 | 2008-01-10 14:37:42 +0100 | [diff] [blame] | 40 | .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) } |
| 41 | #define SOC_SINGLE_TLV(xname, reg, shift, max, invert, tlv_array) \ |
| 42 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ |
| 43 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ |
| 44 | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ |
| 45 | .tlv.p = (tlv_array), \ |
| 46 | .info = snd_soc_info_volsw, .get = snd_soc_get_volsw,\ |
| 47 | .put = snd_soc_put_volsw, \ |
| 48 | .private_value = SOC_SINGLE_VALUE(reg, shift, max, invert) } |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 49 | #define SOC_DOUBLE(xname, xreg, shift_left, shift_right, xmax, xinvert) \ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 50 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ |
| 51 | .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ |
| 52 | .put = snd_soc_put_volsw, \ |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 53 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 54 | {.reg = xreg, .shift = shift_left, .rshift = shift_right, \ |
| 55 | .max = xmax, .invert = xinvert} } |
| 56 | #define SOC_DOUBLE_R(xname, reg_left, reg_right, xshift, xmax, xinvert) \ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 57 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ |
| 58 | .info = snd_soc_info_volsw_2r, \ |
| 59 | .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \ |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 60 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 61 | {.reg = reg_left, .rreg = reg_right, .shift = xshift, \ |
| 62 | .max = xmax, .invert = xinvert} } |
| 63 | #define SOC_DOUBLE_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert, tlv_array) \ |
Philipp Zabel | a7a4ac8 | 2008-01-10 14:37:42 +0100 | [diff] [blame] | 64 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ |
| 65 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ |
| 66 | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ |
| 67 | .tlv.p = (tlv_array), \ |
| 68 | .info = snd_soc_info_volsw, .get = snd_soc_get_volsw, \ |
| 69 | .put = snd_soc_put_volsw, \ |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 70 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 71 | {.reg = xreg, .shift = shift_left, .rshift = shift_right,\ |
| 72 | .max = xmax, .invert = xinvert} } |
| 73 | #define SOC_DOUBLE_R_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert, tlv_array) \ |
Philipp Zabel | a7a4ac8 | 2008-01-10 14:37:42 +0100 | [diff] [blame] | 74 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ |
| 75 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ |
| 76 | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ |
| 77 | .tlv.p = (tlv_array), \ |
| 78 | .info = snd_soc_info_volsw_2r, \ |
| 79 | .get = snd_soc_get_volsw_2r, .put = snd_soc_put_volsw_2r, \ |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 80 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 81 | {.reg = reg_left, .rreg = reg_right, .shift = xshift, \ |
| 82 | .max = xmax, .invert = xinvert} } |
| 83 | #define SOC_DOUBLE_S8_TLV(xname, xreg, xmin, xmax, tlv_array) \ |
Mark Brown | e13ac2e | 2008-05-28 17:58:05 +0100 | [diff] [blame] | 84 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ |
| 85 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ |
| 86 | SNDRV_CTL_ELEM_ACCESS_READWRITE, \ |
| 87 | .tlv.p = (tlv_array), \ |
| 88 | .info = snd_soc_info_volsw_s8, .get = snd_soc_get_volsw_s8, \ |
| 89 | .put = snd_soc_put_volsw_s8, \ |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 90 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 91 | {.reg = xreg, .min = xmin, .max = xmax} } |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 92 | #define SOC_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmax, xtexts) \ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 93 | { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 94 | .max = xmax, .texts = xtexts } |
| 95 | #define SOC_ENUM_SINGLE(xreg, xshift, xmax, xtexts) \ |
| 96 | SOC_ENUM_DOUBLE(xreg, xshift, xshift, xmax, xtexts) |
| 97 | #define SOC_ENUM_SINGLE_EXT(xmax, xtexts) \ |
| 98 | { .max = xmax, .texts = xtexts } |
Peter Ujfalusi | 2e72f8e | 2009-01-05 09:54:57 +0200 | [diff] [blame] | 99 | #define SOC_VALUE_ENUM_DOUBLE(xreg, xshift_l, xshift_r, xmask, xmax, xtexts, xvalues) \ |
| 100 | { .reg = xreg, .shift_l = xshift_l, .shift_r = xshift_r, \ |
| 101 | .mask = xmask, .max = xmax, .texts = xtexts, .values = xvalues} |
| 102 | #define SOC_VALUE_ENUM_SINGLE(xreg, xshift, xmask, xmax, xtexts, xvalues) \ |
| 103 | SOC_VALUE_ENUM_DOUBLE(xreg, xshift, xshift, xmask, xmax, xtexts, xvalues) |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 104 | #define SOC_ENUM(xname, xenum) \ |
| 105 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\ |
| 106 | .info = snd_soc_info_enum_double, \ |
| 107 | .get = snd_soc_get_enum_double, .put = snd_soc_put_enum_double, \ |
| 108 | .private_value = (unsigned long)&xenum } |
Peter Ujfalusi | 2e72f8e | 2009-01-05 09:54:57 +0200 | [diff] [blame] | 109 | #define SOC_VALUE_ENUM(xname, xenum) \ |
| 110 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname,\ |
Peter Ujfalusi | 7415555 | 2009-01-08 13:34:29 +0200 | [diff] [blame] | 111 | .info = snd_soc_info_enum_double, \ |
Peter Ujfalusi | 2e72f8e | 2009-01-05 09:54:57 +0200 | [diff] [blame] | 112 | .get = snd_soc_get_value_enum_double, \ |
| 113 | .put = snd_soc_put_value_enum_double, \ |
| 114 | .private_value = (unsigned long)&xenum } |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 115 | #define SOC_SINGLE_EXT(xname, xreg, xshift, xmax, xinvert,\ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 116 | xhandler_get, xhandler_put) \ |
| 117 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ |
Graeme Gregory | 1c433fb | 2007-02-02 17:13:05 +0100 | [diff] [blame] | 118 | .info = snd_soc_info_volsw, \ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 119 | .get = xhandler_get, .put = xhandler_put, \ |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 120 | .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) } |
Daniel Mack | 7629ad2 | 2009-04-24 16:37:44 +0200 | [diff] [blame] | 121 | #define SOC_DOUBLE_EXT(xname, xreg, shift_left, shift_right, xmax, xinvert,\ |
| 122 | xhandler_get, xhandler_put) \ |
| 123 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname),\ |
| 124 | .info = snd_soc_info_volsw, \ |
| 125 | .get = xhandler_get, .put = xhandler_put, \ |
| 126 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 127 | {.reg = xreg, .shift = shift_left, .rshift = shift_right, \ |
| 128 | .max = xmax, .invert = xinvert} } |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 129 | #define SOC_SINGLE_EXT_TLV(xname, xreg, xshift, xmax, xinvert,\ |
Mike Montour | 10144c0 | 2008-06-11 13:47:13 +0100 | [diff] [blame] | 130 | xhandler_get, xhandler_put, tlv_array) \ |
| 131 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ |
| 132 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ |\ |
| 133 | SNDRV_CTL_ELEM_ACCESS_READWRITE,\ |
| 134 | .tlv.p = (tlv_array), \ |
| 135 | .info = snd_soc_info_volsw, \ |
| 136 | .get = xhandler_get, .put = xhandler_put, \ |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 137 | .private_value = SOC_SINGLE_VALUE(xreg, xshift, xmax, xinvert) } |
Joonyoung Shim | d0af93d | 2009-07-15 20:33:47 +0900 | [diff] [blame] | 138 | #define SOC_DOUBLE_EXT_TLV(xname, xreg, shift_left, shift_right, xmax, xinvert,\ |
| 139 | xhandler_get, xhandler_put, tlv_array) \ |
| 140 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ |
| 141 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ |
| 142 | SNDRV_CTL_ELEM_ACCESS_READWRITE, \ |
| 143 | .tlv.p = (tlv_array), \ |
| 144 | .info = snd_soc_info_volsw, \ |
| 145 | .get = xhandler_get, .put = xhandler_put, \ |
| 146 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 147 | {.reg = xreg, .shift = shift_left, .rshift = shift_right, \ |
| 148 | .max = xmax, .invert = xinvert} } |
Joonyoung Shim | 3ce91d5 | 2009-07-15 20:33:50 +0900 | [diff] [blame] | 149 | #define SOC_DOUBLE_R_EXT_TLV(xname, reg_left, reg_right, xshift, xmax, xinvert,\ |
| 150 | xhandler_get, xhandler_put, tlv_array) \ |
| 151 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = (xname), \ |
| 152 | .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | \ |
| 153 | SNDRV_CTL_ELEM_ACCESS_READWRITE, \ |
| 154 | .tlv.p = (tlv_array), \ |
| 155 | .info = snd_soc_info_volsw_2r, \ |
| 156 | .get = xhandler_get, .put = xhandler_put, \ |
| 157 | .private_value = (unsigned long)&(struct soc_mixer_control) \ |
| 158 | {.reg = reg_left, .rreg = reg_right, .shift = xshift, \ |
| 159 | .max = xmax, .invert = xinvert} } |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 160 | #define SOC_SINGLE_BOOL_EXT(xname, xdata, xhandler_get, xhandler_put) \ |
| 161 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ |
| 162 | .info = snd_soc_info_bool_ext, \ |
| 163 | .get = xhandler_get, .put = xhandler_put, \ |
| 164 | .private_value = xdata } |
| 165 | #define SOC_ENUM_EXT(xname, xenum, xhandler_get, xhandler_put) \ |
| 166 | { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, \ |
| 167 | .info = snd_soc_info_enum_ext, \ |
| 168 | .get = xhandler_get, .put = xhandler_put, \ |
| 169 | .private_value = (unsigned long)&xenum } |
| 170 | |
| 171 | /* |
Mark Brown | 0be9898 | 2008-05-19 12:31:28 +0200 | [diff] [blame] | 172 | * Bias levels |
| 173 | * |
| 174 | * @ON: Bias is fully on for audio playback and capture operations. |
| 175 | * @PREPARE: Prepare for audio operations. Called before DAPM switching for |
| 176 | * stream start and stop operations. |
| 177 | * @STANDBY: Low power standby state when no playback/capture operations are |
| 178 | * in progress. NOTE: The transition time between STANDBY and ON |
| 179 | * should be as fast as possible and no longer than 10ms. |
| 180 | * @OFF: Power Off. No restrictions on transition times. |
| 181 | */ |
| 182 | enum snd_soc_bias_level { |
| 183 | SND_SOC_BIAS_ON, |
| 184 | SND_SOC_BIAS_PREPARE, |
| 185 | SND_SOC_BIAS_STANDBY, |
| 186 | SND_SOC_BIAS_OFF, |
| 187 | }; |
| 188 | |
Mark Brown | 8a2cd61 | 2009-01-07 17:31:10 +0000 | [diff] [blame] | 189 | struct snd_jack; |
| 190 | struct snd_soc_card; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 191 | struct snd_soc_device; |
| 192 | struct snd_soc_pcm_stream; |
| 193 | struct snd_soc_ops; |
| 194 | struct snd_soc_dai_mode; |
| 195 | struct snd_soc_pcm_runtime; |
Liam Girdwood | 3c4b266 | 2008-07-07 16:07:17 +0100 | [diff] [blame] | 196 | struct snd_soc_dai; |
Mark Brown | 12a48a8c | 2008-12-03 19:40:30 +0000 | [diff] [blame] | 197 | struct snd_soc_platform; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 198 | struct snd_soc_codec; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 199 | struct soc_enum; |
| 200 | struct snd_soc_ac97_ops; |
Mark Brown | 8a2cd61 | 2009-01-07 17:31:10 +0000 | [diff] [blame] | 201 | struct snd_soc_jack; |
| 202 | struct snd_soc_jack_pin; |
Lopez Cruz, Misael | ec67624 | 2009-03-03 15:25:04 -0600 | [diff] [blame] | 203 | #ifdef CONFIG_GPIOLIB |
| 204 | struct snd_soc_jack_gpio; |
| 205 | #endif |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 206 | |
| 207 | typedef int (*hw_write_t)(void *,const char* ,int); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 208 | |
| 209 | extern struct snd_ac97_bus_ops soc_ac97_ops; |
| 210 | |
Mark Brown | 7084a42 | 2009-07-10 22:24:27 +0100 | [diff] [blame] | 211 | enum snd_soc_control_type { |
| 212 | SND_SOC_CUSTOM, |
| 213 | SND_SOC_I2C, |
| 214 | SND_SOC_SPI, |
| 215 | }; |
| 216 | |
Mark Brown | 12a48a8c | 2008-12-03 19:40:30 +0000 | [diff] [blame] | 217 | int snd_soc_register_platform(struct snd_soc_platform *platform); |
| 218 | void snd_soc_unregister_platform(struct snd_soc_platform *platform); |
Mark Brown | 0d0cf00 | 2008-12-10 14:32:45 +0000 | [diff] [blame] | 219 | int snd_soc_register_codec(struct snd_soc_codec *codec); |
| 220 | void snd_soc_unregister_codec(struct snd_soc_codec *codec); |
Mark Brown | 096e49d | 2009-07-05 15:12:22 +0100 | [diff] [blame] | 221 | int snd_soc_codec_volatile_register(struct snd_soc_codec *codec, int reg); |
Mark Brown | 17a52fd | 2009-07-05 17:24:50 +0100 | [diff] [blame] | 222 | int snd_soc_codec_set_cache_io(struct snd_soc_codec *codec, |
Mark Brown | 7084a42 | 2009-07-10 22:24:27 +0100 | [diff] [blame] | 223 | int addr_bits, int data_bits, |
| 224 | enum snd_soc_control_type control); |
Mark Brown | 12a48a8c | 2008-12-03 19:40:30 +0000 | [diff] [blame] | 225 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 226 | /* pcm <-> DAI connect */ |
| 227 | void snd_soc_free_pcms(struct snd_soc_device *socdev); |
| 228 | int snd_soc_new_pcms(struct snd_soc_device *socdev, int idx, const char *xid); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 229 | |
Mark Brown | 7aae816 | 2009-11-10 16:08:04 +0000 | [diff] [blame] | 230 | /* Utility functions to get clock rates from various things */ |
| 231 | int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots); |
| 232 | int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params); |
| 233 | int snd_soc_params_to_bclk(struct snd_pcm_hw_params *parms); |
| 234 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 235 | /* set runtime hw params */ |
| 236 | int snd_soc_set_runtime_hwparams(struct snd_pcm_substream *substream, |
| 237 | const struct snd_pcm_hardware *hw); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 238 | |
Mark Brown | 8a2cd61 | 2009-01-07 17:31:10 +0000 | [diff] [blame] | 239 | /* Jack reporting */ |
| 240 | int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type, |
| 241 | struct snd_soc_jack *jack); |
| 242 | void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask); |
| 243 | int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, |
| 244 | struct snd_soc_jack_pin *pins); |
Lopez Cruz, Misael | ec67624 | 2009-03-03 15:25:04 -0600 | [diff] [blame] | 245 | #ifdef CONFIG_GPIOLIB |
| 246 | int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, |
| 247 | struct snd_soc_jack_gpio *gpios); |
| 248 | void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, |
| 249 | struct snd_soc_jack_gpio *gpios); |
| 250 | #endif |
Mark Brown | 8a2cd61 | 2009-01-07 17:31:10 +0000 | [diff] [blame] | 251 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 252 | /* codec register bit access */ |
| 253 | int snd_soc_update_bits(struct snd_soc_codec *codec, unsigned short reg, |
Daniel Ribeiro | 46f5822 | 2009-06-07 02:49:11 -0300 | [diff] [blame] | 254 | unsigned int mask, unsigned int value); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 255 | int snd_soc_test_bits(struct snd_soc_codec *codec, unsigned short reg, |
Daniel Ribeiro | 46f5822 | 2009-06-07 02:49:11 -0300 | [diff] [blame] | 256 | unsigned int mask, unsigned int value); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 257 | |
| 258 | int snd_soc_new_ac97_codec(struct snd_soc_codec *codec, |
| 259 | struct snd_ac97_bus_ops *ops, int num); |
| 260 | void snd_soc_free_ac97_codec(struct snd_soc_codec *codec); |
| 261 | |
| 262 | /* |
| 263 | *Controls |
| 264 | */ |
| 265 | struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template, |
| 266 | void *data, char *long_name); |
Ian Molton | 3e8e195 | 2009-01-09 00:23:21 +0000 | [diff] [blame] | 267 | int snd_soc_add_controls(struct snd_soc_codec *codec, |
| 268 | const struct snd_kcontrol_new *controls, int num_controls); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 269 | int snd_soc_info_enum_double(struct snd_kcontrol *kcontrol, |
| 270 | struct snd_ctl_elem_info *uinfo); |
| 271 | int snd_soc_info_enum_ext(struct snd_kcontrol *kcontrol, |
| 272 | struct snd_ctl_elem_info *uinfo); |
| 273 | int snd_soc_get_enum_double(struct snd_kcontrol *kcontrol, |
| 274 | struct snd_ctl_elem_value *ucontrol); |
| 275 | int snd_soc_put_enum_double(struct snd_kcontrol *kcontrol, |
| 276 | struct snd_ctl_elem_value *ucontrol); |
Peter Ujfalusi | 2e72f8e | 2009-01-05 09:54:57 +0200 | [diff] [blame] | 277 | int snd_soc_get_value_enum_double(struct snd_kcontrol *kcontrol, |
| 278 | struct snd_ctl_elem_value *ucontrol); |
| 279 | int snd_soc_put_value_enum_double(struct snd_kcontrol *kcontrol, |
| 280 | struct snd_ctl_elem_value *ucontrol); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 281 | int snd_soc_info_volsw(struct snd_kcontrol *kcontrol, |
| 282 | struct snd_ctl_elem_info *uinfo); |
| 283 | int snd_soc_info_volsw_ext(struct snd_kcontrol *kcontrol, |
| 284 | struct snd_ctl_elem_info *uinfo); |
Philipp Zabel | 392abe9 | 2008-05-13 14:03:40 +0200 | [diff] [blame] | 285 | #define snd_soc_info_bool_ext snd_ctl_boolean_mono_info |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 286 | int snd_soc_get_volsw(struct snd_kcontrol *kcontrol, |
| 287 | struct snd_ctl_elem_value *ucontrol); |
| 288 | int snd_soc_put_volsw(struct snd_kcontrol *kcontrol, |
| 289 | struct snd_ctl_elem_value *ucontrol); |
| 290 | int snd_soc_info_volsw_2r(struct snd_kcontrol *kcontrol, |
| 291 | struct snd_ctl_elem_info *uinfo); |
| 292 | int snd_soc_get_volsw_2r(struct snd_kcontrol *kcontrol, |
| 293 | struct snd_ctl_elem_value *ucontrol); |
| 294 | int snd_soc_put_volsw_2r(struct snd_kcontrol *kcontrol, |
| 295 | struct snd_ctl_elem_value *ucontrol); |
Mark Brown | e13ac2e | 2008-05-28 17:58:05 +0100 | [diff] [blame] | 296 | int snd_soc_info_volsw_s8(struct snd_kcontrol *kcontrol, |
| 297 | struct snd_ctl_elem_info *uinfo); |
| 298 | int snd_soc_get_volsw_s8(struct snd_kcontrol *kcontrol, |
| 299 | struct snd_ctl_elem_value *ucontrol); |
| 300 | int snd_soc_put_volsw_s8(struct snd_kcontrol *kcontrol, |
| 301 | struct snd_ctl_elem_value *ucontrol); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 302 | |
Mark Brown | 8a2cd61 | 2009-01-07 17:31:10 +0000 | [diff] [blame] | 303 | /** |
| 304 | * struct snd_soc_jack_pin - Describes a pin to update based on jack detection |
| 305 | * |
| 306 | * @pin: name of the pin to update |
| 307 | * @mask: bits to check for in reported jack status |
| 308 | * @invert: if non-zero then pin is enabled when status is not reported |
| 309 | */ |
| 310 | struct snd_soc_jack_pin { |
| 311 | struct list_head list; |
| 312 | const char *pin; |
| 313 | int mask; |
| 314 | bool invert; |
| 315 | }; |
| 316 | |
Lopez Cruz, Misael | ec67624 | 2009-03-03 15:25:04 -0600 | [diff] [blame] | 317 | /** |
| 318 | * struct snd_soc_jack_gpio - Describes a gpio pin for jack detection |
| 319 | * |
| 320 | * @gpio: gpio number |
| 321 | * @name: gpio name |
| 322 | * @report: value to report when jack detected |
| 323 | * @invert: report presence in low state |
| 324 | * @debouce_time: debouce time in ms |
| 325 | */ |
| 326 | #ifdef CONFIG_GPIOLIB |
| 327 | struct snd_soc_jack_gpio { |
| 328 | unsigned int gpio; |
| 329 | const char *name; |
| 330 | int report; |
| 331 | int invert; |
| 332 | int debounce_time; |
| 333 | struct snd_soc_jack *jack; |
| 334 | struct work_struct work; |
Joonyoung Shim | c871a05 | 2009-11-12 17:14:04 +0900 | [diff] [blame] | 335 | |
| 336 | int (*jack_status_check)(void); |
Lopez Cruz, Misael | ec67624 | 2009-03-03 15:25:04 -0600 | [diff] [blame] | 337 | }; |
| 338 | #endif |
| 339 | |
Mark Brown | 8a2cd61 | 2009-01-07 17:31:10 +0000 | [diff] [blame] | 340 | struct snd_soc_jack { |
| 341 | struct snd_jack *jack; |
| 342 | struct snd_soc_card *card; |
| 343 | struct list_head pins; |
| 344 | int status; |
| 345 | }; |
| 346 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 347 | /* SoC PCM stream information */ |
| 348 | struct snd_soc_pcm_stream { |
| 349 | char *stream_name; |
Graeme Gregory | 1c433fb | 2007-02-02 17:13:05 +0100 | [diff] [blame] | 350 | u64 formats; /* SNDRV_PCM_FMTBIT_* */ |
| 351 | unsigned int rates; /* SNDRV_PCM_RATE_* */ |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 352 | unsigned int rate_min; /* min rate */ |
| 353 | unsigned int rate_max; /* max rate */ |
| 354 | unsigned int channels_min; /* min channels */ |
| 355 | unsigned int channels_max; /* max channels */ |
| 356 | unsigned int active:1; /* stream is in use */ |
| 357 | }; |
| 358 | |
| 359 | /* SoC audio ops */ |
| 360 | struct snd_soc_ops { |
| 361 | int (*startup)(struct snd_pcm_substream *); |
| 362 | void (*shutdown)(struct snd_pcm_substream *); |
| 363 | int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); |
| 364 | int (*hw_free)(struct snd_pcm_substream *); |
| 365 | int (*prepare)(struct snd_pcm_substream *); |
| 366 | int (*trigger)(struct snd_pcm_substream *, int); |
| 367 | }; |
| 368 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 369 | /* SoC Audio Codec */ |
| 370 | struct snd_soc_codec { |
| 371 | char *name; |
| 372 | struct module *owner; |
| 373 | struct mutex mutex; |
Mark Brown | 0d0cf00 | 2008-12-10 14:32:45 +0000 | [diff] [blame] | 374 | struct device *dev; |
Mark Brown | 452c5ea | 2009-05-17 21:41:23 +0100 | [diff] [blame] | 375 | struct snd_soc_device *socdev; |
Mark Brown | 0d0cf00 | 2008-12-10 14:32:45 +0000 | [diff] [blame] | 376 | |
| 377 | struct list_head list; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 378 | |
| 379 | /* callbacks */ |
Mark Brown | 0be9898 | 2008-05-19 12:31:28 +0200 | [diff] [blame] | 380 | int (*set_bias_level)(struct snd_soc_codec *, |
| 381 | enum snd_soc_bias_level level); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 382 | |
| 383 | /* runtime */ |
| 384 | struct snd_card *card; |
| 385 | struct snd_ac97 *ac97; /* for ad-hoc ac97 devices */ |
| 386 | unsigned int active; |
| 387 | unsigned int pcm_devs; |
| 388 | void *private_data; |
| 389 | |
| 390 | /* codec IO */ |
| 391 | void *control_data; /* codec control (i2c/3wire) data */ |
| 392 | unsigned int (*read)(struct snd_soc_codec *, unsigned int); |
| 393 | int (*write)(struct snd_soc_codec *, unsigned int, unsigned int); |
Mark Brown | 58cd33c | 2008-07-29 11:42:25 +0100 | [diff] [blame] | 394 | int (*display_register)(struct snd_soc_codec *, char *, |
| 395 | size_t, unsigned int); |
Mark Brown | 096e49d | 2009-07-05 15:12:22 +0100 | [diff] [blame] | 396 | int (*volatile_register)(unsigned int); |
Mark Brown | 77ee09c | 2009-07-31 18:26:51 +0100 | [diff] [blame] | 397 | int (*readable_register)(unsigned int); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 398 | hw_write_t hw_write; |
Mark Brown | afa2f10 | 2009-07-10 23:11:24 +0100 | [diff] [blame] | 399 | unsigned int (*hw_read)(struct snd_soc_codec *, unsigned int); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 400 | void *reg_cache; |
| 401 | short reg_cache_size; |
| 402 | short reg_cache_step; |
| 403 | |
| 404 | /* dapm */ |
Troy Kisky | 12ef193 | 2008-10-13 17:42:14 -0700 | [diff] [blame] | 405 | u32 pop_time; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 406 | struct list_head dapm_widgets; |
| 407 | struct list_head dapm_paths; |
Mark Brown | 0be9898 | 2008-05-19 12:31:28 +0200 | [diff] [blame] | 408 | enum snd_soc_bias_level bias_level; |
| 409 | enum snd_soc_bias_level suspend_bias_level; |
Takashi Iwai | 1321b16 | 2006-12-21 11:02:06 +0100 | [diff] [blame] | 410 | struct delayed_work delayed_work; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 411 | |
| 412 | /* codec DAI's */ |
Liam Girdwood | 3c4b266 | 2008-07-07 16:07:17 +0100 | [diff] [blame] | 413 | struct snd_soc_dai *dai; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 414 | unsigned int num_dai; |
Mark Brown | 384c89e | 2008-12-03 17:34:03 +0000 | [diff] [blame] | 415 | |
| 416 | #ifdef CONFIG_DEBUG_FS |
Peter Ujfalusi | 88439ac | 2009-10-01 10:32:47 +0300 | [diff] [blame] | 417 | struct dentry *debugfs_codec_root; |
Mark Brown | 384c89e | 2008-12-03 17:34:03 +0000 | [diff] [blame] | 418 | struct dentry *debugfs_reg; |
| 419 | struct dentry *debugfs_pop_time; |
Mark Brown | 79fb938 | 2009-08-21 16:38:13 +0100 | [diff] [blame] | 420 | struct dentry *debugfs_dapm; |
Mark Brown | 384c89e | 2008-12-03 17:34:03 +0000 | [diff] [blame] | 421 | #endif |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 422 | }; |
| 423 | |
| 424 | /* codec device */ |
| 425 | struct snd_soc_codec_device { |
| 426 | int (*probe)(struct platform_device *pdev); |
| 427 | int (*remove)(struct platform_device *pdev); |
| 428 | int (*suspend)(struct platform_device *pdev, pm_message_t state); |
| 429 | int (*resume)(struct platform_device *pdev); |
| 430 | }; |
| 431 | |
| 432 | /* SoC platform interface */ |
| 433 | struct snd_soc_platform { |
| 434 | char *name; |
Mark Brown | 12a48a8c | 2008-12-03 19:40:30 +0000 | [diff] [blame] | 435 | struct list_head list; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 436 | |
| 437 | int (*probe)(struct platform_device *pdev); |
| 438 | int (*remove)(struct platform_device *pdev); |
Mark Brown | 07c84d0 | 2008-12-03 18:17:28 +0000 | [diff] [blame] | 439 | int (*suspend)(struct snd_soc_dai *dai); |
| 440 | int (*resume)(struct snd_soc_dai *dai); |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 441 | |
| 442 | /* pcm creation and destruction */ |
Liam Girdwood | 3c4b266 | 2008-07-07 16:07:17 +0100 | [diff] [blame] | 443 | int (*pcm_new)(struct snd_card *, struct snd_soc_dai *, |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 444 | struct snd_pcm *); |
| 445 | void (*pcm_free)(struct snd_pcm *); |
| 446 | |
| 447 | /* platform stream ops */ |
| 448 | struct snd_pcm_ops *pcm_ops; |
| 449 | }; |
| 450 | |
| 451 | /* SoC machine DAI configuration, glues a codec and cpu DAI together */ |
| 452 | struct snd_soc_dai_link { |
| 453 | char *name; /* Codec name */ |
| 454 | char *stream_name; /* Stream name */ |
| 455 | |
| 456 | /* DAI */ |
Liam Girdwood | 3c4b266 | 2008-07-07 16:07:17 +0100 | [diff] [blame] | 457 | struct snd_soc_dai *codec_dai; |
| 458 | struct snd_soc_dai *cpu_dai; |
Graeme Gregory | 1c433fb | 2007-02-02 17:13:05 +0100 | [diff] [blame] | 459 | |
| 460 | /* machine stream operations */ |
| 461 | struct snd_soc_ops *ops; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 462 | |
| 463 | /* codec/machine specific init - e.g. add machine controls */ |
| 464 | int (*init)(struct snd_soc_codec *codec); |
Liam Girdwood | 4ccab3e | 2008-01-10 14:39:01 +0100 | [diff] [blame] | 465 | |
Mark Brown | 06f409d | 2009-04-07 18:10:13 +0100 | [diff] [blame] | 466 | /* Symmetry requirements */ |
| 467 | unsigned int symmetric_rates:1; |
| 468 | |
| 469 | /* Symmetry data - only valid if symmetry is being enforced */ |
| 470 | unsigned int rate; |
| 471 | |
Liam Girdwood | 4ccab3e | 2008-01-10 14:39:01 +0100 | [diff] [blame] | 472 | /* DAI pcm */ |
| 473 | struct snd_pcm *pcm; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 474 | }; |
| 475 | |
Mark Brown | 8750654 | 2008-11-18 20:50:34 +0000 | [diff] [blame] | 476 | /* SoC card */ |
| 477 | struct snd_soc_card { |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 478 | char *name; |
Mark Brown | c5af3a2 | 2008-11-28 13:29:45 +0000 | [diff] [blame] | 479 | struct device *dev; |
| 480 | |
| 481 | struct list_head list; |
| 482 | |
| 483 | int instantiated; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 484 | |
| 485 | int (*probe)(struct platform_device *pdev); |
| 486 | int (*remove)(struct platform_device *pdev); |
| 487 | |
| 488 | /* the pre and post PM functions are used to do any PM work before and |
| 489 | * after the codec and DAI's do any PM work. */ |
| 490 | int (*suspend_pre)(struct platform_device *pdev, pm_message_t state); |
| 491 | int (*suspend_post)(struct platform_device *pdev, pm_message_t state); |
| 492 | int (*resume_pre)(struct platform_device *pdev); |
| 493 | int (*resume_post)(struct platform_device *pdev); |
| 494 | |
Liam Girdwood | 0b4d221 | 2008-01-10 14:36:20 +0100 | [diff] [blame] | 495 | /* callbacks */ |
Mark Brown | 8750654 | 2008-11-18 20:50:34 +0000 | [diff] [blame] | 496 | int (*set_bias_level)(struct snd_soc_card *, |
Mark Brown | 0be9898 | 2008-05-19 12:31:28 +0200 | [diff] [blame] | 497 | enum snd_soc_bias_level level); |
Liam Girdwood | 0b4d221 | 2008-01-10 14:36:20 +0100 | [diff] [blame] | 498 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 499 | /* CPU <--> Codec DAI links */ |
| 500 | struct snd_soc_dai_link *dai_link; |
| 501 | int num_links; |
Mark Brown | 6308419 | 2008-12-02 15:08:03 +0000 | [diff] [blame] | 502 | |
| 503 | struct snd_soc_device *socdev; |
| 504 | |
Mark Brown | 6627a65 | 2009-01-23 22:55:23 +0000 | [diff] [blame] | 505 | struct snd_soc_codec *codec; |
| 506 | |
Mark Brown | 87689d5 | 2008-12-02 16:01:14 +0000 | [diff] [blame] | 507 | struct snd_soc_platform *platform; |
Mark Brown | 6308419 | 2008-12-02 15:08:03 +0000 | [diff] [blame] | 508 | struct delayed_work delayed_work; |
| 509 | struct work_struct deferred_resume_work; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 510 | }; |
| 511 | |
| 512 | /* SoC Device - the audio subsystem */ |
| 513 | struct snd_soc_device { |
| 514 | struct device *dev; |
Mark Brown | 8750654 | 2008-11-18 20:50:34 +0000 | [diff] [blame] | 515 | struct snd_soc_card *card; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 516 | struct snd_soc_codec_device *codec_dev; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 517 | void *codec_data; |
| 518 | }; |
| 519 | |
| 520 | /* runtime channel data */ |
| 521 | struct snd_soc_pcm_runtime { |
Graeme Gregory | 1c433fb | 2007-02-02 17:13:05 +0100 | [diff] [blame] | 522 | struct snd_soc_dai_link *dai; |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 523 | struct snd_soc_device *socdev; |
| 524 | }; |
| 525 | |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 526 | /* mixer control */ |
| 527 | struct soc_mixer_control { |
| 528 | int min, max; |
Jon Smirl | 815ecf8d | 2008-07-29 10:22:24 -0400 | [diff] [blame] | 529 | unsigned int reg, rreg, shift, rshift, invert; |
Jon Smirl | 4eaa981 | 2008-07-29 11:42:26 +0100 | [diff] [blame] | 530 | }; |
| 531 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 532 | /* enumerated kcontrol */ |
| 533 | struct soc_enum { |
| 534 | unsigned short reg; |
| 535 | unsigned short reg2; |
| 536 | unsigned char shift_l; |
| 537 | unsigned char shift_r; |
Jon Smirl | f8ba0b7 | 2008-07-29 11:42:27 +0100 | [diff] [blame] | 538 | unsigned int max; |
Peter Ujfalusi | 2e72f8e | 2009-01-05 09:54:57 +0200 | [diff] [blame] | 539 | unsigned int mask; |
| 540 | const char **texts; |
| 541 | const unsigned int *values; |
| 542 | void *dapm; |
| 543 | }; |
| 544 | |
Mark Brown | 5c82f56 | 2009-05-22 09:41:30 +0100 | [diff] [blame] | 545 | /* codec IO */ |
| 546 | static inline unsigned int snd_soc_read(struct snd_soc_codec *codec, |
| 547 | unsigned int reg) |
| 548 | { |
| 549 | return codec->read(codec, reg); |
| 550 | } |
| 551 | |
| 552 | static inline unsigned int snd_soc_write(struct snd_soc_codec *codec, |
| 553 | unsigned int reg, unsigned int val) |
| 554 | { |
| 555 | return codec->write(codec, reg, val); |
| 556 | } |
| 557 | |
Mark Brown | a47cbe7 | 2008-07-23 14:03:07 +0100 | [diff] [blame] | 558 | #include <sound/soc-dai.h> |
| 559 | |
Richard Purdie | 808db4a | 2006-10-06 18:20:14 +0200 | [diff] [blame] | 560 | #endif |