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(void)
92 s = getenv("dfu_bufsiz");
93 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
94 CONFIG_SYS_DFU_DATA_BUF_SIZE;
96 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
98 printf("%s: Could not memalign 0x%lx bytes\n",
99 __func__, dfu_buf_size);
104 static char *dfu_get_hash_algo(void)
108 s = getenv("dfu_hash_algo");
112 if (!strcmp(s, "crc32")) {
113 debug("%s: DFU hash method: %s\n", __func__, s);
117 error("DFU hash method: %s not supported!\n", s);
121 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
127 w_size = dfu->i_buf - dfu->i_buf_start;
132 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
133 dfu->i_buf_start, w_size, 0);
135 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
137 debug("%s: Write error!\n", __func__);
140 dfu->i_buf = dfu->i_buf_start;
143 dfu->offset += w_size;
150 void dfu_write_transaction_cleanup(struct dfu_entity *dfu)
152 /* clear everything */
156 dfu->i_blk_seq_num = 0;
157 dfu->i_buf_start = dfu_buf;
158 dfu->i_buf_end = dfu_buf;
159 dfu->i_buf = dfu->i_buf_start;
163 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
167 ret = dfu_write_buffer_drain(dfu);
171 if (dfu->flush_medium)
172 ret = dfu->flush_medium(dfu);
175 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
178 dfu_write_transaction_cleanup(dfu);
183 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
187 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
188 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
189 dfu->i_buf - dfu->i_buf_start);
196 dfu->i_blk_seq_num = 0;
197 dfu->i_buf_start = dfu_get_buf();
198 if (dfu->i_buf_start == NULL)
200 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
201 dfu->i_buf = dfu->i_buf_start;
206 if (dfu->i_blk_seq_num != blk_seq_num) {
207 printf("%s: Wrong sequence number! [%d] [%d]\n",
208 __func__, dfu->i_blk_seq_num, blk_seq_num);
209 dfu_write_transaction_cleanup(dfu);
213 /* DFU 1.1 standard says:
214 * The wBlockNum field is a block sequence number. It increments each
215 * time a block is transferred, wrapping to zero from 65,535. It is used
216 * to provide useful context to the DFU loader in the device."
218 * This means that it's a 16 bit counter that roll-overs at
219 * 0xffff -> 0x0000. By having a typical 4K transfer block
220 * we roll-over at exactly 256MB. Not very fun to debug.
222 * Handling rollover, and having an inited variable,
226 /* handle rollover */
227 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
229 /* flush buffer if overflow */
230 if ((dfu->i_buf + size) > dfu->i_buf_end) {
231 ret = dfu_write_buffer_drain(dfu);
233 dfu_write_transaction_cleanup(dfu);
238 /* we should be in buffer now (if not then size too large) */
239 if ((dfu->i_buf + size) > dfu->i_buf_end) {
240 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
241 size, dfu->i_buf_end);
242 dfu_write_transaction_cleanup(dfu);
246 memcpy(dfu->i_buf, buf, size);
249 /* if end or if buffer full flush */
250 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
251 ret = dfu_write_buffer_drain(dfu);
253 dfu_write_transaction_cleanup(dfu);
261 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
268 /* get chunk that can be read */
269 chunk = min(size, dfu->b_left);
272 memcpy(buf, dfu->i_buf, chunk);
274 dfu_hash_algo->hash_update(dfu_hash_algo,
279 dfu->b_left -= chunk;
287 /* no more to read */
288 if (dfu->r_left == 0)
291 dfu->i_buf = dfu->i_buf_start;
292 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
294 /* got to read, but buffer is empty */
295 if (dfu->b_left > dfu->r_left)
296 dfu->b_left = dfu->r_left;
297 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
300 debug("%s: Read error!\n", __func__);
303 dfu->offset += dfu->b_left;
304 dfu->r_left -= dfu->b_left;
313 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
317 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
318 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
321 dfu->i_buf_start = dfu_get_buf();
322 if (dfu->i_buf_start == NULL)
325 dfu->r_left = dfu->get_medium_size(dfu);
328 switch (dfu->layout) {
333 if (dfu->r_left >= dfu_buf_size) {
334 printf("%s: File too big for buffer\n",
340 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
342 dfu->i_blk_seq_num = 0;
345 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
346 dfu->i_buf = dfu->i_buf_start;
354 if (dfu->i_blk_seq_num != blk_seq_num) {
355 printf("%s: Wrong sequence number! [%d] [%d]\n",
356 __func__, dfu->i_blk_seq_num, blk_seq_num);
359 /* handle rollover */
360 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
362 ret = dfu_read_buffer_fill(dfu, buf, size);
364 printf("%s: Failed to fill buffer\n", __func__);
370 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
371 dfu_hash_algo->name, dfu->crc);
372 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
375 dfu->i_blk_seq_num = 0;
378 dfu->i_buf_start = dfu_buf;
379 dfu->i_buf_end = dfu_buf;
380 dfu->i_buf = dfu->i_buf_start;
391 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
392 char *interface, char *devstr)
396 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
397 st = strsep(&s, " ");
398 strcpy(dfu->name, st);
402 /* Specific for mmc device */
403 if (strcmp(interface, "mmc") == 0) {
404 if (dfu_fill_entity_mmc(dfu, devstr, s))
406 } else if (strcmp(interface, "nand") == 0) {
407 if (dfu_fill_entity_nand(dfu, devstr, s))
409 } else if (strcmp(interface, "ram") == 0) {
410 if (dfu_fill_entity_ram(dfu, devstr, s))
413 printf("%s: Device %s not (yet) supported!\n",
414 __func__, interface);
421 void dfu_free_entities(void)
423 struct dfu_entity *dfu, *p, *t = NULL;
425 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
426 list_del(&dfu->list);
431 INIT_LIST_HEAD(&dfu_list);
436 int dfu_config_entities(char *env, char *interface, char *devstr)
438 struct dfu_entity *dfu;
442 dfu_alt_num = dfu_find_alt_num(env);
443 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
445 dfu_hash_algo = NULL;
446 s = dfu_get_hash_algo();
448 ret = hash_lookup_algo(s, &dfu_hash_algo);
450 error("Hash algorithm %s not supported\n", s);
453 dfu = calloc(sizeof(*dfu), dfu_alt_num);
456 for (i = 0; i < dfu_alt_num; i++) {
458 s = strsep(&env, ";");
459 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
464 list_add_tail(&dfu[i].list, &dfu_list);
471 const char *dfu_get_dev_type(enum dfu_device_type t)
473 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
477 const char *dfu_get_layout(enum dfu_layout l)
479 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
480 "EXT3", "EXT4", "RAM_ADDR" };
481 return dfu_layout[l];
484 void dfu_show_entities(void)
486 struct dfu_entity *dfu;
488 puts("DFU alt settings list:\n");
490 list_for_each_entry(dfu, &dfu_list, list) {
491 printf("dev: %s alt: %d name: %s layout: %s\n",
492 dfu_get_dev_type(dfu->dev_type), dfu->alt,
493 dfu->name, dfu_get_layout(dfu->layout));
497 int dfu_get_alt_number(void)
502 struct dfu_entity *dfu_get_entity(int alt)
504 struct dfu_entity *dfu;
506 list_for_each_entry(dfu, &dfu_list, list) {
514 int dfu_get_alt(char *name)
516 struct dfu_entity *dfu;
518 list_for_each_entry(dfu, &dfu_list, list) {
519 if (!strncmp(dfu->name, name, strlen(dfu->name)))