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 static unsigned char *dfu_buf;
45 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
47 static unsigned char *dfu_free_buf(void)
54 static unsigned char *dfu_get_buf(void)
61 s = getenv("dfu_bufsiz");
62 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
63 CONFIG_SYS_DFU_DATA_BUF_SIZE;
65 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
67 printf("%s: Could not memalign 0x%lx bytes\n",
68 __func__, dfu_buf_size);
73 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
79 w_size = dfu->i_buf - dfu->i_buf_start;
84 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
86 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
88 debug("%s: Write error!\n", __func__);
91 dfu->i_buf = dfu->i_buf_start;
94 dfu->offset += w_size;
101 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
106 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
107 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
108 dfu->i_buf - dfu->i_buf_start);
115 dfu->i_blk_seq_num = 0;
116 dfu->i_buf_start = dfu_get_buf();
117 if (dfu->i_buf_start == NULL)
119 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
120 dfu->i_buf = dfu->i_buf_start;
125 if (dfu->i_blk_seq_num != blk_seq_num) {
126 printf("%s: Wrong sequence number! [%d] [%d]\n",
127 __func__, dfu->i_blk_seq_num, blk_seq_num);
131 /* DFU 1.1 standard says:
132 * The wBlockNum field is a block sequence number. It increments each
133 * time a block is transferred, wrapping to zero from 65,535. It is used
134 * to provide useful context to the DFU loader in the device."
136 * This means that it's a 16 bit counter that roll-overs at
137 * 0xffff -> 0x0000. By having a typical 4K transfer block
138 * we roll-over at exactly 256MB. Not very fun to debug.
140 * Handling rollover, and having an inited variable,
144 /* handle rollover */
145 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
147 /* flush buffer if overflow */
148 if ((dfu->i_buf + size) > dfu->i_buf_end) {
149 tret = dfu_write_buffer_drain(dfu);
154 /* we should be in buffer now (if not then size too large) */
155 if ((dfu->i_buf + size) > dfu->i_buf_end) {
156 printf("%s: Wrong size! [%d] [%d] - %d\n",
157 __func__, dfu->i_blk_seq_num, blk_seq_num, size);
161 memcpy(dfu->i_buf, buf, size);
164 /* if end or if buffer full flush */
165 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
166 tret = dfu_write_buffer_drain(dfu);
173 /* Now try and flush to the medium if needed. */
174 if (dfu->flush_medium)
175 ret = dfu->flush_medium(dfu);
176 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
178 /* clear everything */
182 dfu->i_blk_seq_num = 0;
183 dfu->i_buf_start = dfu_buf;
184 dfu->i_buf_end = dfu_buf;
185 dfu->i_buf = dfu->i_buf_start;
191 return ret = 0 ? size : ret;
194 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
201 /* get chunk that can be read */
202 chunk = min(size, dfu->b_left);
205 memcpy(buf, dfu->i_buf, chunk);
206 dfu->crc = crc32(dfu->crc, buf, chunk);
208 dfu->b_left -= chunk;
216 /* no more to read */
217 if (dfu->r_left == 0)
220 dfu->i_buf = dfu->i_buf_start;
221 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
223 /* got to read, but buffer is empty */
224 if (dfu->b_left > dfu->r_left)
225 dfu->b_left = dfu->r_left;
226 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
229 debug("%s: Read error!\n", __func__);
232 dfu->offset += dfu->b_left;
233 dfu->r_left -= dfu->b_left;
242 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
246 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
247 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
250 dfu->i_buf_start = dfu_get_buf();
251 if (dfu->i_buf_start == NULL)
254 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
256 debug("%s: failed to get r_left\n", __func__);
260 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
262 dfu->i_blk_seq_num = 0;
265 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
266 dfu->i_buf = dfu->i_buf_start;
274 if (dfu->i_blk_seq_num != blk_seq_num) {
275 printf("%s: Wrong sequence number! [%d] [%d]\n",
276 __func__, dfu->i_blk_seq_num, blk_seq_num);
279 /* handle rollover */
280 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
282 ret = dfu_read_buffer_fill(dfu, buf, size);
284 printf("%s: Failed to fill buffer\n", __func__);
289 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
290 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
293 dfu->i_blk_seq_num = 0;
296 dfu->i_buf_start = dfu_buf;
297 dfu->i_buf_end = dfu_buf;
298 dfu->i_buf = dfu->i_buf_start;
309 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
310 char *interface, int num)
314 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
315 st = strsep(&s, " ");
316 strcpy(dfu->name, st);
321 /* Specific for mmc device */
322 if (strcmp(interface, "mmc") == 0) {
323 if (dfu_fill_entity_mmc(dfu, s))
325 } else if (strcmp(interface, "nand") == 0) {
326 if (dfu_fill_entity_nand(dfu, s))
329 printf("%s: Device %s not (yet) supported!\n",
330 __func__, interface);
337 void dfu_free_entities(void)
339 struct dfu_entity *dfu, *p, *t = NULL;
341 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
342 list_del(&dfu->list);
347 INIT_LIST_HEAD(&dfu_list);
350 int dfu_config_entities(char *env, char *interface, int num)
352 struct dfu_entity *dfu;
356 dfu_alt_num = dfu_find_alt_num(env);
357 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
359 dfu = calloc(sizeof(*dfu), dfu_alt_num);
362 for (i = 0; i < dfu_alt_num; i++) {
364 s = strsep(&env, ";");
365 ret = dfu_fill_entity(&dfu[i], s, i, interface, num);
369 list_add_tail(&dfu[i].list, &dfu_list);
375 const char *dfu_get_dev_type(enum dfu_device_type t)
377 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND" };
381 const char *dfu_get_layout(enum dfu_layout l)
383 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
385 return dfu_layout[l];
388 void dfu_show_entities(void)
390 struct dfu_entity *dfu;
392 puts("DFU alt settings list:\n");
394 list_for_each_entry(dfu, &dfu_list, list) {
395 printf("dev: %s alt: %d name: %s layout: %s\n",
396 dfu_get_dev_type(dfu->dev_type), dfu->alt,
397 dfu->name, dfu_get_layout(dfu->layout));
401 int dfu_get_alt_number(void)
406 struct dfu_entity *dfu_get_entity(int alt)
408 struct dfu_entity *dfu;
410 list_for_each_entry(dfu, &dfu_list, list) {