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+
16 #include <linux/list.h>
17 #include <linux/compiler.h>
19 static bool dfu_reset_request;
20 static LIST_HEAD(dfu_list);
21 static int dfu_alt_num;
22 static int alt_num_cnt;
26 return dfu_reset_request;
29 void dfu_trigger_reset()
31 dfu_reset_request = true;
34 static int dfu_find_alt_num(const char *s)
45 int dfu_init_env_entities(char *interface, int dev)
51 str_env = getenv("dfu_alt_info");
53 error("\"dfu_alt_info\" env variable not defined!\n");
57 env_bkp = strdup(str_env);
58 ret = dfu_config_entities(env_bkp, interface, dev);
60 error("DFU entities configuration failed!\n");
68 static unsigned char *dfu_buf;
69 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
71 unsigned char *dfu_free_buf(void)
78 unsigned long dfu_get_buf_size(void)
83 unsigned char *dfu_get_buf(void)
90 s = getenv("dfu_bufsiz");
91 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
92 CONFIG_SYS_DFU_DATA_BUF_SIZE;
94 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
96 printf("%s: Could not memalign 0x%lx bytes\n",
97 __func__, dfu_buf_size);
102 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
108 w_size = dfu->i_buf - dfu->i_buf_start;
113 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
115 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
117 debug("%s: Write error!\n", __func__);
120 dfu->i_buf = dfu->i_buf_start;
123 dfu->offset += w_size;
130 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
134 ret = dfu_write_buffer_drain(dfu);
138 if (dfu->flush_medium)
139 ret = dfu->flush_medium(dfu);
141 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
143 /* clear everything */
147 dfu->i_blk_seq_num = 0;
148 dfu->i_buf_start = dfu_buf;
149 dfu->i_buf_end = dfu_buf;
150 dfu->i_buf = dfu->i_buf_start;
156 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
161 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
162 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
163 dfu->i_buf - dfu->i_buf_start);
170 dfu->i_blk_seq_num = 0;
171 dfu->i_buf_start = dfu_get_buf();
172 if (dfu->i_buf_start == NULL)
174 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
175 dfu->i_buf = dfu->i_buf_start;
180 if (dfu->i_blk_seq_num != blk_seq_num) {
181 printf("%s: Wrong sequence number! [%d] [%d]\n",
182 __func__, dfu->i_blk_seq_num, blk_seq_num);
186 /* DFU 1.1 standard says:
187 * The wBlockNum field is a block sequence number. It increments each
188 * time a block is transferred, wrapping to zero from 65,535. It is used
189 * to provide useful context to the DFU loader in the device."
191 * This means that it's a 16 bit counter that roll-overs at
192 * 0xffff -> 0x0000. By having a typical 4K transfer block
193 * we roll-over at exactly 256MB. Not very fun to debug.
195 * Handling rollover, and having an inited variable,
199 /* handle rollover */
200 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
202 /* flush buffer if overflow */
203 if ((dfu->i_buf + size) > dfu->i_buf_end) {
204 tret = dfu_write_buffer_drain(dfu);
209 /* we should be in buffer now (if not then size too large) */
210 if ((dfu->i_buf + size) > dfu->i_buf_end) {
211 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
212 size, dfu->i_buf_end);
216 memcpy(dfu->i_buf, buf, size);
219 /* if end or if buffer full flush */
220 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
221 tret = dfu_write_buffer_drain(dfu);
229 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
236 /* get chunk that can be read */
237 chunk = min(size, dfu->b_left);
240 memcpy(buf, dfu->i_buf, chunk);
241 dfu->crc = crc32(dfu->crc, buf, chunk);
243 dfu->b_left -= chunk;
244 dfu->r_left -= chunk;
252 /* no more to read */
253 if (dfu->r_left == 0)
256 dfu->i_buf = dfu->i_buf_start;
257 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
259 /* got to read, but buffer is empty */
260 if (dfu->b_left > dfu->r_left)
261 dfu->b_left = dfu->r_left;
262 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
265 debug("%s: Read error!\n", __func__);
268 dfu->offset += dfu->b_left;
269 dfu->r_left -= dfu->b_left;
278 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
282 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
283 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
286 dfu->i_buf_start = dfu_get_buf();
287 if (dfu->i_buf_start == NULL)
290 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
292 debug("%s: failed to get r_left\n", __func__);
296 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
298 dfu->i_blk_seq_num = 0;
301 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
302 dfu->i_buf = dfu->i_buf_start;
303 dfu->b_left = min(dfu_buf_size, dfu->r_left);
310 if (dfu->i_blk_seq_num != blk_seq_num) {
311 printf("%s: Wrong sequence number! [%d] [%d]\n",
312 __func__, dfu->i_blk_seq_num, blk_seq_num);
315 /* handle rollover */
316 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
318 ret = dfu_read_buffer_fill(dfu, buf, size);
320 printf("%s: Failed to fill buffer\n", __func__);
325 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
326 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
329 dfu->i_blk_seq_num = 0;
332 dfu->i_buf_start = dfu_buf;
333 dfu->i_buf_end = dfu_buf;
334 dfu->i_buf = dfu->i_buf_start;
345 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
346 char *interface, int num)
350 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
351 st = strsep(&s, " ");
352 strcpy(dfu->name, st);
357 /* Specific for mmc device */
358 if (strcmp(interface, "mmc") == 0) {
359 if (dfu_fill_entity_mmc(dfu, s))
361 } else if (strcmp(interface, "nand") == 0) {
362 if (dfu_fill_entity_nand(dfu, s))
364 } else if (strcmp(interface, "ram") == 0) {
365 if (dfu_fill_entity_ram(dfu, s))
368 printf("%s: Device %s not (yet) supported!\n",
369 __func__, interface);
376 void dfu_free_entities(void)
378 struct dfu_entity *dfu, *p, *t = NULL;
380 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
381 list_del(&dfu->list);
386 INIT_LIST_HEAD(&dfu_list);
391 int dfu_config_entities(char *env, char *interface, int num)
393 struct dfu_entity *dfu;
397 dfu_alt_num = dfu_find_alt_num(env);
398 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
400 dfu = calloc(sizeof(*dfu), dfu_alt_num);
403 for (i = 0; i < dfu_alt_num; i++) {
405 s = strsep(&env, ";");
406 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface, num);
410 list_add_tail(&dfu[i].list, &dfu_list);
417 const char *dfu_get_dev_type(enum dfu_device_type t)
419 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
423 const char *dfu_get_layout(enum dfu_layout l)
425 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
426 "EXT3", "EXT4", "RAM_ADDR" };
427 return dfu_layout[l];
430 void dfu_show_entities(void)
432 struct dfu_entity *dfu;
434 puts("DFU alt settings list:\n");
436 list_for_each_entry(dfu, &dfu_list, list) {
437 printf("dev: %s alt: %d name: %s layout: %s\n",
438 dfu_get_dev_type(dfu->dev_type), dfu->alt,
439 dfu->name, dfu_get_layout(dfu->layout));
443 int dfu_get_alt_number(void)
448 struct dfu_entity *dfu_get_entity(int alt)
450 struct dfu_entity *dfu;
452 list_for_each_entry(dfu, &dfu_list, list) {
460 int dfu_get_alt(char *name)
462 struct dfu_entity *dfu;
464 list_for_each_entry(dfu, &dfu_list, list) {
465 if (!strncmp(dfu->name, name, strlen(dfu->name)))