blob: 824ae005b269f89baaf48f7b037ea5931e9f04f0 [file] [log] [blame]
Luka Perkovd131ad62012-05-27 11:44:51 +00001/*
Stefan Roese84899e22014-10-22 12:13:21 +02002 * Boot a Marvell SoC, with Xmodem over UART0.
Marek Behúnb843aed2021-09-24 23:07:13 +02003 * supports Kirkwood, Dove, Armada 370, Armada XP, Armada 375, Armada 38x and
4 * Armada 39x
Luka Perkovd131ad62012-05-27 11:44:51 +00005 *
6 * (c) 2012 Daniel Stodden <daniel.stodden@gmail.com>
Pali Rohárcf8c9322021-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 Perkovd131ad62012-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 Roesef4db6c92016-01-07 14:12:04 +010015#include "kwbimage.h"
16#include "mkimage.h"
Pali Rohára050a862021-09-24 23:06:42 +020017#include "version.h"
Stefan Roesef4db6c92016-01-07 14:12:04 +010018
Luka Perkovd131ad62012-05-27 11:44:51 +000019#include <stdlib.h>
20#include <stdio.h>
21#include <string.h>
22#include <stdarg.h>
Stefan Roesef4db6c92016-01-07 14:12:04 +010023#include <image.h>
Luka Perkovd131ad62012-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ún12df7b72021-09-24 23:06:52 +020029#include <time.h>
Luka Perkovd131ad62012-05-27 11:44:51 +000030#include <sys/stat.h>
31
Pali Rohár93b55632021-09-24 23:07:06 +020032#ifdef __linux__
33#include "termios_linux.h"
34#else
35#include <termios.h>
36#endif
37
Luka Perkovd131ad62012-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 Roese84899e22014-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 Perkovd131ad62012-05-27 11:44:51 +000051#define KWBOOT_MSG_REQ_DELAY 10 /* ms */
52#define KWBOOT_MSG_RSP_TIMEO 50 /* ms */
53
Stefan Roese84899e22014-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 Perkovd131ad62012-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 Perkovd131ad62012-05-27 11:44:51 +000066
Pali Rohár2ef87f72021-09-24 23:06:48 +020067#define KWBOOT_XM_BLKSZ 128 /* xmodem block size */
68
Luka Perkovd131ad62012-05-27 11:44:51 +000069struct kwboot_block {
70 uint8_t soh;
71 uint8_t pnum;
72 uint8_t _pnum;
Pali Rohár2ef87f72021-09-24 23:06:48 +020073 uint8_t data[KWBOOT_XM_BLKSZ];
Luka Perkovd131ad62012-05-27 11:44:51 +000074 uint8_t csum;
Pali Rohára107c612021-07-23 11:14:14 +020075} __packed;
Luka Perkovd131ad62012-05-27 11:44:51 +000076
Pali Roháref951432022-01-25 18:13:00 +010077#define KWBOOT_BLK_RSP_TIMEO 2000 /* ms */
Marek Behún12df7b72021-09-24 23:06:52 +020078#define KWBOOT_HDR_RSP_TIMEO 10000 /* ms */
Luka Perkovd131ad62012-05-27 11:44:51 +000079
Pali Rohár8dbe0272021-10-27 20:57:02 +020080/* ARM code to change baudrate */
Pali Rohárca272042021-09-24 23:07:05 +020081static unsigned char kwboot_baud_code[] = {
82 /* ; #define UART_BASE 0xd0012000 */
Pali Rohárca272042021-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árca272042021-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árca272042021-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ár56452292021-10-27 20:57:00 +0200106 /* ; msleep(5); */
Pali Rohárca272042021-09-24 23:07:05 +0200107 /* ; return 0; */
108 /* ; } */
109
Pali Rohárca272042021-09-24 23:07:05 +0200110 /* ; r0 = UART_BASE */
Pali Rohár558176d2021-10-27 20:57:01 +0200111 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
112 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
Pali Rohárca272042021-09-24 23:07:05 +0200113
Pali Rohárca272042021-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ár62a98f42021-11-01 14:00:02 +0100139 0x74, 0x20, 0x9f, 0xe5, /* ldr r2, old_baudrate */
Pali Rohárca272042021-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ár56452292021-10-27 20:57:00 +0200146 /* ; r2 = new_baudrate */
Pali Rohár62a98f42021-11-01 14:00:02 +0100147 0x70, 0x20, 0x9f, 0xe5, /* ldr r2, new_baudrate */
Pali Rohárca272042021-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ár56452292021-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árca272042021-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ár62a98f42021-11-01 14:00:02 +0100196 /* ; Jump to the end of execution */
197 0x01, 0x00, 0x00, 0xea, /* b end */
Pali Rohárca272042021-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ár8dbe0272021-10-27 20:57:02 +0200206
207 /* end: */
Pali Rohárca272042021-09-24 23:07:05 +0200208};
209
Pali Rohár62a98f42021-11-01 14:00:02 +0100210/* ARM code from binary header executed by BootROM before changing baudrate */
Pali Rohár8dbe0272021-10-27 20:57:02 +0200211static unsigned char kwboot_baud_code_binhdr_pre[] = {
Pali Rohár62a98f42021-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ár8dbe0272021-10-27 20:57:02 +0200229 0xfe, 0x5f, 0x2d, 0xe9, /* push { r1 - r12, lr } */
Pali Rohár62a98f42021-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ár8dbe0272021-10-27 20:57:02 +0200267};
268
Pali Rohár62a98f42021-11-01 14:00:02 +0100269/* ARM code for returning from binary header back to BootROM */
Pali Rohár8dbe0272021-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 } */
274};
275
276/* 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árca272042021-09-24 23:07:05 +0200283
284static const char kwb_baud_magic[16] = "$baudratechange";
285
Luka Perkovd131ad62012-05-27 11:44:51 +0000286static int kwboot_verbose;
287
Stefan Roese84899e22014-10-22 12:13:21 +0200288static int msg_req_delay = KWBOOT_MSG_REQ_DELAY;
289static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
Kevin Smith7497a6a2016-02-16 21:28:19 +0000290static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
Stefan Roese84899e22014-10-22 12:13:21 +0200291
Marek Behúne453bb42021-09-24 23:06:41 +0200292static ssize_t
293kwboot_write(int fd, const char *buf, size_t len)
294{
295 size_t tot = 0;
296
297 while (tot < len) {
298 ssize_t wr = write(fd, buf + tot, len - tot);
299
300 if (wr < 0)
301 return -1;
302
303 tot += wr;
304 }
305
306 return tot;
307}
308
Luka Perkovd131ad62012-05-27 11:44:51 +0000309static void
310kwboot_printv(const char *fmt, ...)
311{
312 va_list ap;
313
314 if (kwboot_verbose) {
315 va_start(ap, fmt);
316 vprintf(fmt, ap);
317 va_end(ap);
318 fflush(stdout);
319 }
320}
321
322static void
323__spinner(void)
324{
325 const char seq[] = { '-', '\\', '|', '/' };
326 const int div = 8;
327 static int state, bs;
328
329 if (state % div == 0) {
330 fputc(bs, stdout);
331 fputc(seq[state / div % sizeof(seq)], stdout);
332 fflush(stdout);
333 }
334
335 bs = '\b';
336 state++;
337}
338
339static void
340kwboot_spinner(void)
341{
342 if (kwboot_verbose)
343 __spinner();
344}
345
346static void
347__progress(int pct, char c)
348{
349 const int width = 70;
350 static const char *nl = "";
351 static int pos;
352
353 if (pos % width == 0)
354 printf("%s%3d %% [", nl, pct);
355
356 fputc(c, stdout);
357
358 nl = "]\n";
Pali Rohár5a1f8cb2021-09-24 23:06:46 +0200359 pos = (pos + 1) % width;
Luka Perkovd131ad62012-05-27 11:44:51 +0000360
361 if (pct == 100) {
Pali Rohár5a1f8cb2021-09-24 23:06:46 +0200362 while (pos && pos++ < width)
Luka Perkovd131ad62012-05-27 11:44:51 +0000363 fputc(' ', stdout);
364 fputs(nl, stdout);
Pali Rohár5a1f8cb2021-09-24 23:06:46 +0200365 nl = "";
366 pos = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +0000367 }
368
369 fflush(stdout);
370
371}
372
373static void
374kwboot_progress(int _pct, char c)
375{
376 static int pct;
377
378 if (_pct != -1)
379 pct = _pct;
380
381 if (kwboot_verbose)
382 __progress(pct, c);
Pali Rohár5a1f8cb2021-09-24 23:06:46 +0200383
384 if (pct == 100)
385 pct = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +0000386}
387
388static int
389kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
390{
391 int rc, nfds;
392 fd_set rfds;
393 struct timeval tv;
394 ssize_t n;
395
396 rc = -1;
397
398 FD_ZERO(&rfds);
399 FD_SET(fd, &rfds);
400
401 tv.tv_sec = 0;
402 tv.tv_usec = timeo * 1000;
403 if (tv.tv_usec > 1000000) {
404 tv.tv_sec += tv.tv_usec / 1000000;
405 tv.tv_usec %= 1000000;
406 }
407
408 do {
409 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
410 if (nfds < 0)
411 goto out;
412 if (!nfds) {
413 errno = ETIMEDOUT;
414 goto out;
415 }
416
417 n = read(fd, buf, len);
Willy Tarreau4469bd72018-07-03 12:10:31 -0400418 if (n <= 0)
Luka Perkovd131ad62012-05-27 11:44:51 +0000419 goto out;
420
421 buf = (char *)buf + n;
422 len -= n;
423 } while (len > 0);
424
425 rc = 0;
426out:
427 return rc;
428}
429
430static int
Pali Rohárcab817d2021-10-27 20:56:59 +0200431kwboot_tty_send(int fd, const void *buf, size_t len, int nodrain)
Luka Perkovd131ad62012-05-27 11:44:51 +0000432{
Stefan Roese84899e22014-10-22 12:13:21 +0200433 if (!buf)
434 return 0;
435
Marek Behúne453bb42021-09-24 23:06:41 +0200436 if (kwboot_write(fd, buf, len) < 0)
437 return -1;
Luka Perkovd131ad62012-05-27 11:44:51 +0000438
Pali Rohárcab817d2021-10-27 20:56:59 +0200439 if (nodrain)
440 return 0;
441
Marek Behúne453bb42021-09-24 23:06:41 +0200442 return tcdrain(fd);
Luka Perkovd131ad62012-05-27 11:44:51 +0000443}
444
445static int
446kwboot_tty_send_char(int fd, unsigned char c)
447{
Pali Rohárcab817d2021-10-27 20:56:59 +0200448 return kwboot_tty_send(fd, &c, 1, 0);
Luka Perkovd131ad62012-05-27 11:44:51 +0000449}
450
451static speed_t
Pali Rohárca272042021-09-24 23:07:05 +0200452kwboot_tty_baudrate_to_speed(int baudrate)
Luka Perkovd131ad62012-05-27 11:44:51 +0000453{
454 switch (baudrate) {
Pali Rohárca272042021-09-24 23:07:05 +0200455#ifdef B4000000
456 case 4000000:
457 return B4000000;
458#endif
459#ifdef B3500000
460 case 3500000:
461 return B3500000;
462#endif
463#ifdef B3000000
464 case 3000000:
465 return B3000000;
466#endif
467#ifdef B2500000
468 case 2500000:
469 return B2500000;
470#endif
471#ifdef B2000000
472 case 2000000:
473 return B2000000;
474#endif
475#ifdef B1500000
476 case 1500000:
477 return B1500000;
478#endif
479#ifdef B1152000
480 case 1152000:
481 return B1152000;
482#endif
483#ifdef B1000000
484 case 1000000:
485 return B1000000;
486#endif
487#ifdef B921600
488 case 921600:
489 return B921600;
490#endif
491#ifdef B614400
492 case 614400:
493 return B614400;
494#endif
495#ifdef B576000
496 case 576000:
497 return B576000;
498#endif
499#ifdef B500000
500 case 500000:
501 return B500000;
502#endif
503#ifdef B460800
504 case 460800:
505 return B460800;
506#endif
507#ifdef B307200
508 case 307200:
509 return B307200;
510#endif
511#ifdef B230400
512 case 230400:
513 return B230400;
514#endif
515#ifdef B153600
516 case 153600:
517 return B153600;
518#endif
519#ifdef B115200
Luka Perkovd131ad62012-05-27 11:44:51 +0000520 case 115200:
521 return B115200;
Pali Rohárca272042021-09-24 23:07:05 +0200522#endif
523#ifdef B76800
524 case 76800:
525 return B76800;
526#endif
527#ifdef B57600
Luka Perkovd131ad62012-05-27 11:44:51 +0000528 case 57600:
529 return B57600;
Pali Rohárca272042021-09-24 23:07:05 +0200530#endif
531#ifdef B38400
Luka Perkovd131ad62012-05-27 11:44:51 +0000532 case 38400:
533 return B38400;
Pali Rohárca272042021-09-24 23:07:05 +0200534#endif
535#ifdef B19200
Luka Perkovd131ad62012-05-27 11:44:51 +0000536 case 19200:
537 return B19200;
Pali Rohárca272042021-09-24 23:07:05 +0200538#endif
539#ifdef B9600
Luka Perkovd131ad62012-05-27 11:44:51 +0000540 case 9600:
541 return B9600;
Pali Rohárca272042021-09-24 23:07:05 +0200542#endif
543#ifdef B4800
544 case 4800:
545 return B4800;
546#endif
547#ifdef B2400
548 case 2400:
549 return B2400;
550#endif
551#ifdef B1800
552 case 1800:
553 return B1800;
554#endif
555#ifdef B1200
556 case 1200:
557 return B1200;
558#endif
559#ifdef B600
560 case 600:
561 return B600;
562#endif
563#ifdef B300
564 case 300:
565 return B300;
566#endif
567#ifdef B200
568 case 200:
569 return B200;
570#endif
571#ifdef B150
572 case 150:
573 return B150;
574#endif
575#ifdef B134
576 case 134:
577 return B134;
578#endif
579#ifdef B110
580 case 110:
581 return B110;
582#endif
583#ifdef B75
584 case 75:
585 return B75;
586#endif
587#ifdef B50
588 case 50:
589 return B50;
590#endif
591 default:
Pali Rohár93b55632021-09-24 23:07:06 +0200592#ifdef BOTHER
593 return BOTHER;
594#else
Pali Rohárca272042021-09-24 23:07:05 +0200595 return B0;
Pali Rohár93b55632021-09-24 23:07:06 +0200596#endif
Luka Perkovd131ad62012-05-27 11:44:51 +0000597 }
Luka Perkovd131ad62012-05-27 11:44:51 +0000598}
599
600static int
Marek Behún99a3d0232021-09-24 23:07:07 +0200601_is_within_tolerance(int value, int reference, int tolerance)
602{
603 return 100 * value >= reference * (100 - tolerance) &&
604 100 * value <= reference * (100 + tolerance);
605}
606
607static int
Pali Rohárca272042021-09-24 23:07:05 +0200608kwboot_tty_change_baudrate(int fd, int baudrate)
609{
610 struct termios tio;
611 speed_t speed;
612 int rc;
613
614 rc = tcgetattr(fd, &tio);
615 if (rc)
616 return rc;
617
618 speed = kwboot_tty_baudrate_to_speed(baudrate);
619 if (speed == B0) {
620 errno = EINVAL;
621 return -1;
622 }
623
Pali Rohár93b55632021-09-24 23:07:06 +0200624#ifdef BOTHER
625 if (speed == BOTHER)
626 tio.c_ospeed = tio.c_ispeed = baudrate;
627#endif
628
Pali Rohárca272042021-09-24 23:07:05 +0200629 rc = cfsetospeed(&tio, speed);
630 if (rc)
631 return rc;
632
633 rc = cfsetispeed(&tio, speed);
634 if (rc)
635 return rc;
636
637 rc = tcsetattr(fd, TCSANOW, &tio);
638 if (rc)
639 return rc;
640
Marek Behún99a3d0232021-09-24 23:07:07 +0200641 rc = tcgetattr(fd, &tio);
642 if (rc)
643 return rc;
644
645 if (cfgetospeed(&tio) != speed || cfgetispeed(&tio) != speed)
646 goto baud_fail;
647
648#ifdef BOTHER
649 /*
650 * Check whether set baudrate is within 3% tolerance.
651 * If BOTHER is defined, Linux always fills out c_ospeed / c_ispeed
652 * with real values.
653 */
654 if (!_is_within_tolerance(tio.c_ospeed, baudrate, 3))
655 goto baud_fail;
656
657 if (!_is_within_tolerance(tio.c_ispeed, baudrate, 3))
658 goto baud_fail;
659#endif
660
Pali Rohárca272042021-09-24 23:07:05 +0200661 return 0;
Marek Behún99a3d0232021-09-24 23:07:07 +0200662
663baud_fail:
664 fprintf(stderr, "Could not set baudrate to requested value\n");
665 errno = EINVAL;
666 return -1;
Pali Rohárca272042021-09-24 23:07:05 +0200667}
668
669static int
670kwboot_open_tty(const char *path, int baudrate)
Luka Perkovd131ad62012-05-27 11:44:51 +0000671{
Pali Rohár911515b2021-09-24 23:07:10 +0200672 int rc, fd, flags;
Luka Perkovd131ad62012-05-27 11:44:51 +0000673 struct termios tio;
674
675 rc = -1;
676
Marek Behún5fa04f42021-09-24 23:07:11 +0200677 fd = open(path, O_RDWR | O_NOCTTY | O_NDELAY);
Luka Perkovd131ad62012-05-27 11:44:51 +0000678 if (fd < 0)
679 goto out;
680
Pali Rohárc704e0e2021-09-24 23:07:08 +0200681 rc = tcgetattr(fd, &tio);
682 if (rc)
683 goto out;
Luka Perkovd131ad62012-05-27 11:44:51 +0000684
Pali Rohárc704e0e2021-09-24 23:07:08 +0200685 cfmakeraw(&tio);
Marek Behún5fa04f42021-09-24 23:07:11 +0200686 tio.c_cflag |= CREAD | CLOCAL;
Pali Rohár2ecca3d2021-10-25 15:12:53 +0200687 tio.c_cflag &= ~(CSTOPB | HUPCL | CRTSCTS);
Luka Perkovd131ad62012-05-27 11:44:51 +0000688 tio.c_cc[VMIN] = 1;
Pali Rohár24a471b2021-09-24 23:07:09 +0200689 tio.c_cc[VTIME] = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +0000690
Luka Perkovd131ad62012-05-27 11:44:51 +0000691 rc = tcsetattr(fd, TCSANOW, &tio);
692 if (rc)
693 goto out;
694
Pali Rohár911515b2021-09-24 23:07:10 +0200695 flags = fcntl(fd, F_GETFL);
696 if (flags < 0)
697 goto out;
698
699 rc = fcntl(fd, F_SETFL, flags & ~O_NDELAY);
700 if (rc)
701 goto out;
702
Pali Rohárca272042021-09-24 23:07:05 +0200703 rc = kwboot_tty_change_baudrate(fd, baudrate);
704 if (rc)
705 goto out;
706
Luka Perkovd131ad62012-05-27 11:44:51 +0000707 rc = fd;
708out:
709 if (rc < 0) {
710 if (fd >= 0)
711 close(fd);
712 }
713
714 return rc;
715}
716
717static int
718kwboot_bootmsg(int tty, void *msg)
719{
Pali Rohár2bcd5b12022-01-25 18:13:08 +0100720 struct kwboot_block block;
Luka Perkovd131ad62012-05-27 11:44:51 +0000721 int rc;
722 char c;
Jon Nettleton9ca6fae2018-08-13 18:24:38 +0300723 int count;
Luka Perkovd131ad62012-05-27 11:44:51 +0000724
Stefan Roese84899e22014-10-22 12:13:21 +0200725 if (msg == NULL)
726 kwboot_printv("Please reboot the target into UART boot mode...");
727 else
728 kwboot_printv("Sending boot message. Please reboot the target...");
Luka Perkovd131ad62012-05-27 11:44:51 +0000729
730 do {
731 rc = tcflush(tty, TCIOFLUSH);
732 if (rc)
733 break;
734
Jon Nettleton9ca6fae2018-08-13 18:24:38 +0300735 for (count = 0; count < 128; count++) {
Pali Rohárcab817d2021-10-27 20:56:59 +0200736 rc = kwboot_tty_send(tty, msg, 8, 0);
Jon Nettleton9ca6fae2018-08-13 18:24:38 +0300737 if (rc) {
738 usleep(msg_req_delay * 1000);
739 continue;
740 }
Luka Perkovd131ad62012-05-27 11:44:51 +0000741 }
742
Stefan Roese84899e22014-10-22 12:13:21 +0200743 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
Luka Perkovd131ad62012-05-27 11:44:51 +0000744
745 kwboot_spinner();
746
747 } while (rc || c != NAK);
748
749 kwboot_printv("\n");
750
Pali Rohár2bcd5b12022-01-25 18:13:08 +0100751 if (rc)
752 return rc;
753
754 /*
755 * At this stage we have sent more boot message patterns and BootROM
756 * (at least on Armada XP and 385) started interpreting sent bytes as
757 * part of xmodem packets. If BootROM is expecting SOH byte as start of
758 * a xmodem packet and it receives byte 0xff, then it throws it away and
759 * sends a NAK reply to host. If BootROM does not receive any byte for
760 * 2s when expecting some continuation of the xmodem packet, it throws
761 * away the partially received xmodem data and sends NAK reply to host.
762 *
763 * Therefore for starting xmodem transfer we have two options: Either
764 * wait 2s or send 132 0xff bytes (which is the size of xmodem packet)
765 * to ensure that BootROM throws away any partially received data.
766 */
767
768 /* flush output queue with remaining boot message patterns */
769 tcflush(tty, TCOFLUSH);
770
771 /* send one xmodem packet with 0xff bytes to force BootROM to re-sync */
772 memset(&block, 0xff, sizeof(block));
773 kwboot_tty_send(tty, &block, sizeof(block), 0);
774
775 /*
776 * Sending 132 bytes via 115200B/8-N-1 takes 11.45 ms, reading 132 bytes
777 * takes 11.45 ms, so waiting for 30 ms should be enough.
778 */
779 usleep(30 * 1000);
780
781 /* flush remaining NAK replies from input queue */
782 tcflush(tty, TCIFLUSH);
783
784 return 0;
Luka Perkovd131ad62012-05-27 11:44:51 +0000785}
786
787static int
Stefan Roese84899e22014-10-22 12:13:21 +0200788kwboot_debugmsg(int tty, void *msg)
789{
790 int rc;
791
792 kwboot_printv("Sending debug message. Please reboot the target...");
793
794 do {
795 char buf[16];
796
797 rc = tcflush(tty, TCIOFLUSH);
798 if (rc)
799 break;
800
Pali Rohárcab817d2021-10-27 20:56:59 +0200801 rc = kwboot_tty_send(tty, msg, 8, 0);
Stefan Roese84899e22014-10-22 12:13:21 +0200802 if (rc) {
803 usleep(msg_req_delay * 1000);
804 continue;
805 }
806
807 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
808
809 kwboot_spinner();
810
811 } while (rc);
812
813 kwboot_printv("\n");
814
815 return rc;
816}
817
Pali Rohárc5d666a2021-09-24 23:06:44 +0200818static size_t
Luka Perkovd131ad62012-05-27 11:44:51 +0000819kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
820 size_t size, int pnum)
821{
Marek Behúnd8cc8512021-09-24 23:06:45 +0200822 size_t i, n;
Luka Perkovd131ad62012-05-27 11:44:51 +0000823
Stefan Roese84899e22014-10-22 12:13:21 +0200824 block->soh = SOH;
Luka Perkovd131ad62012-05-27 11:44:51 +0000825 block->pnum = pnum;
826 block->_pnum = ~block->pnum;
827
Pali Rohár2ef87f72021-09-24 23:06:48 +0200828 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
Luka Perkovd131ad62012-05-27 11:44:51 +0000829 memcpy(&block->data[0], data, n);
Pali Rohár2ef87f72021-09-24 23:06:48 +0200830 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
Luka Perkovd131ad62012-05-27 11:44:51 +0000831
832 block->csum = 0;
833 for (i = 0; i < n; i++)
834 block->csum += block->data[i];
835
836 return n;
837}
838
Marek Behún12df7b72021-09-24 23:06:52 +0200839static uint64_t
840_now(void)
841{
842 struct timespec ts;
843
844 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
845 static int err_print;
846
847 if (!err_print) {
848 perror("clock_gettime() does not work");
849 err_print = 1;
850 }
851
852 /* this will just make the timeout not work */
853 return -1ULL;
854 }
855
856 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
857}
858
Luka Perkovd131ad62012-05-27 11:44:51 +0000859static int
Marek Behún408ea612021-09-24 23:06:49 +0200860_is_xm_reply(char c)
861{
Pali Rohár94c906a2022-01-25 18:13:03 +0100862 return c == ACK || c == NAK;
Marek Behún408ea612021-09-24 23:06:49 +0200863}
864
865static int
Pali Rohár9cdc2642021-09-24 23:06:54 +0200866_xm_reply_to_error(int c)
867{
868 int rc = -1;
869
870 switch (c) {
871 case ACK:
872 rc = 0;
873 break;
874 case NAK:
875 errno = EBADMSG;
876 break;
Pali Rohár9cdc2642021-09-24 23:06:54 +0200877 default:
878 errno = EPROTO;
879 break;
880 }
881
882 return rc;
883}
884
885static int
Pali Rohárca272042021-09-24 23:07:05 +0200886kwboot_baud_magic_handle(int fd, char c, int baudrate)
887{
888 static size_t rcv_len;
889
890 if (rcv_len < sizeof(kwb_baud_magic)) {
891 /* try to recognize whole magic word */
892 if (c == kwb_baud_magic[rcv_len]) {
893 rcv_len++;
894 } else {
895 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
896 fflush(stdout);
897 rcv_len = 0;
898 }
899 }
900
901 if (rcv_len == sizeof(kwb_baud_magic)) {
902 /* magic word received */
903 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
904
905 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
906 } else {
907 return 0;
908 }
909}
910
911static int
Pali Rohár950ed242022-01-25 18:13:04 +0100912kwboot_xm_recv_reply(int fd, char *c, int stop_on_non_xm,
Pali Rohár82a9e132022-01-25 18:13:02 +0100913 int ignore_nak_reply,
Pali Rohára6fcac22021-10-25 15:13:04 +0200914 int allow_non_xm, int *non_xm_print,
Pali Rohárca272042021-09-24 23:07:05 +0200915 int baudrate, int *baud_changed)
Pali Rohár48b3ea62021-09-24 23:06:50 +0200916{
Marek Behún12df7b72021-09-24 23:06:52 +0200917 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
Marek Behún819cd322021-09-24 23:06:53 +0200918 uint64_t recv_until = _now() + timeout;
Pali Rohár48b3ea62021-09-24 23:06:50 +0200919 int rc;
920
921 while (1) {
Marek Behún12df7b72021-09-24 23:06:52 +0200922 rc = kwboot_tty_recv(fd, c, 1, timeout);
Pali Rohár48b3ea62021-09-24 23:06:50 +0200923 if (rc) {
924 if (errno != ETIMEDOUT)
925 return rc;
Marek Behún819cd322021-09-24 23:06:53 +0200926 else if (allow_non_xm && *non_xm_print)
Marek Behún12df7b72021-09-24 23:06:52 +0200927 return -1;
928 else
929 *c = NAK;
Pali Rohár48b3ea62021-09-24 23:06:50 +0200930 }
931
932 /* If received xmodem reply, end. */
Pali Rohár82a9e132022-01-25 18:13:02 +0100933 if (_is_xm_reply(*c)) {
934 if (*c == NAK && ignore_nak_reply) {
935 timeout = recv_until - _now();
936 if (timeout >= 0)
937 continue;
938 }
Pali Rohár48b3ea62021-09-24 23:06:50 +0200939 break;
Pali Rohár82a9e132022-01-25 18:13:02 +0100940 }
Pali Rohár48b3ea62021-09-24 23:06:50 +0200941
942 /*
Pali Rohárca272042021-09-24 23:07:05 +0200943 * If receiving/printing non-xmodem text output is allowed and
944 * such a byte was received, we want to increase receiving time
945 * and either:
946 * - print the byte, if it is not part of baudrate change magic
947 * sequence while baudrate change was requested (-B option)
948 * - change baudrate
Marek Behún819cd322021-09-24 23:06:53 +0200949 * Otherwise decrease timeout by time elapsed.
Pali Rohár48b3ea62021-09-24 23:06:50 +0200950 */
951 if (allow_non_xm) {
Marek Behún12df7b72021-09-24 23:06:52 +0200952 recv_until = _now() + timeout;
Pali Rohárca272042021-09-24 23:07:05 +0200953
954 if (baudrate && !*baud_changed) {
955 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
956 if (rc == 1)
957 *baud_changed = 1;
958 else if (!rc)
959 *non_xm_print = 1;
960 else
961 return rc;
962 } else if (!baudrate || !*baud_changed) {
963 putchar(*c);
964 fflush(stdout);
965 *non_xm_print = 1;
966 }
Marek Behún819cd322021-09-24 23:06:53 +0200967 } else {
Pali Rohár950ed242022-01-25 18:13:04 +0100968 if (stop_on_non_xm)
Pali Rohára6fcac22021-10-25 15:13:04 +0200969 break;
Marek Behún819cd322021-09-24 23:06:53 +0200970 timeout = recv_until - _now();
971 if (timeout < 0) {
972 errno = ETIMEDOUT;
973 return -1;
974 }
Pali Rohár48b3ea62021-09-24 23:06:50 +0200975 }
976 }
977
978 return 0;
979}
980
981static int
982kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
Pali Rohár5875ad42022-01-25 18:13:05 +0100983 int *done_print, int baudrate, int allow_retries)
Luka Perkovd131ad62012-05-27 11:44:51 +0000984{
Pali Rohárca272042021-09-24 23:07:05 +0200985 int non_xm_print, baud_changed;
986 int rc, err, retries;
Luka Perkovd131ad62012-05-27 11:44:51 +0000987 char c;
988
Pali Rohár48b3ea62021-09-24 23:06:50 +0200989 *done_print = 0;
Pali Rohár455c0d22021-10-27 20:56:58 +0200990 non_xm_print = 0;
991 baud_changed = 0;
Pali Rohár48b3ea62021-09-24 23:06:50 +0200992
Pali Rohárd14a3422021-10-25 15:13:03 +0200993 retries = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +0000994 do {
Pali Rohárcab817d2021-10-27 20:56:59 +0200995 rc = kwboot_tty_send(fd, block, sizeof(*block), 1);
Luka Perkovd131ad62012-05-27 11:44:51 +0000996 if (rc)
Pali Rohár94c906a2022-01-25 18:13:03 +0100997 goto err;
Luka Perkovd131ad62012-05-27 11:44:51 +0000998
Pali Rohár48b3ea62021-09-24 23:06:50 +0200999 if (allow_non_xm && !*done_print) {
1000 kwboot_progress(100, '.');
1001 kwboot_printv("Done\n");
1002 *done_print = 1;
1003 }
Stefan Roese84899e22014-10-22 12:13:21 +02001004
Pali Rohára6fcac22021-10-25 15:13:04 +02001005 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Rohár82a9e132022-01-25 18:13:02 +01001006 retries > 8,
Pali Rohára6fcac22021-10-25 15:13:04 +02001007 allow_non_xm, &non_xm_print,
Pali Rohárca272042021-09-24 23:07:05 +02001008 baudrate, &baud_changed);
Pali Rohár48b3ea62021-09-24 23:06:50 +02001009 if (rc)
Pali Rohár94c906a2022-01-25 18:13:03 +01001010 goto err;
Stefan Roese84899e22014-10-22 12:13:21 +02001011
Pali Rohár5d8aa4c2022-01-25 18:13:06 +01001012 if (!allow_non_xm && c != ACK) {
1013 if (c == NAK && allow_retries && retries + 1 < 16)
1014 kwboot_progress(-1, '+');
1015 else
1016 kwboot_progress(-1, 'E');
1017 }
Pali Rohár5875ad42022-01-25 18:13:05 +01001018 } while (c == NAK && allow_retries && retries++ < 16);
Luka Perkovd131ad62012-05-27 11:44:51 +00001019
Marek Behún2e81b3a2021-09-24 23:06:51 +02001020 if (non_xm_print)
1021 kwboot_printv("\n");
1022
Pali Rohárca272042021-09-24 23:07:05 +02001023 if (allow_non_xm && baudrate && !baud_changed) {
1024 fprintf(stderr, "Baudrate was not changed\n");
Pali Rohárca272042021-09-24 23:07:05 +02001025 errno = EPROTO;
Pali Rohár94c906a2022-01-25 18:13:03 +01001026 return -1;
Pali Rohárca272042021-09-24 23:07:05 +02001027 }
1028
Pali Rohár9cdc2642021-09-24 23:06:54 +02001029 return _xm_reply_to_error(c);
Pali Rohár94c906a2022-01-25 18:13:03 +01001030err:
Pali Rohárca272042021-09-24 23:07:05 +02001031 err = errno;
Pali Rohárca272042021-09-24 23:07:05 +02001032 kwboot_printv("\n");
1033 errno = err;
1034 return rc;
Pali Rohár9cdc2642021-09-24 23:06:54 +02001035}
Luka Perkovd131ad62012-05-27 11:44:51 +00001036
Pali Rohár9cdc2642021-09-24 23:06:54 +02001037static int
1038kwboot_xm_finish(int fd)
1039{
1040 int rc, retries;
1041 char c;
Luka Perkovd131ad62012-05-27 11:44:51 +00001042
Pali Rohár9cdc2642021-09-24 23:06:54 +02001043 kwboot_printv("Finishing transfer\n");
1044
Pali Rohárd14a3422021-10-25 15:13:03 +02001045 retries = 0;
Pali Rohár9cdc2642021-09-24 23:06:54 +02001046 do {
1047 rc = kwboot_tty_send_char(fd, EOT);
1048 if (rc)
1049 return rc;
1050
Pali Rohára6fcac22021-10-25 15:13:04 +02001051 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Rohár82a9e132022-01-25 18:13:02 +01001052 retries > 8,
Pali Rohára6fcac22021-10-25 15:13:04 +02001053 0, NULL, 0, NULL);
Pali Rohár9cdc2642021-09-24 23:06:54 +02001054 if (rc)
1055 return rc;
Pali Rohárd14a3422021-10-25 15:13:03 +02001056 } while (c == NAK && retries++ < 16);
Pali Rohár9cdc2642021-09-24 23:06:54 +02001057
1058 return _xm_reply_to_error(c);
Luka Perkovd131ad62012-05-27 11:44:51 +00001059}
1060
1061static int
Pali Rohár2ef87f72021-09-24 23:06:48 +02001062kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
Pali Rohárca272042021-09-24 23:07:05 +02001063 size_t size, int baudrate)
Luka Perkovd131ad62012-05-27 11:44:51 +00001064{
Pali Rohár48b3ea62021-09-24 23:06:50 +02001065 int done_print = 0;
Pali Rohár2ef87f72021-09-24 23:06:48 +02001066 size_t sent, left;
1067 int rc;
Luka Perkovd131ad62012-05-27 11:44:51 +00001068
Pali Rohár2ef87f72021-09-24 23:06:48 +02001069 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
1070 header ? "header" : "data", size);
Luka Perkovd131ad62012-05-27 11:44:51 +00001071
Pali Rohár2ef87f72021-09-24 23:06:48 +02001072 left = size;
1073 sent = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001074
Pali Rohár2ef87f72021-09-24 23:06:48 +02001075 while (sent < size) {
Luka Perkovd131ad62012-05-27 11:44:51 +00001076 struct kwboot_block block;
Pali Rohár48b3ea62021-09-24 23:06:50 +02001077 int last_block;
Pali Rohár2ef87f72021-09-24 23:06:48 +02001078 size_t blksz;
Luka Perkovd131ad62012-05-27 11:44:51 +00001079
Pali Rohár2ef87f72021-09-24 23:06:48 +02001080 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1081 data += blksz;
Luka Perkovd131ad62012-05-27 11:44:51 +00001082
Pali Rohár48b3ea62021-09-24 23:06:50 +02001083 last_block = (left <= blksz);
1084
Pali Rohár5875ad42022-01-25 18:13:05 +01001085 /*
1086 * Handling of repeated xmodem packets is completely broken in
1087 * Armada 385 BootROM - it completely ignores xmodem packet
1088 * numbers, they are only used for checksum verification.
1089 * BootROM can handle a retry of the xmodem packet only during
1090 * the transmission of kwbimage header and only if BootROM
1091 * itself sent NAK response to previous attempt (it does it on
1092 * checksum failure). During the transmission of kwbimage data
1093 * part, BootROM always expects next xmodem packet, even if it
1094 * sent NAK to previous attempt - there is absolutely no way to
1095 * repair incorrectly transmitted xmodem packet during kwbimage
1096 * data part upload. Also, if kwboot receives non-ACK/NAK
1097 * response (meaning that original BootROM response was damaged
1098 * on UART) there is no way to detect if BootROM accepted xmodem
1099 * packet or not and no way to check if kwboot could repeat the
1100 * packet or not.
1101 *
1102 * Stop transfer and return failure if kwboot receives unknown
1103 * reply if non-xmodem reply is not allowed (for all xmodem
1104 * packets except the last header packet) or when non-ACK reply
1105 * is received during data part transfer.
1106 */
Pali Rohár48b3ea62021-09-24 23:06:50 +02001107 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
Pali Rohár5875ad42022-01-25 18:13:05 +01001108 &done_print, baudrate, header);
Luka Perkovd131ad62012-05-27 11:44:51 +00001109 if (rc)
1110 goto out;
1111
Pali Rohár2ef87f72021-09-24 23:06:48 +02001112 sent += blksz;
1113 left -= blksz;
Luka Perkovd131ad62012-05-27 11:44:51 +00001114
Pali Rohár48b3ea62021-09-24 23:06:50 +02001115 if (!done_print)
1116 kwboot_progress(sent * 100 / size, '.');
Pali Rohár2ef87f72021-09-24 23:06:48 +02001117 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001118
Pali Rohár48b3ea62021-09-24 23:06:50 +02001119 if (!done_print)
1120 kwboot_printv("Done\n");
Pali Rohár2ef87f72021-09-24 23:06:48 +02001121
1122 return 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001123out:
Pali Rohárd5ba8db2021-09-24 23:06:47 +02001124 kwboot_printv("\n");
Luka Perkovd131ad62012-05-27 11:44:51 +00001125 return rc;
Pali Rohár2ef87f72021-09-24 23:06:48 +02001126}
Luka Perkovd131ad62012-05-27 11:44:51 +00001127
Pali Rohár2ef87f72021-09-24 23:06:48 +02001128static int
Pali Rohárca272042021-09-24 23:07:05 +02001129kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
Pali Rohár2ef87f72021-09-24 23:06:48 +02001130{
1131 const uint8_t *img = _img;
1132 int rc, pnum;
1133 size_t hdrsz;
1134
Marek Behúnfe2fd732021-09-24 23:07:01 +02001135 hdrsz = kwbheader_size(img);
Pali Rohár2ef87f72021-09-24 23:06:48 +02001136
Pali Rohárf8017c32021-11-05 23:29:58 +01001137 /*
1138 * If header size is not aligned to xmodem block size (which applies
1139 * for all images in kwbimage v0 format) then we have to ensure that
1140 * the last xmodem block of header contains beginning of the data
1141 * followed by the header. So align header size to xmodem block size.
1142 */
1143 hdrsz += (KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ) % KWBOOT_XM_BLKSZ;
1144
Pali Rohár8bd15fd2022-01-25 18:13:01 +01001145 kwboot_printv("Waiting %d ms and flushing tty\n", blk_rsp_timeo);
1146 usleep(blk_rsp_timeo * 1000);
Pali Rohár2ef87f72021-09-24 23:06:48 +02001147 tcflush(tty, TCIOFLUSH);
1148
1149 pnum = 1;
1150
Pali Rohárca272042021-09-24 23:07:05 +02001151 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
Pali Rohár2ef87f72021-09-24 23:06:48 +02001152 if (rc)
1153 return rc;
1154
Pali Rohárf8017c32021-11-05 23:29:58 +01001155 /*
1156 * If we have already sent image data as a part of the last
1157 * xmodem header block then we have nothing more to send.
1158 */
1159 if (hdrsz < size) {
1160 img += hdrsz;
1161 size -= hdrsz;
1162 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1163 if (rc)
1164 return rc;
1165 }
Pali Rohár2ef87f72021-09-24 23:06:48 +02001166
Pali Rohárca272042021-09-24 23:07:05 +02001167 rc = kwboot_xm_finish(tty);
1168 if (rc)
1169 return rc;
1170
1171 if (baudrate) {
Pali Rohárca272042021-09-24 23:07:05 +02001172 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1173 rc = kwboot_tty_change_baudrate(tty, 115200);
1174 if (rc)
1175 return rc;
1176 }
1177
1178 return 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001179}
1180
1181static int
Marek Behún46237e62021-09-24 23:06:40 +02001182kwboot_term_pipe(int in, int out, const char *quit, int *s)
Luka Perkovd131ad62012-05-27 11:44:51 +00001183{
Marek Behúne453bb42021-09-24 23:06:41 +02001184 ssize_t nin;
Luka Perkovd131ad62012-05-27 11:44:51 +00001185 char _buf[128], *buf = _buf;
1186
Pali Rohár43fef8d2021-07-23 11:14:17 +02001187 nin = read(in, buf, sizeof(_buf));
Willy Tarreau4469bd72018-07-03 12:10:31 -04001188 if (nin <= 0)
Luka Perkovd131ad62012-05-27 11:44:51 +00001189 return -1;
1190
1191 if (quit) {
1192 int i;
1193
1194 for (i = 0; i < nin; i++) {
1195 if (*buf == quit[*s]) {
1196 (*s)++;
1197 if (!quit[*s])
1198 return 0;
1199 buf++;
1200 nin--;
Pali Rohárb943eee2021-07-23 11:14:20 +02001201 } else {
Marek Behúne453bb42021-09-24 23:06:41 +02001202 if (kwboot_write(out, quit, *s) < 0)
1203 return -1;
1204 *s = 0;
Pali Rohárb943eee2021-07-23 11:14:20 +02001205 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001206 }
1207 }
1208
Marek Behúne453bb42021-09-24 23:06:41 +02001209 if (kwboot_write(out, buf, nin) < 0)
1210 return -1;
Luka Perkovd131ad62012-05-27 11:44:51 +00001211
1212 return 0;
1213}
1214
1215static int
1216kwboot_terminal(int tty)
1217{
1218 int rc, in, s;
Marek Behún46237e62021-09-24 23:06:40 +02001219 const char *quit = "\34c";
Luka Perkovd131ad62012-05-27 11:44:51 +00001220 struct termios otio, tio;
1221
1222 rc = -1;
1223
1224 in = STDIN_FILENO;
1225 if (isatty(in)) {
1226 rc = tcgetattr(in, &otio);
1227 if (!rc) {
1228 tio = otio;
1229 cfmakeraw(&tio);
1230 rc = tcsetattr(in, TCSANOW, &tio);
1231 }
1232 if (rc) {
1233 perror("tcsetattr");
1234 goto out;
1235 }
1236
1237 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
Marek Behún5fa04f42021-09-24 23:07:11 +02001238 quit[0] | 0100, quit[1]);
Luka Perkovd131ad62012-05-27 11:44:51 +00001239 } else
1240 in = -1;
1241
1242 rc = 0;
1243 s = 0;
1244
1245 do {
1246 fd_set rfds;
1247 int nfds = 0;
1248
Pali Rohár0a143412021-10-25 15:12:52 +02001249 FD_ZERO(&rfds);
Luka Perkovd131ad62012-05-27 11:44:51 +00001250 FD_SET(tty, &rfds);
1251 nfds = nfds < tty ? tty : nfds;
1252
1253 if (in >= 0) {
1254 FD_SET(in, &rfds);
1255 nfds = nfds < in ? in : nfds;
1256 }
1257
1258 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1259 if (nfds < 0)
1260 break;
1261
1262 if (FD_ISSET(tty, &rfds)) {
1263 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1264 if (rc)
1265 break;
1266 }
1267
Marek Behúnf30cb0d2021-09-24 23:06:39 +02001268 if (in >= 0 && FD_ISSET(in, &rfds)) {
Luka Perkovd131ad62012-05-27 11:44:51 +00001269 rc = kwboot_term_pipe(in, tty, quit, &s);
1270 if (rc)
1271 break;
1272 }
1273 } while (quit[s] != 0);
1274
Pali Rohárec0fe5b2021-07-23 11:14:18 +02001275 if (in >= 0)
1276 tcsetattr(in, TCSANOW, &otio);
Pali Rohár49a0a3b2021-07-23 11:14:19 +02001277 printf("\n");
Luka Perkovd131ad62012-05-27 11:44:51 +00001278out:
1279 return rc;
1280}
1281
1282static void *
Pali Rohár04ced022021-09-24 23:07:03 +02001283kwboot_read_image(const char *path, size_t *size, size_t reserve)
Luka Perkovd131ad62012-05-27 11:44:51 +00001284{
Pali Rohárddc04fa2021-09-24 23:06:55 +02001285 int rc, fd;
Luka Perkovd131ad62012-05-27 11:44:51 +00001286 struct stat st;
1287 void *img;
Pali Rohár04ced022021-09-24 23:07:03 +02001288 off_t tot;
Luka Perkovd131ad62012-05-27 11:44:51 +00001289
1290 rc = -1;
Luka Perkovd131ad62012-05-27 11:44:51 +00001291 img = NULL;
1292
1293 fd = open(path, O_RDONLY);
1294 if (fd < 0)
1295 goto out;
1296
1297 rc = fstat(fd, &st);
1298 if (rc)
1299 goto out;
1300
Pali Rohár04ced022021-09-24 23:07:03 +02001301 img = malloc(st.st_size + reserve);
1302 if (!img)
Luka Perkovd131ad62012-05-27 11:44:51 +00001303 goto out;
Pali Rohár04ced022021-09-24 23:07:03 +02001304
1305 tot = 0;
1306 while (tot < st.st_size) {
1307 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1308
1309 if (rd < 0)
1310 goto out;
1311
1312 tot += rd;
1313
1314 if (!rd && tot < st.st_size) {
1315 errno = EIO;
1316 goto out;
1317 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001318 }
1319
1320 rc = 0;
1321 *size = st.st_size;
1322out:
1323 if (rc && img) {
Pali Rohár04ced022021-09-24 23:07:03 +02001324 free(img);
Luka Perkovd131ad62012-05-27 11:44:51 +00001325 img = NULL;
1326 }
1327 if (fd >= 0)
1328 close(fd);
1329
1330 return img;
1331}
1332
1333static uint8_t
Marek Behúnfe2fd732021-09-24 23:07:01 +02001334kwboot_hdr_csum8(const void *hdr)
Luka Perkovd131ad62012-05-27 11:44:51 +00001335{
Marek Behúnfe2fd732021-09-24 23:07:01 +02001336 const uint8_t *data = hdr;
1337 uint8_t csum;
1338 size_t size;
1339
1340 size = kwbheader_size_for_csum(hdr);
Luka Perkovd131ad62012-05-27 11:44:51 +00001341
1342 for (csum = 0; size-- > 0; data++)
1343 csum += *data;
1344
1345 return csum;
1346}
1347
Pali Rohárad9a3ac2021-10-25 15:12:55 +02001348static uint32_t *
1349kwboot_img_csum32_ptr(void *img)
1350{
1351 struct main_hdr_v1 *hdr = img;
1352 uint32_t datasz;
1353
1354 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1355
1356 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1357}
1358
1359static uint32_t
1360kwboot_img_csum32(const void *img)
1361{
1362 const struct main_hdr_v1 *hdr = img;
1363 uint32_t datasz, csum = 0;
1364 const uint32_t *data;
1365
1366 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1367 if (datasz % sizeof(uint32_t))
1368 return 0;
1369
1370 data = img + le32_to_cpu(hdr->srcaddr);
1371 while (datasz > 0) {
1372 csum += le32_to_cpu(*data++);
1373 datasz -= 4;
1374 }
1375
1376 return cpu_to_le32(csum);
1377}
1378
Luka Perkovd131ad62012-05-27 11:44:51 +00001379static int
Pali Rohár550c9302021-09-24 23:06:57 +02001380kwboot_img_is_secure(void *img)
1381{
1382 struct opt_hdr_v1 *ohdr;
1383
1384 for_each_opt_hdr_v1 (ohdr, img)
1385 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1386 return 1;
1387
1388 return 0;
1389}
1390
Pali Rohárca272042021-09-24 23:07:05 +02001391static void *
Pali Rohár063cb352021-10-25 15:12:56 +02001392kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
Pali Rohárca272042021-09-24 23:07:05 +02001393{
Pali Rohárca272042021-09-24 23:07:05 +02001394 struct main_hdr_v1 *hdr = img;
Pali Rohár063cb352021-10-25 15:12:56 +02001395 void *result;
Pali Rohárca272042021-09-24 23:07:05 +02001396
Pali Rohár063cb352021-10-25 15:12:56 +02001397 /*
1398 * 32-bit checksum comes after end of image code, so we will be putting
1399 * new code there. So we get this pointer and then increase data size
1400 * (since increasing data size changes kwboot_img_csum32_ptr() return
1401 * value).
1402 */
1403 result = kwboot_img_csum32_ptr(img);
Pali Rohárca272042021-09-24 23:07:05 +02001404 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
Pali Rohár063cb352021-10-25 15:12:56 +02001405 *size += grow;
Pali Rohárca272042021-09-24 23:07:05 +02001406
Pali Rohár063cb352021-10-25 15:12:56 +02001407 return result;
Pali Rohárca272042021-09-24 23:07:05 +02001408}
1409
Pali Rohár04ced022021-09-24 23:07:03 +02001410static void
1411kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1412{
1413 uint32_t hdrsz, datasz, srcaddr;
1414 struct main_hdr_v1 *hdr = img;
Pali Rohárd656f5a2021-10-25 15:13:02 +02001415 struct opt_hdr_v1 *ohdr;
Pali Rohár04ced022021-09-24 23:07:03 +02001416 uint8_t *data;
1417
1418 srcaddr = le32_to_cpu(hdr->srcaddr);
1419
Pali Rohárd656f5a2021-10-25 15:13:02 +02001420 /* calculate real used space in kwbimage header */
1421 if (kwbimage_version(img) == 0) {
1422 hdrsz = kwbheader_size(img);
1423 } else {
1424 hdrsz = sizeof(*hdr);
1425 for_each_opt_hdr_v1 (ohdr, hdr)
1426 hdrsz += opt_hdr_v1_size(ohdr);
1427 }
1428
Pali Rohár04ced022021-09-24 23:07:03 +02001429 data = (uint8_t *)img + srcaddr;
1430 datasz = *size - srcaddr;
1431
1432 /* only move data if there is not enough space */
1433 if (hdrsz + grow > srcaddr) {
1434 size_t need = hdrsz + grow - srcaddr;
1435
1436 /* move data by enough bytes */
1437 memmove(data + need, data, datasz);
1438
1439 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1440 *size += need;
1441 }
1442
1443 if (kwbimage_version(img) == 1) {
1444 hdrsz += grow;
Pali Rohárd656f5a2021-10-25 15:13:02 +02001445 if (hdrsz > kwbheader_size(img)) {
1446 hdr->headersz_msb = hdrsz >> 16;
1447 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1448 }
Pali Rohár04ced022021-09-24 23:07:03 +02001449 }
1450}
1451
Pali Rohárca272042021-09-24 23:07:05 +02001452static void *
1453kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1454{
1455 struct main_hdr_v1 *hdr = img;
1456 struct opt_hdr_v1 *ohdr;
Pali Rohára85a71d2021-10-21 16:46:06 +02001457 uint32_t num_args;
1458 uint32_t offset;
Pali Rohárca272042021-09-24 23:07:05 +02001459 uint32_t ohdrsz;
Pali Roháre511cc32021-10-25 15:13:01 +02001460 uint8_t *prev_ext;
Pali Rohárca272042021-09-24 23:07:05 +02001461
Pali Rohár44691032022-01-12 18:20:52 +01001462 if (hdr->ext) {
Pali Rohárca272042021-09-24 23:07:05 +02001463 for_each_opt_hdr_v1 (ohdr, img)
1464 if (opt_hdr_v1_next(ohdr) == NULL)
1465 break;
1466
Pali Roháre511cc32021-10-25 15:13:01 +02001467 prev_ext = opt_hdr_v1_ext(ohdr);
1468 ohdr = _opt_hdr_v1_next(ohdr);
Pali Rohárca272042021-09-24 23:07:05 +02001469 } else {
Pali Rohárca272042021-09-24 23:07:05 +02001470 ohdr = (void *)(hdr + 1);
Pali Roháre511cc32021-10-25 15:13:01 +02001471 prev_ext = &hdr->ext;
Pali Rohárca272042021-09-24 23:07:05 +02001472 }
1473
Pali Rohára85a71d2021-10-21 16:46:06 +02001474 /*
1475 * ARM executable code inside the BIN header on some mvebu platforms
1476 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1477 * This requirement can be met by inserting dummy arguments into
1478 * BIN header, if needed.
1479 */
1480 offset = &ohdr->data[4] - (char *)img;
1481 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1482
1483 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1484 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1485
Pali Rohár44691032022-01-12 18:20:52 +01001486 *prev_ext = 1;
Pali Roháre511cc32021-10-25 15:13:01 +02001487
Pali Rohárca272042021-09-24 23:07:05 +02001488 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1489 ohdr->headersz_msb = ohdrsz >> 16;
1490 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1491
1492 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
Pali Rohára85a71d2021-10-21 16:46:06 +02001493 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
Pali Rohárca272042021-09-24 23:07:05 +02001494
Pali Rohára85a71d2021-10-21 16:46:06 +02001495 return &ohdr->data[4 + 4 * num_args];
Pali Rohárca272042021-09-24 23:07:05 +02001496}
1497
1498static void
Pali Rohár8dbe0272021-10-27 20:57:02 +02001499_inject_baudrate_change_code(void *img, size_t *size, int for_data,
Pali Rohár063cb352021-10-25 15:12:56 +02001500 int old_baud, int new_baud)
Pali Rohárca272042021-09-24 23:07:05 +02001501{
Pali Rohár063cb352021-10-25 15:12:56 +02001502 struct main_hdr_v1 *hdr = img;
Pali Rohár8dbe0272021-10-27 20:57:02 +02001503 uint32_t orig_datasz;
1504 uint32_t codesz;
Pali Rohár063cb352021-10-25 15:12:56 +02001505 uint8_t *code;
Pali Rohárca272042021-09-24 23:07:05 +02001506
Pali Rohár8dbe0272021-10-27 20:57:02 +02001507 if (for_data) {
Pali Rohár063cb352021-10-25 15:12:56 +02001508 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1509
Pali Rohár8dbe0272021-10-27 20:57:02 +02001510 codesz = sizeof(kwboot_baud_code) +
1511 sizeof(kwboot_baud_code_data_jump);
1512 code = kwboot_img_grow_data_right(img, size, codesz);
Pali Rohár063cb352021-10-25 15:12:56 +02001513 } else {
Pali Rohár8dbe0272021-10-27 20:57:02 +02001514 codesz = sizeof(kwboot_baud_code_binhdr_pre) +
1515 sizeof(kwboot_baud_code) +
1516 sizeof(kwboot_baud_code_binhdr_post);
Pali Rohár063cb352021-10-25 15:12:56 +02001517 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
Pali Rohár8dbe0272021-10-27 20:57:02 +02001518
1519 codesz = sizeof(kwboot_baud_code_binhdr_pre);
1520 memcpy(code, kwboot_baud_code_binhdr_pre, codesz);
1521 code += codesz;
Pali Rohárca272042021-09-24 23:07:05 +02001522 }
1523
Pali Rohár8dbe0272021-10-27 20:57:02 +02001524 codesz = sizeof(kwboot_baud_code) - 2 * sizeof(uint32_t);
1525 memcpy(code, kwboot_baud_code, codesz);
1526 code += codesz;
1527 *(uint32_t *)code = cpu_to_le32(old_baud);
1528 code += sizeof(uint32_t);
1529 *(uint32_t *)code = cpu_to_le32(new_baud);
1530 code += sizeof(uint32_t);
1531
1532 if (for_data) {
1533 codesz = sizeof(kwboot_baud_code_data_jump) - sizeof(uint32_t);
1534 memcpy(code, kwboot_baud_code_data_jump, codesz);
1535 code += codesz;
1536 *(uint32_t *)code = hdr->execaddr;
1537 code += sizeof(uint32_t);
1538 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) + orig_datasz);
1539 } else {
1540 codesz = sizeof(kwboot_baud_code_binhdr_post);
1541 memcpy(code, kwboot_baud_code_binhdr_post, codesz);
1542 code += codesz;
1543 }
Pali Rohárca272042021-09-24 23:07:05 +02001544}
1545
Pali Rohár550c9302021-09-24 23:06:57 +02001546static int
Pali Rohárca272042021-09-24 23:07:05 +02001547kwboot_img_patch(void *img, size_t *size, int baudrate)
Luka Perkovd131ad62012-05-27 11:44:51 +00001548{
Stefan Roesee29f1db2015-09-29 09:19:59 +02001549 struct main_hdr_v1 *hdr;
Pali Rohár792e4232021-09-24 23:06:58 +02001550 uint32_t srcaddr;
Luka Perkovd131ad62012-05-27 11:44:51 +00001551 uint8_t csum;
Marek Behún5c8f8122021-09-24 23:07:04 +02001552 size_t hdrsz;
Stefan Roesee29f1db2015-09-29 09:19:59 +02001553 int image_ver;
Pali Rohár550c9302021-09-24 23:06:57 +02001554 int is_secure;
Luka Perkovd131ad62012-05-27 11:44:51 +00001555
Luka Perkovd131ad62012-05-27 11:44:51 +00001556 hdr = img;
1557
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001558 if (*size < sizeof(struct main_hdr_v1))
1559 goto err;
Luka Perkovd131ad62012-05-27 11:44:51 +00001560
Marek Behúnacb0b382021-09-24 23:07:00 +02001561 image_ver = kwbimage_version(img);
Pali Rohár5029d7b2021-07-23 11:14:22 +02001562 if (image_ver != 0 && image_ver != 1) {
Stefan Roesee29f1db2015-09-29 09:19:59 +02001563 fprintf(stderr, "Invalid image header version\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001564 goto err;
Stefan Roesee29f1db2015-09-29 09:19:59 +02001565 }
1566
Marek Behúnfe2fd732021-09-24 23:07:01 +02001567 hdrsz = kwbheader_size(hdr);
Stefan Roesee29f1db2015-09-29 09:19:59 +02001568
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001569 if (*size < hdrsz)
1570 goto err;
Pali Rohár825a2ca2021-07-23 11:14:21 +02001571
Marek Behúnfe2fd732021-09-24 23:07:01 +02001572 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001573 if (csum != hdr->checksum)
1574 goto err;
Luka Perkovd131ad62012-05-27 11:44:51 +00001575
Pali Rohár792e4232021-09-24 23:06:58 +02001576 srcaddr = le32_to_cpu(hdr->srcaddr);
1577
1578 switch (hdr->blockid) {
1579 case IBR_HDR_SATA_ID:
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001580 if (srcaddr < 1)
1581 goto err;
1582
Pali Rohár792e4232021-09-24 23:06:58 +02001583 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1584 break;
1585
1586 case IBR_HDR_SDIO_ID:
1587 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1588 break;
1589
1590 case IBR_HDR_PEX_ID:
1591 if (srcaddr == 0xFFFFFFFF)
1592 hdr->srcaddr = cpu_to_le32(hdrsz);
1593 break;
Pali Rohárf2c644e2021-09-24 23:06:59 +02001594
1595 case IBR_HDR_SPI_ID:
1596 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1597 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1598 hdr->destaddr = cpu_to_le32(0x00800000);
1599 hdr->execaddr = cpu_to_le32(0x00800000);
1600 }
1601 break;
Pali Rohár792e4232021-09-24 23:06:58 +02001602 }
1603
Pali Rohár04ced022021-09-24 23:07:03 +02001604 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001605 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1606 goto err;
Pali Rohár04ced022021-09-24 23:07:03 +02001607
Pali Rohárad9a3ac2021-10-25 15:12:55 +02001608 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1609 goto err;
1610
Pali Rohár550c9302021-09-24 23:06:57 +02001611 is_secure = kwboot_img_is_secure(img);
Luka Perkovd131ad62012-05-27 11:44:51 +00001612
Pali Rohár550c9302021-09-24 23:06:57 +02001613 if (hdr->blockid != IBR_HDR_UART_ID) {
1614 if (is_secure) {
1615 fprintf(stderr,
1616 "Image has secure header with signature for non-UART booting\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001617 goto err;
Pali Rohár550c9302021-09-24 23:06:57 +02001618 }
1619
1620 kwboot_printv("Patching image boot signature to UART\n");
1621 hdr->blockid = IBR_HDR_UART_ID;
1622 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001623
Pali Rohár0089f612021-10-22 12:37:47 +02001624 if (!is_secure) {
Pali Rohár4bebab62021-10-25 15:12:58 +02001625 if (image_ver == 1) {
1626 /*
1627 * Tell BootROM to send BootROM messages to UART port
1628 * number 0 (used also for UART booting) with default
1629 * baudrate (which should be 115200) and do not touch
1630 * UART MPP configuration.
1631 */
1632 hdr->options &= ~0x1F;
1633 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1634 hdr->options |= 0 << 3;
1635 }
Pali Rohár0089f612021-10-22 12:37:47 +02001636 if (image_ver == 0)
1637 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1638 hdr->nandpagesize = 0;
1639 }
1640
Pali Rohárca272042021-09-24 23:07:05 +02001641 if (baudrate) {
Pali Rohárca272042021-09-24 23:07:05 +02001642 if (image_ver == 0) {
1643 fprintf(stderr,
1644 "Cannot inject code for changing baudrate into v0 image header\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001645 goto err;
Pali Rohárca272042021-09-24 23:07:05 +02001646 }
1647
1648 if (is_secure) {
1649 fprintf(stderr,
1650 "Cannot inject code for changing baudrate into image with secure header\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001651 goto err;
Pali Rohárca272042021-09-24 23:07:05 +02001652 }
1653
1654 /*
1655 * First inject code that changes the baudrate from the default
1656 * value of 115200 Bd to requested value. This code is inserted
1657 * as a new opt hdr, so it is executed by BootROM after the
1658 * header part is received.
1659 */
1660 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1661 baudrate);
Pali Rohár063cb352021-10-25 15:12:56 +02001662 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
Pali Rohárca272042021-09-24 23:07:05 +02001663
1664 /*
1665 * Now inject code that changes the baudrate back to 115200 Bd.
Pali Rohár063cb352021-10-25 15:12:56 +02001666 * This code is appended after the data part of the image, and
1667 * execaddr is changed so that it is executed before U-Boot
1668 * proper.
Pali Rohárca272042021-09-24 23:07:05 +02001669 */
1670 kwboot_printv("Injecting code for changing baudrate back\n");
Pali Rohár063cb352021-10-25 15:12:56 +02001671 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
Pali Rohárca272042021-09-24 23:07:05 +02001672
Pali Rohár82c5a0a2021-10-25 15:12:57 +02001673 /* Update the 32-bit data checksum */
1674 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1675
Pali Rohárca272042021-09-24 23:07:05 +02001676 /* recompute header size */
1677 hdrsz = kwbheader_size(hdr);
1678 }
1679
Pali Rohár04ced022021-09-24 23:07:03 +02001680 if (hdrsz % KWBOOT_XM_BLKSZ) {
Pali Roháred792c22021-10-25 15:13:00 +02001681 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
Pali Rohár04ced022021-09-24 23:07:03 +02001682
1683 if (is_secure) {
1684 fprintf(stderr, "Cannot align image with secure header\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001685 goto err;
Pali Rohár04ced022021-09-24 23:07:03 +02001686 }
1687
1688 kwboot_printv("Aligning image header to Xmodem block size\n");
Pali Roháred792c22021-10-25 15:13:00 +02001689 kwboot_img_grow_hdr(img, size, grow);
Pali Rohár04ced022021-09-24 23:07:03 +02001690 }
1691
Marek Behúnfe2fd732021-09-24 23:07:01 +02001692 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
Luka Perkovd131ad62012-05-27 11:44:51 +00001693
Pali Rohár04ced022021-09-24 23:07:03 +02001694 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001695 return 0;
1696err:
1697 errno = EINVAL;
1698 return -1;
Luka Perkovd131ad62012-05-27 11:44:51 +00001699}
1700
1701static void
1702kwboot_usage(FILE *stream, char *progname)
1703{
1704 fprintf(stream,
Kevin Smith8669dac2016-02-16 21:28:17 +00001705 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
Stefan Roese84899e22014-10-22 12:13:21 +02001706 progname);
Luka Perkovd131ad62012-05-27 11:44:51 +00001707 fprintf(stream, "\n");
Stefan Roese84899e22014-10-22 12:13:21 +02001708 fprintf(stream,
1709 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
Stefan Roese84899e22014-10-22 12:13:21 +02001710 fprintf(stream,
1711 " -D <image>: boot <image> without preamble (Dove)\n");
1712 fprintf(stream, " -d: enter debug mode\n");
1713 fprintf(stream, " -a: use timings for Armada XP\n");
Stefan Roese1c0df9e2015-05-29 13:25:04 +02001714 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
1715 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
Kevin Smith7497a6a2016-02-16 21:28:19 +00001716 fprintf(stream,
1717 " -o <block-timeo>: use specific xmodem block timeout\n");
Luka Perkovd131ad62012-05-27 11:44:51 +00001718 fprintf(stream, "\n");
1719 fprintf(stream, " -t: mini terminal\n");
1720 fprintf(stream, "\n");
1721 fprintf(stream, " -B <baud>: set baud rate\n");
1722 fprintf(stream, "\n");
1723}
1724
1725int
1726main(int argc, char **argv)
1727{
1728 const char *ttypath, *imgpath;
Pali Rohárddc04fa2021-09-24 23:06:55 +02001729 int rv, rc, tty, term;
Luka Perkovd131ad62012-05-27 11:44:51 +00001730 void *bootmsg;
Stefan Roese84899e22014-10-22 12:13:21 +02001731 void *debugmsg;
Luka Perkovd131ad62012-05-27 11:44:51 +00001732 void *img;
1733 size_t size;
Pali Rohárca272042021-09-24 23:07:05 +02001734 size_t after_img_rsv;
1735 int baudrate;
Pali Rohárc513fe42022-01-25 18:13:07 +01001736 int prev_optind;
1737 int c;
Luka Perkovd131ad62012-05-27 11:44:51 +00001738
1739 rv = 1;
1740 tty = -1;
1741 bootmsg = NULL;
Stefan Roese84899e22014-10-22 12:13:21 +02001742 debugmsg = NULL;
Luka Perkovd131ad62012-05-27 11:44:51 +00001743 imgpath = NULL;
1744 img = NULL;
1745 term = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001746 size = 0;
Pali Rohárca272042021-09-24 23:07:05 +02001747 after_img_rsv = KWBOOT_XM_BLKSZ;
1748 baudrate = 115200;
Luka Perkovd131ad62012-05-27 11:44:51 +00001749
Pali Rohár75176dc2021-11-05 23:30:42 +01001750 printf("kwboot version %s\n", PLAIN_VERSION);
1751
Luka Perkovd131ad62012-05-27 11:44:51 +00001752 kwboot_verbose = isatty(STDOUT_FILENO);
1753
1754 do {
Pali Rohárc513fe42022-01-25 18:13:07 +01001755 prev_optind = optind;
1756 c = getopt(argc, argv, "hbptaB:dD:q:s:o:");
Luka Perkovd131ad62012-05-27 11:44:51 +00001757 if (c < 0)
1758 break;
1759
1760 switch (c) {
1761 case 'b':
Pali Rohárc513fe42022-01-25 18:13:07 +01001762 if (imgpath || bootmsg || debugmsg)
1763 goto usage;
Luka Perkovd131ad62012-05-27 11:44:51 +00001764 bootmsg = kwboot_msg_boot;
Pali Rohárc513fe42022-01-25 18:13:07 +01001765 if (prev_optind == optind)
1766 goto usage;
1767 if (argv[optind] && argv[optind][0] != '-')
1768 imgpath = argv[optind++];
Luka Perkovd131ad62012-05-27 11:44:51 +00001769 break;
1770
Stefan Roese84899e22014-10-22 12:13:21 +02001771 case 'D':
Pali Rohárc513fe42022-01-25 18:13:07 +01001772 if (imgpath || bootmsg || debugmsg)
1773 goto usage;
Stefan Roese84899e22014-10-22 12:13:21 +02001774 bootmsg = NULL;
1775 imgpath = optarg;
1776 break;
1777
1778 case 'd':
Pali Rohárc513fe42022-01-25 18:13:07 +01001779 if (imgpath || bootmsg || debugmsg)
1780 goto usage;
Stefan Roese84899e22014-10-22 12:13:21 +02001781 debugmsg = kwboot_msg_debug;
1782 break;
1783
Luka Perkovd131ad62012-05-27 11:44:51 +00001784 case 'p':
Pali Rohárddc04fa2021-09-24 23:06:55 +02001785 /* nop, for backward compatibility */
Luka Perkovd131ad62012-05-27 11:44:51 +00001786 break;
1787
1788 case 't':
1789 term = 1;
1790 break;
1791
Stefan Roese84899e22014-10-22 12:13:21 +02001792 case 'a':
1793 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
1794 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1795 break;
1796
Stefan Roese1c0df9e2015-05-29 13:25:04 +02001797 case 'q':
1798 msg_req_delay = atoi(optarg);
1799 break;
1800
1801 case 's':
1802 msg_rsp_timeo = atoi(optarg);
1803 break;
1804
Kevin Smith7497a6a2016-02-16 21:28:19 +00001805 case 'o':
1806 blk_rsp_timeo = atoi(optarg);
1807 break;
1808
Luka Perkovd131ad62012-05-27 11:44:51 +00001809 case 'B':
Pali Rohárca272042021-09-24 23:07:05 +02001810 baudrate = atoi(optarg);
Luka Perkovd131ad62012-05-27 11:44:51 +00001811 break;
1812
1813 case 'h':
1814 rv = 0;
1815 default:
1816 goto usage;
1817 }
1818 } while (1);
1819
Stefan Roese84899e22014-10-22 12:13:21 +02001820 if (!bootmsg && !term && !debugmsg)
Luka Perkovd131ad62012-05-27 11:44:51 +00001821 goto usage;
1822
Luka Perkovd131ad62012-05-27 11:44:51 +00001823 ttypath = argv[optind++];
1824
Pali Rohárc513fe42022-01-25 18:13:07 +01001825 if (optind != argc)
1826 goto usage;
1827
Pali Rohárca272042021-09-24 23:07:05 +02001828 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
Luka Perkovd131ad62012-05-27 11:44:51 +00001829 if (tty < 0) {
1830 perror(ttypath);
1831 goto out;
1832 }
1833
Pali Rohárca272042021-09-24 23:07:05 +02001834 if (baudrate == 115200)
1835 /* do not change baudrate during Xmodem to the same value */
1836 baudrate = 0;
1837 else
1838 /* ensure we have enough space for baudrate change code */
Pali Rohár8dbe0272021-10-27 20:57:02 +02001839 after_img_rsv += sizeof(struct opt_hdr_v1) + 8 + 16 +
1840 sizeof(kwboot_baud_code_binhdr_pre) +
Pali Rohár5923ef62021-10-25 15:12:54 +02001841 sizeof(kwboot_baud_code) +
Pali Rohár8dbe0272021-10-27 20:57:02 +02001842 sizeof(kwboot_baud_code_binhdr_post) +
1843 KWBOOT_XM_BLKSZ +
1844 sizeof(kwboot_baud_code) +
1845 sizeof(kwboot_baud_code_data_jump) +
Pali Rohár5923ef62021-10-25 15:12:54 +02001846 KWBOOT_XM_BLKSZ;
Pali Rohárca272042021-09-24 23:07:05 +02001847
Luka Perkovd131ad62012-05-27 11:44:51 +00001848 if (imgpath) {
Pali Rohárca272042021-09-24 23:07:05 +02001849 img = kwboot_read_image(imgpath, &size, after_img_rsv);
Luka Perkovd131ad62012-05-27 11:44:51 +00001850 if (!img) {
1851 perror(imgpath);
1852 goto out;
1853 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001854
Pali Rohárca272042021-09-24 23:07:05 +02001855 rc = kwboot_img_patch(img, &size, baudrate);
Luka Perkovd131ad62012-05-27 11:44:51 +00001856 if (rc) {
1857 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1858 goto out;
1859 }
1860 }
1861
Stefan Roese84899e22014-10-22 12:13:21 +02001862 if (debugmsg) {
1863 rc = kwboot_debugmsg(tty, debugmsg);
1864 if (rc) {
1865 perror("debugmsg");
1866 goto out;
1867 }
Willy Tarreau3475a712018-07-03 12:10:30 -04001868 } else if (bootmsg) {
Luka Perkovd131ad62012-05-27 11:44:51 +00001869 rc = kwboot_bootmsg(tty, bootmsg);
1870 if (rc) {
1871 perror("bootmsg");
1872 goto out;
1873 }
1874 }
1875
1876 if (img) {
Pali Rohárca272042021-09-24 23:07:05 +02001877 rc = kwboot_xmodem(tty, img, size, baudrate);
Luka Perkovd131ad62012-05-27 11:44:51 +00001878 if (rc) {
1879 perror("xmodem");
1880 goto out;
1881 }
1882 }
1883
1884 if (term) {
1885 rc = kwboot_terminal(tty);
1886 if (rc && !(errno == EINTR)) {
1887 perror("terminal");
1888 goto out;
1889 }
1890 }
1891
1892 rv = 0;
1893out:
1894 if (tty >= 0)
1895 close(tty);
1896
1897 if (img)
Pali Rohár04ced022021-09-24 23:07:03 +02001898 free(img);
Luka Perkovd131ad62012-05-27 11:44:51 +00001899
1900 return rv;
1901
1902usage:
1903 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));
1904 goto out;
1905}