2 * dfu.c -- DFU back-end routines
4 * Copyright (C) 2012 Samsung Electronics
5 * author: Lukasz Majewski <l.majewski@samsung.com>
7 * SPDX-License-Identifier: GPL-2.0+
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)
56 int dfu_init_env_entities(char *interface, char *devstr)
62 #ifdef CONFIG_SET_DFU_ALT_INFO
63 set_dfu_alt_info(interface, devstr);
65 str_env = getenv("dfu_alt_info");
67 error("\"dfu_alt_info\" env variable not defined!\n");
71 env_bkp = strdup(str_env);
72 ret = dfu_config_entities(env_bkp, interface, devstr);
74 error("DFU entities configuration failed!\n");
82 static unsigned char *dfu_buf;
83 static unsigned long dfu_buf_size;
85 unsigned char *dfu_free_buf(void)
92 unsigned long dfu_get_buf_size(void)
97 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
104 s = getenv("dfu_bufsiz");
106 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
108 if (!s || !dfu_buf_size)
109 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
111 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
112 dfu_buf_size = dfu->max_buf_size;
114 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
116 printf("%s: Could not memalign 0x%lx bytes\n",
117 __func__, dfu_buf_size);
122 static char *dfu_get_hash_algo(void)
126 s = getenv("dfu_hash_algo");
130 if (!strcmp(s, "crc32")) {
131 debug("%s: DFU hash method: %s\n", __func__, s);
135 error("DFU hash method: %s not supported!\n", s);
139 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
145 w_size = dfu->i_buf - dfu->i_buf_start;
150 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
151 dfu->i_buf_start, w_size, 0);
153 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
155 debug("%s: Write error!\n", __func__);
158 dfu->i_buf = dfu->i_buf_start;
161 dfu->offset += w_size;
168 void dfu_transaction_cleanup(struct dfu_entity *dfu)
170 /* clear everything */
173 dfu->i_blk_seq_num = 0;
174 dfu->i_buf_start = dfu_buf;
175 dfu->i_buf_end = dfu_buf;
176 dfu->i_buf = dfu->i_buf_start;
184 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
188 ret = dfu_write_buffer_drain(dfu);
192 if (dfu->flush_medium)
193 ret = dfu->flush_medium(dfu);
196 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
199 dfu_transaction_cleanup(dfu);
204 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
208 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
209 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
210 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
217 dfu->i_blk_seq_num = 0;
218 dfu->i_buf_start = dfu_get_buf(dfu);
219 if (dfu->i_buf_start == NULL)
221 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
222 dfu->i_buf = dfu->i_buf_start;
227 if (dfu->i_blk_seq_num != blk_seq_num) {
228 printf("%s: Wrong sequence number! [%d] [%d]\n",
229 __func__, dfu->i_blk_seq_num, blk_seq_num);
230 dfu_transaction_cleanup(dfu);
234 /* DFU 1.1 standard says:
235 * The wBlockNum field is a block sequence number. It increments each
236 * time a block is transferred, wrapping to zero from 65,535. It is used
237 * to provide useful context to the DFU loader in the device."
239 * This means that it's a 16 bit counter that roll-overs at
240 * 0xffff -> 0x0000. By having a typical 4K transfer block
241 * we roll-over at exactly 256MB. Not very fun to debug.
243 * Handling rollover, and having an inited variable,
247 /* handle rollover */
248 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
250 /* flush buffer if overflow */
251 if ((dfu->i_buf + size) > dfu->i_buf_end) {
252 ret = dfu_write_buffer_drain(dfu);
254 dfu_transaction_cleanup(dfu);
259 /* we should be in buffer now (if not then size too large) */
260 if ((dfu->i_buf + size) > dfu->i_buf_end) {
261 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
262 size, dfu->i_buf_end);
263 dfu_transaction_cleanup(dfu);
267 memcpy(dfu->i_buf, buf, size);
270 /* if end or if buffer full flush */
271 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
272 ret = dfu_write_buffer_drain(dfu);
274 dfu_transaction_cleanup(dfu);
282 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
289 /* get chunk that can be read */
290 chunk = min((long)size, dfu->b_left);
293 memcpy(buf, dfu->i_buf, chunk);
295 dfu_hash_algo->hash_update(dfu_hash_algo,
300 dfu->b_left -= chunk;
308 /* no more to read */
309 if (dfu->r_left == 0)
312 dfu->i_buf = dfu->i_buf_start;
313 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
315 /* got to read, but buffer is empty */
316 if (dfu->b_left > dfu->r_left)
317 dfu->b_left = dfu->r_left;
318 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
321 debug("%s: Read error!\n", __func__);
324 dfu->offset += dfu->b_left;
325 dfu->r_left -= dfu->b_left;
334 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
338 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
339 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
342 dfu->i_buf_start = dfu_get_buf(dfu);
343 if (dfu->i_buf_start == NULL)
346 ret = dfu->get_medium_size(dfu, &dfu->r_left);
350 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
352 dfu->i_blk_seq_num = 0;
355 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
356 dfu->i_buf = dfu->i_buf_start;
364 if (dfu->i_blk_seq_num != blk_seq_num) {
365 printf("%s: Wrong sequence number! [%d] [%d]\n",
366 __func__, dfu->i_blk_seq_num, blk_seq_num);
369 /* handle rollover */
370 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
372 ret = dfu_read_buffer_fill(dfu, buf, size);
374 printf("%s: Failed to fill buffer\n", __func__);
380 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
381 dfu_hash_algo->name, dfu->crc);
382 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
384 dfu_transaction_cleanup(dfu);
390 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
391 char *interface, char *devstr)
395 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
396 st = strsep(&s, " ");
397 strcpy(dfu->name, st);
400 dfu->max_buf_size = 0;
401 dfu->free_entity = NULL;
403 /* Specific for mmc device */
404 if (strcmp(interface, "mmc") == 0) {
405 if (dfu_fill_entity_mmc(dfu, devstr, s))
407 } else if (strcmp(interface, "nand") == 0) {
408 if (dfu_fill_entity_nand(dfu, devstr, s))
410 } else if (strcmp(interface, "ram") == 0) {
411 if (dfu_fill_entity_ram(dfu, devstr, s))
413 } else if (strcmp(interface, "sf") == 0) {
414 if (dfu_fill_entity_sf(dfu, devstr, s))
417 printf("%s: Device %s not (yet) supported!\n",
418 __func__, interface);
426 void dfu_free_entities(void)
428 struct dfu_entity *dfu, *p, *t = NULL;
431 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
432 list_del(&dfu->list);
433 if (dfu->free_entity)
434 dfu->free_entity(dfu);
439 INIT_LIST_HEAD(&dfu_list);
444 int dfu_config_entities(char *env, char *interface, char *devstr)
446 struct dfu_entity *dfu;
450 dfu_alt_num = dfu_find_alt_num(env);
451 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
453 dfu_hash_algo = NULL;
454 s = dfu_get_hash_algo();
456 ret = hash_lookup_algo(s, &dfu_hash_algo);
458 error("Hash algorithm %s not supported\n", s);
461 dfu = calloc(sizeof(*dfu), dfu_alt_num);
464 for (i = 0; i < dfu_alt_num; i++) {
466 s = strsep(&env, ";");
467 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
474 list_add_tail(&dfu[i].list, &dfu_list);
481 const char *dfu_get_dev_type(enum dfu_device_type t)
483 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM", "SF" };
487 const char *dfu_get_layout(enum dfu_layout l)
489 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
490 "EXT3", "EXT4", "RAM_ADDR" };
491 return dfu_layout[l];
494 void dfu_show_entities(void)
496 struct dfu_entity *dfu;
498 puts("DFU alt settings list:\n");
500 list_for_each_entry(dfu, &dfu_list, list) {
501 printf("dev: %s alt: %d name: %s layout: %s\n",
502 dfu_get_dev_type(dfu->dev_type), dfu->alt,
503 dfu->name, dfu_get_layout(dfu->layout));
507 int dfu_get_alt_number(void)
512 struct dfu_entity *dfu_get_entity(int alt)
514 struct dfu_entity *dfu;
516 list_for_each_entry(dfu, &dfu_list, list) {
524 int dfu_get_alt(char *name)
526 struct dfu_entity *dfu;
529 list_for_each_entry(dfu, &dfu_list, list) {
530 if (dfu->name[0] != '/') {
531 if (!strncmp(dfu->name, name, strlen(dfu->name)))
535 * One must also consider absolute path
536 * (/boot/bin/uImage) available at dfu->name when
537 * compared "plain" file name (uImage)
539 * It is the case for e.g. thor gadget where lthor SW
540 * sends only the file name, so only the very last part
541 * of path must be checked for equality
544 str = strstr(dfu->name, name);
549 * Check if matching substring is the last element of
552 if (strlen(dfu->name) ==
553 ((str - dfu->name) + strlen(name)))
561 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
563 unsigned long dfu_buf_size, write, left = size;
568 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
569 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
573 dfu_buf_size = dfu_get_buf_size();
574 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
576 for (i = 0; left > 0; i++) {
577 write = min(dfu_buf_size, left);
579 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
581 ret = dfu_write(dfu, dp, write, i);
583 error("DFU write failed\n");
591 ret = dfu_flush(dfu, NULL, 0, i);
593 error("DFU flush failed!");