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>
17 #include <linux/list.h>
18 #include <linux/compiler.h>
20 static LIST_HEAD(dfu_list);
21 static int dfu_alt_num;
22 static int alt_num_cnt;
23 static struct hash_algo *dfu_hash_algo;
26 * The purpose of the dfu_usb_get_reset() function is to
27 * provide information if after USB_DETACH request
28 * being sent the dfu-util performed reset of USB
31 * Described behaviour is the only way to distinct if
32 * user has typed -e (detach) or -R (reset) when invoking
36 __weak bool dfu_usb_get_reset(void)
38 #ifdef CONFIG_SPL_DFU_NO_RESET
45 static int dfu_find_alt_num(const char *s)
57 * treat dfu_alt_info with several interface information
58 * to allow DFU on several device with one command,
59 * the string format is
60 * interface devstring'='alternate list (';' separated)
61 * and each interface separated by '&'
63 int dfu_config_interfaces(char *env)
65 struct dfu_entity *dfu;
66 char *s, *i, *d, *a, *part;
77 ret = dfu_alt_init(n, &dfu);
94 part = strsep(&a, ";");
95 ret = dfu_alt_add(dfu, i, d, part);
104 int dfu_init_env_entities(char *interface, char *devstr)
110 #ifdef CONFIG_SET_DFU_ALT_INFO
111 set_dfu_alt_info(interface, devstr);
113 str_env = env_get("dfu_alt_info");
115 pr_err("\"dfu_alt_info\" env variable not defined!\n");
119 env_bkp = strdup(str_env);
120 if (!interface && !devstr)
121 ret = dfu_config_interfaces(env_bkp);
123 ret = dfu_config_entities(env_bkp, interface, devstr);
126 pr_err("DFU entities configuration failed!\n");
127 pr_err("(partition table does not match dfu_alt_info?)\n");
136 static unsigned char *dfu_buf;
137 static unsigned long dfu_buf_size;
138 static enum dfu_device_type dfu_buf_device_type;
140 unsigned char *dfu_free_buf(void)
147 unsigned long dfu_get_buf_size(void)
152 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
156 /* manage several entity with several contraint */
157 if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
163 s = env_get("dfu_bufsiz");
165 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
167 if (!s || !dfu_buf_size)
168 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
170 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
171 dfu_buf_size = dfu->max_buf_size;
173 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
175 printf("%s: Could not memalign 0x%lx bytes\n",
176 __func__, dfu_buf_size);
178 dfu_buf_device_type = dfu->dev_type;
182 static char *dfu_get_hash_algo(void)
186 s = env_get("dfu_hash_algo");
190 if (!strcmp(s, "crc32")) {
191 debug("%s: DFU hash method: %s\n", __func__, s);
195 pr_err("DFU hash method: %s not supported!\n", s);
199 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
205 w_size = dfu->i_buf - dfu->i_buf_start;
210 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
211 dfu->i_buf_start, w_size, 0);
213 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
215 debug("%s: Write error!\n", __func__);
218 dfu->i_buf = dfu->i_buf_start;
221 dfu->offset += w_size;
228 void dfu_transaction_cleanup(struct dfu_entity *dfu)
230 /* clear everything */
233 dfu->i_blk_seq_num = 0;
234 dfu->i_buf_start = dfu_get_buf(dfu);
235 dfu->i_buf_end = dfu->i_buf_start;
236 dfu->i_buf = dfu->i_buf_start;
244 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
251 dfu_transaction_cleanup(dfu);
253 if (dfu->i_buf_start == NULL)
256 dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
259 ret = dfu->get_medium_size(dfu, &dfu->r_left);
262 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
270 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
274 ret = dfu_write_buffer_drain(dfu);
278 if (dfu->flush_medium)
279 ret = dfu->flush_medium(dfu);
282 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
285 dfu_transaction_cleanup(dfu);
290 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
294 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
295 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
296 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
298 ret = dfu_transaction_initiate(dfu, false);
302 if (dfu->i_blk_seq_num != blk_seq_num) {
303 printf("%s: Wrong sequence number! [%d] [%d]\n",
304 __func__, dfu->i_blk_seq_num, blk_seq_num);
305 dfu_transaction_cleanup(dfu);
309 /* DFU 1.1 standard says:
310 * The wBlockNum field is a block sequence number. It increments each
311 * time a block is transferred, wrapping to zero from 65,535. It is used
312 * to provide useful context to the DFU loader in the device."
314 * This means that it's a 16 bit counter that roll-overs at
315 * 0xffff -> 0x0000. By having a typical 4K transfer block
316 * we roll-over at exactly 256MB. Not very fun to debug.
318 * Handling rollover, and having an inited variable,
322 /* handle rollover */
323 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
325 /* flush buffer if overflow */
326 if ((dfu->i_buf + size) > dfu->i_buf_end) {
327 ret = dfu_write_buffer_drain(dfu);
329 dfu_transaction_cleanup(dfu);
334 /* we should be in buffer now (if not then size too large) */
335 if ((dfu->i_buf + size) > dfu->i_buf_end) {
336 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
337 size, dfu->i_buf_end);
338 dfu_transaction_cleanup(dfu);
342 memcpy(dfu->i_buf, buf, size);
345 /* if end or if buffer full flush */
346 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
347 ret = dfu_write_buffer_drain(dfu);
349 dfu_transaction_cleanup(dfu);
357 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
364 /* get chunk that can be read */
365 chunk = min((long)size, dfu->b_left);
368 memcpy(buf, dfu->i_buf, chunk);
370 dfu_hash_algo->hash_update(dfu_hash_algo,
375 dfu->b_left -= chunk;
383 /* no more to read */
384 if (dfu->r_left == 0)
387 dfu->i_buf = dfu->i_buf_start;
388 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
390 /* got to read, but buffer is empty */
391 if (dfu->b_left > dfu->r_left)
392 dfu->b_left = dfu->r_left;
393 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
396 debug("%s: Read error!\n", __func__);
399 if (dfu->b_left == 0)
401 dfu->offset += dfu->b_left;
402 dfu->r_left -= dfu->b_left;
411 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
415 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
416 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
418 ret = dfu_transaction_initiate(dfu, true);
422 if (dfu->i_blk_seq_num != blk_seq_num) {
423 printf("%s: Wrong sequence number! [%d] [%d]\n",
424 __func__, dfu->i_blk_seq_num, blk_seq_num);
427 /* handle rollover */
428 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
430 ret = dfu_read_buffer_fill(dfu, buf, size);
432 printf("%s: Failed to fill buffer\n", __func__);
438 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
439 dfu_hash_algo->name, dfu->crc);
440 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
442 dfu_transaction_cleanup(dfu);
448 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
449 char *interface, char *devstr)
453 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
454 st = strsep(&s, " ");
455 strcpy(dfu->name, st);
458 dfu->max_buf_size = 0;
459 dfu->free_entity = NULL;
461 /* Specific for mmc device */
462 if (strcmp(interface, "mmc") == 0) {
463 if (dfu_fill_entity_mmc(dfu, devstr, s))
465 } else if (strcmp(interface, "mtd") == 0) {
466 if (dfu_fill_entity_mtd(dfu, devstr, s))
468 } else if (strcmp(interface, "nand") == 0) {
469 if (dfu_fill_entity_nand(dfu, devstr, s))
471 } else if (strcmp(interface, "ram") == 0) {
472 if (dfu_fill_entity_ram(dfu, devstr, s))
474 } else if (strcmp(interface, "sf") == 0) {
475 if (dfu_fill_entity_sf(dfu, devstr, s))
477 } else if (strcmp(interface, "virt") == 0) {
478 if (dfu_fill_entity_virt(dfu, devstr, s))
481 printf("%s: Device %s not (yet) supported!\n",
482 __func__, interface);
490 void dfu_free_entities(void)
492 struct dfu_entity *dfu, *p, *t = NULL;
495 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
496 list_del(&dfu->list);
497 if (dfu->free_entity)
498 dfu->free_entity(dfu);
503 INIT_LIST_HEAD(&dfu_list);
508 int dfu_alt_init(int num, struct dfu_entity **dfu)
514 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
516 dfu_hash_algo = NULL;
517 s = dfu_get_hash_algo();
519 ret = hash_lookup_algo(s, &dfu_hash_algo);
521 pr_err("Hash algorithm %s not supported\n", s);
524 *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
531 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
533 struct dfu_entity *p_dfu;
536 if (alt_num_cnt >= dfu_alt_num)
539 p_dfu = &dfu[alt_num_cnt];
540 ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
544 list_add_tail(&p_dfu->list, &dfu_list);
550 int dfu_config_entities(char *env, char *interface, char *devstr)
552 struct dfu_entity *dfu;
556 ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
560 for (i = 0; i < dfu_alt_num; i++) {
561 s = strsep(&env, ";");
562 ret = dfu_alt_add(dfu, interface, devstr, s);
564 /* We will free "dfu" in dfu_free_entities() */
572 const char *dfu_get_dev_type(enum dfu_device_type t)
574 const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
575 "SF", "MTD", "VIRT"};
579 const char *dfu_get_layout(enum dfu_layout l)
581 const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
582 "EXT3", "EXT4", "RAM_ADDR" };
583 return dfu_layout[l];
586 void dfu_show_entities(void)
588 struct dfu_entity *dfu;
590 puts("DFU alt settings list:\n");
592 list_for_each_entry(dfu, &dfu_list, list) {
593 printf("dev: %s alt: %d name: %s layout: %s\n",
594 dfu_get_dev_type(dfu->dev_type), dfu->alt,
595 dfu->name, dfu_get_layout(dfu->layout));
599 int dfu_get_alt_number(void)
604 struct dfu_entity *dfu_get_entity(int alt)
606 struct dfu_entity *dfu;
608 list_for_each_entry(dfu, &dfu_list, list) {
616 int dfu_get_alt(char *name)
618 struct dfu_entity *dfu;
621 list_for_each_entry(dfu, &dfu_list, list) {
622 if (dfu->name[0] != '/') {
623 if (!strncmp(dfu->name, name, strlen(dfu->name)))
627 * One must also consider absolute path
628 * (/boot/bin/uImage) available at dfu->name when
629 * compared "plain" file name (uImage)
631 * It is the case for e.g. thor gadget where lthor SW
632 * sends only the file name, so only the very last part
633 * of path must be checked for equality
636 str = strstr(dfu->name, name);
641 * Check if matching substring is the last element of
644 if (strlen(dfu->name) ==
645 ((str - dfu->name) + strlen(name)))
653 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
655 unsigned long dfu_buf_size, write, left = size;
660 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
661 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
665 dfu_buf_size = dfu_get_buf_size();
666 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
668 for (i = 0; left > 0; i++) {
669 write = min(dfu_buf_size, left);
671 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
673 ret = dfu_write(dfu, dp, write, i);
675 pr_err("DFU write failed\n");
683 ret = dfu_flush(dfu, NULL, 0, i);
685 pr_err("DFU flush failed!");