2 * Boot a Marvell SoC, with Xmodem over UART0.
3 * supports Kirkwood, Dove, Armada 370, Armada XP, Armada 375, Armada 38x and
10 * References: marvell.com, "88F6180, 88F6190, 88F6192, and 88F6281
11 * Integrated Controller: Functional Specifications" December 2,
12 * 2008. Chapter 24.2 "BootROM Firmware".
34 #include "termios_linux.h"
40 * Marvell BootROM UART Sensing
43 static unsigned char kwboot_msg_boot[] = {
44 0xBB, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
47 static unsigned char kwboot_msg_debug[] = {
48 0xDD, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
51 /* Defines known to work on Kirkwood */
52 #define KWBOOT_MSG_RSP_TIMEO 50 /* ms */
54 /* Defines known to work on Armada XP */
55 #define KWBOOT_MSG_RSP_TIMEO_AXP 1000 /* ms */
61 #define SOH 1 /* sender start of block header */
62 #define EOT 4 /* sender end of block transfer */
63 #define ACK 6 /* target block ack */
64 #define NAK 21 /* target block negative ack */
66 #define KWBOOT_XM_BLKSZ 128 /* xmodem block size */
72 uint8_t data[KWBOOT_XM_BLKSZ];
76 #define KWBOOT_BLK_RSP_TIMEO 2000 /* ms */
77 #define KWBOOT_HDR_RSP_TIMEO 10000 /* ms */
79 /* ARM code to change baudrate */
80 static unsigned char kwboot_baud_code[] = {
81 /* ; #define UART_BASE 0xd0012000 */
82 /* ; #define DLL 0x00 */
83 /* ; #define DLH 0x04 */
84 /* ; #define LCR 0x0c */
85 /* ; #define DLAB 0x80 */
86 /* ; #define LSR 0x14 */
87 /* ; #define TEMT 0x40 */
88 /* ; #define DIV_ROUND(a, b) ((a + b/2) / b) */
90 /* ; u32 set_baudrate(u32 old_b, u32 new_b) { */
92 /* ; (!(readl(UART_BASE + LSR) & TEMT)); */
93 /* ; u32 lcr = readl(UART_BASE + LCR); */
94 /* ; writel(UART_BASE + LCR, lcr | DLAB); */
95 /* ; u8 old_dll = readl(UART_BASE + DLL); */
96 /* ; u8 old_dlh = readl(UART_BASE + DLH); */
97 /* ; u16 old_dl = old_dll | (old_dlh << 8); */
98 /* ; u32 clk = old_b * old_dl; */
99 /* ; u16 new_dl = DIV_ROUND(clk, new_b); */
100 /* ; u8 new_dll = new_dl & 0xff; */
101 /* ; u8 new_dlh = (new_dl >> 8) & 0xff; */
102 /* ; writel(UART_BASE + DLL, new_dll); */
103 /* ; writel(UART_BASE + DLH, new_dlh); */
104 /* ; writel(UART_BASE + LCR, lcr & ~DLAB); */
109 /* ; r0 = UART_BASE */
110 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
111 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
113 /* ; Wait until Transmitter FIFO is Empty */
114 /* .Lloop_txempty: */
115 /* ; r1 = UART_BASE[LSR] & TEMT */
116 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
117 0x40, 0x00, 0x11, 0xe3, /* tst r1, #0x40 */
118 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_txempty */
120 /* ; Set Divisor Latch Access Bit */
121 /* ; UART_BASE[LCR] |= DLAB */
122 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
123 0x80, 0x10, 0x81, 0xe3, /* orr r1, r1, #0x80 */
124 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
126 /* ; Read current Divisor Latch */
127 /* ; r1 = UART_BASE[DLH]<<8 | UART_BASE[DLL] */
128 0x00, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x00] */
129 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
130 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
131 0x04, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x04] */
132 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
133 0x41, 0x14, 0xa0, 0xe1, /* asr r1, r1, #8 */
134 0x02, 0x10, 0x81, 0xe1, /* orr r1, r1, r2 */
136 /* ; Read old baudrate value */
137 /* ; r2 = old_baudrate */
138 0x74, 0x20, 0x9f, 0xe5, /* ldr r2, old_baudrate */
140 /* ; Calculate base clock */
142 0x92, 0x01, 0x01, 0xe0, /* mul r1, r2, r1 */
144 /* ; Read new baudrate value */
145 /* ; r2 = new_baudrate */
146 0x70, 0x20, 0x9f, 0xe5, /* ldr r2, new_baudrate */
148 /* ; Calculate new Divisor Latch */
149 /* ; r1 = DIV_ROUND(r1, r2) = */
150 /* ; = (r1 + r2/2) / r2 */
151 0xa2, 0x10, 0x81, 0xe0, /* add r1, r1, r2, lsr #1 */
152 0x02, 0x40, 0xa0, 0xe1, /* mov r4, r2 */
153 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
155 0x84, 0x40, 0xa0, 0x91, /* movls r4, r4, lsl #1 */
156 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
157 0xfc, 0xff, 0xff, 0x9a, /* bls .Lloop_div1 */
158 0x00, 0x30, 0xa0, 0xe3, /* mov r3, #0 */
160 0x04, 0x00, 0x51, 0xe1, /* cmp r1, r4 */
161 0x04, 0x10, 0x41, 0x20, /* subhs r1, r1, r4 */
162 0x03, 0x30, 0xa3, 0xe0, /* adc r3, r3, r3 */
163 0xa4, 0x40, 0xa0, 0xe1, /* mov r4, r4, lsr #1 */
164 0x02, 0x00, 0x54, 0xe1, /* cmp r4, r2 */
165 0xf9, 0xff, 0xff, 0x2a, /* bhs .Lloop_div2 */
166 0x03, 0x10, 0xa0, 0xe1, /* mov r1, r3 */
168 /* ; Set new Divisor Latch Low */
169 /* ; UART_BASE[DLL] = r1 & 0xff */
170 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
171 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
172 0x00, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x00] */
174 /* ; Set new Divisor Latch High */
175 /* ; UART_BASE[DLH] = r1>>8 & 0xff */
176 0x41, 0x24, 0xa0, 0xe1, /* asr r2, r1, #8 */
177 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
178 0x04, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x04] */
180 /* ; Clear Divisor Latch Access Bit */
181 /* ; UART_BASE[LCR] &= ~DLAB */
182 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
183 0x80, 0x10, 0xc1, 0xe3, /* bic r1, r1, #0x80 */
184 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
186 /* ; Loop 0x2dc000 (2998272) cycles */
187 /* ; which is about 5ms on 1200 MHz CPU */
188 /* ; r1 = 0x2dc000 */
189 0xb7, 0x19, 0xa0, 0xe3, /* mov r1, #0x2dc000 */
191 0x01, 0x10, 0x41, 0xe2, /* sub r1, r1, #1 */
192 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
193 0xfc, 0xff, 0xff, 0x1a, /* bne .Lloop_sleep */
195 /* ; Jump to the end of execution */
196 0x01, 0x00, 0x00, 0xea, /* b end */
198 /* ; Placeholder for old baudrate value */
200 0x00, 0x00, 0x00, 0x00, /* .word 0 */
202 /* ; Placeholder for new baudrate value */
204 0x00, 0x00, 0x00, 0x00, /* .word 0 */
209 /* ARM code from binary header executed by BootROM before changing baudrate */
210 static unsigned char kwboot_baud_code_binhdr_pre[] = {
211 /* ; #define UART_BASE 0xd0012000 */
212 /* ; #define THR 0x00 */
213 /* ; #define LSR 0x14 */
214 /* ; #define THRE 0x20 */
216 /* ; void send_preamble(void) { */
217 /* ; const u8 *str = "$baudratechange"; */
221 /* ; ((readl(UART_BASE + LSR) & THRE)); */
223 /* ; writel(UART_BASE + THR, c); */
227 /* ; Preserve registers for BootROM */
228 0xfe, 0x5f, 0x2d, 0xe9, /* push { r1 - r12, lr } */
230 /* ; r0 = UART_BASE */
231 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
232 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
234 /* ; r2 = address of preamble string */
235 0x00, 0x20, 0x8f, 0xe2, /* adr r2, .Lstr_preamble */
237 /* ; Skip preamble data section */
238 0x03, 0x00, 0x00, 0xea, /* b .Lloop_preamble */
240 /* ; Preamble string */
241 /* .Lstr_preamble: */
242 0x24, 0x62, 0x61, 0x75, /* .asciz "$baudratechange" */
243 0x64, 0x72, 0x61, 0x74,
244 0x65, 0x63, 0x68, 0x61,
245 0x6e, 0x67, 0x65, 0x00,
247 /* ; Send preamble string over UART */
248 /* .Lloop_preamble: */
250 /* ; Wait until Transmitter Holding is Empty */
252 /* ; r1 = UART_BASE[LSR] & THRE */
253 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
254 0x20, 0x00, 0x11, 0xe3, /* tst r1, #0x20 */
255 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_thre */
257 /* ; Put character into Transmitter FIFO */
259 0x01, 0x10, 0xd2, 0xe4, /* ldrb r1, [r2], #1 */
260 /* ; UART_BASE[THR] = r1 */
261 0x00, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0] */
263 /* ; Loop until end of preamble string */
264 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
265 0xf8, 0xff, 0xff, 0x1a, /* bne .Lloop_preamble */
268 /* ARM code for returning from binary header back to BootROM */
269 static unsigned char kwboot_baud_code_binhdr_post[] = {
270 /* ; Return 0 - no error */
271 0x00, 0x00, 0xa0, 0xe3, /* mov r0, #0 */
272 0xfe, 0x9f, 0xbd, 0xe8, /* pop { r1 - r12, pc } */
275 /* ARM code for jumping to the original image exec_addr */
276 static unsigned char kwboot_baud_code_data_jump[] = {
277 0x04, 0xf0, 0x1f, 0xe5, /* ldr pc, exec_addr */
278 /* ; Placeholder for exec_addr */
280 0x00, 0x00, 0x00, 0x00, /* .word 0 */
283 static const char kwb_baud_magic[16] = "$baudratechange";
285 static int kwboot_verbose;
287 static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
288 static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
291 kwboot_write(int fd, const char *buf, size_t len)
296 ssize_t wr = write(fd, buf + tot, len - tot);
298 if (wr < 0 && errno == EINTR)
310 kwboot_printv(const char *fmt, ...)
314 if (kwboot_verbose) {
325 const char seq[] = { '-', '\\', '|', '/' };
327 static int state, bs;
329 if (state % div == 0) {
331 fputc(seq[state / div % sizeof(seq)], stdout);
347 __progress(int pct, char c)
349 const int width = 70;
350 static const char *nl = "";
353 if (pos % width == 0)
354 printf("%s%3d %% [", nl, pct);
359 pos = (pos + 1) % width;
362 while (pos && pos++ < width)
374 kwboot_progress(int _pct, char c)
389 kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
402 tv.tv_usec = timeo * 1000;
403 if (tv.tv_usec > 1000000) {
404 tv.tv_sec += tv.tv_usec / 1000000;
405 tv.tv_usec %= 1000000;
409 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
410 if (nfds < 0 && errno == EINTR)
419 n = read(fd, buf, len);
420 if (n < 0 && errno == EINTR)
425 buf = (char *)buf + n;
435 kwboot_tty_send(int fd, const void *buf, size_t len, int nodrain)
440 if (kwboot_write(fd, buf, len) < 0)
450 kwboot_tty_send_char(int fd, unsigned char c)
452 return kwboot_tty_send(fd, &c, 1, 0);
456 kwboot_tty_baudrate_to_speed(int baudrate)
605 _is_within_tolerance(int value, int reference, int tolerance)
607 return 100 * value >= reference * (100 - tolerance) &&
608 100 * value <= reference * (100 + tolerance);
612 kwboot_tty_change_baudrate(int fd, int baudrate)
618 rc = tcgetattr(fd, &tio);
622 speed = kwboot_tty_baudrate_to_speed(baudrate);
630 tio.c_ospeed = tio.c_ispeed = baudrate;
633 rc = cfsetospeed(&tio, speed);
637 rc = cfsetispeed(&tio, speed);
641 rc = tcsetattr(fd, TCSANOW, &tio);
645 rc = tcgetattr(fd, &tio);
649 if (cfgetospeed(&tio) != speed || cfgetispeed(&tio) != speed)
654 * Check whether set baudrate is within 3% tolerance.
655 * If BOTHER is defined, Linux always fills out c_ospeed / c_ispeed
658 if (!_is_within_tolerance(tio.c_ospeed, baudrate, 3))
661 if (!_is_within_tolerance(tio.c_ispeed, baudrate, 3))
668 fprintf(stderr, "Could not set baudrate to requested value\n");
674 kwboot_open_tty(const char *path, int baudrate)
681 fd = open(path, O_RDWR | O_NOCTTY | O_NDELAY);
685 rc = tcgetattr(fd, &tio);
690 tio.c_cflag |= CREAD | CLOCAL;
691 tio.c_cflag &= ~(CSTOPB | HUPCL | CRTSCTS);
695 rc = tcsetattr(fd, TCSANOW, &tio);
699 flags = fcntl(fd, F_GETFL);
703 rc = fcntl(fd, F_SETFL, flags & ~O_NDELAY);
707 rc = kwboot_tty_change_baudrate(fd, baudrate);
722 kwboot_msg_write_handler(void *arg)
724 int tty = *(int *)((void **)arg)[0];
725 const void *msg = ((void **)arg)[1];
726 int rsp_timeo = msg_rsp_timeo;
727 int i, dummy_oldtype;
729 /* allow to cancel this thread at any time */
730 pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &dummy_oldtype);
733 /* write 128 samples of message pattern into the output queue without waiting */
734 for (i = 0; i < 128; i++) {
735 if (kwboot_tty_send(tty, msg, 8, 1) < 0) {
736 perror("\nFailed to send message pattern");
740 /* wait until output queue is transmitted and then make pause */
741 if (tcdrain(tty) < 0) {
742 perror("\nFailed to send message pattern");
745 /* BootROM requires pause on UART after it detects message pattern */
746 usleep(rsp_timeo * 1000);
751 kwboot_msg_start_thread(pthread_t *thread, int *tty, void *msg)
758 rc = pthread_create(thread, NULL, kwboot_msg_write_handler, arg);
768 kwboot_msg_stop_thread(pthread_t thread)
772 rc = pthread_cancel(thread);
778 rc = pthread_join(thread, NULL);
788 kwboot_bootmsg(int tty)
790 struct kwboot_block block;
791 pthread_t write_thread;
795 /* flush input and output queue */
796 tcflush(tty, TCIOFLUSH);
798 rc = kwboot_msg_start_thread(&write_thread, &tty, kwboot_msg_boot);
800 perror("Failed to start write thread");
804 kwboot_printv("Sending boot message. Please reboot the target...");
810 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
811 if (rc && errno == ETIMEDOUT) {
824 rc = kwboot_msg_stop_thread(write_thread);
826 perror("Failed to stop write thread");
832 perror("Failed to read response for boot message pattern");
837 * At this stage we have sent more boot message patterns and BootROM
838 * (at least on Armada XP and 385) started interpreting sent bytes as
839 * part of xmodem packets. If BootROM is expecting SOH byte as start of
840 * a xmodem packet and it receives byte 0xff, then it throws it away and
841 * sends a NAK reply to host. If BootROM does not receive any byte for
842 * 2s when expecting some continuation of the xmodem packet, it throws
843 * away the partially received xmodem data and sends NAK reply to host.
845 * Therefore for starting xmodem transfer we have two options: Either
846 * wait 2s or send 132 0xff bytes (which is the size of xmodem packet)
847 * to ensure that BootROM throws away any partially received data.
850 /* flush output queue with remaining boot message patterns */
851 rc = tcflush(tty, TCOFLUSH);
853 perror("Failed to flush output queue");
857 /* send one xmodem packet with 0xff bytes to force BootROM to re-sync */
858 memset(&block, 0xff, sizeof(block));
859 rc = kwboot_tty_send(tty, &block, sizeof(block), 0);
861 perror("Failed to send sync sequence");
866 * Sending 132 bytes via 115200B/8-N-1 takes 11.45 ms, reading 132 bytes
867 * takes 11.45 ms, so waiting for 30 ms should be enough.
871 /* flush remaining NAK replies from input queue */
872 rc = tcflush(tty, TCIFLUSH);
874 perror("Failed to flush input queue");
882 kwboot_debugmsg(int tty)
886 kwboot_printv("Sending debug message. Please reboot the target...");
891 rc = tcflush(tty, TCIOFLUSH);
895 rc = kwboot_tty_send(tty, kwboot_msg_debug, sizeof(kwboot_msg_debug), 0);
899 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
911 kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
912 size_t size, int pnum)
918 block->_pnum = ~block->pnum;
920 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
921 memcpy(&block->data[0], data, n);
922 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
925 for (i = 0; i < n; i++)
926 block->csum += block->data[i];
936 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
937 static int err_print;
940 perror("clock_gettime() does not work");
944 /* this will just make the timeout not work */
948 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
954 return c == ACK || c == NAK;
958 _xm_reply_to_error(int c)
978 kwboot_baud_magic_handle(int fd, char c, int baudrate)
980 static size_t rcv_len;
982 if (rcv_len < sizeof(kwb_baud_magic)) {
983 /* try to recognize whole magic word */
984 if (c == kwb_baud_magic[rcv_len]) {
987 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
993 if (rcv_len == sizeof(kwb_baud_magic)) {
994 /* magic word received */
995 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
997 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
1004 kwboot_xm_recv_reply(int fd, char *c, int stop_on_non_xm,
1005 int ignore_nak_reply,
1006 int allow_non_xm, int *non_xm_print,
1007 int baudrate, int *baud_changed)
1009 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
1010 uint64_t recv_until = _now() + timeout;
1014 rc = kwboot_tty_recv(fd, c, 1, timeout);
1016 if (errno != ETIMEDOUT)
1018 else if (allow_non_xm && *non_xm_print)
1024 /* If received xmodem reply, end. */
1025 if (_is_xm_reply(*c)) {
1026 if (*c == NAK && ignore_nak_reply) {
1027 timeout = recv_until - _now();
1035 * If receiving/printing non-xmodem text output is allowed and
1036 * such a byte was received, we want to increase receiving time
1038 * - print the byte, if it is not part of baudrate change magic
1039 * sequence while baudrate change was requested (-B option)
1041 * Otherwise decrease timeout by time elapsed.
1044 recv_until = _now() + timeout;
1046 if (baudrate && !*baud_changed) {
1047 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
1054 } else if (!baudrate || !*baud_changed) {
1062 timeout = recv_until - _now();
1074 kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
1075 int *done_print, int baudrate, int allow_retries)
1077 int non_xm_print, baud_changed;
1078 int rc, err, retries;
1087 rc = kwboot_tty_send(fd, block, sizeof(*block), 1);
1091 if (allow_non_xm && !*done_print) {
1092 kwboot_progress(100, '.');
1093 kwboot_printv("Done\n");
1097 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
1099 allow_non_xm, &non_xm_print,
1100 baudrate, &baud_changed);
1104 if (!allow_non_xm && c != ACK) {
1105 if (c == NAK && allow_retries && retries + 1 < 16)
1106 kwboot_progress(-1, '+');
1108 kwboot_progress(-1, 'E');
1110 } while (c == NAK && allow_retries && retries++ < 16);
1113 kwboot_printv("\n");
1115 if (allow_non_xm && baudrate && !baud_changed) {
1116 fprintf(stderr, "Baudrate was not changed\n");
1121 return _xm_reply_to_error(c);
1124 kwboot_printv("\n");
1130 kwboot_xm_finish(int fd)
1135 kwboot_printv("Finishing transfer\n");
1139 rc = kwboot_tty_send_char(fd, EOT);
1143 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
1148 } while (c == NAK && retries++ < 16);
1150 return _xm_reply_to_error(c);
1154 kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
1155 size_t size, int baudrate)
1161 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
1162 header ? "header" : "data", size);
1167 while (sent < size) {
1168 struct kwboot_block block;
1172 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1175 last_block = (left <= blksz);
1178 * Handling of repeated xmodem packets is completely broken in
1179 * Armada 385 BootROM - it completely ignores xmodem packet
1180 * numbers, they are only used for checksum verification.
1181 * BootROM can handle a retry of the xmodem packet only during
1182 * the transmission of kwbimage header and only if BootROM
1183 * itself sent NAK response to previous attempt (it does it on
1184 * checksum failure). During the transmission of kwbimage data
1185 * part, BootROM always expects next xmodem packet, even if it
1186 * sent NAK to previous attempt - there is absolutely no way to
1187 * repair incorrectly transmitted xmodem packet during kwbimage
1188 * data part upload. Also, if kwboot receives non-ACK/NAK
1189 * response (meaning that original BootROM response was damaged
1190 * on UART) there is no way to detect if BootROM accepted xmodem
1191 * packet or not and no way to check if kwboot could repeat the
1194 * Stop transfer and return failure if kwboot receives unknown
1195 * reply if non-xmodem reply is not allowed (for all xmodem
1196 * packets except the last header packet) or when non-ACK reply
1197 * is received during data part transfer.
1199 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
1200 &done_print, baudrate, header);
1208 kwboot_progress(sent * 100 / size, '.');
1212 kwboot_printv("Done\n");
1216 kwboot_printv("\n");
1221 kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
1223 const uint8_t *img = _img;
1227 hdrsz = kwbheader_size(img);
1230 * If header size is not aligned to xmodem block size (which applies
1231 * for all images in kwbimage v0 format) then we have to ensure that
1232 * the last xmodem block of header contains beginning of the data
1233 * followed by the header. So align header size to xmodem block size.
1235 hdrsz += (KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ) % KWBOOT_XM_BLKSZ;
1239 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
1244 * If we have already sent image data as a part of the last
1245 * xmodem header block then we have nothing more to send.
1250 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1255 rc = kwboot_xm_finish(tty);
1260 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1261 rc = kwboot_tty_change_baudrate(tty, 115200);
1270 kwboot_term_pipe(int in, int out, const char *quit, int *s)
1275 nin = read(in, buf, sizeof(buf));
1282 for (i = 0; i < nin; i++) {
1283 if (buf[i] == quit[*s]) {
1286 nin = (i > *s) ? (i - *s) : 0;
1290 if (*s > i && kwboot_write(out, quit, *s - i) < 0)
1297 nin -= (nin > *s) ? *s : nin;
1300 if (kwboot_write(out, buf, nin) < 0)
1307 kwboot_terminal(int tty)
1310 const char *quit = "\34c";
1311 struct termios otio, tio;
1317 rc = tcgetattr(in, &otio);
1321 rc = tcsetattr(in, TCSANOW, &tio);
1324 perror("tcsetattr");
1328 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
1329 quit[0] | 0100, quit[1]);
1342 nfds = nfds < tty ? tty : nfds;
1346 nfds = nfds < in ? in : nfds;
1349 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1353 if (FD_ISSET(tty, &rfds)) {
1354 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1359 if (in >= 0 && FD_ISSET(in, &rfds)) {
1360 rc = kwboot_term_pipe(in, tty, quit, &s);
1364 } while (quit[s] != 0);
1367 tcsetattr(in, TCSANOW, &otio);
1374 kwboot_read_image(const char *path, size_t *size, size_t reserve)
1384 fd = open(path, O_RDONLY);
1388 rc = fstat(fd, &st);
1392 img = malloc(st.st_size + reserve);
1397 while (tot < st.st_size) {
1398 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1405 if (!rd && tot < st.st_size) {
1425 kwboot_hdr_csum8(const void *hdr)
1427 const uint8_t *data = hdr;
1431 size = kwbheader_size_for_csum(hdr);
1433 for (csum = 0; size-- > 0; data++)
1440 kwboot_img_csum32_ptr(void *img)
1442 struct main_hdr_v1 *hdr = img;
1445 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1447 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1451 kwboot_img_csum32(const void *img)
1453 const struct main_hdr_v1 *hdr = img;
1454 uint32_t datasz, csum = 0;
1455 const uint32_t *data;
1457 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1458 if (datasz % sizeof(uint32_t))
1461 data = img + le32_to_cpu(hdr->srcaddr);
1462 while (datasz > 0) {
1463 csum += le32_to_cpu(*data++);
1467 return cpu_to_le32(csum);
1471 kwboot_img_is_secure(void *img)
1473 struct opt_hdr_v1 *ohdr;
1475 for_each_opt_hdr_v1 (ohdr, img)
1476 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1483 kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
1485 struct main_hdr_v1 *hdr = img;
1489 * 32-bit checksum comes after end of image code, so we will be putting
1490 * new code there. So we get this pointer and then increase data size
1491 * (since increasing data size changes kwboot_img_csum32_ptr() return
1494 result = kwboot_img_csum32_ptr(img);
1495 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
1502 kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1504 uint32_t hdrsz, datasz, srcaddr;
1505 struct main_hdr_v1 *hdr = img;
1506 struct opt_hdr_v1 *ohdr;
1509 srcaddr = le32_to_cpu(hdr->srcaddr);
1511 /* calculate real used space in kwbimage header */
1512 if (kwbimage_version(img) == 0) {
1513 hdrsz = kwbheader_size(img);
1515 hdrsz = sizeof(*hdr);
1516 for_each_opt_hdr_v1 (ohdr, hdr)
1517 hdrsz += opt_hdr_v1_size(ohdr);
1520 data = (uint8_t *)img + srcaddr;
1521 datasz = *size - srcaddr;
1523 /* only move data if there is not enough space */
1524 if (hdrsz + grow > srcaddr) {
1525 size_t need = hdrsz + grow - srcaddr;
1527 /* move data by enough bytes */
1528 memmove(data + need, data, datasz);
1530 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1534 if (kwbimage_version(img) == 1) {
1536 if (hdrsz > kwbheader_size(img)) {
1537 hdr->headersz_msb = hdrsz >> 16;
1538 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1544 kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1546 struct main_hdr_v1 *hdr = img;
1547 struct opt_hdr_v1 *ohdr;
1554 for_each_opt_hdr_v1 (ohdr, img)
1555 if (opt_hdr_v1_next(ohdr) == NULL)
1558 prev_ext = opt_hdr_v1_ext(ohdr);
1559 ohdr = _opt_hdr_v1_next(ohdr);
1561 ohdr = (void *)(hdr + 1);
1562 prev_ext = &hdr->ext;
1566 * ARM executable code inside the BIN header on some mvebu platforms
1567 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1568 * This requirement can be met by inserting dummy arguments into
1569 * BIN header, if needed.
1571 offset = &ohdr->data[4] - (char *)img;
1572 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1574 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1575 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1579 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1580 ohdr->headersz_msb = ohdrsz >> 16;
1581 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1583 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
1584 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
1586 return &ohdr->data[4 + 4 * num_args];
1590 _inject_baudrate_change_code(void *img, size_t *size, int for_data,
1591 int old_baud, int new_baud)
1593 struct main_hdr_v1 *hdr = img;
1594 uint32_t orig_datasz;
1599 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1601 codesz = sizeof(kwboot_baud_code) +
1602 sizeof(kwboot_baud_code_data_jump);
1603 code = kwboot_img_grow_data_right(img, size, codesz);
1605 codesz = sizeof(kwboot_baud_code_binhdr_pre) +
1606 sizeof(kwboot_baud_code) +
1607 sizeof(kwboot_baud_code_binhdr_post);
1608 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
1610 codesz = sizeof(kwboot_baud_code_binhdr_pre);
1611 memcpy(code, kwboot_baud_code_binhdr_pre, codesz);
1615 codesz = sizeof(kwboot_baud_code) - 2 * sizeof(uint32_t);
1616 memcpy(code, kwboot_baud_code, codesz);
1618 *(uint32_t *)code = cpu_to_le32(old_baud);
1619 code += sizeof(uint32_t);
1620 *(uint32_t *)code = cpu_to_le32(new_baud);
1621 code += sizeof(uint32_t);
1624 codesz = sizeof(kwboot_baud_code_data_jump) - sizeof(uint32_t);
1625 memcpy(code, kwboot_baud_code_data_jump, codesz);
1627 *(uint32_t *)code = hdr->execaddr;
1628 code += sizeof(uint32_t);
1629 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) + orig_datasz);
1631 codesz = sizeof(kwboot_baud_code_binhdr_post);
1632 memcpy(code, kwboot_baud_code_binhdr_post, codesz);
1638 kwboot_img_patch(void *img, size_t *size, int baudrate)
1640 struct main_hdr_v1 *hdr;
1649 if (*size < sizeof(struct main_hdr_v1))
1652 image_ver = kwbimage_version(img);
1653 if (image_ver != 0 && image_ver != 1) {
1654 fprintf(stderr, "Invalid image header version\n");
1658 hdrsz = kwbheader_size(hdr);
1663 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
1664 if (csum != hdr->checksum)
1667 srcaddr = le32_to_cpu(hdr->srcaddr);
1669 switch (hdr->blockid) {
1670 case IBR_HDR_SATA_ID:
1674 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1677 case IBR_HDR_SDIO_ID:
1678 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1681 case IBR_HDR_PEX_ID:
1682 if (srcaddr == 0xFFFFFFFF)
1683 hdr->srcaddr = cpu_to_le32(hdrsz);
1686 case IBR_HDR_SPI_ID:
1687 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1688 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1689 hdr->destaddr = cpu_to_le32(0x00800000);
1690 hdr->execaddr = cpu_to_le32(0x00800000);
1695 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
1696 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1699 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1702 is_secure = kwboot_img_is_secure(img);
1704 if (hdr->blockid != IBR_HDR_UART_ID) {
1707 "Image has secure header with signature for non-UART booting\n");
1711 kwboot_printv("Patching image boot signature to UART\n");
1712 hdr->blockid = IBR_HDR_UART_ID;
1716 if (image_ver == 1) {
1718 * Tell BootROM to send BootROM messages to UART port
1719 * number 0 (used also for UART booting) with default
1720 * baudrate (which should be 115200) and do not touch
1721 * UART MPP configuration.
1724 hdr->options &= ~0x1F;
1725 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1726 hdr->options |= 0 << 3;
1729 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1730 hdr->nandpagesize = 0;
1734 if (image_ver == 0) {
1736 "Cannot inject code for changing baudrate into v0 image header\n");
1742 "Cannot inject code for changing baudrate into image with secure header\n");
1747 * First inject code that changes the baudrate from the default
1748 * value of 115200 Bd to requested value. This code is inserted
1749 * as a new opt hdr, so it is executed by BootROM after the
1750 * header part is received.
1752 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1754 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
1757 * Now inject code that changes the baudrate back to 115200 Bd.
1758 * This code is appended after the data part of the image, and
1759 * execaddr is changed so that it is executed before U-Boot
1762 kwboot_printv("Injecting code for changing baudrate back\n");
1763 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
1765 /* Update the 32-bit data checksum */
1766 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1768 /* recompute header size */
1769 hdrsz = kwbheader_size(hdr);
1772 if (hdrsz % KWBOOT_XM_BLKSZ) {
1773 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
1776 fprintf(stderr, "Cannot align image with secure header\n");
1780 kwboot_printv("Aligning image header to Xmodem block size\n");
1781 kwboot_img_grow_hdr(img, size, grow);
1784 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
1786 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
1794 kwboot_usage(FILE *stream, char *progname)
1797 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
1799 fprintf(stream, "\n");
1801 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
1803 " -D <image>: boot <image> without preamble (Dove)\n");
1804 fprintf(stream, " -d: enter debug mode\n");
1805 fprintf(stream, " -a: use timings for Armada XP\n");
1806 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
1808 " -o <block-timeo>: use specific xmodem block timeout\n");
1809 fprintf(stream, "\n");
1810 fprintf(stream, " -t: mini terminal\n");
1811 fprintf(stream, "\n");
1812 fprintf(stream, " -B <baud>: set baud rate\n");
1813 fprintf(stream, "\n");
1817 main(int argc, char **argv)
1819 const char *ttypath, *imgpath;
1820 int rv, rc, tty, term;
1825 size_t after_img_rsv;
1838 after_img_rsv = KWBOOT_XM_BLKSZ;
1841 printf("kwboot version %s\n", PLAIN_VERSION);
1843 kwboot_verbose = isatty(STDOUT_FILENO);
1846 prev_optind = optind;
1847 c = getopt(argc, argv, "hbptaB:dD:q:s:o:");
1853 if (imgpath || bootmsg || debugmsg)
1856 if (prev_optind == optind)
1858 if (optind < argc - 1 && argv[optind] && argv[optind][0] != '-')
1859 imgpath = argv[optind++];
1863 if (imgpath || bootmsg || debugmsg)
1870 if (imgpath || bootmsg || debugmsg)
1876 /* nop, for backward compatibility */
1884 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1888 /* nop, for backward compatibility */
1892 msg_rsp_timeo = atoi(optarg);
1896 blk_rsp_timeo = atoi(optarg);
1900 baudrate = atoi(optarg);
1910 if (!bootmsg && !term && !debugmsg && !imgpath)
1913 ttypath = argv[optind++];
1918 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
1924 if (baudrate == 115200)
1925 /* do not change baudrate during Xmodem to the same value */
1928 /* ensure we have enough space for baudrate change code */
1929 after_img_rsv += sizeof(struct opt_hdr_v1) + 8 + 16 +
1930 sizeof(kwboot_baud_code_binhdr_pre) +
1931 sizeof(kwboot_baud_code) +
1932 sizeof(kwboot_baud_code_binhdr_post) +
1934 sizeof(kwboot_baud_code) +
1935 sizeof(kwboot_baud_code_data_jump) +
1939 img = kwboot_read_image(imgpath, &size, after_img_rsv);
1945 rc = kwboot_img_patch(img, &size, baudrate);
1947 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1953 rc = kwboot_debugmsg(tty);
1958 } else if (bootmsg) {
1959 rc = kwboot_bootmsg(tty);
1965 rc = kwboot_xmodem(tty, img, size, baudrate);
1973 rc = kwboot_terminal(tty);
1974 if (rc && !(errno == EINTR)) {
1991 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));