dfu.c 15 KB

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