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
27 #include <linux/list.h>
28 #include <linux/compiler.h>
30 static LIST_HEAD(dfu_list);
31 static int dfu_alt_num;
33 static int dfu_find_alt_num(const char *s)
44 static unsigned char __aligned(CONFIG_SYS_CACHELINE_SIZE)
45 dfu_buf[DFU_DATA_BUF_SIZE];
47 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
53 w_size = dfu->i_buf - dfu->i_buf_start;
58 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
60 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
62 debug("%s: Write error!\n", __func__);
65 dfu->i_buf = dfu->i_buf_start;
68 dfu->offset += w_size;
75 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
80 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
81 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
82 dfu->i_buf - dfu->i_buf_start);
88 dfu->i_blk_seq_num = 0;
89 dfu->i_buf_start = dfu_buf;
90 dfu->i_buf_end = dfu_buf + sizeof(dfu_buf);
91 dfu->i_buf = dfu->i_buf_start;
96 if (dfu->i_blk_seq_num != blk_seq_num) {
97 printf("%s: Wrong sequence number! [%d] [%d]\n",
98 __func__, dfu->i_blk_seq_num, blk_seq_num);
102 /* DFU 1.1 standard says:
103 * The wBlockNum field is a block sequence number. It increments each
104 * time a block is transferred, wrapping to zero from 65,535. It is used
105 * to provide useful context to the DFU loader in the device."
107 * This means that it's a 16 bit counter that roll-overs at
108 * 0xffff -> 0x0000. By having a typical 4K transfer block
109 * we roll-over at exactly 256MB. Not very fun to debug.
111 * Handling rollover, and having an inited variable,
115 /* handle rollover */
116 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
118 /* flush buffer if overflow */
119 if ((dfu->i_buf + size) > dfu->i_buf_end) {
120 tret = dfu_write_buffer_drain(dfu);
125 /* we should be in buffer now (if not then size too large) */
126 if ((dfu->i_buf + size) > dfu->i_buf_end) {
127 printf("%s: Wrong size! [%d] [%d] - %d\n",
128 __func__, dfu->i_blk_seq_num, blk_seq_num, size);
132 memcpy(dfu->i_buf, buf, size);
135 /* if end or if buffer full flush */
136 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
137 tret = dfu_write_buffer_drain(dfu);
144 /* Now try and flush to the medium if needed. */
145 if (dfu->flush_medium)
146 ret = dfu->flush_medium(dfu);
147 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
149 /* clear everything */
152 dfu->i_blk_seq_num = 0;
153 dfu->i_buf_start = dfu_buf;
154 dfu->i_buf_end = dfu_buf + sizeof(dfu_buf);
155 dfu->i_buf = dfu->i_buf_start;
161 return ret = 0 ? size : ret;
164 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
171 /* get chunk that can be read */
172 chunk = min(size, dfu->b_left);
175 memcpy(buf, dfu->i_buf, chunk);
176 dfu->crc = crc32(dfu->crc, buf, chunk);
178 dfu->b_left -= chunk;
186 /* no more to read */
187 if (dfu->r_left == 0)
190 dfu->i_buf = dfu->i_buf_start;
191 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
193 /* got to read, but buffer is empty */
194 if (dfu->b_left > dfu->r_left)
195 dfu->b_left = dfu->r_left;
196 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
199 debug("%s: Read error!\n", __func__);
202 dfu->offset += dfu->b_left;
203 dfu->r_left -= dfu->b_left;
212 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
216 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
217 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
220 ret = dfu->read_medium(dfu, 0, buf, &dfu->r_left);
222 debug("%s: failed to get r_left\n", __func__);
226 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
228 dfu->i_blk_seq_num = 0;
231 dfu->i_buf_start = dfu_buf;
232 dfu->i_buf_end = dfu_buf + sizeof(dfu_buf);
233 dfu->i_buf = dfu->i_buf_start;
239 if (dfu->i_blk_seq_num != blk_seq_num) {
240 printf("%s: Wrong sequence number! [%d] [%d]\n",
241 __func__, dfu->i_blk_seq_num, blk_seq_num);
244 /* handle rollover */
245 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
247 ret = dfu_read_buffer_fill(dfu, buf, size);
249 printf("%s: Failed to fill buffer\n", __func__);
254 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
255 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
257 dfu->i_blk_seq_num = 0;
260 dfu->i_buf_start = dfu_buf;
261 dfu->i_buf_end = dfu_buf + sizeof(dfu_buf);
262 dfu->i_buf = dfu->i_buf_start;
271 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
272 char *interface, int num)
276 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
277 st = strsep(&s, " ");
278 strcpy(dfu->name, st);
283 /* Specific for mmc device */
284 if (strcmp(interface, "mmc") == 0) {
285 if (dfu_fill_entity_mmc(dfu, s))
288 printf("%s: Device %s not (yet) supported!\n",
289 __func__, interface);
296 void dfu_free_entities(void)
298 struct dfu_entity *dfu, *p, *t = NULL;
300 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
301 list_del(&dfu->list);
306 INIT_LIST_HEAD(&dfu_list);
309 int dfu_config_entities(char *env, char *interface, int num)
311 struct dfu_entity *dfu;
315 dfu_alt_num = dfu_find_alt_num(env);
316 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
318 dfu = calloc(sizeof(*dfu), dfu_alt_num);
321 for (i = 0; i < dfu_alt_num; i++) {
323 s = strsep(&env, ";");
324 ret = dfu_fill_entity(&dfu[i], s, i, interface, num);
328 list_add_tail(&dfu[i].list, &dfu_list);
334 const char *dfu_get_dev_type(enum dfu_device_type t)
336 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND" };
340 const char *dfu_get_layout(enum dfu_layout l)
342 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
344 return dfu_layout[l];
347 void dfu_show_entities(void)
349 struct dfu_entity *dfu;
351 puts("DFU alt settings list:\n");
353 list_for_each_entry(dfu, &dfu_list, list) {
354 printf("dev: %s alt: %d name: %s layout: %s\n",
355 dfu_get_dev_type(dfu->dev_type), dfu->alt,
356 dfu->name, dfu_get_layout(dfu->layout));
360 int dfu_get_alt_number(void)
365 struct dfu_entity *dfu_get_entity(int alt)
367 struct dfu_entity *dfu;
369 list_for_each_entry(dfu, &dfu_list, list) {