dfu.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * dfu.c -- DFU back-end routines
  4. *
  5. * Copyright (C) 2012 Samsung Electronics
  6. * author: Lukasz Majewski <l.majewski@samsung.com>
  7. */
  8. #include <common.h>
  9. #include <env.h>
  10. #include <errno.h>
  11. #include <log.h>
  12. #include <malloc.h>
  13. #include <mmc.h>
  14. #include <fat.h>
  15. #include <dfu.h>
  16. #include <hash.h>
  17. #include <linux/list.h>
  18. #include <linux/compiler.h>
  19. LIST_HEAD(dfu_list);
  20. static int dfu_alt_num;
  21. static int alt_num_cnt;
  22. static struct hash_algo *dfu_hash_algo;
  23. #ifdef CONFIG_DFU_TIMEOUT
  24. static unsigned long dfu_timeout = 0;
  25. #endif
  26. /*
  27. * The purpose of the dfu_flush_callback() function is to
  28. * provide callback for dfu user
  29. */
  30. __weak void dfu_flush_callback(struct dfu_entity *dfu)
  31. {
  32. }
  33. /*
  34. * The purpose of the dfu_initiated_callback() function is to
  35. * provide callback for dfu user
  36. */
  37. __weak void dfu_initiated_callback(struct dfu_entity *dfu)
  38. {
  39. }
  40. /*
  41. * The purpose of the dfu_usb_get_reset() function is to
  42. * provide information if after USB_DETACH request
  43. * being sent the dfu-util performed reset of USB
  44. * bus.
  45. *
  46. * Described behaviour is the only way to distinct if
  47. * user has typed -e (detach) or -R (reset) when invoking
  48. * dfu-util command.
  49. *
  50. */
  51. __weak bool dfu_usb_get_reset(void)
  52. {
  53. #ifdef CONFIG_SPL_DFU_NO_RESET
  54. return false;
  55. #else
  56. return true;
  57. #endif
  58. }
  59. #ifdef CONFIG_DFU_TIMEOUT
  60. void dfu_set_timeout(unsigned long timeout)
  61. {
  62. dfu_timeout = timeout;
  63. }
  64. unsigned long dfu_get_timeout(void)
  65. {
  66. return dfu_timeout;
  67. }
  68. #endif
  69. static int dfu_find_alt_num(const char *s)
  70. {
  71. int i = 0;
  72. for (; *s; s++)
  73. if (*s == ';')
  74. i++;
  75. return ++i;
  76. }
  77. /*
  78. * treat dfu_alt_info with several interface information
  79. * to allow DFU on several device with one command,
  80. * the string format is
  81. * interface devstring'='alternate list (';' separated)
  82. * and each interface separated by '&'
  83. */
  84. int dfu_config_interfaces(char *env)
  85. {
  86. struct dfu_entity *dfu;
  87. char *s, *i, *d, *a, *part;
  88. int ret = -EINVAL;
  89. int n = 1;
  90. s = env;
  91. for (; *s; s++) {
  92. if (*s == ';')
  93. n++;
  94. if (*s == '&')
  95. n++;
  96. }
  97. ret = dfu_alt_init(n, &dfu);
  98. if (ret)
  99. return ret;
  100. s = env;
  101. while (s) {
  102. ret = -EINVAL;
  103. i = strsep(&s, " ");
  104. if (!i)
  105. break;
  106. d = strsep(&s, "=");
  107. if (!d)
  108. break;
  109. a = strsep(&s, "&");
  110. if (!a)
  111. a = s;
  112. do {
  113. part = strsep(&a, ";");
  114. ret = dfu_alt_add(dfu, i, d, part);
  115. if (ret)
  116. return ret;
  117. } while (a);
  118. }
  119. return ret;
  120. }
  121. int dfu_init_env_entities(char *interface, char *devstr)
  122. {
  123. const char *str_env;
  124. char *env_bkp;
  125. int ret = 0;
  126. #ifdef CONFIG_SET_DFU_ALT_INFO
  127. set_dfu_alt_info(interface, devstr);
  128. #endif
  129. str_env = env_get("dfu_alt_info");
  130. if (!str_env) {
  131. pr_err("\"dfu_alt_info\" env variable not defined!\n");
  132. return -EINVAL;
  133. }
  134. env_bkp = strdup(str_env);
  135. if (!interface && !devstr)
  136. ret = dfu_config_interfaces(env_bkp);
  137. else
  138. ret = dfu_config_entities(env_bkp, interface, devstr);
  139. if (ret) {
  140. pr_err("DFU entities configuration failed!\n");
  141. pr_err("(partition table does not match dfu_alt_info?)\n");
  142. goto done;
  143. }
  144. done:
  145. free(env_bkp);
  146. return ret;
  147. }
  148. static unsigned char *dfu_buf;
  149. static unsigned long dfu_buf_size;
  150. static enum dfu_device_type dfu_buf_device_type;
  151. unsigned char *dfu_free_buf(void)
  152. {
  153. free(dfu_buf);
  154. dfu_buf = NULL;
  155. return dfu_buf;
  156. }
  157. unsigned long dfu_get_buf_size(void)
  158. {
  159. return dfu_buf_size;
  160. }
  161. unsigned char *dfu_get_buf(struct dfu_entity *dfu)
  162. {
  163. char *s;
  164. /* manage several entity with several contraint */
  165. if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
  166. dfu_free_buf();
  167. if (dfu_buf != NULL)
  168. return dfu_buf;
  169. s = env_get("dfu_bufsiz");
  170. if (s)
  171. dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
  172. if (!s || !dfu_buf_size)
  173. dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
  174. if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
  175. dfu_buf_size = dfu->max_buf_size;
  176. dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
  177. if (dfu_buf == NULL)
  178. printf("%s: Could not memalign 0x%lx bytes\n",
  179. __func__, dfu_buf_size);
  180. dfu_buf_device_type = dfu->dev_type;
  181. return dfu_buf;
  182. }
  183. static char *dfu_get_hash_algo(void)
  184. {
  185. char *s;
  186. s = env_get("dfu_hash_algo");
  187. if (!s)
  188. return NULL;
  189. if (!strcmp(s, "crc32")) {
  190. debug("%s: DFU hash method: %s\n", __func__, s);
  191. return s;
  192. }
  193. pr_err("DFU hash method: %s not supported!\n", s);
  194. return NULL;
  195. }
  196. static int dfu_write_buffer_drain(struct dfu_entity *dfu)
  197. {
  198. long w_size;
  199. int ret;
  200. /* flush size? */
  201. w_size = dfu->i_buf - dfu->i_buf_start;
  202. if (w_size == 0)
  203. return 0;
  204. if (dfu_hash_algo)
  205. dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
  206. dfu->i_buf_start, w_size, 0);
  207. ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
  208. if (ret)
  209. debug("%s: Write error!\n", __func__);
  210. /* point back */
  211. dfu->i_buf = dfu->i_buf_start;
  212. /* update offset */
  213. dfu->offset += w_size;
  214. puts("#");
  215. return ret;
  216. }
  217. void dfu_transaction_cleanup(struct dfu_entity *dfu)
  218. {
  219. /* clear everything */
  220. dfu->crc = 0;
  221. dfu->offset = 0;
  222. dfu->i_blk_seq_num = 0;
  223. dfu->i_buf_start = dfu_get_buf(dfu);
  224. dfu->i_buf_end = dfu->i_buf_start;
  225. dfu->i_buf = dfu->i_buf_start;
  226. dfu->r_left = 0;
  227. dfu->b_left = 0;
  228. dfu->bad_skip = 0;
  229. dfu->inited = 0;
  230. }
  231. int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
  232. {
  233. int ret = 0;
  234. if (dfu->inited)
  235. return 0;
  236. dfu_transaction_cleanup(dfu);
  237. if (dfu->i_buf_start == NULL)
  238. return -ENOMEM;
  239. dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
  240. if (read) {
  241. ret = dfu->get_medium_size(dfu, &dfu->r_left);
  242. if (ret < 0)
  243. return ret;
  244. debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
  245. }
  246. dfu->inited = 1;
  247. dfu_initiated_callback(dfu);
  248. return 0;
  249. }
  250. int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
  251. {
  252. int ret = 0;
  253. ret = dfu_write_buffer_drain(dfu);
  254. if (ret)
  255. return ret;
  256. if (dfu->flush_medium)
  257. ret = dfu->flush_medium(dfu);
  258. if (dfu_hash_algo)
  259. printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
  260. dfu->crc);
  261. dfu_flush_callback(dfu);
  262. dfu_transaction_cleanup(dfu);
  263. return ret;
  264. }
  265. int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
  266. {
  267. int ret;
  268. debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
  269. __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
  270. (unsigned long)(dfu->i_buf - dfu->i_buf_start));
  271. ret = dfu_transaction_initiate(dfu, false);
  272. if (ret < 0)
  273. return ret;
  274. if (dfu->i_blk_seq_num != blk_seq_num) {
  275. printf("%s: Wrong sequence number! [%d] [%d]\n",
  276. __func__, dfu->i_blk_seq_num, blk_seq_num);
  277. dfu_transaction_cleanup(dfu);
  278. return -1;
  279. }
  280. /* DFU 1.1 standard says:
  281. * The wBlockNum field is a block sequence number. It increments each
  282. * time a block is transferred, wrapping to zero from 65,535. It is used
  283. * to provide useful context to the DFU loader in the device."
  284. *
  285. * This means that it's a 16 bit counter that roll-overs at
  286. * 0xffff -> 0x0000. By having a typical 4K transfer block
  287. * we roll-over at exactly 256MB. Not very fun to debug.
  288. *
  289. * Handling rollover, and having an inited variable,
  290. * makes things work.
  291. */
  292. /* handle rollover */
  293. dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
  294. /* flush buffer if overflow */
  295. if ((dfu->i_buf + size) > dfu->i_buf_end) {
  296. ret = dfu_write_buffer_drain(dfu);
  297. if (ret) {
  298. dfu_transaction_cleanup(dfu);
  299. return ret;
  300. }
  301. }
  302. /* we should be in buffer now (if not then size too large) */
  303. if ((dfu->i_buf + size) > dfu->i_buf_end) {
  304. pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
  305. size, dfu->i_buf_end);
  306. dfu_transaction_cleanup(dfu);
  307. return -1;
  308. }
  309. memcpy(dfu->i_buf, buf, size);
  310. dfu->i_buf += size;
  311. /* if end or if buffer full flush */
  312. if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
  313. ret = dfu_write_buffer_drain(dfu);
  314. if (ret) {
  315. dfu_transaction_cleanup(dfu);
  316. return ret;
  317. }
  318. }
  319. return 0;
  320. }
  321. static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
  322. {
  323. long chunk;
  324. int ret, readn;
  325. readn = 0;
  326. while (size > 0) {
  327. /* get chunk that can be read */
  328. chunk = min((long)size, dfu->b_left);
  329. /* consume */
  330. if (chunk > 0) {
  331. memcpy(buf, dfu->i_buf, chunk);
  332. if (dfu_hash_algo)
  333. dfu_hash_algo->hash_update(dfu_hash_algo,
  334. &dfu->crc, buf,
  335. chunk, 0);
  336. dfu->i_buf += chunk;
  337. dfu->b_left -= chunk;
  338. size -= chunk;
  339. buf += chunk;
  340. readn += chunk;
  341. }
  342. /* all done */
  343. if (size > 0) {
  344. /* no more to read */
  345. if (dfu->r_left == 0)
  346. break;
  347. dfu->i_buf = dfu->i_buf_start;
  348. dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
  349. /* got to read, but buffer is empty */
  350. if (dfu->b_left > dfu->r_left)
  351. dfu->b_left = dfu->r_left;
  352. ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
  353. &dfu->b_left);
  354. if (ret != 0) {
  355. debug("%s: Read error!\n", __func__);
  356. return ret;
  357. }
  358. if (dfu->b_left == 0)
  359. break;
  360. dfu->offset += dfu->b_left;
  361. dfu->r_left -= dfu->b_left;
  362. puts("#");
  363. }
  364. }
  365. return readn;
  366. }
  367. int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
  368. {
  369. int ret = 0;
  370. debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
  371. __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
  372. ret = dfu_transaction_initiate(dfu, true);
  373. if (ret < 0)
  374. return ret;
  375. if (dfu->i_blk_seq_num != blk_seq_num) {
  376. printf("%s: Wrong sequence number! [%d] [%d]\n",
  377. __func__, dfu->i_blk_seq_num, blk_seq_num);
  378. return -1;
  379. }
  380. /* handle rollover */
  381. dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
  382. ret = dfu_read_buffer_fill(dfu, buf, size);
  383. if (ret < 0) {
  384. printf("%s: Failed to fill buffer\n", __func__);
  385. return -1;
  386. }
  387. if (ret < size) {
  388. if (dfu_hash_algo)
  389. debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
  390. dfu_hash_algo->name, dfu->crc);
  391. puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
  392. dfu_transaction_cleanup(dfu);
  393. }
  394. return ret;
  395. }
  396. static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
  397. char *interface, char *devstr)
  398. {
  399. char *st;
  400. debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
  401. st = strsep(&s, " ");
  402. strcpy(dfu->name, st);
  403. dfu->alt = alt;
  404. dfu->max_buf_size = 0;
  405. dfu->free_entity = NULL;
  406. /* Specific for mmc device */
  407. if (strcmp(interface, "mmc") == 0) {
  408. if (dfu_fill_entity_mmc(dfu, devstr, s))
  409. return -1;
  410. } else if (strcmp(interface, "mtd") == 0) {
  411. if (dfu_fill_entity_mtd(dfu, devstr, s))
  412. return -1;
  413. } else if (strcmp(interface, "nand") == 0) {
  414. if (dfu_fill_entity_nand(dfu, devstr, s))
  415. return -1;
  416. } else if (strcmp(interface, "ram") == 0) {
  417. if (dfu_fill_entity_ram(dfu, devstr, s))
  418. return -1;
  419. } else if (strcmp(interface, "sf") == 0) {
  420. if (dfu_fill_entity_sf(dfu, devstr, s))
  421. return -1;
  422. } else if (strcmp(interface, "virt") == 0) {
  423. if (dfu_fill_entity_virt(dfu, devstr, s))
  424. return -1;
  425. } else {
  426. printf("%s: Device %s not (yet) supported!\n",
  427. __func__, interface);
  428. return -1;
  429. }
  430. dfu_get_buf(dfu);
  431. return 0;
  432. }
  433. void dfu_free_entities(void)
  434. {
  435. struct dfu_entity *dfu, *p, *t = NULL;
  436. dfu_free_buf();
  437. list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
  438. list_del(&dfu->list);
  439. if (dfu->free_entity)
  440. dfu->free_entity(dfu);
  441. t = dfu;
  442. }
  443. if (t)
  444. free(t);
  445. INIT_LIST_HEAD(&dfu_list);
  446. alt_num_cnt = 0;
  447. }
  448. int dfu_alt_init(int num, struct dfu_entity **dfu)
  449. {
  450. char *s;
  451. int ret;
  452. dfu_alt_num = num;
  453. debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
  454. dfu_hash_algo = NULL;
  455. s = dfu_get_hash_algo();
  456. if (s) {
  457. ret = hash_lookup_algo(s, &dfu_hash_algo);
  458. if (ret)
  459. pr_err("Hash algorithm %s not supported\n", s);
  460. }
  461. *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
  462. if (!*dfu)
  463. return -1;
  464. return 0;
  465. }
  466. int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
  467. {
  468. struct dfu_entity *p_dfu;
  469. int ret;
  470. if (alt_num_cnt >= dfu_alt_num)
  471. return -1;
  472. p_dfu = &dfu[alt_num_cnt];
  473. ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
  474. if (ret)
  475. return -1;
  476. list_add_tail(&p_dfu->list, &dfu_list);
  477. alt_num_cnt++;
  478. return 0;
  479. }
  480. int dfu_config_entities(char *env, char *interface, char *devstr)
  481. {
  482. struct dfu_entity *dfu;
  483. int i, ret;
  484. char *s;
  485. ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
  486. if (ret)
  487. return -1;
  488. for (i = 0; i < dfu_alt_num; i++) {
  489. s = strsep(&env, ";");
  490. ret = dfu_alt_add(dfu, interface, devstr, s);
  491. if (ret) {
  492. /* We will free "dfu" in dfu_free_entities() */
  493. return -1;
  494. }
  495. }
  496. return 0;
  497. }
  498. const char *dfu_get_dev_type(enum dfu_device_type t)
  499. {
  500. const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
  501. "SF", "MTD", "VIRT"};
  502. return dev_t[t];
  503. }
  504. const char *dfu_get_layout(enum dfu_layout l)
  505. {
  506. const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
  507. "EXT3", "EXT4", "RAM_ADDR" };
  508. return dfu_layout[l];
  509. }
  510. void dfu_show_entities(void)
  511. {
  512. struct dfu_entity *dfu;
  513. puts("DFU alt settings list:\n");
  514. list_for_each_entry(dfu, &dfu_list, list) {
  515. printf("dev: %s alt: %d name: %s layout: %s\n",
  516. dfu_get_dev_type(dfu->dev_type), dfu->alt,
  517. dfu->name, dfu_get_layout(dfu->layout));
  518. }
  519. }
  520. int dfu_get_alt_number(void)
  521. {
  522. return dfu_alt_num;
  523. }
  524. struct dfu_entity *dfu_get_entity(int alt)
  525. {
  526. struct dfu_entity *dfu;
  527. list_for_each_entry(dfu, &dfu_list, list) {
  528. if (dfu->alt == alt)
  529. return dfu;
  530. }
  531. return NULL;
  532. }
  533. int dfu_get_alt(char *name)
  534. {
  535. struct dfu_entity *dfu;
  536. char *str;
  537. list_for_each_entry(dfu, &dfu_list, list) {
  538. if (dfu->name[0] != '/') {
  539. if (!strncmp(dfu->name, name, strlen(dfu->name)))
  540. return dfu->alt;
  541. } else {
  542. /*
  543. * One must also consider absolute path
  544. * (/boot/bin/uImage) available at dfu->name when
  545. * compared "plain" file name (uImage)
  546. *
  547. * It is the case for e.g. thor gadget where lthor SW
  548. * sends only the file name, so only the very last part
  549. * of path must be checked for equality
  550. */
  551. str = strstr(dfu->name, name);
  552. if (!str)
  553. continue;
  554. /*
  555. * Check if matching substring is the last element of
  556. * dfu->name (uImage)
  557. */
  558. if (strlen(dfu->name) ==
  559. ((str - dfu->name) + strlen(name)))
  560. return dfu->alt;
  561. }
  562. }
  563. return -ENODEV;
  564. }
  565. int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
  566. {
  567. unsigned long dfu_buf_size, write, left = size;
  568. int i, ret = 0;
  569. void *dp = buf;
  570. /*
  571. * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
  572. * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
  573. * into account.
  574. */
  575. dfu_get_buf(dfu);
  576. dfu_buf_size = dfu_get_buf_size();
  577. debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
  578. for (i = 0; left > 0; i++) {
  579. write = min(dfu_buf_size, left);
  580. debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
  581. dp, left, write);
  582. ret = dfu_write(dfu, dp, write, i);
  583. if (ret) {
  584. pr_err("DFU write failed\n");
  585. return ret;
  586. }
  587. dp += write;
  588. left -= write;
  589. }
  590. ret = dfu_flush(dfu, NULL, 0, i);
  591. if (ret)
  592. pr_err("DFU flush failed!");
  593. return ret;
  594. }