2 * Boot a Marvell SoC, with Xmodem over UART0.
3 * supports Kirkwood, Dove, Armada 370, Armada XP, Armada 375, Armada 38x and
6 * (c) 2012 Daniel Stodden <daniel.stodden@gmail.com>
7 * (c) 2021 Pali Rohár <pali@kernel.org>
8 * (c) 2021 Marek Behún <marek.behun@nic.cz>
10 * References: marvell.com, "88F6180, 88F6190, 88F6192, and 88F6281
11 * Integrated Controller: Functional Specifications" December 2,
12 * 2008. Chapter 24.2 "BootROM Firmware".
33 #include "termios_linux.h"
39 * Marvell BootROM UART Sensing
42 static unsigned char kwboot_msg_boot[] = {
43 0xBB, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
46 static unsigned char kwboot_msg_debug[] = {
47 0xDD, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
50 /* Defines known to work on Kirkwood */
51 #define KWBOOT_MSG_REQ_DELAY 10 /* ms */
52 #define KWBOOT_MSG_RSP_TIMEO 50 /* ms */
54 /* Defines known to work on Armada XP */
55 #define KWBOOT_MSG_REQ_DELAY_AXP 1000 /* ms */
56 #define KWBOOT_MSG_RSP_TIMEO_AXP 1000 /* ms */
62 #define SOH 1 /* sender start of block header */
63 #define EOT 4 /* sender end of block transfer */
64 #define ACK 6 /* target block ack */
65 #define NAK 21 /* target block negative ack */
66 #define CAN 24 /* target/sender transfer cancellation */
68 #define KWBOOT_XM_BLKSZ 128 /* xmodem block size */
74 uint8_t data[KWBOOT_XM_BLKSZ];
78 #define KWBOOT_BLK_RSP_TIMEO 2000 /* ms */
79 #define KWBOOT_HDR_RSP_TIMEO 10000 /* ms */
81 /* ARM code to change baudrate */
82 static unsigned char kwboot_baud_code[] = {
83 /* ; #define UART_BASE 0xd0012000 */
84 /* ; #define DLL 0x00 */
85 /* ; #define DLH 0x04 */
86 /* ; #define LCR 0x0c */
87 /* ; #define DLAB 0x80 */
88 /* ; #define LSR 0x14 */
89 /* ; #define TEMT 0x40 */
90 /* ; #define DIV_ROUND(a, b) ((a + b/2) / b) */
92 /* ; u32 set_baudrate(u32 old_b, u32 new_b) { */
94 /* ; (!(readl(UART_BASE + LSR) & TEMT)); */
95 /* ; u32 lcr = readl(UART_BASE + LCR); */
96 /* ; writel(UART_BASE + LCR, lcr | DLAB); */
97 /* ; u8 old_dll = readl(UART_BASE + DLL); */
98 /* ; u8 old_dlh = readl(UART_BASE + DLH); */
99 /* ; u16 old_dl = old_dll | (old_dlh << 8); */
100 /* ; u32 clk = old_b * old_dl; */
101 /* ; u16 new_dl = DIV_ROUND(clk, new_b); */
102 /* ; u8 new_dll = new_dl & 0xff; */
103 /* ; u8 new_dlh = (new_dl >> 8) & 0xff; */
104 /* ; writel(UART_BASE + DLL, new_dll); */
105 /* ; writel(UART_BASE + DLH, new_dlh); */
106 /* ; writel(UART_BASE + LCR, lcr & ~DLAB); */
111 /* ; r0 = UART_BASE */
112 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
113 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
115 /* ; Wait until Transmitter FIFO is Empty */
116 /* .Lloop_txempty: */
117 /* ; r1 = UART_BASE[LSR] & TEMT */
118 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
119 0x40, 0x00, 0x11, 0xe3, /* tst r1, #0x40 */
120 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_txempty */
122 /* ; Set Divisor Latch Access Bit */
123 /* ; UART_BASE[LCR] |= DLAB */
124 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
125 0x80, 0x10, 0x81, 0xe3, /* orr r1, r1, #0x80 */
126 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
128 /* ; Read current Divisor Latch */
129 /* ; r1 = UART_BASE[DLH]<<8 | UART_BASE[DLL] */
130 0x00, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x00] */
131 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
132 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
133 0x04, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x04] */
134 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
135 0x41, 0x14, 0xa0, 0xe1, /* asr r1, r1, #8 */
136 0x02, 0x10, 0x81, 0xe1, /* orr r1, r1, r2 */
138 /* ; Read old baudrate value */
139 /* ; r2 = old_baudrate */
140 0x74, 0x20, 0x9f, 0xe5, /* ldr r2, old_baudrate */
142 /* ; Calculate base clock */
144 0x92, 0x01, 0x01, 0xe0, /* mul r1, r2, r1 */
146 /* ; Read new baudrate value */
147 /* ; r2 = new_baudrate */
148 0x70, 0x20, 0x9f, 0xe5, /* ldr r2, new_baudrate */
150 /* ; Calculate new Divisor Latch */
151 /* ; r1 = DIV_ROUND(r1, r2) = */
152 /* ; = (r1 + r2/2) / r2 */
153 0xa2, 0x10, 0x81, 0xe0, /* add r1, r1, r2, lsr #1 */
154 0x02, 0x40, 0xa0, 0xe1, /* mov r4, r2 */
155 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
157 0x84, 0x40, 0xa0, 0x91, /* movls r4, r4, lsl #1 */
158 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
159 0xfc, 0xff, 0xff, 0x9a, /* bls .Lloop_div1 */
160 0x00, 0x30, 0xa0, 0xe3, /* mov r3, #0 */
162 0x04, 0x00, 0x51, 0xe1, /* cmp r1, r4 */
163 0x04, 0x10, 0x41, 0x20, /* subhs r1, r1, r4 */
164 0x03, 0x30, 0xa3, 0xe0, /* adc r3, r3, r3 */
165 0xa4, 0x40, 0xa0, 0xe1, /* mov r4, r4, lsr #1 */
166 0x02, 0x00, 0x54, 0xe1, /* cmp r4, r2 */
167 0xf9, 0xff, 0xff, 0x2a, /* bhs .Lloop_div2 */
168 0x03, 0x10, 0xa0, 0xe1, /* mov r1, r3 */
170 /* ; Set new Divisor Latch Low */
171 /* ; UART_BASE[DLL] = r1 & 0xff */
172 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
173 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
174 0x00, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x00] */
176 /* ; Set new Divisor Latch High */
177 /* ; UART_BASE[DLH] = r1>>8 & 0xff */
178 0x41, 0x24, 0xa0, 0xe1, /* asr r2, r1, #8 */
179 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
180 0x04, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x04] */
182 /* ; Clear Divisor Latch Access Bit */
183 /* ; UART_BASE[LCR] &= ~DLAB */
184 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
185 0x80, 0x10, 0xc1, 0xe3, /* bic r1, r1, #0x80 */
186 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
188 /* ; Loop 0x2dc000 (2998272) cycles */
189 /* ; which is about 5ms on 1200 MHz CPU */
190 /* ; r1 = 0x2dc000 */
191 0xb7, 0x19, 0xa0, 0xe3, /* mov r1, #0x2dc000 */
193 0x01, 0x10, 0x41, 0xe2, /* sub r1, r1, #1 */
194 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
195 0xfc, 0xff, 0xff, 0x1a, /* bne .Lloop_sleep */
197 /* ; Jump to the end of execution */
198 0x01, 0x00, 0x00, 0xea, /* b end */
200 /* ; Placeholder for old baudrate value */
202 0x00, 0x00, 0x00, 0x00, /* .word 0 */
204 /* ; Placeholder for new baudrate value */
206 0x00, 0x00, 0x00, 0x00, /* .word 0 */
211 /* ARM code from binary header executed by BootROM before changing baudrate */
212 static unsigned char kwboot_baud_code_binhdr_pre[] = {
213 /* ; #define UART_BASE 0xd0012000 */
214 /* ; #define THR 0x00 */
215 /* ; #define LSR 0x14 */
216 /* ; #define THRE 0x20 */
218 /* ; void send_preamble(void) { */
219 /* ; const u8 *str = "$baudratechange"; */
223 /* ; ((readl(UART_BASE + LSR) & THRE)); */
225 /* ; writel(UART_BASE + THR, c); */
229 /* ; Preserve registers for BootROM */
230 0xfe, 0x5f, 0x2d, 0xe9, /* push { r1 - r12, lr } */
232 /* ; r0 = UART_BASE */
233 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
234 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
236 /* ; r2 = address of preamble string */
237 0x00, 0x20, 0x8f, 0xe2, /* adr r2, .Lstr_preamble */
239 /* ; Skip preamble data section */
240 0x03, 0x00, 0x00, 0xea, /* b .Lloop_preamble */
242 /* ; Preamble string */
243 /* .Lstr_preamble: */
244 0x24, 0x62, 0x61, 0x75, /* .asciz "$baudratechange" */
245 0x64, 0x72, 0x61, 0x74,
246 0x65, 0x63, 0x68, 0x61,
247 0x6e, 0x67, 0x65, 0x00,
249 /* ; Send preamble string over UART */
250 /* .Lloop_preamble: */
252 /* ; Wait until Transmitter Holding is Empty */
254 /* ; r1 = UART_BASE[LSR] & THRE */
255 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
256 0x20, 0x00, 0x11, 0xe3, /* tst r1, #0x20 */
257 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_thre */
259 /* ; Put character into Transmitter FIFO */
261 0x01, 0x10, 0xd2, 0xe4, /* ldrb r1, [r2], #1 */
262 /* ; UART_BASE[THR] = r1 */
263 0x00, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0] */
265 /* ; Loop until end of preamble string */
266 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
267 0xf8, 0xff, 0xff, 0x1a, /* bne .Lloop_preamble */
270 /* ARM code for returning from binary header back to BootROM */
271 static unsigned char kwboot_baud_code_binhdr_post[] = {
272 /* ; Return 0 - no error */
273 0x00, 0x00, 0xa0, 0xe3, /* mov r0, #0 */
274 0xfe, 0x9f, 0xbd, 0xe8, /* pop { r1 - r12, pc } */
277 /* ARM code for jumping to the original image exec_addr */
278 static unsigned char kwboot_baud_code_data_jump[] = {
279 0x04, 0xf0, 0x1f, 0xe5, /* ldr pc, exec_addr */
280 /* ; Placeholder for exec_addr */
282 0x00, 0x00, 0x00, 0x00, /* .word 0 */
285 static const char kwb_baud_magic[16] = "$baudratechange";
287 static int kwboot_verbose;
289 static int msg_req_delay = KWBOOT_MSG_REQ_DELAY;
290 static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
291 static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
294 kwboot_write(int fd, const char *buf, size_t len)
299 ssize_t wr = write(fd, buf + tot, len - tot);
311 kwboot_printv(const char *fmt, ...)
315 if (kwboot_verbose) {
326 const char seq[] = { '-', '\\', '|', '/' };
328 static int state, bs;
330 if (state % div == 0) {
332 fputc(seq[state / div % sizeof(seq)], stdout);
348 __progress(int pct, char c)
350 const int width = 70;
351 static const char *nl = "";
354 if (pos % width == 0)
355 printf("%s%3d %% [", nl, pct);
360 pos = (pos + 1) % width;
363 while (pos && pos++ < width)
375 kwboot_progress(int _pct, char c)
390 kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
403 tv.tv_usec = timeo * 1000;
404 if (tv.tv_usec > 1000000) {
405 tv.tv_sec += tv.tv_usec / 1000000;
406 tv.tv_usec %= 1000000;
410 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
418 n = read(fd, buf, len);
422 buf = (char *)buf + n;
432 kwboot_tty_send(int fd, const void *buf, size_t len, int nodrain)
437 if (kwboot_write(fd, buf, len) < 0)
447 kwboot_tty_send_char(int fd, unsigned char c)
449 return kwboot_tty_send(fd, &c, 1, 0);
453 kwboot_tty_baudrate_to_speed(int baudrate)
602 _is_within_tolerance(int value, int reference, int tolerance)
604 return 100 * value >= reference * (100 - tolerance) &&
605 100 * value <= reference * (100 + tolerance);
609 kwboot_tty_change_baudrate(int fd, int baudrate)
615 rc = tcgetattr(fd, &tio);
619 speed = kwboot_tty_baudrate_to_speed(baudrate);
627 tio.c_ospeed = tio.c_ispeed = baudrate;
630 rc = cfsetospeed(&tio, speed);
634 rc = cfsetispeed(&tio, speed);
638 rc = tcsetattr(fd, TCSANOW, &tio);
642 rc = tcgetattr(fd, &tio);
646 if (cfgetospeed(&tio) != speed || cfgetispeed(&tio) != speed)
651 * Check whether set baudrate is within 3% tolerance.
652 * If BOTHER is defined, Linux always fills out c_ospeed / c_ispeed
655 if (!_is_within_tolerance(tio.c_ospeed, baudrate, 3))
658 if (!_is_within_tolerance(tio.c_ispeed, baudrate, 3))
665 fprintf(stderr, "Could not set baudrate to requested value\n");
671 kwboot_open_tty(const char *path, int baudrate)
678 fd = open(path, O_RDWR | O_NOCTTY | O_NDELAY);
682 rc = tcgetattr(fd, &tio);
687 tio.c_cflag |= CREAD | CLOCAL;
688 tio.c_cflag &= ~(CSTOPB | HUPCL | CRTSCTS);
692 rc = tcsetattr(fd, TCSANOW, &tio);
696 flags = fcntl(fd, F_GETFL);
700 rc = fcntl(fd, F_SETFL, flags & ~O_NDELAY);
704 rc = kwboot_tty_change_baudrate(fd, baudrate);
719 kwboot_bootmsg(int tty, void *msg)
726 kwboot_printv("Please reboot the target into UART boot mode...");
728 kwboot_printv("Sending boot message. Please reboot the target...");
731 rc = tcflush(tty, TCIOFLUSH);
735 for (count = 0; count < 128; count++) {
736 rc = kwboot_tty_send(tty, msg, 8, 0);
738 usleep(msg_req_delay * 1000);
743 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
747 } while (rc || c != NAK);
755 kwboot_debugmsg(int tty, void *msg)
759 kwboot_printv("Sending debug message. Please reboot the target...");
764 rc = tcflush(tty, TCIOFLUSH);
768 rc = kwboot_tty_send(tty, msg, 8, 0);
770 usleep(msg_req_delay * 1000);
774 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
786 kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
787 size_t size, int pnum)
793 block->_pnum = ~block->pnum;
795 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
796 memcpy(&block->data[0], data, n);
797 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
800 for (i = 0; i < n; i++)
801 block->csum += block->data[i];
811 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
812 static int err_print;
815 perror("clock_gettime() does not work");
819 /* this will just make the timeout not work */
823 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
829 return c == ACK || c == NAK || c == CAN;
833 _xm_reply_to_error(int c)
856 kwboot_baud_magic_handle(int fd, char c, int baudrate)
858 static size_t rcv_len;
860 if (rcv_len < sizeof(kwb_baud_magic)) {
861 /* try to recognize whole magic word */
862 if (c == kwb_baud_magic[rcv_len]) {
865 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
871 if (rcv_len == sizeof(kwb_baud_magic)) {
872 /* magic word received */
873 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
875 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
882 kwboot_xm_recv_reply(int fd, char *c, int nak_on_non_xm,
883 int allow_non_xm, int *non_xm_print,
884 int baudrate, int *baud_changed)
886 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
887 uint64_t recv_until = _now() + timeout;
891 rc = kwboot_tty_recv(fd, c, 1, timeout);
893 if (errno != ETIMEDOUT)
895 else if (allow_non_xm && *non_xm_print)
901 /* If received xmodem reply, end. */
902 if (_is_xm_reply(*c))
906 * If receiving/printing non-xmodem text output is allowed and
907 * such a byte was received, we want to increase receiving time
909 * - print the byte, if it is not part of baudrate change magic
910 * sequence while baudrate change was requested (-B option)
912 * Otherwise decrease timeout by time elapsed.
915 recv_until = _now() + timeout;
917 if (baudrate && !*baud_changed) {
918 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
925 } else if (!baudrate || !*baud_changed) {
935 timeout = recv_until - _now();
947 kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
948 int *done_print, int baudrate)
950 int non_xm_print, baud_changed;
951 int rc, err, retries;
960 rc = kwboot_tty_send(fd, block, sizeof(*block), 1);
964 if (allow_non_xm && !*done_print) {
965 kwboot_progress(100, '.');
966 kwboot_printv("Done\n");
970 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
971 allow_non_xm, &non_xm_print,
972 baudrate, &baud_changed);
976 if (!allow_non_xm && c != ACK)
977 kwboot_progress(-1, '+');
978 } while (c == NAK && retries++ < 16);
983 if (allow_non_xm && baudrate && !baud_changed) {
984 fprintf(stderr, "Baudrate was not changed\n");
990 return _xm_reply_to_error(c);
993 kwboot_tty_send_char(fd, CAN);
1000 kwboot_xm_finish(int fd)
1005 kwboot_printv("Finishing transfer\n");
1009 rc = kwboot_tty_send_char(fd, EOT);
1013 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
1017 } while (c == NAK && retries++ < 16);
1019 return _xm_reply_to_error(c);
1023 kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
1024 size_t size, int baudrate)
1030 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
1031 header ? "header" : "data", size);
1036 while (sent < size) {
1037 struct kwboot_block block;
1041 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1044 last_block = (left <= blksz);
1046 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
1047 &done_print, baudrate);
1055 kwboot_progress(sent * 100 / size, '.');
1059 kwboot_printv("Done\n");
1063 kwboot_printv("\n");
1068 kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
1070 const uint8_t *img = _img;
1074 hdrsz = kwbheader_size(img);
1077 * If header size is not aligned to xmodem block size (which applies
1078 * for all images in kwbimage v0 format) then we have to ensure that
1079 * the last xmodem block of header contains beginning of the data
1080 * followed by the header. So align header size to xmodem block size.
1082 hdrsz += (KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ) % KWBOOT_XM_BLKSZ;
1084 kwboot_printv("Waiting 2s and flushing tty\n");
1085 sleep(2); /* flush isn't effective without it */
1086 tcflush(tty, TCIOFLUSH);
1090 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
1095 * If we have already sent image data as a part of the last
1096 * xmodem header block then we have nothing more to send.
1101 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1106 rc = kwboot_xm_finish(tty);
1111 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1112 rc = kwboot_tty_change_baudrate(tty, 115200);
1121 kwboot_term_pipe(int in, int out, const char *quit, int *s)
1124 char _buf[128], *buf = _buf;
1126 nin = read(in, buf, sizeof(_buf));
1133 for (i = 0; i < nin; i++) {
1134 if (*buf == quit[*s]) {
1141 if (kwboot_write(out, quit, *s) < 0)
1148 if (kwboot_write(out, buf, nin) < 0)
1155 kwboot_terminal(int tty)
1158 const char *quit = "\34c";
1159 struct termios otio, tio;
1165 rc = tcgetattr(in, &otio);
1169 rc = tcsetattr(in, TCSANOW, &tio);
1172 perror("tcsetattr");
1176 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
1177 quit[0] | 0100, quit[1]);
1190 nfds = nfds < tty ? tty : nfds;
1194 nfds = nfds < in ? in : nfds;
1197 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1201 if (FD_ISSET(tty, &rfds)) {
1202 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1207 if (in >= 0 && FD_ISSET(in, &rfds)) {
1208 rc = kwboot_term_pipe(in, tty, quit, &s);
1212 } while (quit[s] != 0);
1215 tcsetattr(in, TCSANOW, &otio);
1222 kwboot_read_image(const char *path, size_t *size, size_t reserve)
1232 fd = open(path, O_RDONLY);
1236 rc = fstat(fd, &st);
1240 img = malloc(st.st_size + reserve);
1245 while (tot < st.st_size) {
1246 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1253 if (!rd && tot < st.st_size) {
1273 kwboot_hdr_csum8(const void *hdr)
1275 const uint8_t *data = hdr;
1279 size = kwbheader_size_for_csum(hdr);
1281 for (csum = 0; size-- > 0; data++)
1288 kwboot_img_csum32_ptr(void *img)
1290 struct main_hdr_v1 *hdr = img;
1293 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1295 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1299 kwboot_img_csum32(const void *img)
1301 const struct main_hdr_v1 *hdr = img;
1302 uint32_t datasz, csum = 0;
1303 const uint32_t *data;
1305 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1306 if (datasz % sizeof(uint32_t))
1309 data = img + le32_to_cpu(hdr->srcaddr);
1310 while (datasz > 0) {
1311 csum += le32_to_cpu(*data++);
1315 return cpu_to_le32(csum);
1319 kwboot_img_is_secure(void *img)
1321 struct opt_hdr_v1 *ohdr;
1323 for_each_opt_hdr_v1 (ohdr, img)
1324 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1331 kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
1333 struct main_hdr_v1 *hdr = img;
1337 * 32-bit checksum comes after end of image code, so we will be putting
1338 * new code there. So we get this pointer and then increase data size
1339 * (since increasing data size changes kwboot_img_csum32_ptr() return
1342 result = kwboot_img_csum32_ptr(img);
1343 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
1350 kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1352 uint32_t hdrsz, datasz, srcaddr;
1353 struct main_hdr_v1 *hdr = img;
1354 struct opt_hdr_v1 *ohdr;
1357 srcaddr = le32_to_cpu(hdr->srcaddr);
1359 /* calculate real used space in kwbimage header */
1360 if (kwbimage_version(img) == 0) {
1361 hdrsz = kwbheader_size(img);
1363 hdrsz = sizeof(*hdr);
1364 for_each_opt_hdr_v1 (ohdr, hdr)
1365 hdrsz += opt_hdr_v1_size(ohdr);
1368 data = (uint8_t *)img + srcaddr;
1369 datasz = *size - srcaddr;
1371 /* only move data if there is not enough space */
1372 if (hdrsz + grow > srcaddr) {
1373 size_t need = hdrsz + grow - srcaddr;
1375 /* move data by enough bytes */
1376 memmove(data + need, data, datasz);
1378 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1382 if (kwbimage_version(img) == 1) {
1384 if (hdrsz > kwbheader_size(img)) {
1385 hdr->headersz_msb = hdrsz >> 16;
1386 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1392 kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1394 struct main_hdr_v1 *hdr = img;
1395 struct opt_hdr_v1 *ohdr;
1402 for_each_opt_hdr_v1 (ohdr, img)
1403 if (opt_hdr_v1_next(ohdr) == NULL)
1406 prev_ext = opt_hdr_v1_ext(ohdr);
1407 ohdr = _opt_hdr_v1_next(ohdr);
1409 ohdr = (void *)(hdr + 1);
1410 prev_ext = &hdr->ext;
1414 * ARM executable code inside the BIN header on some mvebu platforms
1415 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1416 * This requirement can be met by inserting dummy arguments into
1417 * BIN header, if needed.
1419 offset = &ohdr->data[4] - (char *)img;
1420 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1422 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1423 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1427 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1428 ohdr->headersz_msb = ohdrsz >> 16;
1429 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1431 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
1432 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
1434 return &ohdr->data[4 + 4 * num_args];
1438 _inject_baudrate_change_code(void *img, size_t *size, int for_data,
1439 int old_baud, int new_baud)
1441 struct main_hdr_v1 *hdr = img;
1442 uint32_t orig_datasz;
1447 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1449 codesz = sizeof(kwboot_baud_code) +
1450 sizeof(kwboot_baud_code_data_jump);
1451 code = kwboot_img_grow_data_right(img, size, codesz);
1453 codesz = sizeof(kwboot_baud_code_binhdr_pre) +
1454 sizeof(kwboot_baud_code) +
1455 sizeof(kwboot_baud_code_binhdr_post);
1456 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
1458 codesz = sizeof(kwboot_baud_code_binhdr_pre);
1459 memcpy(code, kwboot_baud_code_binhdr_pre, codesz);
1463 codesz = sizeof(kwboot_baud_code) - 2 * sizeof(uint32_t);
1464 memcpy(code, kwboot_baud_code, codesz);
1466 *(uint32_t *)code = cpu_to_le32(old_baud);
1467 code += sizeof(uint32_t);
1468 *(uint32_t *)code = cpu_to_le32(new_baud);
1469 code += sizeof(uint32_t);
1472 codesz = sizeof(kwboot_baud_code_data_jump) - sizeof(uint32_t);
1473 memcpy(code, kwboot_baud_code_data_jump, codesz);
1475 *(uint32_t *)code = hdr->execaddr;
1476 code += sizeof(uint32_t);
1477 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) + orig_datasz);
1479 codesz = sizeof(kwboot_baud_code_binhdr_post);
1480 memcpy(code, kwboot_baud_code_binhdr_post, codesz);
1486 kwboot_img_patch(void *img, size_t *size, int baudrate)
1488 struct main_hdr_v1 *hdr;
1497 if (*size < sizeof(struct main_hdr_v1))
1500 image_ver = kwbimage_version(img);
1501 if (image_ver != 0 && image_ver != 1) {
1502 fprintf(stderr, "Invalid image header version\n");
1506 hdrsz = kwbheader_size(hdr);
1511 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
1512 if (csum != hdr->checksum)
1515 srcaddr = le32_to_cpu(hdr->srcaddr);
1517 switch (hdr->blockid) {
1518 case IBR_HDR_SATA_ID:
1522 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1525 case IBR_HDR_SDIO_ID:
1526 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1529 case IBR_HDR_PEX_ID:
1530 if (srcaddr == 0xFFFFFFFF)
1531 hdr->srcaddr = cpu_to_le32(hdrsz);
1534 case IBR_HDR_SPI_ID:
1535 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1536 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1537 hdr->destaddr = cpu_to_le32(0x00800000);
1538 hdr->execaddr = cpu_to_le32(0x00800000);
1543 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
1544 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1547 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1550 is_secure = kwboot_img_is_secure(img);
1552 if (hdr->blockid != IBR_HDR_UART_ID) {
1555 "Image has secure header with signature for non-UART booting\n");
1559 kwboot_printv("Patching image boot signature to UART\n");
1560 hdr->blockid = IBR_HDR_UART_ID;
1564 if (image_ver == 1) {
1566 * Tell BootROM to send BootROM messages to UART port
1567 * number 0 (used also for UART booting) with default
1568 * baudrate (which should be 115200) and do not touch
1569 * UART MPP configuration.
1571 hdr->options &= ~0x1F;
1572 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1573 hdr->options |= 0 << 3;
1576 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1577 hdr->nandpagesize = 0;
1581 if (image_ver == 0) {
1583 "Cannot inject code for changing baudrate into v0 image header\n");
1589 "Cannot inject code for changing baudrate into image with secure header\n");
1594 * First inject code that changes the baudrate from the default
1595 * value of 115200 Bd to requested value. This code is inserted
1596 * as a new opt hdr, so it is executed by BootROM after the
1597 * header part is received.
1599 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1601 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
1604 * Now inject code that changes the baudrate back to 115200 Bd.
1605 * This code is appended after the data part of the image, and
1606 * execaddr is changed so that it is executed before U-Boot
1609 kwboot_printv("Injecting code for changing baudrate back\n");
1610 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
1612 /* Update the 32-bit data checksum */
1613 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1615 /* recompute header size */
1616 hdrsz = kwbheader_size(hdr);
1619 if (hdrsz % KWBOOT_XM_BLKSZ) {
1620 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
1623 fprintf(stderr, "Cannot align image with secure header\n");
1627 kwboot_printv("Aligning image header to Xmodem block size\n");
1628 kwboot_img_grow_hdr(img, size, grow);
1631 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
1633 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
1641 kwboot_usage(FILE *stream, char *progname)
1644 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
1646 fprintf(stream, "\n");
1648 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
1650 " -D <image>: boot <image> without preamble (Dove)\n");
1651 fprintf(stream, " -d: enter debug mode\n");
1652 fprintf(stream, " -a: use timings for Armada XP\n");
1653 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
1654 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
1656 " -o <block-timeo>: use specific xmodem block timeout\n");
1657 fprintf(stream, "\n");
1658 fprintf(stream, " -t: mini terminal\n");
1659 fprintf(stream, "\n");
1660 fprintf(stream, " -B <baud>: set baud rate\n");
1661 fprintf(stream, "\n");
1665 main(int argc, char **argv)
1667 const char *ttypath, *imgpath;
1668 int rv, rc, tty, term;
1673 size_t after_img_rsv;
1684 after_img_rsv = KWBOOT_XM_BLKSZ;
1687 printf("kwboot version %s\n", PLAIN_VERSION);
1689 kwboot_verbose = isatty(STDOUT_FILENO);
1692 int c = getopt(argc, argv, "hb:ptaB:dD:q:s:o:");
1698 bootmsg = kwboot_msg_boot;
1708 debugmsg = kwboot_msg_debug;
1712 /* nop, for backward compatibility */
1720 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
1721 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1725 msg_req_delay = atoi(optarg);
1729 msg_rsp_timeo = atoi(optarg);
1733 blk_rsp_timeo = atoi(optarg);
1737 baudrate = atoi(optarg);
1747 if (!bootmsg && !term && !debugmsg)
1750 if (argc - optind < 1)
1753 ttypath = argv[optind++];
1755 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
1761 if (baudrate == 115200)
1762 /* do not change baudrate during Xmodem to the same value */
1765 /* ensure we have enough space for baudrate change code */
1766 after_img_rsv += sizeof(struct opt_hdr_v1) + 8 + 16 +
1767 sizeof(kwboot_baud_code_binhdr_pre) +
1768 sizeof(kwboot_baud_code) +
1769 sizeof(kwboot_baud_code_binhdr_post) +
1771 sizeof(kwboot_baud_code) +
1772 sizeof(kwboot_baud_code_data_jump) +
1776 img = kwboot_read_image(imgpath, &size, after_img_rsv);
1782 rc = kwboot_img_patch(img, &size, baudrate);
1784 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1790 rc = kwboot_debugmsg(tty, debugmsg);
1795 } else if (bootmsg) {
1796 rc = kwboot_bootmsg(tty, bootmsg);
1804 rc = kwboot_xmodem(tty, img, size, baudrate);
1812 rc = kwboot_terminal(tty);
1813 if (rc && !(errno == EINTR)) {
1830 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));