2 * dfu.c -- DFU back-end routines
4 * Copyright (C) 2012 Samsung Electronics
5 * author: Lukasz Majewski <l.majewski@samsung.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <linux/list.h>
29 #include <linux/compiler.h>
31 static LIST_HEAD(dfu_list);
32 static int dfu_alt_num;
34 static int dfu_find_alt_num(const char *s)
45 static unsigned char *dfu_buf;
46 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
48 static unsigned char *dfu_free_buf(void)
55 static unsigned char *dfu_get_buf(void)
62 s = getenv("dfu_bufsiz");
63 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
64 CONFIG_SYS_DFU_DATA_BUF_SIZE;
66 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
68 printf("%s: Could not memalign 0x%lx bytes\n",
69 __func__, dfu_buf_size);
74 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
80 w_size = dfu->i_buf - dfu->i_buf_start;
85 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
87 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
89 debug("%s: Write error!\n", __func__);
92 dfu->i_buf = dfu->i_buf_start;
95 dfu->offset += w_size;
102 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
107 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
108 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
109 dfu->i_buf - dfu->i_buf_start);
116 dfu->i_blk_seq_num = 0;
117 dfu->i_buf_start = dfu_get_buf();
118 if (dfu->i_buf_start == NULL)
120 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
121 dfu->i_buf = dfu->i_buf_start;
126 if (dfu->i_blk_seq_num != blk_seq_num) {
127 printf("%s: Wrong sequence number! [%d] [%d]\n",
128 __func__, dfu->i_blk_seq_num, blk_seq_num);
132 /* DFU 1.1 standard says:
133 * The wBlockNum field is a block sequence number. It increments each
134 * time a block is transferred, wrapping to zero from 65,535. It is used
135 * to provide useful context to the DFU loader in the device."
137 * This means that it's a 16 bit counter that roll-overs at
138 * 0xffff -> 0x0000. By having a typical 4K transfer block
139 * we roll-over at exactly 256MB. Not very fun to debug.
141 * Handling rollover, and having an inited variable,
145 /* handle rollover */
146 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
148 /* flush buffer if overflow */
149 if ((dfu->i_buf + size) > dfu->i_buf_end) {
150 tret = dfu_write_buffer_drain(dfu);
155 /* we should be in buffer now (if not then size too large) */
156 if ((dfu->i_buf + size) > dfu->i_buf_end) {
157 printf("%s: Wrong size! [%d] [%d] - %d\n",
158 __func__, dfu->i_blk_seq_num, blk_seq_num, size);
162 memcpy(dfu->i_buf, buf, size);
165 /* if end or if buffer full flush */
166 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
167 tret = dfu_write_buffer_drain(dfu);
174 /* Now try and flush to the medium if needed. */
175 if (dfu->flush_medium)
176 ret = dfu->flush_medium(dfu);
177 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
179 /* clear everything */
183 dfu->i_blk_seq_num = 0;
184 dfu->i_buf_start = dfu_buf;
185 dfu->i_buf_end = dfu_buf;
186 dfu->i_buf = dfu->i_buf_start;
192 return ret = 0 ? size : ret;
195 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
202 /* get chunk that can be read */
203 chunk = min(size, dfu->b_left);
206 memcpy(buf, dfu->i_buf, chunk);
207 dfu->crc = crc32(dfu->crc, buf, chunk);
209 dfu->b_left -= chunk;
217 /* no more to read */
218 if (dfu->r_left == 0)
221 dfu->i_buf = dfu->i_buf_start;
222 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
224 /* got to read, but buffer is empty */
225 if (dfu->b_left > dfu->r_left)
226 dfu->b_left = dfu->r_left;
227 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
230 debug("%s: Read error!\n", __func__);
233 dfu->offset += dfu->b_left;
234 dfu->r_left -= dfu->b_left;
243 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
247 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
248 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
251 dfu->i_buf_start = dfu_get_buf();
252 if (dfu->i_buf_start == NULL)
255 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
257 debug("%s: failed to get r_left\n", __func__);
261 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
263 dfu->i_blk_seq_num = 0;
266 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
267 dfu->i_buf = dfu->i_buf_start;
275 if (dfu->i_blk_seq_num != blk_seq_num) {
276 printf("%s: Wrong sequence number! [%d] [%d]\n",
277 __func__, dfu->i_blk_seq_num, blk_seq_num);
280 /* handle rollover */
281 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
283 ret = dfu_read_buffer_fill(dfu, buf, size);
285 printf("%s: Failed to fill buffer\n", __func__);
290 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
291 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
294 dfu->i_blk_seq_num = 0;
297 dfu->i_buf_start = dfu_buf;
298 dfu->i_buf_end = dfu_buf;
299 dfu->i_buf = dfu->i_buf_start;
310 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
311 char *interface, int num)
315 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
316 st = strsep(&s, " ");
317 strcpy(dfu->name, st);
322 /* Specific for mmc device */
323 if (strcmp(interface, "mmc") == 0) {
324 if (dfu_fill_entity_mmc(dfu, s))
326 } else if (strcmp(interface, "nand") == 0) {
327 if (dfu_fill_entity_nand(dfu, s))
330 printf("%s: Device %s not (yet) supported!\n",
331 __func__, interface);
338 void dfu_free_entities(void)
340 struct dfu_entity *dfu, *p, *t = NULL;
342 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
343 list_del(&dfu->list);
348 INIT_LIST_HEAD(&dfu_list);
351 int dfu_config_entities(char *env, char *interface, int num)
353 struct dfu_entity *dfu;
357 dfu_alt_num = dfu_find_alt_num(env);
358 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
360 dfu = calloc(sizeof(*dfu), dfu_alt_num);
363 for (i = 0; i < dfu_alt_num; i++) {
365 s = strsep(&env, ";");
366 ret = dfu_fill_entity(&dfu[i], s, i, interface, num);
370 list_add_tail(&dfu[i].list, &dfu_list);
376 const char *dfu_get_dev_type(enum dfu_device_type t)
378 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND" };
382 const char *dfu_get_layout(enum dfu_layout l)
384 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
386 return dfu_layout[l];
389 void dfu_show_entities(void)
391 struct dfu_entity *dfu;
393 puts("DFU alt settings list:\n");
395 list_for_each_entry(dfu, &dfu_list, list) {
396 printf("dev: %s alt: %d name: %s layout: %s\n",
397 dfu_get_dev_type(dfu->dev_type), dfu->alt,
398 dfu->name, dfu_get_layout(dfu->layout));
402 int dfu_get_alt_number(void)
407 struct dfu_entity *dfu_get_entity(int alt)
409 struct dfu_entity *dfu;
411 list_for_each_entry(dfu, &dfu_list, list) {