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 static unsigned char *dfu_free_buf(void)
77 static unsigned char *dfu_get_buf(void)
84 s
= getenv("dfu_bufsiz");
85 dfu_buf_size
= s
? (unsigned long)simple_strtol(s
, NULL
, 16) :
86 CONFIG_SYS_DFU_DATA_BUF_SIZE
;
88 dfu_buf
= memalign(CONFIG_SYS_CACHELINE_SIZE
, dfu_buf_size
);
90 printf("%s: Could not memalign 0x%lx bytes\n",
91 __func__
, dfu_buf_size
);
96 static int dfu_write_buffer_drain(struct dfu_entity
*dfu
)
102 w_size
= dfu
->i_buf
- dfu
->i_buf_start
;
107 dfu
->crc
= crc32(dfu
->crc
, dfu
->i_buf_start
, w_size
);
109 ret
= dfu
->write_medium(dfu
, dfu
->offset
, dfu
->i_buf_start
, &w_size
);
111 debug("%s: Write error!\n", __func__
);
114 dfu
->i_buf
= dfu
->i_buf_start
;
117 dfu
->offset
+= w_size
;
124 int dfu_write(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
129 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
130 __func__
, dfu
->name
, buf
, size
, blk_seq_num
, dfu
->offset
,
131 dfu
->i_buf
- dfu
->i_buf_start
);
138 dfu
->i_blk_seq_num
= 0;
139 dfu
->i_buf_start
= dfu_get_buf();
140 if (dfu
->i_buf_start
== NULL
)
142 dfu
->i_buf_end
= dfu_get_buf() + dfu_buf_size
;
143 dfu
->i_buf
= dfu
->i_buf_start
;
148 if (dfu
->i_blk_seq_num
!= blk_seq_num
) {
149 printf("%s: Wrong sequence number! [%d] [%d]\n",
150 __func__
, dfu
->i_blk_seq_num
, blk_seq_num
);
154 /* DFU 1.1 standard says:
155 * The wBlockNum field is a block sequence number. It increments each
156 * time a block is transferred, wrapping to zero from 65,535. It is used
157 * to provide useful context to the DFU loader in the device."
159 * This means that it's a 16 bit counter that roll-overs at
160 * 0xffff -> 0x0000. By having a typical 4K transfer block
161 * we roll-over at exactly 256MB. Not very fun to debug.
163 * Handling rollover, and having an inited variable,
167 /* handle rollover */
168 dfu
->i_blk_seq_num
= (dfu
->i_blk_seq_num
+ 1) & 0xffff;
170 /* flush buffer if overflow */
171 if ((dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
172 tret
= dfu_write_buffer_drain(dfu
);
177 /* we should be in buffer now (if not then size too large) */
178 if ((dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
179 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu
->i_buf
,
180 size
, dfu
->i_buf_end
);
184 memcpy(dfu
->i_buf
, buf
, size
);
187 /* if end or if buffer full flush */
188 if (size
== 0 || (dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
189 tret
= dfu_write_buffer_drain(dfu
);
196 /* Now try and flush to the medium if needed. */
197 if (dfu
->flush_medium
)
198 ret
= dfu
->flush_medium(dfu
);
199 printf("\nDFU complete CRC32: 0x%08x\n", dfu
->crc
);
201 /* clear everything */
205 dfu
->i_blk_seq_num
= 0;
206 dfu
->i_buf_start
= dfu_buf
;
207 dfu
->i_buf_end
= dfu_buf
;
208 dfu
->i_buf
= dfu
->i_buf_start
;
214 return ret
= 0 ? size
: ret
;
217 static int dfu_read_buffer_fill(struct dfu_entity
*dfu
, void *buf
, int size
)
224 /* get chunk that can be read */
225 chunk
= min(size
, dfu
->b_left
);
228 memcpy(buf
, dfu
->i_buf
, chunk
);
229 dfu
->crc
= crc32(dfu
->crc
, buf
, chunk
);
231 dfu
->b_left
-= chunk
;
239 /* no more to read */
240 if (dfu
->r_left
== 0)
243 dfu
->i_buf
= dfu
->i_buf_start
;
244 dfu
->b_left
= dfu
->i_buf_end
- dfu
->i_buf_start
;
246 /* got to read, but buffer is empty */
247 if (dfu
->b_left
> dfu
->r_left
)
248 dfu
->b_left
= dfu
->r_left
;
249 ret
= dfu
->read_medium(dfu
, dfu
->offset
, dfu
->i_buf
,
252 debug("%s: Read error!\n", __func__
);
255 dfu
->offset
+= dfu
->b_left
;
256 dfu
->r_left
-= dfu
->b_left
;
265 int dfu_read(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
269 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
270 __func__
, dfu
->name
, buf
, size
, blk_seq_num
, dfu
->i_buf
);
273 dfu
->i_buf_start
= dfu_get_buf();
274 if (dfu
->i_buf_start
== NULL
)
277 ret
= dfu
->read_medium(dfu
, 0, dfu
->i_buf_start
, &dfu
->r_left
);
279 debug("%s: failed to get r_left\n", __func__
);
283 debug("%s: %s %ld [B]\n", __func__
, dfu
->name
, dfu
->r_left
);
285 dfu
->i_blk_seq_num
= 0;
288 dfu
->i_buf_end
= dfu_get_buf() + dfu_buf_size
;
289 dfu
->i_buf
= dfu
->i_buf_start
;
297 if (dfu
->i_blk_seq_num
!= blk_seq_num
) {
298 printf("%s: Wrong sequence number! [%d] [%d]\n",
299 __func__
, dfu
->i_blk_seq_num
, blk_seq_num
);
302 /* handle rollover */
303 dfu
->i_blk_seq_num
= (dfu
->i_blk_seq_num
+ 1) & 0xffff;
305 ret
= dfu_read_buffer_fill(dfu
, buf
, size
);
307 printf("%s: Failed to fill buffer\n", __func__
);
312 debug("%s: %s CRC32: 0x%x\n", __func__
, dfu
->name
, dfu
->crc
);
313 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
316 dfu
->i_blk_seq_num
= 0;
319 dfu
->i_buf_start
= dfu_buf
;
320 dfu
->i_buf_end
= dfu_buf
;
321 dfu
->i_buf
= dfu
->i_buf_start
;
332 static int dfu_fill_entity(struct dfu_entity
*dfu
, char *s
, int alt
,
333 char *interface
, int num
)
337 debug("%s: %s interface: %s num: %d\n", __func__
, s
, interface
, num
);
338 st
= strsep(&s
, " ");
339 strcpy(dfu
->name
, st
);
344 /* Specific for mmc device */
345 if (strcmp(interface
, "mmc") == 0) {
346 if (dfu_fill_entity_mmc(dfu
, s
))
348 } else if (strcmp(interface
, "nand") == 0) {
349 if (dfu_fill_entity_nand(dfu
, s
))
351 } else if (strcmp(interface
, "ram") == 0) {
352 if (dfu_fill_entity_ram(dfu
, s
))
355 printf("%s: Device %s not (yet) supported!\n",
356 __func__
, interface
);
363 void dfu_free_entities(void)
365 struct dfu_entity
*dfu
, *p
, *t
= NULL
;
367 list_for_each_entry_safe_reverse(dfu
, p
, &dfu_list
, list
) {
368 list_del(&dfu
->list
);
373 INIT_LIST_HEAD(&dfu_list
);
376 int dfu_config_entities(char *env
, char *interface
, int num
)
378 struct dfu_entity
*dfu
;
382 dfu_alt_num
= dfu_find_alt_num(env
);
383 debug("%s: dfu_alt_num=%d\n", __func__
, dfu_alt_num
);
385 dfu
= calloc(sizeof(*dfu
), dfu_alt_num
);
388 for (i
= 0; i
< dfu_alt_num
; i
++) {
390 s
= strsep(&env
, ";");
391 ret
= dfu_fill_entity(&dfu
[i
], s
, i
, interface
, num
);
395 list_add_tail(&dfu
[i
].list
, &dfu_list
);
401 const char *dfu_get_dev_type(enum dfu_device_type t
)
403 const char *dev_t
[] = {NULL
, "eMMC", "OneNAND", "NAND", "RAM" };
407 const char *dfu_get_layout(enum dfu_layout l
)
409 const char *dfu_layout
[] = {NULL
, "RAW_ADDR", "FAT", "EXT2",
410 "EXT3", "EXT4", "RAM_ADDR" };
411 return dfu_layout
[l
];
414 void dfu_show_entities(void)
416 struct dfu_entity
*dfu
;
418 puts("DFU alt settings list:\n");
420 list_for_each_entry(dfu
, &dfu_list
, list
) {
421 printf("dev: %s alt: %d name: %s layout: %s\n",
422 dfu_get_dev_type(dfu
->dev_type
), dfu
->alt
,
423 dfu
->name
, dfu_get_layout(dfu
->layout
));
427 int dfu_get_alt_number(void)
432 struct dfu_entity
*dfu_get_entity(int alt
)
434 struct dfu_entity
*dfu
;
436 list_for_each_entry(dfu
, &dfu_list
, list
) {