xref: /openbmc/u-boot/drivers/dfu/dfu.c (revision 254d68b6) 
1 /*
2  * dfu.c -- DFU back-end routines
3  *
4  * Copyright (C) 2012 Samsung Electronics
5  * author: Lukasz Majewski <l.majewski@samsung.com>
6  *
7  * SPDX-License-Identifier:	GPL-2.0+
8  */
9 
10 #include <common.h>
11 #include <errno.h>
12 #include <malloc.h>
13 #include <mmc.h>
14 #include <fat.h>
15 #include <dfu.h>
16 #include <linux/list.h>
17 #include <linux/compiler.h>
18 
19 static bool dfu_reset_request;
20 static LIST_HEAD(dfu_list);
21 static int dfu_alt_num;
22 
23 bool dfu_reset(void)
24 {
25 	return dfu_reset_request;
26 }
27 
28 void dfu_trigger_reset()
29 {
30 	dfu_reset_request = true;
31 }
32 
33 static int dfu_find_alt_num(const char *s)
34 {
35 	int i = 0;
36 
37 	for (; *s; s++)
38 		if (*s == ';')
39 			i++;
40 
41 	return ++i;
42 }
43 
44 int dfu_init_env_entities(char *interface, int dev)
45 {
46 	const char *str_env;
47 	char *env_bkp;
48 	int ret;
49 
50 	str_env = getenv("dfu_alt_info");
51 	if (!str_env) {
52 		error("\"dfu_alt_info\" env variable not defined!\n");
53 		return -EINVAL;
54 	}
55 
56 	env_bkp = strdup(str_env);
57 	ret = dfu_config_entities(env_bkp, interface, dev);
58 	if (ret) {
59 		error("DFU entities configuration failed!\n");
60 		return ret;
61 	}
62 
63 	free(env_bkp);
64 	return 0;
65 }
66 
67 static unsigned char *dfu_buf;
68 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
69 
70 unsigned char *dfu_free_buf(void)
71 {
72 	free(dfu_buf);
73 	dfu_buf = NULL;
74 	return dfu_buf;
75 }
76 
77 unsigned long dfu_get_buf_size(void)
78 {
79 	return dfu_buf_size;
80 }
81 
82 unsigned char *dfu_get_buf(void)
83 {
84 	char *s;
85 
86 	if (dfu_buf != NULL)
87 		return dfu_buf;
88 
89 	s = getenv("dfu_bufsiz");
90 	dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) :
91 			CONFIG_SYS_DFU_DATA_BUF_SIZE;
92 
93 	dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
94 	if (dfu_buf == NULL)
95 		printf("%s: Could not memalign 0x%lx bytes\n",
96 		       __func__, dfu_buf_size);
97 
98 	return dfu_buf;
99 }
100 
101 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
102 {
103 	long w_size;
104 	int ret;
105 
106 	/* flush size? */
107 	w_size = dfu->i_buf - dfu->i_buf_start;
108 	if (w_size == 0)
109 		return 0;
110 
111 	/* update CRC32 */
112 	dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size);
113 
114 	ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
115 	if (ret)
116 		debug("%s: Write error!\n", __func__);
117 
118 	/* point back */
119 	dfu->i_buf = dfu->i_buf_start;
120 
121 	/* update offset */
122 	dfu->offset += w_size;
123 
124 	puts("#");
125 
126 	return ret;
127 }
128 
129 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
130 {
131 	int ret = 0;
132 
133 	if (dfu->flush_medium)
134 		ret = dfu->flush_medium(dfu);
135 
136 	printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc);
137 
138 	/* clear everything */
139 	dfu_free_buf();
140 	dfu->crc = 0;
141 	dfu->offset = 0;
142 	dfu->i_blk_seq_num = 0;
143 	dfu->i_buf_start = dfu_buf;
144 	dfu->i_buf_end = dfu_buf;
145 	dfu->i_buf = dfu->i_buf_start;
146 	dfu->inited = 0;
147 
148 	return ret;
149 }
150 
151 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
152 {
153 	int ret = 0;
154 	int tret;
155 
156 	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n",
157 	      __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
158 	      dfu->i_buf - dfu->i_buf_start);
159 
160 	if (!dfu->inited) {
161 		/* initial state */
162 		dfu->crc = 0;
163 		dfu->offset = 0;
164 		dfu->bad_skip = 0;
165 		dfu->i_blk_seq_num = 0;
166 		dfu->i_buf_start = dfu_get_buf();
167 		if (dfu->i_buf_start == NULL)
168 			return -ENOMEM;
169 		dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
170 		dfu->i_buf = dfu->i_buf_start;
171 
172 		dfu->inited = 1;
173 	}
174 
175 	if (dfu->i_blk_seq_num != blk_seq_num) {
176 		printf("%s: Wrong sequence number! [%d] [%d]\n",
177 		       __func__, dfu->i_blk_seq_num, blk_seq_num);
178 		return -1;
179 	}
180 
181 	/* DFU 1.1 standard says:
182 	 * The wBlockNum field is a block sequence number. It increments each
183 	 * time a block is transferred, wrapping to zero from 65,535. It is used
184 	 * to provide useful context to the DFU loader in the device."
185 	 *
186 	 * This means that it's a 16 bit counter that roll-overs at
187 	 * 0xffff -> 0x0000. By having a typical 4K transfer block
188 	 * we roll-over at exactly 256MB. Not very fun to debug.
189 	 *
190 	 * Handling rollover, and having an inited variable,
191 	 * makes things work.
192 	 */
193 
194 	/* handle rollover */
195 	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
196 
197 	/* flush buffer if overflow */
198 	if ((dfu->i_buf + size) > dfu->i_buf_end) {
199 		tret = dfu_write_buffer_drain(dfu);
200 		if (ret == 0)
201 			ret = tret;
202 	}
203 
204 	/* we should be in buffer now (if not then size too large) */
205 	if ((dfu->i_buf + size) > dfu->i_buf_end) {
206 		error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
207 		      size, dfu->i_buf_end);
208 		return -1;
209 	}
210 
211 	memcpy(dfu->i_buf, buf, size);
212 	dfu->i_buf += size;
213 
214 	/* if end or if buffer full flush */
215 	if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
216 		tret = dfu_write_buffer_drain(dfu);
217 		if (ret == 0)
218 			ret = tret;
219 	}
220 
221 	return ret = 0 ? size : ret;
222 }
223 
224 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
225 {
226 	long chunk;
227 	int ret, readn;
228 
229 	readn = 0;
230 	while (size > 0) {
231 		/* get chunk that can be read */
232 		chunk = min(size, dfu->b_left);
233 		/* consume */
234 		if (chunk > 0) {
235 			memcpy(buf, dfu->i_buf, chunk);
236 			dfu->crc = crc32(dfu->crc, buf, chunk);
237 			dfu->i_buf += chunk;
238 			dfu->b_left -= chunk;
239 			dfu->r_left -= chunk;
240 			size -= chunk;
241 			buf += chunk;
242 			readn += chunk;
243 		}
244 
245 		/* all done */
246 		if (size > 0) {
247 			/* no more to read */
248 			if (dfu->r_left == 0)
249 				break;
250 
251 			dfu->i_buf = dfu->i_buf_start;
252 			dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
253 
254 			/* got to read, but buffer is empty */
255 			if (dfu->b_left > dfu->r_left)
256 				dfu->b_left = dfu->r_left;
257 			ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
258 					&dfu->b_left);
259 			if (ret != 0) {
260 				debug("%s: Read error!\n", __func__);
261 				return ret;
262 			}
263 			dfu->offset += dfu->b_left;
264 			dfu->r_left -= dfu->b_left;
265 
266 			puts("#");
267 		}
268 	}
269 
270 	return readn;
271 }
272 
273 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
274 {
275 	int ret = 0;
276 
277 	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
278 	       __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
279 
280 	if (!dfu->inited) {
281 		dfu->i_buf_start = dfu_get_buf();
282 		if (dfu->i_buf_start == NULL)
283 			return -ENOMEM;
284 
285 		ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left);
286 		if (ret != 0) {
287 			debug("%s: failed to get r_left\n", __func__);
288 			return ret;
289 		}
290 
291 		debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
292 
293 		dfu->i_blk_seq_num = 0;
294 		dfu->crc = 0;
295 		dfu->offset = 0;
296 		dfu->i_buf_end = dfu_get_buf() + dfu_buf_size;
297 		dfu->i_buf = dfu->i_buf_start;
298 		dfu->b_left = min(dfu_buf_size, dfu->r_left);
299 
300 		dfu->bad_skip = 0;
301 
302 		dfu->inited = 1;
303 	}
304 
305 	if (dfu->i_blk_seq_num != blk_seq_num) {
306 		printf("%s: Wrong sequence number! [%d] [%d]\n",
307 		       __func__, dfu->i_blk_seq_num, blk_seq_num);
308 		return -1;
309 	}
310 	/* handle rollover */
311 	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
312 
313 	ret = dfu_read_buffer_fill(dfu, buf, size);
314 	if (ret < 0) {
315 		printf("%s: Failed to fill buffer\n", __func__);
316 		return -1;
317 	}
318 
319 	if (ret < size) {
320 		debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc);
321 		puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
322 
323 		dfu_free_buf();
324 		dfu->i_blk_seq_num = 0;
325 		dfu->crc = 0;
326 		dfu->offset = 0;
327 		dfu->i_buf_start = dfu_buf;
328 		dfu->i_buf_end = dfu_buf;
329 		dfu->i_buf = dfu->i_buf_start;
330 		dfu->b_left = 0;
331 
332 		dfu->bad_skip = 0;
333 
334 		dfu->inited = 0;
335 	}
336 
337 	return ret;
338 }
339 
340 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
341 			   char *interface, int num)
342 {
343 	char *st;
344 
345 	debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num);
346 	st = strsep(&s, " ");
347 	strcpy(dfu->name, st);
348 
349 	dfu->dev_num = num;
350 	dfu->alt = alt;
351 
352 	/* Specific for mmc device */
353 	if (strcmp(interface, "mmc") == 0) {
354 		if (dfu_fill_entity_mmc(dfu, s))
355 			return -1;
356 	} else if (strcmp(interface, "nand") == 0) {
357 		if (dfu_fill_entity_nand(dfu, s))
358 			return -1;
359 	} else if (strcmp(interface, "ram") == 0) {
360 		if (dfu_fill_entity_ram(dfu, s))
361 			return -1;
362 	} else {
363 		printf("%s: Device %s not (yet) supported!\n",
364 		       __func__,  interface);
365 		return -1;
366 	}
367 
368 	return 0;
369 }
370 
371 void dfu_free_entities(void)
372 {
373 	struct dfu_entity *dfu, *p, *t = NULL;
374 
375 	list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
376 		list_del(&dfu->list);
377 		t = dfu;
378 	}
379 	if (t)
380 		free(t);
381 	INIT_LIST_HEAD(&dfu_list);
382 }
383 
384 int dfu_config_entities(char *env, char *interface, int num)
385 {
386 	struct dfu_entity *dfu;
387 	int i, ret;
388 	char *s;
389 
390 	dfu_alt_num = dfu_find_alt_num(env);
391 	debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
392 
393 	dfu = calloc(sizeof(*dfu), dfu_alt_num);
394 	if (!dfu)
395 		return -1;
396 	for (i = 0; i < dfu_alt_num; i++) {
397 
398 		s = strsep(&env, ";");
399 		ret = dfu_fill_entity(&dfu[i], s, i, interface, num);
400 		if (ret)
401 			return -1;
402 
403 		list_add_tail(&dfu[i].list, &dfu_list);
404 	}
405 
406 	return 0;
407 }
408 
409 const char *dfu_get_dev_type(enum dfu_device_type t)
410 {
411 	const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
412 	return dev_t[t];
413 }
414 
415 const char *dfu_get_layout(enum dfu_layout l)
416 {
417 	const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
418 					   "EXT3", "EXT4", "RAM_ADDR" };
419 	return dfu_layout[l];
420 }
421 
422 void dfu_show_entities(void)
423 {
424 	struct dfu_entity *dfu;
425 
426 	puts("DFU alt settings list:\n");
427 
428 	list_for_each_entry(dfu, &dfu_list, list) {
429 		printf("dev: %s alt: %d name: %s layout: %s\n",
430 		       dfu_get_dev_type(dfu->dev_type), dfu->alt,
431 		       dfu->name, dfu_get_layout(dfu->layout));
432 	}
433 }
434 
435 int dfu_get_alt_number(void)
436 {
437 	return dfu_alt_num;
438 }
439 
440 struct dfu_entity *dfu_get_entity(int alt)
441 {
442 	struct dfu_entity *dfu;
443 
444 	list_for_each_entry(dfu, &dfu_list, list) {
445 		if (dfu->alt == alt)
446 			return dfu;
447 	}
448 
449 	return NULL;
450 }
451 
452 int dfu_get_alt(char *name)
453 {
454 	struct dfu_entity *dfu;
455 
456 	list_for_each_entry(dfu, &dfu_list, list) {
457 		if (!strncmp(dfu->name, name, strlen(dfu->name)))
458 			return dfu->alt;
459 	}
460 
461 	return -ENODEV;
462 }
463