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_flush_callback() function is to
27 * provide callback for dfu user
29 __weak void dfu_flush_callback(struct dfu_entity *dfu)
34 * The purpose of the dfu_initiated_callback() function is to
35 * provide callback for dfu user
37 __weak void dfu_initiated_callback(struct dfu_entity *dfu)
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
47 * Described behaviour is the only way to distinct if
48 * user has typed -e (detach) or -R (reset) when invoking
52 __weak bool dfu_usb_get_reset(void)
54 #ifdef CONFIG_SPL_DFU_NO_RESET
61 static int dfu_find_alt_num(const char *s)
73 * treat dfu_alt_info with several interface information
74 * to allow DFU on several device with one command,
75 * the string format is
76 * interface devstring'='alternate list (';' separated)
77 * and each interface separated by '&'
79 int dfu_config_interfaces(char *env)
81 struct dfu_entity *dfu;
82 char *s, *i, *d, *a, *part;
93 ret = dfu_alt_init(n, &dfu);
110 part = strsep(&a, ";");
111 ret = dfu_alt_add(dfu, i, d, part);
120 int dfu_init_env_entities(char *interface, char *devstr)
126 #ifdef CONFIG_SET_DFU_ALT_INFO
127 set_dfu_alt_info(interface, devstr);
129 str_env = env_get("dfu_alt_info");
131 pr_err("\"dfu_alt_info\" env variable not defined!\n");
135 env_bkp = strdup(str_env);
136 if (!interface && !devstr)
137 ret = dfu_config_interfaces(env_bkp);
139 ret = dfu_config_entities(env_bkp, interface, devstr);
142 pr_err("DFU entities configuration failed!\n");
143 pr_err("(partition table does not match dfu_alt_info?)\n");
152 static unsigned char *dfu_buf;
153 static unsigned long dfu_buf_size;
154 static enum dfu_device_type dfu_buf_device_type;
156 unsigned char *dfu_free_buf(void)
163 unsigned long dfu_get_buf_size(void)
168 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
172 /* manage several entity with several contraint */
173 if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
179 s = env_get("dfu_bufsiz");
181 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
183 if (!s || !dfu_buf_size)
184 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
186 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
187 dfu_buf_size = dfu->max_buf_size;
189 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
191 printf("%s: Could not memalign 0x%lx bytes\n",
192 __func__, dfu_buf_size);
194 dfu_buf_device_type = dfu->dev_type;
198 static char *dfu_get_hash_algo(void)
202 s = env_get("dfu_hash_algo");
206 if (!strcmp(s, "crc32")) {
207 debug("%s: DFU hash method: %s\n", __func__, s);
211 pr_err("DFU hash method: %s not supported!\n", s);
215 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
221 w_size = dfu->i_buf - dfu->i_buf_start;
226 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
227 dfu->i_buf_start, w_size, 0);
229 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
231 debug("%s: Write error!\n", __func__);
234 dfu->i_buf = dfu->i_buf_start;
237 dfu->offset += w_size;
244 void dfu_transaction_cleanup(struct dfu_entity *dfu)
246 /* clear everything */
249 dfu->i_blk_seq_num = 0;
250 dfu->i_buf_start = dfu_get_buf(dfu);
251 dfu->i_buf_end = dfu->i_buf_start;
252 dfu->i_buf = dfu->i_buf_start;
260 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
267 dfu_transaction_cleanup(dfu);
269 if (dfu->i_buf_start == NULL)
272 dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
275 ret = dfu->get_medium_size(dfu, &dfu->r_left);
278 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
282 dfu_initiated_callback(dfu);
287 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
291 ret = dfu_write_buffer_drain(dfu);
295 if (dfu->flush_medium)
296 ret = dfu->flush_medium(dfu);
299 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
302 dfu_flush_callback(dfu);
304 dfu_transaction_cleanup(dfu);
309 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
313 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
314 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
315 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
317 ret = dfu_transaction_initiate(dfu, false);
321 if (dfu->i_blk_seq_num != blk_seq_num) {
322 printf("%s: Wrong sequence number! [%d] [%d]\n",
323 __func__, dfu->i_blk_seq_num, blk_seq_num);
324 dfu_transaction_cleanup(dfu);
328 /* DFU 1.1 standard says:
329 * The wBlockNum field is a block sequence number. It increments each
330 * time a block is transferred, wrapping to zero from 65,535. It is used
331 * to provide useful context to the DFU loader in the device."
333 * This means that it's a 16 bit counter that roll-overs at
334 * 0xffff -> 0x0000. By having a typical 4K transfer block
335 * we roll-over at exactly 256MB. Not very fun to debug.
337 * Handling rollover, and having an inited variable,
341 /* handle rollover */
342 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
344 /* flush buffer if overflow */
345 if ((dfu->i_buf + size) > dfu->i_buf_end) {
346 ret = dfu_write_buffer_drain(dfu);
348 dfu_transaction_cleanup(dfu);
353 /* we should be in buffer now (if not then size too large) */
354 if ((dfu->i_buf + size) > dfu->i_buf_end) {
355 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
356 size, dfu->i_buf_end);
357 dfu_transaction_cleanup(dfu);
361 memcpy(dfu->i_buf, buf, size);
364 /* if end or if buffer full flush */
365 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
366 ret = dfu_write_buffer_drain(dfu);
368 dfu_transaction_cleanup(dfu);
376 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
383 /* get chunk that can be read */
384 chunk = min((long)size, dfu->b_left);
387 memcpy(buf, dfu->i_buf, chunk);
389 dfu_hash_algo->hash_update(dfu_hash_algo,
394 dfu->b_left -= chunk;
402 /* no more to read */
403 if (dfu->r_left == 0)
406 dfu->i_buf = dfu->i_buf_start;
407 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
409 /* got to read, but buffer is empty */
410 if (dfu->b_left > dfu->r_left)
411 dfu->b_left = dfu->r_left;
412 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
415 debug("%s: Read error!\n", __func__);
418 if (dfu->b_left == 0)
420 dfu->offset += dfu->b_left;
421 dfu->r_left -= dfu->b_left;
430 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
434 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
435 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
437 ret = dfu_transaction_initiate(dfu, true);
441 if (dfu->i_blk_seq_num != blk_seq_num) {
442 printf("%s: Wrong sequence number! [%d] [%d]\n",
443 __func__, dfu->i_blk_seq_num, blk_seq_num);
446 /* handle rollover */
447 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
449 ret = dfu_read_buffer_fill(dfu, buf, size);
451 printf("%s: Failed to fill buffer\n", __func__);
457 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
458 dfu_hash_algo->name, dfu->crc);
459 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
461 dfu_transaction_cleanup(dfu);
467 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
468 char *interface, char *devstr)
472 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
473 st = strsep(&s, " ");
474 strcpy(dfu->name, st);
477 dfu->max_buf_size = 0;
478 dfu->free_entity = NULL;
480 /* Specific for mmc device */
481 if (strcmp(interface, "mmc") == 0) {
482 if (dfu_fill_entity_mmc(dfu, devstr, s))
484 } else if (strcmp(interface, "mtd") == 0) {
485 if (dfu_fill_entity_mtd(dfu, devstr, s))
487 } else if (strcmp(interface, "nand") == 0) {
488 if (dfu_fill_entity_nand(dfu, devstr, s))
490 } else if (strcmp(interface, "ram") == 0) {
491 if (dfu_fill_entity_ram(dfu, devstr, s))
493 } else if (strcmp(interface, "sf") == 0) {
494 if (dfu_fill_entity_sf(dfu, devstr, s))
496 } else if (strcmp(interface, "virt") == 0) {
497 if (dfu_fill_entity_virt(dfu, devstr, s))
500 printf("%s: Device %s not (yet) supported!\n",
501 __func__, interface);
509 void dfu_free_entities(void)
511 struct dfu_entity *dfu, *p, *t = NULL;
514 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
515 list_del(&dfu->list);
516 if (dfu->free_entity)
517 dfu->free_entity(dfu);
522 INIT_LIST_HEAD(&dfu_list);
527 int dfu_alt_init(int num, struct dfu_entity **dfu)
533 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
535 dfu_hash_algo = NULL;
536 s = dfu_get_hash_algo();
538 ret = hash_lookup_algo(s, &dfu_hash_algo);
540 pr_err("Hash algorithm %s not supported\n", s);
543 *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
550 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
552 struct dfu_entity *p_dfu;
555 if (alt_num_cnt >= dfu_alt_num)
558 p_dfu = &dfu[alt_num_cnt];
559 ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
563 list_add_tail(&p_dfu->list, &dfu_list);
569 int dfu_config_entities(char *env, char *interface, char *devstr)
571 struct dfu_entity *dfu;
575 ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
579 for (i = 0; i < dfu_alt_num; i++) {
580 s = strsep(&env, ";");
581 ret = dfu_alt_add(dfu, interface, devstr, s);
583 /* We will free "dfu" in dfu_free_entities() */
591 const char *dfu_get_dev_type(enum dfu_device_type t)
593 const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
594 "SF", "MTD", "VIRT"};
598 const char *dfu_get_layout(enum dfu_layout l)
600 const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
601 "EXT3", "EXT4", "RAM_ADDR" };
602 return dfu_layout[l];
605 void dfu_show_entities(void)
607 struct dfu_entity *dfu;
609 puts("DFU alt settings list:\n");
611 list_for_each_entry(dfu, &dfu_list, list) {
612 printf("dev: %s alt: %d name: %s layout: %s\n",
613 dfu_get_dev_type(dfu->dev_type), dfu->alt,
614 dfu->name, dfu_get_layout(dfu->layout));
618 int dfu_get_alt_number(void)
623 struct dfu_entity *dfu_get_entity(int alt)
625 struct dfu_entity *dfu;
627 list_for_each_entry(dfu, &dfu_list, list) {
635 int dfu_get_alt(char *name)
637 struct dfu_entity *dfu;
640 list_for_each_entry(dfu, &dfu_list, list) {
641 if (dfu->name[0] != '/') {
642 if (!strncmp(dfu->name, name, strlen(dfu->name)))
646 * One must also consider absolute path
647 * (/boot/bin/uImage) available at dfu->name when
648 * compared "plain" file name (uImage)
650 * It is the case for e.g. thor gadget where lthor SW
651 * sends only the file name, so only the very last part
652 * of path must be checked for equality
655 str = strstr(dfu->name, name);
660 * Check if matching substring is the last element of
663 if (strlen(dfu->name) ==
664 ((str - dfu->name) + strlen(name)))
672 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
674 unsigned long dfu_buf_size, write, left = size;
679 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
680 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
684 dfu_buf_size = dfu_get_buf_size();
685 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
687 for (i = 0; left > 0; i++) {
688 write = min(dfu_buf_size, left);
690 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
692 ret = dfu_write(dfu, dp, write, i);
694 pr_err("DFU write failed\n");
702 ret = dfu_flush(dfu, NULL, 0, i);
704 pr_err("DFU flush failed!");