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_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
135 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
136 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
137 dfu->i_buf - dfu->i_buf_start);
144 dfu->i_blk_seq_num = 0;
145 dfu->i_buf_start = dfu_get_buf();
146 if (dfu->i_buf_start == NULL)
148 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
149 dfu->i_buf = dfu->i_buf_start;
154 if (dfu->i_blk_seq_num != blk_seq_num) {
155 printf("%s: Wrong sequence number! [%d] [%d]\n",
156 __func__, dfu->i_blk_seq_num, blk_seq_num);
160 /* DFU 1.1 standard says:
161 * The wBlockNum field is a block sequence number. It increments each
162 * time a block is transferred, wrapping to zero from 65,535. It is used
163 * to provide useful context to the DFU loader in the device."
165 * This means that it's a 16 bit counter that roll-overs at
166 * 0xffff -> 0x0000. By having a typical 4K transfer block
167 * we roll-over at exactly 256MB. Not very fun to debug.
169 * Handling rollover, and having an inited variable,
173 /* handle rollover */
174 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
176 /* flush buffer if overflow */
177 if ((dfu->i_buf + size) > dfu->i_buf_end) {
178 tret = dfu_write_buffer_drain(dfu);
183 /* we should be in buffer now (if not then size too large) */
184 if ((dfu->i_buf + size) > dfu->i_buf_end) {
185 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
186 size, dfu->i_buf_end);
190 memcpy(dfu->i_buf, buf, size);
193 /* if end or if buffer full flush */
194 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
195 tret = dfu_write_buffer_drain(dfu);
202 /* Now try and flush to the medium if needed. */
203 if (dfu->flush_medium)
204 ret = dfu->flush_medium(dfu);
205 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
207 /* clear everything */
211 dfu->i_blk_seq_num = 0;
212 dfu->i_buf_start = dfu_buf;
213 dfu->i_buf_end = dfu_buf;
214 dfu->i_buf = dfu->i_buf_start;
220 return ret = 0 ? size : ret;
223 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
230 /* get chunk that can be read */
231 chunk = min(size, dfu->b_left);
234 memcpy(buf, dfu->i_buf, chunk);
235 dfu->crc = crc32(dfu->crc, buf, chunk);
237 dfu->b_left -= chunk;
238 dfu->r_left -= chunk;
246 /* no more to read */
247 if (dfu->r_left == 0)
250 dfu->i_buf = dfu->i_buf_start;
251 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
253 /* got to read, but buffer is empty */
254 if (dfu->b_left > dfu->r_left)
255 dfu->b_left = dfu->r_left;
256 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
259 debug("%s: Read error!\n", __func__);
262 dfu->offset += dfu->b_left;
263 dfu->r_left -= dfu->b_left;
272 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
276 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
277 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
280 dfu->i_buf_start = dfu_get_buf();
281 if (dfu->i_buf_start == NULL)
284 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
286 debug("%s: failed to get r_left\n", __func__);
290 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
292 dfu->i_blk_seq_num = 0;
295 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
296 dfu->i_buf = dfu->i_buf_start;
297 dfu->b_left = min(dfu_buf_size, dfu->r_left);
304 if (dfu->i_blk_seq_num != blk_seq_num) {
305 printf("%s: Wrong sequence number! [%d] [%d]\n",
306 __func__, dfu->i_blk_seq_num, blk_seq_num);
309 /* handle rollover */
310 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
312 ret = dfu_read_buffer_fill(dfu, buf, size);
314 printf("%s: Failed to fill buffer\n", __func__);
319 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
320 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
323 dfu->i_blk_seq_num = 0;
326 dfu->i_buf_start = dfu_buf;
327 dfu->i_buf_end = dfu_buf;
328 dfu->i_buf = dfu->i_buf_start;
339 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
340 char *interface, int num)
344 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
345 st = strsep(&s, " ");
346 strcpy(dfu->name, st);
351 /* Specific for mmc device */
352 if (strcmp(interface, "mmc") == 0) {
353 if (dfu_fill_entity_mmc(dfu, s))
355 } else if (strcmp(interface, "nand") == 0) {
356 if (dfu_fill_entity_nand(dfu, s))
358 } else if (strcmp(interface, "ram") == 0) {
359 if (dfu_fill_entity_ram(dfu, s))
362 printf("%s: Device %s not (yet) supported!\n",
363 __func__, interface);
370 void dfu_free_entities(void)
372 struct dfu_entity *dfu, *p, *t = NULL;
374 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
375 list_del(&dfu->list);
380 INIT_LIST_HEAD(&dfu_list);
385 int dfu_config_entities(char *env, char *interface, int num)
387 struct dfu_entity *dfu;
391 dfu_alt_num = dfu_find_alt_num(env);
392 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
394 dfu = calloc(sizeof(*dfu), dfu_alt_num);
397 for (i = 0; i < dfu_alt_num; i++) {
399 s = strsep(&env, ";");
400 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface, num);
404 list_add_tail(&dfu[i].list, &dfu_list);
411 const char *dfu_get_dev_type(enum dfu_device_type t)
413 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
417 const char *dfu_get_layout(enum dfu_layout l)
419 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
420 "EXT3", "EXT4", "RAM_ADDR" };
421 return dfu_layout[l];
424 void dfu_show_entities(void)
426 struct dfu_entity *dfu;
428 puts("DFU alt settings list:\n");
430 list_for_each_entry(dfu, &dfu_list, list) {
431 printf("dev: %s alt: %d name: %s layout: %s\n",
432 dfu_get_dev_type(dfu->dev_type), dfu->alt,
433 dfu->name, dfu_get_layout(dfu->layout));
437 int dfu_get_alt_number(void)
442 struct dfu_entity *dfu_get_entity(int alt)
444 struct dfu_entity *dfu;
446 list_for_each_entry(dfu, &dfu_list, list) {
454 int dfu_get_alt(char *name)
456 struct dfu_entity *dfu;
458 list_for_each_entry(dfu, &dfu_list, list) {
459 if (!strncmp(dfu->name, name, strlen(dfu->name)))