loader.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836
  1. // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
  2. //
  3. // This file is provided under a dual BSD/GPLv2 license. When using or
  4. // redistributing this file, you may do so under either license.
  5. //
  6. // Copyright(c) 2018 Intel Corporation. All rights reserved.
  7. //
  8. // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
  9. //
  10. // Generic firmware loader.
  11. //
  12. #include <linux/firmware.h>
  13. #include <sound/sof.h>
  14. #include <sound/sof/ext_manifest.h>
  15. #include "ops.h"
  16. static int get_ext_windows(struct snd_sof_dev *sdev,
  17. const struct sof_ipc_ext_data_hdr *ext_hdr)
  18. {
  19. const struct sof_ipc_window *w =
  20. container_of(ext_hdr, struct sof_ipc_window, ext_hdr);
  21. if (w->num_windows == 0 || w->num_windows > SOF_IPC_MAX_ELEMS)
  22. return -EINVAL;
  23. if (sdev->info_window) {
  24. if (memcmp(sdev->info_window, w, ext_hdr->hdr.size)) {
  25. dev_err(sdev->dev, "error: mismatch between window descriptor from extended manifest and mailbox");
  26. return -EINVAL;
  27. }
  28. return 0;
  29. }
  30. /* keep a local copy of the data */
  31. sdev->info_window = devm_kmemdup(sdev->dev, w, ext_hdr->hdr.size,
  32. GFP_KERNEL);
  33. if (!sdev->info_window)
  34. return -ENOMEM;
  35. return 0;
  36. }
  37. static int get_cc_info(struct snd_sof_dev *sdev,
  38. const struct sof_ipc_ext_data_hdr *ext_hdr)
  39. {
  40. int ret;
  41. const struct sof_ipc_cc_version *cc =
  42. container_of(ext_hdr, struct sof_ipc_cc_version, ext_hdr);
  43. if (sdev->cc_version) {
  44. if (memcmp(sdev->cc_version, cc, cc->ext_hdr.hdr.size)) {
  45. dev_err(sdev->dev, "error: receive diverged cc_version descriptions");
  46. return -EINVAL;
  47. }
  48. return 0;
  49. }
  50. dev_dbg(sdev->dev, "Firmware info: used compiler %s %d:%d:%d%s used optimization flags %s\n",
  51. cc->name, cc->major, cc->minor, cc->micro, cc->desc,
  52. cc->optim);
  53. /* create read-only cc_version debugfs to store compiler version info */
  54. /* use local copy of the cc_version to prevent data corruption */
  55. if (sdev->first_boot) {
  56. sdev->cc_version = devm_kmalloc(sdev->dev, cc->ext_hdr.hdr.size,
  57. GFP_KERNEL);
  58. if (!sdev->cc_version)
  59. return -ENOMEM;
  60. memcpy(sdev->cc_version, cc, cc->ext_hdr.hdr.size);
  61. ret = snd_sof_debugfs_buf_item(sdev, sdev->cc_version,
  62. cc->ext_hdr.hdr.size,
  63. "cc_version", 0444);
  64. /* errors are only due to memory allocation, not debugfs */
  65. if (ret < 0) {
  66. dev_err(sdev->dev, "error: snd_sof_debugfs_buf_item failed\n");
  67. return ret;
  68. }
  69. }
  70. return 0;
  71. }
  72. /* parse the extended FW boot data structures from FW boot message */
  73. int snd_sof_fw_parse_ext_data(struct snd_sof_dev *sdev, u32 bar, u32 offset)
  74. {
  75. struct sof_ipc_ext_data_hdr *ext_hdr;
  76. void *ext_data;
  77. int ret = 0;
  78. ext_data = kzalloc(PAGE_SIZE, GFP_KERNEL);
  79. if (!ext_data)
  80. return -ENOMEM;
  81. /* get first header */
  82. snd_sof_dsp_block_read(sdev, bar, offset, ext_data,
  83. sizeof(*ext_hdr));
  84. ext_hdr = ext_data;
  85. while (ext_hdr->hdr.cmd == SOF_IPC_FW_READY) {
  86. /* read in ext structure */
  87. snd_sof_dsp_block_read(sdev, bar, offset + sizeof(*ext_hdr),
  88. (void *)((u8 *)ext_data + sizeof(*ext_hdr)),
  89. ext_hdr->hdr.size - sizeof(*ext_hdr));
  90. dev_dbg(sdev->dev, "found ext header type %d size 0x%x\n",
  91. ext_hdr->type, ext_hdr->hdr.size);
  92. /* process structure data */
  93. switch (ext_hdr->type) {
  94. case SOF_IPC_EXT_WINDOW:
  95. ret = get_ext_windows(sdev, ext_hdr);
  96. break;
  97. case SOF_IPC_EXT_CC_INFO:
  98. ret = get_cc_info(sdev, ext_hdr);
  99. break;
  100. case SOF_IPC_EXT_UNUSED:
  101. case SOF_IPC_EXT_PROBE_INFO:
  102. case SOF_IPC_EXT_USER_ABI_INFO:
  103. /* They are supported but we don't do anything here */
  104. break;
  105. default:
  106. dev_warn(sdev->dev, "warning: unknown ext header type %d size 0x%x\n",
  107. ext_hdr->type, ext_hdr->hdr.size);
  108. ret = 0;
  109. break;
  110. }
  111. if (ret < 0) {
  112. dev_err(sdev->dev, "error: failed to parse ext data type %d\n",
  113. ext_hdr->type);
  114. break;
  115. }
  116. /* move to next header */
  117. offset += ext_hdr->hdr.size;
  118. snd_sof_dsp_block_read(sdev, bar, offset, ext_data,
  119. sizeof(*ext_hdr));
  120. ext_hdr = ext_data;
  121. }
  122. kfree(ext_data);
  123. return ret;
  124. }
  125. EXPORT_SYMBOL(snd_sof_fw_parse_ext_data);
  126. static int ext_man_get_fw_version(struct snd_sof_dev *sdev,
  127. const struct sof_ext_man_elem_header *hdr)
  128. {
  129. const struct sof_ext_man_fw_version *v =
  130. container_of(hdr, struct sof_ext_man_fw_version, hdr);
  131. memcpy(&sdev->fw_ready.version, &v->version, sizeof(v->version));
  132. sdev->fw_ready.flags = v->flags;
  133. /* log ABI versions and check FW compatibility */
  134. return snd_sof_ipc_valid(sdev);
  135. }
  136. static int ext_man_get_windows(struct snd_sof_dev *sdev,
  137. const struct sof_ext_man_elem_header *hdr)
  138. {
  139. const struct sof_ext_man_window *w;
  140. w = container_of(hdr, struct sof_ext_man_window, hdr);
  141. return get_ext_windows(sdev, &w->ipc_window.ext_hdr);
  142. }
  143. static int ext_man_get_cc_info(struct snd_sof_dev *sdev,
  144. const struct sof_ext_man_elem_header *hdr)
  145. {
  146. const struct sof_ext_man_cc_version *cc;
  147. cc = container_of(hdr, struct sof_ext_man_cc_version, hdr);
  148. return get_cc_info(sdev, &cc->cc_version.ext_hdr);
  149. }
  150. static int ext_man_get_dbg_abi_info(struct snd_sof_dev *sdev,
  151. const struct sof_ext_man_elem_header *hdr)
  152. {
  153. const struct ext_man_dbg_abi *dbg_abi =
  154. container_of(hdr, struct ext_man_dbg_abi, hdr);
  155. if (sdev->first_boot)
  156. dev_dbg(sdev->dev,
  157. "Firmware: DBG_ABI %d:%d:%d\n",
  158. SOF_ABI_VERSION_MAJOR(dbg_abi->dbg_abi.abi_dbg_version),
  159. SOF_ABI_VERSION_MINOR(dbg_abi->dbg_abi.abi_dbg_version),
  160. SOF_ABI_VERSION_PATCH(dbg_abi->dbg_abi.abi_dbg_version));
  161. return 0;
  162. }
  163. static ssize_t snd_sof_ext_man_size(const struct firmware *fw)
  164. {
  165. const struct sof_ext_man_header *head;
  166. head = (struct sof_ext_man_header *)fw->data;
  167. /*
  168. * assert fw size is big enough to contain extended manifest header,
  169. * it prevents from reading unallocated memory from `head` in following
  170. * step.
  171. */
  172. if (fw->size < sizeof(*head))
  173. return -EINVAL;
  174. /*
  175. * When fw points to extended manifest,
  176. * then first u32 must be equal SOF_EXT_MAN_MAGIC_NUMBER.
  177. */
  178. if (head->magic == SOF_EXT_MAN_MAGIC_NUMBER)
  179. return head->full_size;
  180. /* otherwise given fw don't have an extended manifest */
  181. return 0;
  182. }
  183. /* parse extended FW manifest data structures */
  184. static int snd_sof_fw_ext_man_parse(struct snd_sof_dev *sdev,
  185. const struct firmware *fw)
  186. {
  187. const struct sof_ext_man_elem_header *elem_hdr;
  188. const struct sof_ext_man_header *head;
  189. ssize_t ext_man_size;
  190. ssize_t remaining;
  191. uintptr_t iptr;
  192. int ret = 0;
  193. head = (struct sof_ext_man_header *)fw->data;
  194. remaining = head->full_size - head->header_size;
  195. ext_man_size = snd_sof_ext_man_size(fw);
  196. /* Assert firmware starts with extended manifest */
  197. if (ext_man_size <= 0)
  198. return ext_man_size;
  199. /* incompatible version */
  200. if (SOF_EXT_MAN_VERSION_INCOMPATIBLE(SOF_EXT_MAN_VERSION,
  201. head->header_version)) {
  202. dev_err(sdev->dev, "error: extended manifest version 0x%X differ from used 0x%X\n",
  203. head->header_version, SOF_EXT_MAN_VERSION);
  204. return -EINVAL;
  205. }
  206. /* get first extended manifest element header */
  207. iptr = (uintptr_t)fw->data + head->header_size;
  208. while (remaining > sizeof(*elem_hdr)) {
  209. elem_hdr = (struct sof_ext_man_elem_header *)iptr;
  210. dev_dbg(sdev->dev, "found sof_ext_man header type %d size 0x%X\n",
  211. elem_hdr->type, elem_hdr->size);
  212. if (elem_hdr->size < sizeof(*elem_hdr) ||
  213. elem_hdr->size > remaining) {
  214. dev_err(sdev->dev, "error: invalid sof_ext_man header size, type %d size 0x%X\n",
  215. elem_hdr->type, elem_hdr->size);
  216. return -EINVAL;
  217. }
  218. /* process structure data */
  219. switch (elem_hdr->type) {
  220. case SOF_EXT_MAN_ELEM_FW_VERSION:
  221. ret = ext_man_get_fw_version(sdev, elem_hdr);
  222. break;
  223. case SOF_EXT_MAN_ELEM_WINDOW:
  224. ret = ext_man_get_windows(sdev, elem_hdr);
  225. break;
  226. case SOF_EXT_MAN_ELEM_CC_VERSION:
  227. ret = ext_man_get_cc_info(sdev, elem_hdr);
  228. break;
  229. case SOF_EXT_MAN_ELEM_DBG_ABI:
  230. ret = ext_man_get_dbg_abi_info(sdev, elem_hdr);
  231. break;
  232. default:
  233. dev_warn(sdev->dev, "warning: unknown sof_ext_man header type %d size 0x%X\n",
  234. elem_hdr->type, elem_hdr->size);
  235. break;
  236. }
  237. if (ret < 0) {
  238. dev_err(sdev->dev, "error: failed to parse sof_ext_man header type %d size 0x%X\n",
  239. elem_hdr->type, elem_hdr->size);
  240. return ret;
  241. }
  242. remaining -= elem_hdr->size;
  243. iptr += elem_hdr->size;
  244. }
  245. if (remaining) {
  246. dev_err(sdev->dev, "error: sof_ext_man header is inconsistent\n");
  247. return -EINVAL;
  248. }
  249. return ext_man_size;
  250. }
  251. /*
  252. * IPC Firmware ready.
  253. */
  254. static void sof_get_windows(struct snd_sof_dev *sdev)
  255. {
  256. struct sof_ipc_window_elem *elem;
  257. u32 outbox_offset = 0;
  258. u32 stream_offset = 0;
  259. u32 inbox_offset = 0;
  260. u32 outbox_size = 0;
  261. u32 stream_size = 0;
  262. u32 inbox_size = 0;
  263. u32 debug_size = 0;
  264. u32 debug_offset = 0;
  265. int window_offset;
  266. int bar;
  267. int i;
  268. if (!sdev->info_window) {
  269. dev_err(sdev->dev, "error: have no window info\n");
  270. return;
  271. }
  272. bar = snd_sof_dsp_get_bar_index(sdev, SOF_FW_BLK_TYPE_SRAM);
  273. if (bar < 0) {
  274. dev_err(sdev->dev, "error: have no bar mapping\n");
  275. return;
  276. }
  277. for (i = 0; i < sdev->info_window->num_windows; i++) {
  278. elem = &sdev->info_window->window[i];
  279. window_offset = snd_sof_dsp_get_window_offset(sdev, elem->id);
  280. if (window_offset < 0) {
  281. dev_warn(sdev->dev, "warn: no offset for window %d\n",
  282. elem->id);
  283. continue;
  284. }
  285. switch (elem->type) {
  286. case SOF_IPC_REGION_UPBOX:
  287. inbox_offset = window_offset + elem->offset;
  288. inbox_size = elem->size;
  289. snd_sof_debugfs_io_item(sdev,
  290. sdev->bar[bar] +
  291. inbox_offset,
  292. elem->size, "inbox",
  293. SOF_DEBUGFS_ACCESS_D0_ONLY);
  294. break;
  295. case SOF_IPC_REGION_DOWNBOX:
  296. outbox_offset = window_offset + elem->offset;
  297. outbox_size = elem->size;
  298. snd_sof_debugfs_io_item(sdev,
  299. sdev->bar[bar] +
  300. outbox_offset,
  301. elem->size, "outbox",
  302. SOF_DEBUGFS_ACCESS_D0_ONLY);
  303. break;
  304. case SOF_IPC_REGION_TRACE:
  305. snd_sof_debugfs_io_item(sdev,
  306. sdev->bar[bar] +
  307. window_offset +
  308. elem->offset,
  309. elem->size, "etrace",
  310. SOF_DEBUGFS_ACCESS_D0_ONLY);
  311. break;
  312. case SOF_IPC_REGION_DEBUG:
  313. debug_offset = window_offset + elem->offset;
  314. debug_size = elem->size;
  315. snd_sof_debugfs_io_item(sdev,
  316. sdev->bar[bar] +
  317. window_offset +
  318. elem->offset,
  319. elem->size, "debug",
  320. SOF_DEBUGFS_ACCESS_D0_ONLY);
  321. break;
  322. case SOF_IPC_REGION_STREAM:
  323. stream_offset = window_offset + elem->offset;
  324. stream_size = elem->size;
  325. snd_sof_debugfs_io_item(sdev,
  326. sdev->bar[bar] +
  327. stream_offset,
  328. elem->size, "stream",
  329. SOF_DEBUGFS_ACCESS_D0_ONLY);
  330. break;
  331. case SOF_IPC_REGION_REGS:
  332. snd_sof_debugfs_io_item(sdev,
  333. sdev->bar[bar] +
  334. window_offset +
  335. elem->offset,
  336. elem->size, "regs",
  337. SOF_DEBUGFS_ACCESS_D0_ONLY);
  338. break;
  339. case SOF_IPC_REGION_EXCEPTION:
  340. sdev->dsp_oops_offset = window_offset + elem->offset;
  341. snd_sof_debugfs_io_item(sdev,
  342. sdev->bar[bar] +
  343. window_offset +
  344. elem->offset,
  345. elem->size, "exception",
  346. SOF_DEBUGFS_ACCESS_D0_ONLY);
  347. break;
  348. default:
  349. dev_err(sdev->dev, "error: get illegal window info\n");
  350. return;
  351. }
  352. }
  353. if (outbox_size == 0 || inbox_size == 0) {
  354. dev_err(sdev->dev, "error: get illegal mailbox window\n");
  355. return;
  356. }
  357. snd_sof_dsp_mailbox_init(sdev, inbox_offset, inbox_size,
  358. outbox_offset, outbox_size);
  359. sdev->stream_box.offset = stream_offset;
  360. sdev->stream_box.size = stream_size;
  361. sdev->debug_box.offset = debug_offset;
  362. sdev->debug_box.size = debug_size;
  363. dev_dbg(sdev->dev, " mailbox upstream 0x%x - size 0x%x\n",
  364. inbox_offset, inbox_size);
  365. dev_dbg(sdev->dev, " mailbox downstream 0x%x - size 0x%x\n",
  366. outbox_offset, outbox_size);
  367. dev_dbg(sdev->dev, " stream region 0x%x - size 0x%x\n",
  368. stream_offset, stream_size);
  369. dev_dbg(sdev->dev, " debug region 0x%x - size 0x%x\n",
  370. debug_offset, debug_size);
  371. }
  372. /* check for ABI compatibility and create memory windows on first boot */
  373. int sof_fw_ready(struct snd_sof_dev *sdev, u32 msg_id)
  374. {
  375. struct sof_ipc_fw_ready *fw_ready = &sdev->fw_ready;
  376. int offset;
  377. int bar;
  378. int ret;
  379. /* mailbox must be on 4k boundary */
  380. offset = snd_sof_dsp_get_mailbox_offset(sdev);
  381. if (offset < 0) {
  382. dev_err(sdev->dev, "error: have no mailbox offset\n");
  383. return offset;
  384. }
  385. bar = snd_sof_dsp_get_bar_index(sdev, SOF_FW_BLK_TYPE_SRAM);
  386. if (bar < 0) {
  387. dev_err(sdev->dev, "error: have no bar mapping\n");
  388. return -EINVAL;
  389. }
  390. dev_dbg(sdev->dev, "ipc: DSP is ready 0x%8.8x offset 0x%x\n",
  391. msg_id, offset);
  392. /* no need to re-check version/ABI for subsequent boots */
  393. if (!sdev->first_boot)
  394. return 0;
  395. /* copy data from the DSP FW ready offset */
  396. sof_block_read(sdev, bar, offset, fw_ready, sizeof(*fw_ready));
  397. /* make sure ABI version is compatible */
  398. ret = snd_sof_ipc_valid(sdev);
  399. if (ret < 0)
  400. return ret;
  401. /* now check for extended data */
  402. snd_sof_fw_parse_ext_data(sdev, bar, offset +
  403. sizeof(struct sof_ipc_fw_ready));
  404. sof_get_windows(sdev);
  405. return 0;
  406. }
  407. EXPORT_SYMBOL(sof_fw_ready);
  408. /* generic module parser for mmaped DSPs */
  409. int snd_sof_parse_module_memcpy(struct snd_sof_dev *sdev,
  410. struct snd_sof_mod_hdr *module)
  411. {
  412. struct snd_sof_blk_hdr *block;
  413. int count, bar;
  414. u32 offset;
  415. size_t remaining;
  416. dev_dbg(sdev->dev, "new module size 0x%x blocks 0x%x type 0x%x\n",
  417. module->size, module->num_blocks, module->type);
  418. block = (struct snd_sof_blk_hdr *)((u8 *)module + sizeof(*module));
  419. /* module->size doesn't include header size */
  420. remaining = module->size;
  421. for (count = 0; count < module->num_blocks; count++) {
  422. /* check for wrap */
  423. if (remaining < sizeof(*block)) {
  424. dev_err(sdev->dev, "error: not enough data remaining\n");
  425. return -EINVAL;
  426. }
  427. /* minus header size of block */
  428. remaining -= sizeof(*block);
  429. if (block->size == 0) {
  430. dev_warn(sdev->dev,
  431. "warning: block %d size zero\n", count);
  432. dev_warn(sdev->dev, " type 0x%x offset 0x%x\n",
  433. block->type, block->offset);
  434. continue;
  435. }
  436. switch (block->type) {
  437. case SOF_FW_BLK_TYPE_RSRVD0:
  438. case SOF_FW_BLK_TYPE_ROM...SOF_FW_BLK_TYPE_RSRVD14:
  439. continue; /* not handled atm */
  440. case SOF_FW_BLK_TYPE_IRAM:
  441. case SOF_FW_BLK_TYPE_DRAM:
  442. case SOF_FW_BLK_TYPE_SRAM:
  443. offset = block->offset;
  444. bar = snd_sof_dsp_get_bar_index(sdev, block->type);
  445. if (bar < 0) {
  446. dev_err(sdev->dev,
  447. "error: no BAR mapping for block type 0x%x\n",
  448. block->type);
  449. return bar;
  450. }
  451. break;
  452. default:
  453. dev_err(sdev->dev, "error: bad type 0x%x for block 0x%x\n",
  454. block->type, count);
  455. return -EINVAL;
  456. }
  457. dev_dbg(sdev->dev,
  458. "block %d type 0x%x size 0x%x ==> offset 0x%x\n",
  459. count, block->type, block->size, offset);
  460. /* checking block->size to avoid unaligned access */
  461. if (block->size % sizeof(u32)) {
  462. dev_err(sdev->dev, "error: invalid block size 0x%x\n",
  463. block->size);
  464. return -EINVAL;
  465. }
  466. snd_sof_dsp_block_write(sdev, bar, offset,
  467. block + 1, block->size);
  468. if (remaining < block->size) {
  469. dev_err(sdev->dev, "error: not enough data remaining\n");
  470. return -EINVAL;
  471. }
  472. /* minus body size of block */
  473. remaining -= block->size;
  474. /* next block */
  475. block = (struct snd_sof_blk_hdr *)((u8 *)block + sizeof(*block)
  476. + block->size);
  477. }
  478. return 0;
  479. }
  480. EXPORT_SYMBOL(snd_sof_parse_module_memcpy);
  481. static int check_header(struct snd_sof_dev *sdev, const struct firmware *fw,
  482. size_t fw_offset)
  483. {
  484. struct snd_sof_fw_header *header;
  485. size_t fw_size = fw->size - fw_offset;
  486. if (fw->size <= fw_offset) {
  487. dev_err(sdev->dev, "error: firmware size must be greater than firmware offset\n");
  488. return -EINVAL;
  489. }
  490. /* Read the header information from the data pointer */
  491. header = (struct snd_sof_fw_header *)(fw->data + fw_offset);
  492. /* verify FW sig */
  493. if (strncmp(header->sig, SND_SOF_FW_SIG, SND_SOF_FW_SIG_SIZE) != 0) {
  494. dev_err(sdev->dev, "error: invalid firmware signature\n");
  495. return -EINVAL;
  496. }
  497. /* check size is valid */
  498. if (fw_size != header->file_size + sizeof(*header)) {
  499. dev_err(sdev->dev, "error: invalid filesize mismatch got 0x%zx expected 0x%zx\n",
  500. fw_size, header->file_size + sizeof(*header));
  501. return -EINVAL;
  502. }
  503. dev_dbg(sdev->dev, "header size=0x%x modules=0x%x abi=0x%x size=%zu\n",
  504. header->file_size, header->num_modules,
  505. header->abi, sizeof(*header));
  506. return 0;
  507. }
  508. static int load_modules(struct snd_sof_dev *sdev, const struct firmware *fw,
  509. size_t fw_offset)
  510. {
  511. struct snd_sof_fw_header *header;
  512. struct snd_sof_mod_hdr *module;
  513. int (*load_module)(struct snd_sof_dev *sof_dev,
  514. struct snd_sof_mod_hdr *hdr);
  515. int ret, count;
  516. size_t remaining;
  517. header = (struct snd_sof_fw_header *)(fw->data + fw_offset);
  518. load_module = sof_ops(sdev)->load_module;
  519. if (!load_module)
  520. return -EINVAL;
  521. /* parse each module */
  522. module = (struct snd_sof_mod_hdr *)(fw->data + fw_offset +
  523. sizeof(*header));
  524. remaining = fw->size - sizeof(*header) - fw_offset;
  525. /* check for wrap */
  526. if (remaining > fw->size) {
  527. dev_err(sdev->dev, "error: fw size smaller than header size\n");
  528. return -EINVAL;
  529. }
  530. for (count = 0; count < header->num_modules; count++) {
  531. /* check for wrap */
  532. if (remaining < sizeof(*module)) {
  533. dev_err(sdev->dev, "error: not enough data remaining\n");
  534. return -EINVAL;
  535. }
  536. /* minus header size of module */
  537. remaining -= sizeof(*module);
  538. /* module */
  539. ret = load_module(sdev, module);
  540. if (ret < 0) {
  541. dev_err(sdev->dev, "error: invalid module %d\n", count);
  542. return ret;
  543. }
  544. if (remaining < module->size) {
  545. dev_err(sdev->dev, "error: not enough data remaining\n");
  546. return -EINVAL;
  547. }
  548. /* minus body size of module */
  549. remaining -= module->size;
  550. module = (struct snd_sof_mod_hdr *)((u8 *)module
  551. + sizeof(*module) + module->size);
  552. }
  553. return 0;
  554. }
  555. int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev)
  556. {
  557. struct snd_sof_pdata *plat_data = sdev->pdata;
  558. const char *fw_filename;
  559. ssize_t ext_man_size;
  560. int ret;
  561. /* Don't request firmware again if firmware is already requested */
  562. if (plat_data->fw)
  563. return 0;
  564. fw_filename = kasprintf(GFP_KERNEL, "%s/%s",
  565. plat_data->fw_filename_prefix,
  566. plat_data->fw_filename);
  567. if (!fw_filename)
  568. return -ENOMEM;
  569. ret = request_firmware(&plat_data->fw, fw_filename, sdev->dev);
  570. if (ret < 0) {
  571. dev_err(sdev->dev, "error: request firmware %s failed err: %d\n",
  572. fw_filename, ret);
  573. goto err;
  574. } else {
  575. dev_dbg(sdev->dev, "request_firmware %s successful\n",
  576. fw_filename);
  577. }
  578. /* check for extended manifest */
  579. ext_man_size = snd_sof_fw_ext_man_parse(sdev, plat_data->fw);
  580. if (ext_man_size > 0) {
  581. /* when no error occurred, drop extended manifest */
  582. plat_data->fw_offset = ext_man_size;
  583. } else if (!ext_man_size) {
  584. /* No extended manifest, so nothing to skip during FW load */
  585. dev_dbg(sdev->dev, "firmware doesn't contain extended manifest\n");
  586. } else {
  587. ret = ext_man_size;
  588. dev_err(sdev->dev, "error: firmware %s contains unsupported or invalid extended manifest: %d\n",
  589. fw_filename, ret);
  590. }
  591. err:
  592. kfree(fw_filename);
  593. return ret;
  594. }
  595. EXPORT_SYMBOL(snd_sof_load_firmware_raw);
  596. int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev)
  597. {
  598. struct snd_sof_pdata *plat_data = sdev->pdata;
  599. int ret;
  600. ret = snd_sof_load_firmware_raw(sdev);
  601. if (ret < 0)
  602. return ret;
  603. /* make sure the FW header and file is valid */
  604. ret = check_header(sdev, plat_data->fw, plat_data->fw_offset);
  605. if (ret < 0) {
  606. dev_err(sdev->dev, "error: invalid FW header\n");
  607. goto error;
  608. }
  609. /* prepare the DSP for FW loading */
  610. ret = snd_sof_dsp_reset(sdev);
  611. if (ret < 0) {
  612. dev_err(sdev->dev, "error: failed to reset DSP\n");
  613. goto error;
  614. }
  615. /* parse and load firmware modules to DSP */
  616. ret = load_modules(sdev, plat_data->fw, plat_data->fw_offset);
  617. if (ret < 0) {
  618. dev_err(sdev->dev, "error: invalid FW modules\n");
  619. goto error;
  620. }
  621. return 0;
  622. error:
  623. release_firmware(plat_data->fw);
  624. plat_data->fw = NULL;
  625. return ret;
  626. }
  627. EXPORT_SYMBOL(snd_sof_load_firmware_memcpy);
  628. int snd_sof_load_firmware(struct snd_sof_dev *sdev)
  629. {
  630. dev_dbg(sdev->dev, "loading firmware\n");
  631. if (sof_ops(sdev)->load_firmware)
  632. return sof_ops(sdev)->load_firmware(sdev);
  633. return 0;
  634. }
  635. EXPORT_SYMBOL(snd_sof_load_firmware);
  636. int snd_sof_run_firmware(struct snd_sof_dev *sdev)
  637. {
  638. int ret;
  639. int init_core_mask;
  640. init_waitqueue_head(&sdev->boot_wait);
  641. /* create read-only fw_version debugfs to store boot version info */
  642. if (sdev->first_boot) {
  643. ret = snd_sof_debugfs_buf_item(sdev, &sdev->fw_version,
  644. sizeof(sdev->fw_version),
  645. "fw_version", 0444);
  646. /* errors are only due to memory allocation, not debugfs */
  647. if (ret < 0) {
  648. dev_err(sdev->dev, "error: snd_sof_debugfs_buf_item failed\n");
  649. return ret;
  650. }
  651. }
  652. /* perform pre fw run operations */
  653. ret = snd_sof_dsp_pre_fw_run(sdev);
  654. if (ret < 0) {
  655. dev_err(sdev->dev, "error: failed pre fw run op\n");
  656. return ret;
  657. }
  658. dev_dbg(sdev->dev, "booting DSP firmware\n");
  659. /* boot the firmware on the DSP */
  660. ret = snd_sof_dsp_run(sdev);
  661. if (ret < 0) {
  662. dev_err(sdev->dev, "error: failed to reset DSP\n");
  663. return ret;
  664. }
  665. init_core_mask = ret;
  666. /*
  667. * now wait for the DSP to boot. There are 3 possible outcomes:
  668. * 1. Boot wait times out indicating FW boot failure.
  669. * 2. FW boots successfully and fw_ready op succeeds.
  670. * 3. FW boots but fw_ready op fails.
  671. */
  672. ret = wait_event_timeout(sdev->boot_wait,
  673. sdev->fw_state > SOF_FW_BOOT_IN_PROGRESS,
  674. msecs_to_jiffies(sdev->boot_timeout));
  675. if (ret == 0) {
  676. dev_err(sdev->dev, "error: firmware boot failure\n");
  677. snd_sof_dsp_dbg_dump(sdev, SOF_DBG_REGS | SOF_DBG_MBOX |
  678. SOF_DBG_TEXT | SOF_DBG_PCI);
  679. sdev->fw_state = SOF_FW_BOOT_FAILED;
  680. return -EIO;
  681. }
  682. if (sdev->fw_state == SOF_FW_BOOT_COMPLETE)
  683. dev_dbg(sdev->dev, "firmware boot complete\n");
  684. else
  685. return -EIO; /* FW boots but fw_ready op failed */
  686. /* perform post fw run operations */
  687. ret = snd_sof_dsp_post_fw_run(sdev);
  688. if (ret < 0) {
  689. dev_err(sdev->dev, "error: failed post fw run op\n");
  690. return ret;
  691. }
  692. /* fw boot is complete. Update the active cores mask */
  693. sdev->enabled_cores_mask = init_core_mask;
  694. return 0;
  695. }
  696. EXPORT_SYMBOL(snd_sof_run_firmware);
  697. void snd_sof_fw_unload(struct snd_sof_dev *sdev)
  698. {
  699. /* TODO: support module unloading at runtime */
  700. release_firmware(sdev->pdata->fw);
  701. sdev->pdata->fw = NULL;
  702. }
  703. EXPORT_SYMBOL(snd_sof_fw_unload);