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 part = skip_spaces(part);
139 ret = dfu_alt_add(dfu, i, d, part);
148 int dfu_init_env_entities(char *interface, char *devstr)
154 dfu_reinit_needed = false;
156 #ifdef CONFIG_SET_DFU_ALT_INFO
157 set_dfu_alt_info(interface, devstr);
159 str_env = env_get("dfu_alt_info");
161 pr_err("\"dfu_alt_info\" env variable not defined!\n");
165 env_bkp = strdup(str_env);
166 if (!interface && !devstr)
167 ret = dfu_config_interfaces(env_bkp);
169 ret = dfu_config_entities(env_bkp, interface, devstr);
172 pr_err("DFU entities configuration failed!\n");
173 pr_err("(partition table does not match dfu_alt_info?)\n");
182 static unsigned char *dfu_buf;
183 static unsigned long dfu_buf_size;
184 static enum dfu_device_type dfu_buf_device_type;
186 unsigned char *dfu_free_buf(void)
193 unsigned long dfu_get_buf_size(void)
198 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
202 /* manage several entity with several contraint */
203 if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
209 s = env_get("dfu_bufsiz");
211 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
213 if (!s || !dfu_buf_size)
214 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
216 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
217 dfu_buf_size = dfu->max_buf_size;
219 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
221 printf("%s: Could not memalign 0x%lx bytes\n",
222 __func__, dfu_buf_size);
224 dfu_buf_device_type = dfu->dev_type;
228 static char *dfu_get_hash_algo(void)
232 s = env_get("dfu_hash_algo");
236 if (!strcmp(s, "crc32")) {
237 debug("%s: DFU hash method: %s\n", __func__, s);
241 pr_err("DFU hash method: %s not supported!\n", s);
245 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
251 w_size = dfu->i_buf - dfu->i_buf_start;
256 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
257 dfu->i_buf_start, w_size, 0);
259 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
261 debug("%s: Write error!\n", __func__);
264 dfu->i_buf = dfu->i_buf_start;
267 dfu->offset += w_size;
274 void dfu_transaction_cleanup(struct dfu_entity *dfu)
276 /* clear everything */
279 dfu->i_blk_seq_num = 0;
280 dfu->i_buf_start = dfu_get_buf(dfu);
281 dfu->i_buf_end = dfu->i_buf_start;
282 dfu->i_buf = dfu->i_buf_start;
290 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
297 dfu_transaction_cleanup(dfu);
299 if (dfu->i_buf_start == NULL)
302 dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
305 ret = dfu->get_medium_size(dfu, &dfu->r_left);
308 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
312 dfu_initiated_callback(dfu);
317 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
321 ret = dfu_write_buffer_drain(dfu);
325 if (dfu->flush_medium)
326 ret = dfu->flush_medium(dfu);
329 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
332 dfu_flush_callback(dfu);
334 dfu_transaction_cleanup(dfu);
339 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
343 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
344 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
345 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
347 ret = dfu_transaction_initiate(dfu, false);
351 if (dfu->i_blk_seq_num != blk_seq_num) {
352 printf("%s: Wrong sequence number! [%d] [%d]\n",
353 __func__, dfu->i_blk_seq_num, blk_seq_num);
354 dfu_transaction_cleanup(dfu);
355 dfu_error_callback(dfu, "Wrong sequence number");
359 /* DFU 1.1 standard says:
360 * The wBlockNum field is a block sequence number. It increments each
361 * time a block is transferred, wrapping to zero from 65,535. It is used
362 * to provide useful context to the DFU loader in the device."
364 * This means that it's a 16 bit counter that roll-overs at
365 * 0xffff -> 0x0000. By having a typical 4K transfer block
366 * we roll-over at exactly 256MB. Not very fun to debug.
368 * Handling rollover, and having an inited variable,
372 /* handle rollover */
373 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
375 /* flush buffer if overflow */
376 if ((dfu->i_buf + size) > dfu->i_buf_end) {
377 ret = dfu_write_buffer_drain(dfu);
379 dfu_transaction_cleanup(dfu);
380 dfu_error_callback(dfu, "DFU write error");
385 /* we should be in buffer now (if not then size too large) */
386 if ((dfu->i_buf + size) > dfu->i_buf_end) {
387 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
388 size, dfu->i_buf_end);
389 dfu_transaction_cleanup(dfu);
390 dfu_error_callback(dfu, "Buffer overflow");
394 memcpy(dfu->i_buf, buf, size);
397 /* if end or if buffer full flush */
398 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
399 ret = dfu_write_buffer_drain(dfu);
401 dfu_transaction_cleanup(dfu);
402 dfu_error_callback(dfu, "DFU write error");
410 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
417 /* get chunk that can be read */
418 chunk = min((long)size, dfu->b_left);
421 memcpy(buf, dfu->i_buf, chunk);
423 dfu_hash_algo->hash_update(dfu_hash_algo,
428 dfu->b_left -= chunk;
436 /* no more to read */
437 if (dfu->r_left == 0)
440 dfu->i_buf = dfu->i_buf_start;
441 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
443 /* got to read, but buffer is empty */
444 if (dfu->b_left > dfu->r_left)
445 dfu->b_left = dfu->r_left;
446 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
449 debug("%s: Read error!\n", __func__);
452 if (dfu->b_left == 0)
454 dfu->offset += dfu->b_left;
455 dfu->r_left -= dfu->b_left;
464 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
468 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
469 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
471 ret = dfu_transaction_initiate(dfu, true);
475 if (dfu->i_blk_seq_num != blk_seq_num) {
476 printf("%s: Wrong sequence number! [%d] [%d]\n",
477 __func__, dfu->i_blk_seq_num, blk_seq_num);
480 /* handle rollover */
481 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
483 ret = dfu_read_buffer_fill(dfu, buf, size);
485 printf("%s: Failed to fill buffer\n", __func__);
491 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
492 dfu_hash_algo->name, dfu->crc);
493 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
495 dfu_transaction_cleanup(dfu);
501 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
502 char *interface, char *devstr)
504 char *argv[DFU_MAX_ENTITY_ARGS];
508 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
509 st = strsep(&s, " \t");
510 strlcpy(dfu->name, st, DFU_NAME_SIZE);
512 /* Parse arguments */
513 for (argc = 0; s && argc < DFU_MAX_ENTITY_ARGS; argc++) {
517 argv[argc] = strsep(&s, " \t");
520 if (argc == DFU_MAX_ENTITY_ARGS && s) {
523 log_err("Too many arguments for %s\n", dfu->name);
529 dfu->max_buf_size = 0;
530 dfu->free_entity = NULL;
532 /* Specific for mmc device */
533 if (strcmp(interface, "mmc") == 0) {
534 if (dfu_fill_entity_mmc(dfu, devstr, argv, argc))
536 } else if (strcmp(interface, "mtd") == 0) {
537 if (dfu_fill_entity_mtd(dfu, devstr, argv, argc))
539 } else if (strcmp(interface, "nand") == 0) {
540 if (dfu_fill_entity_nand(dfu, devstr, argv, argc))
542 } else if (strcmp(interface, "ram") == 0) {
543 if (dfu_fill_entity_ram(dfu, devstr, argv, argc))
545 } else if (strcmp(interface, "sf") == 0) {
546 if (dfu_fill_entity_sf(dfu, devstr, argv, argc))
548 } else if (strcmp(interface, "virt") == 0) {
549 if (dfu_fill_entity_virt(dfu, devstr, argv, argc))
552 printf("%s: Device %s not (yet) supported!\n",
553 __func__, interface);
561 void dfu_free_entities(void)
563 struct dfu_entity *dfu, *p, *t = NULL;
566 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
567 list_del(&dfu->list);
568 if (dfu->free_entity)
569 dfu->free_entity(dfu);
574 INIT_LIST_HEAD(&dfu_list);
579 int dfu_alt_init(int num, struct dfu_entity **dfu)
585 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
587 dfu_hash_algo = NULL;
588 s = dfu_get_hash_algo();
590 ret = hash_lookup_algo(s, &dfu_hash_algo);
592 pr_err("Hash algorithm %s not supported\n", s);
595 *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
602 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
604 struct dfu_entity *p_dfu;
607 if (alt_num_cnt >= dfu_alt_num)
610 p_dfu = &dfu[alt_num_cnt];
611 ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
615 list_add_tail(&p_dfu->list, &dfu_list);
621 int dfu_config_entities(char *env, char *interface, char *devstr)
623 struct dfu_entity *dfu;
627 ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
631 for (i = 0; i < dfu_alt_num; i++) {
632 s = strsep(&env, ";");
634 ret = dfu_alt_add(dfu, interface, devstr, s);
636 /* We will free "dfu" in dfu_free_entities() */
644 const char *dfu_get_dev_type(enum dfu_device_type t)
646 const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
647 "SF", "MTD", "VIRT"};
651 const char *dfu_get_layout(enum dfu_layout l)
653 const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
654 "EXT3", "EXT4", "RAM_ADDR", "SKIP",
656 return dfu_layout[l];
659 void dfu_show_entities(void)
661 struct dfu_entity *dfu;
663 puts("DFU alt settings list:\n");
665 list_for_each_entry(dfu, &dfu_list, list) {
666 printf("dev: %s alt: %d name: %s layout: %s\n",
667 dfu_get_dev_type(dfu->dev_type), dfu->alt,
668 dfu->name, dfu_get_layout(dfu->layout));
672 int dfu_get_alt_number(void)
677 struct dfu_entity *dfu_get_entity(int alt)
679 struct dfu_entity *dfu;
681 list_for_each_entry(dfu, &dfu_list, list) {
689 int dfu_get_alt(char *name)
691 struct dfu_entity *dfu;
694 list_for_each_entry(dfu, &dfu_list, list) {
695 if (dfu->name[0] != '/') {
696 if (!strncmp(dfu->name, name, strlen(dfu->name)))
700 * One must also consider absolute path
701 * (/boot/bin/uImage) available at dfu->name when
702 * compared "plain" file name (uImage)
704 * It is the case for e.g. thor gadget where lthor SW
705 * sends only the file name, so only the very last part
706 * of path must be checked for equality
709 str = strstr(dfu->name, name);
714 * Check if matching substring is the last element of
717 if (strlen(dfu->name) ==
718 ((str - dfu->name) + strlen(name)))
726 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
728 unsigned long dfu_buf_size, write, left = size;
733 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
734 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
738 dfu_buf_size = dfu_get_buf_size();
739 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
741 for (i = 0; left > 0; i++) {
742 write = min(dfu_buf_size, left);
744 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
746 ret = dfu_write(dfu, dp, write, i);
748 pr_err("DFU write failed\n");
756 ret = dfu_flush(dfu, NULL, 0, i);
758 pr_err("DFU flush failed!");