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");
99 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
101 if (!s || !dfu_buf_size)
102 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
104 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
105 dfu_buf_size = dfu->max_buf_size;
107 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
109 printf("%s: Could not memalign 0x%lx bytes\n",
110 __func__, dfu_buf_size);
115 static char *dfu_get_hash_algo(void)
119 s = getenv("dfu_hash_algo");
123 if (!strcmp(s, "crc32")) {
124 debug("%s: DFU hash method: %s\n", __func__, s);
128 error("DFU hash method: %s not supported!\n", s);
132 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
138 w_size = dfu->i_buf - dfu->i_buf_start;
143 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
144 dfu->i_buf_start, w_size, 0);
146 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
148 debug("%s: Write error!\n", __func__);
151 dfu->i_buf = dfu->i_buf_start;
154 dfu->offset += w_size;
161 void dfu_write_transaction_cleanup(struct dfu_entity *dfu)
163 /* clear everything */
167 dfu->i_blk_seq_num = 0;
168 dfu->i_buf_start = dfu_buf;
169 dfu->i_buf_end = dfu_buf;
170 dfu->i_buf = dfu->i_buf_start;
174 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
178 ret = dfu_write_buffer_drain(dfu);
182 if (dfu->flush_medium)
183 ret = dfu->flush_medium(dfu);
186 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
189 dfu_write_transaction_cleanup(dfu);
194 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
198 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
199 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
200 dfu->i_buf - dfu->i_buf_start);
207 dfu->i_blk_seq_num = 0;
208 dfu->i_buf_start = dfu_get_buf(dfu);
209 if (dfu->i_buf_start == NULL)
211 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
212 dfu->i_buf = dfu->i_buf_start;
217 if (dfu->i_blk_seq_num != blk_seq_num) {
218 printf("%s: Wrong sequence number! [%d] [%d]\n",
219 __func__, dfu->i_blk_seq_num, blk_seq_num);
220 dfu_write_transaction_cleanup(dfu);
224 /* DFU 1.1 standard says:
225 * The wBlockNum field is a block sequence number. It increments each
226 * time a block is transferred, wrapping to zero from 65,535. It is used
227 * to provide useful context to the DFU loader in the device."
229 * This means that it's a 16 bit counter that roll-overs at
230 * 0xffff -> 0x0000. By having a typical 4K transfer block
231 * we roll-over at exactly 256MB. Not very fun to debug.
233 * Handling rollover, and having an inited variable,
237 /* handle rollover */
238 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
240 /* flush buffer if overflow */
241 if ((dfu->i_buf + size) > dfu->i_buf_end) {
242 ret = dfu_write_buffer_drain(dfu);
244 dfu_write_transaction_cleanup(dfu);
249 /* we should be in buffer now (if not then size too large) */
250 if ((dfu->i_buf + size) > dfu->i_buf_end) {
251 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
252 size, dfu->i_buf_end);
253 dfu_write_transaction_cleanup(dfu);
257 memcpy(dfu->i_buf, buf, size);
260 /* if end or if buffer full flush */
261 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
262 ret = dfu_write_buffer_drain(dfu);
264 dfu_write_transaction_cleanup(dfu);
272 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
279 /* get chunk that can be read */
280 chunk = min((long)size, dfu->b_left);
283 memcpy(buf, dfu->i_buf, chunk);
285 dfu_hash_algo->hash_update(dfu_hash_algo,
290 dfu->b_left -= chunk;
298 /* no more to read */
299 if (dfu->r_left == 0)
302 dfu->i_buf = dfu->i_buf_start;
303 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
305 /* got to read, but buffer is empty */
306 if (dfu->b_left > dfu->r_left)
307 dfu->b_left = dfu->r_left;
308 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
311 debug("%s: Read error!\n", __func__);
314 dfu->offset += dfu->b_left;
315 dfu->r_left -= dfu->b_left;
324 int dfu_read(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 i_buf: 0x%p\n",
329 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
332 dfu->i_buf_start = dfu_get_buf(dfu);
333 if (dfu->i_buf_start == NULL)
336 dfu->r_left = dfu->get_medium_size(dfu);
339 switch (dfu->layout) {
344 if (dfu->r_left > dfu_buf_size) {
345 printf("%s: File too big for buffer\n",
351 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
353 dfu->i_blk_seq_num = 0;
356 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
357 dfu->i_buf = dfu->i_buf_start;
365 if (dfu->i_blk_seq_num != blk_seq_num) {
366 printf("%s: Wrong sequence number! [%d] [%d]\n",
367 __func__, dfu->i_blk_seq_num, blk_seq_num);
370 /* handle rollover */
371 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
373 ret = dfu_read_buffer_fill(dfu, buf, size);
375 printf("%s: Failed to fill buffer\n", __func__);
381 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
382 dfu_hash_algo->name, dfu->crc);
383 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
386 dfu->i_blk_seq_num = 0;
389 dfu->i_buf_start = dfu_buf;
390 dfu->i_buf_end = dfu_buf;
391 dfu->i_buf = dfu->i_buf_start;
402 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
403 char *interface, char *devstr)
407 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
408 st = strsep(&s, " ");
409 strcpy(dfu->name, st);
412 dfu->max_buf_size = 0;
413 dfu->free_entity = NULL;
415 /* Specific for mmc device */
416 if (strcmp(interface, "mmc") == 0) {
417 if (dfu_fill_entity_mmc(dfu, devstr, s))
419 } else if (strcmp(interface, "nand") == 0) {
420 if (dfu_fill_entity_nand(dfu, devstr, s))
422 } else if (strcmp(interface, "ram") == 0) {
423 if (dfu_fill_entity_ram(dfu, devstr, s))
425 } else if (strcmp(interface, "sf") == 0) {
426 if (dfu_fill_entity_sf(dfu, devstr, s))
429 printf("%s: Device %s not (yet) supported!\n",
430 __func__, interface);
437 void dfu_free_entities(void)
439 struct dfu_entity *dfu, *p, *t = NULL;
441 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
442 list_del(&dfu->list);
443 if (dfu->free_entity)
444 dfu->free_entity(dfu);
449 INIT_LIST_HEAD(&dfu_list);
454 int dfu_config_entities(char *env, char *interface, char *devstr)
456 struct dfu_entity *dfu;
460 dfu_alt_num = dfu_find_alt_num(env);
461 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
463 dfu_hash_algo = NULL;
464 s = dfu_get_hash_algo();
466 ret = hash_lookup_algo(s, &dfu_hash_algo);
468 error("Hash algorithm %s not supported\n", s);
471 dfu = calloc(sizeof(*dfu), dfu_alt_num);
474 for (i = 0; i < dfu_alt_num; i++) {
476 s = strsep(&env, ";");
477 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
482 list_add_tail(&dfu[i].list, &dfu_list);
489 const char *dfu_get_dev_type(enum dfu_device_type t)
491 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
495 const char *dfu_get_layout(enum dfu_layout l)
497 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
498 "EXT3", "EXT4", "RAM_ADDR" };
499 return dfu_layout[l];
502 void dfu_show_entities(void)
504 struct dfu_entity *dfu;
506 puts("DFU alt settings list:\n");
508 list_for_each_entry(dfu, &dfu_list, list) {
509 printf("dev: %s alt: %d name: %s layout: %s\n",
510 dfu_get_dev_type(dfu->dev_type), dfu->alt,
511 dfu->name, dfu_get_layout(dfu->layout));
515 int dfu_get_alt_number(void)
520 struct dfu_entity *dfu_get_entity(int alt)
522 struct dfu_entity *dfu;
524 list_for_each_entry(dfu, &dfu_list, list) {
532 int dfu_get_alt(char *name)
534 struct dfu_entity *dfu;
537 list_for_each_entry(dfu, &dfu_list, list) {
538 if (dfu->name[0] != '/') {
539 if (!strncmp(dfu->name, name, strlen(dfu->name)))
543 * One must also consider absolute path
544 * (/boot/bin/uImage) available at dfu->name when
545 * compared "plain" file name (uImage)
547 * It is the case for e.g. thor gadget where lthor SW
548 * sends only the file name, so only the very last part
549 * of path must be checked for equality
552 str = strstr(dfu->name, name);
557 * Check if matching substring is the last element of
560 if (strlen(dfu->name) ==
561 ((str - dfu->name) + strlen(name)))