x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / sound / soc / codecs / wm0010.c
blob4f5f5710b56941ddbee4e827bab1d16b79734a5e
1 /*
2 * wm0010.c -- WM0010 DSP Driver
4 * Copyright 2012 Wolfson Microelectronics PLC.
6 * Authors: Mark Brown <broonie@opensource.wolfsonmicro.com>
7 * Dimitris Papastamos <dp@opensource.wolfsonmicro.com>
8 * Scott Ling <sl@opensource.wolfsonmicro.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/interrupt.h>
18 #include <linux/irqreturn.h>
19 #include <linux/init.h>
20 #include <linux/spi/spi.h>
21 #include <linux/firmware.h>
22 #include <linux/delay.h>
23 #include <linux/fs.h>
24 #include <linux/gpio.h>
25 #include <linux/regulator/consumer.h>
26 #include <linux/mutex.h>
27 #include <linux/workqueue.h>
29 #include <sound/soc.h>
30 #include <sound/wm0010.h>
32 #define DEVICE_ID_WM0010 10
34 /* We only support v1 of the .dfw INFO record */
35 #define INFO_VERSION 1
37 enum dfw_cmd {
38 DFW_CMD_FUSE = 0x01,
39 DFW_CMD_CODE_HDR,
40 DFW_CMD_CODE_DATA,
41 DFW_CMD_PLL,
42 DFW_CMD_INFO = 0xff
45 struct dfw_binrec {
46 u8 command;
47 u32 length:24;
48 u32 address;
49 uint8_t data[0];
50 } __packed;
52 struct dfw_inforec {
53 u8 info_version;
54 u8 tool_major_version;
55 u8 tool_minor_version;
56 u8 dsp_target;
59 struct dfw_pllrec {
60 u8 command;
61 u32 length:24;
62 u32 address;
63 u32 clkctrl1;
64 u32 clkctrl2;
65 u32 clkctrl3;
66 u32 ldetctrl;
67 u32 uart_div;
68 u32 spi_div;
69 } __packed;
71 static struct pll_clock_map {
72 int max_sysclk;
73 int max_pll_spi_speed;
74 u32 pll_clkctrl1;
75 } pll_clock_map[] = { /* Dividers */
76 { 22000000, 26000000, 0x00201f11 }, /* 2,32,2 */
77 { 18000000, 26000000, 0x00203f21 }, /* 2,64,4 */
78 { 14000000, 26000000, 0x00202620 }, /* 1,39,4 */
79 { 10000000, 22000000, 0x00203120 }, /* 1,50,4 */
80 { 6500000, 22000000, 0x00204520 }, /* 1,70,4 */
81 { 5500000, 22000000, 0x00103f10 }, /* 1,64,2 */
84 enum wm0010_state {
85 WM0010_POWER_OFF,
86 WM0010_OUT_OF_RESET,
87 WM0010_BOOTROM,
88 WM0010_STAGE2,
89 WM0010_FIRMWARE,
92 struct wm0010_priv {
93 struct snd_soc_codec *codec;
95 struct mutex lock;
96 struct device *dev;
98 struct wm0010_pdata pdata;
100 int gpio_reset;
101 int gpio_reset_value;
103 struct regulator_bulk_data core_supplies[2];
104 struct regulator *dbvdd;
106 int sysclk;
108 enum wm0010_state state;
109 bool boot_failed;
110 bool ready;
111 bool pll_running;
112 int max_spi_freq;
113 int board_max_spi_speed;
114 u32 pll_clkctrl1;
116 spinlock_t irq_lock;
117 int irq;
119 struct completion boot_completion;
122 struct wm0010_spi_msg {
123 struct spi_message m;
124 struct spi_transfer t;
125 u8 *tx_buf;
126 u8 *rx_buf;
127 size_t len;
130 static const struct snd_soc_dapm_widget wm0010_dapm_widgets[] = {
131 SND_SOC_DAPM_SUPPLY("CLKIN", SND_SOC_NOPM, 0, 0, NULL, 0),
134 static const struct snd_soc_dapm_route wm0010_dapm_routes[] = {
135 { "SDI2 Capture", NULL, "SDI1 Playback" },
136 { "SDI1 Capture", NULL, "SDI2 Playback" },
138 { "SDI1 Capture", NULL, "CLKIN" },
139 { "SDI2 Capture", NULL, "CLKIN" },
140 { "SDI1 Playback", NULL, "CLKIN" },
141 { "SDI2 Playback", NULL, "CLKIN" },
144 static const char *wm0010_state_to_str(enum wm0010_state state)
146 static const char * const state_to_str[] = {
147 "Power off",
148 "Out of reset",
149 "Boot ROM",
150 "Stage2",
151 "Firmware"
154 if (state < 0 || state >= ARRAY_SIZE(state_to_str))
155 return "null";
156 return state_to_str[state];
159 /* Called with wm0010->lock held */
160 static void wm0010_halt(struct snd_soc_codec *codec)
162 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
163 unsigned long flags;
164 enum wm0010_state state;
166 /* Fetch the wm0010 state */
167 spin_lock_irqsave(&wm0010->irq_lock, flags);
168 state = wm0010->state;
169 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
171 switch (state) {
172 case WM0010_POWER_OFF:
173 /* If there's nothing to do, bail out */
174 return;
175 case WM0010_OUT_OF_RESET:
176 case WM0010_BOOTROM:
177 case WM0010_STAGE2:
178 case WM0010_FIRMWARE:
179 /* Remember to put chip back into reset */
180 gpio_set_value_cansleep(wm0010->gpio_reset,
181 wm0010->gpio_reset_value);
182 /* Disable the regulators */
183 regulator_disable(wm0010->dbvdd);
184 regulator_bulk_disable(ARRAY_SIZE(wm0010->core_supplies),
185 wm0010->core_supplies);
186 break;
189 spin_lock_irqsave(&wm0010->irq_lock, flags);
190 wm0010->state = WM0010_POWER_OFF;
191 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
194 struct wm0010_boot_xfer {
195 struct list_head list;
196 struct snd_soc_codec *codec;
197 struct completion *done;
198 struct spi_message m;
199 struct spi_transfer t;
202 /* Called with wm0010->lock held */
203 static void wm0010_mark_boot_failure(struct wm0010_priv *wm0010)
205 enum wm0010_state state;
206 unsigned long flags;
208 spin_lock_irqsave(&wm0010->irq_lock, flags);
209 state = wm0010->state;
210 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
212 dev_err(wm0010->dev, "Failed to transition from `%s' state to `%s' state\n",
213 wm0010_state_to_str(state), wm0010_state_to_str(state + 1));
215 wm0010->boot_failed = true;
218 static void wm0010_boot_xfer_complete(void *data)
220 struct wm0010_boot_xfer *xfer = data;
221 struct snd_soc_codec *codec = xfer->codec;
222 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
223 u32 *out32 = xfer->t.rx_buf;
224 int i;
226 if (xfer->m.status != 0) {
227 dev_err(codec->dev, "SPI transfer failed: %d\n",
228 xfer->m.status);
229 wm0010_mark_boot_failure(wm0010);
230 if (xfer->done)
231 complete(xfer->done);
232 return;
235 for (i = 0; i < xfer->t.len / 4; i++) {
236 dev_dbg(codec->dev, "%d: %04x\n", i, out32[i]);
238 switch (be32_to_cpu(out32[i])) {
239 case 0xe0e0e0e0:
240 dev_err(codec->dev,
241 "%d: ROM error reported in stage 2\n", i);
242 wm0010_mark_boot_failure(wm0010);
243 break;
245 case 0x55555555:
246 if (wm0010->state < WM0010_STAGE2)
247 break;
248 dev_err(codec->dev,
249 "%d: ROM bootloader running in stage 2\n", i);
250 wm0010_mark_boot_failure(wm0010);
251 break;
253 case 0x0fed0000:
254 dev_dbg(codec->dev, "Stage2 loader running\n");
255 break;
257 case 0x0fed0007:
258 dev_dbg(codec->dev, "CODE_HDR packet received\n");
259 break;
261 case 0x0fed0008:
262 dev_dbg(codec->dev, "CODE_DATA packet received\n");
263 break;
265 case 0x0fed0009:
266 dev_dbg(codec->dev, "Download complete\n");
267 break;
269 case 0x0fed000c:
270 dev_dbg(codec->dev, "Application start\n");
271 break;
273 case 0x0fed000e:
274 dev_dbg(codec->dev, "PLL packet received\n");
275 wm0010->pll_running = true;
276 break;
278 case 0x0fed0025:
279 dev_err(codec->dev, "Device reports image too long\n");
280 wm0010_mark_boot_failure(wm0010);
281 break;
283 case 0x0fed002c:
284 dev_err(codec->dev, "Device reports bad SPI packet\n");
285 wm0010_mark_boot_failure(wm0010);
286 break;
288 case 0x0fed0031:
289 dev_err(codec->dev, "Device reports SPI read overflow\n");
290 wm0010_mark_boot_failure(wm0010);
291 break;
293 case 0x0fed0032:
294 dev_err(codec->dev, "Device reports SPI underclock\n");
295 wm0010_mark_boot_failure(wm0010);
296 break;
298 case 0x0fed0033:
299 dev_err(codec->dev, "Device reports bad header packet\n");
300 wm0010_mark_boot_failure(wm0010);
301 break;
303 case 0x0fed0034:
304 dev_err(codec->dev, "Device reports invalid packet type\n");
305 wm0010_mark_boot_failure(wm0010);
306 break;
308 case 0x0fed0035:
309 dev_err(codec->dev, "Device reports data before header error\n");
310 wm0010_mark_boot_failure(wm0010);
311 break;
313 case 0x0fed0038:
314 dev_err(codec->dev, "Device reports invalid PLL packet\n");
315 break;
317 case 0x0fed003a:
318 dev_err(codec->dev, "Device reports packet alignment error\n");
319 wm0010_mark_boot_failure(wm0010);
320 break;
322 default:
323 dev_err(codec->dev, "Unrecognised return 0x%x\n",
324 be32_to_cpu(out32[i]));
325 wm0010_mark_boot_failure(wm0010);
326 break;
329 if (wm0010->boot_failed)
330 break;
333 if (xfer->done)
334 complete(xfer->done);
337 static void byte_swap_64(u64 *data_in, u64 *data_out, u32 len)
339 int i;
341 for (i = 0; i < len / 8; i++)
342 data_out[i] = cpu_to_be64(le64_to_cpu(data_in[i]));
345 static int wm0010_firmware_load(const char *name, struct snd_soc_codec *codec)
347 struct spi_device *spi = to_spi_device(codec->dev);
348 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
349 struct list_head xfer_list;
350 struct wm0010_boot_xfer *xfer;
351 int ret;
352 struct completion done;
353 const struct firmware *fw;
354 const struct dfw_binrec *rec;
355 const struct dfw_inforec *inforec;
356 u64 *img;
357 u8 *out, dsp;
358 u32 len, offset;
360 INIT_LIST_HEAD(&xfer_list);
362 ret = request_firmware(&fw, name, codec->dev);
363 if (ret != 0) {
364 dev_err(codec->dev, "Failed to request application(%s): %d\n",
365 name, ret);
366 return ret;
369 rec = (const struct dfw_binrec *)fw->data;
370 inforec = (const struct dfw_inforec *)rec->data;
371 offset = 0;
372 dsp = inforec->dsp_target;
373 wm0010->boot_failed = false;
374 if (WARN_ON(!list_empty(&xfer_list)))
375 return -EINVAL;
376 init_completion(&done);
378 /* First record should be INFO */
379 if (rec->command != DFW_CMD_INFO) {
380 dev_err(codec->dev, "First record not INFO\r\n");
381 ret = -EINVAL;
382 goto abort;
385 if (inforec->info_version != INFO_VERSION) {
386 dev_err(codec->dev,
387 "Unsupported version (%02d) of INFO record\r\n",
388 inforec->info_version);
389 ret = -EINVAL;
390 goto abort;
393 dev_dbg(codec->dev, "Version v%02d INFO record found\r\n",
394 inforec->info_version);
396 /* Check it's a DSP file */
397 if (dsp != DEVICE_ID_WM0010) {
398 dev_err(codec->dev, "Not a WM0010 firmware file.\r\n");
399 ret = -EINVAL;
400 goto abort;
403 /* Skip the info record as we don't need to send it */
404 offset += ((rec->length) + 8);
405 rec = (void *)&rec->data[rec->length];
407 while (offset < fw->size) {
408 dev_dbg(codec->dev,
409 "Packet: command %d, data length = 0x%x\r\n",
410 rec->command, rec->length);
411 len = rec->length + 8;
413 xfer = kzalloc(sizeof(*xfer), GFP_KERNEL);
414 if (!xfer) {
415 ret = -ENOMEM;
416 goto abort;
419 xfer->codec = codec;
420 list_add_tail(&xfer->list, &xfer_list);
422 out = kzalloc(len, GFP_KERNEL | GFP_DMA);
423 if (!out) {
424 ret = -ENOMEM;
425 goto abort1;
427 xfer->t.rx_buf = out;
429 img = kzalloc(len, GFP_KERNEL | GFP_DMA);
430 if (!img) {
431 ret = -ENOMEM;
432 goto abort1;
434 xfer->t.tx_buf = img;
436 byte_swap_64((u64 *)&rec->command, img, len);
438 spi_message_init(&xfer->m);
439 xfer->m.complete = wm0010_boot_xfer_complete;
440 xfer->m.context = xfer;
441 xfer->t.len = len;
442 xfer->t.bits_per_word = 8;
444 if (!wm0010->pll_running) {
445 xfer->t.speed_hz = wm0010->sysclk / 6;
446 } else {
447 xfer->t.speed_hz = wm0010->max_spi_freq;
449 if (wm0010->board_max_spi_speed &&
450 (wm0010->board_max_spi_speed < wm0010->max_spi_freq))
451 xfer->t.speed_hz = wm0010->board_max_spi_speed;
454 /* Store max usable spi frequency for later use */
455 wm0010->max_spi_freq = xfer->t.speed_hz;
457 spi_message_add_tail(&xfer->t, &xfer->m);
459 offset += ((rec->length) + 8);
460 rec = (void *)&rec->data[rec->length];
462 if (offset >= fw->size) {
463 dev_dbg(codec->dev, "All transfers scheduled\n");
464 xfer->done = &done;
467 ret = spi_async(spi, &xfer->m);
468 if (ret != 0) {
469 dev_err(codec->dev, "Write failed: %d\n", ret);
470 goto abort1;
473 if (wm0010->boot_failed) {
474 dev_dbg(codec->dev, "Boot fail!\n");
475 ret = -EINVAL;
476 goto abort1;
480 wait_for_completion(&done);
482 ret = 0;
484 abort1:
485 while (!list_empty(&xfer_list)) {
486 xfer = list_first_entry(&xfer_list, struct wm0010_boot_xfer,
487 list);
488 kfree(xfer->t.rx_buf);
489 kfree(xfer->t.tx_buf);
490 list_del(&xfer->list);
491 kfree(xfer);
494 abort:
495 release_firmware(fw);
496 return ret;
499 static int wm0010_stage2_load(struct snd_soc_codec *codec)
501 struct spi_device *spi = to_spi_device(codec->dev);
502 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
503 const struct firmware *fw;
504 struct spi_message m;
505 struct spi_transfer t;
506 u32 *img;
507 u8 *out;
508 int i;
509 int ret = 0;
511 ret = request_firmware(&fw, "wm0010_stage2.bin", codec->dev);
512 if (ret != 0) {
513 dev_err(codec->dev, "Failed to request stage2 loader: %d\n",
514 ret);
515 return ret;
518 dev_dbg(codec->dev, "Downloading %zu byte stage 2 loader\n", fw->size);
520 /* Copy to local buffer first as vmalloc causes problems for dma */
521 img = kzalloc(fw->size, GFP_KERNEL | GFP_DMA);
522 if (!img) {
523 ret = -ENOMEM;
524 goto abort2;
527 out = kzalloc(fw->size, GFP_KERNEL | GFP_DMA);
528 if (!out) {
529 ret = -ENOMEM;
530 goto abort1;
533 memcpy(img, &fw->data[0], fw->size);
535 spi_message_init(&m);
536 memset(&t, 0, sizeof(t));
537 t.rx_buf = out;
538 t.tx_buf = img;
539 t.len = fw->size;
540 t.bits_per_word = 8;
541 t.speed_hz = wm0010->sysclk / 10;
542 spi_message_add_tail(&t, &m);
544 dev_dbg(codec->dev, "Starting initial download at %dHz\n",
545 t.speed_hz);
547 ret = spi_sync(spi, &m);
548 if (ret != 0) {
549 dev_err(codec->dev, "Initial download failed: %d\n", ret);
550 goto abort;
553 /* Look for errors from the boot ROM */
554 for (i = 0; i < fw->size; i++) {
555 if (out[i] != 0x55) {
556 dev_err(codec->dev, "Boot ROM error: %x in %d\n",
557 out[i], i);
558 wm0010_mark_boot_failure(wm0010);
559 ret = -EBUSY;
560 goto abort;
563 abort:
564 kfree(out);
565 abort1:
566 kfree(img);
567 abort2:
568 release_firmware(fw);
570 return ret;
573 static int wm0010_boot(struct snd_soc_codec *codec)
575 struct spi_device *spi = to_spi_device(codec->dev);
576 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
577 unsigned long flags;
578 int ret;
579 struct spi_message m;
580 struct spi_transfer t;
581 struct dfw_pllrec pll_rec;
582 u32 *p, len;
583 u64 *img_swap;
584 u8 *out;
585 int i;
587 spin_lock_irqsave(&wm0010->irq_lock, flags);
588 if (wm0010->state != WM0010_POWER_OFF)
589 dev_warn(wm0010->dev, "DSP already powered up!\n");
590 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
592 if (wm0010->sysclk > 26000000) {
593 dev_err(codec->dev, "Max DSP clock frequency is 26MHz\n");
594 ret = -ECANCELED;
595 goto err;
598 mutex_lock(&wm0010->lock);
599 wm0010->pll_running = false;
601 dev_dbg(codec->dev, "max_spi_freq: %d\n", wm0010->max_spi_freq);
603 ret = regulator_bulk_enable(ARRAY_SIZE(wm0010->core_supplies),
604 wm0010->core_supplies);
605 if (ret != 0) {
606 dev_err(&spi->dev, "Failed to enable core supplies: %d\n",
607 ret);
608 mutex_unlock(&wm0010->lock);
609 goto err;
612 ret = regulator_enable(wm0010->dbvdd);
613 if (ret != 0) {
614 dev_err(&spi->dev, "Failed to enable DBVDD: %d\n", ret);
615 goto err_core;
618 /* Release reset */
619 gpio_set_value_cansleep(wm0010->gpio_reset, !wm0010->gpio_reset_value);
620 spin_lock_irqsave(&wm0010->irq_lock, flags);
621 wm0010->state = WM0010_OUT_OF_RESET;
622 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
624 if (!wait_for_completion_timeout(&wm0010->boot_completion,
625 msecs_to_jiffies(20)))
626 dev_err(codec->dev, "Failed to get interrupt from DSP\n");
628 spin_lock_irqsave(&wm0010->irq_lock, flags);
629 wm0010->state = WM0010_BOOTROM;
630 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
632 ret = wm0010_stage2_load(codec);
633 if (ret)
634 goto abort;
636 if (!wait_for_completion_timeout(&wm0010->boot_completion,
637 msecs_to_jiffies(20)))
638 dev_err(codec->dev, "Failed to get interrupt from DSP loader.\n");
640 spin_lock_irqsave(&wm0010->irq_lock, flags);
641 wm0010->state = WM0010_STAGE2;
642 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
644 /* Only initialise PLL if max_spi_freq initialised */
645 if (wm0010->max_spi_freq) {
647 /* Initialise a PLL record */
648 memset(&pll_rec, 0, sizeof(pll_rec));
649 pll_rec.command = DFW_CMD_PLL;
650 pll_rec.length = (sizeof(pll_rec) - 8);
652 /* On wm0010 only the CLKCTRL1 value is used */
653 pll_rec.clkctrl1 = wm0010->pll_clkctrl1;
655 ret = -ENOMEM;
656 len = pll_rec.length + 8;
657 out = kzalloc(len, GFP_KERNEL | GFP_DMA);
658 if (!out) {
659 dev_err(codec->dev,
660 "Failed to allocate RX buffer\n");
661 goto abort;
664 img_swap = kzalloc(len, GFP_KERNEL | GFP_DMA);
665 if (!img_swap)
666 goto abort_out;
668 /* We need to re-order for 0010 */
669 byte_swap_64((u64 *)&pll_rec, img_swap, len);
671 spi_message_init(&m);
672 memset(&t, 0, sizeof(t));
673 t.rx_buf = out;
674 t.tx_buf = img_swap;
675 t.len = len;
676 t.bits_per_word = 8;
677 t.speed_hz = wm0010->sysclk / 6;
678 spi_message_add_tail(&t, &m);
680 ret = spi_sync(spi, &m);
681 if (ret) {
682 dev_err(codec->dev, "First PLL write failed: %d\n", ret);
683 goto abort_swap;
686 /* Use a second send of the message to get the return status */
687 ret = spi_sync(spi, &m);
688 if (ret) {
689 dev_err(codec->dev, "Second PLL write failed: %d\n", ret);
690 goto abort_swap;
693 p = (u32 *)out;
695 /* Look for PLL active code from the DSP */
696 for (i = 0; i < len / 4; i++) {
697 if (*p == 0x0e00ed0f) {
698 dev_dbg(codec->dev, "PLL packet received\n");
699 wm0010->pll_running = true;
700 break;
702 p++;
705 kfree(img_swap);
706 kfree(out);
707 } else
708 dev_dbg(codec->dev, "Not enabling DSP PLL.");
710 ret = wm0010_firmware_load("wm0010.dfw", codec);
712 if (ret != 0)
713 goto abort;
715 spin_lock_irqsave(&wm0010->irq_lock, flags);
716 wm0010->state = WM0010_FIRMWARE;
717 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
719 mutex_unlock(&wm0010->lock);
721 return 0;
723 abort_swap:
724 kfree(img_swap);
725 abort_out:
726 kfree(out);
727 abort:
728 /* Put the chip back into reset */
729 wm0010_halt(codec);
730 mutex_unlock(&wm0010->lock);
731 return ret;
733 err_core:
734 mutex_unlock(&wm0010->lock);
735 regulator_bulk_disable(ARRAY_SIZE(wm0010->core_supplies),
736 wm0010->core_supplies);
737 err:
738 return ret;
741 static int wm0010_set_bias_level(struct snd_soc_codec *codec,
742 enum snd_soc_bias_level level)
744 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
746 switch (level) {
747 case SND_SOC_BIAS_ON:
748 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_PREPARE)
749 wm0010_boot(codec);
750 break;
751 case SND_SOC_BIAS_PREPARE:
752 break;
753 case SND_SOC_BIAS_STANDBY:
754 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_PREPARE) {
755 mutex_lock(&wm0010->lock);
756 wm0010_halt(codec);
757 mutex_unlock(&wm0010->lock);
759 break;
760 case SND_SOC_BIAS_OFF:
761 break;
764 return 0;
767 static int wm0010_set_sysclk(struct snd_soc_codec *codec, int source,
768 int clk_id, unsigned int freq, int dir)
770 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
771 unsigned int i;
773 wm0010->sysclk = freq;
775 if (freq < pll_clock_map[ARRAY_SIZE(pll_clock_map)-1].max_sysclk) {
776 wm0010->max_spi_freq = 0;
777 } else {
778 for (i = 0; i < ARRAY_SIZE(pll_clock_map); i++)
779 if (freq >= pll_clock_map[i].max_sysclk) {
780 wm0010->max_spi_freq = pll_clock_map[i].max_pll_spi_speed;
781 wm0010->pll_clkctrl1 = pll_clock_map[i].pll_clkctrl1;
782 break;
786 return 0;
789 static int wm0010_probe(struct snd_soc_codec *codec);
791 static const struct snd_soc_codec_driver soc_codec_dev_wm0010 = {
792 .probe = wm0010_probe,
793 .set_bias_level = wm0010_set_bias_level,
794 .set_sysclk = wm0010_set_sysclk,
795 .idle_bias_off = true,
797 .component_driver = {
798 .dapm_widgets = wm0010_dapm_widgets,
799 .num_dapm_widgets = ARRAY_SIZE(wm0010_dapm_widgets),
800 .dapm_routes = wm0010_dapm_routes,
801 .num_dapm_routes = ARRAY_SIZE(wm0010_dapm_routes),
805 #define WM0010_RATES (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
806 #define WM0010_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |\
807 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE |\
808 SNDRV_PCM_FMTBIT_S32_LE)
810 static struct snd_soc_dai_driver wm0010_dai[] = {
812 .name = "wm0010-sdi1",
813 .playback = {
814 .stream_name = "SDI1 Playback",
815 .channels_min = 1,
816 .channels_max = 2,
817 .rates = WM0010_RATES,
818 .formats = WM0010_FORMATS,
820 .capture = {
821 .stream_name = "SDI1 Capture",
822 .channels_min = 1,
823 .channels_max = 2,
824 .rates = WM0010_RATES,
825 .formats = WM0010_FORMATS,
829 .name = "wm0010-sdi2",
830 .playback = {
831 .stream_name = "SDI2 Playback",
832 .channels_min = 1,
833 .channels_max = 2,
834 .rates = WM0010_RATES,
835 .formats = WM0010_FORMATS,
837 .capture = {
838 .stream_name = "SDI2 Capture",
839 .channels_min = 1,
840 .channels_max = 2,
841 .rates = WM0010_RATES,
842 .formats = WM0010_FORMATS,
847 static irqreturn_t wm0010_irq(int irq, void *data)
849 struct wm0010_priv *wm0010 = data;
851 switch (wm0010->state) {
852 case WM0010_OUT_OF_RESET:
853 case WM0010_BOOTROM:
854 case WM0010_STAGE2:
855 spin_lock(&wm0010->irq_lock);
856 complete(&wm0010->boot_completion);
857 spin_unlock(&wm0010->irq_lock);
858 return IRQ_HANDLED;
859 default:
860 return IRQ_NONE;
863 return IRQ_NONE;
866 static int wm0010_probe(struct snd_soc_codec *codec)
868 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
870 wm0010->codec = codec;
872 return 0;
875 static int wm0010_spi_probe(struct spi_device *spi)
877 unsigned long gpio_flags;
878 int ret;
879 int trigger;
880 int irq;
881 struct wm0010_priv *wm0010;
883 wm0010 = devm_kzalloc(&spi->dev, sizeof(*wm0010),
884 GFP_KERNEL);
885 if (!wm0010)
886 return -ENOMEM;
888 mutex_init(&wm0010->lock);
889 spin_lock_init(&wm0010->irq_lock);
891 spi_set_drvdata(spi, wm0010);
892 wm0010->dev = &spi->dev;
894 if (dev_get_platdata(&spi->dev))
895 memcpy(&wm0010->pdata, dev_get_platdata(&spi->dev),
896 sizeof(wm0010->pdata));
898 init_completion(&wm0010->boot_completion);
900 wm0010->core_supplies[0].supply = "AVDD";
901 wm0010->core_supplies[1].supply = "DCVDD";
902 ret = devm_regulator_bulk_get(wm0010->dev, ARRAY_SIZE(wm0010->core_supplies),
903 wm0010->core_supplies);
904 if (ret != 0) {
905 dev_err(wm0010->dev, "Failed to obtain core supplies: %d\n",
906 ret);
907 return ret;
910 wm0010->dbvdd = devm_regulator_get(wm0010->dev, "DBVDD");
911 if (IS_ERR(wm0010->dbvdd)) {
912 ret = PTR_ERR(wm0010->dbvdd);
913 dev_err(wm0010->dev, "Failed to obtain DBVDD: %d\n", ret);
914 return ret;
917 if (wm0010->pdata.gpio_reset) {
918 wm0010->gpio_reset = wm0010->pdata.gpio_reset;
920 if (wm0010->pdata.reset_active_high)
921 wm0010->gpio_reset_value = 1;
922 else
923 wm0010->gpio_reset_value = 0;
925 if (wm0010->gpio_reset_value)
926 gpio_flags = GPIOF_OUT_INIT_HIGH;
927 else
928 gpio_flags = GPIOF_OUT_INIT_LOW;
930 ret = devm_gpio_request_one(wm0010->dev, wm0010->gpio_reset,
931 gpio_flags, "wm0010 reset");
932 if (ret < 0) {
933 dev_err(wm0010->dev,
934 "Failed to request GPIO for DSP reset: %d\n",
935 ret);
936 return ret;
938 } else {
939 dev_err(wm0010->dev, "No reset GPIO configured\n");
940 return -EINVAL;
943 wm0010->state = WM0010_POWER_OFF;
945 irq = spi->irq;
946 if (wm0010->pdata.irq_flags)
947 trigger = wm0010->pdata.irq_flags;
948 else
949 trigger = IRQF_TRIGGER_FALLING;
950 trigger |= IRQF_ONESHOT;
952 ret = request_threaded_irq(irq, NULL, wm0010_irq, trigger,
953 "wm0010", wm0010);
954 if (ret) {
955 dev_err(wm0010->dev, "Failed to request IRQ %d: %d\n",
956 irq, ret);
957 return ret;
959 wm0010->irq = irq;
961 ret = irq_set_irq_wake(irq, 1);
962 if (ret) {
963 dev_err(wm0010->dev, "Failed to set IRQ %d as wake source: %d\n",
964 irq, ret);
965 return ret;
968 if (spi->max_speed_hz)
969 wm0010->board_max_spi_speed = spi->max_speed_hz;
970 else
971 wm0010->board_max_spi_speed = 0;
973 ret = snd_soc_register_codec(&spi->dev,
974 &soc_codec_dev_wm0010, wm0010_dai,
975 ARRAY_SIZE(wm0010_dai));
976 if (ret < 0)
977 return ret;
979 return 0;
982 static int wm0010_spi_remove(struct spi_device *spi)
984 struct wm0010_priv *wm0010 = spi_get_drvdata(spi);
986 snd_soc_unregister_codec(&spi->dev);
988 gpio_set_value_cansleep(wm0010->gpio_reset,
989 wm0010->gpio_reset_value);
991 irq_set_irq_wake(wm0010->irq, 0);
993 if (wm0010->irq)
994 free_irq(wm0010->irq, wm0010);
996 return 0;
999 static struct spi_driver wm0010_spi_driver = {
1000 .driver = {
1001 .name = "wm0010",
1003 .probe = wm0010_spi_probe,
1004 .remove = wm0010_spi_remove,
1007 module_spi_driver(wm0010_spi_driver);
1009 MODULE_DESCRIPTION("ASoC WM0010 driver");
1010 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
1011 MODULE_LICENSE("GPL");