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