Prepare v2023.10
[platform/kernel/u-boot.git] / drivers / dfu / dfu.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * dfu.c -- DFU back-end routines
4  *
5  * Copyright (C) 2012 Samsung Electronics
6  * author: Lukasz Majewski <l.majewski@samsung.com>
7  */
8
9 #include <common.h>
10 #include <env.h>
11 #include <errno.h>
12 #include <log.h>
13 #include <malloc.h>
14 #include <mmc.h>
15 #include <fat.h>
16 #include <dfu.h>
17 #include <hash.h>
18 #include <linux/list.h>
19 #include <linux/compiler.h>
20
21 LIST_HEAD(dfu_list);
22 static int dfu_alt_num;
23 static int alt_num_cnt;
24 static struct hash_algo *dfu_hash_algo;
25 #ifdef CONFIG_DFU_TIMEOUT
26 static unsigned long dfu_timeout = 0;
27 #endif
28
29 bool dfu_reinit_needed = false;
30
31 /*
32  * The purpose of the dfu_flush_callback() function is to
33  * provide callback for dfu user
34  */
35 __weak void dfu_flush_callback(struct dfu_entity *dfu)
36 {
37 }
38
39 /*
40  * The purpose of the dfu_initiated_callback() function is to
41  * provide callback for dfu user
42  */
43 __weak void dfu_initiated_callback(struct dfu_entity *dfu)
44 {
45 }
46
47 /*
48  * The purpose of the dfu_error_callback() function is to
49  * provide callback for dfu user
50  */
51 __weak void dfu_error_callback(struct dfu_entity *dfu, const char *msg)
52 {
53 }
54
55 /*
56  * The purpose of the dfu_usb_get_reset() function is to
57  * provide information if after USB_DETACH request
58  * being sent the dfu-util performed reset of USB
59  * bus.
60  *
61  * Described behaviour is the only way to distinct if
62  * user has typed -e (detach) or -R (reset) when invoking
63  * dfu-util command.
64  *
65  */
66 __weak bool dfu_usb_get_reset(void)
67 {
68 #ifdef CONFIG_SPL_DFU_NO_RESET
69         return false;
70 #else
71         return true;
72 #endif
73 }
74
75 #ifdef CONFIG_DFU_TIMEOUT
76 void dfu_set_timeout(unsigned long timeout)
77 {
78         dfu_timeout = timeout;
79 }
80
81 unsigned long dfu_get_timeout(void)
82 {
83         return dfu_timeout;
84 }
85 #endif
86
87 static int dfu_find_alt_num(const char *s)
88 {
89         int i = 0;
90
91         for (; *s; s++)
92                 if (*s == ';')
93                         i++;
94
95         return ++i;
96 }
97
98 /*
99  * treat dfu_alt_info with several interface information
100  * to allow DFU on several device with one command,
101  * the string format is
102  * interface devstring'='alternate list (';' separated)
103  * and each interface separated by '&'
104  */
105 int dfu_config_interfaces(char *env)
106 {
107         struct dfu_entity *dfu;
108         char *s, *i, *d, *a, *part;
109         int ret = -EINVAL;
110         int n = 1;
111
112         s = env;
113         for (; *s; s++) {
114                 if (*s == ';')
115                         n++;
116                 if (*s == '&')
117                         n++;
118         }
119         ret = dfu_alt_init(n, &dfu);
120         if (ret)
121                 return ret;
122
123         s = env;
124         while (s) {
125                 ret = -EINVAL;
126                 i = strsep(&s, " \t");
127                 if (!i)
128                         break;
129                 s = skip_spaces(s);
130                 d = strsep(&s, "=");
131                 if (!d)
132                         break;
133                 a = strsep(&s, "&");
134                 if (!a)
135                         a = s;
136                 do {
137                         part = strsep(&a, ";");
138                         part = skip_spaces(part);
139                         ret = dfu_alt_add(dfu, i, d, part);
140                         if (ret)
141                                 return ret;
142                 } while (a);
143         }
144
145         return ret;
146 }
147
148 int dfu_init_env_entities(char *interface, char *devstr)
149 {
150         const char *str_env;
151         char *env_bkp;
152         int ret = 0;
153
154         dfu_reinit_needed = false;
155
156 #ifdef CONFIG_SET_DFU_ALT_INFO
157         set_dfu_alt_info(interface, devstr);
158 #endif
159         str_env = env_get("dfu_alt_info");
160         if (!str_env) {
161                 pr_err("\"dfu_alt_info\" env variable not defined!\n");
162                 return -EINVAL;
163         }
164
165         env_bkp = strdup(str_env);
166         if (!interface && !devstr)
167                 ret = dfu_config_interfaces(env_bkp);
168         else
169                 ret = dfu_config_entities(env_bkp, interface, devstr);
170
171         if (ret) {
172                 pr_err("DFU entities configuration failed!\n");
173                 pr_err("(partition table does not match dfu_alt_info?)\n");
174                 goto done;
175         }
176
177 done:
178         free(env_bkp);
179         return ret;
180 }
181
182 static unsigned char *dfu_buf;
183 static unsigned long dfu_buf_size;
184 static enum dfu_device_type dfu_buf_device_type;
185
186 unsigned char *dfu_free_buf(void)
187 {
188         free(dfu_buf);
189         dfu_buf = NULL;
190         return dfu_buf;
191 }
192
193 unsigned long dfu_get_buf_size(void)
194 {
195         return dfu_buf_size;
196 }
197
198 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
199 {
200         char *s;
201
202         /* manage several entity with several contraint */
203         if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
204                 dfu_free_buf();
205
206         if (dfu_buf != NULL)
207                 return dfu_buf;
208
209         s = env_get("dfu_bufsiz");
210         if (s)
211                 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
212
213         if (!s || !dfu_buf_size)
214                 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
215
216         if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
217                 dfu_buf_size = dfu->max_buf_size;
218
219         dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
220         if (dfu_buf == NULL)
221                 printf("%s: Could not memalign 0x%lx bytes\n",
222                        __func__, dfu_buf_size);
223
224         dfu_buf_device_type = dfu->dev_type;
225         return dfu_buf;
226 }
227
228 static char *dfu_get_hash_algo(void)
229 {
230         char *s;
231
232         s = env_get("dfu_hash_algo");
233         if (!s)
234                 return NULL;
235
236         if (!strcmp(s, "crc32")) {
237                 debug("%s: DFU hash method: %s\n", __func__, s);
238                 return s;
239         }
240
241         pr_err("DFU hash method: %s not supported!\n", s);
242         return NULL;
243 }
244
245 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
246 {
247         long w_size;
248         int ret;
249
250         /* flush size? */
251         w_size = dfu->i_buf - dfu->i_buf_start;
252         if (w_size == 0)
253                 return 0;
254
255         if (dfu_hash_algo)
256                 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
257                                            dfu->i_buf_start, w_size, 0);
258
259         ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
260         if (ret)
261                 debug("%s: Write error!\n", __func__);
262
263         /* point back */
264         dfu->i_buf = dfu->i_buf_start;
265
266         /* update offset */
267         dfu->offset += w_size;
268
269         puts("#");
270
271         return ret;
272 }
273
274 void dfu_transaction_cleanup(struct dfu_entity *dfu)
275 {
276         /* clear everything */
277         dfu->crc = 0;
278         dfu->offset = 0;
279         dfu->i_blk_seq_num = 0;
280         dfu->i_buf_start = dfu_get_buf(dfu);
281         dfu->i_buf_end = dfu->i_buf_start;
282         dfu->i_buf = dfu->i_buf_start;
283         dfu->r_left = 0;
284         dfu->b_left = 0;
285         dfu->bad_skip = 0;
286
287         dfu->inited = 0;
288 }
289
290 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
291 {
292         int ret = 0;
293
294         if (dfu->inited)
295                 return 0;
296
297         dfu_transaction_cleanup(dfu);
298
299         if (dfu->i_buf_start == NULL)
300                 return -ENOMEM;
301
302         dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
303
304         if (read) {
305                 ret = dfu->get_medium_size(dfu, &dfu->r_left);
306                 if (ret < 0)
307                         return ret;
308                 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
309         }
310
311         dfu->inited = 1;
312         dfu_initiated_callback(dfu);
313
314         return 0;
315 }
316
317 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
318 {
319         int ret = 0;
320
321         ret = dfu_write_buffer_drain(dfu);
322         if (ret)
323                 return ret;
324
325         if (dfu->flush_medium)
326                 ret = dfu->flush_medium(dfu);
327
328         if (dfu_hash_algo)
329                 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
330                        dfu->crc);
331
332         dfu_flush_callback(dfu);
333
334         dfu_transaction_cleanup(dfu);
335
336         return ret;
337 }
338
339 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
340 {
341         int ret;
342
343         debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
344               __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
345               (unsigned long)(dfu->i_buf - dfu->i_buf_start));
346
347         ret = dfu_transaction_initiate(dfu, false);
348         if (ret < 0)
349                 return ret;
350
351         if (dfu->i_blk_seq_num != blk_seq_num) {
352                 printf("%s: Wrong sequence number! [%d] [%d]\n",
353                        __func__, dfu->i_blk_seq_num, blk_seq_num);
354                 dfu_transaction_cleanup(dfu);
355                 dfu_error_callback(dfu, "Wrong sequence number");
356                 return -1;
357         }
358
359         /* DFU 1.1 standard says:
360          * The wBlockNum field is a block sequence number. It increments each
361          * time a block is transferred, wrapping to zero from 65,535. It is used
362          * to provide useful context to the DFU loader in the device."
363          *
364          * This means that it's a 16 bit counter that roll-overs at
365          * 0xffff -> 0x0000. By having a typical 4K transfer block
366          * we roll-over at exactly 256MB. Not very fun to debug.
367          *
368          * Handling rollover, and having an inited variable,
369          * makes things work.
370          */
371
372         /* handle rollover */
373         dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
374
375         /* flush buffer if overflow */
376         if ((dfu->i_buf + size) > dfu->i_buf_end) {
377                 ret = dfu_write_buffer_drain(dfu);
378                 if (ret) {
379                         dfu_transaction_cleanup(dfu);
380                         dfu_error_callback(dfu, "DFU write error");
381                         return ret;
382                 }
383         }
384
385         /* we should be in buffer now (if not then size too large) */
386         if ((dfu->i_buf + size) > dfu->i_buf_end) {
387                 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
388                       size, dfu->i_buf_end);
389                 dfu_transaction_cleanup(dfu);
390                 dfu_error_callback(dfu, "Buffer overflow");
391                 return -1;
392         }
393
394         memcpy(dfu->i_buf, buf, size);
395         dfu->i_buf += size;
396
397         /* if end or if buffer full flush */
398         if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
399                 ret = dfu_write_buffer_drain(dfu);
400                 if (ret) {
401                         dfu_transaction_cleanup(dfu);
402                         dfu_error_callback(dfu, "DFU write error");
403                         return ret;
404                 }
405         }
406
407         return 0;
408 }
409
410 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
411 {
412         long chunk;
413         int ret, readn;
414
415         readn = 0;
416         while (size > 0) {
417                 /* get chunk that can be read */
418                 chunk = min((long)size, dfu->b_left);
419                 /* consume */
420                 if (chunk > 0) {
421                         memcpy(buf, dfu->i_buf, chunk);
422                         if (dfu_hash_algo)
423                                 dfu_hash_algo->hash_update(dfu_hash_algo,
424                                                            &dfu->crc, buf,
425                                                            chunk, 0);
426
427                         dfu->i_buf += chunk;
428                         dfu->b_left -= chunk;
429                         size -= chunk;
430                         buf += chunk;
431                         readn += chunk;
432                 }
433
434                 /* all done */
435                 if (size > 0) {
436                         /* no more to read */
437                         if (dfu->r_left == 0)
438                                 break;
439
440                         dfu->i_buf = dfu->i_buf_start;
441                         dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
442
443                         /* got to read, but buffer is empty */
444                         if (dfu->b_left > dfu->r_left)
445                                 dfu->b_left = dfu->r_left;
446                         ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
447                                         &dfu->b_left);
448                         if (ret != 0) {
449                                 debug("%s: Read error!\n", __func__);
450                                 return ret;
451                         }
452                         if (dfu->b_left == 0)
453                                 break;
454                         dfu->offset += dfu->b_left;
455                         dfu->r_left -= dfu->b_left;
456
457                         puts("#");
458                 }
459         }
460
461         return readn;
462 }
463
464 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
465 {
466         int ret = 0;
467
468         debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
469                __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
470
471         ret = dfu_transaction_initiate(dfu, true);
472         if (ret < 0)
473                 return ret;
474
475         if (dfu->i_blk_seq_num != blk_seq_num) {
476                 printf("%s: Wrong sequence number! [%d] [%d]\n",
477                        __func__, dfu->i_blk_seq_num, blk_seq_num);
478                 return -1;
479         }
480         /* handle rollover */
481         dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
482
483         ret = dfu_read_buffer_fill(dfu, buf, size);
484         if (ret < 0) {
485                 printf("%s: Failed to fill buffer\n", __func__);
486                 return -1;
487         }
488
489         if (ret < size) {
490                 if (dfu_hash_algo)
491                         debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
492                               dfu_hash_algo->name, dfu->crc);
493                 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
494
495                 dfu_transaction_cleanup(dfu);
496         }
497
498         return ret;
499 }
500
501 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
502                            char *interface, char *devstr)
503 {
504         char *argv[DFU_MAX_ENTITY_ARGS];
505         int argc;
506         char *st;
507
508         debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
509         st = strsep(&s, " \t");
510         strlcpy(dfu->name, st, DFU_NAME_SIZE);
511
512         /* Parse arguments */
513         for (argc = 0; s && argc < DFU_MAX_ENTITY_ARGS; argc++) {
514                 s = skip_spaces(s);
515                 if (!*s)
516                         break;
517                 argv[argc] = strsep(&s, " \t");
518         }
519
520         if (argc == DFU_MAX_ENTITY_ARGS && s) {
521                 s = skip_spaces(s);
522                 if (*s) {
523                         log_err("Too many arguments for %s\n", dfu->name);
524                         return -EINVAL;
525                 }
526         }
527
528         dfu->alt = alt;
529         dfu->max_buf_size = 0;
530         dfu->free_entity = NULL;
531
532         /* Specific for mmc device */
533         if (strcmp(interface, "mmc") == 0) {
534                 if (dfu_fill_entity_mmc(dfu, devstr, argv, argc))
535                         return -1;
536         } else if (strcmp(interface, "mtd") == 0) {
537                 if (dfu_fill_entity_mtd(dfu, devstr, argv, argc))
538                         return -1;
539         } else if (strcmp(interface, "nand") == 0) {
540                 if (dfu_fill_entity_nand(dfu, devstr, argv, argc))
541                         return -1;
542         } else if (strcmp(interface, "ram") == 0) {
543                 if (dfu_fill_entity_ram(dfu, devstr, argv, argc))
544                         return -1;
545         } else if (strcmp(interface, "sf") == 0) {
546                 if (dfu_fill_entity_sf(dfu, devstr, argv, argc))
547                         return -1;
548         } else if (strcmp(interface, "virt") == 0) {
549                 if (dfu_fill_entity_virt(dfu, devstr, argv, argc))
550                         return -1;
551         } else {
552                 printf("%s: Device %s not (yet) supported!\n",
553                        __func__,  interface);
554                 return -1;
555         }
556         dfu_get_buf(dfu);
557
558         return 0;
559 }
560
561 void dfu_free_entities(void)
562 {
563         struct dfu_entity *dfu, *p, *t = NULL;
564
565         dfu_free_buf();
566         list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
567                 list_del(&dfu->list);
568                 if (dfu->free_entity)
569                         dfu->free_entity(dfu);
570                 t = dfu;
571         }
572         if (t)
573                 free(t);
574         INIT_LIST_HEAD(&dfu_list);
575
576         alt_num_cnt = 0;
577 }
578
579 int dfu_alt_init(int num, struct dfu_entity **dfu)
580 {
581         char *s;
582         int ret;
583
584         dfu_alt_num = num;
585         debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
586
587         dfu_hash_algo = NULL;
588         s = dfu_get_hash_algo();
589         if (s) {
590                 ret = hash_lookup_algo(s, &dfu_hash_algo);
591                 if (ret)
592                         pr_err("Hash algorithm %s not supported\n", s);
593         }
594
595         *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
596         if (!*dfu)
597                 return -1;
598
599         return 0;
600 }
601
602 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
603 {
604         struct dfu_entity *p_dfu;
605         int ret;
606
607         if (alt_num_cnt >= dfu_alt_num)
608                 return -1;
609
610         p_dfu = &dfu[alt_num_cnt];
611         ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
612         if (ret)
613                 return -1;
614
615         list_add_tail(&p_dfu->list, &dfu_list);
616         alt_num_cnt++;
617
618         return 0;
619 }
620
621 int dfu_config_entities(char *env, char *interface, char *devstr)
622 {
623         struct dfu_entity *dfu;
624         int i, ret;
625         char *s;
626
627         ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
628         if (ret)
629                 return -1;
630
631         for (i = 0; i < dfu_alt_num; i++) {
632                 s = strsep(&env, ";");
633                 s = skip_spaces(s);
634                 ret = dfu_alt_add(dfu, interface, devstr, s);
635                 if (ret) {
636                         /* We will free "dfu" in dfu_free_entities() */
637                         return -1;
638                 }
639         }
640
641         return 0;
642 }
643
644 const char *dfu_get_dev_type(enum dfu_device_type t)
645 {
646         const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
647                                      "SF", "MTD", "VIRT"};
648         return dev_t[t];
649 }
650
651 const char *dfu_get_layout(enum dfu_layout l)
652 {
653         const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
654                                           "EXT3", "EXT4", "RAM_ADDR", "SKIP",
655                                           "SCRIPT" };
656         return dfu_layout[l];
657 }
658
659 void dfu_show_entities(void)
660 {
661         struct dfu_entity *dfu;
662
663         puts("DFU alt settings list:\n");
664
665         list_for_each_entry(dfu, &dfu_list, list) {
666                 printf("dev: %s alt: %d name: %s layout: %s\n",
667                        dfu_get_dev_type(dfu->dev_type), dfu->alt,
668                        dfu->name, dfu_get_layout(dfu->layout));
669         }
670 }
671
672 int dfu_get_alt_number(void)
673 {
674         return dfu_alt_num;
675 }
676
677 struct dfu_entity *dfu_get_entity(int alt)
678 {
679         struct dfu_entity *dfu;
680
681         list_for_each_entry(dfu, &dfu_list, list) {
682                 if (dfu->alt == alt)
683                         return dfu;
684         }
685
686         return NULL;
687 }
688
689 int dfu_get_alt(char *name)
690 {
691         struct dfu_entity *dfu;
692         char *str;
693
694         list_for_each_entry(dfu, &dfu_list, list) {
695                 if (dfu->name[0] != '/') {
696                         if (!strncmp(dfu->name, name, strlen(dfu->name)))
697                                 return dfu->alt;
698                 } else {
699                         /*
700                          * One must also consider absolute path
701                          * (/boot/bin/uImage) available at dfu->name when
702                          * compared "plain" file name (uImage)
703                          *
704                          * It is the case for e.g. thor gadget where lthor SW
705                          * sends only the file name, so only the very last part
706                          * of path must be checked for equality
707                          */
708
709                         str = strstr(dfu->name, name);
710                         if (!str)
711                                 continue;
712
713                         /*
714                          * Check if matching substring is the last element of
715                          * dfu->name (uImage)
716                          */
717                         if (strlen(dfu->name) ==
718                             ((str - dfu->name) + strlen(name)))
719                                 return dfu->alt;
720                 }
721         }
722
723         return -ENODEV;
724 }
725
726 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
727 {
728         unsigned long dfu_buf_size, write, left = size;
729         int i, ret = 0;
730         void *dp = buf;
731
732         /*
733          * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
734          * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
735          * into account.
736          */
737         dfu_get_buf(dfu);
738         dfu_buf_size = dfu_get_buf_size();
739         debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
740
741         for (i = 0; left > 0; i++) {
742                 write = min(dfu_buf_size, left);
743
744                 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
745                       dp, left, write);
746                 ret = dfu_write(dfu, dp, write, i);
747                 if (ret) {
748                         pr_err("DFU write failed\n");
749                         return ret;
750                 }
751
752                 dp += write;
753                 left -= write;
754         }
755
756         ret = dfu_flush(dfu, NULL, 0, i);
757         if (ret)
758                 pr_err("DFU flush failed!");
759         puts("\n");
760
761         return ret;
762 }