| 1 | /* |
| 2 | * ad1980.c -- ALSA Soc AD1980 codec support |
| 3 | * |
| 4 | * Copyright: Analog Device Inc. |
| 5 | * Author: Roy Huang <roy.huang@analog.com> |
| 6 | * Cliff Cai <cliff.cai@analog.com> |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify it |
| 9 | * under the terms of the GNU General Public License as published by the |
| 10 | * Free Software Foundation; either version 2 of the License, or (at your |
| 11 | * option) any later version. |
| 12 | */ |
| 13 | |
| 14 | /* |
| 15 | * WARNING: |
| 16 | * |
| 17 | * Because Analog Devices Inc. discontinued the ad1980 sound chip since |
| 18 | * Sep. 2009, this ad1980 driver is not maintained, tested and supported |
| 19 | * by ADI now. |
| 20 | */ |
| 21 | |
| 22 | #include <linux/init.h> |
| 23 | #include <linux/slab.h> |
| 24 | #include <linux/module.h> |
| 25 | #include <linux/kernel.h> |
| 26 | #include <linux/device.h> |
| 27 | #include <sound/core.h> |
| 28 | #include <sound/pcm.h> |
| 29 | #include <sound/ac97_codec.h> |
| 30 | #include <sound/initval.h> |
| 31 | #include <sound/soc.h> |
| 32 | |
| 33 | /* |
| 34 | * AD1980 register cache |
| 35 | */ |
| 36 | static const u16 ad1980_reg[] = { |
| 37 | 0x0090, 0x8000, 0x8000, 0x8000, /* 0 - 6 */ |
| 38 | 0x0000, 0x0000, 0x8008, 0x8008, /* 8 - e */ |
| 39 | 0x8808, 0x8808, 0x0000, 0x8808, /* 10 - 16 */ |
| 40 | 0x8808, 0x0000, 0x8000, 0x0000, /* 18 - 1e */ |
| 41 | 0x0000, 0x0000, 0x0000, 0x0000, /* 20 - 26 */ |
| 42 | 0x03c7, 0x0000, 0xbb80, 0xbb80, /* 28 - 2e */ |
| 43 | 0xbb80, 0xbb80, 0x0000, 0x8080, /* 30 - 36 */ |
| 44 | 0x8080, 0x2000, 0x0000, 0x0000, /* 38 - 3e */ |
| 45 | 0x0000, 0x0000, 0x0000, 0x0000, /* reserved */ |
| 46 | 0x0000, 0x0000, 0x0000, 0x0000, /* reserved */ |
| 47 | 0x0000, 0x0000, 0x0000, 0x0000, /* reserved */ |
| 48 | 0x0000, 0x0000, 0x0000, 0x0000, /* reserved */ |
| 49 | 0x8080, 0x0000, 0x0000, 0x0000, /* 60 - 66 */ |
| 50 | 0x0000, 0x0000, 0x0000, 0x0000, /* reserved */ |
| 51 | 0x0000, 0x0000, 0x1001, 0x0000, /* 70 - 76 */ |
| 52 | 0x0000, 0x0000, 0x4144, 0x5370 /* 78 - 7e */ |
| 53 | }; |
| 54 | |
| 55 | static const char *ad1980_rec_sel[] = {"Mic", "CD", "NC", "AUX", "Line", |
| 56 | "Stereo Mix", "Mono Mix", "Phone"}; |
| 57 | |
| 58 | static SOC_ENUM_DOUBLE_DECL(ad1980_cap_src, |
| 59 | AC97_REC_SEL, 8, 0, ad1980_rec_sel); |
| 60 | |
| 61 | static const struct snd_kcontrol_new ad1980_snd_ac97_controls[] = { |
| 62 | SOC_DOUBLE("Master Playback Volume", AC97_MASTER, 8, 0, 31, 1), |
| 63 | SOC_SINGLE("Master Playback Switch", AC97_MASTER, 15, 1, 1), |
| 64 | |
| 65 | SOC_DOUBLE("Headphone Playback Volume", AC97_HEADPHONE, 8, 0, 31, 1), |
| 66 | SOC_SINGLE("Headphone Playback Switch", AC97_HEADPHONE, 15, 1, 1), |
| 67 | |
| 68 | SOC_DOUBLE("PCM Playback Volume", AC97_PCM, 8, 0, 31, 1), |
| 69 | SOC_SINGLE("PCM Playback Switch", AC97_PCM, 15, 1, 1), |
| 70 | |
| 71 | SOC_DOUBLE("PCM Capture Volume", AC97_REC_GAIN, 8, 0, 31, 0), |
| 72 | SOC_SINGLE("PCM Capture Switch", AC97_REC_GAIN, 15, 1, 1), |
| 73 | |
| 74 | SOC_SINGLE("Mono Playback Volume", AC97_MASTER_MONO, 0, 31, 1), |
| 75 | SOC_SINGLE("Mono Playback Switch", AC97_MASTER_MONO, 15, 1, 1), |
| 76 | |
| 77 | SOC_SINGLE("Phone Capture Volume", AC97_PHONE, 0, 31, 1), |
| 78 | SOC_SINGLE("Phone Capture Switch", AC97_PHONE, 15, 1, 1), |
| 79 | |
| 80 | SOC_SINGLE("Mic Volume", AC97_MIC, 0, 31, 1), |
| 81 | SOC_SINGLE("Mic Switch", AC97_MIC, 15, 1, 1), |
| 82 | |
| 83 | SOC_SINGLE("Stereo Mic Switch", AC97_AD_MISC, 6, 1, 0), |
| 84 | SOC_DOUBLE("Line HP Swap Switch", AC97_AD_MISC, 10, 5, 1, 0), |
| 85 | |
| 86 | SOC_DOUBLE("Surround Playback Volume", AC97_SURROUND_MASTER, 8, 0, 31, 1), |
| 87 | SOC_DOUBLE("Surround Playback Switch", AC97_SURROUND_MASTER, 15, 7, 1, 1), |
| 88 | |
| 89 | SOC_DOUBLE("Center/LFE Playback Volume", AC97_CENTER_LFE_MASTER, 8, 0, 31, 1), |
| 90 | SOC_DOUBLE("Center/LFE Playback Switch", AC97_CENTER_LFE_MASTER, 15, 7, 1, 1), |
| 91 | |
| 92 | SOC_ENUM("Capture Source", ad1980_cap_src), |
| 93 | |
| 94 | SOC_SINGLE("Mic Boost Switch", AC97_MIC, 6, 1, 0), |
| 95 | }; |
| 96 | |
| 97 | static const struct snd_soc_dapm_widget ad1980_dapm_widgets[] = { |
| 98 | SND_SOC_DAPM_INPUT("MIC1"), |
| 99 | SND_SOC_DAPM_INPUT("MIC2"), |
| 100 | SND_SOC_DAPM_INPUT("CD_L"), |
| 101 | SND_SOC_DAPM_INPUT("CD_R"), |
| 102 | SND_SOC_DAPM_INPUT("AUX_L"), |
| 103 | SND_SOC_DAPM_INPUT("AUX_R"), |
| 104 | SND_SOC_DAPM_INPUT("LINE_IN_L"), |
| 105 | SND_SOC_DAPM_INPUT("LINE_IN_R"), |
| 106 | |
| 107 | SND_SOC_DAPM_OUTPUT("LFE_OUT"), |
| 108 | SND_SOC_DAPM_OUTPUT("CENTER_OUT"), |
| 109 | SND_SOC_DAPM_OUTPUT("LINE_OUT_L"), |
| 110 | SND_SOC_DAPM_OUTPUT("LINE_OUT_R"), |
| 111 | SND_SOC_DAPM_OUTPUT("MONO_OUT"), |
| 112 | SND_SOC_DAPM_OUTPUT("HP_OUT_L"), |
| 113 | SND_SOC_DAPM_OUTPUT("HP_OUT_R"), |
| 114 | }; |
| 115 | |
| 116 | static const struct snd_soc_dapm_route ad1980_dapm_routes[] = { |
| 117 | { "Capture", NULL, "MIC1" }, |
| 118 | { "Capture", NULL, "MIC2" }, |
| 119 | { "Capture", NULL, "CD_L" }, |
| 120 | { "Capture", NULL, "CD_R" }, |
| 121 | { "Capture", NULL, "AUX_L" }, |
| 122 | { "Capture", NULL, "AUX_R" }, |
| 123 | { "Capture", NULL, "LINE_IN_L" }, |
| 124 | { "Capture", NULL, "LINE_IN_R" }, |
| 125 | |
| 126 | { "LFE_OUT", NULL, "Playback" }, |
| 127 | { "CENTER_OUT", NULL, "Playback" }, |
| 128 | { "LINE_OUT_L", NULL, "Playback" }, |
| 129 | { "LINE_OUT_R", NULL, "Playback" }, |
| 130 | { "MONO_OUT", NULL, "Playback" }, |
| 131 | { "HP_OUT_L", NULL, "Playback" }, |
| 132 | { "HP_OUT_R", NULL, "Playback" }, |
| 133 | }; |
| 134 | |
| 135 | static unsigned int ac97_read(struct snd_soc_codec *codec, |
| 136 | unsigned int reg) |
| 137 | { |
| 138 | u16 *cache = codec->reg_cache; |
| 139 | |
| 140 | switch (reg) { |
| 141 | case AC97_RESET: |
| 142 | case AC97_INT_PAGING: |
| 143 | case AC97_POWERDOWN: |
| 144 | case AC97_EXTENDED_STATUS: |
| 145 | case AC97_VENDOR_ID1: |
| 146 | case AC97_VENDOR_ID2: |
| 147 | return soc_ac97_ops->read(codec->ac97, reg); |
| 148 | default: |
| 149 | reg = reg >> 1; |
| 150 | |
| 151 | if (reg >= ARRAY_SIZE(ad1980_reg)) |
| 152 | return -EINVAL; |
| 153 | |
| 154 | return cache[reg]; |
| 155 | } |
| 156 | } |
| 157 | |
| 158 | static int ac97_write(struct snd_soc_codec *codec, unsigned int reg, |
| 159 | unsigned int val) |
| 160 | { |
| 161 | u16 *cache = codec->reg_cache; |
| 162 | |
| 163 | soc_ac97_ops->write(codec->ac97, reg, val); |
| 164 | reg = reg >> 1; |
| 165 | if (reg < ARRAY_SIZE(ad1980_reg)) |
| 166 | cache[reg] = val; |
| 167 | |
| 168 | return 0; |
| 169 | } |
| 170 | |
| 171 | static struct snd_soc_dai_driver ad1980_dai = { |
| 172 | .name = "ad1980-hifi", |
| 173 | .playback = { |
| 174 | .stream_name = "Playback", |
| 175 | .channels_min = 2, |
| 176 | .channels_max = 6, |
| 177 | .rates = SNDRV_PCM_RATE_48000, |
| 178 | .formats = SND_SOC_STD_AC97_FMTS, }, |
| 179 | .capture = { |
| 180 | .stream_name = "Capture", |
| 181 | .channels_min = 2, |
| 182 | .channels_max = 2, |
| 183 | .rates = SNDRV_PCM_RATE_48000, |
| 184 | .formats = SND_SOC_STD_AC97_FMTS, }, |
| 185 | }; |
| 186 | |
| 187 | static int ad1980_reset(struct snd_soc_codec *codec, int try_warm) |
| 188 | { |
| 189 | unsigned int retry_cnt = 0; |
| 190 | |
| 191 | do { |
| 192 | if (try_warm && soc_ac97_ops->warm_reset) { |
| 193 | soc_ac97_ops->warm_reset(codec->ac97); |
| 194 | if (ac97_read(codec, AC97_RESET) == 0x0090) |
| 195 | return 1; |
| 196 | } |
| 197 | |
| 198 | soc_ac97_ops->reset(codec->ac97); |
| 199 | /* |
| 200 | * Set bit 16slot in register 74h, then every slot will has only |
| 201 | * 16 bits. This command is sent out in 20bit mode, in which |
| 202 | * case the first nibble of data is eaten by the addr. (Tag is |
| 203 | * always 16 bit) |
| 204 | */ |
| 205 | ac97_write(codec, AC97_AD_SERIAL_CFG, 0x9900); |
| 206 | |
| 207 | if (ac97_read(codec, AC97_RESET) == 0x0090) |
| 208 | return 0; |
| 209 | } while (retry_cnt++ < 10); |
| 210 | |
| 211 | dev_err(codec->dev, "Failed to reset: AC97 link error\n"); |
| 212 | |
| 213 | return -EIO; |
| 214 | } |
| 215 | |
| 216 | static int ad1980_soc_probe(struct snd_soc_codec *codec) |
| 217 | { |
| 218 | int ret; |
| 219 | u16 vendor_id2; |
| 220 | u16 ext_status; |
| 221 | |
| 222 | ret = snd_soc_new_ac97_codec(codec); |
| 223 | if (ret < 0) { |
| 224 | dev_err(codec->dev, "Failed to register AC97 codec\n"); |
| 225 | return ret; |
| 226 | } |
| 227 | |
| 228 | ret = ad1980_reset(codec, 0); |
| 229 | if (ret < 0) |
| 230 | goto reset_err; |
| 231 | |
| 232 | /* Read out vendor ID to make sure it is ad1980 */ |
| 233 | if (ac97_read(codec, AC97_VENDOR_ID1) != 0x4144) { |
| 234 | ret = -ENODEV; |
| 235 | goto reset_err; |
| 236 | } |
| 237 | |
| 238 | vendor_id2 = ac97_read(codec, AC97_VENDOR_ID2); |
| 239 | |
| 240 | if (vendor_id2 != 0x5370) { |
| 241 | if (vendor_id2 != 0x5374) { |
| 242 | ret = -ENODEV; |
| 243 | goto reset_err; |
| 244 | } else { |
| 245 | dev_warn(codec->dev, |
| 246 | "Found AD1981 - only 2/2 IN/OUT Channels supported\n"); |
| 247 | } |
| 248 | } |
| 249 | |
| 250 | /* unmute captures and playbacks volume */ |
| 251 | ac97_write(codec, AC97_MASTER, 0x0000); |
| 252 | ac97_write(codec, AC97_PCM, 0x0000); |
| 253 | ac97_write(codec, AC97_REC_GAIN, 0x0000); |
| 254 | ac97_write(codec, AC97_CENTER_LFE_MASTER, 0x0000); |
| 255 | ac97_write(codec, AC97_SURROUND_MASTER, 0x0000); |
| 256 | |
| 257 | /*power on LFE/CENTER/Surround DACs*/ |
| 258 | ext_status = ac97_read(codec, AC97_EXTENDED_STATUS); |
| 259 | ac97_write(codec, AC97_EXTENDED_STATUS, ext_status&~0x3800); |
| 260 | |
| 261 | return 0; |
| 262 | |
| 263 | reset_err: |
| 264 | snd_soc_free_ac97_codec(codec); |
| 265 | return ret; |
| 266 | } |
| 267 | |
| 268 | static int ad1980_soc_remove(struct snd_soc_codec *codec) |
| 269 | { |
| 270 | snd_soc_free_ac97_codec(codec); |
| 271 | return 0; |
| 272 | } |
| 273 | |
| 274 | static struct snd_soc_codec_driver soc_codec_dev_ad1980 = { |
| 275 | .probe = ad1980_soc_probe, |
| 276 | .remove = ad1980_soc_remove, |
| 277 | .reg_cache_size = ARRAY_SIZE(ad1980_reg), |
| 278 | .reg_word_size = sizeof(u16), |
| 279 | .reg_cache_default = ad1980_reg, |
| 280 | .reg_cache_step = 2, |
| 281 | .write = ac97_write, |
| 282 | .read = ac97_read, |
| 283 | |
| 284 | .controls = ad1980_snd_ac97_controls, |
| 285 | .num_controls = ARRAY_SIZE(ad1980_snd_ac97_controls), |
| 286 | .dapm_widgets = ad1980_dapm_widgets, |
| 287 | .num_dapm_widgets = ARRAY_SIZE(ad1980_dapm_widgets), |
| 288 | .dapm_routes = ad1980_dapm_routes, |
| 289 | .num_dapm_routes = ARRAY_SIZE(ad1980_dapm_routes), |
| 290 | }; |
| 291 | |
| 292 | static int ad1980_probe(struct platform_device *pdev) |
| 293 | { |
| 294 | return snd_soc_register_codec(&pdev->dev, |
| 295 | &soc_codec_dev_ad1980, &ad1980_dai, 1); |
| 296 | } |
| 297 | |
| 298 | static int ad1980_remove(struct platform_device *pdev) |
| 299 | { |
| 300 | snd_soc_unregister_codec(&pdev->dev); |
| 301 | return 0; |
| 302 | } |
| 303 | |
| 304 | static struct platform_driver ad1980_codec_driver = { |
| 305 | .driver = { |
| 306 | .name = "ad1980", |
| 307 | .owner = THIS_MODULE, |
| 308 | }, |
| 309 | |
| 310 | .probe = ad1980_probe, |
| 311 | .remove = ad1980_remove, |
| 312 | }; |
| 313 | |
| 314 | module_platform_driver(ad1980_codec_driver); |
| 315 | |
| 316 | MODULE_DESCRIPTION("ASoC ad1980 driver (Obsolete)"); |
| 317 | MODULE_AUTHOR("Roy Huang, Cliff Cai"); |
| 318 | MODULE_LICENSE("GPL"); |