spi/build: Remove SPI_SIRF from compile test
[deliverable/linux.git] / sound / soc / cirrus / ep93xx-ac97.c
CommitLineData
aa7e1b84
MW
1/*
2 * ASoC driver for Cirrus Logic EP93xx AC97 controller.
3 *
4 * Copyright (c) 2010 Mika Westerberg
5 *
6 * Based on s3c-ac97 ASoC driver by Jaswinder Singh.
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/delay.h>
b25b5aa0 14#include <linux/err.h>
aa7e1b84
MW
15#include <linux/io.h>
16#include <linux/init.h>
17#include <linux/module.h>
18#include <linux/platform_device.h>
19#include <linux/slab.h>
20
21#include <sound/core.h>
22#include <sound/ac97_codec.h>
23#include <sound/soc.h>
24
a3b29245 25#include <linux/platform_data/dma-ep93xx.h>
aa7e1b84
MW
26
27/*
28 * Per channel (1-4) registers.
29 */
30#define AC97CH(n) (((n) - 1) * 0x20)
31
32#define AC97DR(n) (AC97CH(n) + 0x0000)
33
34#define AC97RXCR(n) (AC97CH(n) + 0x0004)
35#define AC97RXCR_REN BIT(0)
36#define AC97RXCR_RX3 BIT(3)
37#define AC97RXCR_RX4 BIT(4)
38#define AC97RXCR_CM BIT(15)
39
40#define AC97TXCR(n) (AC97CH(n) + 0x0008)
41#define AC97TXCR_TEN BIT(0)
42#define AC97TXCR_TX3 BIT(3)
43#define AC97TXCR_TX4 BIT(4)
44#define AC97TXCR_CM BIT(15)
45
46#define AC97SR(n) (AC97CH(n) + 0x000c)
47#define AC97SR_TXFE BIT(1)
48#define AC97SR_TXUE BIT(6)
49
50#define AC97RISR(n) (AC97CH(n) + 0x0010)
51#define AC97ISR(n) (AC97CH(n) + 0x0014)
52#define AC97IE(n) (AC97CH(n) + 0x0018)
53
54/*
55 * Global AC97 controller registers.
56 */
57#define AC97S1DATA 0x0080
58#define AC97S2DATA 0x0084
59#define AC97S12DATA 0x0088
60
61#define AC97RGIS 0x008c
62#define AC97GIS 0x0090
63#define AC97IM 0x0094
64/*
65 * Common bits for RGIS, GIS and IM registers.
66 */
67#define AC97_SLOT2RXVALID BIT(1)
68#define AC97_CODECREADY BIT(5)
69#define AC97_SLOT2TXCOMPLETE BIT(6)
70
71#define AC97EOI 0x0098
72#define AC97EOI_WINT BIT(0)
73#define AC97EOI_CODECREADY BIT(1)
74
75#define AC97GCR 0x009c
76#define AC97GCR_AC97IFE BIT(0)
77
78#define AC97RESET 0x00a0
79#define AC97RESET_TIMEDRESET BIT(0)
80
81#define AC97SYNC 0x00a4
82#define AC97SYNC_TIMEDSYNC BIT(0)
83
84#define AC97_TIMEOUT msecs_to_jiffies(5)
85
86/**
87 * struct ep93xx_ac97_info - EP93xx AC97 controller info structure
88 * @lock: mutex serializing access to the bus (slot 1 & 2 ops)
89 * @dev: pointer to the platform device dev structure
aa7e1b84 90 * @regs: mapped AC97 controller registers
aa7e1b84
MW
91 * @done: bus ops wait here for an interrupt
92 */
93struct ep93xx_ac97_info {
94 struct mutex lock;
95 struct device *dev;
aa7e1b84 96 void __iomem *regs;
aa7e1b84
MW
97 struct completion done;
98};
99
100/* currently ALSA only supports a single AC97 device */
101static struct ep93xx_ac97_info *ep93xx_ac97_info;
102
453807f3 103static struct ep93xx_dma_data ep93xx_ac97_pcm_out = {
aa7e1b84 104 .name = "ac97-pcm-out",
51e2cc0c 105 .dma_port = EP93XX_DMA_AAC1,
453807f3 106 .direction = DMA_MEM_TO_DEV,
aa7e1b84
MW
107};
108
453807f3 109static struct ep93xx_dma_data ep93xx_ac97_pcm_in = {
aa7e1b84 110 .name = "ac97-pcm-in",
51e2cc0c 111 .dma_port = EP93XX_DMA_AAC1,
453807f3 112 .direction = DMA_DEV_TO_MEM,
aa7e1b84
MW
113};
114
115static inline unsigned ep93xx_ac97_read_reg(struct ep93xx_ac97_info *info,
116 unsigned reg)
117{
118 return __raw_readl(info->regs + reg);
119}
120
121static inline void ep93xx_ac97_write_reg(struct ep93xx_ac97_info *info,
122 unsigned reg, unsigned val)
123{
124 __raw_writel(val, info->regs + reg);
125}
126
127static unsigned short ep93xx_ac97_read(struct snd_ac97 *ac97,
128 unsigned short reg)
129{
130 struct ep93xx_ac97_info *info = ep93xx_ac97_info;
131 unsigned short val;
132
133 mutex_lock(&info->lock);
134
135 ep93xx_ac97_write_reg(info, AC97S1DATA, reg);
136 ep93xx_ac97_write_reg(info, AC97IM, AC97_SLOT2RXVALID);
137 if (!wait_for_completion_timeout(&info->done, AC97_TIMEOUT)) {
138 dev_warn(info->dev, "timeout reading register %x\n", reg);
139 mutex_unlock(&info->lock);
140 return -ETIMEDOUT;
141 }
142 val = (unsigned short)ep93xx_ac97_read_reg(info, AC97S2DATA);
143
144 mutex_unlock(&info->lock);
145 return val;
146}
147
148static void ep93xx_ac97_write(struct snd_ac97 *ac97,
149 unsigned short reg,
150 unsigned short val)
151{
152 struct ep93xx_ac97_info *info = ep93xx_ac97_info;
153
154 mutex_lock(&info->lock);
155
156 /*
157 * Writes to the codec need to be done so that slot 2 is filled in
158 * before slot 1.
159 */
160 ep93xx_ac97_write_reg(info, AC97S2DATA, val);
161 ep93xx_ac97_write_reg(info, AC97S1DATA, reg);
162
163 ep93xx_ac97_write_reg(info, AC97IM, AC97_SLOT2TXCOMPLETE);
164 if (!wait_for_completion_timeout(&info->done, AC97_TIMEOUT))
165 dev_warn(info->dev, "timeout writing register %x\n", reg);
166
167 mutex_unlock(&info->lock);
168}
169
170static void ep93xx_ac97_warm_reset(struct snd_ac97 *ac97)
171{
172 struct ep93xx_ac97_info *info = ep93xx_ac97_info;
173
174 mutex_lock(&info->lock);
175
176 /*
177 * We are assuming that before this functions gets called, the codec
178 * BIT_CLK is stopped by forcing the codec into powerdown mode. We can
179 * control the SYNC signal directly via AC97SYNC register. Using
180 * TIMEDSYNC the controller will keep the SYNC high > 1us.
181 */
182 ep93xx_ac97_write_reg(info, AC97SYNC, AC97SYNC_TIMEDSYNC);
183 ep93xx_ac97_write_reg(info, AC97IM, AC97_CODECREADY);
184 if (!wait_for_completion_timeout(&info->done, AC97_TIMEOUT))
185 dev_warn(info->dev, "codec warm reset timeout\n");
186
187 mutex_unlock(&info->lock);
188}
189
190static void ep93xx_ac97_cold_reset(struct snd_ac97 *ac97)
191{
192 struct ep93xx_ac97_info *info = ep93xx_ac97_info;
193
194 mutex_lock(&info->lock);
195
196 /*
197 * For doing cold reset, we disable the AC97 controller interface, clear
198 * WINT and CODECREADY bits, and finally enable the interface again.
199 */
200 ep93xx_ac97_write_reg(info, AC97GCR, 0);
201 ep93xx_ac97_write_reg(info, AC97EOI, AC97EOI_CODECREADY | AC97EOI_WINT);
202 ep93xx_ac97_write_reg(info, AC97GCR, AC97GCR_AC97IFE);
203
204 /*
205 * Now, assert the reset and wait for the codec to become ready.
206 */
207 ep93xx_ac97_write_reg(info, AC97RESET, AC97RESET_TIMEDRESET);
208 ep93xx_ac97_write_reg(info, AC97IM, AC97_CODECREADY);
209 if (!wait_for_completion_timeout(&info->done, AC97_TIMEOUT))
210 dev_warn(info->dev, "codec cold reset timeout\n");
211
212 /*
213 * Give the codec some time to come fully out from the reset. This way
214 * we ensure that the subsequent reads/writes will work.
215 */
216 usleep_range(15000, 20000);
217
218 mutex_unlock(&info->lock);
219}
220
221static irqreturn_t ep93xx_ac97_interrupt(int irq, void *dev_id)
222{
223 struct ep93xx_ac97_info *info = dev_id;
224 unsigned status, mask;
225
226 /*
227 * Just mask out the interrupt and wake up the waiting thread.
228 * Interrupts are cleared via reading/writing to slot 1 & 2 registers by
229 * the waiting thread.
230 */
231 status = ep93xx_ac97_read_reg(info, AC97GIS);
232 mask = ep93xx_ac97_read_reg(info, AC97IM);
233 mask &= ~status;
234 ep93xx_ac97_write_reg(info, AC97IM, mask);
235
236 complete(&info->done);
237 return IRQ_HANDLED;
238}
239
b047e1cc 240static struct snd_ac97_bus_ops ep93xx_ac97_ops = {
aa7e1b84
MW
241 .read = ep93xx_ac97_read,
242 .write = ep93xx_ac97_write,
243 .reset = ep93xx_ac97_cold_reset,
244 .warm_reset = ep93xx_ac97_warm_reset,
245};
aa7e1b84
MW
246
247static int ep93xx_ac97_trigger(struct snd_pcm_substream *substream,
248 int cmd, struct snd_soc_dai *dai)
249{
250 struct ep93xx_ac97_info *info = snd_soc_dai_get_drvdata(dai);
251 unsigned v = 0;
252
aa7e1b84
MW
253 switch (cmd) {
254 case SNDRV_PCM_TRIGGER_START:
255 case SNDRV_PCM_TRIGGER_RESUME:
256 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
257 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
258 /*
259 * Enable compact mode, TX slots 3 & 4, and the TX FIFO
260 * itself.
261 */
262 v |= AC97TXCR_CM;
263 v |= AC97TXCR_TX3 | AC97TXCR_TX4;
264 v |= AC97TXCR_TEN;
265 ep93xx_ac97_write_reg(info, AC97TXCR(1), v);
266 } else {
267 /*
268 * Enable compact mode, RX slots 3 & 4, and the RX FIFO
269 * itself.
270 */
271 v |= AC97RXCR_CM;
272 v |= AC97RXCR_RX3 | AC97RXCR_RX4;
273 v |= AC97RXCR_REN;
274 ep93xx_ac97_write_reg(info, AC97RXCR(1), v);
275 }
276 break;
277
278 case SNDRV_PCM_TRIGGER_STOP:
279 case SNDRV_PCM_TRIGGER_SUSPEND:
280 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
281 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
282 /*
283 * As per Cirrus EP93xx errata described below:
284 *
285 * http://www.cirrus.com/en/pubs/errata/ER667E2B.pdf
286 *
287 * we will wait for the TX FIFO to be empty before
288 * clearing the TEN bit.
289 */
290 unsigned long timeout = jiffies + AC97_TIMEOUT;
291
292 do {
293 v = ep93xx_ac97_read_reg(info, AC97SR(1));
294 if (time_after(jiffies, timeout)) {
295 dev_warn(info->dev, "TX timeout\n");
296 break;
297 }
298 } while (!(v & (AC97SR_TXFE | AC97SR_TXUE)));
299
300 /* disable the TX FIFO */
301 ep93xx_ac97_write_reg(info, AC97TXCR(1), 0);
302 } else {
303 /* disable the RX FIFO */
304 ep93xx_ac97_write_reg(info, AC97RXCR(1), 0);
305 }
306 break;
307
308 default:
309 dev_warn(info->dev, "unknown command %d\n", cmd);
310 return -EINVAL;
311 }
312
313 return 0;
314}
315
785d81e2 316static int ep93xx_ac97_dai_probe(struct snd_soc_dai *dai)
aa7e1b84 317{
785d81e2
LPC
318 dai->playback_dma_data = &ep93xx_ac97_pcm_out;
319 dai->capture_dma_data = &ep93xx_ac97_pcm_in;
aa7e1b84 320
aa7e1b84
MW
321 return 0;
322}
323
85e7652d 324static const struct snd_soc_dai_ops ep93xx_ac97_dai_ops = {
aa7e1b84
MW
325 .trigger = ep93xx_ac97_trigger,
326};
327
1c6927f8 328static struct snd_soc_dai_driver ep93xx_ac97_dai = {
aa7e1b84
MW
329 .name = "ep93xx-ac97",
330 .id = 0,
331 .ac97_control = 1,
785d81e2 332 .probe = ep93xx_ac97_dai_probe,
aa7e1b84
MW
333 .playback = {
334 .stream_name = "AC97 Playback",
335 .channels_min = 2,
336 .channels_max = 2,
337 .rates = SNDRV_PCM_RATE_8000_48000,
338 .formats = SNDRV_PCM_FMTBIT_S16_LE,
339 },
340 .capture = {
341 .stream_name = "AC97 Capture",
342 .channels_min = 2,
343 .channels_max = 2,
344 .rates = SNDRV_PCM_RATE_8000_48000,
345 .formats = SNDRV_PCM_FMTBIT_S16_LE,
346 },
347 .ops = &ep93xx_ac97_dai_ops,
348};
349
426c3408
KM
350static const struct snd_soc_component_driver ep93xx_ac97_component = {
351 .name = "ep93xx-ac97",
352};
353
145e2879 354static int ep93xx_ac97_probe(struct platform_device *pdev)
aa7e1b84
MW
355{
356 struct ep93xx_ac97_info *info;
e7cff0ab
HS
357 struct resource *res;
358 unsigned int irq;
aa7e1b84
MW
359 int ret;
360
e7cff0ab 361 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
aa7e1b84
MW
362 if (!info)
363 return -ENOMEM;
364
e7cff0ab
HS
365 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
366 if (!res)
367 return -ENODEV;
aa7e1b84 368
b25b5aa0
TR
369 info->regs = devm_ioremap_resource(&pdev->dev, res);
370 if (IS_ERR(info->regs))
371 return PTR_ERR(info->regs);
aa7e1b84 372
e7cff0ab
HS
373 irq = platform_get_irq(pdev, 0);
374 if (!irq)
375 return -ENODEV;
aa7e1b84 376
e7cff0ab
HS
377 ret = devm_request_irq(&pdev->dev, irq, ep93xx_ac97_interrupt,
378 IRQF_TRIGGER_HIGH, pdev->name, info);
379 if (ret)
380 goto fail;
aa7e1b84 381
e7cff0ab 382 dev_set_drvdata(&pdev->dev, info);
aa7e1b84 383
e7cff0ab
HS
384 mutex_init(&info->lock);
385 init_completion(&info->done);
386 info->dev = &pdev->dev;
aa7e1b84
MW
387
388 ep93xx_ac97_info = info;
389 platform_set_drvdata(pdev, info);
390
b047e1cc
MB
391 ret = snd_soc_set_ac97_ops(&ep93xx_ac97_ops);
392 if (ret)
393 goto fail;
394
426c3408
KM
395 ret = snd_soc_register_component(&pdev->dev, &ep93xx_ac97_component,
396 &ep93xx_ac97_dai, 1);
aa7e1b84 397 if (ret)
e7cff0ab 398 goto fail;
aa7e1b84
MW
399
400 return 0;
401
e7cff0ab 402fail:
e7cff0ab 403 ep93xx_ac97_info = NULL;
b047e1cc 404 snd_soc_set_ac97_ops(NULL);
aa7e1b84
MW
405 return ret;
406}
407
145e2879 408static int ep93xx_ac97_remove(struct platform_device *pdev)
aa7e1b84
MW
409{
410 struct ep93xx_ac97_info *info = platform_get_drvdata(pdev);
411
426c3408 412 snd_soc_unregister_component(&pdev->dev);
aa7e1b84
MW
413
414 /* disable the AC97 controller */
415 ep93xx_ac97_write_reg(info, AC97GCR, 0);
416
e7cff0ab 417 ep93xx_ac97_info = NULL;
aa7e1b84 418
b047e1cc 419 snd_soc_set_ac97_ops(NULL);
aa7e1b84
MW
420
421 return 0;
422}
423
424static struct platform_driver ep93xx_ac97_driver = {
425 .probe = ep93xx_ac97_probe,
145e2879 426 .remove = ep93xx_ac97_remove,
aa7e1b84
MW
427 .driver = {
428 .name = "ep93xx-ac97",
429 .owner = THIS_MODULE,
430 },
431};
432
ee18f631 433module_platform_driver(ep93xx_ac97_driver);
aa7e1b84
MW
434
435MODULE_DESCRIPTION("EP93xx AC97 ASoC Driver");
436MODULE_AUTHOR("Mika Westerberg <mika.westerberg@iki.fi>");
437MODULE_LICENSE("GPL");
438MODULE_ALIAS("platform:ep93xx-ac97");
This page took 0.171083 seconds and 5 git commands to generate.