]> git.ipfire.org Git - people/ms/u-boot.git/blame - drivers/dfu/dfu.c
dfu: don't keep freeing/reallocating
[people/ms/u-boot.git] / drivers / dfu / dfu.c
CommitLineData
f22b11c1
ŁM
1/*
2 * dfu.c -- DFU back-end routines
3 *
4 * Copyright (C) 2012 Samsung Electronics
5 * author: Lukasz Majewski <l.majewski@samsung.com>
6 *
1a459660 7 * SPDX-License-Identifier: GPL-2.0+
f22b11c1
ŁM
8 */
9
10#include <common.h>
e7e75c70 11#include <errno.h>
f22b11c1
ŁM
12#include <malloc.h>
13#include <mmc.h>
14#include <fat.h>
15#include <dfu.h>
bd694244 16#include <hash.h>
f22b11c1
ŁM
17#include <linux/list.h>
18#include <linux/compiler.h>
19
20static LIST_HEAD(dfu_list);
21static int dfu_alt_num;
b627eb46 22static int alt_num_cnt;
bd694244 23static struct hash_algo *dfu_hash_algo;
f22b11c1 24
1cc03c5c
ŁM
25/*
26 * The purpose of the dfu_usb_get_reset() function is to
27 * provide information if after USB_DETACH request
28 * being sent the dfu-util performed reset of USB
29 * bus.
30 *
31 * Described behaviour is the only way to distinct if
32 * user has typed -e (detach) or -R (reset) when invoking
33 * dfu-util command.
34 *
35 */
36__weak bool dfu_usb_get_reset(void)
37{
38 return true;
39}
40
f22b11c1
ŁM
41static int dfu_find_alt_num(const char *s)
42{
43 int i = 0;
44
45 for (; *s; s++)
46 if (*s == ';')
47 i++;
48
49 return ++i;
50}
51
dd64827e 52int dfu_init_env_entities(char *interface, char *devstr)
765c5ae5
ŁM
53{
54 const char *str_env;
55 char *env_bkp;
56 int ret;
57
899a5282
PM
58#ifdef CONFIG_SET_DFU_ALT_INFO
59 set_dfu_alt_info(interface, devstr);
60#endif
765c5ae5
ŁM
61 str_env = getenv("dfu_alt_info");
62 if (!str_env) {
63 error("\"dfu_alt_info\" env variable not defined!\n");
64 return -EINVAL;
65 }
66
67 env_bkp = strdup(str_env);
dd64827e 68 ret = dfu_config_entities(env_bkp, interface, devstr);
765c5ae5
ŁM
69 if (ret) {
70 error("DFU entities configuration failed!\n");
71 return ret;
72 }
73
74 free(env_bkp);
75 return 0;
76}
77
e7e75c70 78static unsigned char *dfu_buf;
a7e6892f 79static unsigned long dfu_buf_size;
e7e75c70 80
d4278263 81unsigned char *dfu_free_buf(void)
e7e75c70
HS
82{
83 free(dfu_buf);
84 dfu_buf = NULL;
85 return dfu_buf;
86}
87
4fb12789
ŁM
88unsigned long dfu_get_buf_size(void)
89{
90 return dfu_buf_size;
91}
92
7ac1b410 93unsigned char *dfu_get_buf(struct dfu_entity *dfu)
e7e75c70
HS
94{
95 char *s;
96
97 if (dfu_buf != NULL)
98 return dfu_buf;
99
100 s = getenv("dfu_bufsiz");
f597fc3d
PM
101 if (s)
102 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
103
104 if (!s || !dfu_buf_size)
105 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
106
7ac1b410
SW
107 if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
108 dfu_buf_size = dfu->max_buf_size;
e7e75c70
HS
109
110 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
111 if (dfu_buf == NULL)
112 printf("%s: Could not memalign 0x%lx bytes\n",
113 __func__, dfu_buf_size);
114
115 return dfu_buf;
116}
f22b11c1 117
bd694244
ŁM
118static char *dfu_get_hash_algo(void)
119{
120 char *s;
121
122 s = getenv("dfu_hash_algo");
3d83e675 123 if (!s)
bd694244
ŁM
124 return NULL;
125
3d83e675
ŁM
126 if (!strcmp(s, "crc32")) {
127 debug("%s: DFU hash method: %s\n", __func__, s);
128 return s;
129 }
130
131 error("DFU hash method: %s not supported!\n", s);
bd694244
ŁM
132 return NULL;
133}
134
ea2453d5
PA
135static int dfu_write_buffer_drain(struct dfu_entity *dfu)
136{
137 long w_size;
138 int ret;
139
140 /* flush size? */
141 w_size = dfu->i_buf - dfu->i_buf_start;
142 if (w_size == 0)
143 return 0;
144
bd694244
ŁM
145 if (dfu_hash_algo)
146 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
147 dfu->i_buf_start, w_size, 0);
ea2453d5
PA
148
149 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
150 if (ret)
151 debug("%s: Write error!\n", __func__);
152
153 /* point back */
154 dfu->i_buf = dfu->i_buf_start;
155
156 /* update offset */
157 dfu->offset += w_size;
158
159 puts("#");
160
161 return ret;
162}
163
3ee9593f
SW
164void dfu_write_transaction_cleanup(struct dfu_entity *dfu)
165{
166 /* clear everything */
3ee9593f
SW
167 dfu->crc = 0;
168 dfu->offset = 0;
169 dfu->i_blk_seq_num = 0;
170 dfu->i_buf_start = dfu_buf;
171 dfu->i_buf_end = dfu_buf;
172 dfu->i_buf = dfu->i_buf_start;
173 dfu->inited = 0;
174}
175
a2199afe
HS
176int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
177{
178 int ret = 0;
179
1aa4bdc8
PM
180 ret = dfu_write_buffer_drain(dfu);
181 if (ret)
182 return ret;
183
a2199afe
HS
184 if (dfu->flush_medium)
185 ret = dfu->flush_medium(dfu);
186
bd694244
ŁM
187 if (dfu_hash_algo)
188 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
189 dfu->crc);
a2199afe 190
3ee9593f 191 dfu_write_transaction_cleanup(dfu);
a2199afe
HS
192
193 return ret;
194}
195
f22b11c1
ŁM
196int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
197{
3ee9593f 198 int ret;
f22b11c1 199
e621c7ab 200 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
ea2453d5 201 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
e621c7ab 202 (unsigned long)(dfu->i_buf - dfu->i_buf_start));
f22b11c1 203
ea2453d5
PA
204 if (!dfu->inited) {
205 /* initial state */
206 dfu->crc = 0;
207 dfu->offset = 0;
c6631764 208 dfu->bad_skip = 0;
ea2453d5 209 dfu->i_blk_seq_num = 0;
7ac1b410 210 dfu->i_buf_start = dfu_get_buf(dfu);
e7e75c70
HS
211 if (dfu->i_buf_start == NULL)
212 return -ENOMEM;
7ac1b410 213 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
ea2453d5
PA
214 dfu->i_buf = dfu->i_buf_start;
215
216 dfu->inited = 1;
f22b11c1
ŁM
217 }
218
ea2453d5 219 if (dfu->i_blk_seq_num != blk_seq_num) {
f22b11c1 220 printf("%s: Wrong sequence number! [%d] [%d]\n",
ea2453d5 221 __func__, dfu->i_blk_seq_num, blk_seq_num);
3ee9593f 222 dfu_write_transaction_cleanup(dfu);
f22b11c1
ŁM
223 return -1;
224 }
225
ea2453d5
PA
226 /* DFU 1.1 standard says:
227 * The wBlockNum field is a block sequence number. It increments each
228 * time a block is transferred, wrapping to zero from 65,535. It is used
229 * to provide useful context to the DFU loader in the device."
230 *
231 * This means that it's a 16 bit counter that roll-overs at
232 * 0xffff -> 0x0000. By having a typical 4K transfer block
233 * we roll-over at exactly 256MB. Not very fun to debug.
234 *
235 * Handling rollover, and having an inited variable,
236 * makes things work.
237 */
238
239 /* handle rollover */
240 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
241
242 /* flush buffer if overflow */
243 if ((dfu->i_buf + size) > dfu->i_buf_end) {
3ee9593f
SW
244 ret = dfu_write_buffer_drain(dfu);
245 if (ret) {
246 dfu_write_transaction_cleanup(dfu);
247 return ret;
248 }
ea2453d5 249 }
f22b11c1 250
ea2453d5
PA
251 /* we should be in buffer now (if not then size too large) */
252 if ((dfu->i_buf + size) > dfu->i_buf_end) {
a7d2c3cd
ŁM
253 error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
254 size, dfu->i_buf_end);
3ee9593f 255 dfu_write_transaction_cleanup(dfu);
ea2453d5
PA
256 return -1;
257 }
258
259 memcpy(dfu->i_buf, buf, size);
260 dfu->i_buf += size;
261
262 /* if end or if buffer full flush */
263 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
3ee9593f
SW
264 ret = dfu_write_buffer_drain(dfu);
265 if (ret) {
266 dfu_write_transaction_cleanup(dfu);
267 return ret;
268 }
ea2453d5
PA
269 }
270
3ee9593f 271 return 0;
ea2453d5
PA
272}
273
274static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
275{
276 long chunk;
277 int ret, readn;
278
279 readn = 0;
280 while (size > 0) {
281 /* get chunk that can be read */
b4141195 282 chunk = min((long)size, dfu->b_left);
ea2453d5
PA
283 /* consume */
284 if (chunk > 0) {
285 memcpy(buf, dfu->i_buf, chunk);
bd694244
ŁM
286 if (dfu_hash_algo)
287 dfu_hash_algo->hash_update(dfu_hash_algo,
288 &dfu->crc, buf,
289 chunk, 0);
290
ea2453d5
PA
291 dfu->i_buf += chunk;
292 dfu->b_left -= chunk;
293 size -= chunk;
294 buf += chunk;
295 readn += chunk;
296 }
297
298 /* all done */
299 if (size > 0) {
300 /* no more to read */
301 if (dfu->r_left == 0)
302 break;
303
304 dfu->i_buf = dfu->i_buf_start;
305 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
306
307 /* got to read, but buffer is empty */
308 if (dfu->b_left > dfu->r_left)
309 dfu->b_left = dfu->r_left;
310 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
311 &dfu->b_left);
312 if (ret != 0) {
313 debug("%s: Read error!\n", __func__);
314 return ret;
315 }
316 dfu->offset += dfu->b_left;
317 dfu->r_left -= dfu->b_left;
318
319 puts("#");
320 }
321 }
322
323 return readn;
f22b11c1
ŁM
324}
325
326int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
327{
f22b11c1
ŁM
328 int ret = 0;
329
330 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
ea2453d5
PA
331 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
332
333 if (!dfu->inited) {
7ac1b410 334 dfu->i_buf_start = dfu_get_buf(dfu);
9df49553
ŁM
335 if (dfu->i_buf_start == NULL)
336 return -ENOMEM;
337
0e285b50
SW
338 dfu->r_left = dfu->get_medium_size(dfu);
339 if (dfu->r_left < 0)
340 return dfu->r_left;
341 switch (dfu->layout) {
342 case DFU_RAW_ADDR:
343 case DFU_RAM_ADDR:
344 break;
345 default:
67ab0a5e 346 if (dfu->r_left > dfu_buf_size) {
0e285b50
SW
347 printf("%s: File too big for buffer\n",
348 __func__);
349 return -EOVERFLOW;
350 }
ea2453d5
PA
351 }
352
353 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left);
354
355 dfu->i_blk_seq_num = 0;
356 dfu->crc = 0;
357 dfu->offset = 0;
7ac1b410 358 dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
ea2453d5 359 dfu->i_buf = dfu->i_buf_start;
0e285b50 360 dfu->b_left = 0;
ea2453d5 361
c6631764
PA
362 dfu->bad_skip = 0;
363
ea2453d5 364 dfu->inited = 1;
f22b11c1
ŁM
365 }
366
ea2453d5 367 if (dfu->i_blk_seq_num != blk_seq_num) {
f22b11c1 368 printf("%s: Wrong sequence number! [%d] [%d]\n",
ea2453d5 369 __func__, dfu->i_blk_seq_num, blk_seq_num);
f22b11c1
ŁM
370 return -1;
371 }
ea2453d5
PA
372 /* handle rollover */
373 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
f22b11c1 374
ea2453d5
PA
375 ret = dfu_read_buffer_fill(dfu, buf, size);
376 if (ret < 0) {
377 printf("%s: Failed to fill buffer\n", __func__);
378 return -1;
f22b11c1 379 }
ea2453d5
PA
380
381 if (ret < size) {
bd694244
ŁM
382 if (dfu_hash_algo)
383 debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
384 dfu_hash_algo->name, dfu->crc);
ea2453d5
PA
385 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
386
387 dfu->i_blk_seq_num = 0;
388 dfu->crc = 0;
389 dfu->offset = 0;
390 dfu->i_buf_start = dfu_buf;
e7e75c70 391 dfu->i_buf_end = dfu_buf;
ea2453d5
PA
392 dfu->i_buf = dfu->i_buf_start;
393 dfu->b_left = 0;
394
c6631764
PA
395 dfu->bad_skip = 0;
396
ea2453d5
PA
397 dfu->inited = 0;
398 }
399
f22b11c1
ŁM
400 return ret;
401}
402
403static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
dd64827e 404 char *interface, char *devstr)
f22b11c1
ŁM
405{
406 char *st;
407
dd64827e 408 debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
f22b11c1
ŁM
409 st = strsep(&s, " ");
410 strcpy(dfu->name, st);
411
f22b11c1 412 dfu->alt = alt;
7ac1b410 413 dfu->max_buf_size = 0;
cb7bd2e0 414 dfu->free_entity = NULL;
f22b11c1
ŁM
415
416 /* Specific for mmc device */
417 if (strcmp(interface, "mmc") == 0) {
dd64827e 418 if (dfu_fill_entity_mmc(dfu, devstr, s))
f22b11c1 419 return -1;
c6631764 420 } else if (strcmp(interface, "nand") == 0) {
dd64827e 421 if (dfu_fill_entity_nand(dfu, devstr, s))
c6631764 422 return -1;
a9479f04 423 } else if (strcmp(interface, "ram") == 0) {
dd64827e 424 if (dfu_fill_entity_ram(dfu, devstr, s))
a9479f04 425 return -1;
6f12ebf6
SW
426 } else if (strcmp(interface, "sf") == 0) {
427 if (dfu_fill_entity_sf(dfu, devstr, s))
428 return -1;
f22b11c1
ŁM
429 } else {
430 printf("%s: Device %s not (yet) supported!\n",
431 __func__, interface);
432 return -1;
433 }
806bd245 434 dfu_get_buf(dfu);
f22b11c1
ŁM
435
436 return 0;
437}
438
439void dfu_free_entities(void)
440{
441 struct dfu_entity *dfu, *p, *t = NULL;
442
806bd245 443 dfu_free_buf();
f22b11c1
ŁM
444 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
445 list_del(&dfu->list);
cb7bd2e0
SW
446 if (dfu->free_entity)
447 dfu->free_entity(dfu);
f22b11c1
ŁM
448 t = dfu;
449 }
450 if (t)
451 free(t);
452 INIT_LIST_HEAD(&dfu_list);
b627eb46
PM
453
454 alt_num_cnt = 0;
f22b11c1
ŁM
455}
456
dd64827e 457int dfu_config_entities(char *env, char *interface, char *devstr)
f22b11c1
ŁM
458{
459 struct dfu_entity *dfu;
460 int i, ret;
461 char *s;
462
463 dfu_alt_num = dfu_find_alt_num(env);
464 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
465
bd694244
ŁM
466 dfu_hash_algo = NULL;
467 s = dfu_get_hash_algo();
468 if (s) {
469 ret = hash_lookup_algo(s, &dfu_hash_algo);
470 if (ret)
471 error("Hash algorithm %s not supported\n", s);
472 }
473
f22b11c1
ŁM
474 dfu = calloc(sizeof(*dfu), dfu_alt_num);
475 if (!dfu)
476 return -1;
477 for (i = 0; i < dfu_alt_num; i++) {
478
479 s = strsep(&env, ";");
dd64827e
SW
480 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
481 devstr);
f22b11c1
ŁM
482 if (ret)
483 return -1;
484
485 list_add_tail(&dfu[i].list, &dfu_list);
b627eb46 486 alt_num_cnt++;
f22b11c1
ŁM
487 }
488
489 return 0;
490}
491
492const char *dfu_get_dev_type(enum dfu_device_type t)
493{
a9479f04 494 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM" };
f22b11c1
ŁM
495 return dev_t[t];
496}
497
498const char *dfu_get_layout(enum dfu_layout l)
499{
500 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
a9479f04 501 "EXT3", "EXT4", "RAM_ADDR" };
f22b11c1
ŁM
502 return dfu_layout[l];
503}
504
505void dfu_show_entities(void)
506{
507 struct dfu_entity *dfu;
508
509 puts("DFU alt settings list:\n");
510
511 list_for_each_entry(dfu, &dfu_list, list) {
512 printf("dev: %s alt: %d name: %s layout: %s\n",
513 dfu_get_dev_type(dfu->dev_type), dfu->alt,
514 dfu->name, dfu_get_layout(dfu->layout));
515 }
516}
517
518int dfu_get_alt_number(void)
519{
520 return dfu_alt_num;
521}
522
523struct dfu_entity *dfu_get_entity(int alt)
524{
525 struct dfu_entity *dfu;
526
527 list_for_each_entry(dfu, &dfu_list, list) {
528 if (dfu->alt == alt)
529 return dfu;
530 }
531
532 return NULL;
533}
fed936ed
ŁM
534
535int dfu_get_alt(char *name)
536{
537 struct dfu_entity *dfu;
5610b057 538 char *str;
fed936ed
ŁM
539
540 list_for_each_entry(dfu, &dfu_list, list) {
5610b057
ŁM
541 if (dfu->name[0] != '/') {
542 if (!strncmp(dfu->name, name, strlen(dfu->name)))
543 return dfu->alt;
544 } else {
545 /*
546 * One must also consider absolute path
547 * (/boot/bin/uImage) available at dfu->name when
548 * compared "plain" file name (uImage)
549 *
550 * It is the case for e.g. thor gadget where lthor SW
551 * sends only the file name, so only the very last part
552 * of path must be checked for equality
553 */
554
555 str = strstr(dfu->name, name);
556 if (!str)
557 continue;
558
559 /*
560 * Check if matching substring is the last element of
561 * dfu->name (uImage)
562 */
563 if (strlen(dfu->name) ==
564 ((str - dfu->name) + strlen(name)))
565 return dfu->alt;
566 }
fed936ed
ŁM
567 }
568
569 return -ENODEV;
570}
2092e461
LM
571
572int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
573{
574 unsigned long dfu_buf_size, write, left = size;
575 int i, ret = 0;
576 void *dp = buf;
577
578 /*
579 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
580 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
581 * into account.
582 */
583 dfu_get_buf(dfu);
584 dfu_buf_size = dfu_get_buf_size();
585 debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
586
587 for (i = 0; left > 0; i++) {
588 write = min(dfu_buf_size, left);
589
590 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
591 dp, left, write);
592 ret = dfu_write(dfu, dp, write, i);
593 if (ret) {
594 error("DFU write failed\n");
595 return ret;
596 }
597
598 dp += write;
599 left -= write;
600 }
601
602 ret = dfu_flush(dfu, NULL, 0, i);
603 if (ret)
604 error("DFU flush failed!");
605
606 return ret;
607}