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 bool dfu_detach_request
;
21 static LIST_HEAD(dfu_list
);
22 static int dfu_alt_num
;
23 static int alt_num_cnt
;
24 static struct hash_algo
*dfu_hash_algo
;
27 * The purpose of the dfu_usb_get_reset() function is to
28 * provide information if after USB_DETACH request
29 * being sent the dfu-util performed reset of USB
32 * Described behaviour is the only way to distinct if
33 * user has typed -e (detach) or -R (reset) when invoking
37 __weak
bool dfu_usb_get_reset(void)
44 return dfu_detach_request
;
47 void dfu_trigger_detach(void)
49 dfu_detach_request
= true;
52 void dfu_clear_detach(void)
54 dfu_detach_request
= false;
57 static int dfu_find_alt_num(const char *s
)
68 int dfu_init_env_entities(char *interface
, char *devstr
)
74 str_env
= getenv("dfu_alt_info");
76 error("\"dfu_alt_info\" env variable not defined!\n");
80 env_bkp
= strdup(str_env
);
81 ret
= dfu_config_entities(env_bkp
, interface
, devstr
);
83 error("DFU entities configuration failed!\n");
91 static unsigned char *dfu_buf
;
92 static unsigned long dfu_buf_size
= CONFIG_SYS_DFU_DATA_BUF_SIZE
;
94 unsigned char *dfu_free_buf(void)
101 unsigned long dfu_get_buf_size(void)
106 unsigned char *dfu_get_buf(struct dfu_entity
*dfu
)
113 s
= getenv("dfu_bufsiz");
114 dfu_buf_size
= s
? (unsigned long)simple_strtol(s
, NULL
, 16) :
115 CONFIG_SYS_DFU_DATA_BUF_SIZE
;
116 if (dfu
->max_buf_size
&& dfu_buf_size
> dfu
->max_buf_size
)
117 dfu_buf_size
= dfu
->max_buf_size
;
119 dfu_buf
= memalign(CONFIG_SYS_CACHELINE_SIZE
, dfu_buf_size
);
121 printf("%s: Could not memalign 0x%lx bytes\n",
122 __func__
, dfu_buf_size
);
127 static char *dfu_get_hash_algo(void)
131 s
= getenv("dfu_hash_algo");
135 if (!strcmp(s
, "crc32")) {
136 debug("%s: DFU hash method: %s\n", __func__
, s
);
140 error("DFU hash method: %s not supported!\n", s
);
144 static int dfu_write_buffer_drain(struct dfu_entity
*dfu
)
150 w_size
= dfu
->i_buf
- dfu
->i_buf_start
;
155 dfu_hash_algo
->hash_update(dfu_hash_algo
, &dfu
->crc
,
156 dfu
->i_buf_start
, w_size
, 0);
158 ret
= dfu
->write_medium(dfu
, dfu
->offset
, dfu
->i_buf_start
, &w_size
);
160 debug("%s: Write error!\n", __func__
);
163 dfu
->i_buf
= dfu
->i_buf_start
;
166 dfu
->offset
+= w_size
;
173 void dfu_write_transaction_cleanup(struct dfu_entity
*dfu
)
175 /* clear everything */
179 dfu
->i_blk_seq_num
= 0;
180 dfu
->i_buf_start
= dfu_buf
;
181 dfu
->i_buf_end
= dfu_buf
;
182 dfu
->i_buf
= dfu
->i_buf_start
;
186 int dfu_flush(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
190 ret
= dfu_write_buffer_drain(dfu
);
194 if (dfu
->flush_medium
)
195 ret
= dfu
->flush_medium(dfu
);
198 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo
->name
,
201 dfu_write_transaction_cleanup(dfu
);
206 int dfu_write(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
210 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
211 __func__
, dfu
->name
, buf
, size
, blk_seq_num
, dfu
->offset
,
212 dfu
->i_buf
- dfu
->i_buf_start
);
219 dfu
->i_blk_seq_num
= 0;
220 dfu
->i_buf_start
= dfu_get_buf(dfu
);
221 if (dfu
->i_buf_start
== NULL
)
223 dfu
->i_buf_end
= dfu_get_buf(dfu
) + dfu_buf_size
;
224 dfu
->i_buf
= dfu
->i_buf_start
;
229 if (dfu
->i_blk_seq_num
!= blk_seq_num
) {
230 printf("%s: Wrong sequence number! [%d] [%d]\n",
231 __func__
, dfu
->i_blk_seq_num
, blk_seq_num
);
232 dfu_write_transaction_cleanup(dfu
);
236 /* DFU 1.1 standard says:
237 * The wBlockNum field is a block sequence number. It increments each
238 * time a block is transferred, wrapping to zero from 65,535. It is used
239 * to provide useful context to the DFU loader in the device."
241 * This means that it's a 16 bit counter that roll-overs at
242 * 0xffff -> 0x0000. By having a typical 4K transfer block
243 * we roll-over at exactly 256MB. Not very fun to debug.
245 * Handling rollover, and having an inited variable,
249 /* handle rollover */
250 dfu
->i_blk_seq_num
= (dfu
->i_blk_seq_num
+ 1) & 0xffff;
252 /* flush buffer if overflow */
253 if ((dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
254 ret
= dfu_write_buffer_drain(dfu
);
256 dfu_write_transaction_cleanup(dfu
);
261 /* we should be in buffer now (if not then size too large) */
262 if ((dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
263 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu
->i_buf
,
264 size
, dfu
->i_buf_end
);
265 dfu_write_transaction_cleanup(dfu
);
269 memcpy(dfu
->i_buf
, buf
, size
);
272 /* if end or if buffer full flush */
273 if (size
== 0 || (dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
274 ret
= dfu_write_buffer_drain(dfu
);
276 dfu_write_transaction_cleanup(dfu
);
284 static int dfu_read_buffer_fill(struct dfu_entity
*dfu
, void *buf
, int size
)
291 /* get chunk that can be read */
292 chunk
= min(size
, dfu
->b_left
);
295 memcpy(buf
, dfu
->i_buf
, chunk
);
297 dfu_hash_algo
->hash_update(dfu_hash_algo
,
302 dfu
->b_left
-= chunk
;
310 /* no more to read */
311 if (dfu
->r_left
== 0)
314 dfu
->i_buf
= dfu
->i_buf_start
;
315 dfu
->b_left
= dfu
->i_buf_end
- dfu
->i_buf_start
;
317 /* got to read, but buffer is empty */
318 if (dfu
->b_left
> dfu
->r_left
)
319 dfu
->b_left
= dfu
->r_left
;
320 ret
= dfu
->read_medium(dfu
, dfu
->offset
, dfu
->i_buf
,
323 debug("%s: Read error!\n", __func__
);
326 dfu
->offset
+= dfu
->b_left
;
327 dfu
->r_left
-= dfu
->b_left
;
336 int dfu_read(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
340 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
341 __func__
, dfu
->name
, buf
, size
, blk_seq_num
, dfu
->i_buf
);
344 dfu
->i_buf_start
= dfu_get_buf(dfu
);
345 if (dfu
->i_buf_start
== NULL
)
348 dfu
->r_left
= dfu
->get_medium_size(dfu
);
351 switch (dfu
->layout
) {
356 if (dfu
->r_left
> dfu_buf_size
) {
357 printf("%s: File too big for buffer\n",
363 debug("%s: %s %ld [B]\n", __func__
, dfu
->name
, dfu
->r_left
);
365 dfu
->i_blk_seq_num
= 0;
368 dfu
->i_buf_end
= dfu_get_buf(dfu
) + dfu_buf_size
;
369 dfu
->i_buf
= dfu
->i_buf_start
;
377 if (dfu
->i_blk_seq_num
!= blk_seq_num
) {
378 printf("%s: Wrong sequence number! [%d] [%d]\n",
379 __func__
, dfu
->i_blk_seq_num
, blk_seq_num
);
382 /* handle rollover */
383 dfu
->i_blk_seq_num
= (dfu
->i_blk_seq_num
+ 1) & 0xffff;
385 ret
= dfu_read_buffer_fill(dfu
, buf
, size
);
387 printf("%s: Failed to fill buffer\n", __func__
);
393 debug("%s: %s %s: 0x%x\n", __func__
, dfu
->name
,
394 dfu_hash_algo
->name
, dfu
->crc
);
395 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
398 dfu
->i_blk_seq_num
= 0;
401 dfu
->i_buf_start
= dfu_buf
;
402 dfu
->i_buf_end
= dfu_buf
;
403 dfu
->i_buf
= dfu
->i_buf_start
;
414 static int dfu_fill_entity(struct dfu_entity
*dfu
, char *s
, int alt
,
415 char *interface
, char *devstr
)
419 debug("%s: %s interface: %s dev: %s\n", __func__
, s
, interface
, devstr
);
420 st
= strsep(&s
, " ");
421 strcpy(dfu
->name
, st
);
424 dfu
->max_buf_size
= 0;
425 dfu
->free_entity
= NULL
;
427 /* Specific for mmc device */
428 if (strcmp(interface
, "mmc") == 0) {
429 if (dfu_fill_entity_mmc(dfu
, devstr
, s
))
431 } else if (strcmp(interface
, "nand") == 0) {
432 if (dfu_fill_entity_nand(dfu
, devstr
, s
))
434 } else if (strcmp(interface
, "ram") == 0) {
435 if (dfu_fill_entity_ram(dfu
, devstr
, s
))
437 } else if (strcmp(interface
, "sf") == 0) {
438 if (dfu_fill_entity_sf(dfu
, devstr
, s
))
441 printf("%s: Device %s not (yet) supported!\n",
442 __func__
, interface
);
449 void dfu_free_entities(void)
451 struct dfu_entity
*dfu
, *p
, *t
= NULL
;
453 list_for_each_entry_safe_reverse(dfu
, p
, &dfu_list
, list
) {
454 list_del(&dfu
->list
);
455 if (dfu
->free_entity
)
456 dfu
->free_entity(dfu
);
461 INIT_LIST_HEAD(&dfu_list
);
466 int dfu_config_entities(char *env
, char *interface
, char *devstr
)
468 struct dfu_entity
*dfu
;
472 dfu_alt_num
= dfu_find_alt_num(env
);
473 debug("%s: dfu_alt_num=%d\n", __func__
, dfu_alt_num
);
475 dfu_hash_algo
= NULL
;
476 s
= dfu_get_hash_algo();
478 ret
= hash_lookup_algo(s
, &dfu_hash_algo
);
480 error("Hash algorithm %s not supported\n", s
);
483 dfu
= calloc(sizeof(*dfu
), dfu_alt_num
);
486 for (i
= 0; i
< dfu_alt_num
; i
++) {
488 s
= strsep(&env
, ";");
489 ret
= dfu_fill_entity(&dfu
[i
], s
, alt_num_cnt
, interface
,
494 list_add_tail(&dfu
[i
].list
, &dfu_list
);
501 const char *dfu_get_dev_type(enum dfu_device_type t
)
503 const char *dev_t
[] = {NULL
, "eMMC", "OneNAND", "NAND", "RAM" };
507 const char *dfu_get_layout(enum dfu_layout l
)
509 const char *dfu_layout
[] = {NULL
, "RAW_ADDR", "FAT", "EXT2",
510 "EXT3", "EXT4", "RAM_ADDR" };
511 return dfu_layout
[l
];
514 void dfu_show_entities(void)
516 struct dfu_entity
*dfu
;
518 puts("DFU alt settings list:\n");
520 list_for_each_entry(dfu
, &dfu_list
, list
) {
521 printf("dev: %s alt: %d name: %s layout: %s\n",
522 dfu_get_dev_type(dfu
->dev_type
), dfu
->alt
,
523 dfu
->name
, dfu_get_layout(dfu
->layout
));
527 int dfu_get_alt_number(void)
532 struct dfu_entity
*dfu_get_entity(int alt
)
534 struct dfu_entity
*dfu
;
536 list_for_each_entry(dfu
, &dfu_list
, list
) {
544 int dfu_get_alt(char *name
)
546 struct dfu_entity
*dfu
;
548 list_for_each_entry(dfu
, &dfu_list
, list
) {
549 if (!strncmp(dfu
->name
, name
, strlen(dfu
->name
)))