wm0010.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017
  1. /*
  2. * wm0010.c -- WM0010 DSP Driver
  3. *
  4. * Copyright 2012 Wolfson Microelectronics PLC.
  5. *
  6. * Authors: Mark Brown <broonie@opensource.wolfsonmicro.com>
  7. * Dimitris Papastamos <dp@opensource.wolfsonmicro.com>
  8. * Scott Ling <sl@opensource.wolfsonmicro.com>
  9. *
  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.
  13. */
  14. #include <linux/module.h>
  15. #include <linux/moduleparam.h>
  16. #include <linux/irqreturn.h>
  17. #include <linux/init.h>
  18. #include <linux/spi/spi.h>
  19. #include <linux/firmware.h>
  20. #include <linux/delay.h>
  21. #include <linux/fs.h>
  22. #include <linux/miscdevice.h>
  23. #include <linux/gpio.h>
  24. #include <linux/regulator/consumer.h>
  25. #include <linux/mutex.h>
  26. #include <linux/workqueue.h>
  27. #include <sound/soc.h>
  28. #include <sound/wm0010.h>
  29. #define DEVICE_ID_WM0010 10
  30. /* We only support v1 of the .dfw INFO record */
  31. #define INFO_VERSION 1
  32. enum dfw_cmd {
  33. DFW_CMD_FUSE = 0x01,
  34. DFW_CMD_CODE_HDR,
  35. DFW_CMD_CODE_DATA,
  36. DFW_CMD_PLL,
  37. DFW_CMD_INFO = 0xff
  38. };
  39. struct dfw_binrec {
  40. u8 command;
  41. u32 length:24;
  42. u32 address;
  43. uint8_t data[0];
  44. } __packed;
  45. struct dfw_inforec {
  46. u8 info_version;
  47. u8 tool_major_version;
  48. u8 tool_minor_version;
  49. u8 dsp_target;
  50. };
  51. struct dfw_pllrec {
  52. u8 command;
  53. u32 length:24;
  54. u32 address;
  55. u32 clkctrl1;
  56. u32 clkctrl2;
  57. u32 clkctrl3;
  58. u32 ldetctrl;
  59. u32 uart_div;
  60. u32 spi_div;
  61. } __packed;
  62. static struct pll_clock_map {
  63. int max_sysclk;
  64. int max_pll_spi_speed;
  65. u32 pll_clkctrl1;
  66. } pll_clock_map[] = { /* Dividers */
  67. { 22000000, 26000000, 0x00201f11 }, /* 2,32,2 */
  68. { 18000000, 26000000, 0x00203f21 }, /* 2,64,4 */
  69. { 14000000, 26000000, 0x00202620 }, /* 1,39,4 */
  70. { 10000000, 22000000, 0x00203120 }, /* 1,50,4 */
  71. { 6500000, 22000000, 0x00204520 }, /* 1,70,4 */
  72. { 5500000, 22000000, 0x00103f10 }, /* 1,64,2 */
  73. };
  74. enum wm0010_state {
  75. WM0010_POWER_OFF,
  76. WM0010_OUT_OF_RESET,
  77. WM0010_BOOTROM,
  78. WM0010_STAGE2,
  79. WM0010_FIRMWARE,
  80. };
  81. struct wm0010_priv {
  82. struct snd_soc_codec *codec;
  83. struct mutex lock;
  84. struct device *dev;
  85. struct wm0010_pdata pdata;
  86. int gpio_reset;
  87. int gpio_reset_value;
  88. struct regulator_bulk_data core_supplies[2];
  89. struct regulator *dbvdd;
  90. int sysclk;
  91. enum wm0010_state state;
  92. bool boot_failed;
  93. bool ready;
  94. bool pll_running;
  95. int max_spi_freq;
  96. int board_max_spi_speed;
  97. u32 pll_clkctrl1;
  98. spinlock_t irq_lock;
  99. int irq;
  100. struct completion boot_completion;
  101. };
  102. struct wm0010_spi_msg {
  103. struct spi_message m;
  104. struct spi_transfer t;
  105. u8 *tx_buf;
  106. u8 *rx_buf;
  107. size_t len;
  108. };
  109. static const struct snd_soc_dapm_widget wm0010_dapm_widgets[] = {
  110. SND_SOC_DAPM_SUPPLY("CLKIN", SND_SOC_NOPM, 0, 0, NULL, 0),
  111. };
  112. static const struct snd_soc_dapm_route wm0010_dapm_routes[] = {
  113. { "SDI2 Capture", NULL, "SDI1 Playback" },
  114. { "SDI1 Capture", NULL, "SDI2 Playback" },
  115. { "SDI1 Capture", NULL, "CLKIN" },
  116. { "SDI2 Capture", NULL, "CLKIN" },
  117. { "SDI1 Playback", NULL, "CLKIN" },
  118. { "SDI2 Playback", NULL, "CLKIN" },
  119. };
  120. static const char *wm0010_state_to_str(enum wm0010_state state)
  121. {
  122. const char *state_to_str[] = {
  123. "Power off",
  124. "Out of reset",
  125. "Boot ROM",
  126. "Stage2",
  127. "Firmware"
  128. };
  129. if (state < 0 || state >= ARRAY_SIZE(state_to_str))
  130. return "null";
  131. return state_to_str[state];
  132. }
  133. /* Called with wm0010->lock held */
  134. static void wm0010_halt(struct snd_soc_codec *codec)
  135. {
  136. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  137. unsigned long flags;
  138. enum wm0010_state state;
  139. /* Fetch the wm0010 state */
  140. spin_lock_irqsave(&wm0010->irq_lock, flags);
  141. state = wm0010->state;
  142. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  143. switch (state) {
  144. case WM0010_POWER_OFF:
  145. /* If there's nothing to do, bail out */
  146. return;
  147. case WM0010_OUT_OF_RESET:
  148. case WM0010_BOOTROM:
  149. case WM0010_STAGE2:
  150. case WM0010_FIRMWARE:
  151. /* Remember to put chip back into reset */
  152. gpio_set_value_cansleep(wm0010->gpio_reset,
  153. wm0010->gpio_reset_value);
  154. /* Disable the regulators */
  155. regulator_disable(wm0010->dbvdd);
  156. regulator_bulk_disable(ARRAY_SIZE(wm0010->core_supplies),
  157. wm0010->core_supplies);
  158. break;
  159. }
  160. spin_lock_irqsave(&wm0010->irq_lock, flags);
  161. wm0010->state = WM0010_POWER_OFF;
  162. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  163. }
  164. struct wm0010_boot_xfer {
  165. struct list_head list;
  166. struct snd_soc_codec *codec;
  167. struct completion *done;
  168. struct spi_message m;
  169. struct spi_transfer t;
  170. };
  171. /* Called with wm0010->lock held */
  172. static void wm0010_mark_boot_failure(struct wm0010_priv *wm0010)
  173. {
  174. enum wm0010_state state;
  175. unsigned long flags;
  176. spin_lock_irqsave(&wm0010->irq_lock, flags);
  177. state = wm0010->state;
  178. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  179. dev_err(wm0010->dev, "Failed to transition from `%s' state to `%s' state\n",
  180. wm0010_state_to_str(state), wm0010_state_to_str(state + 1));
  181. wm0010->boot_failed = true;
  182. }
  183. static void wm0010_boot_xfer_complete(void *data)
  184. {
  185. struct wm0010_boot_xfer *xfer = data;
  186. struct snd_soc_codec *codec = xfer->codec;
  187. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  188. u32 *out32 = xfer->t.rx_buf;
  189. int i;
  190. if (xfer->m.status != 0) {
  191. dev_err(codec->dev, "SPI transfer failed: %d\n",
  192. xfer->m.status);
  193. wm0010_mark_boot_failure(wm0010);
  194. if (xfer->done)
  195. complete(xfer->done);
  196. return;
  197. }
  198. for (i = 0; i < xfer->t.len / 4; i++) {
  199. dev_dbg(codec->dev, "%d: %04x\n", i, out32[i]);
  200. switch (be32_to_cpu(out32[i])) {
  201. case 0xe0e0e0e0:
  202. dev_err(codec->dev,
  203. "%d: ROM error reported in stage 2\n", i);
  204. wm0010_mark_boot_failure(wm0010);
  205. break;
  206. case 0x55555555:
  207. if (wm0010->state < WM0010_STAGE2)
  208. break;
  209. dev_err(codec->dev,
  210. "%d: ROM bootloader running in stage 2\n", i);
  211. wm0010_mark_boot_failure(wm0010);
  212. break;
  213. case 0x0fed0000:
  214. dev_dbg(codec->dev, "Stage2 loader running\n");
  215. break;
  216. case 0x0fed0007:
  217. dev_dbg(codec->dev, "CODE_HDR packet received\n");
  218. break;
  219. case 0x0fed0008:
  220. dev_dbg(codec->dev, "CODE_DATA packet received\n");
  221. break;
  222. case 0x0fed0009:
  223. dev_dbg(codec->dev, "Download complete\n");
  224. break;
  225. case 0x0fed000c:
  226. dev_dbg(codec->dev, "Application start\n");
  227. break;
  228. case 0x0fed000e:
  229. dev_dbg(codec->dev, "PLL packet received\n");
  230. wm0010->pll_running = true;
  231. break;
  232. case 0x0fed0025:
  233. dev_err(codec->dev, "Device reports image too long\n");
  234. wm0010_mark_boot_failure(wm0010);
  235. break;
  236. case 0x0fed002c:
  237. dev_err(codec->dev, "Device reports bad SPI packet\n");
  238. wm0010_mark_boot_failure(wm0010);
  239. break;
  240. case 0x0fed0031:
  241. dev_err(codec->dev, "Device reports SPI read overflow\n");
  242. wm0010_mark_boot_failure(wm0010);
  243. break;
  244. case 0x0fed0032:
  245. dev_err(codec->dev, "Device reports SPI underclock\n");
  246. wm0010_mark_boot_failure(wm0010);
  247. break;
  248. case 0x0fed0033:
  249. dev_err(codec->dev, "Device reports bad header packet\n");
  250. wm0010_mark_boot_failure(wm0010);
  251. break;
  252. case 0x0fed0034:
  253. dev_err(codec->dev, "Device reports invalid packet type\n");
  254. wm0010_mark_boot_failure(wm0010);
  255. break;
  256. case 0x0fed0035:
  257. dev_err(codec->dev, "Device reports data before header error\n");
  258. wm0010_mark_boot_failure(wm0010);
  259. break;
  260. case 0x0fed0038:
  261. dev_err(codec->dev, "Device reports invalid PLL packet\n");
  262. break;
  263. case 0x0fed003a:
  264. dev_err(codec->dev, "Device reports packet alignment error\n");
  265. wm0010_mark_boot_failure(wm0010);
  266. break;
  267. default:
  268. dev_err(codec->dev, "Unrecognised return 0x%x\n",
  269. be32_to_cpu(out32[i]));
  270. wm0010_mark_boot_failure(wm0010);
  271. break;
  272. }
  273. if (wm0010->boot_failed)
  274. break;
  275. }
  276. if (xfer->done)
  277. complete(xfer->done);
  278. }
  279. static void byte_swap_64(u64 *data_in, u64 *data_out, u32 len)
  280. {
  281. int i;
  282. for (i = 0; i < len / 8; i++)
  283. data_out[i] = cpu_to_be64(le64_to_cpu(data_in[i]));
  284. }
  285. static int wm0010_firmware_load(char *name, struct snd_soc_codec *codec)
  286. {
  287. struct spi_device *spi = to_spi_device(codec->dev);
  288. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  289. struct list_head xfer_list;
  290. struct wm0010_boot_xfer *xfer;
  291. int ret;
  292. struct completion done;
  293. const struct firmware *fw;
  294. const struct dfw_binrec *rec;
  295. const struct dfw_inforec *inforec;
  296. u64 *img;
  297. u8 *out, dsp;
  298. u32 len, offset;
  299. INIT_LIST_HEAD(&xfer_list);
  300. ret = request_firmware(&fw, name, codec->dev);
  301. if (ret != 0) {
  302. dev_err(codec->dev, "Failed to request application: %d\n",
  303. ret);
  304. return ret;
  305. }
  306. rec = (const struct dfw_binrec *)fw->data;
  307. inforec = (const struct dfw_inforec *)rec->data;
  308. offset = 0;
  309. dsp = inforec->dsp_target;
  310. wm0010->boot_failed = false;
  311. BUG_ON(!list_empty(&xfer_list));
  312. init_completion(&done);
  313. /* First record should be INFO */
  314. if (rec->command != DFW_CMD_INFO) {
  315. dev_err(codec->dev, "First record not INFO\r\n");
  316. ret = -EINVAL;
  317. goto abort;
  318. }
  319. if (inforec->info_version != INFO_VERSION) {
  320. dev_err(codec->dev,
  321. "Unsupported version (%02d) of INFO record\r\n",
  322. inforec->info_version);
  323. ret = -EINVAL;
  324. goto abort;
  325. }
  326. dev_dbg(codec->dev, "Version v%02d INFO record found\r\n",
  327. inforec->info_version);
  328. /* Check it's a DSP file */
  329. if (dsp != DEVICE_ID_WM0010) {
  330. dev_err(codec->dev, "Not a WM0010 firmware file.\r\n");
  331. ret = -EINVAL;
  332. goto abort;
  333. }
  334. /* Skip the info record as we don't need to send it */
  335. offset += ((rec->length) + 8);
  336. rec = (void *)&rec->data[rec->length];
  337. while (offset < fw->size) {
  338. dev_dbg(codec->dev,
  339. "Packet: command %d, data length = 0x%x\r\n",
  340. rec->command, rec->length);
  341. len = rec->length + 8;
  342. out = kzalloc(len, GFP_KERNEL);
  343. if (!out) {
  344. dev_err(codec->dev,
  345. "Failed to allocate RX buffer\n");
  346. ret = -ENOMEM;
  347. goto abort1;
  348. }
  349. img = kzalloc(len, GFP_KERNEL);
  350. if (!img) {
  351. dev_err(codec->dev,
  352. "Failed to allocate image buffer\n");
  353. ret = -ENOMEM;
  354. goto abort1;
  355. }
  356. byte_swap_64((u64 *)&rec->command, img, len);
  357. xfer = kzalloc(sizeof(*xfer), GFP_KERNEL);
  358. if (!xfer) {
  359. dev_err(codec->dev, "Failed to allocate xfer\n");
  360. ret = -ENOMEM;
  361. goto abort1;
  362. }
  363. xfer->codec = codec;
  364. list_add_tail(&xfer->list, &xfer_list);
  365. spi_message_init(&xfer->m);
  366. xfer->m.complete = wm0010_boot_xfer_complete;
  367. xfer->m.context = xfer;
  368. xfer->t.tx_buf = img;
  369. xfer->t.rx_buf = out;
  370. xfer->t.len = len;
  371. xfer->t.bits_per_word = 8;
  372. if (!wm0010->pll_running) {
  373. xfer->t.speed_hz = wm0010->sysclk / 6;
  374. } else {
  375. xfer->t.speed_hz = wm0010->max_spi_freq;
  376. if (wm0010->board_max_spi_speed &&
  377. (wm0010->board_max_spi_speed < wm0010->max_spi_freq))
  378. xfer->t.speed_hz = wm0010->board_max_spi_speed;
  379. }
  380. /* Store max usable spi frequency for later use */
  381. wm0010->max_spi_freq = xfer->t.speed_hz;
  382. spi_message_add_tail(&xfer->t, &xfer->m);
  383. offset += ((rec->length) + 8);
  384. rec = (void *)&rec->data[rec->length];
  385. if (offset >= fw->size) {
  386. dev_dbg(codec->dev, "All transfers scheduled\n");
  387. xfer->done = &done;
  388. }
  389. ret = spi_async(spi, &xfer->m);
  390. if (ret != 0) {
  391. dev_err(codec->dev, "Write failed: %d\n", ret);
  392. goto abort1;
  393. }
  394. if (wm0010->boot_failed) {
  395. dev_dbg(codec->dev, "Boot fail!\n");
  396. ret = -EINVAL;
  397. goto abort1;
  398. }
  399. }
  400. wait_for_completion(&done);
  401. ret = 0;
  402. abort1:
  403. while (!list_empty(&xfer_list)) {
  404. xfer = list_first_entry(&xfer_list, struct wm0010_boot_xfer,
  405. list);
  406. kfree(xfer->t.rx_buf);
  407. kfree(xfer->t.tx_buf);
  408. list_del(&xfer->list);
  409. kfree(xfer);
  410. }
  411. abort:
  412. release_firmware(fw);
  413. return ret;
  414. }
  415. static int wm0010_stage2_load(struct snd_soc_codec *codec)
  416. {
  417. struct spi_device *spi = to_spi_device(codec->dev);
  418. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  419. const struct firmware *fw;
  420. struct spi_message m;
  421. struct spi_transfer t;
  422. u32 *img;
  423. u8 *out;
  424. int i;
  425. int ret = 0;
  426. ret = request_firmware(&fw, "wm0010_stage2.bin", codec->dev);
  427. if (ret != 0) {
  428. dev_err(codec->dev, "Failed to request stage2 loader: %d\n",
  429. ret);
  430. return ret;
  431. }
  432. dev_dbg(codec->dev, "Downloading %zu byte stage 2 loader\n", fw->size);
  433. /* Copy to local buffer first as vmalloc causes problems for dma */
  434. img = kzalloc(fw->size, GFP_KERNEL);
  435. if (!img) {
  436. dev_err(codec->dev, "Failed to allocate image buffer\n");
  437. ret = -ENOMEM;
  438. goto abort2;
  439. }
  440. out = kzalloc(fw->size, GFP_KERNEL);
  441. if (!out) {
  442. dev_err(codec->dev, "Failed to allocate output buffer\n");
  443. ret = -ENOMEM;
  444. goto abort1;
  445. }
  446. memcpy(img, &fw->data[0], fw->size);
  447. spi_message_init(&m);
  448. memset(&t, 0, sizeof(t));
  449. t.rx_buf = out;
  450. t.tx_buf = img;
  451. t.len = fw->size;
  452. t.bits_per_word = 8;
  453. t.speed_hz = wm0010->sysclk / 10;
  454. spi_message_add_tail(&t, &m);
  455. dev_dbg(codec->dev, "Starting initial download at %dHz\n",
  456. t.speed_hz);
  457. ret = spi_sync(spi, &m);
  458. if (ret != 0) {
  459. dev_err(codec->dev, "Initial download failed: %d\n", ret);
  460. goto abort;
  461. }
  462. /* Look for errors from the boot ROM */
  463. for (i = 0; i < fw->size; i++) {
  464. if (out[i] != 0x55) {
  465. dev_err(codec->dev, "Boot ROM error: %x in %d\n",
  466. out[i], i);
  467. wm0010_mark_boot_failure(wm0010);
  468. ret = -EBUSY;
  469. goto abort;
  470. }
  471. }
  472. abort:
  473. kfree(out);
  474. abort1:
  475. kfree(img);
  476. abort2:
  477. release_firmware(fw);
  478. return ret;
  479. }
  480. static int wm0010_boot(struct snd_soc_codec *codec)
  481. {
  482. struct spi_device *spi = to_spi_device(codec->dev);
  483. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  484. unsigned long flags;
  485. int ret;
  486. const struct firmware *fw;
  487. struct spi_message m;
  488. struct spi_transfer t;
  489. struct dfw_pllrec pll_rec;
  490. u32 *p, len;
  491. u64 *img_swap;
  492. u8 *out;
  493. int i;
  494. spin_lock_irqsave(&wm0010->irq_lock, flags);
  495. if (wm0010->state != WM0010_POWER_OFF)
  496. dev_warn(wm0010->dev, "DSP already powered up!\n");
  497. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  498. if (wm0010->sysclk > 26000000) {
  499. dev_err(codec->dev, "Max DSP clock frequency is 26MHz\n");
  500. ret = -ECANCELED;
  501. goto err;
  502. }
  503. mutex_lock(&wm0010->lock);
  504. wm0010->pll_running = false;
  505. dev_dbg(codec->dev, "max_spi_freq: %d\n", wm0010->max_spi_freq);
  506. ret = regulator_bulk_enable(ARRAY_SIZE(wm0010->core_supplies),
  507. wm0010->core_supplies);
  508. if (ret != 0) {
  509. dev_err(&spi->dev, "Failed to enable core supplies: %d\n",
  510. ret);
  511. mutex_unlock(&wm0010->lock);
  512. goto err;
  513. }
  514. ret = regulator_enable(wm0010->dbvdd);
  515. if (ret != 0) {
  516. dev_err(&spi->dev, "Failed to enable DBVDD: %d\n", ret);
  517. goto err_core;
  518. }
  519. /* Release reset */
  520. gpio_set_value_cansleep(wm0010->gpio_reset, !wm0010->gpio_reset_value);
  521. spin_lock_irqsave(&wm0010->irq_lock, flags);
  522. wm0010->state = WM0010_OUT_OF_RESET;
  523. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  524. /* First the bootloader */
  525. ret = request_firmware(&fw, "wm0010_stage2.bin", codec->dev);
  526. if (ret != 0) {
  527. dev_err(codec->dev, "Failed to request stage2 loader: %d\n",
  528. ret);
  529. goto abort;
  530. }
  531. if (!wait_for_completion_timeout(&wm0010->boot_completion,
  532. msecs_to_jiffies(20)))
  533. dev_err(codec->dev, "Failed to get interrupt from DSP\n");
  534. spin_lock_irqsave(&wm0010->irq_lock, flags);
  535. wm0010->state = WM0010_BOOTROM;
  536. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  537. ret = wm0010_stage2_load(codec);
  538. if (ret)
  539. goto abort;
  540. if (!wait_for_completion_timeout(&wm0010->boot_completion,
  541. msecs_to_jiffies(20)))
  542. dev_err(codec->dev, "Failed to get interrupt from DSP loader.\n");
  543. spin_lock_irqsave(&wm0010->irq_lock, flags);
  544. wm0010->state = WM0010_STAGE2;
  545. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  546. /* Only initialise PLL if max_spi_freq initialised */
  547. if (wm0010->max_spi_freq) {
  548. /* Initialise a PLL record */
  549. memset(&pll_rec, 0, sizeof(pll_rec));
  550. pll_rec.command = DFW_CMD_PLL;
  551. pll_rec.length = (sizeof(pll_rec) - 8);
  552. /* On wm0010 only the CLKCTRL1 value is used */
  553. pll_rec.clkctrl1 = wm0010->pll_clkctrl1;
  554. len = pll_rec.length + 8;
  555. out = kzalloc(len, GFP_KERNEL);
  556. if (!out) {
  557. dev_err(codec->dev,
  558. "Failed to allocate RX buffer\n");
  559. goto abort;
  560. }
  561. img_swap = kzalloc(len, GFP_KERNEL);
  562. if (!img_swap) {
  563. dev_err(codec->dev,
  564. "Failed to allocate image buffer\n");
  565. goto abort;
  566. }
  567. /* We need to re-order for 0010 */
  568. byte_swap_64((u64 *)&pll_rec, img_swap, len);
  569. spi_message_init(&m);
  570. memset(&t, 0, sizeof(t));
  571. t.rx_buf = out;
  572. t.tx_buf = img_swap;
  573. t.len = len;
  574. t.bits_per_word = 8;
  575. t.speed_hz = wm0010->sysclk / 6;
  576. spi_message_add_tail(&t, &m);
  577. ret = spi_sync(spi, &m);
  578. if (ret != 0) {
  579. dev_err(codec->dev, "First PLL write failed: %d\n", ret);
  580. goto abort;
  581. }
  582. /* Use a second send of the message to get the return status */
  583. ret = spi_sync(spi, &m);
  584. if (ret != 0) {
  585. dev_err(codec->dev, "Second PLL write failed: %d\n", ret);
  586. goto abort;
  587. }
  588. p = (u32 *)out;
  589. /* Look for PLL active code from the DSP */
  590. for (i = 0; i < len / 4; i++) {
  591. if (*p == 0x0e00ed0f) {
  592. dev_dbg(codec->dev, "PLL packet received\n");
  593. wm0010->pll_running = true;
  594. break;
  595. }
  596. p++;
  597. }
  598. kfree(img_swap);
  599. kfree(out);
  600. } else
  601. dev_dbg(codec->dev, "Not enabling DSP PLL.");
  602. ret = wm0010_firmware_load("wm0010.dfw", codec);
  603. if (ret != 0)
  604. goto abort;
  605. spin_lock_irqsave(&wm0010->irq_lock, flags);
  606. wm0010->state = WM0010_FIRMWARE;
  607. spin_unlock_irqrestore(&wm0010->irq_lock, flags);
  608. mutex_unlock(&wm0010->lock);
  609. return 0;
  610. abort:
  611. /* Put the chip back into reset */
  612. wm0010_halt(codec);
  613. mutex_unlock(&wm0010->lock);
  614. return ret;
  615. err_core:
  616. mutex_unlock(&wm0010->lock);
  617. regulator_bulk_disable(ARRAY_SIZE(wm0010->core_supplies),
  618. wm0010->core_supplies);
  619. err:
  620. return ret;
  621. }
  622. static int wm0010_set_bias_level(struct snd_soc_codec *codec,
  623. enum snd_soc_bias_level level)
  624. {
  625. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  626. switch (level) {
  627. case SND_SOC_BIAS_ON:
  628. if (codec->dapm.bias_level == SND_SOC_BIAS_PREPARE)
  629. wm0010_boot(codec);
  630. break;
  631. case SND_SOC_BIAS_PREPARE:
  632. break;
  633. case SND_SOC_BIAS_STANDBY:
  634. if (codec->dapm.bias_level == SND_SOC_BIAS_PREPARE) {
  635. mutex_lock(&wm0010->lock);
  636. wm0010_halt(codec);
  637. mutex_unlock(&wm0010->lock);
  638. }
  639. break;
  640. case SND_SOC_BIAS_OFF:
  641. break;
  642. }
  643. codec->dapm.bias_level = level;
  644. return 0;
  645. }
  646. static int wm0010_set_sysclk(struct snd_soc_codec *codec, int source,
  647. int clk_id, unsigned int freq, int dir)
  648. {
  649. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  650. unsigned int i;
  651. wm0010->sysclk = freq;
  652. if (freq < pll_clock_map[ARRAY_SIZE(pll_clock_map)-1].max_sysclk) {
  653. wm0010->max_spi_freq = 0;
  654. } else {
  655. for (i = 0; i < ARRAY_SIZE(pll_clock_map); i++)
  656. if (freq >= pll_clock_map[i].max_sysclk)
  657. break;
  658. wm0010->max_spi_freq = pll_clock_map[i].max_pll_spi_speed;
  659. wm0010->pll_clkctrl1 = pll_clock_map[i].pll_clkctrl1;
  660. }
  661. return 0;
  662. }
  663. static int wm0010_probe(struct snd_soc_codec *codec);
  664. static struct snd_soc_codec_driver soc_codec_dev_wm0010 = {
  665. .probe = wm0010_probe,
  666. .set_bias_level = wm0010_set_bias_level,
  667. .set_sysclk = wm0010_set_sysclk,
  668. .idle_bias_off = true,
  669. .dapm_widgets = wm0010_dapm_widgets,
  670. .num_dapm_widgets = ARRAY_SIZE(wm0010_dapm_widgets),
  671. .dapm_routes = wm0010_dapm_routes,
  672. .num_dapm_routes = ARRAY_SIZE(wm0010_dapm_routes),
  673. };
  674. #define WM0010_RATES (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
  675. #define WM0010_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE |\
  676. SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE |\
  677. SNDRV_PCM_FMTBIT_S32_LE)
  678. static struct snd_soc_dai_driver wm0010_dai[] = {
  679. {
  680. .name = "wm0010-sdi1",
  681. .playback = {
  682. .stream_name = "SDI1 Playback",
  683. .channels_min = 1,
  684. .channels_max = 2,
  685. .rates = WM0010_RATES,
  686. .formats = WM0010_FORMATS,
  687. },
  688. .capture = {
  689. .stream_name = "SDI1 Capture",
  690. .channels_min = 1,
  691. .channels_max = 2,
  692. .rates = WM0010_RATES,
  693. .formats = WM0010_FORMATS,
  694. },
  695. },
  696. {
  697. .name = "wm0010-sdi2",
  698. .playback = {
  699. .stream_name = "SDI2 Playback",
  700. .channels_min = 1,
  701. .channels_max = 2,
  702. .rates = WM0010_RATES,
  703. .formats = WM0010_FORMATS,
  704. },
  705. .capture = {
  706. .stream_name = "SDI2 Capture",
  707. .channels_min = 1,
  708. .channels_max = 2,
  709. .rates = WM0010_RATES,
  710. .formats = WM0010_FORMATS,
  711. },
  712. },
  713. };
  714. static irqreturn_t wm0010_irq(int irq, void *data)
  715. {
  716. struct wm0010_priv *wm0010 = data;
  717. switch (wm0010->state) {
  718. case WM0010_OUT_OF_RESET:
  719. case WM0010_BOOTROM:
  720. case WM0010_STAGE2:
  721. spin_lock(&wm0010->irq_lock);
  722. complete(&wm0010->boot_completion);
  723. spin_unlock(&wm0010->irq_lock);
  724. return IRQ_HANDLED;
  725. default:
  726. return IRQ_NONE;
  727. }
  728. return IRQ_NONE;
  729. }
  730. static int wm0010_probe(struct snd_soc_codec *codec)
  731. {
  732. struct wm0010_priv *wm0010 = snd_soc_codec_get_drvdata(codec);
  733. wm0010->codec = codec;
  734. return 0;
  735. }
  736. static int wm0010_spi_probe(struct spi_device *spi)
  737. {
  738. unsigned long gpio_flags;
  739. int ret;
  740. int trigger;
  741. int irq;
  742. struct wm0010_priv *wm0010;
  743. wm0010 = devm_kzalloc(&spi->dev, sizeof(*wm0010),
  744. GFP_KERNEL);
  745. if (!wm0010)
  746. return -ENOMEM;
  747. mutex_init(&wm0010->lock);
  748. spin_lock_init(&wm0010->irq_lock);
  749. spi_set_drvdata(spi, wm0010);
  750. wm0010->dev = &spi->dev;
  751. if (dev_get_platdata(&spi->dev))
  752. memcpy(&wm0010->pdata, dev_get_platdata(&spi->dev),
  753. sizeof(wm0010->pdata));
  754. init_completion(&wm0010->boot_completion);
  755. wm0010->core_supplies[0].supply = "AVDD";
  756. wm0010->core_supplies[1].supply = "DCVDD";
  757. ret = devm_regulator_bulk_get(wm0010->dev, ARRAY_SIZE(wm0010->core_supplies),
  758. wm0010->core_supplies);
  759. if (ret != 0) {
  760. dev_err(wm0010->dev, "Failed to obtain core supplies: %d\n",
  761. ret);
  762. return ret;
  763. }
  764. wm0010->dbvdd = devm_regulator_get(wm0010->dev, "DBVDD");
  765. if (IS_ERR(wm0010->dbvdd)) {
  766. ret = PTR_ERR(wm0010->dbvdd);
  767. dev_err(wm0010->dev, "Failed to obtain DBVDD: %d\n", ret);
  768. return ret;
  769. }
  770. if (wm0010->pdata.gpio_reset) {
  771. wm0010->gpio_reset = wm0010->pdata.gpio_reset;
  772. if (wm0010->pdata.reset_active_high)
  773. wm0010->gpio_reset_value = 1;
  774. else
  775. wm0010->gpio_reset_value = 0;
  776. if (wm0010->gpio_reset_value)
  777. gpio_flags = GPIOF_OUT_INIT_HIGH;
  778. else
  779. gpio_flags = GPIOF_OUT_INIT_LOW;
  780. ret = devm_gpio_request_one(wm0010->dev, wm0010->gpio_reset,
  781. gpio_flags, "wm0010 reset");
  782. if (ret < 0) {
  783. dev_err(wm0010->dev,
  784. "Failed to request GPIO for DSP reset: %d\n",
  785. ret);
  786. return ret;
  787. }
  788. } else {
  789. dev_err(wm0010->dev, "No reset GPIO configured\n");
  790. return -EINVAL;
  791. }
  792. wm0010->state = WM0010_POWER_OFF;
  793. irq = spi->irq;
  794. if (wm0010->pdata.irq_flags)
  795. trigger = wm0010->pdata.irq_flags;
  796. else
  797. trigger = IRQF_TRIGGER_FALLING;
  798. trigger |= IRQF_ONESHOT;
  799. ret = request_threaded_irq(irq, NULL, wm0010_irq, trigger | IRQF_ONESHOT,
  800. "wm0010", wm0010);
  801. if (ret) {
  802. dev_err(wm0010->dev, "Failed to request IRQ %d: %d\n",
  803. irq, ret);
  804. return ret;
  805. }
  806. wm0010->irq = irq;
  807. if (spi->max_speed_hz)
  808. wm0010->board_max_spi_speed = spi->max_speed_hz;
  809. else
  810. wm0010->board_max_spi_speed = 0;
  811. ret = snd_soc_register_codec(&spi->dev,
  812. &soc_codec_dev_wm0010, wm0010_dai,
  813. ARRAY_SIZE(wm0010_dai));
  814. if (ret < 0)
  815. return ret;
  816. return 0;
  817. }
  818. static int wm0010_spi_remove(struct spi_device *spi)
  819. {
  820. struct wm0010_priv *wm0010 = spi_get_drvdata(spi);
  821. snd_soc_unregister_codec(&spi->dev);
  822. gpio_set_value_cansleep(wm0010->gpio_reset,
  823. wm0010->gpio_reset_value);
  824. if (wm0010->irq)
  825. free_irq(wm0010->irq, wm0010);
  826. return 0;
  827. }
  828. static struct spi_driver wm0010_spi_driver = {
  829. .driver = {
  830. .name = "wm0010",
  831. .bus = &spi_bus_type,
  832. .owner = THIS_MODULE,
  833. },
  834. .probe = wm0010_spi_probe,
  835. .remove = wm0010_spi_remove,
  836. };
  837. module_spi_driver(wm0010_spi_driver);
  838. MODULE_DESCRIPTION("ASoC WM0010 driver");
  839. MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
  840. MODULE_LICENSE("GPL");