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 1000 /* ms */
79 #define KWBOOT_HDR_RSP_TIMEO 10000 /* ms */
81 /* ARM code making baudrate changing function return to original exec address */
82 static unsigned char kwboot_pre_baud_code[] = {
84 0x00, 0x00, 0x00, 0x00, /* .word 0 */
85 0x0c, 0xe0, 0x1f, 0xe5, /* ldr lr, exec_addr */
88 /* ARM code for binary header injection to change baudrate */
89 static unsigned char kwboot_baud_code[] = {
90 /* ; #define UART_BASE 0xd0012000 */
91 /* ; #define THR 0x00 */
92 /* ; #define DLL 0x00 */
93 /* ; #define DLH 0x04 */
94 /* ; #define LCR 0x0c */
95 /* ; #define DLAB 0x80 */
96 /* ; #define LSR 0x14 */
97 /* ; #define THRE 0x20 */
98 /* ; #define TEMT 0x40 */
99 /* ; #define DIV_ROUND(a, b) ((a + b/2) / b) */
101 /* ; u32 set_baudrate(u32 old_b, u32 new_b) { */
102 /* ; const u8 *str = "$baudratechange"; */
106 /* ; writel(UART_BASE + THR, c); */
109 /* ; (!(readl(UART_BASE + LSR) & TEMT)); */
110 /* ; u32 lcr = readl(UART_BASE + LCR); */
111 /* ; writel(UART_BASE + LCR, lcr | DLAB); */
112 /* ; u8 old_dll = readl(UART_BASE + DLL); */
113 /* ; u8 old_dlh = readl(UART_BASE + DLH); */
114 /* ; u16 old_dl = old_dll | (old_dlh << 8); */
115 /* ; u32 clk = old_b * old_dl; */
116 /* ; u16 new_dl = DIV_ROUND(clk, new_b); */
117 /* ; u8 new_dll = new_dl & 0xff; */
118 /* ; u8 new_dlh = (new_dl >> 8) & 0xff; */
119 /* ; writel(UART_BASE + DLL, new_dll); */
120 /* ; writel(UART_BASE + DLH, new_dlh); */
121 /* ; writel(UART_BASE + LCR, lcr & ~DLAB); */
126 0xfe, 0x5f, 0x2d, 0xe9, /* push { r1 - r12, lr } */
128 /* ; r0 = UART_BASE */
129 0x02, 0x0a, 0xa0, 0xe3, /* mov r0, #0x2000 */
130 0x01, 0x00, 0x4d, 0xe3, /* movt r0, #0xd001 */
132 /* ; r2 = address of preamble string */
133 0xd0, 0x20, 0x8f, 0xe2, /* adr r2, preamble */
135 /* ; Send preamble string over UART */
136 /* .Lloop_preamble: */
138 /* ; Wait until Transmitter Holding is Empty */
140 /* ; r1 = UART_BASE[LSR] & THRE */
141 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
142 0x20, 0x00, 0x11, 0xe3, /* tst r1, #0x20 */
143 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_thre */
145 /* ; Put character into Transmitter FIFO */
147 0x01, 0x10, 0xd2, 0xe4, /* ldrb r1, [r2], #1 */
148 /* ; UART_BASE[THR] = r1 */
149 0x00, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0] */
151 /* ; Loop until end of preamble string */
152 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
153 0xf8, 0xff, 0xff, 0x1a, /* bne .Lloop_preamble */
155 /* ; Wait until Transmitter FIFO is Empty */
156 /* .Lloop_txempty: */
157 /* ; r1 = UART_BASE[LSR] & TEMT */
158 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
159 0x40, 0x00, 0x11, 0xe3, /* tst r1, #0x40 */
160 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_txempty */
162 /* ; Set Divisor Latch Access Bit */
163 /* ; UART_BASE[LCR] |= DLAB */
164 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
165 0x80, 0x10, 0x81, 0xe3, /* orr r1, r1, #0x80 */
166 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
168 /* ; Read current Divisor Latch */
169 /* ; r1 = UART_BASE[DLH]<<8 | UART_BASE[DLL] */
170 0x00, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x00] */
171 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
172 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
173 0x04, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x04] */
174 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
175 0x41, 0x14, 0xa0, 0xe1, /* asr r1, r1, #8 */
176 0x02, 0x10, 0x81, 0xe1, /* orr r1, r1, r2 */
178 /* ; Read old baudrate value */
179 /* ; r2 = old_baudrate */
180 0x8c, 0x20, 0x9f, 0xe5, /* ldr r2, old_baudrate */
182 /* ; Calculate base clock */
184 0x92, 0x01, 0x01, 0xe0, /* mul r1, r2, r1 */
186 /* ; Read new baudrate value */
187 /* ; r2 = baudrate */
188 0x88, 0x20, 0x9f, 0xe5, /* ldr r2, baudrate */
190 /* ; Calculate new Divisor Latch */
191 /* ; r1 = DIV_ROUND(r1, r2) = */
192 /* ; = (r1 + r2/2) / r2 */
193 0xa2, 0x10, 0x81, 0xe0, /* add r1, r1, r2, lsr #1 */
194 0x02, 0x40, 0xa0, 0xe1, /* mov r4, r2 */
195 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
197 0x84, 0x40, 0xa0, 0x91, /* movls r4, r4, lsl #1 */
198 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
199 0xfc, 0xff, 0xff, 0x9a, /* bls .Lloop_div1 */
200 0x00, 0x30, 0xa0, 0xe3, /* mov r3, #0 */
202 0x04, 0x00, 0x51, 0xe1, /* cmp r1, r4 */
203 0x04, 0x10, 0x41, 0x20, /* subhs r1, r1, r4 */
204 0x03, 0x30, 0xa3, 0xe0, /* adc r3, r3, r3 */
205 0xa4, 0x40, 0xa0, 0xe1, /* mov r4, r4, lsr #1 */
206 0x02, 0x00, 0x54, 0xe1, /* cmp r4, r2 */
207 0xf9, 0xff, 0xff, 0x2a, /* bhs .Lloop_div2 */
208 0x03, 0x10, 0xa0, 0xe1, /* mov r1, r3 */
210 /* ; Set new Divisor Latch Low */
211 /* ; UART_BASE[DLL] = r1 & 0xff */
212 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
213 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
214 0x00, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x00] */
216 /* ; Set new Divisor Latch High */
217 /* ; UART_BASE[DLH] = r1>>8 & 0xff */
218 0x41, 0x24, 0xa0, 0xe1, /* asr r2, r1, #8 */
219 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
220 0x04, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x04] */
222 /* ; Clear Divisor Latch Access Bit */
223 /* ; UART_BASE[LCR] &= ~DLAB */
224 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
225 0x80, 0x10, 0xc1, 0xe3, /* bic r1, r1, #0x80 */
226 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
228 /* ; Sleep 1ms ~~ 600000 cycles at 1200 MHz */
230 0x9f, 0x1d, 0xa0, 0xe3, /* mov r1, #0x27c0 */
231 0x09, 0x10, 0x40, 0xe3, /* movt r1, #0x0009 */
233 0x01, 0x10, 0x41, 0xe2, /* sub r1, r1, #1 */
234 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
235 0xfc, 0xff, 0xff, 0x1a, /* bne .Lloop_sleep */
237 /* ; Return 0 - no error */
238 0x00, 0x00, 0xa0, 0xe3, /* mov r0, #0 */
239 0xfe, 0x9f, 0xbd, 0xe8, /* pop { r1 - r12, pc } */
241 /* ; Preamble string */
243 0x24, 0x62, 0x61, 0x75, /* .asciz "$baudratechange" */
244 0x64, 0x72, 0x61, 0x74,
245 0x65, 0x63, 0x68, 0x61,
246 0x6e, 0x67, 0x65, 0x00,
248 /* ; Placeholder for old baudrate value */
250 0x00, 0x00, 0x00, 0x00, /* .word 0 */
252 /* ; Placeholder for new baudrate value */
254 0x00, 0x00, 0x00, 0x00, /* .word 0 */
257 #define KWBOOT_BAUDRATE_BIN_HEADER_SZ (sizeof(kwboot_baud_code) + \
258 sizeof(struct opt_hdr_v1) + 8 + 16)
260 static const char kwb_baud_magic[16] = "$baudratechange";
262 static int kwboot_verbose;
264 static int msg_req_delay = KWBOOT_MSG_REQ_DELAY;
265 static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
266 static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
269 kwboot_write(int fd, const char *buf, size_t len)
274 ssize_t wr = write(fd, buf + tot, len - tot);
286 kwboot_printv(const char *fmt, ...)
290 if (kwboot_verbose) {
301 const char seq[] = { '-', '\\', '|', '/' };
303 static int state, bs;
305 if (state % div == 0) {
307 fputc(seq[state / div % sizeof(seq)], stdout);
323 __progress(int pct, char c)
325 const int width = 70;
326 static const char *nl = "";
329 if (pos % width == 0)
330 printf("%s%3d %% [", nl, pct);
335 pos = (pos + 1) % width;
338 while (pos && pos++ < width)
350 kwboot_progress(int _pct, char c)
365 kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
378 tv.tv_usec = timeo * 1000;
379 if (tv.tv_usec > 1000000) {
380 tv.tv_sec += tv.tv_usec / 1000000;
381 tv.tv_usec %= 1000000;
385 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
393 n = read(fd, buf, len);
397 buf = (char *)buf + n;
407 kwboot_tty_send(int fd, const void *buf, size_t len)
412 if (kwboot_write(fd, buf, len) < 0)
419 kwboot_tty_send_char(int fd, unsigned char c)
421 return kwboot_tty_send(fd, &c, 1);
425 kwboot_tty_baudrate_to_speed(int baudrate)
574 _is_within_tolerance(int value, int reference, int tolerance)
576 return 100 * value >= reference * (100 - tolerance) &&
577 100 * value <= reference * (100 + tolerance);
581 kwboot_tty_change_baudrate(int fd, int baudrate)
587 rc = tcgetattr(fd, &tio);
591 speed = kwboot_tty_baudrate_to_speed(baudrate);
599 tio.c_ospeed = tio.c_ispeed = baudrate;
602 rc = cfsetospeed(&tio, speed);
606 rc = cfsetispeed(&tio, speed);
610 rc = tcsetattr(fd, TCSANOW, &tio);
614 rc = tcgetattr(fd, &tio);
618 if (cfgetospeed(&tio) != speed || cfgetispeed(&tio) != speed)
623 * Check whether set baudrate is within 3% tolerance.
624 * If BOTHER is defined, Linux always fills out c_ospeed / c_ispeed
627 if (!_is_within_tolerance(tio.c_ospeed, baudrate, 3))
630 if (!_is_within_tolerance(tio.c_ispeed, baudrate, 3))
637 fprintf(stderr, "Could not set baudrate to requested value\n");
643 kwboot_open_tty(const char *path, int baudrate)
650 fd = open(path, O_RDWR | O_NOCTTY | O_NDELAY);
654 rc = tcgetattr(fd, &tio);
659 tio.c_cflag |= CREAD | CLOCAL;
660 tio.c_cflag &= ~(CSTOPB | HUPCL | CRTSCTS);
664 rc = tcsetattr(fd, TCSANOW, &tio);
668 flags = fcntl(fd, F_GETFL);
672 rc = fcntl(fd, F_SETFL, flags & ~O_NDELAY);
676 rc = kwboot_tty_change_baudrate(fd, baudrate);
691 kwboot_bootmsg(int tty, void *msg)
698 kwboot_printv("Please reboot the target into UART boot mode...");
700 kwboot_printv("Sending boot message. Please reboot the target...");
703 rc = tcflush(tty, TCIOFLUSH);
707 for (count = 0; count < 128; count++) {
708 rc = kwboot_tty_send(tty, msg, 8);
710 usleep(msg_req_delay * 1000);
715 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
719 } while (rc || c != NAK);
727 kwboot_debugmsg(int tty, void *msg)
731 kwboot_printv("Sending debug message. Please reboot the target...");
736 rc = tcflush(tty, TCIOFLUSH);
740 rc = kwboot_tty_send(tty, msg, 8);
742 usleep(msg_req_delay * 1000);
746 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
758 kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
759 size_t size, int pnum)
765 block->_pnum = ~block->pnum;
767 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
768 memcpy(&block->data[0], data, n);
769 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
772 for (i = 0; i < n; i++)
773 block->csum += block->data[i];
783 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
784 static int err_print;
787 perror("clock_gettime() does not work");
791 /* this will just make the timeout not work */
795 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
801 return c == ACK || c == NAK || c == CAN;
805 _xm_reply_to_error(int c)
828 kwboot_baud_magic_handle(int fd, char c, int baudrate)
830 static size_t rcv_len;
832 if (rcv_len < sizeof(kwb_baud_magic)) {
833 /* try to recognize whole magic word */
834 if (c == kwb_baud_magic[rcv_len]) {
837 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
843 if (rcv_len == sizeof(kwb_baud_magic)) {
844 /* magic word received */
845 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
847 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
854 kwboot_xm_recv_reply(int fd, char *c, int allow_non_xm, int *non_xm_print,
855 int baudrate, int *baud_changed)
857 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
858 uint64_t recv_until = _now() + timeout;
867 rc = kwboot_tty_recv(fd, c, 1, timeout);
869 if (errno != ETIMEDOUT)
871 else if (allow_non_xm && *non_xm_print)
877 /* If received xmodem reply, end. */
878 if (_is_xm_reply(*c))
882 * If receiving/printing non-xmodem text output is allowed and
883 * such a byte was received, we want to increase receiving time
885 * - print the byte, if it is not part of baudrate change magic
886 * sequence while baudrate change was requested (-B option)
888 * Otherwise decrease timeout by time elapsed.
891 recv_until = _now() + timeout;
893 if (baudrate && !*baud_changed) {
894 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
901 } else if (!baudrate || !*baud_changed) {
907 timeout = recv_until - _now();
919 kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
920 int *done_print, int baudrate)
922 int non_xm_print, baud_changed;
923 int rc, err, retries;
930 rc = kwboot_tty_send(fd, block, sizeof(*block));
934 if (allow_non_xm && !*done_print) {
935 kwboot_progress(100, '.');
936 kwboot_printv("Done\n");
940 rc = kwboot_xm_recv_reply(fd, &c, allow_non_xm, &non_xm_print,
941 baudrate, &baud_changed);
945 if (!allow_non_xm && c != ACK)
946 kwboot_progress(-1, '+');
947 } while (c == NAK && retries-- > 0);
952 if (allow_non_xm && baudrate && !baud_changed) {
953 fprintf(stderr, "Baudrate was not changed\n");
959 return _xm_reply_to_error(c);
962 kwboot_tty_send_char(fd, CAN);
969 kwboot_xm_finish(int fd)
974 kwboot_printv("Finishing transfer\n");
978 rc = kwboot_tty_send_char(fd, EOT);
982 rc = kwboot_xm_recv_reply(fd, &c, 0, NULL, 0, NULL);
985 } while (c == NAK && retries-- > 0);
987 return _xm_reply_to_error(c);
991 kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
992 size_t size, int baudrate)
998 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
999 header ? "header" : "data", size);
1004 while (sent < size) {
1005 struct kwboot_block block;
1009 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1012 last_block = (left <= blksz);
1014 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
1015 &done_print, baudrate);
1023 kwboot_progress(sent * 100 / size, '.');
1027 kwboot_printv("Done\n");
1031 kwboot_printv("\n");
1036 kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
1038 const uint8_t *img = _img;
1042 hdrsz = kwbheader_size(img);
1044 kwboot_printv("Waiting 2s and flushing tty\n");
1045 sleep(2); /* flush isn't effective without it */
1046 tcflush(tty, TCIOFLUSH);
1050 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
1057 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1061 rc = kwboot_xm_finish(tty);
1066 char buf[sizeof(kwb_baud_magic)];
1068 kwboot_printv("Waiting 1s for baudrate change magic\n");
1069 rc = kwboot_tty_recv(tty, buf, sizeof(buf), 1000);
1073 if (memcmp(buf, kwb_baud_magic, sizeof(buf))) {
1078 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1079 rc = kwboot_tty_change_baudrate(tty, 115200);
1088 kwboot_term_pipe(int in, int out, const char *quit, int *s)
1091 char _buf[128], *buf = _buf;
1093 nin = read(in, buf, sizeof(_buf));
1100 for (i = 0; i < nin; i++) {
1101 if (*buf == quit[*s]) {
1108 if (kwboot_write(out, quit, *s) < 0)
1115 if (kwboot_write(out, buf, nin) < 0)
1122 kwboot_terminal(int tty)
1125 const char *quit = "\34c";
1126 struct termios otio, tio;
1132 rc = tcgetattr(in, &otio);
1136 rc = tcsetattr(in, TCSANOW, &tio);
1139 perror("tcsetattr");
1143 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
1144 quit[0] | 0100, quit[1]);
1157 nfds = nfds < tty ? tty : nfds;
1161 nfds = nfds < in ? in : nfds;
1164 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1168 if (FD_ISSET(tty, &rfds)) {
1169 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1174 if (in >= 0 && FD_ISSET(in, &rfds)) {
1175 rc = kwboot_term_pipe(in, tty, quit, &s);
1179 } while (quit[s] != 0);
1182 tcsetattr(in, TCSANOW, &otio);
1189 kwboot_read_image(const char *path, size_t *size, size_t reserve)
1199 fd = open(path, O_RDONLY);
1203 rc = fstat(fd, &st);
1207 img = malloc(st.st_size + reserve);
1212 while (tot < st.st_size) {
1213 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1220 if (!rd && tot < st.st_size) {
1240 kwboot_hdr_csum8(const void *hdr)
1242 const uint8_t *data = hdr;
1246 size = kwbheader_size_for_csum(hdr);
1248 for (csum = 0; size-- > 0; data++)
1255 kwboot_img_csum32_ptr(void *img)
1257 struct main_hdr_v1 *hdr = img;
1260 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1262 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1266 kwboot_img_csum32(const void *img)
1268 const struct main_hdr_v1 *hdr = img;
1269 uint32_t datasz, csum = 0;
1270 const uint32_t *data;
1272 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1273 if (datasz % sizeof(uint32_t))
1276 data = img + le32_to_cpu(hdr->srcaddr);
1277 while (datasz > 0) {
1278 csum += le32_to_cpu(*data++);
1282 return cpu_to_le32(csum);
1286 kwboot_img_is_secure(void *img)
1288 struct opt_hdr_v1 *ohdr;
1290 for_each_opt_hdr_v1 (ohdr, img)
1291 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1298 kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
1300 struct main_hdr_v1 *hdr = img;
1304 * 32-bit checksum comes after end of image code, so we will be putting
1305 * new code there. So we get this pointer and then increase data size
1306 * (since increasing data size changes kwboot_img_csum32_ptr() return
1309 result = kwboot_img_csum32_ptr(img);
1310 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
1317 kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1319 uint32_t hdrsz, datasz, srcaddr;
1320 struct main_hdr_v1 *hdr = img;
1321 struct opt_hdr_v1 *ohdr;
1324 srcaddr = le32_to_cpu(hdr->srcaddr);
1326 /* calculate real used space in kwbimage header */
1327 if (kwbimage_version(img) == 0) {
1328 hdrsz = kwbheader_size(img);
1330 hdrsz = sizeof(*hdr);
1331 for_each_opt_hdr_v1 (ohdr, hdr)
1332 hdrsz += opt_hdr_v1_size(ohdr);
1335 data = (uint8_t *)img + srcaddr;
1336 datasz = *size - srcaddr;
1338 /* only move data if there is not enough space */
1339 if (hdrsz + grow > srcaddr) {
1340 size_t need = hdrsz + grow - srcaddr;
1342 /* move data by enough bytes */
1343 memmove(data + need, data, datasz);
1345 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1349 if (kwbimage_version(img) == 1) {
1351 if (hdrsz > kwbheader_size(img)) {
1352 hdr->headersz_msb = hdrsz >> 16;
1353 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1359 kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1361 struct main_hdr_v1 *hdr = img;
1362 struct opt_hdr_v1 *ohdr;
1368 if (hdr->ext & 0x1) {
1369 for_each_opt_hdr_v1 (ohdr, img)
1370 if (opt_hdr_v1_next(ohdr) == NULL)
1373 prev_ext = opt_hdr_v1_ext(ohdr);
1374 ohdr = _opt_hdr_v1_next(ohdr);
1376 ohdr = (void *)(hdr + 1);
1377 prev_ext = &hdr->ext;
1381 * ARM executable code inside the BIN header on some mvebu platforms
1382 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1383 * This requirement can be met by inserting dummy arguments into
1384 * BIN header, if needed.
1386 offset = &ohdr->data[4] - (char *)img;
1387 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1389 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1390 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1394 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1395 ohdr->headersz_msb = ohdrsz >> 16;
1396 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1398 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
1399 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
1401 return &ohdr->data[4 + 4 * num_args];
1405 _inject_baudrate_change_code(void *img, size_t *size, int pre,
1406 int old_baud, int new_baud)
1408 uint32_t codesz = sizeof(kwboot_baud_code);
1409 struct main_hdr_v1 *hdr = img;
1413 uint32_t presz = sizeof(kwboot_pre_baud_code);
1414 uint32_t orig_datasz;
1416 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1418 code = kwboot_img_grow_data_right(img, size, presz + codesz);
1421 * We need to prepend code that loads lr register with original
1422 * value of hdr->execaddr. We do this by putting the original
1423 * exec address before the code that loads it relatively from
1425 * Afterwards we change the exec address to this code (which is
1426 * at offset 4, because the first 4 bytes contain the original
1429 memcpy(code, kwboot_pre_baud_code, presz);
1430 *(uint32_t *)code = hdr->execaddr;
1432 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) +
1437 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
1440 memcpy(code, kwboot_baud_code, codesz - 8);
1441 *(uint32_t *)(code + codesz - 8) = cpu_to_le32(old_baud);
1442 *(uint32_t *)(code + codesz - 4) = cpu_to_le32(new_baud);
1446 kwboot_img_patch(void *img, size_t *size, int baudrate)
1448 struct main_hdr_v1 *hdr;
1457 if (*size < sizeof(struct main_hdr_v1))
1460 image_ver = kwbimage_version(img);
1461 if (image_ver != 0 && image_ver != 1) {
1462 fprintf(stderr, "Invalid image header version\n");
1466 hdrsz = kwbheader_size(hdr);
1471 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
1472 if (csum != hdr->checksum)
1475 srcaddr = le32_to_cpu(hdr->srcaddr);
1477 switch (hdr->blockid) {
1478 case IBR_HDR_SATA_ID:
1482 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1485 case IBR_HDR_SDIO_ID:
1486 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1489 case IBR_HDR_PEX_ID:
1490 if (srcaddr == 0xFFFFFFFF)
1491 hdr->srcaddr = cpu_to_le32(hdrsz);
1494 case IBR_HDR_SPI_ID:
1495 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1496 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1497 hdr->destaddr = cpu_to_le32(0x00800000);
1498 hdr->execaddr = cpu_to_le32(0x00800000);
1503 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
1504 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1507 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1510 is_secure = kwboot_img_is_secure(img);
1512 if (hdr->blockid != IBR_HDR_UART_ID) {
1515 "Image has secure header with signature for non-UART booting\n");
1519 kwboot_printv("Patching image boot signature to UART\n");
1520 hdr->blockid = IBR_HDR_UART_ID;
1524 if (image_ver == 1) {
1526 * Tell BootROM to send BootROM messages to UART port
1527 * number 0 (used also for UART booting) with default
1528 * baudrate (which should be 115200) and do not touch
1529 * UART MPP configuration.
1531 hdr->options &= ~0x1F;
1532 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1533 hdr->options |= 0 << 3;
1536 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1537 hdr->nandpagesize = 0;
1541 if (image_ver == 0) {
1543 "Cannot inject code for changing baudrate into v0 image header\n");
1549 "Cannot inject code for changing baudrate into image with secure header\n");
1554 * First inject code that changes the baudrate from the default
1555 * value of 115200 Bd to requested value. This code is inserted
1556 * as a new opt hdr, so it is executed by BootROM after the
1557 * header part is received.
1559 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1561 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
1564 * Now inject code that changes the baudrate back to 115200 Bd.
1565 * This code is appended after the data part of the image, and
1566 * execaddr is changed so that it is executed before U-Boot
1569 kwboot_printv("Injecting code for changing baudrate back\n");
1570 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
1572 /* Update the 32-bit data checksum */
1573 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1575 /* recompute header size */
1576 hdrsz = kwbheader_size(hdr);
1579 if (hdrsz % KWBOOT_XM_BLKSZ) {
1580 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
1583 fprintf(stderr, "Cannot align image with secure header\n");
1587 kwboot_printv("Aligning image header to Xmodem block size\n");
1588 kwboot_img_grow_hdr(img, size, grow);
1591 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
1593 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
1601 kwboot_usage(FILE *stream, char *progname)
1603 fprintf(stream, "kwboot version %s\n", PLAIN_VERSION);
1605 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
1607 fprintf(stream, "\n");
1609 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
1611 " -D <image>: boot <image> without preamble (Dove)\n");
1612 fprintf(stream, " -d: enter debug mode\n");
1613 fprintf(stream, " -a: use timings for Armada XP\n");
1614 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
1615 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
1617 " -o <block-timeo>: use specific xmodem block timeout\n");
1618 fprintf(stream, "\n");
1619 fprintf(stream, " -t: mini terminal\n");
1620 fprintf(stream, "\n");
1621 fprintf(stream, " -B <baud>: set baud rate\n");
1622 fprintf(stream, "\n");
1626 main(int argc, char **argv)
1628 const char *ttypath, *imgpath;
1629 int rv, rc, tty, term;
1634 size_t after_img_rsv;
1645 after_img_rsv = KWBOOT_XM_BLKSZ;
1648 kwboot_verbose = isatty(STDOUT_FILENO);
1651 int c = getopt(argc, argv, "hb:ptaB:dD:q:s:o:");
1657 bootmsg = kwboot_msg_boot;
1667 debugmsg = kwboot_msg_debug;
1671 /* nop, for backward compatibility */
1679 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
1680 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1684 msg_req_delay = atoi(optarg);
1688 msg_rsp_timeo = atoi(optarg);
1692 blk_rsp_timeo = atoi(optarg);
1696 baudrate = atoi(optarg);
1706 if (!bootmsg && !term && !debugmsg)
1709 if (argc - optind < 1)
1712 ttypath = argv[optind++];
1714 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
1720 if (baudrate == 115200)
1721 /* do not change baudrate during Xmodem to the same value */
1724 /* ensure we have enough space for baudrate change code */
1725 after_img_rsv += KWBOOT_BAUDRATE_BIN_HEADER_SZ +
1727 sizeof(kwboot_pre_baud_code) +
1728 sizeof(kwboot_baud_code) +
1732 img = kwboot_read_image(imgpath, &size, after_img_rsv);
1738 rc = kwboot_img_patch(img, &size, baudrate);
1740 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1746 rc = kwboot_debugmsg(tty, debugmsg);
1751 } else if (bootmsg) {
1752 rc = kwboot_bootmsg(tty, bootmsg);
1760 rc = kwboot_xmodem(tty, img, size, baudrate);
1768 rc = kwboot_terminal(tty);
1769 if (rc && !(errno == EINTR)) {
1786 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));