1 /* 2 * linux/sound/pxa2xx-ac97.c -- AC97 support for the Intel PXA2xx chip. 3 * 4 * Author: Nicolas Pitre 5 * Created: Dec 02, 2004 6 * Copyright: MontaVista Software Inc. 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 #include <linux/init.h> 14 #include <linux/module.h> 15 #include <linux/kernel.h> 16 #include <linux/platform_device.h> 17 #include <linux/interrupt.h> 18 #include <linux/wait.h> 19 #include <linux/clk.h> 20 #include <linux/delay.h> 21 22 #include <sound/core.h> 23 #include <sound/pcm.h> 24 #include <sound/ac97_codec.h> 25 #include <sound/initval.h> 26 27 #include <asm/irq.h> 28 #include <linux/mutex.h> 29 #include <mach/hardware.h> 30 #include <mach/pxa-regs.h> 31 #include <mach/pxa2xx-gpio.h> 32 #include <mach/audio.h> 33 34 #include "pxa2xx-pcm.h" 35 36 37 static DEFINE_MUTEX(car_mutex); 38 static DECLARE_WAIT_QUEUE_HEAD(gsr_wq); 39 static volatile long gsr_bits; 40 static struct clk *ac97_clk; 41 #ifdef CONFIG_PXA27x 42 static struct clk *ac97conf_clk; 43 #endif 44 45 /* 46 * Beware PXA27x bugs: 47 * 48 * o Slot 12 read from modem space will hang controller. 49 * o CDONE, SDONE interrupt fails after any slot 12 IO. 50 * 51 * We therefore have an hybrid approach for waiting on SDONE (interrupt or 52 * 1 jiffy timeout if interrupt never comes). 53 */ 54 55 static unsigned short pxa2xx_ac97_read(struct snd_ac97 *ac97, unsigned short reg) 56 { 57 unsigned short val = -1; 58 volatile u32 *reg_addr; 59 60 mutex_lock(&car_mutex); 61 62 /* set up primary or secondary codec space */ 63 reg_addr = (ac97->num & 1) ? &SAC_REG_BASE : &PAC_REG_BASE; 64 reg_addr += (reg >> 1); 65 66 /* start read access across the ac97 link */ 67 GSR = GSR_CDONE | GSR_SDONE; 68 gsr_bits = 0; 69 val = *reg_addr; 70 if (reg == AC97_GPIO_STATUS) 71 goto out; 72 if (wait_event_timeout(gsr_wq, (GSR | gsr_bits) & GSR_SDONE, 1) <= 0 && 73 !((GSR | gsr_bits) & GSR_SDONE)) { 74 printk(KERN_ERR "%s: read error (ac97_reg=%d GSR=%#lx)\n", 75 __func__, reg, GSR | gsr_bits); 76 val = -1; 77 goto out; 78 } 79 80 /* valid data now */ 81 GSR = GSR_CDONE | GSR_SDONE; 82 gsr_bits = 0; 83 val = *reg_addr; 84 /* but we've just started another cycle... */ 85 wait_event_timeout(gsr_wq, (GSR | gsr_bits) & GSR_SDONE, 1); 86 87 out: mutex_unlock(&car_mutex); 88 return val; 89 } 90 91 static void pxa2xx_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short val) 92 { 93 volatile u32 *reg_addr; 94 95 mutex_lock(&car_mutex); 96 97 /* set up primary or secondary codec space */ 98 reg_addr = (ac97->num & 1) ? &SAC_REG_BASE : &PAC_REG_BASE; 99 reg_addr += (reg >> 1); 100 101 GSR = GSR_CDONE | GSR_SDONE; 102 gsr_bits = 0; 103 *reg_addr = val; 104 if (wait_event_timeout(gsr_wq, (GSR | gsr_bits) & GSR_CDONE, 1) <= 0 && 105 !((GSR | gsr_bits) & GSR_CDONE)) 106 printk(KERN_ERR "%s: write error (ac97_reg=%d GSR=%#lx)\n", 107 __func__, reg, GSR | gsr_bits); 108 109 mutex_unlock(&car_mutex); 110 } 111 112 static void pxa2xx_ac97_reset(struct snd_ac97 *ac97) 113 { 114 /* First, try cold reset */ 115 #ifdef CONFIG_PXA3xx 116 int timeout; 117 118 /* Hold CLKBPB for 100us */ 119 GCR = 0; 120 GCR = GCR_CLKBPB; 121 udelay(100); 122 GCR = 0; 123 #endif 124 125 GCR &= GCR_COLD_RST; /* clear everything but nCRST */ 126 GCR &= ~GCR_COLD_RST; /* then assert nCRST */ 127 128 gsr_bits = 0; 129 #ifdef CONFIG_PXA27x 130 /* PXA27x Developers Manual section 13.5.2.2.1 */ 131 clk_enable(ac97conf_clk); 132 udelay(5); 133 clk_disable(ac97conf_clk); 134 GCR = GCR_COLD_RST; 135 udelay(50); 136 #elif defined(CONFIG_PXA3xx) 137 timeout = 1000; 138 /* Can't use interrupts on PXA3xx */ 139 GCR &= ~(GCR_PRIRDY_IEN|GCR_SECRDY_IEN); 140 141 GCR = GCR_WARM_RST | GCR_COLD_RST; 142 while (!(GSR & (GSR_PCR | GSR_SCR)) && timeout--) 143 mdelay(10); 144 #else 145 GCR = GCR_COLD_RST; 146 GCR |= GCR_CDONE_IE|GCR_SDONE_IE; 147 wait_event_timeout(gsr_wq, gsr_bits & (GSR_PCR | GSR_SCR), 1); 148 #endif 149 150 if (!((GSR | gsr_bits) & (GSR_PCR | GSR_SCR))) { 151 printk(KERN_INFO "%s: cold reset timeout (GSR=%#lx)\n", 152 __func__, gsr_bits); 153 154 /* let's try warm reset */ 155 gsr_bits = 0; 156 #ifdef CONFIG_PXA27x 157 /* warm reset broken on Bulverde, 158 so manually keep AC97 reset high */ 159 pxa_gpio_mode(113 | GPIO_OUT | GPIO_DFLT_HIGH); 160 udelay(10); 161 GCR |= GCR_WARM_RST; 162 pxa_gpio_mode(113 | GPIO_ALT_FN_2_OUT); 163 udelay(500); 164 #elif defined(CONFIG_PXA3xx) 165 timeout = 100; 166 /* Can't use interrupts */ 167 GCR |= GCR_WARM_RST; 168 while (!((GSR | gsr_bits) & (GSR_PCR | GSR_SCR)) && timeout--) 169 mdelay(1); 170 #else 171 GCR |= GCR_WARM_RST|GCR_PRIRDY_IEN|GCR_SECRDY_IEN; 172 wait_event_timeout(gsr_wq, gsr_bits & (GSR_PCR | GSR_SCR), 1); 173 #endif 174 175 if (!((GSR | gsr_bits) & (GSR_PCR | GSR_SCR))) 176 printk(KERN_INFO "%s: warm reset timeout (GSR=%#lx)\n", 177 __func__, gsr_bits); 178 } 179 180 GCR &= ~(GCR_PRIRDY_IEN|GCR_SECRDY_IEN); 181 GCR |= GCR_SDONE_IE|GCR_CDONE_IE; 182 } 183 184 static irqreturn_t pxa2xx_ac97_irq(int irq, void *dev_id) 185 { 186 long status; 187 188 status = GSR; 189 if (status) { 190 GSR = status; 191 gsr_bits |= status; 192 wake_up(&gsr_wq); 193 194 #ifdef CONFIG_PXA27x 195 /* Although we don't use those we still need to clear them 196 since they tend to spuriously trigger when MMC is used 197 (hardware bug? go figure)... */ 198 MISR = MISR_EOC; 199 PISR = PISR_EOC; 200 MCSR = MCSR_EOC; 201 #endif 202 203 return IRQ_HANDLED; 204 } 205 206 return IRQ_NONE; 207 } 208 209 static struct snd_ac97_bus_ops pxa2xx_ac97_ops = { 210 .read = pxa2xx_ac97_read, 211 .write = pxa2xx_ac97_write, 212 .reset = pxa2xx_ac97_reset, 213 }; 214 215 static struct pxa2xx_pcm_dma_params pxa2xx_ac97_pcm_out = { 216 .name = "AC97 PCM out", 217 .dev_addr = __PREG(PCDR), 218 .drcmr = &DRCMRTXPCDR, 219 .dcmd = DCMD_INCSRCADDR | DCMD_FLOWTRG | 220 DCMD_BURST32 | DCMD_WIDTH4, 221 }; 222 223 static struct pxa2xx_pcm_dma_params pxa2xx_ac97_pcm_in = { 224 .name = "AC97 PCM in", 225 .dev_addr = __PREG(PCDR), 226 .drcmr = &DRCMRRXPCDR, 227 .dcmd = DCMD_INCTRGADDR | DCMD_FLOWSRC | 228 DCMD_BURST32 | DCMD_WIDTH4, 229 }; 230 231 static struct snd_pcm *pxa2xx_ac97_pcm; 232 static struct snd_ac97 *pxa2xx_ac97_ac97; 233 234 static int pxa2xx_ac97_pcm_startup(struct snd_pcm_substream *substream) 235 { 236 struct snd_pcm_runtime *runtime = substream->runtime; 237 pxa2xx_audio_ops_t *platform_ops; 238 int r; 239 240 runtime->hw.channels_min = 2; 241 runtime->hw.channels_max = 2; 242 243 r = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) ? 244 AC97_RATES_FRONT_DAC : AC97_RATES_ADC; 245 runtime->hw.rates = pxa2xx_ac97_ac97->rates[r]; 246 snd_pcm_limit_hw_rates(runtime); 247 248 platform_ops = substream->pcm->card->dev->platform_data; 249 if (platform_ops && platform_ops->startup) 250 return platform_ops->startup(substream, platform_ops->priv); 251 else 252 return 0; 253 } 254 255 static void pxa2xx_ac97_pcm_shutdown(struct snd_pcm_substream *substream) 256 { 257 pxa2xx_audio_ops_t *platform_ops; 258 259 platform_ops = substream->pcm->card->dev->platform_data; 260 if (platform_ops && platform_ops->shutdown) 261 platform_ops->shutdown(substream, platform_ops->priv); 262 } 263 264 static int pxa2xx_ac97_pcm_prepare(struct snd_pcm_substream *substream) 265 { 266 struct snd_pcm_runtime *runtime = substream->runtime; 267 int reg = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) ? 268 AC97_PCM_FRONT_DAC_RATE : AC97_PCM_LR_ADC_RATE; 269 return snd_ac97_set_rate(pxa2xx_ac97_ac97, reg, runtime->rate); 270 } 271 272 static struct pxa2xx_pcm_client pxa2xx_ac97_pcm_client = { 273 .playback_params = &pxa2xx_ac97_pcm_out, 274 .capture_params = &pxa2xx_ac97_pcm_in, 275 .startup = pxa2xx_ac97_pcm_startup, 276 .shutdown = pxa2xx_ac97_pcm_shutdown, 277 .prepare = pxa2xx_ac97_pcm_prepare, 278 }; 279 280 #ifdef CONFIG_PM 281 282 static int pxa2xx_ac97_do_suspend(struct snd_card *card, pm_message_t state) 283 { 284 pxa2xx_audio_ops_t *platform_ops = card->dev->platform_data; 285 286 snd_power_change_state(card, SNDRV_CTL_POWER_D3cold); 287 snd_pcm_suspend_all(pxa2xx_ac97_pcm); 288 snd_ac97_suspend(pxa2xx_ac97_ac97); 289 if (platform_ops && platform_ops->suspend) 290 platform_ops->suspend(platform_ops->priv); 291 GCR |= GCR_ACLINK_OFF; 292 clk_disable(ac97_clk); 293 294 return 0; 295 } 296 297 static int pxa2xx_ac97_do_resume(struct snd_card *card) 298 { 299 pxa2xx_audio_ops_t *platform_ops = card->dev->platform_data; 300 301 clk_enable(ac97_clk); 302 if (platform_ops && platform_ops->resume) 303 platform_ops->resume(platform_ops->priv); 304 snd_ac97_resume(pxa2xx_ac97_ac97); 305 snd_power_change_state(card, SNDRV_CTL_POWER_D0); 306 307 return 0; 308 } 309 310 static int pxa2xx_ac97_suspend(struct platform_device *dev, pm_message_t state) 311 { 312 struct snd_card *card = platform_get_drvdata(dev); 313 int ret = 0; 314 315 if (card) 316 ret = pxa2xx_ac97_do_suspend(card, PMSG_SUSPEND); 317 318 return ret; 319 } 320 321 static int pxa2xx_ac97_resume(struct platform_device *dev) 322 { 323 struct snd_card *card = platform_get_drvdata(dev); 324 int ret = 0; 325 326 if (card) 327 ret = pxa2xx_ac97_do_resume(card); 328 329 return ret; 330 } 331 332 #else 333 #define pxa2xx_ac97_suspend NULL 334 #define pxa2xx_ac97_resume NULL 335 #endif 336 337 static int __devinit pxa2xx_ac97_probe(struct platform_device *dev) 338 { 339 struct snd_card *card; 340 struct snd_ac97_bus *ac97_bus; 341 struct snd_ac97_template ac97_template; 342 int ret; 343 344 ret = -ENOMEM; 345 card = snd_card_new(SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1, 346 THIS_MODULE, 0); 347 if (!card) 348 goto err; 349 350 card->dev = &dev->dev; 351 strncpy(card->driver, dev->dev.driver->name, sizeof(card->driver)); 352 353 ret = pxa2xx_pcm_new(card, &pxa2xx_ac97_pcm_client, &pxa2xx_ac97_pcm); 354 if (ret) 355 goto err; 356 357 ret = request_irq(IRQ_AC97, pxa2xx_ac97_irq, 0, "AC97", NULL); 358 if (ret < 0) 359 goto err; 360 361 pxa_gpio_mode(GPIO31_SYNC_AC97_MD); 362 pxa_gpio_mode(GPIO30_SDATA_OUT_AC97_MD); 363 pxa_gpio_mode(GPIO28_BITCLK_AC97_MD); 364 pxa_gpio_mode(GPIO29_SDATA_IN_AC97_MD); 365 #ifdef CONFIG_PXA27x 366 /* Use GPIO 113 as AC97 Reset on Bulverde */ 367 pxa_gpio_mode(113 | GPIO_ALT_FN_2_OUT); 368 ac97conf_clk = clk_get(&dev->dev, "AC97CONFCLK"); 369 if (IS_ERR(ac97conf_clk)) { 370 ret = PTR_ERR(ac97conf_clk); 371 ac97conf_clk = NULL; 372 goto err; 373 } 374 #endif 375 376 ac97_clk = clk_get(&dev->dev, "AC97CLK"); 377 if (IS_ERR(ac97_clk)) { 378 ret = PTR_ERR(ac97_clk); 379 ac97_clk = NULL; 380 goto err; 381 } 382 clk_enable(ac97_clk); 383 384 ret = snd_ac97_bus(card, 0, &pxa2xx_ac97_ops, NULL, &ac97_bus); 385 if (ret) 386 goto err; 387 memset(&ac97_template, 0, sizeof(ac97_template)); 388 ret = snd_ac97_mixer(ac97_bus, &ac97_template, &pxa2xx_ac97_ac97); 389 if (ret) 390 goto err; 391 392 snprintf(card->shortname, sizeof(card->shortname), 393 "%s", snd_ac97_get_short_name(pxa2xx_ac97_ac97)); 394 snprintf(card->longname, sizeof(card->longname), 395 "%s (%s)", dev->dev.driver->name, card->mixername); 396 397 snd_card_set_dev(card, &dev->dev); 398 ret = snd_card_register(card); 399 if (ret == 0) { 400 platform_set_drvdata(dev, card); 401 return 0; 402 } 403 404 err: 405 if (card) 406 snd_card_free(card); 407 if (ac97_clk) { 408 GCR |= GCR_ACLINK_OFF; 409 free_irq(IRQ_AC97, NULL); 410 clk_disable(ac97_clk); 411 clk_put(ac97_clk); 412 ac97_clk = NULL; 413 } 414 #ifdef CONFIG_PXA27x 415 if (ac97conf_clk) { 416 clk_put(ac97conf_clk); 417 ac97conf_clk = NULL; 418 } 419 #endif 420 return ret; 421 } 422 423 static int __devexit pxa2xx_ac97_remove(struct platform_device *dev) 424 { 425 struct snd_card *card = platform_get_drvdata(dev); 426 427 if (card) { 428 snd_card_free(card); 429 platform_set_drvdata(dev, NULL); 430 GCR |= GCR_ACLINK_OFF; 431 free_irq(IRQ_AC97, NULL); 432 clk_disable(ac97_clk); 433 clk_put(ac97_clk); 434 ac97_clk = NULL; 435 #ifdef CONFIG_PXA27x 436 clk_put(ac97conf_clk); 437 ac97conf_clk = NULL; 438 #endif 439 } 440 441 return 0; 442 } 443 444 static struct platform_driver pxa2xx_ac97_driver = { 445 .probe = pxa2xx_ac97_probe, 446 .remove = __devexit_p(pxa2xx_ac97_remove), 447 .suspend = pxa2xx_ac97_suspend, 448 .resume = pxa2xx_ac97_resume, 449 .driver = { 450 .name = "pxa2xx-ac97", 451 .owner = THIS_MODULE, 452 }, 453 }; 454 455 static int __init pxa2xx_ac97_init(void) 456 { 457 return platform_driver_register(&pxa2xx_ac97_driver); 458 } 459 460 static void __exit pxa2xx_ac97_exit(void) 461 { 462 platform_driver_unregister(&pxa2xx_ac97_driver); 463 } 464 465 module_init(pxa2xx_ac97_init); 466 module_exit(pxa2xx_ac97_exit); 467 468 MODULE_AUTHOR("Nicolas Pitre"); 469 MODULE_DESCRIPTION("AC97 driver for the Intel PXA2xx chip"); 470 MODULE_LICENSE("GPL"); 471 MODULE_ALIAS("platform:pxa2xx-ac97"); 472