blob: 2d2d545d82587d6af0cfb4517405e7157284f9dd [file] [log] [blame]
Luka Perkovdff289642012-05-27 11:44:51 +00001/*
Stefan Roesebb5c4282014-10-22 12:13:21 +02002 * Boot a Marvell SoC, with Xmodem over UART0.
Marek Behúndb5b53e2021-09-24 23:07:13 +02003 * supports Kirkwood, Dove, Armada 370, Armada XP, Armada 375, Armada 38x and
4 * Armada 39x
Luka Perkovdff289642012-05-27 11:44:51 +00005 *
6 * (c) 2012 Daniel Stodden <daniel.stodden@gmail.com>
Pali Roháraa98a1e2021-09-24 23:07:14 +02007 * (c) 2021 Pali Rohár <pali@kernel.org>
8 * (c) 2021 Marek Behún <marek.behun@nic.cz>
Luka Perkovdff289642012-05-27 11:44:51 +00009 *
10 * References: marvell.com, "88F6180, 88F6190, 88F6192, and 88F6281
11 * Integrated Controller: Functional Specifications" December 2,
12 * 2008. Chapter 24.2 "BootROM Firmware".
13 */
14
Stefan Roese04ec0d32016-01-07 14:12:04 +010015#include "kwbimage.h"
16#include "mkimage.h"
Pali Rohár3c703aaf2021-09-24 23:06:42 +020017#include "version.h"
Stefan Roese04ec0d32016-01-07 14:12:04 +010018
Luka Perkovdff289642012-05-27 11:44:51 +000019#include <stdlib.h>
20#include <stdio.h>
21#include <string.h>
22#include <stdarg.h>
Stefan Roese04ec0d32016-01-07 14:12:04 +010023#include <image.h>
Luka Perkovdff289642012-05-27 11:44:51 +000024#include <libgen.h>
25#include <fcntl.h>
26#include <errno.h>
27#include <unistd.h>
28#include <stdint.h>
Marek Behún2d9f2452021-09-24 23:06:52 +020029#include <time.h>
Luka Perkovdff289642012-05-27 11:44:51 +000030#include <sys/stat.h>
31
Pali Rohárfd935e92021-09-24 23:07:06 +020032#ifdef __linux__
33#include "termios_linux.h"
34#else
35#include <termios.h>
36#endif
37
Luka Perkovdff289642012-05-27 11:44:51 +000038/*
39 * Marvell BootROM UART Sensing
40 */
41
42static unsigned char kwboot_msg_boot[] = {
43 0xBB, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
44};
45
Stefan Roesebb5c4282014-10-22 12:13:21 +020046static unsigned char kwboot_msg_debug[] = {
47 0xDD, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
48};
49
50/* Defines known to work on Kirkwood */
Luka Perkovdff289642012-05-27 11:44:51 +000051#define KWBOOT_MSG_REQ_DELAY 10 /* ms */
52#define KWBOOT_MSG_RSP_TIMEO 50 /* ms */
53
Stefan Roesebb5c4282014-10-22 12:13:21 +020054/* 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 */
57
Luka Perkovdff289642012-05-27 11:44:51 +000058/*
59 * Xmodem Transfers
60 */
61
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 */
Luka Perkovdff289642012-05-27 11:44:51 +000066
Pali Rohárbed18ef2021-09-24 23:06:48 +020067#define KWBOOT_XM_BLKSZ 128 /* xmodem block size */
68
Luka Perkovdff289642012-05-27 11:44:51 +000069struct kwboot_block {
70 uint8_t soh;
71 uint8_t pnum;
72 uint8_t _pnum;
Pali Rohárbed18ef2021-09-24 23:06:48 +020073 uint8_t data[KWBOOT_XM_BLKSZ];
Luka Perkovdff289642012-05-27 11:44:51 +000074 uint8_t csum;
Pali Rohárf01adfd2021-07-23 11:14:14 +020075} __packed;
Luka Perkovdff289642012-05-27 11:44:51 +000076
Pali Rohárdef98382022-01-25 18:13:00 +010077#define KWBOOT_BLK_RSP_TIMEO 2000 /* ms */
Marek Behún2d9f2452021-09-24 23:06:52 +020078#define KWBOOT_HDR_RSP_TIMEO 10000 /* ms */
Luka Perkovdff289642012-05-27 11:44:51 +000079
Pali Rohár6303a232021-10-27 20:57:02 +020080/* ARM code to change baudrate */
Pali Rohár2a8b7692021-09-24 23:07:05 +020081static unsigned char kwboot_baud_code[] = {
82 /* ; #define UART_BASE 0xd0012000 */
Pali Rohár2a8b7692021-09-24 23:07:05 +020083 /* ; #define DLL 0x00 */
84 /* ; #define DLH 0x04 */
85 /* ; #define LCR 0x0c */
86 /* ; #define DLAB 0x80 */
87 /* ; #define LSR 0x14 */
Pali Rohár2a8b7692021-09-24 23:07:05 +020088 /* ; #define TEMT 0x40 */
89 /* ; #define DIV_ROUND(a, b) ((a + b/2) / b) */
90 /* ; */
91 /* ; u32 set_baudrate(u32 old_b, u32 new_b) { */
Pali Rohár2a8b7692021-09-24 23:07:05 +020092 /* ; while */
93 /* ; (!(readl(UART_BASE + LSR) & TEMT)); */
94 /* ; u32 lcr = readl(UART_BASE + LCR); */
95 /* ; writel(UART_BASE + LCR, lcr | DLAB); */
96 /* ; u8 old_dll = readl(UART_BASE + DLL); */
97 /* ; u8 old_dlh = readl(UART_BASE + DLH); */
98 /* ; u16 old_dl = old_dll | (old_dlh << 8); */
99 /* ; u32 clk = old_b * old_dl; */
100 /* ; u16 new_dl = DIV_ROUND(clk, new_b); */
101 /* ; u8 new_dll = new_dl & 0xff; */
102 /* ; u8 new_dlh = (new_dl >> 8) & 0xff; */
103 /* ; writel(UART_BASE + DLL, new_dll); */
104 /* ; writel(UART_BASE + DLH, new_dlh); */
105 /* ; writel(UART_BASE + LCR, lcr & ~DLAB); */
Pali Rohár9e624c92021-10-27 20:57:00 +0200106 /* ; msleep(5); */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200107 /* ; return 0; */
108 /* ; } */
109
Pali Rohár2a8b7692021-09-24 23:07:05 +0200110 /* ; r0 = UART_BASE */
Pali Rohár15b16e52021-10-27 20:57:01 +0200111 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
112 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200113
Pali Rohár2a8b7692021-09-24 23:07:05 +0200114 /* ; Wait until Transmitter FIFO is Empty */
115 /* .Lloop_txempty: */
116 /* ; r1 = UART_BASE[LSR] & TEMT */
117 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
118 0x40, 0x00, 0x11, 0xe3, /* tst r1, #0x40 */
119 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_txempty */
120
121 /* ; Set Divisor Latch Access Bit */
122 /* ; UART_BASE[LCR] |= DLAB */
123 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
124 0x80, 0x10, 0x81, 0xe3, /* orr r1, r1, #0x80 */
125 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
126
127 /* ; Read current Divisor Latch */
128 /* ; r1 = UART_BASE[DLH]<<8 | UART_BASE[DLL] */
129 0x00, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x00] */
130 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
131 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
132 0x04, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x04] */
133 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
134 0x41, 0x14, 0xa0, 0xe1, /* asr r1, r1, #8 */
135 0x02, 0x10, 0x81, 0xe1, /* orr r1, r1, r2 */
136
137 /* ; Read old baudrate value */
138 /* ; r2 = old_baudrate */
Pali Rohár2d760ed2021-11-01 14:00:02 +0100139 0x74, 0x20, 0x9f, 0xe5, /* ldr r2, old_baudrate */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200140
141 /* ; Calculate base clock */
142 /* ; r1 = r2 * r1 */
143 0x92, 0x01, 0x01, 0xe0, /* mul r1, r2, r1 */
144
145 /* ; Read new baudrate value */
Pali Rohár9e624c92021-10-27 20:57:00 +0200146 /* ; r2 = new_baudrate */
Pali Rohár2d760ed2021-11-01 14:00:02 +0100147 0x70, 0x20, 0x9f, 0xe5, /* ldr r2, new_baudrate */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200148
149 /* ; Calculate new Divisor Latch */
150 /* ; r1 = DIV_ROUND(r1, r2) = */
151 /* ; = (r1 + r2/2) / r2 */
152 0xa2, 0x10, 0x81, 0xe0, /* add r1, r1, r2, lsr #1 */
153 0x02, 0x40, 0xa0, 0xe1, /* mov r4, r2 */
154 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
155 /* .Lloop_div1: */
156 0x84, 0x40, 0xa0, 0x91, /* movls r4, r4, lsl #1 */
157 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
158 0xfc, 0xff, 0xff, 0x9a, /* bls .Lloop_div1 */
159 0x00, 0x30, 0xa0, 0xe3, /* mov r3, #0 */
160 /* .Lloop_div2: */
161 0x04, 0x00, 0x51, 0xe1, /* cmp r1, r4 */
162 0x04, 0x10, 0x41, 0x20, /* subhs r1, r1, r4 */
163 0x03, 0x30, 0xa3, 0xe0, /* adc r3, r3, r3 */
164 0xa4, 0x40, 0xa0, 0xe1, /* mov r4, r4, lsr #1 */
165 0x02, 0x00, 0x54, 0xe1, /* cmp r4, r2 */
166 0xf9, 0xff, 0xff, 0x2a, /* bhs .Lloop_div2 */
167 0x03, 0x10, 0xa0, 0xe1, /* mov r1, r3 */
168
169 /* ; Set new Divisor Latch Low */
170 /* ; UART_BASE[DLL] = r1 & 0xff */
171 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
172 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
173 0x00, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x00] */
174
175 /* ; Set new Divisor Latch High */
176 /* ; UART_BASE[DLH] = r1>>8 & 0xff */
177 0x41, 0x24, 0xa0, 0xe1, /* asr r2, r1, #8 */
178 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
179 0x04, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x04] */
180
181 /* ; Clear Divisor Latch Access Bit */
182 /* ; UART_BASE[LCR] &= ~DLAB */
183 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
184 0x80, 0x10, 0xc1, 0xe3, /* bic r1, r1, #0x80 */
185 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
186
Pali Rohár9e624c92021-10-27 20:57:00 +0200187 /* ; Loop 0x2dc000 (2998272) cycles */
188 /* ; which is about 5ms on 1200 MHz CPU */
189 /* ; r1 = 0x2dc000 */
190 0xb7, 0x19, 0xa0, 0xe3, /* mov r1, #0x2dc000 */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200191 /* .Lloop_sleep: */
192 0x01, 0x10, 0x41, 0xe2, /* sub r1, r1, #1 */
193 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
194 0xfc, 0xff, 0xff, 0x1a, /* bne .Lloop_sleep */
195
Pali Rohár2d760ed2021-11-01 14:00:02 +0100196 /* ; Jump to the end of execution */
197 0x01, 0x00, 0x00, 0xea, /* b end */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200198
199 /* ; Placeholder for old baudrate value */
200 /* old_baudrate: */
201 0x00, 0x00, 0x00, 0x00, /* .word 0 */
202
203 /* ; Placeholder for new baudrate value */
204 /* new_baudrate: */
205 0x00, 0x00, 0x00, 0x00, /* .word 0 */
Pali Rohár6303a232021-10-27 20:57:02 +0200206
207 /* end: */
208};
209
Pali Rohár2d760ed2021-11-01 14:00:02 +0100210/* ARM code from binary header executed by BootROM before changing baudrate */
Pali Rohár6303a232021-10-27 20:57:02 +0200211static unsigned char kwboot_baud_code_binhdr_pre[] = {
Pali Rohár2d760ed2021-11-01 14:00:02 +0100212 /* ; #define UART_BASE 0xd0012000 */
213 /* ; #define THR 0x00 */
214 /* ; #define LSR 0x14 */
215 /* ; #define THRE 0x20 */
216 /* ; */
217 /* ; void send_preamble(void) { */
218 /* ; const u8 *str = "$baudratechange"; */
219 /* ; u8 c; */
220 /* ; do { */
221 /* ; while */
222 /* ; ((readl(UART_BASE + LSR) & THRE)); */
223 /* ; c = *str++; */
224 /* ; writel(UART_BASE + THR, c); */
225 /* ; } while (c); */
226 /* ; } */
227
228 /* ; Preserve registers for BootROM */
Pali Rohár6303a232021-10-27 20:57:02 +0200229 0xfe, 0x5f, 0x2d, 0xe9, /* push { r1 - r12, lr } */
Pali Rohár2d760ed2021-11-01 14:00:02 +0100230
231 /* ; r0 = UART_BASE */
232 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
233 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
234
235 /* ; r2 = address of preamble string */
236 0x00, 0x20, 0x8f, 0xe2, /* adr r2, .Lstr_preamble */
237
238 /* ; Skip preamble data section */
239 0x03, 0x00, 0x00, 0xea, /* b .Lloop_preamble */
240
241 /* ; Preamble string */
242 /* .Lstr_preamble: */
243 0x24, 0x62, 0x61, 0x75, /* .asciz "$baudratechange" */
244 0x64, 0x72, 0x61, 0x74,
245 0x65, 0x63, 0x68, 0x61,
246 0x6e, 0x67, 0x65, 0x00,
247
248 /* ; Send preamble string over UART */
249 /* .Lloop_preamble: */
250 /* */
251 /* ; Wait until Transmitter Holding is Empty */
252 /* .Lloop_thre: */
253 /* ; r1 = UART_BASE[LSR] & THRE */
254 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
255 0x20, 0x00, 0x11, 0xe3, /* tst r1, #0x20 */
256 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_thre */
257
258 /* ; Put character into Transmitter FIFO */
259 /* ; r1 = *r2++ */
260 0x01, 0x10, 0xd2, 0xe4, /* ldrb r1, [r2], #1 */
261 /* ; UART_BASE[THR] = r1 */
262 0x00, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0] */
263
264 /* ; Loop until end of preamble string */
265 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
266 0xf8, 0xff, 0xff, 0x1a, /* bne .Lloop_preamble */
Pali Rohár6303a232021-10-27 20:57:02 +0200267};
268
Pali Rohár2d760ed2021-11-01 14:00:02 +0100269/* ARM code for returning from binary header back to BootROM */
Pali Rohár6303a232021-10-27 20:57:02 +0200270static unsigned char kwboot_baud_code_binhdr_post[] = {
271 /* ; Return 0 - no error */
272 0x00, 0x00, 0xa0, 0xe3, /* mov r0, #0 */
273 0xfe, 0x9f, 0xbd, 0xe8, /* pop { r1 - r12, pc } */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200274};
275
Pali Rohár6303a232021-10-27 20:57:02 +0200276/* ARM code for jumping to the original image exec_addr */
277static unsigned char kwboot_baud_code_data_jump[] = {
278 0x04, 0xf0, 0x1f, 0xe5, /* ldr pc, exec_addr */
279 /* ; Placeholder for exec_addr */
280 /* exec_addr: */
281 0x00, 0x00, 0x00, 0x00, /* .word 0 */
282};
Pali Rohár2a8b7692021-09-24 23:07:05 +0200283
284static const char kwb_baud_magic[16] = "$baudratechange";
285
Luka Perkovdff289642012-05-27 11:44:51 +0000286static int kwboot_verbose;
287
Stefan Roesebb5c4282014-10-22 12:13:21 +0200288static int msg_req_delay = KWBOOT_MSG_REQ_DELAY;
289static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
Kevin Smith4d31a842016-02-16 21:28:19 +0000290static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
Stefan Roesebb5c4282014-10-22 12:13:21 +0200291
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200292static ssize_t
293kwboot_write(int fd, const char *buf, size_t len)
294{
Pali Rohár5350df12022-01-25 18:13:10 +0100295 ssize_t tot = 0;
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200296
297 while (tot < len) {
298 ssize_t wr = write(fd, buf + tot, len - tot);
299
Pali Rohár5350df12022-01-25 18:13:10 +0100300 if (wr < 0 && errno == EINTR)
301 continue;
302 else if (wr < 0)
303 return wr;
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200304
305 tot += wr;
306 }
307
308 return tot;
309}
310
Luka Perkovdff289642012-05-27 11:44:51 +0000311static void
312kwboot_printv(const char *fmt, ...)
313{
314 va_list ap;
315
316 if (kwboot_verbose) {
317 va_start(ap, fmt);
318 vprintf(fmt, ap);
319 va_end(ap);
320 fflush(stdout);
321 }
322}
323
324static void
325__spinner(void)
326{
327 const char seq[] = { '-', '\\', '|', '/' };
328 const int div = 8;
329 static int state, bs;
330
331 if (state % div == 0) {
332 fputc(bs, stdout);
333 fputc(seq[state / div % sizeof(seq)], stdout);
334 fflush(stdout);
335 }
336
337 bs = '\b';
338 state++;
339}
340
341static void
342kwboot_spinner(void)
343{
344 if (kwboot_verbose)
345 __spinner();
346}
347
348static void
349__progress(int pct, char c)
350{
351 const int width = 70;
352 static const char *nl = "";
353 static int pos;
354
355 if (pos % width == 0)
356 printf("%s%3d %% [", nl, pct);
357
358 fputc(c, stdout);
359
360 nl = "]\n";
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200361 pos = (pos + 1) % width;
Luka Perkovdff289642012-05-27 11:44:51 +0000362
363 if (pct == 100) {
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200364 while (pos && pos++ < width)
Luka Perkovdff289642012-05-27 11:44:51 +0000365 fputc(' ', stdout);
366 fputs(nl, stdout);
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200367 nl = "";
368 pos = 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000369 }
370
371 fflush(stdout);
372
373}
374
375static void
376kwboot_progress(int _pct, char c)
377{
378 static int pct;
379
380 if (_pct != -1)
381 pct = _pct;
382
383 if (kwboot_verbose)
384 __progress(pct, c);
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200385
386 if (pct == 100)
387 pct = 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000388}
389
390static int
391kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
392{
393 int rc, nfds;
394 fd_set rfds;
395 struct timeval tv;
396 ssize_t n;
397
398 rc = -1;
399
400 FD_ZERO(&rfds);
401 FD_SET(fd, &rfds);
402
403 tv.tv_sec = 0;
404 tv.tv_usec = timeo * 1000;
405 if (tv.tv_usec > 1000000) {
406 tv.tv_sec += tv.tv_usec / 1000000;
407 tv.tv_usec %= 1000000;
408 }
409
410 do {
411 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
Pali Rohár613bd8b2022-01-25 18:13:11 +0100412 if (nfds < 0 && errno == EINTR)
413 continue;
414 else if (nfds < 0)
Luka Perkovdff289642012-05-27 11:44:51 +0000415 goto out;
Pali Rohár613bd8b2022-01-25 18:13:11 +0100416 else if (!nfds) {
Luka Perkovdff289642012-05-27 11:44:51 +0000417 errno = ETIMEDOUT;
418 goto out;
419 }
420
421 n = read(fd, buf, len);
Pali Rohár613bd8b2022-01-25 18:13:11 +0100422 if (n < 0 && errno == EINTR)
423 continue;
424 else if (n <= 0)
Luka Perkovdff289642012-05-27 11:44:51 +0000425 goto out;
426
427 buf = (char *)buf + n;
428 len -= n;
429 } while (len > 0);
430
431 rc = 0;
432out:
433 return rc;
434}
435
436static int
Pali Rohárf2acbba2021-10-27 20:56:59 +0200437kwboot_tty_send(int fd, const void *buf, size_t len, int nodrain)
Luka Perkovdff289642012-05-27 11:44:51 +0000438{
Stefan Roesebb5c4282014-10-22 12:13:21 +0200439 if (!buf)
440 return 0;
441
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200442 if (kwboot_write(fd, buf, len) < 0)
443 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +0000444
Pali Rohárf2acbba2021-10-27 20:56:59 +0200445 if (nodrain)
446 return 0;
447
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200448 return tcdrain(fd);
Luka Perkovdff289642012-05-27 11:44:51 +0000449}
450
451static int
452kwboot_tty_send_char(int fd, unsigned char c)
453{
Pali Rohárf2acbba2021-10-27 20:56:59 +0200454 return kwboot_tty_send(fd, &c, 1, 0);
Luka Perkovdff289642012-05-27 11:44:51 +0000455}
456
457static speed_t
Pali Rohár2a8b7692021-09-24 23:07:05 +0200458kwboot_tty_baudrate_to_speed(int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +0000459{
460 switch (baudrate) {
Pali Rohár2a8b7692021-09-24 23:07:05 +0200461#ifdef B4000000
462 case 4000000:
463 return B4000000;
464#endif
465#ifdef B3500000
466 case 3500000:
467 return B3500000;
468#endif
469#ifdef B3000000
470 case 3000000:
471 return B3000000;
472#endif
473#ifdef B2500000
474 case 2500000:
475 return B2500000;
476#endif
477#ifdef B2000000
478 case 2000000:
479 return B2000000;
480#endif
481#ifdef B1500000
482 case 1500000:
483 return B1500000;
484#endif
485#ifdef B1152000
486 case 1152000:
487 return B1152000;
488#endif
489#ifdef B1000000
490 case 1000000:
491 return B1000000;
492#endif
493#ifdef B921600
494 case 921600:
495 return B921600;
496#endif
497#ifdef B614400
498 case 614400:
499 return B614400;
500#endif
501#ifdef B576000
502 case 576000:
503 return B576000;
504#endif
505#ifdef B500000
506 case 500000:
507 return B500000;
508#endif
509#ifdef B460800
510 case 460800:
511 return B460800;
512#endif
513#ifdef B307200
514 case 307200:
515 return B307200;
516#endif
517#ifdef B230400
518 case 230400:
519 return B230400;
520#endif
521#ifdef B153600
522 case 153600:
523 return B153600;
524#endif
525#ifdef B115200
Luka Perkovdff289642012-05-27 11:44:51 +0000526 case 115200:
527 return B115200;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200528#endif
529#ifdef B76800
530 case 76800:
531 return B76800;
532#endif
533#ifdef B57600
Luka Perkovdff289642012-05-27 11:44:51 +0000534 case 57600:
535 return B57600;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200536#endif
537#ifdef B38400
Luka Perkovdff289642012-05-27 11:44:51 +0000538 case 38400:
539 return B38400;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200540#endif
541#ifdef B19200
Luka Perkovdff289642012-05-27 11:44:51 +0000542 case 19200:
543 return B19200;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200544#endif
545#ifdef B9600
Luka Perkovdff289642012-05-27 11:44:51 +0000546 case 9600:
547 return B9600;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200548#endif
549#ifdef B4800
550 case 4800:
551 return B4800;
552#endif
553#ifdef B2400
554 case 2400:
555 return B2400;
556#endif
557#ifdef B1800
558 case 1800:
559 return B1800;
560#endif
561#ifdef B1200
562 case 1200:
563 return B1200;
564#endif
565#ifdef B600
566 case 600:
567 return B600;
568#endif
569#ifdef B300
570 case 300:
571 return B300;
572#endif
573#ifdef B200
574 case 200:
575 return B200;
576#endif
577#ifdef B150
578 case 150:
579 return B150;
580#endif
581#ifdef B134
582 case 134:
583 return B134;
584#endif
585#ifdef B110
586 case 110:
587 return B110;
588#endif
589#ifdef B75
590 case 75:
591 return B75;
592#endif
593#ifdef B50
594 case 50:
595 return B50;
596#endif
597 default:
Pali Rohárfd935e92021-09-24 23:07:06 +0200598#ifdef BOTHER
599 return BOTHER;
600#else
Pali Rohár2a8b7692021-09-24 23:07:05 +0200601 return B0;
Pali Rohárfd935e92021-09-24 23:07:06 +0200602#endif
Luka Perkovdff289642012-05-27 11:44:51 +0000603 }
Pali Rohár2a8b7692021-09-24 23:07:05 +0200604}
605
606static int
Marek Behún67835492021-09-24 23:07:07 +0200607_is_within_tolerance(int value, int reference, int tolerance)
608{
609 return 100 * value >= reference * (100 - tolerance) &&
610 100 * value <= reference * (100 + tolerance);
611}
612
613static int
Pali Rohár2a8b7692021-09-24 23:07:05 +0200614kwboot_tty_change_baudrate(int fd, int baudrate)
615{
616 struct termios tio;
617 speed_t speed;
618 int rc;
619
620 rc = tcgetattr(fd, &tio);
621 if (rc)
622 return rc;
623
624 speed = kwboot_tty_baudrate_to_speed(baudrate);
625 if (speed == B0) {
626 errno = EINVAL;
627 return -1;
628 }
629
Pali Rohárfd935e92021-09-24 23:07:06 +0200630#ifdef BOTHER
631 if (speed == BOTHER)
632 tio.c_ospeed = tio.c_ispeed = baudrate;
633#endif
634
Pali Rohár2a8b7692021-09-24 23:07:05 +0200635 rc = cfsetospeed(&tio, speed);
636 if (rc)
637 return rc;
638
639 rc = cfsetispeed(&tio, speed);
640 if (rc)
641 return rc;
Luka Perkovdff289642012-05-27 11:44:51 +0000642
Pali Rohár2a8b7692021-09-24 23:07:05 +0200643 rc = tcsetattr(fd, TCSANOW, &tio);
644 if (rc)
645 return rc;
646
Marek Behún67835492021-09-24 23:07:07 +0200647 rc = tcgetattr(fd, &tio);
648 if (rc)
649 return rc;
650
651 if (cfgetospeed(&tio) != speed || cfgetispeed(&tio) != speed)
652 goto baud_fail;
653
654#ifdef BOTHER
655 /*
656 * Check whether set baudrate is within 3% tolerance.
657 * If BOTHER is defined, Linux always fills out c_ospeed / c_ispeed
658 * with real values.
659 */
660 if (!_is_within_tolerance(tio.c_ospeed, baudrate, 3))
661 goto baud_fail;
662
663 if (!_is_within_tolerance(tio.c_ispeed, baudrate, 3))
664 goto baud_fail;
665#endif
666
Pali Rohár2a8b7692021-09-24 23:07:05 +0200667 return 0;
Marek Behún67835492021-09-24 23:07:07 +0200668
669baud_fail:
670 fprintf(stderr, "Could not set baudrate to requested value\n");
671 errno = EINVAL;
672 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +0000673}
674
675static int
Pali Rohár2a8b7692021-09-24 23:07:05 +0200676kwboot_open_tty(const char *path, int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +0000677{
Pali Rohár2bffe242021-09-24 23:07:10 +0200678 int rc, fd, flags;
Luka Perkovdff289642012-05-27 11:44:51 +0000679 struct termios tio;
680
681 rc = -1;
682
Marek Behún6c598c32021-09-24 23:07:11 +0200683 fd = open(path, O_RDWR | O_NOCTTY | O_NDELAY);
Luka Perkovdff289642012-05-27 11:44:51 +0000684 if (fd < 0)
685 goto out;
686
Pali Rohár909a0b92021-09-24 23:07:08 +0200687 rc = tcgetattr(fd, &tio);
688 if (rc)
689 goto out;
Luka Perkovdff289642012-05-27 11:44:51 +0000690
Pali Rohár909a0b92021-09-24 23:07:08 +0200691 cfmakeraw(&tio);
Marek Behún6c598c32021-09-24 23:07:11 +0200692 tio.c_cflag |= CREAD | CLOCAL;
Pali Rohár40003a02021-10-25 15:12:53 +0200693 tio.c_cflag &= ~(CSTOPB | HUPCL | CRTSCTS);
Luka Perkovdff289642012-05-27 11:44:51 +0000694 tio.c_cc[VMIN] = 1;
Pali Rohár12095b22021-09-24 23:07:09 +0200695 tio.c_cc[VTIME] = 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000696
Luka Perkovdff289642012-05-27 11:44:51 +0000697 rc = tcsetattr(fd, TCSANOW, &tio);
698 if (rc)
699 goto out;
700
Pali Rohár2bffe242021-09-24 23:07:10 +0200701 flags = fcntl(fd, F_GETFL);
702 if (flags < 0)
703 goto out;
704
705 rc = fcntl(fd, F_SETFL, flags & ~O_NDELAY);
706 if (rc)
707 goto out;
708
Pali Rohár2a8b7692021-09-24 23:07:05 +0200709 rc = kwboot_tty_change_baudrate(fd, baudrate);
710 if (rc)
711 goto out;
712
Luka Perkovdff289642012-05-27 11:44:51 +0000713 rc = fd;
714out:
715 if (rc < 0) {
716 if (fd >= 0)
717 close(fd);
718 }
719
720 return rc;
721}
722
723static int
724kwboot_bootmsg(int tty, void *msg)
725{
Pali Roháre68c27bd2022-01-25 18:13:08 +0100726 struct kwboot_block block;
Luka Perkovdff289642012-05-27 11:44:51 +0000727 int rc;
728 char c;
Jon Nettleton0e428ee2018-08-13 18:24:38 +0300729 int count;
Luka Perkovdff289642012-05-27 11:44:51 +0000730
Stefan Roesebb5c4282014-10-22 12:13:21 +0200731 if (msg == NULL)
732 kwboot_printv("Please reboot the target into UART boot mode...");
733 else
734 kwboot_printv("Sending boot message. Please reboot the target...");
Luka Perkovdff289642012-05-27 11:44:51 +0000735
736 do {
737 rc = tcflush(tty, TCIOFLUSH);
738 if (rc)
739 break;
740
Jon Nettleton0e428ee2018-08-13 18:24:38 +0300741 for (count = 0; count < 128; count++) {
Pali Rohárf2acbba2021-10-27 20:56:59 +0200742 rc = kwboot_tty_send(tty, msg, 8, 0);
Jon Nettleton0e428ee2018-08-13 18:24:38 +0300743 if (rc) {
744 usleep(msg_req_delay * 1000);
745 continue;
746 }
Luka Perkovdff289642012-05-27 11:44:51 +0000747 }
748
Stefan Roesebb5c4282014-10-22 12:13:21 +0200749 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
Luka Perkovdff289642012-05-27 11:44:51 +0000750
751 kwboot_spinner();
752
753 } while (rc || c != NAK);
754
755 kwboot_printv("\n");
756
Pali Roháre68c27bd2022-01-25 18:13:08 +0100757 if (rc)
758 return rc;
759
760 /*
761 * At this stage we have sent more boot message patterns and BootROM
762 * (at least on Armada XP and 385) started interpreting sent bytes as
763 * part of xmodem packets. If BootROM is expecting SOH byte as start of
764 * a xmodem packet and it receives byte 0xff, then it throws it away and
765 * sends a NAK reply to host. If BootROM does not receive any byte for
766 * 2s when expecting some continuation of the xmodem packet, it throws
767 * away the partially received xmodem data and sends NAK reply to host.
768 *
769 * Therefore for starting xmodem transfer we have two options: Either
770 * wait 2s or send 132 0xff bytes (which is the size of xmodem packet)
771 * to ensure that BootROM throws away any partially received data.
772 */
773
774 /* flush output queue with remaining boot message patterns */
775 tcflush(tty, TCOFLUSH);
776
777 /* send one xmodem packet with 0xff bytes to force BootROM to re-sync */
778 memset(&block, 0xff, sizeof(block));
779 kwboot_tty_send(tty, &block, sizeof(block), 0);
780
781 /*
782 * Sending 132 bytes via 115200B/8-N-1 takes 11.45 ms, reading 132 bytes
783 * takes 11.45 ms, so waiting for 30 ms should be enough.
784 */
785 usleep(30 * 1000);
786
787 /* flush remaining NAK replies from input queue */
788 tcflush(tty, TCIFLUSH);
789
790 return 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000791}
792
793static int
Stefan Roesebb5c4282014-10-22 12:13:21 +0200794kwboot_debugmsg(int tty, void *msg)
795{
796 int rc;
797
798 kwboot_printv("Sending debug message. Please reboot the target...");
799
800 do {
801 char buf[16];
802
803 rc = tcflush(tty, TCIOFLUSH);
804 if (rc)
805 break;
806
Pali Rohárf2acbba2021-10-27 20:56:59 +0200807 rc = kwboot_tty_send(tty, msg, 8, 0);
Stefan Roesebb5c4282014-10-22 12:13:21 +0200808 if (rc) {
809 usleep(msg_req_delay * 1000);
810 continue;
811 }
812
813 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
814
815 kwboot_spinner();
816
817 } while (rc);
818
819 kwboot_printv("\n");
820
821 return rc;
822}
823
Pali Rohár58cf04de2021-09-24 23:06:44 +0200824static size_t
Luka Perkovdff289642012-05-27 11:44:51 +0000825kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
826 size_t size, int pnum)
827{
Marek Behúnedb63242021-09-24 23:06:45 +0200828 size_t i, n;
Luka Perkovdff289642012-05-27 11:44:51 +0000829
Stefan Roesebb5c4282014-10-22 12:13:21 +0200830 block->soh = SOH;
Luka Perkovdff289642012-05-27 11:44:51 +0000831 block->pnum = pnum;
832 block->_pnum = ~block->pnum;
833
Pali Rohárbed18ef2021-09-24 23:06:48 +0200834 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
Luka Perkovdff289642012-05-27 11:44:51 +0000835 memcpy(&block->data[0], data, n);
Pali Rohárbed18ef2021-09-24 23:06:48 +0200836 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
Luka Perkovdff289642012-05-27 11:44:51 +0000837
838 block->csum = 0;
839 for (i = 0; i < n; i++)
840 block->csum += block->data[i];
841
842 return n;
843}
844
Marek Behún2d9f2452021-09-24 23:06:52 +0200845static uint64_t
846_now(void)
847{
848 struct timespec ts;
849
850 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
851 static int err_print;
852
853 if (!err_print) {
854 perror("clock_gettime() does not work");
855 err_print = 1;
856 }
857
858 /* this will just make the timeout not work */
859 return -1ULL;
860 }
861
862 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
863}
864
Luka Perkovdff289642012-05-27 11:44:51 +0000865static int
Marek Behúneabacb82021-09-24 23:06:49 +0200866_is_xm_reply(char c)
867{
Pali Rohár6af14292022-01-25 18:13:03 +0100868 return c == ACK || c == NAK;
Marek Behúneabacb82021-09-24 23:06:49 +0200869}
870
871static int
Pali Rohár42c61a42021-09-24 23:06:54 +0200872_xm_reply_to_error(int c)
873{
874 int rc = -1;
875
876 switch (c) {
877 case ACK:
878 rc = 0;
879 break;
880 case NAK:
881 errno = EBADMSG;
882 break;
Pali Rohár42c61a42021-09-24 23:06:54 +0200883 default:
884 errno = EPROTO;
885 break;
886 }
887
888 return rc;
889}
890
891static int
Pali Rohár2a8b7692021-09-24 23:07:05 +0200892kwboot_baud_magic_handle(int fd, char c, int baudrate)
893{
894 static size_t rcv_len;
895
896 if (rcv_len < sizeof(kwb_baud_magic)) {
897 /* try to recognize whole magic word */
898 if (c == kwb_baud_magic[rcv_len]) {
899 rcv_len++;
900 } else {
901 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
902 fflush(stdout);
903 rcv_len = 0;
904 }
905 }
906
907 if (rcv_len == sizeof(kwb_baud_magic)) {
908 /* magic word received */
909 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
910
911 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
912 } else {
913 return 0;
914 }
915}
916
917static int
Pali Rohár230d4f82022-01-25 18:13:04 +0100918kwboot_xm_recv_reply(int fd, char *c, int stop_on_non_xm,
Pali Roháre4529bd2022-01-25 18:13:02 +0100919 int ignore_nak_reply,
Pali Rohár959e8502021-10-25 15:13:04 +0200920 int allow_non_xm, int *non_xm_print,
Pali Rohár2a8b7692021-09-24 23:07:05 +0200921 int baudrate, int *baud_changed)
Pali Rohárd06d5202021-09-24 23:06:50 +0200922{
Marek Behún2d9f2452021-09-24 23:06:52 +0200923 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
Marek Behún0a3b85a2021-09-24 23:06:53 +0200924 uint64_t recv_until = _now() + timeout;
Pali Rohárd06d5202021-09-24 23:06:50 +0200925 int rc;
926
927 while (1) {
Marek Behún2d9f2452021-09-24 23:06:52 +0200928 rc = kwboot_tty_recv(fd, c, 1, timeout);
Pali Rohárd06d5202021-09-24 23:06:50 +0200929 if (rc) {
930 if (errno != ETIMEDOUT)
931 return rc;
Marek Behún0a3b85a2021-09-24 23:06:53 +0200932 else if (allow_non_xm && *non_xm_print)
Marek Behún2d9f2452021-09-24 23:06:52 +0200933 return -1;
934 else
935 *c = NAK;
Pali Rohárd06d5202021-09-24 23:06:50 +0200936 }
937
938 /* If received xmodem reply, end. */
Pali Roháre4529bd2022-01-25 18:13:02 +0100939 if (_is_xm_reply(*c)) {
940 if (*c == NAK && ignore_nak_reply) {
941 timeout = recv_until - _now();
942 if (timeout >= 0)
943 continue;
944 }
Pali Rohárd06d5202021-09-24 23:06:50 +0200945 break;
Pali Roháre4529bd2022-01-25 18:13:02 +0100946 }
Pali Rohárd06d5202021-09-24 23:06:50 +0200947
948 /*
Pali Rohár2a8b7692021-09-24 23:07:05 +0200949 * If receiving/printing non-xmodem text output is allowed and
950 * such a byte was received, we want to increase receiving time
951 * and either:
952 * - print the byte, if it is not part of baudrate change magic
953 * sequence while baudrate change was requested (-B option)
954 * - change baudrate
Marek Behún0a3b85a2021-09-24 23:06:53 +0200955 * Otherwise decrease timeout by time elapsed.
Pali Rohárd06d5202021-09-24 23:06:50 +0200956 */
957 if (allow_non_xm) {
Marek Behún2d9f2452021-09-24 23:06:52 +0200958 recv_until = _now() + timeout;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200959
960 if (baudrate && !*baud_changed) {
961 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
962 if (rc == 1)
963 *baud_changed = 1;
964 else if (!rc)
965 *non_xm_print = 1;
966 else
967 return rc;
968 } else if (!baudrate || !*baud_changed) {
969 putchar(*c);
970 fflush(stdout);
971 *non_xm_print = 1;
972 }
Marek Behún0a3b85a2021-09-24 23:06:53 +0200973 } else {
Pali Rohár230d4f82022-01-25 18:13:04 +0100974 if (stop_on_non_xm)
Pali Rohár959e8502021-10-25 15:13:04 +0200975 break;
Marek Behún0a3b85a2021-09-24 23:06:53 +0200976 timeout = recv_until - _now();
977 if (timeout < 0) {
978 errno = ETIMEDOUT;
979 return -1;
980 }
Pali Rohárd06d5202021-09-24 23:06:50 +0200981 }
982 }
983
984 return 0;
985}
986
987static int
988kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
Pali Rohár80241ce2022-01-25 18:13:05 +0100989 int *done_print, int baudrate, int allow_retries)
Luka Perkovdff289642012-05-27 11:44:51 +0000990{
Pali Rohár2a8b7692021-09-24 23:07:05 +0200991 int non_xm_print, baud_changed;
992 int rc, err, retries;
Luka Perkovdff289642012-05-27 11:44:51 +0000993 char c;
994
Pali Rohárd06d5202021-09-24 23:06:50 +0200995 *done_print = 0;
Pali Rohár6daa5612021-10-27 20:56:58 +0200996 non_xm_print = 0;
997 baud_changed = 0;
Pali Rohárd06d5202021-09-24 23:06:50 +0200998
Pali Roháre665c6a2021-10-25 15:13:03 +0200999 retries = 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001000 do {
Pali Rohárf2acbba2021-10-27 20:56:59 +02001001 rc = kwboot_tty_send(fd, block, sizeof(*block), 1);
Luka Perkovdff289642012-05-27 11:44:51 +00001002 if (rc)
Pali Rohár6af14292022-01-25 18:13:03 +01001003 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001004
Pali Rohárd06d5202021-09-24 23:06:50 +02001005 if (allow_non_xm && !*done_print) {
1006 kwboot_progress(100, '.');
1007 kwboot_printv("Done\n");
1008 *done_print = 1;
1009 }
Stefan Roesebb5c4282014-10-22 12:13:21 +02001010
Pali Rohár959e8502021-10-25 15:13:04 +02001011 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Roháre4529bd2022-01-25 18:13:02 +01001012 retries > 8,
Pali Rohár959e8502021-10-25 15:13:04 +02001013 allow_non_xm, &non_xm_print,
Pali Rohár2a8b7692021-09-24 23:07:05 +02001014 baudrate, &baud_changed);
Pali Rohárd06d5202021-09-24 23:06:50 +02001015 if (rc)
Pali Rohár6af14292022-01-25 18:13:03 +01001016 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001017
Pali Rohárb3760f92022-01-25 18:13:06 +01001018 if (!allow_non_xm && c != ACK) {
1019 if (c == NAK && allow_retries && retries + 1 < 16)
1020 kwboot_progress(-1, '+');
1021 else
1022 kwboot_progress(-1, 'E');
1023 }
Pali Rohár80241ce2022-01-25 18:13:05 +01001024 } while (c == NAK && allow_retries && retries++ < 16);
Luka Perkovdff289642012-05-27 11:44:51 +00001025
Marek Behúnbcc5e042021-09-24 23:06:51 +02001026 if (non_xm_print)
1027 kwboot_printv("\n");
1028
Pali Rohár2a8b7692021-09-24 23:07:05 +02001029 if (allow_non_xm && baudrate && !baud_changed) {
1030 fprintf(stderr, "Baudrate was not changed\n");
Pali Rohár2a8b7692021-09-24 23:07:05 +02001031 errno = EPROTO;
Pali Rohár6af14292022-01-25 18:13:03 +01001032 return -1;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001033 }
1034
Pali Rohár42c61a42021-09-24 23:06:54 +02001035 return _xm_reply_to_error(c);
Pali Rohár6af14292022-01-25 18:13:03 +01001036err:
Pali Rohár2a8b7692021-09-24 23:07:05 +02001037 err = errno;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001038 kwboot_printv("\n");
1039 errno = err;
1040 return rc;
Pali Rohár42c61a42021-09-24 23:06:54 +02001041}
Luka Perkovdff289642012-05-27 11:44:51 +00001042
Pali Rohár42c61a42021-09-24 23:06:54 +02001043static int
1044kwboot_xm_finish(int fd)
1045{
1046 int rc, retries;
1047 char c;
Luka Perkovdff289642012-05-27 11:44:51 +00001048
Pali Rohár42c61a42021-09-24 23:06:54 +02001049 kwboot_printv("Finishing transfer\n");
1050
Pali Roháre665c6a2021-10-25 15:13:03 +02001051 retries = 0;
Pali Rohár42c61a42021-09-24 23:06:54 +02001052 do {
1053 rc = kwboot_tty_send_char(fd, EOT);
1054 if (rc)
1055 return rc;
1056
Pali Rohár959e8502021-10-25 15:13:04 +02001057 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Roháre4529bd2022-01-25 18:13:02 +01001058 retries > 8,
Pali Rohár959e8502021-10-25 15:13:04 +02001059 0, NULL, 0, NULL);
Pali Rohár42c61a42021-09-24 23:06:54 +02001060 if (rc)
1061 return rc;
Pali Roháre665c6a2021-10-25 15:13:03 +02001062 } while (c == NAK && retries++ < 16);
Pali Rohár42c61a42021-09-24 23:06:54 +02001063
1064 return _xm_reply_to_error(c);
Luka Perkovdff289642012-05-27 11:44:51 +00001065}
1066
1067static int
Pali Rohárbed18ef2021-09-24 23:06:48 +02001068kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
Pali Rohár2a8b7692021-09-24 23:07:05 +02001069 size_t size, int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +00001070{
Pali Rohárd06d5202021-09-24 23:06:50 +02001071 int done_print = 0;
Pali Rohárbed18ef2021-09-24 23:06:48 +02001072 size_t sent, left;
1073 int rc;
Luka Perkovdff289642012-05-27 11:44:51 +00001074
Pali Rohárbed18ef2021-09-24 23:06:48 +02001075 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
1076 header ? "header" : "data", size);
Luka Perkovdff289642012-05-27 11:44:51 +00001077
Pali Rohárbed18ef2021-09-24 23:06:48 +02001078 left = size;
1079 sent = 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001080
Pali Rohárbed18ef2021-09-24 23:06:48 +02001081 while (sent < size) {
Luka Perkovdff289642012-05-27 11:44:51 +00001082 struct kwboot_block block;
Pali Rohárd06d5202021-09-24 23:06:50 +02001083 int last_block;
Pali Rohárbed18ef2021-09-24 23:06:48 +02001084 size_t blksz;
Luka Perkovdff289642012-05-27 11:44:51 +00001085
Pali Rohárbed18ef2021-09-24 23:06:48 +02001086 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1087 data += blksz;
Luka Perkovdff289642012-05-27 11:44:51 +00001088
Pali Rohárd06d5202021-09-24 23:06:50 +02001089 last_block = (left <= blksz);
1090
Pali Rohár80241ce2022-01-25 18:13:05 +01001091 /*
1092 * Handling of repeated xmodem packets is completely broken in
1093 * Armada 385 BootROM - it completely ignores xmodem packet
1094 * numbers, they are only used for checksum verification.
1095 * BootROM can handle a retry of the xmodem packet only during
1096 * the transmission of kwbimage header and only if BootROM
1097 * itself sent NAK response to previous attempt (it does it on
1098 * checksum failure). During the transmission of kwbimage data
1099 * part, BootROM always expects next xmodem packet, even if it
1100 * sent NAK to previous attempt - there is absolutely no way to
1101 * repair incorrectly transmitted xmodem packet during kwbimage
1102 * data part upload. Also, if kwboot receives non-ACK/NAK
1103 * response (meaning that original BootROM response was damaged
1104 * on UART) there is no way to detect if BootROM accepted xmodem
1105 * packet or not and no way to check if kwboot could repeat the
1106 * packet or not.
1107 *
1108 * Stop transfer and return failure if kwboot receives unknown
1109 * reply if non-xmodem reply is not allowed (for all xmodem
1110 * packets except the last header packet) or when non-ACK reply
1111 * is received during data part transfer.
1112 */
Pali Rohárd06d5202021-09-24 23:06:50 +02001113 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
Pali Rohár80241ce2022-01-25 18:13:05 +01001114 &done_print, baudrate, header);
Luka Perkovdff289642012-05-27 11:44:51 +00001115 if (rc)
1116 goto out;
1117
Pali Rohárbed18ef2021-09-24 23:06:48 +02001118 sent += blksz;
1119 left -= blksz;
1120
Pali Rohárd06d5202021-09-24 23:06:50 +02001121 if (!done_print)
1122 kwboot_progress(sent * 100 / size, '.');
Pali Rohárbed18ef2021-09-24 23:06:48 +02001123 }
Luka Perkovdff289642012-05-27 11:44:51 +00001124
Pali Rohárd06d5202021-09-24 23:06:50 +02001125 if (!done_print)
1126 kwboot_printv("Done\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001127
Pali Rohárbed18ef2021-09-24 23:06:48 +02001128 return 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001129out:
Pali Rohár5ed896f2021-09-24 23:06:47 +02001130 kwboot_printv("\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001131 return rc;
Pali Rohárbed18ef2021-09-24 23:06:48 +02001132}
1133
1134static int
Pali Rohár2a8b7692021-09-24 23:07:05 +02001135kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
Pali Rohárbed18ef2021-09-24 23:06:48 +02001136{
1137 const uint8_t *img = _img;
1138 int rc, pnum;
1139 size_t hdrsz;
1140
Marek Behúnd1b0b032021-09-24 23:07:01 +02001141 hdrsz = kwbheader_size(img);
Pali Rohárbed18ef2021-09-24 23:06:48 +02001142
Pali Rohár400b5cf2021-11-05 23:29:58 +01001143 /*
1144 * If header size is not aligned to xmodem block size (which applies
1145 * for all images in kwbimage v0 format) then we have to ensure that
1146 * the last xmodem block of header contains beginning of the data
1147 * followed by the header. So align header size to xmodem block size.
1148 */
1149 hdrsz += (KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ) % KWBOOT_XM_BLKSZ;
1150
Pali Rohárbed18ef2021-09-24 23:06:48 +02001151 pnum = 1;
1152
Pali Rohár2a8b7692021-09-24 23:07:05 +02001153 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
Pali Rohárbed18ef2021-09-24 23:06:48 +02001154 if (rc)
1155 return rc;
1156
Pali Rohár400b5cf2021-11-05 23:29:58 +01001157 /*
1158 * If we have already sent image data as a part of the last
1159 * xmodem header block then we have nothing more to send.
1160 */
1161 if (hdrsz < size) {
1162 img += hdrsz;
1163 size -= hdrsz;
1164 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1165 if (rc)
1166 return rc;
1167 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001168
1169 rc = kwboot_xm_finish(tty);
Pali Rohárbed18ef2021-09-24 23:06:48 +02001170 if (rc)
1171 return rc;
Luka Perkovdff289642012-05-27 11:44:51 +00001172
Pali Rohár2a8b7692021-09-24 23:07:05 +02001173 if (baudrate) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001174 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1175 rc = kwboot_tty_change_baudrate(tty, 115200);
1176 if (rc)
1177 return rc;
1178 }
1179
1180 return 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001181}
1182
1183static int
Marek Behúnea5b2b32021-09-24 23:06:40 +02001184kwboot_term_pipe(int in, int out, const char *quit, int *s)
Luka Perkovdff289642012-05-27 11:44:51 +00001185{
Pali Rohár111779f2022-02-03 17:45:20 +01001186 char buf[128];
Marek Behúnd3bc5c32021-09-24 23:06:41 +02001187 ssize_t nin;
Luka Perkovdff289642012-05-27 11:44:51 +00001188
Pali Rohár111779f2022-02-03 17:45:20 +01001189 nin = read(in, buf, sizeof(buf));
Willy Tarreauab7e8a12018-07-03 12:10:31 -04001190 if (nin <= 0)
Luka Perkovdff289642012-05-27 11:44:51 +00001191 return -1;
1192
1193 if (quit) {
1194 int i;
1195
1196 for (i = 0; i < nin; i++) {
Pali Rohár111779f2022-02-03 17:45:20 +01001197 if (buf[i] == quit[*s]) {
Luka Perkovdff289642012-05-27 11:44:51 +00001198 (*s)++;
Pali Rohár111779f2022-02-03 17:45:20 +01001199 if (!quit[*s]) {
Pali Rohár6a5d1312022-02-18 12:24:13 +01001200 nin = (i > *s) ? (i - *s) : 0;
Pali Rohár111779f2022-02-03 17:45:20 +01001201 break;
1202 }
Pali Rohár48615ba2021-07-23 11:14:20 +02001203 } else {
Pali Rohár111779f2022-02-03 17:45:20 +01001204 if (*s > i && kwboot_write(out, quit, *s - i) < 0)
Marek Behúnd3bc5c32021-09-24 23:06:41 +02001205 return -1;
1206 *s = 0;
Pali Rohár48615ba2021-07-23 11:14:20 +02001207 }
Luka Perkovdff289642012-05-27 11:44:51 +00001208 }
Pali Rohár111779f2022-02-03 17:45:20 +01001209
1210 if (i == nin)
Pali Rohár6a5d1312022-02-18 12:24:13 +01001211 nin -= (nin > *s) ? *s : nin;
Luka Perkovdff289642012-05-27 11:44:51 +00001212 }
1213
Marek Behúnd3bc5c32021-09-24 23:06:41 +02001214 if (kwboot_write(out, buf, nin) < 0)
1215 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +00001216
1217 return 0;
1218}
1219
1220static int
1221kwboot_terminal(int tty)
1222{
1223 int rc, in, s;
Marek Behúnea5b2b32021-09-24 23:06:40 +02001224 const char *quit = "\34c";
Luka Perkovdff289642012-05-27 11:44:51 +00001225 struct termios otio, tio;
1226
1227 rc = -1;
1228
1229 in = STDIN_FILENO;
1230 if (isatty(in)) {
1231 rc = tcgetattr(in, &otio);
1232 if (!rc) {
1233 tio = otio;
1234 cfmakeraw(&tio);
1235 rc = tcsetattr(in, TCSANOW, &tio);
1236 }
1237 if (rc) {
1238 perror("tcsetattr");
1239 goto out;
1240 }
1241
1242 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
Marek Behún6c598c32021-09-24 23:07:11 +02001243 quit[0] | 0100, quit[1]);
Luka Perkovdff289642012-05-27 11:44:51 +00001244 } else
1245 in = -1;
1246
1247 rc = 0;
1248 s = 0;
1249
1250 do {
1251 fd_set rfds;
1252 int nfds = 0;
1253
Pali Rohárc1efca42021-10-25 15:12:52 +02001254 FD_ZERO(&rfds);
Luka Perkovdff289642012-05-27 11:44:51 +00001255 FD_SET(tty, &rfds);
1256 nfds = nfds < tty ? tty : nfds;
1257
1258 if (in >= 0) {
1259 FD_SET(in, &rfds);
1260 nfds = nfds < in ? in : nfds;
1261 }
1262
1263 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1264 if (nfds < 0)
1265 break;
1266
1267 if (FD_ISSET(tty, &rfds)) {
1268 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1269 if (rc)
1270 break;
1271 }
1272
Marek Behún4eb55de2021-09-24 23:06:39 +02001273 if (in >= 0 && FD_ISSET(in, &rfds)) {
Luka Perkovdff289642012-05-27 11:44:51 +00001274 rc = kwboot_term_pipe(in, tty, quit, &s);
1275 if (rc)
1276 break;
1277 }
1278 } while (quit[s] != 0);
1279
Pali Roháreafc9692021-07-23 11:14:18 +02001280 if (in >= 0)
1281 tcsetattr(in, TCSANOW, &otio);
Pali Rohár049cf912021-07-23 11:14:19 +02001282 printf("\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001283out:
1284 return rc;
1285}
1286
1287static void *
Pali Rohárd9355bf2021-09-24 23:07:03 +02001288kwboot_read_image(const char *path, size_t *size, size_t reserve)
Luka Perkovdff289642012-05-27 11:44:51 +00001289{
Pali Rohár4d276012021-09-24 23:06:55 +02001290 int rc, fd;
Luka Perkovdff289642012-05-27 11:44:51 +00001291 struct stat st;
1292 void *img;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001293 off_t tot;
Luka Perkovdff289642012-05-27 11:44:51 +00001294
1295 rc = -1;
Luka Perkovdff289642012-05-27 11:44:51 +00001296 img = NULL;
1297
1298 fd = open(path, O_RDONLY);
1299 if (fd < 0)
1300 goto out;
1301
1302 rc = fstat(fd, &st);
1303 if (rc)
1304 goto out;
1305
Pali Rohárd9355bf2021-09-24 23:07:03 +02001306 img = malloc(st.st_size + reserve);
1307 if (!img)
Luka Perkovdff289642012-05-27 11:44:51 +00001308 goto out;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001309
1310 tot = 0;
1311 while (tot < st.st_size) {
1312 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1313
1314 if (rd < 0)
1315 goto out;
1316
1317 tot += rd;
1318
1319 if (!rd && tot < st.st_size) {
1320 errno = EIO;
1321 goto out;
1322 }
Luka Perkovdff289642012-05-27 11:44:51 +00001323 }
1324
1325 rc = 0;
1326 *size = st.st_size;
1327out:
1328 if (rc && img) {
Pali Rohárd9355bf2021-09-24 23:07:03 +02001329 free(img);
Luka Perkovdff289642012-05-27 11:44:51 +00001330 img = NULL;
1331 }
1332 if (fd >= 0)
1333 close(fd);
1334
1335 return img;
1336}
1337
1338static uint8_t
Marek Behúnd1b0b032021-09-24 23:07:01 +02001339kwboot_hdr_csum8(const void *hdr)
Luka Perkovdff289642012-05-27 11:44:51 +00001340{
Marek Behúnd1b0b032021-09-24 23:07:01 +02001341 const uint8_t *data = hdr;
1342 uint8_t csum;
1343 size_t size;
1344
1345 size = kwbheader_size_for_csum(hdr);
Luka Perkovdff289642012-05-27 11:44:51 +00001346
1347 for (csum = 0; size-- > 0; data++)
1348 csum += *data;
1349
1350 return csum;
1351}
1352
Pali Rohár0b659e52021-10-25 15:12:55 +02001353static uint32_t *
1354kwboot_img_csum32_ptr(void *img)
1355{
1356 struct main_hdr_v1 *hdr = img;
1357 uint32_t datasz;
1358
1359 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1360
1361 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1362}
1363
1364static uint32_t
1365kwboot_img_csum32(const void *img)
1366{
1367 const struct main_hdr_v1 *hdr = img;
1368 uint32_t datasz, csum = 0;
1369 const uint32_t *data;
1370
1371 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1372 if (datasz % sizeof(uint32_t))
1373 return 0;
1374
1375 data = img + le32_to_cpu(hdr->srcaddr);
1376 while (datasz > 0) {
1377 csum += le32_to_cpu(*data++);
1378 datasz -= 4;
1379 }
1380
1381 return cpu_to_le32(csum);
1382}
1383
Luka Perkovdff289642012-05-27 11:44:51 +00001384static int
Pali Rohár5725e0c2021-09-24 23:06:57 +02001385kwboot_img_is_secure(void *img)
1386{
1387 struct opt_hdr_v1 *ohdr;
1388
1389 for_each_opt_hdr_v1 (ohdr, img)
1390 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1391 return 1;
1392
1393 return 0;
1394}
1395
Pali Rohár2a8b7692021-09-24 23:07:05 +02001396static void *
Pali Roháraed39f22021-10-25 15:12:56 +02001397kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
Pali Rohár2a8b7692021-09-24 23:07:05 +02001398{
Pali Rohár2a8b7692021-09-24 23:07:05 +02001399 struct main_hdr_v1 *hdr = img;
Pali Roháraed39f22021-10-25 15:12:56 +02001400 void *result;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001401
Pali Roháraed39f22021-10-25 15:12:56 +02001402 /*
1403 * 32-bit checksum comes after end of image code, so we will be putting
1404 * new code there. So we get this pointer and then increase data size
1405 * (since increasing data size changes kwboot_img_csum32_ptr() return
1406 * value).
1407 */
1408 result = kwboot_img_csum32_ptr(img);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001409 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
Pali Roháraed39f22021-10-25 15:12:56 +02001410 *size += grow;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001411
Pali Roháraed39f22021-10-25 15:12:56 +02001412 return result;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001413}
1414
Pali Rohárd9355bf2021-09-24 23:07:03 +02001415static void
1416kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1417{
1418 uint32_t hdrsz, datasz, srcaddr;
1419 struct main_hdr_v1 *hdr = img;
Pali Rohár6fa97092021-10-25 15:13:02 +02001420 struct opt_hdr_v1 *ohdr;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001421 uint8_t *data;
1422
1423 srcaddr = le32_to_cpu(hdr->srcaddr);
1424
Pali Rohár6fa97092021-10-25 15:13:02 +02001425 /* calculate real used space in kwbimage header */
1426 if (kwbimage_version(img) == 0) {
1427 hdrsz = kwbheader_size(img);
1428 } else {
1429 hdrsz = sizeof(*hdr);
1430 for_each_opt_hdr_v1 (ohdr, hdr)
1431 hdrsz += opt_hdr_v1_size(ohdr);
1432 }
1433
Pali Rohárd9355bf2021-09-24 23:07:03 +02001434 data = (uint8_t *)img + srcaddr;
1435 datasz = *size - srcaddr;
1436
1437 /* only move data if there is not enough space */
1438 if (hdrsz + grow > srcaddr) {
1439 size_t need = hdrsz + grow - srcaddr;
1440
1441 /* move data by enough bytes */
1442 memmove(data + need, data, datasz);
1443
1444 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1445 *size += need;
1446 }
1447
1448 if (kwbimage_version(img) == 1) {
1449 hdrsz += grow;
Pali Rohár6fa97092021-10-25 15:13:02 +02001450 if (hdrsz > kwbheader_size(img)) {
1451 hdr->headersz_msb = hdrsz >> 16;
1452 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1453 }
Pali Rohárd9355bf2021-09-24 23:07:03 +02001454 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001455}
1456
1457static void *
1458kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1459{
1460 struct main_hdr_v1 *hdr = img;
1461 struct opt_hdr_v1 *ohdr;
Pali Rohár87cc3c92021-10-21 16:46:06 +02001462 uint32_t num_args;
1463 uint32_t offset;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001464 uint32_t ohdrsz;
Pali Rohár90eb9002021-10-25 15:13:01 +02001465 uint8_t *prev_ext;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001466
Pali Rohár32eec192022-01-12 18:20:52 +01001467 if (hdr->ext) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001468 for_each_opt_hdr_v1 (ohdr, img)
1469 if (opt_hdr_v1_next(ohdr) == NULL)
1470 break;
1471
Pali Rohár90eb9002021-10-25 15:13:01 +02001472 prev_ext = opt_hdr_v1_ext(ohdr);
1473 ohdr = _opt_hdr_v1_next(ohdr);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001474 } else {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001475 ohdr = (void *)(hdr + 1);
Pali Rohár90eb9002021-10-25 15:13:01 +02001476 prev_ext = &hdr->ext;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001477 }
1478
Pali Rohár87cc3c92021-10-21 16:46:06 +02001479 /*
1480 * ARM executable code inside the BIN header on some mvebu platforms
1481 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1482 * This requirement can be met by inserting dummy arguments into
1483 * BIN header, if needed.
1484 */
1485 offset = &ohdr->data[4] - (char *)img;
1486 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1487
1488 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1489 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1490
Pali Rohár32eec192022-01-12 18:20:52 +01001491 *prev_ext = 1;
Pali Rohár90eb9002021-10-25 15:13:01 +02001492
Pali Rohár2a8b7692021-09-24 23:07:05 +02001493 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1494 ohdr->headersz_msb = ohdrsz >> 16;
1495 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1496
1497 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
Pali Rohár87cc3c92021-10-21 16:46:06 +02001498 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001499
Pali Rohár87cc3c92021-10-21 16:46:06 +02001500 return &ohdr->data[4 + 4 * num_args];
Pali Rohárd9355bf2021-09-24 23:07:03 +02001501}
1502
Pali Rohár2a8b7692021-09-24 23:07:05 +02001503static void
Pali Rohár6303a232021-10-27 20:57:02 +02001504_inject_baudrate_change_code(void *img, size_t *size, int for_data,
Pali Roháraed39f22021-10-25 15:12:56 +02001505 int old_baud, int new_baud)
Pali Rohár2a8b7692021-09-24 23:07:05 +02001506{
Pali Roháraed39f22021-10-25 15:12:56 +02001507 struct main_hdr_v1 *hdr = img;
Pali Rohár6303a232021-10-27 20:57:02 +02001508 uint32_t orig_datasz;
1509 uint32_t codesz;
Pali Roháraed39f22021-10-25 15:12:56 +02001510 uint8_t *code;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001511
Pali Rohár6303a232021-10-27 20:57:02 +02001512 if (for_data) {
Pali Roháraed39f22021-10-25 15:12:56 +02001513 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1514
Pali Rohár6303a232021-10-27 20:57:02 +02001515 codesz = sizeof(kwboot_baud_code) +
1516 sizeof(kwboot_baud_code_data_jump);
1517 code = kwboot_img_grow_data_right(img, size, codesz);
1518 } else {
1519 codesz = sizeof(kwboot_baud_code_binhdr_pre) +
1520 sizeof(kwboot_baud_code) +
1521 sizeof(kwboot_baud_code_binhdr_post);
1522 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001523
Pali Rohár6303a232021-10-27 20:57:02 +02001524 codesz = sizeof(kwboot_baud_code_binhdr_pre);
1525 memcpy(code, kwboot_baud_code_binhdr_pre, codesz);
1526 code += codesz;
1527 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001528
Pali Rohár6303a232021-10-27 20:57:02 +02001529 codesz = sizeof(kwboot_baud_code) - 2 * sizeof(uint32_t);
1530 memcpy(code, kwboot_baud_code, codesz);
1531 code += codesz;
1532 *(uint32_t *)code = cpu_to_le32(old_baud);
1533 code += sizeof(uint32_t);
1534 *(uint32_t *)code = cpu_to_le32(new_baud);
1535 code += sizeof(uint32_t);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001536
Pali Rohár6303a232021-10-27 20:57:02 +02001537 if (for_data) {
1538 codesz = sizeof(kwboot_baud_code_data_jump) - sizeof(uint32_t);
1539 memcpy(code, kwboot_baud_code_data_jump, codesz);
1540 code += codesz;
1541 *(uint32_t *)code = hdr->execaddr;
1542 code += sizeof(uint32_t);
1543 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) + orig_datasz);
Pali Roháraed39f22021-10-25 15:12:56 +02001544 } else {
Pali Rohár6303a232021-10-27 20:57:02 +02001545 codesz = sizeof(kwboot_baud_code_binhdr_post);
1546 memcpy(code, kwboot_baud_code_binhdr_post, codesz);
1547 code += codesz;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001548 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001549}
1550
Pali Rohár5725e0c2021-09-24 23:06:57 +02001551static int
Pali Rohár2a8b7692021-09-24 23:07:05 +02001552kwboot_img_patch(void *img, size_t *size, int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +00001553{
Stefan Roesec74165d2015-09-29 09:19:59 +02001554 struct main_hdr_v1 *hdr;
Pali Rohár88255af2021-09-24 23:06:58 +02001555 uint32_t srcaddr;
Luka Perkovdff289642012-05-27 11:44:51 +00001556 uint8_t csum;
Marek Behún811821e2021-09-24 23:07:04 +02001557 size_t hdrsz;
Stefan Roesec74165d2015-09-29 09:19:59 +02001558 int image_ver;
Pali Rohár5725e0c2021-09-24 23:06:57 +02001559 int is_secure;
Luka Perkovdff289642012-05-27 11:44:51 +00001560
Luka Perkovdff289642012-05-27 11:44:51 +00001561 hdr = img;
1562
Marek Behún3e6117e2021-09-24 23:07:12 +02001563 if (*size < sizeof(struct main_hdr_v1))
1564 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001565
Marek Behúnfa9caec2021-09-24 23:07:00 +02001566 image_ver = kwbimage_version(img);
Pali Rohárb572ac42021-07-23 11:14:22 +02001567 if (image_ver != 0 && image_ver != 1) {
Stefan Roesec74165d2015-09-29 09:19:59 +02001568 fprintf(stderr, "Invalid image header version\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001569 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001570 }
1571
Marek Behúnd1b0b032021-09-24 23:07:01 +02001572 hdrsz = kwbheader_size(hdr);
Stefan Roesec74165d2015-09-29 09:19:59 +02001573
Marek Behún3e6117e2021-09-24 23:07:12 +02001574 if (*size < hdrsz)
1575 goto err;
Pali Rohár12281162021-07-23 11:14:21 +02001576
Marek Behúnd1b0b032021-09-24 23:07:01 +02001577 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
Marek Behún3e6117e2021-09-24 23:07:12 +02001578 if (csum != hdr->checksum)
1579 goto err;
Stefan Roesec74165d2015-09-29 09:19:59 +02001580
Pali Rohár88255af2021-09-24 23:06:58 +02001581 srcaddr = le32_to_cpu(hdr->srcaddr);
1582
1583 switch (hdr->blockid) {
1584 case IBR_HDR_SATA_ID:
Marek Behún3e6117e2021-09-24 23:07:12 +02001585 if (srcaddr < 1)
1586 goto err;
1587
Pali Rohár88255af2021-09-24 23:06:58 +02001588 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1589 break;
1590
1591 case IBR_HDR_SDIO_ID:
1592 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1593 break;
1594
1595 case IBR_HDR_PEX_ID:
1596 if (srcaddr == 0xFFFFFFFF)
1597 hdr->srcaddr = cpu_to_le32(hdrsz);
1598 break;
Pali Rohár398d4152021-09-24 23:06:59 +02001599
1600 case IBR_HDR_SPI_ID:
1601 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1602 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1603 hdr->destaddr = cpu_to_le32(0x00800000);
1604 hdr->execaddr = cpu_to_le32(0x00800000);
1605 }
1606 break;
Pali Rohár88255af2021-09-24 23:06:58 +02001607 }
1608
Pali Rohárd9355bf2021-09-24 23:07:03 +02001609 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
Marek Behún3e6117e2021-09-24 23:07:12 +02001610 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1611 goto err;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001612
Pali Rohár0b659e52021-10-25 15:12:55 +02001613 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1614 goto err;
1615
Pali Rohár5725e0c2021-09-24 23:06:57 +02001616 is_secure = kwboot_img_is_secure(img);
Luka Perkovdff289642012-05-27 11:44:51 +00001617
Pali Rohár5725e0c2021-09-24 23:06:57 +02001618 if (hdr->blockid != IBR_HDR_UART_ID) {
1619 if (is_secure) {
1620 fprintf(stderr,
1621 "Image has secure header with signature for non-UART booting\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001622 goto err;
Pali Rohár5725e0c2021-09-24 23:06:57 +02001623 }
1624
1625 kwboot_printv("Patching image boot signature to UART\n");
1626 hdr->blockid = IBR_HDR_UART_ID;
1627 }
Luka Perkovdff289642012-05-27 11:44:51 +00001628
Pali Rohár3024ebd2021-10-22 12:37:47 +02001629 if (!is_secure) {
Pali Rohár71db3622021-10-25 15:12:58 +02001630 if (image_ver == 1) {
1631 /*
1632 * Tell BootROM to send BootROM messages to UART port
1633 * number 0 (used also for UART booting) with default
1634 * baudrate (which should be 115200) and do not touch
1635 * UART MPP configuration.
1636 */
Pali Roháre4b8fca2022-01-25 18:13:13 +01001637 hdr->flags |= 0x1;
Pali Rohár71db3622021-10-25 15:12:58 +02001638 hdr->options &= ~0x1F;
1639 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1640 hdr->options |= 0 << 3;
1641 }
Pali Rohár3024ebd2021-10-22 12:37:47 +02001642 if (image_ver == 0)
1643 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1644 hdr->nandpagesize = 0;
1645 }
1646
Pali Rohár2a8b7692021-09-24 23:07:05 +02001647 if (baudrate) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001648 if (image_ver == 0) {
1649 fprintf(stderr,
1650 "Cannot inject code for changing baudrate into v0 image header\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001651 goto err;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001652 }
1653
1654 if (is_secure) {
1655 fprintf(stderr,
1656 "Cannot inject code for changing baudrate into image with secure header\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001657 goto err;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001658 }
1659
1660 /*
1661 * First inject code that changes the baudrate from the default
1662 * value of 115200 Bd to requested value. This code is inserted
1663 * as a new opt hdr, so it is executed by BootROM after the
1664 * header part is received.
1665 */
1666 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1667 baudrate);
Pali Roháraed39f22021-10-25 15:12:56 +02001668 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001669
1670 /*
1671 * Now inject code that changes the baudrate back to 115200 Bd.
Pali Roháraed39f22021-10-25 15:12:56 +02001672 * This code is appended after the data part of the image, and
1673 * execaddr is changed so that it is executed before U-Boot
1674 * proper.
Pali Rohár2a8b7692021-09-24 23:07:05 +02001675 */
1676 kwboot_printv("Injecting code for changing baudrate back\n");
Pali Roháraed39f22021-10-25 15:12:56 +02001677 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001678
Pali Rohárf625a222021-10-25 15:12:57 +02001679 /* Update the 32-bit data checksum */
1680 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1681
Pali Rohár2a8b7692021-09-24 23:07:05 +02001682 /* recompute header size */
1683 hdrsz = kwbheader_size(hdr);
1684 }
1685
Pali Rohárd9355bf2021-09-24 23:07:03 +02001686 if (hdrsz % KWBOOT_XM_BLKSZ) {
Pali Rohár085d9ce2021-10-25 15:13:00 +02001687 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001688
1689 if (is_secure) {
1690 fprintf(stderr, "Cannot align image with secure header\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001691 goto err;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001692 }
1693
1694 kwboot_printv("Aligning image header to Xmodem block size\n");
Pali Rohár085d9ce2021-10-25 15:13:00 +02001695 kwboot_img_grow_hdr(img, size, grow);
Pali Rohárd9355bf2021-09-24 23:07:03 +02001696 }
1697
Marek Behúnd1b0b032021-09-24 23:07:01 +02001698 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
Luka Perkovdff289642012-05-27 11:44:51 +00001699
Pali Rohárd9355bf2021-09-24 23:07:03 +02001700 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
Marek Behún3e6117e2021-09-24 23:07:12 +02001701 return 0;
1702err:
1703 errno = EINVAL;
1704 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +00001705}
1706
1707static void
1708kwboot_usage(FILE *stream, char *progname)
1709{
1710 fprintf(stream,
Kevin Smith6c7c1ba2016-02-16 21:28:17 +00001711 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
Stefan Roesebb5c4282014-10-22 12:13:21 +02001712 progname);
Luka Perkovdff289642012-05-27 11:44:51 +00001713 fprintf(stream, "\n");
Stefan Roesebb5c4282014-10-22 12:13:21 +02001714 fprintf(stream,
1715 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
Stefan Roesebb5c4282014-10-22 12:13:21 +02001716 fprintf(stream,
1717 " -D <image>: boot <image> without preamble (Dove)\n");
1718 fprintf(stream, " -d: enter debug mode\n");
1719 fprintf(stream, " -a: use timings for Armada XP\n");
Stefan Roesef7f509d2015-05-29 13:25:04 +02001720 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
1721 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
Kevin Smith4d31a842016-02-16 21:28:19 +00001722 fprintf(stream,
1723 " -o <block-timeo>: use specific xmodem block timeout\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001724 fprintf(stream, "\n");
1725 fprintf(stream, " -t: mini terminal\n");
1726 fprintf(stream, "\n");
1727 fprintf(stream, " -B <baud>: set baud rate\n");
1728 fprintf(stream, "\n");
1729}
1730
1731int
1732main(int argc, char **argv)
1733{
1734 const char *ttypath, *imgpath;
Pali Rohár4d276012021-09-24 23:06:55 +02001735 int rv, rc, tty, term;
Luka Perkovdff289642012-05-27 11:44:51 +00001736 void *bootmsg;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001737 void *debugmsg;
Luka Perkovdff289642012-05-27 11:44:51 +00001738 void *img;
1739 size_t size;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001740 size_t after_img_rsv;
1741 int baudrate;
Pali Rohár48953362022-01-25 18:13:07 +01001742 int prev_optind;
1743 int c;
Luka Perkovdff289642012-05-27 11:44:51 +00001744
1745 rv = 1;
1746 tty = -1;
1747 bootmsg = NULL;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001748 debugmsg = NULL;
Luka Perkovdff289642012-05-27 11:44:51 +00001749 imgpath = NULL;
1750 img = NULL;
1751 term = 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001752 size = 0;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001753 after_img_rsv = KWBOOT_XM_BLKSZ;
1754 baudrate = 115200;
Luka Perkovdff289642012-05-27 11:44:51 +00001755
Pali Rohár73ae7aa2021-11-05 23:30:42 +01001756 printf("kwboot version %s\n", PLAIN_VERSION);
1757
Luka Perkovdff289642012-05-27 11:44:51 +00001758 kwboot_verbose = isatty(STDOUT_FILENO);
1759
1760 do {
Pali Rohár48953362022-01-25 18:13:07 +01001761 prev_optind = optind;
1762 c = getopt(argc, argv, "hbptaB:dD:q:s:o:");
Luka Perkovdff289642012-05-27 11:44:51 +00001763 if (c < 0)
1764 break;
1765
1766 switch (c) {
1767 case 'b':
Pali Rohár48953362022-01-25 18:13:07 +01001768 if (imgpath || bootmsg || debugmsg)
1769 goto usage;
Luka Perkovdff289642012-05-27 11:44:51 +00001770 bootmsg = kwboot_msg_boot;
Pali Rohár48953362022-01-25 18:13:07 +01001771 if (prev_optind == optind)
1772 goto usage;
Pali Rohárcf91fa82022-02-07 10:12:24 +01001773 if (optind < argc - 1 && argv[optind] && argv[optind][0] != '-')
Pali Rohár48953362022-01-25 18:13:07 +01001774 imgpath = argv[optind++];
Luka Perkovdff289642012-05-27 11:44:51 +00001775 break;
1776
Stefan Roesebb5c4282014-10-22 12:13:21 +02001777 case 'D':
Pali Rohár48953362022-01-25 18:13:07 +01001778 if (imgpath || bootmsg || debugmsg)
1779 goto usage;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001780 bootmsg = NULL;
1781 imgpath = optarg;
1782 break;
1783
1784 case 'd':
Pali Rohár48953362022-01-25 18:13:07 +01001785 if (imgpath || bootmsg || debugmsg)
1786 goto usage;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001787 debugmsg = kwboot_msg_debug;
1788 break;
1789
Luka Perkovdff289642012-05-27 11:44:51 +00001790 case 'p':
Pali Rohár4d276012021-09-24 23:06:55 +02001791 /* nop, for backward compatibility */
Luka Perkovdff289642012-05-27 11:44:51 +00001792 break;
1793
1794 case 't':
1795 term = 1;
1796 break;
1797
Stefan Roesebb5c4282014-10-22 12:13:21 +02001798 case 'a':
1799 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
1800 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1801 break;
1802
Stefan Roesef7f509d2015-05-29 13:25:04 +02001803 case 'q':
1804 msg_req_delay = atoi(optarg);
1805 break;
1806
1807 case 's':
1808 msg_rsp_timeo = atoi(optarg);
1809 break;
1810
Kevin Smith4d31a842016-02-16 21:28:19 +00001811 case 'o':
1812 blk_rsp_timeo = atoi(optarg);
1813 break;
1814
Luka Perkovdff289642012-05-27 11:44:51 +00001815 case 'B':
Pali Rohár2a8b7692021-09-24 23:07:05 +02001816 baudrate = atoi(optarg);
Luka Perkovdff289642012-05-27 11:44:51 +00001817 break;
1818
1819 case 'h':
1820 rv = 0;
1821 default:
1822 goto usage;
1823 }
1824 } while (1);
1825
Pali Rohár577506c2022-01-25 18:13:12 +01001826 if (!bootmsg && !term && !debugmsg && !imgpath)
Luka Perkovdff289642012-05-27 11:44:51 +00001827 goto usage;
1828
Luka Perkovdff289642012-05-27 11:44:51 +00001829 ttypath = argv[optind++];
1830
Pali Rohár48953362022-01-25 18:13:07 +01001831 if (optind != argc)
1832 goto usage;
1833
Pali Rohár2a8b7692021-09-24 23:07:05 +02001834 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
Luka Perkovdff289642012-05-27 11:44:51 +00001835 if (tty < 0) {
1836 perror(ttypath);
1837 goto out;
1838 }
1839
Pali Rohár2a8b7692021-09-24 23:07:05 +02001840 if (baudrate == 115200)
1841 /* do not change baudrate during Xmodem to the same value */
1842 baudrate = 0;
1843 else
1844 /* ensure we have enough space for baudrate change code */
Pali Rohár6303a232021-10-27 20:57:02 +02001845 after_img_rsv += sizeof(struct opt_hdr_v1) + 8 + 16 +
1846 sizeof(kwboot_baud_code_binhdr_pre) +
1847 sizeof(kwboot_baud_code) +
1848 sizeof(kwboot_baud_code_binhdr_post) +
Pali Rohárd8774392021-10-25 15:12:54 +02001849 KWBOOT_XM_BLKSZ +
Pali Rohárd8774392021-10-25 15:12:54 +02001850 sizeof(kwboot_baud_code) +
Pali Rohár6303a232021-10-27 20:57:02 +02001851 sizeof(kwboot_baud_code_data_jump) +
Pali Rohárd8774392021-10-25 15:12:54 +02001852 KWBOOT_XM_BLKSZ;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001853
Luka Perkovdff289642012-05-27 11:44:51 +00001854 if (imgpath) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001855 img = kwboot_read_image(imgpath, &size, after_img_rsv);
Luka Perkovdff289642012-05-27 11:44:51 +00001856 if (!img) {
1857 perror(imgpath);
1858 goto out;
1859 }
Luka Perkovdff289642012-05-27 11:44:51 +00001860
Pali Rohár2a8b7692021-09-24 23:07:05 +02001861 rc = kwboot_img_patch(img, &size, baudrate);
Luka Perkovdff289642012-05-27 11:44:51 +00001862 if (rc) {
1863 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1864 goto out;
1865 }
1866 }
1867
Stefan Roesebb5c4282014-10-22 12:13:21 +02001868 if (debugmsg) {
1869 rc = kwboot_debugmsg(tty, debugmsg);
1870 if (rc) {
1871 perror("debugmsg");
1872 goto out;
1873 }
Willy Tarreaue8f8a7c2018-07-03 12:10:30 -04001874 } else if (bootmsg) {
Luka Perkovdff289642012-05-27 11:44:51 +00001875 rc = kwboot_bootmsg(tty, bootmsg);
1876 if (rc) {
1877 perror("bootmsg");
1878 goto out;
1879 }
1880 }
1881
1882 if (img) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001883 rc = kwboot_xmodem(tty, img, size, baudrate);
Luka Perkovdff289642012-05-27 11:44:51 +00001884 if (rc) {
1885 perror("xmodem");
1886 goto out;
1887 }
1888 }
1889
1890 if (term) {
1891 rc = kwboot_terminal(tty);
1892 if (rc && !(errno == EINTR)) {
1893 perror("terminal");
1894 goto out;
1895 }
1896 }
1897
1898 rv = 0;
1899out:
1900 if (tty >= 0)
1901 close(tty);
1902
1903 if (img)
Pali Rohárd9355bf2021-09-24 23:07:03 +02001904 free(img);
Luka Perkovdff289642012-05-27 11:44:51 +00001905
1906 return rv;
1907
1908usage:
1909 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));
1910 goto out;
1911}