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 if (dfu
->flush_medium
)
135 ret
= dfu
->flush_medium(dfu
);
137 printf("\nDFU complete CRC32: 0x%08x\n", dfu
->crc
);
139 /* clear everything */
143 dfu
->i_blk_seq_num
= 0;
144 dfu
->i_buf_start
= dfu_buf
;
145 dfu
->i_buf_end
= dfu_buf
;
146 dfu
->i_buf
= dfu
->i_buf_start
;
152 int dfu_write(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
157 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
158 __func__
, dfu
->name
, buf
, size
, blk_seq_num
, dfu
->offset
,
159 dfu
->i_buf
- dfu
->i_buf_start
);
166 dfu
->i_blk_seq_num
= 0;
167 dfu
->i_buf_start
= dfu_get_buf();
168 if (dfu
->i_buf_start
== NULL
)
170 dfu
->i_buf_end
= dfu_get_buf() + dfu_buf_size
;
171 dfu
->i_buf
= dfu
->i_buf_start
;
176 if (dfu
->i_blk_seq_num
!= blk_seq_num
) {
177 printf("%s: Wrong sequence number! [%d] [%d]\n",
178 __func__
, dfu
->i_blk_seq_num
, blk_seq_num
);
182 /* DFU 1.1 standard says:
183 * The wBlockNum field is a block sequence number. It increments each
184 * time a block is transferred, wrapping to zero from 65,535. It is used
185 * to provide useful context to the DFU loader in the device."
187 * This means that it's a 16 bit counter that roll-overs at
188 * 0xffff -> 0x0000. By having a typical 4K transfer block
189 * we roll-over at exactly 256MB. Not very fun to debug.
191 * Handling rollover, and having an inited variable,
195 /* handle rollover */
196 dfu
->i_blk_seq_num
= (dfu
->i_blk_seq_num
+ 1) & 0xffff;
198 /* flush buffer if overflow */
199 if ((dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
200 tret
= dfu_write_buffer_drain(dfu
);
205 /* we should be in buffer now (if not then size too large) */
206 if ((dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
207 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu
->i_buf
,
208 size
, dfu
->i_buf_end
);
212 memcpy(dfu
->i_buf
, buf
, size
);
215 /* if end or if buffer full flush */
216 if (size
== 0 || (dfu
->i_buf
+ size
) > dfu
->i_buf_end
) {
217 tret
= dfu_write_buffer_drain(dfu
);
225 static int dfu_read_buffer_fill(struct dfu_entity
*dfu
, void *buf
, int size
)
232 /* get chunk that can be read */
233 chunk
= min(size
, dfu
->b_left
);
236 memcpy(buf
, dfu
->i_buf
, chunk
);
237 dfu
->crc
= crc32(dfu
->crc
, buf
, chunk
);
239 dfu
->b_left
-= chunk
;
240 dfu
->r_left
-= chunk
;
248 /* no more to read */
249 if (dfu
->r_left
== 0)
252 dfu
->i_buf
= dfu
->i_buf_start
;
253 dfu
->b_left
= dfu
->i_buf_end
- dfu
->i_buf_start
;
255 /* got to read, but buffer is empty */
256 if (dfu
->b_left
> dfu
->r_left
)
257 dfu
->b_left
= dfu
->r_left
;
258 ret
= dfu
->read_medium(dfu
, dfu
->offset
, dfu
->i_buf
,
261 debug("%s: Read error!\n", __func__
);
264 dfu
->offset
+= dfu
->b_left
;
265 dfu
->r_left
-= dfu
->b_left
;
274 int dfu_read(struct dfu_entity
*dfu
, void *buf
, int size
, int blk_seq_num
)
278 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
279 __func__
, dfu
->name
, buf
, size
, blk_seq_num
, dfu
->i_buf
);
282 dfu
->i_buf_start
= dfu_get_buf();
283 if (dfu
->i_buf_start
== NULL
)
286 ret
= dfu
->read_medium(dfu
, 0, dfu
->i_buf_start
, &dfu
->r_left
);
288 debug("%s: failed to get r_left\n", __func__
);
292 debug("%s: %s %ld [B]\n", __func__
, dfu
->name
, dfu
->r_left
);
294 dfu
->i_blk_seq_num
= 0;
297 dfu
->i_buf_end
= dfu_get_buf() + dfu_buf_size
;
298 dfu
->i_buf
= dfu
->i_buf_start
;
299 dfu
->b_left
= min(dfu_buf_size
, dfu
->r_left
);
306 if (dfu
->i_blk_seq_num
!= blk_seq_num
) {
307 printf("%s: Wrong sequence number! [%d] [%d]\n",
308 __func__
, dfu
->i_blk_seq_num
, blk_seq_num
);
311 /* handle rollover */
312 dfu
->i_blk_seq_num
= (dfu
->i_blk_seq_num
+ 1) & 0xffff;
314 ret
= dfu_read_buffer_fill(dfu
, buf
, size
);
316 printf("%s: Failed to fill buffer\n", __func__
);
321 debug("%s: %s CRC32: 0x%x\n", __func__
, dfu
->name
, dfu
->crc
);
322 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
325 dfu
->i_blk_seq_num
= 0;
328 dfu
->i_buf_start
= dfu_buf
;
329 dfu
->i_buf_end
= dfu_buf
;
330 dfu
->i_buf
= dfu
->i_buf_start
;
341 static int dfu_fill_entity(struct dfu_entity
*dfu
, char *s
, int alt
,
342 char *interface
, int num
)
346 debug("%s: %s interface: %s num: %d\n", __func__
, s
, interface
, num
);
347 st
= strsep(&s
, " ");
348 strcpy(dfu
->name
, st
);
353 /* Specific for mmc device */
354 if (strcmp(interface
, "mmc") == 0) {
355 if (dfu_fill_entity_mmc(dfu
, s
))
357 } else if (strcmp(interface
, "nand") == 0) {
358 if (dfu_fill_entity_nand(dfu
, s
))
360 } else if (strcmp(interface
, "ram") == 0) {
361 if (dfu_fill_entity_ram(dfu
, s
))
364 printf("%s: Device %s not (yet) supported!\n",
365 __func__
, interface
);
372 void dfu_free_entities(void)
374 struct dfu_entity
*dfu
, *p
, *t
= NULL
;
376 list_for_each_entry_safe_reverse(dfu
, p
, &dfu_list
, list
) {
377 list_del(&dfu
->list
);
382 INIT_LIST_HEAD(&dfu_list
);
387 int dfu_config_entities(char *env
, char *interface
, int num
)
389 struct dfu_entity
*dfu
;
393 dfu_alt_num
= dfu_find_alt_num(env
);
394 debug("%s: dfu_alt_num=%d\n", __func__
, dfu_alt_num
);
396 dfu
= calloc(sizeof(*dfu
), dfu_alt_num
);
399 for (i
= 0; i
< dfu_alt_num
; i
++) {
401 s
= strsep(&env
, ";");
402 ret
= dfu_fill_entity(&dfu
[i
], s
, alt_num_cnt
, interface
, num
);
406 list_add_tail(&dfu
[i
].list
, &dfu_list
);
413 const char *dfu_get_dev_type(enum dfu_device_type t
)
415 const char *dev_t
[] = {NULL
, "eMMC", "OneNAND", "NAND", "RAM" };
419 const char *dfu_get_layout(enum dfu_layout l
)
421 const char *dfu_layout
[] = {NULL
, "RAW_ADDR", "FAT", "EXT2",
422 "EXT3", "EXT4", "RAM_ADDR" };
423 return dfu_layout
[l
];
426 void dfu_show_entities(void)
428 struct dfu_entity
*dfu
;
430 puts("DFU alt settings list:\n");
432 list_for_each_entry(dfu
, &dfu_list
, list
) {
433 printf("dev: %s alt: %d name: %s layout: %s\n",
434 dfu_get_dev_type(dfu
->dev_type
), dfu
->alt
,
435 dfu
->name
, dfu_get_layout(dfu
->layout
));
439 int dfu_get_alt_number(void)
444 struct dfu_entity
*dfu_get_entity(int alt
)
446 struct dfu_entity
*dfu
;
448 list_for_each_entry(dfu
, &dfu_list
, list
) {
456 int dfu_get_alt(char *name
)
458 struct dfu_entity
*dfu
;
460 list_for_each_entry(dfu
, &dfu_list
, list
) {
461 if (!strncmp(dfu
->name
, name
, strlen(dfu
->name
)))