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;
24 #ifdef CONFIG_DFU_TIMEOUT
25 static unsigned long dfu_timeout = 0;
29 * The purpose of the dfu_flush_callback() function is to
30 * provide callback for dfu user
32 __weak void dfu_flush_callback(struct dfu_entity *dfu)
37 * The purpose of the dfu_initiated_callback() function is to
38 * provide callback for dfu user
40 __weak void dfu_initiated_callback(struct dfu_entity *dfu)
45 * The purpose of the dfu_usb_get_reset() function is to
46 * provide information if after USB_DETACH request
47 * being sent the dfu-util performed reset of USB
50 * Described behaviour is the only way to distinct if
51 * user has typed -e (detach) or -R (reset) when invoking
55 __weak bool dfu_usb_get_reset(void)
57 #ifdef CONFIG_SPL_DFU_NO_RESET
64 #ifdef CONFIG_DFU_TIMEOUT
65 void dfu_set_timeout(unsigned long timeout)
67 dfu_timeout = timeout;
70 unsigned long dfu_get_timeout(void)
76 static int dfu_find_alt_num(const char *s)
88 * treat dfu_alt_info with several interface information
89 * to allow DFU on several device with one command,
90 * the string format is
91 * interface devstring'='alternate list (';' separated)
92 * and each interface separated by '&'
94 int dfu_config_interfaces(char *env)
96 struct dfu_entity *dfu;
97 char *s, *i, *d, *a, *part;
108 ret = dfu_alt_init(n, &dfu);
125 part = strsep(&a, ";");
126 ret = dfu_alt_add(dfu, i, d, part);
135 int dfu_init_env_entities(char *interface, char *devstr)
141 #ifdef CONFIG_SET_DFU_ALT_INFO
142 set_dfu_alt_info(interface, devstr);
144 str_env = env_get("dfu_alt_info");
146 pr_err("\"dfu_alt_info\" env variable not defined!\n");
150 env_bkp = strdup(str_env);
151 if (!interface && !devstr)
152 ret = dfu_config_interfaces(env_bkp);
154 ret = dfu_config_entities(env_bkp, interface, devstr);
157 pr_err("DFU entities configuration failed!\n");
158 pr_err("(partition table does not match dfu_alt_info?)\n");
167 static unsigned char *dfu_buf;
168 static unsigned long dfu_buf_size;
169 static enum dfu_device_type dfu_buf_device_type;
171 unsigned char *dfu_free_buf(void)
178 unsigned long dfu_get_buf_size(void)
183 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
187 /* manage several entity with several contraint */
188 if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
194 s = env_get("dfu_bufsiz");
196 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
198 if (!s || !dfu_buf_size)
199 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
201 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
202 dfu_buf_size = dfu->max_buf_size;
204 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
206 printf("%s: Could not memalign 0x%lx bytes\n",
207 __func__, dfu_buf_size);
209 dfu_buf_device_type = dfu->dev_type;
213 static char *dfu_get_hash_algo(void)
217 s = env_get("dfu_hash_algo");
221 if (!strcmp(s, "crc32")) {
222 debug("%s: DFU hash method: %s\n", __func__, s);
226 pr_err("DFU hash method: %s not supported!\n", s);
230 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
236 w_size = dfu->i_buf - dfu->i_buf_start;
241 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
242 dfu->i_buf_start, w_size, 0);
244 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
246 debug("%s: Write error!\n", __func__);
249 dfu->i_buf = dfu->i_buf_start;
252 dfu->offset += w_size;
259 void dfu_transaction_cleanup(struct dfu_entity *dfu)
261 /* clear everything */
264 dfu->i_blk_seq_num = 0;
265 dfu->i_buf_start = dfu_get_buf(dfu);
266 dfu->i_buf_end = dfu->i_buf_start;
267 dfu->i_buf = dfu->i_buf_start;
275 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
282 dfu_transaction_cleanup(dfu);
284 if (dfu->i_buf_start == NULL)
287 dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
290 ret = dfu->get_medium_size(dfu, &dfu->r_left);
293 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
297 dfu_initiated_callback(dfu);
302 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
306 ret = dfu_write_buffer_drain(dfu);
310 if (dfu->flush_medium)
311 ret = dfu->flush_medium(dfu);
314 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
317 dfu_flush_callback(dfu);
319 dfu_transaction_cleanup(dfu);
324 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
328 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
329 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
330 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
332 ret = dfu_transaction_initiate(dfu, false);
336 if (dfu->i_blk_seq_num != blk_seq_num) {
337 printf("%s: Wrong sequence number! [%d] [%d]\n",
338 __func__, dfu->i_blk_seq_num, blk_seq_num);
339 dfu_transaction_cleanup(dfu);
343 /* DFU 1.1 standard says:
344 * The wBlockNum field is a block sequence number. It increments each
345 * time a block is transferred, wrapping to zero from 65,535. It is used
346 * to provide useful context to the DFU loader in the device."
348 * This means that it's a 16 bit counter that roll-overs at
349 * 0xffff -> 0x0000. By having a typical 4K transfer block
350 * we roll-over at exactly 256MB. Not very fun to debug.
352 * Handling rollover, and having an inited variable,
356 /* handle rollover */
357 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
359 /* flush buffer if overflow */
360 if ((dfu->i_buf + size) > dfu->i_buf_end) {
361 ret = dfu_write_buffer_drain(dfu);
363 dfu_transaction_cleanup(dfu);
368 /* we should be in buffer now (if not then size too large) */
369 if ((dfu->i_buf + size) > dfu->i_buf_end) {
370 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
371 size, dfu->i_buf_end);
372 dfu_transaction_cleanup(dfu);
376 memcpy(dfu->i_buf, buf, size);
379 /* if end or if buffer full flush */
380 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
381 ret = dfu_write_buffer_drain(dfu);
383 dfu_transaction_cleanup(dfu);
391 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
398 /* get chunk that can be read */
399 chunk = min((long)size, dfu->b_left);
402 memcpy(buf, dfu->i_buf, chunk);
404 dfu_hash_algo->hash_update(dfu_hash_algo,
409 dfu->b_left -= chunk;
417 /* no more to read */
418 if (dfu->r_left == 0)
421 dfu->i_buf = dfu->i_buf_start;
422 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
424 /* got to read, but buffer is empty */
425 if (dfu->b_left > dfu->r_left)
426 dfu->b_left = dfu->r_left;
427 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
430 debug("%s: Read error!\n", __func__);
433 if (dfu->b_left == 0)
435 dfu->offset += dfu->b_left;
436 dfu->r_left -= dfu->b_left;
445 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
449 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
450 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
452 ret = dfu_transaction_initiate(dfu, true);
456 if (dfu->i_blk_seq_num != blk_seq_num) {
457 printf("%s: Wrong sequence number! [%d] [%d]\n",
458 __func__, dfu->i_blk_seq_num, blk_seq_num);
461 /* handle rollover */
462 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
464 ret = dfu_read_buffer_fill(dfu, buf, size);
466 printf("%s: Failed to fill buffer\n", __func__);
472 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
473 dfu_hash_algo->name, dfu->crc);
474 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
476 dfu_transaction_cleanup(dfu);
482 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
483 char *interface, char *devstr)
487 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
488 st = strsep(&s, " ");
489 strcpy(dfu->name, st);
492 dfu->max_buf_size = 0;
493 dfu->free_entity = NULL;
495 /* Specific for mmc device */
496 if (strcmp(interface, "mmc") == 0) {
497 if (dfu_fill_entity_mmc(dfu, devstr, s))
499 } else if (strcmp(interface, "mtd") == 0) {
500 if (dfu_fill_entity_mtd(dfu, devstr, s))
502 } else if (strcmp(interface, "nand") == 0) {
503 if (dfu_fill_entity_nand(dfu, devstr, s))
505 } else if (strcmp(interface, "ram") == 0) {
506 if (dfu_fill_entity_ram(dfu, devstr, s))
508 } else if (strcmp(interface, "sf") == 0) {
509 if (dfu_fill_entity_sf(dfu, devstr, s))
511 } else if (strcmp(interface, "virt") == 0) {
512 if (dfu_fill_entity_virt(dfu, devstr, s))
515 printf("%s: Device %s not (yet) supported!\n",
516 __func__, interface);
524 void dfu_free_entities(void)
526 struct dfu_entity *dfu, *p, *t = NULL;
529 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
530 list_del(&dfu->list);
531 if (dfu->free_entity)
532 dfu->free_entity(dfu);
537 INIT_LIST_HEAD(&dfu_list);
542 int dfu_alt_init(int num, struct dfu_entity **dfu)
548 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
550 dfu_hash_algo = NULL;
551 s = dfu_get_hash_algo();
553 ret = hash_lookup_algo(s, &dfu_hash_algo);
555 pr_err("Hash algorithm %s not supported\n", s);
558 *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
565 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
567 struct dfu_entity *p_dfu;
570 if (alt_num_cnt >= dfu_alt_num)
573 p_dfu = &dfu[alt_num_cnt];
574 ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
578 list_add_tail(&p_dfu->list, &dfu_list);
584 int dfu_config_entities(char *env, char *interface, char *devstr)
586 struct dfu_entity *dfu;
590 ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
594 for (i = 0; i < dfu_alt_num; i++) {
595 s = strsep(&env, ";");
596 ret = dfu_alt_add(dfu, interface, devstr, s);
598 /* We will free "dfu" in dfu_free_entities() */
606 const char *dfu_get_dev_type(enum dfu_device_type t)
608 const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
609 "SF", "MTD", "VIRT"};
613 const char *dfu_get_layout(enum dfu_layout l)
615 const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
616 "EXT3", "EXT4", "RAM_ADDR" };
617 return dfu_layout[l];
620 void dfu_show_entities(void)
622 struct dfu_entity *dfu;
624 puts("DFU alt settings list:\n");
626 list_for_each_entry(dfu, &dfu_list, list) {
627 printf("dev: %s alt: %d name: %s layout: %s\n",
628 dfu_get_dev_type(dfu->dev_type), dfu->alt,
629 dfu->name, dfu_get_layout(dfu->layout));
633 int dfu_get_alt_number(void)
638 struct dfu_entity *dfu_get_entity(int alt)
640 struct dfu_entity *dfu;
642 list_for_each_entry(dfu, &dfu_list, list) {
650 int dfu_get_alt(char *name)
652 struct dfu_entity *dfu;
655 list_for_each_entry(dfu, &dfu_list, list) {
656 if (dfu->name[0] != '/') {
657 if (!strncmp(dfu->name, name, strlen(dfu->name)))
661 * One must also consider absolute path
662 * (/boot/bin/uImage) available at dfu->name when
663 * compared "plain" file name (uImage)
665 * It is the case for e.g. thor gadget where lthor SW
666 * sends only the file name, so only the very last part
667 * of path must be checked for equality
670 str = strstr(dfu->name, name);
675 * Check if matching substring is the last element of
678 if (strlen(dfu->name) ==
679 ((str - dfu->name) + strlen(name)))
687 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
689 unsigned long dfu_buf_size, write, left = size;
694 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
695 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
699 dfu_buf_size = dfu_get_buf_size();
700 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
702 for (i = 0; left > 0; i++) {
703 write = min(dfu_buf_size, left);
705 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
707 ret = dfu_write(dfu, dp, write, i);
709 pr_err("DFU write failed\n");
717 ret = dfu_flush(dfu, NULL, 0, i);
719 pr_err("DFU flush failed!");