2 * Au1000/Au1500/Au1100 AC97C controller driver for ASoC
4 * (c) 2011 Manuel Lauss <manuel.lauss@googlemail.com>
6 * based on the old ALSA driver originally written by
7 * Charles Eidsness <charles@cooper-street.com>
10 #include <linux/init.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/device.h>
14 #include <linux/delay.h>
15 #include <linux/mutex.h>
16 #include <linux/platform_device.h>
17 #include <linux/suspend.h>
18 #include <sound/core.h>
19 #include <sound/pcm.h>
20 #include <sound/initval.h>
21 #include <sound/soc.h>
22 #include <asm/mach-au1x00/au1000.h>
26 /* register offsets and bits */
27 #define AC97_CONFIG 0x00
28 #define AC97_STATUS 0x04
29 #define AC97_DATA 0x08
30 #define AC97_CMDRESP 0x0c
31 #define AC97_ENABLE 0x10
33 #define CFG_RC(x) (((x) & 0x3ff) << 13) /* valid rx slots mask */
34 #define CFG_XS(x) (((x) & 0x3ff) << 3) /* valid tx slots mask */
35 #define CFG_SG (1 << 2) /* sync gate */
36 #define CFG_SN (1 << 1) /* sync control */
37 #define CFG_RS (1 << 0) /* acrst# control */
38 #define STAT_XU (1 << 11) /* tx underflow */
39 #define STAT_XO (1 << 10) /* tx overflow */
40 #define STAT_RU (1 << 9) /* rx underflow */
41 #define STAT_RO (1 << 8) /* rx overflow */
42 #define STAT_RD (1 << 7) /* codec ready */
43 #define STAT_CP (1 << 6) /* command pending */
44 #define STAT_TE (1 << 4) /* tx fifo empty */
45 #define STAT_TF (1 << 3) /* tx fifo full */
46 #define STAT_RE (1 << 1) /* rx fifo empty */
47 #define STAT_RF (1 << 0) /* rx fifo full */
48 #define CMD_SET_DATA(x) (((x) & 0xffff) << 16)
49 #define CMD_GET_DATA(x) ((x) & 0xffff)
50 #define CMD_READ (1 << 7)
51 #define CMD_WRITE (0 << 7)
52 #define CMD_IDX(x) ((x) & 0x7f)
53 #define EN_D (1 << 1) /* DISable bit */
54 #define EN_CE (1 << 0) /* clock enable bit */
56 /* how often to retry failed codec register reads/writes */
57 #define AC97_RW_RETRIES 5
60 SNDRV_PCM_RATE_CONTINUOUS
63 (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE)
65 /* instance data. There can be only one, MacLeod!!!!, fortunately there IS only
66 * once AC97C on early Alchemy chips. The newer ones aren't so lucky.
68 static struct au1xpsc_audio_data *ac97c_workdata;
69 #define ac97_to_ctx(x) ac97c_workdata
71 static inline unsigned long RD(struct au1xpsc_audio_data *ctx, int reg)
73 return __raw_readl(ctx->mmio + reg);
76 static inline void WR(struct au1xpsc_audio_data *ctx, int reg, unsigned long v)
78 __raw_writel(v, ctx->mmio + reg);
82 static unsigned short au1xac97c_ac97_read(struct snd_ac97 *ac97,
85 struct au1xpsc_audio_data *ctx = ac97_to_ctx(ac97);
86 unsigned int tmo, retry;
90 retry = AC97_RW_RETRIES;
92 mutex_lock(&ctx->lock);
95 while ((RD(ctx, AC97_STATUS) & STAT_CP) && tmo--)
96 udelay(21); /* wait an ac97 frame time */
98 pr_debug("ac97rd timeout #1\n");
102 WR(ctx, AC97_CMDRESP, CMD_IDX(r) | CMD_READ);
104 /* stupid errata: data is only valid for 21us, so
105 * poll, Forrest, poll...
108 while ((RD(ctx, AC97_STATUS) & STAT_CP) && tmo--)
109 asm volatile ("nop");
110 data = RD(ctx, AC97_CMDRESP);
113 pr_debug("ac97rd timeout #2\n");
116 mutex_unlock(&ctx->lock);
117 } while (--retry && !tmo);
119 pr_debug("AC97RD %04x %04lx %d\n", r, data, retry);
121 return retry ? data & 0xffff : 0xffff;
124 static void au1xac97c_ac97_write(struct snd_ac97 *ac97, unsigned short r,
127 struct au1xpsc_audio_data *ctx = ac97_to_ctx(ac97);
128 unsigned int tmo, retry;
130 retry = AC97_RW_RETRIES;
132 mutex_lock(&ctx->lock);
134 for (tmo = 5; (RD(ctx, AC97_STATUS) & STAT_CP) && tmo; tmo--)
137 pr_debug("ac97wr timeout #1\n");
141 WR(ctx, AC97_CMDRESP, CMD_WRITE | CMD_IDX(r) | CMD_SET_DATA(v));
143 for (tmo = 10; (RD(ctx, AC97_STATUS) & STAT_CP) && tmo; tmo--)
146 pr_debug("ac97wr timeout #2\n");
148 mutex_unlock(&ctx->lock);
149 } while (--retry && !tmo);
151 pr_debug("AC97WR %04x %04x %d\n", r, v, retry);
154 static void au1xac97c_ac97_warm_reset(struct snd_ac97 *ac97)
156 struct au1xpsc_audio_data *ctx = ac97_to_ctx(ac97);
158 WR(ctx, AC97_CONFIG, ctx->cfg | CFG_SG | CFG_SN);
160 WR(ctx, AC97_CONFIG, ctx->cfg | CFG_SG);
161 WR(ctx, AC97_CONFIG, ctx->cfg);
164 static void au1xac97c_ac97_cold_reset(struct snd_ac97 *ac97)
166 struct au1xpsc_audio_data *ctx = ac97_to_ctx(ac97);
169 WR(ctx, AC97_CONFIG, ctx->cfg | CFG_RS);
171 WR(ctx, AC97_CONFIG, ctx->cfg);
173 /* wait for codec ready */
175 while (((RD(ctx, AC97_STATUS) & STAT_RD) == 0) && --i)
178 printk(KERN_ERR "ac97c: codec not ready after cold reset\n");
181 /* AC97 controller operations */
182 struct snd_ac97_bus_ops soc_ac97_ops = {
183 .read = au1xac97c_ac97_read,
184 .write = au1xac97c_ac97_write,
185 .reset = au1xac97c_ac97_cold_reset,
186 .warm_reset = au1xac97c_ac97_warm_reset,
188 EXPORT_SYMBOL_GPL(soc_ac97_ops); /* globals be gone! */
190 static int alchemy_ac97c_startup(struct snd_pcm_substream *substream,
191 struct snd_soc_dai *dai)
193 struct au1xpsc_audio_data *ctx = snd_soc_dai_get_drvdata(dai);
194 snd_soc_dai_set_dma_data(dai, substream, &ctx->dmaids[0]);
198 static const struct snd_soc_dai_ops alchemy_ac97c_ops = {
199 .startup = alchemy_ac97c_startup,
202 static int au1xac97c_dai_probe(struct snd_soc_dai *dai)
204 return ac97c_workdata ? 0 : -ENODEV;
207 static struct snd_soc_dai_driver au1xac97c_dai_driver = {
208 .name = "alchemy-ac97c",
210 .probe = au1xac97c_dai_probe,
213 .formats = AC97_FMTS,
219 .formats = AC97_FMTS,
223 .ops = &alchemy_ac97c_ops,
226 static int __devinit au1xac97c_drvprobe(struct platform_device *pdev)
229 struct resource *iores, *dmares;
230 struct au1xpsc_audio_data *ctx;
232 ctx = devm_kzalloc(&pdev->dev, sizeof(*ctx), GFP_KERNEL);
236 mutex_init(&ctx->lock);
238 iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
242 if (!devm_request_mem_region(&pdev->dev, iores->start,
243 resource_size(iores),
247 ctx->mmio = devm_ioremap_nocache(&pdev->dev, iores->start,
248 resource_size(iores));
252 dmares = platform_get_resource(pdev, IORESOURCE_DMA, 0);
255 ctx->dmaids[SNDRV_PCM_STREAM_PLAYBACK] = dmares->start;
257 dmares = platform_get_resource(pdev, IORESOURCE_DMA, 1);
260 ctx->dmaids[SNDRV_PCM_STREAM_CAPTURE] = dmares->start;
263 WR(ctx, AC97_ENABLE, EN_D | EN_CE);
264 WR(ctx, AC97_ENABLE, EN_CE);
266 ctx->cfg = CFG_RC(3) | CFG_XS(3);
267 WR(ctx, AC97_CONFIG, ctx->cfg);
269 platform_set_drvdata(pdev, ctx);
271 ret = snd_soc_register_dai(&pdev->dev, &au1xac97c_dai_driver);
275 ac97c_workdata = ctx;
279 static int __devexit au1xac97c_drvremove(struct platform_device *pdev)
281 struct au1xpsc_audio_data *ctx = platform_get_drvdata(pdev);
283 snd_soc_unregister_dai(&pdev->dev);
285 WR(ctx, AC97_ENABLE, EN_D); /* clock off, disable */
287 ac97c_workdata = NULL; /* MDEV */
293 static int au1xac97c_drvsuspend(struct device *dev)
295 struct au1xpsc_audio_data *ctx = dev_get_drvdata(dev);
297 WR(ctx, AC97_ENABLE, EN_D); /* clock off, disable */
302 static int au1xac97c_drvresume(struct device *dev)
304 struct au1xpsc_audio_data *ctx = dev_get_drvdata(dev);
306 WR(ctx, AC97_ENABLE, EN_D | EN_CE);
307 WR(ctx, AC97_ENABLE, EN_CE);
308 WR(ctx, AC97_CONFIG, ctx->cfg);
313 static const struct dev_pm_ops au1xpscac97_pmops = {
314 .suspend = au1xac97c_drvsuspend,
315 .resume = au1xac97c_drvresume,
318 #define AU1XPSCAC97_PMOPS (&au1xpscac97_pmops)
322 #define AU1XPSCAC97_PMOPS NULL
326 static struct platform_driver au1xac97c_driver = {
328 .name = "alchemy-ac97c",
329 .owner = THIS_MODULE,
330 .pm = AU1XPSCAC97_PMOPS,
332 .probe = au1xac97c_drvprobe,
333 .remove = __devexit_p(au1xac97c_drvremove),
336 static int __init au1xac97c_load(void)
338 ac97c_workdata = NULL;
339 return platform_driver_register(&au1xac97c_driver);
342 static void __exit au1xac97c_unload(void)
344 platform_driver_unregister(&au1xac97c_driver);
347 module_init(au1xac97c_load);
348 module_exit(au1xac97c_unload);
350 MODULE_LICENSE("GPL");
351 MODULE_DESCRIPTION("Au1000/1500/1100 AC97C ASoC driver");
352 MODULE_AUTHOR("Manuel Lauss");