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 LIST_HEAD(dfu_list);
20 static int dfu_alt_num;
22 static int dfu_find_alt_num(const char *s)
33 static unsigned char *dfu_buf;
34 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
36 static unsigned char *dfu_free_buf(void)
43 static unsigned char *dfu_get_buf(void)
50 s = getenv("dfu_bufsiz");
51 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
52 CONFIG_SYS_DFU_DATA_BUF_SIZE;
54 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
56 printf("%s: Could not memalign 0x%lx bytes\n",
57 __func__, dfu_buf_size);
62 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
68 w_size = dfu->i_buf - dfu->i_buf_start;
73 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
75 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
77 debug("%s: Write error!\n", __func__);
80 dfu->i_buf = dfu->i_buf_start;
83 dfu->offset += w_size;
90 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
95 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
96 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
97 dfu->i_buf - dfu->i_buf_start);
104 dfu->i_blk_seq_num = 0;
105 dfu->i_buf_start = dfu_get_buf();
106 if (dfu->i_buf_start == NULL)
108 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
109 dfu->i_buf = dfu->i_buf_start;
114 if (dfu->i_blk_seq_num != blk_seq_num) {
115 printf("%s: Wrong sequence number! [%d] [%d]\n",
116 __func__, dfu->i_blk_seq_num, blk_seq_num);
120 /* DFU 1.1 standard says:
121 * The wBlockNum field is a block sequence number. It increments each
122 * time a block is transferred, wrapping to zero from 65,535. It is used
123 * to provide useful context to the DFU loader in the device."
125 * This means that it's a 16 bit counter that roll-overs at
126 * 0xffff -> 0x0000. By having a typical 4K transfer block
127 * we roll-over at exactly 256MB. Not very fun to debug.
129 * Handling rollover, and having an inited variable,
133 /* handle rollover */
134 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
136 /* flush buffer if overflow */
137 if ((dfu->i_buf + size) > dfu->i_buf_end) {
138 tret = dfu_write_buffer_drain(dfu);
143 /* we should be in buffer now (if not then size too large) */
144 if ((dfu->i_buf + size) > dfu->i_buf_end) {
145 printf("%s: Wrong size! [%d] [%d] - %d\n",
146 __func__, dfu->i_blk_seq_num, blk_seq_num, size);
150 memcpy(dfu->i_buf, buf, size);
153 /* if end or if buffer full flush */
154 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
155 tret = dfu_write_buffer_drain(dfu);
162 /* Now try and flush to the medium if needed. */
163 if (dfu->flush_medium)
164 ret = dfu->flush_medium(dfu);
165 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
167 /* clear everything */
171 dfu->i_blk_seq_num = 0;
172 dfu->i_buf_start = dfu_buf;
173 dfu->i_buf_end = dfu_buf;
174 dfu->i_buf = dfu->i_buf_start;
180 return ret = 0 ? size : ret;
183 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
190 /* get chunk that can be read */
191 chunk = min(size, dfu->b_left);
194 memcpy(buf, dfu->i_buf, chunk);
195 dfu->crc = crc32(dfu->crc, buf, chunk);
197 dfu->b_left -= chunk;
205 /* no more to read */
206 if (dfu->r_left == 0)
209 dfu->i_buf = dfu->i_buf_start;
210 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
212 /* got to read, but buffer is empty */
213 if (dfu->b_left > dfu->r_left)
214 dfu->b_left = dfu->r_left;
215 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
218 debug("%s: Read error!\n", __func__);
221 dfu->offset += dfu->b_left;
222 dfu->r_left -= dfu->b_left;
231 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
235 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
236 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
239 dfu->i_buf_start = dfu_get_buf();
240 if (dfu->i_buf_start == NULL)
243 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
245 debug("%s: failed to get r_left\n", __func__);
249 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
251 dfu->i_blk_seq_num = 0;
254 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
255 dfu->i_buf = dfu->i_buf_start;
263 if (dfu->i_blk_seq_num != blk_seq_num) {
264 printf("%s: Wrong sequence number! [%d] [%d]\n",
265 __func__, dfu->i_blk_seq_num, blk_seq_num);
268 /* handle rollover */
269 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
271 ret = dfu_read_buffer_fill(dfu, buf, size);
273 printf("%s: Failed to fill buffer\n", __func__);
278 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
279 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
282 dfu->i_blk_seq_num = 0;
285 dfu->i_buf_start = dfu_buf;
286 dfu->i_buf_end = dfu_buf;
287 dfu->i_buf = dfu->i_buf_start;
298 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
299 char *interface, int num)
303 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
304 st = strsep(&s, " ");
305 strcpy(dfu->name, st);
310 /* Specific for mmc device */
311 if (strcmp(interface, "mmc") == 0) {
312 if (dfu_fill_entity_mmc(dfu, s))
314 } else if (strcmp(interface, "nand") == 0) {
315 if (dfu_fill_entity_nand(dfu, s))
318 printf("%s: Device %s not (yet) supported!\n",
319 __func__, interface);
326 void dfu_free_entities(void)
328 struct dfu_entity *dfu, *p, *t = NULL;
330 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
331 list_del(&dfu->list);
336 INIT_LIST_HEAD(&dfu_list);
339 int dfu_config_entities(char *env, char *interface, int num)
341 struct dfu_entity *dfu;
345 dfu_alt_num = dfu_find_alt_num(env);
346 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
348 dfu = calloc(sizeof(*dfu), dfu_alt_num);
351 for (i = 0; i < dfu_alt_num; i++) {
353 s = strsep(&env, ";");
354 ret = dfu_fill_entity(&dfu[i], s, i, interface, num);
358 list_add_tail(&dfu[i].list, &dfu_list);
364 const char *dfu_get_dev_type(enum dfu_device_type t)
366 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND" };
370 const char *dfu_get_layout(enum dfu_layout l)
372 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
374 return dfu_layout[l];
377 void dfu_show_entities(void)
379 struct dfu_entity *dfu;
381 puts("DFU alt settings list:\n");
383 list_for_each_entry(dfu, &dfu_list, list) {
384 printf("dev: %s alt: %d name: %s layout: %s\n",
385 dfu_get_dev_type(dfu->dev_type), dfu->alt,
386 dfu->name, dfu_get_layout(dfu->layout));
390 int dfu_get_alt_number(void)
395 struct dfu_entity *dfu_get_entity(int alt)
397 struct dfu_entity *dfu;
399 list_for_each_entry(dfu, &dfu_list, list) {