1 // SPDX-License-Identifier: GPL-2.0+
3 * dfu.c -- DFU back-end routines
5 * Copyright (C) 2012 Samsung Electronics
6 * author: Lukasz Majewski <l.majewski@samsung.com>
18 #include <linux/list.h>
19 #include <linux/compiler.h>
22 static int dfu_alt_num;
23 static int alt_num_cnt;
24 static struct hash_algo *dfu_hash_algo;
25 #ifdef CONFIG_DFU_TIMEOUT
26 static unsigned long dfu_timeout = 0;
29 bool dfu_reinit_needed = false;
32 * The purpose of the dfu_flush_callback() function is to
33 * provide callback for dfu user
35 __weak void dfu_flush_callback(struct dfu_entity *dfu)
40 * The purpose of the dfu_initiated_callback() function is to
41 * provide callback for dfu user
43 __weak void dfu_initiated_callback(struct dfu_entity *dfu)
48 * The purpose of the dfu_error_callback() function is to
49 * provide callback for dfu user
51 __weak void dfu_error_callback(struct dfu_entity *dfu, const char *msg)
56 * The purpose of the dfu_usb_get_reset() function is to
57 * provide information if after USB_DETACH request
58 * being sent the dfu-util performed reset of USB
61 * Described behaviour is the only way to distinct if
62 * user has typed -e (detach) or -R (reset) when invoking
66 __weak bool dfu_usb_get_reset(void)
68 #ifdef CONFIG_SPL_DFU_NO_RESET
75 #ifdef CONFIG_DFU_TIMEOUT
76 void dfu_set_timeout(unsigned long timeout)
78 dfu_timeout = timeout;
81 unsigned long dfu_get_timeout(void)
87 static int dfu_find_alt_num(const char *s)
99 * treat dfu_alt_info with several interface information
100 * to allow DFU on several device with one command,
101 * the string format is
102 * interface devstring'='alternate list (';' separated)
103 * and each interface separated by '&'
105 int dfu_config_interfaces(char *env)
107 struct dfu_entity *dfu;
108 char *s, *i, *d, *a, *part;
119 ret = dfu_alt_init(n, &dfu);
126 i = strsep(&s, " \t");
137 part = strsep(&a, ";");
138 ret = dfu_alt_add(dfu, i, d, part);
147 int dfu_init_env_entities(char *interface, char *devstr)
153 dfu_reinit_needed = false;
155 #ifdef CONFIG_SET_DFU_ALT_INFO
156 set_dfu_alt_info(interface, devstr);
158 str_env = env_get("dfu_alt_info");
160 pr_err("\"dfu_alt_info\" env variable not defined!\n");
164 env_bkp = strdup(str_env);
165 if (!interface && !devstr)
166 ret = dfu_config_interfaces(env_bkp);
168 ret = dfu_config_entities(env_bkp, interface, devstr);
171 pr_err("DFU entities configuration failed!\n");
172 pr_err("(partition table does not match dfu_alt_info?)\n");
181 static unsigned char *dfu_buf;
182 static unsigned long dfu_buf_size;
183 static enum dfu_device_type dfu_buf_device_type;
185 unsigned char *dfu_free_buf(void)
192 unsigned long dfu_get_buf_size(void)
197 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
201 /* manage several entity with several contraint */
202 if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
208 s = env_get("dfu_bufsiz");
210 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
212 if (!s || !dfu_buf_size)
213 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
215 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
216 dfu_buf_size = dfu->max_buf_size;
218 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
220 printf("%s: Could not memalign 0x%lx bytes\n",
221 __func__, dfu_buf_size);
223 dfu_buf_device_type = dfu->dev_type;
227 static char *dfu_get_hash_algo(void)
231 s = env_get("dfu_hash_algo");
235 if (!strcmp(s, "crc32")) {
236 debug("%s: DFU hash method: %s\n", __func__, s);
240 pr_err("DFU hash method: %s not supported!\n", s);
244 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
250 w_size = dfu->i_buf - dfu->i_buf_start;
255 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
256 dfu->i_buf_start, w_size, 0);
258 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
260 debug("%s: Write error!\n", __func__);
263 dfu->i_buf = dfu->i_buf_start;
266 dfu->offset += w_size;
273 void dfu_transaction_cleanup(struct dfu_entity *dfu)
275 /* clear everything */
278 dfu->i_blk_seq_num = 0;
279 dfu->i_buf_start = dfu_get_buf(dfu);
280 dfu->i_buf_end = dfu->i_buf_start;
281 dfu->i_buf = dfu->i_buf_start;
289 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
296 dfu_transaction_cleanup(dfu);
298 if (dfu->i_buf_start == NULL)
301 dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
304 ret = dfu->get_medium_size(dfu, &dfu->r_left);
307 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
311 dfu_initiated_callback(dfu);
316 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
320 ret = dfu_write_buffer_drain(dfu);
324 if (dfu->flush_medium)
325 ret = dfu->flush_medium(dfu);
328 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
331 dfu_flush_callback(dfu);
333 dfu_transaction_cleanup(dfu);
338 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
342 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
343 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
344 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
346 ret = dfu_transaction_initiate(dfu, false);
350 if (dfu->i_blk_seq_num != blk_seq_num) {
351 printf("%s: Wrong sequence number! [%d] [%d]\n",
352 __func__, dfu->i_blk_seq_num, blk_seq_num);
353 dfu_transaction_cleanup(dfu);
354 dfu_error_callback(dfu, "Wrong sequence number");
358 /* DFU 1.1 standard says:
359 * The wBlockNum field is a block sequence number. It increments each
360 * time a block is transferred, wrapping to zero from 65,535. It is used
361 * to provide useful context to the DFU loader in the device."
363 * This means that it's a 16 bit counter that roll-overs at
364 * 0xffff -> 0x0000. By having a typical 4K transfer block
365 * we roll-over at exactly 256MB. Not very fun to debug.
367 * Handling rollover, and having an inited variable,
371 /* handle rollover */
372 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
374 /* flush buffer if overflow */
375 if ((dfu->i_buf + size) > dfu->i_buf_end) {
376 ret = dfu_write_buffer_drain(dfu);
378 dfu_transaction_cleanup(dfu);
379 dfu_error_callback(dfu, "DFU write error");
384 /* we should be in buffer now (if not then size too large) */
385 if ((dfu->i_buf + size) > dfu->i_buf_end) {
386 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
387 size, dfu->i_buf_end);
388 dfu_transaction_cleanup(dfu);
389 dfu_error_callback(dfu, "Buffer overflow");
393 memcpy(dfu->i_buf, buf, size);
396 /* if end or if buffer full flush */
397 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
398 ret = dfu_write_buffer_drain(dfu);
400 dfu_transaction_cleanup(dfu);
401 dfu_error_callback(dfu, "DFU write error");
409 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
416 /* get chunk that can be read */
417 chunk = min((long)size, dfu->b_left);
420 memcpy(buf, dfu->i_buf, chunk);
422 dfu_hash_algo->hash_update(dfu_hash_algo,
427 dfu->b_left -= chunk;
435 /* no more to read */
436 if (dfu->r_left == 0)
439 dfu->i_buf = dfu->i_buf_start;
440 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
442 /* got to read, but buffer is empty */
443 if (dfu->b_left > dfu->r_left)
444 dfu->b_left = dfu->r_left;
445 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
448 debug("%s: Read error!\n", __func__);
451 if (dfu->b_left == 0)
453 dfu->offset += dfu->b_left;
454 dfu->r_left -= dfu->b_left;
463 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
467 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
468 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
470 ret = dfu_transaction_initiate(dfu, true);
474 if (dfu->i_blk_seq_num != blk_seq_num) {
475 printf("%s: Wrong sequence number! [%d] [%d]\n",
476 __func__, dfu->i_blk_seq_num, blk_seq_num);
479 /* handle rollover */
480 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
482 ret = dfu_read_buffer_fill(dfu, buf, size);
484 printf("%s: Failed to fill buffer\n", __func__);
490 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
491 dfu_hash_algo->name, dfu->crc);
492 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
494 dfu_transaction_cleanup(dfu);
500 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
501 char *interface, char *devstr)
503 char *argv[DFU_MAX_ENTITY_ARGS];
507 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
508 st = strsep(&s, " \t");
509 strlcpy(dfu->name, st, DFU_NAME_SIZE);
511 /* Parse arguments */
512 for (argc = 0; s && argc < DFU_MAX_ENTITY_ARGS; argc++) {
516 argv[argc] = strsep(&s, " \t");
519 if (argc == DFU_MAX_ENTITY_ARGS && s) {
522 log_err("Too many arguments for %s\n", dfu->name);
528 dfu->max_buf_size = 0;
529 dfu->free_entity = NULL;
531 /* Specific for mmc device */
532 if (strcmp(interface, "mmc") == 0) {
533 if (dfu_fill_entity_mmc(dfu, devstr, argv, argc))
535 } else if (strcmp(interface, "mtd") == 0) {
536 if (dfu_fill_entity_mtd(dfu, devstr, argv, argc))
538 } else if (strcmp(interface, "nand") == 0) {
539 if (dfu_fill_entity_nand(dfu, devstr, argv, argc))
541 } else if (strcmp(interface, "ram") == 0) {
542 if (dfu_fill_entity_ram(dfu, devstr, argv, argc))
544 } else if (strcmp(interface, "sf") == 0) {
545 if (dfu_fill_entity_sf(dfu, devstr, argv, argc))
547 } else if (strcmp(interface, "virt") == 0) {
548 if (dfu_fill_entity_virt(dfu, devstr, argv, argc))
551 printf("%s: Device %s not (yet) supported!\n",
552 __func__, interface);
560 void dfu_free_entities(void)
562 struct dfu_entity *dfu, *p, *t = NULL;
565 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
566 list_del(&dfu->list);
567 if (dfu->free_entity)
568 dfu->free_entity(dfu);
573 INIT_LIST_HEAD(&dfu_list);
578 int dfu_alt_init(int num, struct dfu_entity **dfu)
584 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
586 dfu_hash_algo = NULL;
587 s = dfu_get_hash_algo();
589 ret = hash_lookup_algo(s, &dfu_hash_algo);
591 pr_err("Hash algorithm %s not supported\n", s);
594 *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
601 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
603 struct dfu_entity *p_dfu;
606 if (alt_num_cnt >= dfu_alt_num)
609 p_dfu = &dfu[alt_num_cnt];
610 ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
614 list_add_tail(&p_dfu->list, &dfu_list);
620 int dfu_config_entities(char *env, char *interface, char *devstr)
622 struct dfu_entity *dfu;
626 ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
630 for (i = 0; i < dfu_alt_num; i++) {
631 s = strsep(&env, ";");
632 ret = dfu_alt_add(dfu, interface, devstr, s);
634 /* We will free "dfu" in dfu_free_entities() */
642 const char *dfu_get_dev_type(enum dfu_device_type t)
644 const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
645 "SF", "MTD", "VIRT"};
649 const char *dfu_get_layout(enum dfu_layout l)
651 const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
652 "EXT3", "EXT4", "RAM_ADDR", "SKIP",
654 return dfu_layout[l];
657 void dfu_show_entities(void)
659 struct dfu_entity *dfu;
661 puts("DFU alt settings list:\n");
663 list_for_each_entry(dfu, &dfu_list, list) {
664 printf("dev: %s alt: %d name: %s layout: %s\n",
665 dfu_get_dev_type(dfu->dev_type), dfu->alt,
666 dfu->name, dfu_get_layout(dfu->layout));
670 int dfu_get_alt_number(void)
675 struct dfu_entity *dfu_get_entity(int alt)
677 struct dfu_entity *dfu;
679 list_for_each_entry(dfu, &dfu_list, list) {
687 int dfu_get_alt(char *name)
689 struct dfu_entity *dfu;
692 list_for_each_entry(dfu, &dfu_list, list) {
693 if (dfu->name[0] != '/') {
694 if (!strncmp(dfu->name, name, strlen(dfu->name)))
698 * One must also consider absolute path
699 * (/boot/bin/uImage) available at dfu->name when
700 * compared "plain" file name (uImage)
702 * It is the case for e.g. thor gadget where lthor SW
703 * sends only the file name, so only the very last part
704 * of path must be checked for equality
707 str = strstr(dfu->name, name);
712 * Check if matching substring is the last element of
715 if (strlen(dfu->name) ==
716 ((str - dfu->name) + strlen(name)))
724 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
726 unsigned long dfu_buf_size, write, left = size;
731 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
732 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
736 dfu_buf_size = dfu_get_buf_size();
737 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
739 for (i = 0; left > 0; i++) {
740 write = min(dfu_buf_size, left);
742 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
744 ret = dfu_write(dfu, dp, write, i);
746 pr_err("DFU write failed\n");
754 ret = dfu_flush(dfu, NULL, 0, i);
756 pr_err("DFU flush failed!");