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)
41 static int dfu_find_alt_num(const char *s)
52 int dfu_init_env_entities(char *interface, char *devstr)
58 str_env = getenv("dfu_alt_info");
60 error("\"dfu_alt_info\" env variable not defined!\n");
64 env_bkp = strdup(str_env);
65 ret = dfu_config_entities(env_bkp, interface, devstr);
67 error("DFU entities configuration failed!\n");
75 static unsigned char *dfu_buf;
76 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
78 unsigned char *dfu_free_buf(void)
85 unsigned long dfu_get_buf_size(void)
90 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
97 s = getenv("dfu_bufsiz");
98 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
99 CONFIG_SYS_DFU_DATA_BUF_SIZE;
100 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
101 dfu_buf_size = dfu->max_buf_size;
103 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
105 printf("%s: Could not memalign 0x%lx bytes\n",
106 __func__, dfu_buf_size);
111 static char *dfu_get_hash_algo(void)
115 s = getenv("dfu_hash_algo");
119 if (!strcmp(s, "crc32")) {
120 debug("%s: DFU hash method: %s\n", __func__, s);
124 error("DFU hash method: %s not supported!\n", s);
128 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
134 w_size = dfu->i_buf - dfu->i_buf_start;
139 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
140 dfu->i_buf_start, w_size, 0);
142 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
144 debug("%s: Write error!\n", __func__);
147 dfu->i_buf = dfu->i_buf_start;
150 dfu->offset += w_size;
157 void dfu_write_transaction_cleanup(struct dfu_entity *dfu)
159 /* clear everything */
163 dfu->i_blk_seq_num = 0;
164 dfu->i_buf_start = dfu_buf;
165 dfu->i_buf_end = dfu_buf;
166 dfu->i_buf = dfu->i_buf_start;
170 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
174 ret = dfu_write_buffer_drain(dfu);
178 if (dfu->flush_medium)
179 ret = dfu->flush_medium(dfu);
182 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
185 dfu_write_transaction_cleanup(dfu);
190 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
194 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
195 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
196 dfu->i_buf - dfu->i_buf_start);
203 dfu->i_blk_seq_num = 0;
204 dfu->i_buf_start = dfu_get_buf(dfu);
205 if (dfu->i_buf_start == NULL)
207 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
208 dfu->i_buf = dfu->i_buf_start;
213 if (dfu->i_blk_seq_num != blk_seq_num) {
214 printf("%s: Wrong sequence number! [%d] [%d]\n",
215 __func__, dfu->i_blk_seq_num, blk_seq_num);
216 dfu_write_transaction_cleanup(dfu);
220 /* DFU 1.1 standard says:
221 * The wBlockNum field is a block sequence number. It increments each
222 * time a block is transferred, wrapping to zero from 65,535. It is used
223 * to provide useful context to the DFU loader in the device."
225 * This means that it's a 16 bit counter that roll-overs at
226 * 0xffff -> 0x0000. By having a typical 4K transfer block
227 * we roll-over at exactly 256MB. Not very fun to debug.
229 * Handling rollover, and having an inited variable,
233 /* handle rollover */
234 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
236 /* flush buffer if overflow */
237 if ((dfu->i_buf + size) > dfu->i_buf_end) {
238 ret = dfu_write_buffer_drain(dfu);
240 dfu_write_transaction_cleanup(dfu);
245 /* we should be in buffer now (if not then size too large) */
246 if ((dfu->i_buf + size) > dfu->i_buf_end) {
247 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
248 size, dfu->i_buf_end);
249 dfu_write_transaction_cleanup(dfu);
253 memcpy(dfu->i_buf, buf, size);
256 /* if end or if buffer full flush */
257 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
258 ret = dfu_write_buffer_drain(dfu);
260 dfu_write_transaction_cleanup(dfu);
268 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
275 /* get chunk that can be read */
276 chunk = min((long)size, dfu->b_left);
279 memcpy(buf, dfu->i_buf, chunk);
281 dfu_hash_algo->hash_update(dfu_hash_algo,
286 dfu->b_left -= chunk;
294 /* no more to read */
295 if (dfu->r_left == 0)
298 dfu->i_buf = dfu->i_buf_start;
299 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
301 /* got to read, but buffer is empty */
302 if (dfu->b_left > dfu->r_left)
303 dfu->b_left = dfu->r_left;
304 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
307 debug("%s: Read error!\n", __func__);
310 dfu->offset += dfu->b_left;
311 dfu->r_left -= dfu->b_left;
320 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
324 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
325 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
328 dfu->i_buf_start = dfu_get_buf(dfu);
329 if (dfu->i_buf_start == NULL)
332 dfu->r_left = dfu->get_medium_size(dfu);
335 switch (dfu->layout) {
340 if (dfu->r_left > dfu_buf_size) {
341 printf("%s: File too big for buffer\n",
347 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
349 dfu->i_blk_seq_num = 0;
352 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
353 dfu->i_buf = dfu->i_buf_start;
361 if (dfu->i_blk_seq_num != blk_seq_num) {
362 printf("%s: Wrong sequence number! [%d] [%d]\n",
363 __func__, dfu->i_blk_seq_num, blk_seq_num);
366 /* handle rollover */
367 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
369 ret = dfu_read_buffer_fill(dfu, buf, size);
371 printf("%s: Failed to fill buffer\n", __func__);
377 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
378 dfu_hash_algo->name, dfu->crc);
379 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
382 dfu->i_blk_seq_num = 0;
385 dfu->i_buf_start = dfu_buf;
386 dfu->i_buf_end = dfu_buf;
387 dfu->i_buf = dfu->i_buf_start;
398 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
399 char *interface, char *devstr)
403 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
404 st = strsep(&s, " ");
405 strcpy(dfu->name, st);
408 dfu->max_buf_size = 0;
409 dfu->free_entity = NULL;
411 /* Specific for mmc device */
412 if (strcmp(interface, "mmc") == 0) {
413 if (dfu_fill_entity_mmc(dfu, devstr, s))
415 } else if (strcmp(interface, "nand") == 0) {
416 if (dfu_fill_entity_nand(dfu, devstr, s))
418 } else if (strcmp(interface, "ram") == 0) {
419 if (dfu_fill_entity_ram(dfu, devstr, s))
421 } else if (strcmp(interface, "sf") == 0) {
422 if (dfu_fill_entity_sf(dfu, devstr, s))
425 printf("%s: Device %s not (yet) supported!\n",
426 __func__, interface);
433 void dfu_free_entities(void)
435 struct dfu_entity *dfu, *p, *t = NULL;
437 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
438 list_del(&dfu->list);
439 if (dfu->free_entity)
440 dfu->free_entity(dfu);
445 INIT_LIST_HEAD(&dfu_list);
450 int dfu_config_entities(char *env, char *interface, char *devstr)
452 struct dfu_entity *dfu;
456 dfu_alt_num = dfu_find_alt_num(env);
457 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
459 dfu_hash_algo = NULL;
460 s = dfu_get_hash_algo();
462 ret = hash_lookup_algo(s, &dfu_hash_algo);
464 error("Hash algorithm %s not supported\n", s);
467 dfu = calloc(sizeof(*dfu), dfu_alt_num);
470 for (i = 0; i < dfu_alt_num; i++) {
472 s = strsep(&env, ";");
473 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
478 list_add_tail(&dfu[i].list, &dfu_list);
485 const char *dfu_get_dev_type(enum dfu_device_type t)
487 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
491 const char *dfu_get_layout(enum dfu_layout l)
493 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
494 "EXT3", "EXT4", "RAM_ADDR" };
495 return dfu_layout[l];
498 void dfu_show_entities(void)
500 struct dfu_entity *dfu;
502 puts("DFU alt settings list:\n");
504 list_for_each_entry(dfu, &dfu_list, list) {
505 printf("dev: %s alt: %d name: %s layout: %s\n",
506 dfu_get_dev_type(dfu->dev_type), dfu->alt,
507 dfu->name, dfu_get_layout(dfu->layout));
511 int dfu_get_alt_number(void)
516 struct dfu_entity *dfu_get_entity(int alt)
518 struct dfu_entity *dfu;
520 list_for_each_entry(dfu, &dfu_list, list) {
528 int dfu_get_alt(char *name)
530 struct dfu_entity *dfu;
533 list_for_each_entry(dfu, &dfu_list, list) {
534 if (dfu->name[0] != '/') {
535 if (!strncmp(dfu->name, name, strlen(dfu->name)))
539 * One must also consider absolute path
540 * (/boot/bin/uImage) available at dfu->name when
541 * compared "plain" file name (uImage)
543 * It is the case for e.g. thor gadget where lthor SW
544 * sends only the file name, so only the very last part
545 * of path must be checked for equality
548 str = strstr(dfu->name, name);
553 * Check if matching substring is the last element of
556 if (strlen(dfu->name) ==
557 ((str - dfu->name) + strlen(name)))