dfu.c 15 KB

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