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;
25 return dfu_reset_request;
28 void dfu_trigger_reset()
30 dfu_reset_request = true;
33 static int dfu_find_alt_num(const char *s)
44 int dfu_init_env_entities(char *interface, int dev)
50 str_env = getenv("dfu_alt_info");
52 error("\"dfu_alt_info\" env variable not defined!\n");
56 env_bkp = strdup(str_env);
57 ret = dfu_config_entities(env_bkp, interface, dev);
59 error("DFU entities configuration failed!\n");
67 static unsigned char *dfu_buf;
68 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
70 unsigned char *dfu_free_buf(void)
77 unsigned long dfu_get_buf_size(void)
82 unsigned char *dfu_get_buf(void)
89 s = getenv("dfu_bufsiz");
90 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
91 CONFIG_SYS_DFU_DATA_BUF_SIZE;
93 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
95 printf("%s: Could not memalign 0x%lx bytes\n",
96 __func__, dfu_buf_size);
101 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
107 w_size = dfu->i_buf - dfu->i_buf_start;
112 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
114 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
116 debug("%s: Write error!\n", __func__);
119 dfu->i_buf = dfu->i_buf_start;
122 dfu->offset += w_size;
129 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
134 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
135 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
136 dfu->i_buf - dfu->i_buf_start);
143 dfu->i_blk_seq_num = 0;
144 dfu->i_buf_start = dfu_get_buf();
145 if (dfu->i_buf_start == NULL)
147 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
148 dfu->i_buf = dfu->i_buf_start;
153 if (dfu->i_blk_seq_num != blk_seq_num) {
154 printf("%s: Wrong sequence number! [%d] [%d]\n",
155 __func__, dfu->i_blk_seq_num, blk_seq_num);
159 /* DFU 1.1 standard says:
160 * The wBlockNum field is a block sequence number. It increments each
161 * time a block is transferred, wrapping to zero from 65,535. It is used
162 * to provide useful context to the DFU loader in the device."
164 * This means that it's a 16 bit counter that roll-overs at
165 * 0xffff -> 0x0000. By having a typical 4K transfer block
166 * we roll-over at exactly 256MB. Not very fun to debug.
168 * Handling rollover, and having an inited variable,
172 /* handle rollover */
173 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
175 /* flush buffer if overflow */
176 if ((dfu->i_buf + size) > dfu->i_buf_end) {
177 tret = dfu_write_buffer_drain(dfu);
182 /* we should be in buffer now (if not then size too large) */
183 if ((dfu->i_buf + size) > dfu->i_buf_end) {
184 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
185 size, dfu->i_buf_end);
189 memcpy(dfu->i_buf, buf, size);
192 /* if end or if buffer full flush */
193 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
194 tret = dfu_write_buffer_drain(dfu);
201 /* Now try and flush to the medium if needed. */
202 if (dfu->flush_medium)
203 ret = dfu->flush_medium(dfu);
204 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
206 /* clear everything */
210 dfu->i_blk_seq_num = 0;
211 dfu->i_buf_start = dfu_buf;
212 dfu->i_buf_end = dfu_buf;
213 dfu->i_buf = dfu->i_buf_start;
219 return ret = 0 ? size : ret;
222 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
229 /* get chunk that can be read */
230 chunk = min(size, dfu->b_left);
233 memcpy(buf, dfu->i_buf, chunk);
234 dfu->crc = crc32(dfu->crc, buf, chunk);
236 dfu->b_left -= chunk;
237 dfu->r_left -= chunk;
245 /* no more to read */
246 if (dfu->r_left == 0)
249 dfu->i_buf = dfu->i_buf_start;
250 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
252 /* got to read, but buffer is empty */
253 if (dfu->b_left > dfu->r_left)
254 dfu->b_left = dfu->r_left;
255 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
258 debug("%s: Read error!\n", __func__);
261 dfu->offset += dfu->b_left;
262 dfu->r_left -= dfu->b_left;
271 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
275 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
276 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
279 dfu->i_buf_start = dfu_get_buf();
280 if (dfu->i_buf_start == NULL)
283 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
285 debug("%s: failed to get r_left\n", __func__);
289 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
291 dfu->i_blk_seq_num = 0;
294 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
295 dfu->i_buf = dfu->i_buf_start;
296 dfu->b_left = min(dfu_buf_size, dfu->r_left);
303 if (dfu->i_blk_seq_num != blk_seq_num) {
304 printf("%s: Wrong sequence number! [%d] [%d]\n",
305 __func__, dfu->i_blk_seq_num, blk_seq_num);
308 /* handle rollover */
309 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
311 ret = dfu_read_buffer_fill(dfu, buf, size);
313 printf("%s: Failed to fill buffer\n", __func__);
318 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
319 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
322 dfu->i_blk_seq_num = 0;
325 dfu->i_buf_start = dfu_buf;
326 dfu->i_buf_end = dfu_buf;
327 dfu->i_buf = dfu->i_buf_start;
338 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
339 char *interface, int num)
343 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
344 st = strsep(&s, " ");
345 strcpy(dfu->name, st);
350 /* Specific for mmc device */
351 if (strcmp(interface, "mmc") == 0) {
352 if (dfu_fill_entity_mmc(dfu, s))
354 } else if (strcmp(interface, "nand") == 0) {
355 if (dfu_fill_entity_nand(dfu, s))
357 } else if (strcmp(interface, "ram") == 0) {
358 if (dfu_fill_entity_ram(dfu, s))
361 printf("%s: Device %s not (yet) supported!\n",
362 __func__, interface);
369 void dfu_free_entities(void)
371 struct dfu_entity *dfu, *p, *t = NULL;
373 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
374 list_del(&dfu->list);
379 INIT_LIST_HEAD(&dfu_list);
382 int dfu_config_entities(char *env, char *interface, int num)
384 struct dfu_entity *dfu;
388 dfu_alt_num = dfu_find_alt_num(env);
389 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
391 dfu = calloc(sizeof(*dfu), dfu_alt_num);
394 for (i = 0; i < dfu_alt_num; i++) {
396 s = strsep(&env, ";");
397 ret = dfu_fill_entity(&dfu[i], s, i, interface, num);
401 list_add_tail(&dfu[i].list, &dfu_list);
407 const char *dfu_get_dev_type(enum dfu_device_type t)
409 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
413 const char *dfu_get_layout(enum dfu_layout l)
415 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
416 "EXT3", "EXT4", "RAM_ADDR" };
417 return dfu_layout[l];
420 void dfu_show_entities(void)
422 struct dfu_entity *dfu;
424 puts("DFU alt settings list:\n");
426 list_for_each_entry(dfu, &dfu_list, list) {
427 printf("dev: %s alt: %d name: %s layout: %s\n",
428 dfu_get_dev_type(dfu->dev_type), dfu->alt,
429 dfu->name, dfu_get_layout(dfu->layout));
433 int dfu_get_alt_number(void)
438 struct dfu_entity *dfu_get_entity(int alt)
440 struct dfu_entity *dfu;
442 list_for_each_entry(dfu, &dfu_list, list) {
450 int dfu_get_alt(char *name)
452 struct dfu_entity *dfu;
454 list_for_each_entry(dfu, &dfu_list, list) {
455 if (!strncmp(dfu->name, name, strlen(dfu->name)))