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_reset_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;
28 return dfu_reset_request;
31 void dfu_trigger_reset()
33 dfu_reset_request = true;
36 static int dfu_find_alt_num(const char *s)
47 int dfu_init_env_entities(char *interface, char *devstr)
53 str_env = getenv("dfu_alt_info");
55 error("\"dfu_alt_info\" env variable not defined!\n");
59 env_bkp = strdup(str_env);
60 ret = dfu_config_entities(env_bkp, interface, devstr);
62 error("DFU entities configuration failed!\n");
70 static unsigned char *dfu_buf;
71 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
73 unsigned char *dfu_free_buf(void)
80 unsigned long dfu_get_buf_size(void)
85 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
92 s = getenv("dfu_bufsiz");
93 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
94 CONFIG_SYS_DFU_DATA_BUF_SIZE;
95 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
96 dfu_buf_size = dfu->max_buf_size;
98 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
100 printf("%s: Could not memalign 0x%lx bytes\n",
101 __func__, dfu_buf_size);
106 static char *dfu_get_hash_algo(void)
110 s = getenv("dfu_hash_algo");
114 if (!strcmp(s, "crc32")) {
115 debug("%s: DFU hash method: %s\n", __func__, s);
119 error("DFU hash method: %s not supported!\n", s);
123 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
129 w_size = dfu->i_buf - dfu->i_buf_start;
134 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
135 dfu->i_buf_start, w_size, 0);
137 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
139 debug("%s: Write error!\n", __func__);
142 dfu->i_buf = dfu->i_buf_start;
145 dfu->offset += w_size;
152 void dfu_write_transaction_cleanup(struct dfu_entity *dfu)
154 /* clear everything */
158 dfu->i_blk_seq_num = 0;
159 dfu->i_buf_start = dfu_buf;
160 dfu->i_buf_end = dfu_buf;
161 dfu->i_buf = dfu->i_buf_start;
165 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
169 ret = dfu_write_buffer_drain(dfu);
173 if (dfu->flush_medium)
174 ret = dfu->flush_medium(dfu);
177 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
180 dfu_write_transaction_cleanup(dfu);
185 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
189 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
190 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
191 dfu->i_buf - dfu->i_buf_start);
198 dfu->i_blk_seq_num = 0;
199 dfu->i_buf_start = dfu_get_buf(dfu);
200 if (dfu->i_buf_start == NULL)
202 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
203 dfu->i_buf = dfu->i_buf_start;
208 if (dfu->i_blk_seq_num != blk_seq_num) {
209 printf("%s: Wrong sequence number! [%d] [%d]\n",
210 __func__, dfu->i_blk_seq_num, blk_seq_num);
211 dfu_write_transaction_cleanup(dfu);
215 /* DFU 1.1 standard says:
216 * The wBlockNum field is a block sequence number. It increments each
217 * time a block is transferred, wrapping to zero from 65,535. It is used
218 * to provide useful context to the DFU loader in the device."
220 * This means that it's a 16 bit counter that roll-overs at
221 * 0xffff -> 0x0000. By having a typical 4K transfer block
222 * we roll-over at exactly 256MB. Not very fun to debug.
224 * Handling rollover, and having an inited variable,
228 /* handle rollover */
229 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
231 /* flush buffer if overflow */
232 if ((dfu->i_buf + size) > dfu->i_buf_end) {
233 ret = dfu_write_buffer_drain(dfu);
235 dfu_write_transaction_cleanup(dfu);
240 /* we should be in buffer now (if not then size too large) */
241 if ((dfu->i_buf + size) > dfu->i_buf_end) {
242 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
243 size, dfu->i_buf_end);
244 dfu_write_transaction_cleanup(dfu);
248 memcpy(dfu->i_buf, buf, size);
251 /* if end or if buffer full flush */
252 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
253 ret = dfu_write_buffer_drain(dfu);
255 dfu_write_transaction_cleanup(dfu);
263 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
270 /* get chunk that can be read */
271 chunk = min(size, dfu->b_left);
274 memcpy(buf, dfu->i_buf, chunk);
276 dfu_hash_algo->hash_update(dfu_hash_algo,
281 dfu->b_left -= chunk;
289 /* no more to read */
290 if (dfu->r_left == 0)
293 dfu->i_buf = dfu->i_buf_start;
294 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
296 /* got to read, but buffer is empty */
297 if (dfu->b_left > dfu->r_left)
298 dfu->b_left = dfu->r_left;
299 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
302 debug("%s: Read error!\n", __func__);
305 dfu->offset += dfu->b_left;
306 dfu->r_left -= dfu->b_left;
315 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
319 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
320 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
323 dfu->i_buf_start = dfu_get_buf(dfu);
324 if (dfu->i_buf_start == NULL)
327 dfu->r_left = dfu->get_medium_size(dfu);
330 switch (dfu->layout) {
335 if (dfu->r_left >= dfu_buf_size) {
336 printf("%s: File too big for buffer\n",
342 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
344 dfu->i_blk_seq_num = 0;
347 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
348 dfu->i_buf = dfu->i_buf_start;
356 if (dfu->i_blk_seq_num != blk_seq_num) {
357 printf("%s: Wrong sequence number! [%d] [%d]\n",
358 __func__, dfu->i_blk_seq_num, blk_seq_num);
361 /* handle rollover */
362 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
364 ret = dfu_read_buffer_fill(dfu, buf, size);
366 printf("%s: Failed to fill buffer\n", __func__);
372 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
373 dfu_hash_algo->name, dfu->crc);
374 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
377 dfu->i_blk_seq_num = 0;
380 dfu->i_buf_start = dfu_buf;
381 dfu->i_buf_end = dfu_buf;
382 dfu->i_buf = dfu->i_buf_start;
393 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
394 char *interface, char *devstr)
398 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
399 st = strsep(&s, " ");
400 strcpy(dfu->name, st);
403 dfu->max_buf_size = 0;
405 /* Specific for mmc device */
406 if (strcmp(interface, "mmc") == 0) {
407 if (dfu_fill_entity_mmc(dfu, devstr, s))
409 } else if (strcmp(interface, "nand") == 0) {
410 if (dfu_fill_entity_nand(dfu, devstr, s))
412 } else if (strcmp(interface, "ram") == 0) {
413 if (dfu_fill_entity_ram(dfu, devstr, s))
416 printf("%s: Device %s not (yet) supported!\n",
417 __func__, interface);
424 void dfu_free_entities(void)
426 struct dfu_entity *dfu, *p, *t = NULL;
428 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
429 list_del(&dfu->list);
434 INIT_LIST_HEAD(&dfu_list);
439 int dfu_config_entities(char *env, char *interface, char *devstr)
441 struct dfu_entity *dfu;
445 dfu_alt_num = dfu_find_alt_num(env);
446 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
448 dfu_hash_algo = NULL;
449 s = dfu_get_hash_algo();
451 ret = hash_lookup_algo(s, &dfu_hash_algo);
453 error("Hash algorithm %s not supported\n", s);
456 dfu = calloc(sizeof(*dfu), dfu_alt_num);
459 for (i = 0; i < dfu_alt_num; i++) {
461 s = strsep(&env, ";");
462 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
467 list_add_tail(&dfu[i].list, &dfu_list);
474 const char *dfu_get_dev_type(enum dfu_device_type t)
476 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
480 const char *dfu_get_layout(enum dfu_layout l)
482 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
483 "EXT3", "EXT4", "RAM_ADDR" };
484 return dfu_layout[l];
487 void dfu_show_entities(void)
489 struct dfu_entity *dfu;
491 puts("DFU alt settings list:\n");
493 list_for_each_entry(dfu, &dfu_list, list) {
494 printf("dev: %s alt: %d name: %s layout: %s\n",
495 dfu_get_dev_type(dfu->dev_type), dfu->alt,
496 dfu->name, dfu_get_layout(dfu->layout));
500 int dfu_get_alt_number(void)
505 struct dfu_entity *dfu_get_entity(int alt)
507 struct dfu_entity *dfu;
509 list_for_each_entry(dfu, &dfu_list, list) {
517 int dfu_get_alt(char *name)
519 struct dfu_entity *dfu;
521 list_for_each_entry(dfu, &dfu_list, list) {
522 if (!strncmp(dfu->name, name, strlen(dfu->name)))