tools: kwboot: Fix kwboot_xm_sendblock() function when kwboot_tty_recv() fails
[platform/kernel/u-boot.git] / tools / kwboot.c
1 /*
2  * Boot a Marvell SoC, with Xmodem over UART0.
3  *  supports Kirkwood, Dove, Armada 370, Armada XP
4  *
5  * (c) 2012 Daniel Stodden <daniel.stodden@gmail.com>
6  *
7  * References: marvell.com, "88F6180, 88F6190, 88F6192, and 88F6281
8  *   Integrated Controller: Functional Specifications" December 2,
9  *   2008. Chapter 24.2 "BootROM Firmware".
10  */
11
12 #include "kwbimage.h"
13 #include "mkimage.h"
14 #include "version.h"
15
16 #include <stdlib.h>
17 #include <stdio.h>
18 #include <string.h>
19 #include <stdarg.h>
20 #include <image.h>
21 #include <libgen.h>
22 #include <fcntl.h>
23 #include <errno.h>
24 #include <unistd.h>
25 #include <stdint.h>
26 #include <termios.h>
27 #include <sys/mman.h>
28 #include <sys/stat.h>
29
30 /*
31  * Marvell BootROM UART Sensing
32  */
33
34 static unsigned char kwboot_msg_boot[] = {
35         0xBB, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
36 };
37
38 static unsigned char kwboot_msg_debug[] = {
39         0xDD, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
40 };
41
42 /* Defines known to work on Kirkwood */
43 #define KWBOOT_MSG_REQ_DELAY    10 /* ms */
44 #define KWBOOT_MSG_RSP_TIMEO    50 /* ms */
45
46 /* Defines known to work on Armada XP */
47 #define KWBOOT_MSG_REQ_DELAY_AXP        1000 /* ms */
48 #define KWBOOT_MSG_RSP_TIMEO_AXP        1000 /* ms */
49
50 /*
51  * Xmodem Transfers
52  */
53
54 #define SOH     1       /* sender start of block header */
55 #define EOT     4       /* sender end of block transfer */
56 #define ACK     6       /* target block ack */
57 #define NAK     21      /* target block negative ack */
58 #define CAN     24      /* target/sender transfer cancellation */
59
60 struct kwboot_block {
61         uint8_t soh;
62         uint8_t pnum;
63         uint8_t _pnum;
64         uint8_t data[128];
65         uint8_t csum;
66 } __packed;
67
68 #define KWBOOT_BLK_RSP_TIMEO 1000 /* ms */
69
70 static int kwboot_verbose;
71
72 static int msg_req_delay = KWBOOT_MSG_REQ_DELAY;
73 static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
74 static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
75
76 static ssize_t
77 kwboot_write(int fd, const char *buf, size_t len)
78 {
79         size_t tot = 0;
80
81         while (tot < len) {
82                 ssize_t wr = write(fd, buf + tot, len - tot);
83
84                 if (wr < 0)
85                         return -1;
86
87                 tot += wr;
88         }
89
90         return tot;
91 }
92
93 static void
94 kwboot_printv(const char *fmt, ...)
95 {
96         va_list ap;
97
98         if (kwboot_verbose) {
99                 va_start(ap, fmt);
100                 vprintf(fmt, ap);
101                 va_end(ap);
102                 fflush(stdout);
103         }
104 }
105
106 static void
107 __spinner(void)
108 {
109         const char seq[] = { '-', '\\', '|', '/' };
110         const int div = 8;
111         static int state, bs;
112
113         if (state % div == 0) {
114                 fputc(bs, stdout);
115                 fputc(seq[state / div % sizeof(seq)], stdout);
116                 fflush(stdout);
117         }
118
119         bs = '\b';
120         state++;
121 }
122
123 static void
124 kwboot_spinner(void)
125 {
126         if (kwboot_verbose)
127                 __spinner();
128 }
129
130 static void
131 __progress(int pct, char c)
132 {
133         const int width = 70;
134         static const char *nl = "";
135         static int pos;
136
137         if (pos % width == 0)
138                 printf("%s%3d %% [", nl, pct);
139
140         fputc(c, stdout);
141
142         nl = "]\n";
143         pos++;
144
145         if (pct == 100) {
146                 while (pos++ < width)
147                         fputc(' ', stdout);
148                 fputs(nl, stdout);
149         }
150
151         fflush(stdout);
152
153 }
154
155 static void
156 kwboot_progress(int _pct, char c)
157 {
158         static int pct;
159
160         if (_pct != -1)
161                 pct = _pct;
162
163         if (kwboot_verbose)
164                 __progress(pct, c);
165 }
166
167 static int
168 kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
169 {
170         int rc, nfds;
171         fd_set rfds;
172         struct timeval tv;
173         ssize_t n;
174
175         rc = -1;
176
177         FD_ZERO(&rfds);
178         FD_SET(fd, &rfds);
179
180         tv.tv_sec = 0;
181         tv.tv_usec = timeo * 1000;
182         if (tv.tv_usec > 1000000) {
183                 tv.tv_sec += tv.tv_usec / 1000000;
184                 tv.tv_usec %= 1000000;
185         }
186
187         do {
188                 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
189                 if (nfds < 0)
190                         goto out;
191                 if (!nfds) {
192                         errno = ETIMEDOUT;
193                         goto out;
194                 }
195
196                 n = read(fd, buf, len);
197                 if (n <= 0)
198                         goto out;
199
200                 buf = (char *)buf + n;
201                 len -= n;
202         } while (len > 0);
203
204         rc = 0;
205 out:
206         return rc;
207 }
208
209 static int
210 kwboot_tty_send(int fd, const void *buf, size_t len)
211 {
212         if (!buf)
213                 return 0;
214
215         if (kwboot_write(fd, buf, len) < 0)
216                 return -1;
217
218         return tcdrain(fd);
219 }
220
221 static int
222 kwboot_tty_send_char(int fd, unsigned char c)
223 {
224         return kwboot_tty_send(fd, &c, 1);
225 }
226
227 static speed_t
228 kwboot_tty_speed(int baudrate)
229 {
230         switch (baudrate) {
231         case 115200:
232                 return B115200;
233         case 57600:
234                 return B57600;
235         case 38400:
236                 return B38400;
237         case 19200:
238                 return B19200;
239         case 9600:
240                 return B9600;
241         }
242
243         return -1;
244 }
245
246 static int
247 kwboot_open_tty(const char *path, speed_t speed)
248 {
249         int rc, fd;
250         struct termios tio;
251
252         rc = -1;
253
254         fd = open(path, O_RDWR|O_NOCTTY|O_NDELAY);
255         if (fd < 0)
256                 goto out;
257
258         memset(&tio, 0, sizeof(tio));
259
260         tio.c_iflag = 0;
261         tio.c_cflag = CREAD|CLOCAL|CS8;
262
263         tio.c_cc[VMIN] = 1;
264         tio.c_cc[VTIME] = 10;
265
266         cfsetospeed(&tio, speed);
267         cfsetispeed(&tio, speed);
268
269         rc = tcsetattr(fd, TCSANOW, &tio);
270         if (rc)
271                 goto out;
272
273         rc = fd;
274 out:
275         if (rc < 0) {
276                 if (fd >= 0)
277                         close(fd);
278         }
279
280         return rc;
281 }
282
283 static int
284 kwboot_bootmsg(int tty, void *msg)
285 {
286         int rc;
287         char c;
288         int count;
289
290         if (msg == NULL)
291                 kwboot_printv("Please reboot the target into UART boot mode...");
292         else
293                 kwboot_printv("Sending boot message. Please reboot the target...");
294
295         do {
296                 rc = tcflush(tty, TCIOFLUSH);
297                 if (rc)
298                         break;
299
300                 for (count = 0; count < 128; count++) {
301                         rc = kwboot_tty_send(tty, msg, 8);
302                         if (rc) {
303                                 usleep(msg_req_delay * 1000);
304                                 continue;
305                         }
306                 }
307
308                 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
309
310                 kwboot_spinner();
311
312         } while (rc || c != NAK);
313
314         kwboot_printv("\n");
315
316         return rc;
317 }
318
319 static int
320 kwboot_debugmsg(int tty, void *msg)
321 {
322         int rc;
323
324         kwboot_printv("Sending debug message. Please reboot the target...");
325
326         do {
327                 char buf[16];
328
329                 rc = tcflush(tty, TCIOFLUSH);
330                 if (rc)
331                         break;
332
333                 rc = kwboot_tty_send(tty, msg, 8);
334                 if (rc) {
335                         usleep(msg_req_delay * 1000);
336                         continue;
337                 }
338
339                 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
340
341                 kwboot_spinner();
342
343         } while (rc);
344
345         kwboot_printv("\n");
346
347         return rc;
348 }
349
350 static int
351 kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
352                     size_t size, int pnum)
353 {
354         const size_t blksz = sizeof(block->data);
355         size_t n;
356         int i;
357
358         block->soh = SOH;
359         block->pnum = pnum;
360         block->_pnum = ~block->pnum;
361
362         n = size < blksz ? size : blksz;
363         memcpy(&block->data[0], data, n);
364         memset(&block->data[n], 0, blksz - n);
365
366         block->csum = 0;
367         for (i = 0; i < n; i++)
368                 block->csum += block->data[i];
369
370         return n;
371 }
372
373 static int
374 kwboot_xm_sendblock(int fd, struct kwboot_block *block)
375 {
376         int rc, retries;
377         char c;
378
379         retries = 16;
380         do {
381                 rc = kwboot_tty_send(fd, block, sizeof(*block));
382                 if (rc)
383                         return rc;
384
385                 do {
386                         rc = kwboot_tty_recv(fd, &c, 1, blk_rsp_timeo);
387                         if (rc) {
388                                 if (errno != ETIMEDOUT)
389                                         return rc;
390                                 c = NAK;
391                         }
392
393                         if (c != ACK && c != NAK && c != CAN)
394                                 printf("%c", c);
395
396                 } while (c != ACK && c != NAK && c != CAN);
397
398                 if (c != ACK)
399                         kwboot_progress(-1, '+');
400
401         } while (c == NAK && retries-- > 0);
402
403         rc = -1;
404
405         switch (c) {
406         case ACK:
407                 rc = 0;
408                 break;
409         case NAK:
410                 errno = EBADMSG;
411                 break;
412         case CAN:
413                 errno = ECANCELED;
414                 break;
415         default:
416                 errno = EPROTO;
417                 break;
418         }
419
420         return rc;
421 }
422
423 static int
424 kwboot_xmodem(int tty, const void *_data, size_t size)
425 {
426         const uint8_t *data = _data;
427         int rc, pnum, N, err;
428
429         pnum = 1;
430         N = 0;
431
432         kwboot_printv("Sending boot image...\n");
433
434         sleep(2); /* flush isn't effective without it */
435         tcflush(tty, TCIOFLUSH);
436
437         do {
438                 struct kwboot_block block;
439                 int n;
440
441                 n = kwboot_xm_makeblock(&block,
442                                         data + N, size - N,
443                                         pnum++);
444                 if (n < 0)
445                         goto can;
446
447                 if (!n)
448                         break;
449
450                 rc = kwboot_xm_sendblock(tty, &block);
451                 if (rc)
452                         goto out;
453
454                 N += n;
455                 kwboot_progress(N * 100 / size, '.');
456         } while (1);
457
458         rc = kwboot_tty_send_char(tty, EOT);
459
460 out:
461         return rc;
462
463 can:
464         err = errno;
465         kwboot_tty_send_char(tty, CAN);
466         errno = err;
467         goto out;
468 }
469
470 static int
471 kwboot_term_pipe(int in, int out, const char *quit, int *s)
472 {
473         ssize_t nin;
474         char _buf[128], *buf = _buf;
475
476         nin = read(in, buf, sizeof(_buf));
477         if (nin <= 0)
478                 return -1;
479
480         if (quit) {
481                 int i;
482
483                 for (i = 0; i < nin; i++) {
484                         if (*buf == quit[*s]) {
485                                 (*s)++;
486                                 if (!quit[*s])
487                                         return 0;
488                                 buf++;
489                                 nin--;
490                         } else {
491                                 if (kwboot_write(out, quit, *s) < 0)
492                                         return -1;
493                                 *s = 0;
494                         }
495                 }
496         }
497
498         if (kwboot_write(out, buf, nin) < 0)
499                 return -1;
500
501         return 0;
502 }
503
504 static int
505 kwboot_terminal(int tty)
506 {
507         int rc, in, s;
508         const char *quit = "\34c";
509         struct termios otio, tio;
510
511         rc = -1;
512
513         in = STDIN_FILENO;
514         if (isatty(in)) {
515                 rc = tcgetattr(in, &otio);
516                 if (!rc) {
517                         tio = otio;
518                         cfmakeraw(&tio);
519                         rc = tcsetattr(in, TCSANOW, &tio);
520                 }
521                 if (rc) {
522                         perror("tcsetattr");
523                         goto out;
524                 }
525
526                 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
527                               quit[0]|0100, quit[1]);
528         } else
529                 in = -1;
530
531         rc = 0;
532         s = 0;
533
534         do {
535                 fd_set rfds;
536                 int nfds = 0;
537
538                 FD_SET(tty, &rfds);
539                 nfds = nfds < tty ? tty : nfds;
540
541                 if (in >= 0) {
542                         FD_SET(in, &rfds);
543                         nfds = nfds < in ? in : nfds;
544                 }
545
546                 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
547                 if (nfds < 0)
548                         break;
549
550                 if (FD_ISSET(tty, &rfds)) {
551                         rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
552                         if (rc)
553                                 break;
554                 }
555
556                 if (in >= 0 && FD_ISSET(in, &rfds)) {
557                         rc = kwboot_term_pipe(in, tty, quit, &s);
558                         if (rc)
559                                 break;
560                 }
561         } while (quit[s] != 0);
562
563         if (in >= 0)
564                 tcsetattr(in, TCSANOW, &otio);
565         printf("\n");
566 out:
567         return rc;
568 }
569
570 static void *
571 kwboot_mmap_image(const char *path, size_t *size, int prot)
572 {
573         int rc, fd, flags;
574         struct stat st;
575         void *img;
576
577         rc = -1;
578         img = NULL;
579
580         fd = open(path, O_RDONLY);
581         if (fd < 0)
582                 goto out;
583
584         rc = fstat(fd, &st);
585         if (rc)
586                 goto out;
587
588         flags = (prot & PROT_WRITE) ? MAP_PRIVATE : MAP_SHARED;
589
590         img = mmap(NULL, st.st_size, prot, flags, fd, 0);
591         if (img == MAP_FAILED) {
592                 img = NULL;
593                 goto out;
594         }
595
596         rc = 0;
597         *size = st.st_size;
598 out:
599         if (rc && img) {
600                 munmap(img, st.st_size);
601                 img = NULL;
602         }
603         if (fd >= 0)
604                 close(fd);
605
606         return img;
607 }
608
609 static uint8_t
610 kwboot_img_csum8(void *_data, size_t size)
611 {
612         uint8_t *data = _data, csum;
613
614         for (csum = 0; size-- > 0; data++)
615                 csum += *data;
616
617         return csum;
618 }
619
620 static int
621 kwboot_img_patch_hdr(void *img, size_t size)
622 {
623         int rc;
624         struct main_hdr_v1 *hdr;
625         uint8_t csum;
626         size_t hdrsz = sizeof(*hdr);
627         int image_ver;
628
629         rc = -1;
630         hdr = img;
631
632         if (size < hdrsz) {
633                 errno = EINVAL;
634                 goto out;
635         }
636
637         image_ver = image_version(img);
638         if (image_ver != 0 && image_ver != 1) {
639                 fprintf(stderr, "Invalid image header version\n");
640                 errno = EINVAL;
641                 goto out;
642         }
643
644         if (image_ver == 0)
645                 hdrsz = sizeof(*hdr);
646         else
647                 hdrsz = KWBHEADER_V1_SIZE(hdr);
648
649         if (size < hdrsz) {
650                 errno = EINVAL;
651                 goto out;
652         }
653
654         csum = kwboot_img_csum8(hdr, hdrsz) - hdr->checksum;
655         if (csum != hdr->checksum) {
656                 errno = EINVAL;
657                 goto out;
658         }
659
660         if (hdr->blockid == IBR_HDR_UART_ID) {
661                 rc = 0;
662                 goto out;
663         }
664
665         hdr->blockid = IBR_HDR_UART_ID;
666
667         if (image_ver == 0) {
668                 struct main_hdr_v0 *hdr_v0 = img;
669
670                 hdr_v0->nandeccmode = IBR_HDR_ECC_DISABLED;
671                 hdr_v0->nandpagesize = 0;
672
673                 hdr_v0->srcaddr = hdr_v0->ext
674                         ? sizeof(struct kwb_header)
675                         : sizeof(*hdr_v0);
676         }
677
678         hdr->checksum = kwboot_img_csum8(hdr, hdrsz) - csum;
679
680         rc = 0;
681 out:
682         return rc;
683 }
684
685 static void
686 kwboot_usage(FILE *stream, char *progname)
687 {
688         fprintf(stream, "kwboot version %s\n", PLAIN_VERSION);
689         fprintf(stream,
690                 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
691                 progname);
692         fprintf(stream, "\n");
693         fprintf(stream,
694                 "  -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
695         fprintf(stream, "  -p: patch <image> to type 0x69 (uart boot)\n");
696         fprintf(stream,
697                 "  -D <image>: boot <image> without preamble (Dove)\n");
698         fprintf(stream, "  -d: enter debug mode\n");
699         fprintf(stream, "  -a: use timings for Armada XP\n");
700         fprintf(stream, "  -q <req-delay>:  use specific request-delay\n");
701         fprintf(stream, "  -s <resp-timeo>: use specific response-timeout\n");
702         fprintf(stream,
703                 "  -o <block-timeo>: use specific xmodem block timeout\n");
704         fprintf(stream, "\n");
705         fprintf(stream, "  -t: mini terminal\n");
706         fprintf(stream, "\n");
707         fprintf(stream, "  -B <baud>: set baud rate\n");
708         fprintf(stream, "\n");
709 }
710
711 int
712 main(int argc, char **argv)
713 {
714         const char *ttypath, *imgpath;
715         int rv, rc, tty, term, prot, patch;
716         void *bootmsg;
717         void *debugmsg;
718         void *img;
719         size_t size;
720         speed_t speed;
721
722         rv = 1;
723         tty = -1;
724         bootmsg = NULL;
725         debugmsg = NULL;
726         imgpath = NULL;
727         img = NULL;
728         term = 0;
729         patch = 0;
730         size = 0;
731         speed = B115200;
732
733         kwboot_verbose = isatty(STDOUT_FILENO);
734
735         do {
736                 int c = getopt(argc, argv, "hb:ptaB:dD:q:s:o:");
737                 if (c < 0)
738                         break;
739
740                 switch (c) {
741                 case 'b':
742                         bootmsg = kwboot_msg_boot;
743                         imgpath = optarg;
744                         break;
745
746                 case 'D':
747                         bootmsg = NULL;
748                         imgpath = optarg;
749                         break;
750
751                 case 'd':
752                         debugmsg = kwboot_msg_debug;
753                         break;
754
755                 case 'p':
756                         patch = 1;
757                         break;
758
759                 case 't':
760                         term = 1;
761                         break;
762
763                 case 'a':
764                         msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
765                         msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
766                         break;
767
768                 case 'q':
769                         msg_req_delay = atoi(optarg);
770                         break;
771
772                 case 's':
773                         msg_rsp_timeo = atoi(optarg);
774                         break;
775
776                 case 'o':
777                         blk_rsp_timeo = atoi(optarg);
778                         break;
779
780                 case 'B':
781                         speed = kwboot_tty_speed(atoi(optarg));
782                         if (speed == -1)
783                                 goto usage;
784                         break;
785
786                 case 'h':
787                         rv = 0;
788                 default:
789                         goto usage;
790                 }
791         } while (1);
792
793         if (!bootmsg && !term && !debugmsg)
794                 goto usage;
795
796         if (patch && !imgpath)
797                 goto usage;
798
799         if (argc - optind < 1)
800                 goto usage;
801
802         ttypath = argv[optind++];
803
804         tty = kwboot_open_tty(ttypath, speed);
805         if (tty < 0) {
806                 perror(ttypath);
807                 goto out;
808         }
809
810         if (imgpath) {
811                 prot = PROT_READ | (patch ? PROT_WRITE : 0);
812
813                 img = kwboot_mmap_image(imgpath, &size, prot);
814                 if (!img) {
815                         perror(imgpath);
816                         goto out;
817                 }
818         }
819
820         if (patch) {
821                 rc = kwboot_img_patch_hdr(img, size);
822                 if (rc) {
823                         fprintf(stderr, "%s: Invalid image.\n", imgpath);
824                         goto out;
825                 }
826         }
827
828         if (debugmsg) {
829                 rc = kwboot_debugmsg(tty, debugmsg);
830                 if (rc) {
831                         perror("debugmsg");
832                         goto out;
833                 }
834         } else if (bootmsg) {
835                 rc = kwboot_bootmsg(tty, bootmsg);
836                 if (rc) {
837                         perror("bootmsg");
838                         goto out;
839                 }
840         }
841
842         if (img) {
843                 rc = kwboot_xmodem(tty, img, size);
844                 if (rc) {
845                         perror("xmodem");
846                         goto out;
847                 }
848         }
849
850         if (term) {
851                 rc = kwboot_terminal(tty);
852                 if (rc && !(errno == EINTR)) {
853                         perror("terminal");
854                         goto out;
855                 }
856         }
857
858         rv = 0;
859 out:
860         if (tty >= 0)
861                 close(tty);
862
863         if (img)
864                 munmap(img, size);
865
866         return rv;
867
868 usage:
869         kwboot_usage(rv ? stderr : stdout, basename(argv[0]));
870         goto out;
871 }