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/irqreturn.h>
18 #include <linux/init.h>
19 #include <linux/spi/spi.h>
20 #include <linux/firmware.h>
21 #include <linux/delay.h>
23 #include <linux/miscdevice.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
61 static struct pll_clock_map {
63 int max_pll_spi_speed;
65 } pll_clock_map[] = { /* Dividers */
66 { 22000000, 26000000, 0x00201f11 }, /* 2,32,2 */
67 { 18000000, 26000000, 0x00203f21 }, /* 2,64,4 */
68 { 14000000, 26000000, 0x00202620 }, /* 1,39,4 */
69 { 10000000, 22000000, 0x00203120 }, /* 1,50,4 */
70 { 6500000, 22000000, 0x00204520 }, /* 1,70,4 */
71 { 5500000, 22000000, 0x00103f10 }, /* 1,64,2 */
83 struct snd_soc_codec *codec;
88 struct wm0010_pdata pdata;
93 struct regulator_bulk_data core_supplies[2];
94 struct regulator *dbvdd;
98 enum wm0010_state state;
104 int board_max_spi_speed;
110 struct completion boot_completion;
113 struct wm0010_spi_msg {
114 struct spi_message m;
115 struct spi_transfer t;
121 static const struct snd_soc_dapm_widget wm0010_dapm_widgets[] = {
122 SND_SOC_DAPM_SUPPLY("CLKIN", SND_SOC_NOPM, 0, 0, NULL, 0),
125 static const struct snd_soc_dapm_route wm0010_dapm_routes[] = {
126 { "SDI2 Capture", NULL, "SDI1 Playback" },
127 { "SDI1 Capture", NULL, "SDI2 Playback" },
129 { "SDI1 Capture", NULL, "CLKIN" },
130 { "SDI2 Capture", NULL, "CLKIN" },
131 { "SDI1 Playback", NULL, "CLKIN" },
132 { "SDI2 Playback", NULL, "CLKIN" },
135 static const char *wm0010_state_to_str(enum wm0010_state state)
137 const char *state_to_str[] = {
145 if (state < 0 || state >= ARRAY_SIZE(state_to_str))
147 return state_to_str[state];
150 /* Called with wm0010->lock held */
151 static void wm0010_halt(struct snd_soc_codec *codec)
153 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
155 enum wm0010_state state;
157 /* Fetch the wm0010 state */
158 spin_lock_irqsave(&wm0010->irq_lock, flags);
159 state = wm0010->state;
160 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
163 case WM0010_POWER_OFF:
164 /* If there's nothing to do, bail out */
166 case WM0010_OUT_OF_RESET:
169 case WM0010_FIRMWARE:
170 /* Remember to put chip back into reset */
171 gpio_set_value_cansleep(wm0010->gpio_reset,
172 wm0010->gpio_reset_value);
173 /* Disable the regulators */
174 regulator_disable(wm0010->dbvdd);
175 regulator_bulk_disable(ARRAY_SIZE(wm0010->core_supplies),
176 wm0010->core_supplies);
180 spin_lock_irqsave(&wm0010->irq_lock, flags);
181 wm0010->state = WM0010_POWER_OFF;
182 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
185 struct wm0010_boot_xfer {
186 struct list_head list;
187 struct snd_soc_codec *codec;
188 struct completion *done;
189 struct spi_message m;
190 struct spi_transfer t;
193 /* Called with wm0010->lock held */
194 static void wm0010_mark_boot_failure(struct wm0010_priv *wm0010)
196 enum wm0010_state state;
199 spin_lock_irqsave(&wm0010->irq_lock, flags);
200 state = wm0010->state;
201 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
203 dev_err(wm0010->dev, "Failed to transition from `%s' state to `%s' state\n",
204 wm0010_state_to_str(state), wm0010_state_to_str(state + 1));
206 wm0010->boot_failed = true;
209 static void wm0010_boot_xfer_complete(void *data)
211 struct wm0010_boot_xfer *xfer = data;
212 struct snd_soc_codec *codec = xfer->codec;
213 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
214 u32 *out32 = xfer->t.rx_buf;
217 if (xfer->m.status != 0) {
218 dev_err(codec->dev, "SPI transfer failed: %d\n",
220 wm0010_mark_boot_failure(wm0010);
222 complete(xfer->done);
226 for (i = 0; i < xfer->t.len / 4; i++) {
227 dev_dbg(codec->dev, "%d: %04x\n", i, out32[i]);
229 switch (be32_to_cpu(out32[i])) {
232 "%d: ROM error reported in stage 2\n", i);
233 wm0010_mark_boot_failure(wm0010);
237 if (wm0010->boot_done == 0)
240 "%d: ROM bootloader running in stage 2\n", i);
241 wm0010_mark_boot_failure(wm0010);
245 dev_dbg(codec->dev, "Stage2 loader running\n");
249 dev_dbg(codec->dev, "CODE_HDR packet received\n");
253 dev_dbg(codec->dev, "CODE_DATA packet received\n");
257 dev_dbg(codec->dev, "Download complete\n");
261 dev_dbg(codec->dev, "Application start\n");
265 dev_dbg(codec->dev, "PLL packet received\n");
266 wm0010->pll_running = true;
270 dev_err(codec->dev, "Device reports image too long\n");
271 wm0010_mark_boot_failure(wm0010);
275 dev_err(codec->dev, "Device reports bad SPI packet\n");
276 wm0010_mark_boot_failure(wm0010);
280 dev_err(codec->dev, "Device reports SPI read overflow\n");
281 wm0010_mark_boot_failure(wm0010);
285 dev_err(codec->dev, "Device reports SPI underclock\n");
286 wm0010_mark_boot_failure(wm0010);
290 dev_err(codec->dev, "Device reports bad header packet\n");
291 wm0010_mark_boot_failure(wm0010);
295 dev_err(codec->dev, "Device reports invalid packet type\n");
296 wm0010_mark_boot_failure(wm0010);
300 dev_err(codec->dev, "Device reports data before header error\n");
301 wm0010_mark_boot_failure(wm0010);
305 dev_err(codec->dev, "Device reports invalid PLL packet\n");
309 dev_err(codec->dev, "Device reports packet alignment error\n");
310 wm0010_mark_boot_failure(wm0010);
314 dev_err(codec->dev, "Unrecognised return 0x%x\n",
315 be32_to_cpu(out32[i]));
316 wm0010_mark_boot_failure(wm0010);
320 if (wm0010->boot_failed)
326 complete(xfer->done);
329 static void byte_swap_64(u64 *data_in, u64 *data_out, u32 len)
333 for (i = 0; i < len / 8; i++)
334 data_out[i] = cpu_to_be64(le64_to_cpu(data_in[i]));
337 static int wm0010_boot(struct snd_soc_codec *codec)
339 struct spi_device *spi = to_spi_device(codec->dev);
340 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
342 struct list_head xfer_list;
343 struct wm0010_boot_xfer *xfer;
345 struct completion done;
346 const struct firmware *fw;
347 const struct dfw_binrec *rec;
348 struct spi_message m;
349 struct spi_transfer t;
350 struct dfw_pllrec pll_rec;
357 spin_lock_irqsave(&wm0010->irq_lock, flags);
358 if (wm0010->state != WM0010_POWER_OFF)
359 dev_warn(wm0010->dev, "DSP already powered up!\n");
360 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
362 if (wm0010->sysclk > 26000000) {
363 dev_err(codec->dev, "Max DSP clock frequency is 26MHz\n");
368 INIT_LIST_HEAD(&xfer_list);
370 mutex_lock(&wm0010->lock);
371 wm0010->pll_running = false;
373 dev_dbg(codec->dev, "max_spi_freq: %d\n", wm0010->max_spi_freq);
375 ret = regulator_bulk_enable(ARRAY_SIZE(wm0010->core_supplies),
376 wm0010->core_supplies);
378 dev_err(&spi->dev, "Failed to enable core supplies: %d\n",
380 mutex_unlock(&wm0010->lock);
384 ret = regulator_enable(wm0010->dbvdd);
386 dev_err(&spi->dev, "Failed to enable DBVDD: %d\n", ret);
391 gpio_set_value_cansleep(wm0010->gpio_reset, !wm0010->gpio_reset_value);
392 spin_lock_irqsave(&wm0010->irq_lock, flags);
393 wm0010->state = WM0010_OUT_OF_RESET;
394 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
396 /* First the bootloader */
397 ret = request_firmware(&fw, "wm0010_stage2.bin", codec->dev);
399 dev_err(codec->dev, "Failed to request stage2 loader: %d\n",
404 if (!wait_for_completion_timeout(&wm0010->boot_completion,
405 msecs_to_jiffies(10)))
406 dev_err(codec->dev, "Failed to get interrupt from DSP\n");
408 spin_lock_irqsave(&wm0010->irq_lock, flags);
409 wm0010->state = WM0010_BOOTROM;
410 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
412 dev_dbg(codec->dev, "Downloading %zu byte stage 2 loader\n", fw->size);
414 /* Copy to local buffer first as vmalloc causes problems for dma */
415 img = kzalloc(fw->size, GFP_KERNEL);
417 dev_err(codec->dev, "Failed to allocate image buffer\n");
421 out = kzalloc(fw->size, GFP_KERNEL);
423 dev_err(codec->dev, "Failed to allocate output buffer\n");
427 memcpy(img, &fw->data[0], fw->size);
429 spi_message_init(&m);
430 memset(&t, 0, sizeof(t));
435 t.speed_hz = wm0010->sysclk / 10;
436 spi_message_add_tail(&t, &m);
438 dev_dbg(codec->dev, "Starting initial download at %dHz\n",
441 ret = spi_sync(spi, &m);
443 dev_err(codec->dev, "Initial download failed: %d\n", ret);
447 /* Look for errors from the boot ROM */
448 for (i = 0; i < fw->size; i++) {
449 if (out[i] != 0x55) {
451 dev_err(codec->dev, "Boot ROM error: %x in %d\n",
453 wm0010_mark_boot_failure(wm0010);
458 release_firmware(fw);
462 if (!wait_for_completion_timeout(&wm0010->boot_completion,
463 msecs_to_jiffies(10)))
464 dev_err(codec->dev, "Failed to get interrupt from DSP loader.\n");
466 spin_lock_irqsave(&wm0010->irq_lock, flags);
467 wm0010->state = WM0010_STAGE2;
468 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
470 /* Only initialise PLL if max_spi_freq initialised */
471 if (wm0010->max_spi_freq) {
473 /* Initialise a PLL record */
474 memset(&pll_rec, 0, sizeof(pll_rec));
475 pll_rec.command = DFW_CMD_PLL;
476 pll_rec.length = (sizeof(pll_rec) - 8);
478 /* On wm0010 only the CLKCTRL1 value is used */
479 pll_rec.clkctrl1 = wm0010->pll_clkctrl1;
481 len = pll_rec.length + 8;
482 out = kzalloc(len, GFP_KERNEL);
485 "Failed to allocate RX buffer\n");
489 img_swap = kzalloc(len, GFP_KERNEL);
492 "Failed to allocate image buffer\n");
496 /* We need to re-order for 0010 */
497 byte_swap_64((u64 *)&pll_rec, img_swap, len);
499 spi_message_init(&m);
500 memset(&t, 0, sizeof(t));
505 t.speed_hz = wm0010->sysclk / 6;
506 spi_message_add_tail(&t, &m);
508 ret = spi_sync(spi, &m);
510 dev_err(codec->dev, "First PLL write failed: %d\n", ret);
514 /* Use a second send of the message to get the return status */
515 ret = spi_sync(spi, &m);
517 dev_err(codec->dev, "Second PLL write failed: %d\n", ret);
523 /* Look for PLL active code from the DSP */
524 for (i = 0; i < len / 4; i++) {
525 if (*p == 0x0e00ed0f) {
526 dev_dbg(codec->dev, "PLL packet received\n");
527 wm0010->pll_running = true;
536 dev_dbg(codec->dev, "Not enabling DSP PLL.");
538 ret = request_firmware(&fw, "wm0010.dfw", codec->dev);
540 dev_err(codec->dev, "Failed to request application: %d\n",
545 rec = (const struct dfw_binrec *)fw->data;
547 wm0010->boot_done = 0;
548 wm0010->boot_failed = false;
549 BUG_ON(!list_empty(&xfer_list));
550 init_completion(&done);
552 /* First record should be INFO */
553 if (rec->command != DFW_CMD_INFO) {
554 dev_err(codec->dev, "First record not INFO\r\n");
558 /* Check it's a 0010 file */
559 if (rec->data[0] != DEVICE_ID_WM0010) {
560 dev_err(codec->dev, "Not a WM0010 firmware file.\r\n");
564 /* Skip the info record as we don't need to send it */
565 offset += ((rec->length) + 8);
566 rec = (void *)&rec->data[rec->length];
568 while (offset < fw->size) {
570 "Packet: command %d, data length = 0x%x\r\n",
571 rec->command, rec->length);
572 len = rec->length + 8;
574 out = kzalloc(len, GFP_KERNEL);
577 "Failed to allocate RX buffer\n");
581 img_swap = kzalloc(len, GFP_KERNEL);
584 "Failed to allocate image buffer\n");
588 /* We need to re-order for 0010 */
589 byte_swap_64((u64 *)&rec->command, img_swap, len);
591 xfer = kzalloc(sizeof(*xfer), GFP_KERNEL);
593 dev_err(codec->dev, "Failed to allocate xfer\n");
598 list_add_tail(&xfer->list, &xfer_list);
600 spi_message_init(&xfer->m);
601 xfer->m.complete = wm0010_boot_xfer_complete;
602 xfer->m.context = xfer;
603 xfer->t.tx_buf = img_swap;
604 xfer->t.rx_buf = out;
606 xfer->t.bits_per_word = 8;
608 if (!wm0010->pll_running) {
609 xfer->t.speed_hz = wm0010->sysclk / 6;
611 xfer->t.speed_hz = wm0010->max_spi_freq;
613 if (wm0010->board_max_spi_speed &&
614 (wm0010->board_max_spi_speed < wm0010->max_spi_freq))
615 xfer->t.speed_hz = wm0010->board_max_spi_speed;
618 /* Store max usable spi frequency for later use */
619 wm0010->max_spi_freq = xfer->t.speed_hz;
621 spi_message_add_tail(&xfer->t, &xfer->m);
623 offset += ((rec->length) + 8);
624 rec = (void *)&rec->data[rec->length];
626 if (offset >= fw->size) {
627 dev_dbg(codec->dev, "All transfers scheduled\n");
631 ret = spi_async(spi, &xfer->m);
633 dev_err(codec->dev, "Write failed: %d\n", ret);
637 if (wm0010->boot_failed)
641 wait_for_completion(&done);
643 spin_lock_irqsave(&wm0010->irq_lock, flags);
644 wm0010->state = WM0010_FIRMWARE;
645 spin_unlock_irqrestore(&wm0010->irq_lock, flags);
647 mutex_unlock(&wm0010->lock);
649 release_firmware(fw);
651 while (!list_empty(&xfer_list)) {
652 xfer = list_first_entry(&xfer_list, struct wm0010_boot_xfer,
654 kfree(xfer->t.rx_buf);
655 kfree(xfer->t.tx_buf);
656 list_del(&xfer->list);
663 /* Put the chip back into reset */
665 mutex_unlock(&wm0010->lock);
669 mutex_unlock(&wm0010->lock);
670 regulator_bulk_disable(ARRAY_SIZE(wm0010->core_supplies),
671 wm0010->core_supplies);
676 static int wm0010_set_bias_level(struct snd_soc_codec *codec,
677 enum snd_soc_bias_level level)
679 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
682 case SND_SOC_BIAS_ON:
683 if (codec->dapm.bias_level == SND_SOC_BIAS_PREPARE)
686 case SND_SOC_BIAS_PREPARE:
688 case SND_SOC_BIAS_STANDBY:
689 if (codec->dapm.bias_level == SND_SOC_BIAS_PREPARE) {
690 mutex_lock(&wm0010->lock);
692 mutex_unlock(&wm0010->lock);
695 case SND_SOC_BIAS_OFF:
699 codec->dapm.bias_level = level;
704 static int wm0010_set_sysclk(struct snd_soc_codec *codec, int source,
705 int clk_id, unsigned int freq, int dir)
707 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
710 wm0010->sysclk = freq;
712 if (freq < pll_clock_map[ARRAY_SIZE(pll_clock_map)-1].max_sysclk) {
713 wm0010->max_spi_freq = 0;
715 for (i = 0; i < ARRAY_SIZE(pll_clock_map); i++)
716 if (freq >= pll_clock_map[i].max_sysclk)
719 wm0010->max_spi_freq = pll_clock_map[i].max_pll_spi_speed;
720 wm0010->pll_clkctrl1 = pll_clock_map[i].pll_clkctrl1;
726 static int wm0010_probe(struct snd_soc_codec *codec);
728 static struct snd_soc_codec_driver soc_codec_dev_wm0010 = {
729 .probe = wm0010_probe,
730 .set_bias_level = wm0010_set_bias_level,
731 .set_sysclk = wm0010_set_sysclk,
732 .idle_bias_off = true,
734 .dapm_widgets = wm0010_dapm_widgets,
735 .num_dapm_widgets = ARRAY_SIZE(wm0010_dapm_widgets),
736 .dapm_routes = wm0010_dapm_routes,
737 .num_dapm_routes = ARRAY_SIZE(wm0010_dapm_routes),
740 #define WM0010_RATES (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
741 #define WM0010_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |\
742 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE |\
743 SNDRV_PCM_FMTBIT_S32_LE)
745 static struct snd_soc_dai_driver wm0010_dai[] = {
747 .name = "wm0010-sdi1",
749 .stream_name = "SDI1 Playback",
752 .rates = WM0010_RATES,
753 .formats = WM0010_FORMATS,
756 .stream_name = "SDI1 Capture",
759 .rates = WM0010_RATES,
760 .formats = WM0010_FORMATS,
764 .name = "wm0010-sdi2",
766 .stream_name = "SDI2 Playback",
769 .rates = WM0010_RATES,
770 .formats = WM0010_FORMATS,
773 .stream_name = "SDI2 Capture",
776 .rates = WM0010_RATES,
777 .formats = WM0010_FORMATS,
782 static irqreturn_t wm0010_irq(int irq, void *data)
784 struct wm0010_priv *wm0010 = data;
786 switch (wm0010->state) {
787 case WM0010_POWER_OFF:
788 case WM0010_OUT_OF_RESET:
791 spin_lock(&wm0010->irq_lock);
792 complete(&wm0010->boot_completion);
793 spin_unlock(&wm0010->irq_lock);
802 static int wm0010_probe(struct snd_soc_codec *codec)
804 struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
806 wm0010->codec = codec;
811 static int __devinit wm0010_spi_probe(struct spi_device *spi)
813 unsigned long gpio_flags;
817 struct wm0010_priv *wm0010;
819 wm0010 = devm_kzalloc(&spi->dev, sizeof(*wm0010),
824 mutex_init(&wm0010->lock);
825 spin_lock_init(&wm0010->irq_lock);
827 spi_set_drvdata(spi, wm0010);
828 wm0010->dev = &spi->dev;
830 if (dev_get_platdata(&spi->dev))
831 memcpy(&wm0010->pdata, dev_get_platdata(&spi->dev),
832 sizeof(wm0010->pdata));
834 init_completion(&wm0010->boot_completion);
836 wm0010->core_supplies[0].supply = "AVDD";
837 wm0010->core_supplies[1].supply = "DCVDD";
838 ret = devm_regulator_bulk_get(wm0010->dev, ARRAY_SIZE(wm0010->core_supplies),
839 wm0010->core_supplies);
841 dev_err(wm0010->dev, "Failed to obtain core supplies: %d\n",
846 wm0010->dbvdd = devm_regulator_get(wm0010->dev, "DBVDD");
847 if (IS_ERR(wm0010->dbvdd)) {
848 ret = PTR_ERR(wm0010->dbvdd);
849 dev_err(wm0010->dev, "Failed to obtain DBVDD: %d\n", ret);
853 if (wm0010->pdata.gpio_reset) {
854 wm0010->gpio_reset = wm0010->pdata.gpio_reset;
856 if (wm0010->pdata.reset_active_high)
857 wm0010->gpio_reset_value = 1;
859 wm0010->gpio_reset_value = 0;
861 if (wm0010->gpio_reset_value)
862 gpio_flags = GPIOF_OUT_INIT_HIGH;
864 gpio_flags = GPIOF_OUT_INIT_LOW;
866 ret = devm_gpio_request_one(wm0010->dev, wm0010->gpio_reset,
867 gpio_flags, "wm0010 reset");
870 "Failed to request GPIO for DSP reset: %d\n",
875 dev_err(wm0010->dev, "No reset GPIO configured\n");
879 wm0010->state = WM0010_POWER_OFF;
882 if (wm0010->pdata.irq_flags)
883 trigger = wm0010->pdata.irq_flags;
885 trigger = IRQF_TRIGGER_FALLING;
886 trigger |= IRQF_ONESHOT;
888 ret = request_threaded_irq(irq, NULL, wm0010_irq, trigger | IRQF_ONESHOT,
891 dev_err(wm0010->dev, "Failed to request IRQ %d: %d\n",
897 if (spi->max_speed_hz)
898 wm0010->board_max_spi_speed = spi->max_speed_hz;
900 wm0010->board_max_spi_speed = 0;
902 ret = snd_soc_register_codec(&spi->dev,
903 &soc_codec_dev_wm0010, wm0010_dai,
904 ARRAY_SIZE(wm0010_dai));
911 static int __devexit wm0010_spi_remove(struct spi_device *spi)
913 struct wm0010_priv *wm0010 = spi_get_drvdata(spi);
915 snd_soc_unregister_codec(&spi->dev);
917 gpio_set_value_cansleep(wm0010->gpio_reset,
918 wm0010->gpio_reset_value);
921 free_irq(wm0010->irq, wm0010);
926 static struct spi_driver wm0010_spi_driver = {
929 .bus = &spi_bus_type,
930 .owner = THIS_MODULE,
932 .probe = wm0010_spi_probe,
933 .remove = __devexit_p(wm0010_spi_remove),
936 module_spi_driver(wm0010_spi_driver);
938 MODULE_DESCRIPTION("ASoC WM0010 driver");
939 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
940 MODULE_LICENSE("GPL");