2 * Boot a Marvell SoC, with Xmodem over UART0.
3 * supports Kirkwood, Dove, Armada 370, Armada XP
5 * (c) 2012 Daniel Stodden <daniel.stodden@gmail.com>
7 * References: marvell.com, "88F6180, 88F6190, 88F6192, and 88F6281
8 * Integrated Controller: Functional Specifications" December 2,
9 * 2008. Chapter 24.2 "BootROM Firmware".
31 * Marvell BootROM UART Sensing
34 static unsigned char kwboot_msg_boot[] = {
35 0xBB, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
38 static unsigned char kwboot_msg_debug[] = {
39 0xDD, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
42 /* Defines known to work on Kirkwood */
43 #define KWBOOT_MSG_REQ_DELAY 10 /* ms */
44 #define KWBOOT_MSG_RSP_TIMEO 50 /* ms */
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 */
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 */
68 #define KWBOOT_BLK_RSP_TIMEO 1000 /* ms */
70 static int kwboot_verbose;
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;
77 kwboot_write(int fd, const char *buf, size_t len)
82 ssize_t wr = write(fd, buf + tot, len - tot);
94 kwboot_printv(const char *fmt, ...)
109 const char seq[] = { '-', '\\', '|', '/' };
111 static int state, bs;
113 if (state % div == 0) {
115 fputc(seq[state / div % sizeof(seq)], stdout);
131 __progress(int pct, char c)
133 const int width = 70;
134 static const char *nl = "";
137 if (pos % width == 0)
138 printf("%s%3d %% [", nl, pct);
143 pos = (pos + 1) % width;
146 while (pos && pos++ < width)
158 kwboot_progress(int _pct, char c)
173 kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
186 tv.tv_usec = timeo * 1000;
187 if (tv.tv_usec > 1000000) {
188 tv.tv_sec += tv.tv_usec / 1000000;
189 tv.tv_usec %= 1000000;
193 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
201 n = read(fd, buf, len);
205 buf = (char *)buf + n;
215 kwboot_tty_send(int fd, const void *buf, size_t len)
220 if (kwboot_write(fd, buf, len) < 0)
227 kwboot_tty_send_char(int fd, unsigned char c)
229 return kwboot_tty_send(fd, &c, 1);
233 kwboot_tty_speed(int baudrate)
252 kwboot_open_tty(const char *path, speed_t speed)
259 fd = open(path, O_RDWR|O_NOCTTY|O_NDELAY);
263 memset(&tio, 0, sizeof(tio));
266 tio.c_cflag = CREAD|CLOCAL|CS8;
269 tio.c_cc[VTIME] = 10;
271 cfsetospeed(&tio, speed);
272 cfsetispeed(&tio, speed);
274 rc = tcsetattr(fd, TCSANOW, &tio);
289 kwboot_bootmsg(int tty, void *msg)
296 kwboot_printv("Please reboot the target into UART boot mode...");
298 kwboot_printv("Sending boot message. Please reboot the target...");
301 rc = tcflush(tty, TCIOFLUSH);
305 for (count = 0; count < 128; count++) {
306 rc = kwboot_tty_send(tty, msg, 8);
308 usleep(msg_req_delay * 1000);
313 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
317 } while (rc || c != NAK);
325 kwboot_debugmsg(int tty, void *msg)
329 kwboot_printv("Sending debug message. Please reboot the target...");
334 rc = tcflush(tty, TCIOFLUSH);
338 rc = kwboot_tty_send(tty, msg, 8);
340 usleep(msg_req_delay * 1000);
344 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
356 kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
357 size_t size, int pnum)
359 const size_t blksz = sizeof(block->data);
364 block->_pnum = ~block->pnum;
366 n = size < blksz ? size : blksz;
367 memcpy(&block->data[0], data, n);
368 memset(&block->data[n], 0, blksz - n);
371 for (i = 0; i < n; i++)
372 block->csum += block->data[i];
378 kwboot_xm_sendblock(int fd, struct kwboot_block *block)
385 rc = kwboot_tty_send(fd, block, sizeof(*block));
390 rc = kwboot_tty_recv(fd, &c, 1, blk_rsp_timeo);
392 if (errno != ETIMEDOUT)
397 if (c != ACK && c != NAK && c != CAN)
400 } while (c != ACK && c != NAK && c != CAN);
403 kwboot_progress(-1, '+');
405 } while (c == NAK && retries-- > 0);
428 kwboot_xmodem(int tty, const void *_data, size_t size)
430 const uint8_t *data = _data;
431 int rc, pnum, N, err;
436 kwboot_printv("Sending boot image...\n");
438 sleep(2); /* flush isn't effective without it */
439 tcflush(tty, TCIOFLUSH);
442 struct kwboot_block block;
445 n = kwboot_xm_makeblock(&block,
451 rc = kwboot_xm_sendblock(tty, &block);
456 kwboot_progress(N * 100 / size, '.');
459 rc = kwboot_tty_send_char(tty, EOT);
467 kwboot_tty_send_char(tty, CAN);
473 kwboot_term_pipe(int in, int out, const char *quit, int *s)
476 char _buf[128], *buf = _buf;
478 nin = read(in, buf, sizeof(_buf));
485 for (i = 0; i < nin; i++) {
486 if (*buf == quit[*s]) {
493 if (kwboot_write(out, quit, *s) < 0)
500 if (kwboot_write(out, buf, nin) < 0)
507 kwboot_terminal(int tty)
510 const char *quit = "\34c";
511 struct termios otio, tio;
517 rc = tcgetattr(in, &otio);
521 rc = tcsetattr(in, TCSANOW, &tio);
528 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
529 quit[0]|0100, quit[1]);
541 nfds = nfds < tty ? tty : nfds;
545 nfds = nfds < in ? in : nfds;
548 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
552 if (FD_ISSET(tty, &rfds)) {
553 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
558 if (in >= 0 && FD_ISSET(in, &rfds)) {
559 rc = kwboot_term_pipe(in, tty, quit, &s);
563 } while (quit[s] != 0);
566 tcsetattr(in, TCSANOW, &otio);
573 kwboot_mmap_image(const char *path, size_t *size, int prot)
582 fd = open(path, O_RDONLY);
590 flags = (prot & PROT_WRITE) ? MAP_PRIVATE : MAP_SHARED;
592 img = mmap(NULL, st.st_size, prot, flags, fd, 0);
593 if (img == MAP_FAILED) {
602 munmap(img, st.st_size);
612 kwboot_img_csum8(void *_data, size_t size)
614 uint8_t *data = _data, csum;
616 for (csum = 0; size-- > 0; data++)
623 kwboot_img_patch_hdr(void *img, size_t size)
626 struct main_hdr_v1 *hdr;
628 size_t hdrsz = sizeof(*hdr);
639 image_ver = image_version(img);
640 if (image_ver != 0 && image_ver != 1) {
641 fprintf(stderr, "Invalid image header version\n");
647 hdrsz = sizeof(*hdr);
649 hdrsz = KWBHEADER_V1_SIZE(hdr);
656 csum = kwboot_img_csum8(hdr, hdrsz) - hdr->checksum;
657 if (csum != hdr->checksum) {
662 if (hdr->blockid == IBR_HDR_UART_ID) {
667 hdr->blockid = IBR_HDR_UART_ID;
669 if (image_ver == 0) {
670 struct main_hdr_v0 *hdr_v0 = img;
672 hdr_v0->nandeccmode = IBR_HDR_ECC_DISABLED;
673 hdr_v0->nandpagesize = 0;
675 hdr_v0->srcaddr = hdr_v0->ext
676 ? sizeof(struct kwb_header)
680 hdr->checksum = kwboot_img_csum8(hdr, hdrsz) - csum;
688 kwboot_usage(FILE *stream, char *progname)
690 fprintf(stream, "kwboot version %s\n", PLAIN_VERSION);
692 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
694 fprintf(stream, "\n");
696 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
697 fprintf(stream, " -p: patch <image> to type 0x69 (uart boot)\n");
699 " -D <image>: boot <image> without preamble (Dove)\n");
700 fprintf(stream, " -d: enter debug mode\n");
701 fprintf(stream, " -a: use timings for Armada XP\n");
702 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
703 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
705 " -o <block-timeo>: use specific xmodem block timeout\n");
706 fprintf(stream, "\n");
707 fprintf(stream, " -t: mini terminal\n");
708 fprintf(stream, "\n");
709 fprintf(stream, " -B <baud>: set baud rate\n");
710 fprintf(stream, "\n");
714 main(int argc, char **argv)
716 const char *ttypath, *imgpath;
717 int rv, rc, tty, term, prot, patch;
735 kwboot_verbose = isatty(STDOUT_FILENO);
738 int c = getopt(argc, argv, "hb:ptaB:dD:q:s:o:");
744 bootmsg = kwboot_msg_boot;
754 debugmsg = kwboot_msg_debug;
766 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
767 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
771 msg_req_delay = atoi(optarg);
775 msg_rsp_timeo = atoi(optarg);
779 blk_rsp_timeo = atoi(optarg);
783 speed = kwboot_tty_speed(atoi(optarg));
795 if (!bootmsg && !term && !debugmsg)
798 if (patch && !imgpath)
801 if (argc - optind < 1)
804 ttypath = argv[optind++];
806 tty = kwboot_open_tty(ttypath, speed);
813 prot = PROT_READ | (patch ? PROT_WRITE : 0);
815 img = kwboot_mmap_image(imgpath, &size, prot);
823 rc = kwboot_img_patch_hdr(img, size);
825 fprintf(stderr, "%s: Invalid image.\n", imgpath);
831 rc = kwboot_debugmsg(tty, debugmsg);
836 } else if (bootmsg) {
837 rc = kwboot_bootmsg(tty, bootmsg);
845 rc = kwboot_xmodem(tty, img, size);
853 rc = kwboot_terminal(tty);
854 if (rc && !(errno == EINTR)) {
871 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));