blob: dfac8aed7beffbdf455c183c750fb1032b8772bb [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{
720 int rc;
721 char c;
Jon Nettleton9ca6fae2018-08-13 18:24:38 +0300722 int count;
Luka Perkovd131ad62012-05-27 11:44:51 +0000723
Stefan Roese84899e22014-10-22 12:13:21 +0200724 if (msg == NULL)
725 kwboot_printv("Please reboot the target into UART boot mode...");
726 else
727 kwboot_printv("Sending boot message. Please reboot the target...");
Luka Perkovd131ad62012-05-27 11:44:51 +0000728
729 do {
730 rc = tcflush(tty, TCIOFLUSH);
731 if (rc)
732 break;
733
Jon Nettleton9ca6fae2018-08-13 18:24:38 +0300734 for (count = 0; count < 128; count++) {
Pali Rohárcab817d2021-10-27 20:56:59 +0200735 rc = kwboot_tty_send(tty, msg, 8, 0);
Jon Nettleton9ca6fae2018-08-13 18:24:38 +0300736 if (rc) {
737 usleep(msg_req_delay * 1000);
738 continue;
739 }
Luka Perkovd131ad62012-05-27 11:44:51 +0000740 }
741
Stefan Roese84899e22014-10-22 12:13:21 +0200742 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
Luka Perkovd131ad62012-05-27 11:44:51 +0000743
744 kwboot_spinner();
745
746 } while (rc || c != NAK);
747
748 kwboot_printv("\n");
749
750 return rc;
751}
752
753static int
Stefan Roese84899e22014-10-22 12:13:21 +0200754kwboot_debugmsg(int tty, void *msg)
755{
756 int rc;
757
758 kwboot_printv("Sending debug message. Please reboot the target...");
759
760 do {
761 char buf[16];
762
763 rc = tcflush(tty, TCIOFLUSH);
764 if (rc)
765 break;
766
Pali Rohárcab817d2021-10-27 20:56:59 +0200767 rc = kwboot_tty_send(tty, msg, 8, 0);
Stefan Roese84899e22014-10-22 12:13:21 +0200768 if (rc) {
769 usleep(msg_req_delay * 1000);
770 continue;
771 }
772
773 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
774
775 kwboot_spinner();
776
777 } while (rc);
778
779 kwboot_printv("\n");
780
781 return rc;
782}
783
Pali Rohárc5d666a2021-09-24 23:06:44 +0200784static size_t
Luka Perkovd131ad62012-05-27 11:44:51 +0000785kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
786 size_t size, int pnum)
787{
Marek Behúnd8cc8512021-09-24 23:06:45 +0200788 size_t i, n;
Luka Perkovd131ad62012-05-27 11:44:51 +0000789
Stefan Roese84899e22014-10-22 12:13:21 +0200790 block->soh = SOH;
Luka Perkovd131ad62012-05-27 11:44:51 +0000791 block->pnum = pnum;
792 block->_pnum = ~block->pnum;
793
Pali Rohár2ef87f72021-09-24 23:06:48 +0200794 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
Luka Perkovd131ad62012-05-27 11:44:51 +0000795 memcpy(&block->data[0], data, n);
Pali Rohár2ef87f72021-09-24 23:06:48 +0200796 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
Luka Perkovd131ad62012-05-27 11:44:51 +0000797
798 block->csum = 0;
799 for (i = 0; i < n; i++)
800 block->csum += block->data[i];
801
802 return n;
803}
804
Marek Behún12df7b72021-09-24 23:06:52 +0200805static uint64_t
806_now(void)
807{
808 struct timespec ts;
809
810 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
811 static int err_print;
812
813 if (!err_print) {
814 perror("clock_gettime() does not work");
815 err_print = 1;
816 }
817
818 /* this will just make the timeout not work */
819 return -1ULL;
820 }
821
822 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
823}
824
Luka Perkovd131ad62012-05-27 11:44:51 +0000825static int
Marek Behún408ea612021-09-24 23:06:49 +0200826_is_xm_reply(char c)
827{
Pali Rohár94c906a2022-01-25 18:13:03 +0100828 return c == ACK || c == NAK;
Marek Behún408ea612021-09-24 23:06:49 +0200829}
830
831static int
Pali Rohár9cdc2642021-09-24 23:06:54 +0200832_xm_reply_to_error(int c)
833{
834 int rc = -1;
835
836 switch (c) {
837 case ACK:
838 rc = 0;
839 break;
840 case NAK:
841 errno = EBADMSG;
842 break;
Pali Rohár9cdc2642021-09-24 23:06:54 +0200843 default:
844 errno = EPROTO;
845 break;
846 }
847
848 return rc;
849}
850
851static int
Pali Rohárca272042021-09-24 23:07:05 +0200852kwboot_baud_magic_handle(int fd, char c, int baudrate)
853{
854 static size_t rcv_len;
855
856 if (rcv_len < sizeof(kwb_baud_magic)) {
857 /* try to recognize whole magic word */
858 if (c == kwb_baud_magic[rcv_len]) {
859 rcv_len++;
860 } else {
861 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
862 fflush(stdout);
863 rcv_len = 0;
864 }
865 }
866
867 if (rcv_len == sizeof(kwb_baud_magic)) {
868 /* magic word received */
869 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
870
871 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
872 } else {
873 return 0;
874 }
875}
876
877static int
Pali Rohár950ed242022-01-25 18:13:04 +0100878kwboot_xm_recv_reply(int fd, char *c, int stop_on_non_xm,
Pali Rohár82a9e132022-01-25 18:13:02 +0100879 int ignore_nak_reply,
Pali Rohára6fcac22021-10-25 15:13:04 +0200880 int allow_non_xm, int *non_xm_print,
Pali Rohárca272042021-09-24 23:07:05 +0200881 int baudrate, int *baud_changed)
Pali Rohár48b3ea62021-09-24 23:06:50 +0200882{
Marek Behún12df7b72021-09-24 23:06:52 +0200883 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
Marek Behún819cd322021-09-24 23:06:53 +0200884 uint64_t recv_until = _now() + timeout;
Pali Rohár48b3ea62021-09-24 23:06:50 +0200885 int rc;
886
887 while (1) {
Marek Behún12df7b72021-09-24 23:06:52 +0200888 rc = kwboot_tty_recv(fd, c, 1, timeout);
Pali Rohár48b3ea62021-09-24 23:06:50 +0200889 if (rc) {
890 if (errno != ETIMEDOUT)
891 return rc;
Marek Behún819cd322021-09-24 23:06:53 +0200892 else if (allow_non_xm && *non_xm_print)
Marek Behún12df7b72021-09-24 23:06:52 +0200893 return -1;
894 else
895 *c = NAK;
Pali Rohár48b3ea62021-09-24 23:06:50 +0200896 }
897
898 /* If received xmodem reply, end. */
Pali Rohár82a9e132022-01-25 18:13:02 +0100899 if (_is_xm_reply(*c)) {
900 if (*c == NAK && ignore_nak_reply) {
901 timeout = recv_until - _now();
902 if (timeout >= 0)
903 continue;
904 }
Pali Rohár48b3ea62021-09-24 23:06:50 +0200905 break;
Pali Rohár82a9e132022-01-25 18:13:02 +0100906 }
Pali Rohár48b3ea62021-09-24 23:06:50 +0200907
908 /*
Pali Rohárca272042021-09-24 23:07:05 +0200909 * If receiving/printing non-xmodem text output is allowed and
910 * such a byte was received, we want to increase receiving time
911 * and either:
912 * - print the byte, if it is not part of baudrate change magic
913 * sequence while baudrate change was requested (-B option)
914 * - change baudrate
Marek Behún819cd322021-09-24 23:06:53 +0200915 * Otherwise decrease timeout by time elapsed.
Pali Rohár48b3ea62021-09-24 23:06:50 +0200916 */
917 if (allow_non_xm) {
Marek Behún12df7b72021-09-24 23:06:52 +0200918 recv_until = _now() + timeout;
Pali Rohárca272042021-09-24 23:07:05 +0200919
920 if (baudrate && !*baud_changed) {
921 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
922 if (rc == 1)
923 *baud_changed = 1;
924 else if (!rc)
925 *non_xm_print = 1;
926 else
927 return rc;
928 } else if (!baudrate || !*baud_changed) {
929 putchar(*c);
930 fflush(stdout);
931 *non_xm_print = 1;
932 }
Marek Behún819cd322021-09-24 23:06:53 +0200933 } else {
Pali Rohár950ed242022-01-25 18:13:04 +0100934 if (stop_on_non_xm)
Pali Rohára6fcac22021-10-25 15:13:04 +0200935 break;
Marek Behún819cd322021-09-24 23:06:53 +0200936 timeout = recv_until - _now();
937 if (timeout < 0) {
938 errno = ETIMEDOUT;
939 return -1;
940 }
Pali Rohár48b3ea62021-09-24 23:06:50 +0200941 }
942 }
943
944 return 0;
945}
946
947static int
948kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
Pali Rohár5875ad42022-01-25 18:13:05 +0100949 int *done_print, int baudrate, int allow_retries)
Luka Perkovd131ad62012-05-27 11:44:51 +0000950{
Pali Rohárca272042021-09-24 23:07:05 +0200951 int non_xm_print, baud_changed;
952 int rc, err, retries;
Luka Perkovd131ad62012-05-27 11:44:51 +0000953 char c;
954
Pali Rohár48b3ea62021-09-24 23:06:50 +0200955 *done_print = 0;
Pali Rohár455c0d22021-10-27 20:56:58 +0200956 non_xm_print = 0;
957 baud_changed = 0;
Pali Rohár48b3ea62021-09-24 23:06:50 +0200958
Pali Rohárd14a3422021-10-25 15:13:03 +0200959 retries = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +0000960 do {
Pali Rohárcab817d2021-10-27 20:56:59 +0200961 rc = kwboot_tty_send(fd, block, sizeof(*block), 1);
Luka Perkovd131ad62012-05-27 11:44:51 +0000962 if (rc)
Pali Rohár94c906a2022-01-25 18:13:03 +0100963 goto err;
Luka Perkovd131ad62012-05-27 11:44:51 +0000964
Pali Rohár48b3ea62021-09-24 23:06:50 +0200965 if (allow_non_xm && !*done_print) {
966 kwboot_progress(100, '.');
967 kwboot_printv("Done\n");
968 *done_print = 1;
969 }
Stefan Roese84899e22014-10-22 12:13:21 +0200970
Pali Rohára6fcac22021-10-25 15:13:04 +0200971 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Rohár82a9e132022-01-25 18:13:02 +0100972 retries > 8,
Pali Rohára6fcac22021-10-25 15:13:04 +0200973 allow_non_xm, &non_xm_print,
Pali Rohárca272042021-09-24 23:07:05 +0200974 baudrate, &baud_changed);
Pali Rohár48b3ea62021-09-24 23:06:50 +0200975 if (rc)
Pali Rohár94c906a2022-01-25 18:13:03 +0100976 goto err;
Stefan Roese84899e22014-10-22 12:13:21 +0200977
Pali Rohár48b3ea62021-09-24 23:06:50 +0200978 if (!allow_non_xm && c != ACK)
Luka Perkovd131ad62012-05-27 11:44:51 +0000979 kwboot_progress(-1, '+');
Pali Rohár5875ad42022-01-25 18:13:05 +0100980 } while (c == NAK && allow_retries && retries++ < 16);
Luka Perkovd131ad62012-05-27 11:44:51 +0000981
Marek Behún2e81b3a2021-09-24 23:06:51 +0200982 if (non_xm_print)
983 kwboot_printv("\n");
984
Pali Rohárca272042021-09-24 23:07:05 +0200985 if (allow_non_xm && baudrate && !baud_changed) {
986 fprintf(stderr, "Baudrate was not changed\n");
Pali Rohárca272042021-09-24 23:07:05 +0200987 errno = EPROTO;
Pali Rohár94c906a2022-01-25 18:13:03 +0100988 return -1;
Pali Rohárca272042021-09-24 23:07:05 +0200989 }
990
Pali Rohár9cdc2642021-09-24 23:06:54 +0200991 return _xm_reply_to_error(c);
Pali Rohár94c906a2022-01-25 18:13:03 +0100992err:
Pali Rohárca272042021-09-24 23:07:05 +0200993 err = errno;
Pali Rohárca272042021-09-24 23:07:05 +0200994 kwboot_printv("\n");
995 errno = err;
996 return rc;
Pali Rohár9cdc2642021-09-24 23:06:54 +0200997}
Luka Perkovd131ad62012-05-27 11:44:51 +0000998
Pali Rohár9cdc2642021-09-24 23:06:54 +0200999static int
1000kwboot_xm_finish(int fd)
1001{
1002 int rc, retries;
1003 char c;
Luka Perkovd131ad62012-05-27 11:44:51 +00001004
Pali Rohár9cdc2642021-09-24 23:06:54 +02001005 kwboot_printv("Finishing transfer\n");
1006
Pali Rohárd14a3422021-10-25 15:13:03 +02001007 retries = 0;
Pali Rohár9cdc2642021-09-24 23:06:54 +02001008 do {
1009 rc = kwboot_tty_send_char(fd, EOT);
1010 if (rc)
1011 return rc;
1012
Pali Rohára6fcac22021-10-25 15:13:04 +02001013 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Rohár82a9e132022-01-25 18:13:02 +01001014 retries > 8,
Pali Rohára6fcac22021-10-25 15:13:04 +02001015 0, NULL, 0, NULL);
Pali Rohár9cdc2642021-09-24 23:06:54 +02001016 if (rc)
1017 return rc;
Pali Rohárd14a3422021-10-25 15:13:03 +02001018 } while (c == NAK && retries++ < 16);
Pali Rohár9cdc2642021-09-24 23:06:54 +02001019
1020 return _xm_reply_to_error(c);
Luka Perkovd131ad62012-05-27 11:44:51 +00001021}
1022
1023static int
Pali Rohár2ef87f72021-09-24 23:06:48 +02001024kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
Pali Rohárca272042021-09-24 23:07:05 +02001025 size_t size, int baudrate)
Luka Perkovd131ad62012-05-27 11:44:51 +00001026{
Pali Rohár48b3ea62021-09-24 23:06:50 +02001027 int done_print = 0;
Pali Rohár2ef87f72021-09-24 23:06:48 +02001028 size_t sent, left;
1029 int rc;
Luka Perkovd131ad62012-05-27 11:44:51 +00001030
Pali Rohár2ef87f72021-09-24 23:06:48 +02001031 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
1032 header ? "header" : "data", size);
Luka Perkovd131ad62012-05-27 11:44:51 +00001033
Pali Rohár2ef87f72021-09-24 23:06:48 +02001034 left = size;
1035 sent = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001036
Pali Rohár2ef87f72021-09-24 23:06:48 +02001037 while (sent < size) {
Luka Perkovd131ad62012-05-27 11:44:51 +00001038 struct kwboot_block block;
Pali Rohár48b3ea62021-09-24 23:06:50 +02001039 int last_block;
Pali Rohár2ef87f72021-09-24 23:06:48 +02001040 size_t blksz;
Luka Perkovd131ad62012-05-27 11:44:51 +00001041
Pali Rohár2ef87f72021-09-24 23:06:48 +02001042 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1043 data += blksz;
Luka Perkovd131ad62012-05-27 11:44:51 +00001044
Pali Rohár48b3ea62021-09-24 23:06:50 +02001045 last_block = (left <= blksz);
1046
Pali Rohár5875ad42022-01-25 18:13:05 +01001047 /*
1048 * Handling of repeated xmodem packets is completely broken in
1049 * Armada 385 BootROM - it completely ignores xmodem packet
1050 * numbers, they are only used for checksum verification.
1051 * BootROM can handle a retry of the xmodem packet only during
1052 * the transmission of kwbimage header and only if BootROM
1053 * itself sent NAK response to previous attempt (it does it on
1054 * checksum failure). During the transmission of kwbimage data
1055 * part, BootROM always expects next xmodem packet, even if it
1056 * sent NAK to previous attempt - there is absolutely no way to
1057 * repair incorrectly transmitted xmodem packet during kwbimage
1058 * data part upload. Also, if kwboot receives non-ACK/NAK
1059 * response (meaning that original BootROM response was damaged
1060 * on UART) there is no way to detect if BootROM accepted xmodem
1061 * packet or not and no way to check if kwboot could repeat the
1062 * packet or not.
1063 *
1064 * Stop transfer and return failure if kwboot receives unknown
1065 * reply if non-xmodem reply is not allowed (for all xmodem
1066 * packets except the last header packet) or when non-ACK reply
1067 * is received during data part transfer.
1068 */
Pali Rohár48b3ea62021-09-24 23:06:50 +02001069 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
Pali Rohár5875ad42022-01-25 18:13:05 +01001070 &done_print, baudrate, header);
Luka Perkovd131ad62012-05-27 11:44:51 +00001071 if (rc)
1072 goto out;
1073
Pali Rohár2ef87f72021-09-24 23:06:48 +02001074 sent += blksz;
1075 left -= blksz;
Luka Perkovd131ad62012-05-27 11:44:51 +00001076
Pali Rohár48b3ea62021-09-24 23:06:50 +02001077 if (!done_print)
1078 kwboot_progress(sent * 100 / size, '.');
Pali Rohár2ef87f72021-09-24 23:06:48 +02001079 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001080
Pali Rohár48b3ea62021-09-24 23:06:50 +02001081 if (!done_print)
1082 kwboot_printv("Done\n");
Pali Rohár2ef87f72021-09-24 23:06:48 +02001083
1084 return 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001085out:
Pali Rohárd5ba8db2021-09-24 23:06:47 +02001086 kwboot_printv("\n");
Luka Perkovd131ad62012-05-27 11:44:51 +00001087 return rc;
Pali Rohár2ef87f72021-09-24 23:06:48 +02001088}
Luka Perkovd131ad62012-05-27 11:44:51 +00001089
Pali Rohár2ef87f72021-09-24 23:06:48 +02001090static int
Pali Rohárca272042021-09-24 23:07:05 +02001091kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
Pali Rohár2ef87f72021-09-24 23:06:48 +02001092{
1093 const uint8_t *img = _img;
1094 int rc, pnum;
1095 size_t hdrsz;
1096
Marek Behúnfe2fd732021-09-24 23:07:01 +02001097 hdrsz = kwbheader_size(img);
Pali Rohár2ef87f72021-09-24 23:06:48 +02001098
Pali Rohárf8017c32021-11-05 23:29:58 +01001099 /*
1100 * If header size is not aligned to xmodem block size (which applies
1101 * for all images in kwbimage v0 format) then we have to ensure that
1102 * the last xmodem block of header contains beginning of the data
1103 * followed by the header. So align header size to xmodem block size.
1104 */
1105 hdrsz += (KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ) % KWBOOT_XM_BLKSZ;
1106
Pali Rohár8bd15fd2022-01-25 18:13:01 +01001107 kwboot_printv("Waiting %d ms and flushing tty\n", blk_rsp_timeo);
1108 usleep(blk_rsp_timeo * 1000);
Pali Rohár2ef87f72021-09-24 23:06:48 +02001109 tcflush(tty, TCIOFLUSH);
1110
1111 pnum = 1;
1112
Pali Rohárca272042021-09-24 23:07:05 +02001113 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
Pali Rohár2ef87f72021-09-24 23:06:48 +02001114 if (rc)
1115 return rc;
1116
Pali Rohárf8017c32021-11-05 23:29:58 +01001117 /*
1118 * If we have already sent image data as a part of the last
1119 * xmodem header block then we have nothing more to send.
1120 */
1121 if (hdrsz < size) {
1122 img += hdrsz;
1123 size -= hdrsz;
1124 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1125 if (rc)
1126 return rc;
1127 }
Pali Rohár2ef87f72021-09-24 23:06:48 +02001128
Pali Rohárca272042021-09-24 23:07:05 +02001129 rc = kwboot_xm_finish(tty);
1130 if (rc)
1131 return rc;
1132
1133 if (baudrate) {
Pali Rohárca272042021-09-24 23:07:05 +02001134 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1135 rc = kwboot_tty_change_baudrate(tty, 115200);
1136 if (rc)
1137 return rc;
1138 }
1139
1140 return 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001141}
1142
1143static int
Marek Behún46237e62021-09-24 23:06:40 +02001144kwboot_term_pipe(int in, int out, const char *quit, int *s)
Luka Perkovd131ad62012-05-27 11:44:51 +00001145{
Marek Behúne453bb42021-09-24 23:06:41 +02001146 ssize_t nin;
Luka Perkovd131ad62012-05-27 11:44:51 +00001147 char _buf[128], *buf = _buf;
1148
Pali Rohár43fef8d2021-07-23 11:14:17 +02001149 nin = read(in, buf, sizeof(_buf));
Willy Tarreau4469bd72018-07-03 12:10:31 -04001150 if (nin <= 0)
Luka Perkovd131ad62012-05-27 11:44:51 +00001151 return -1;
1152
1153 if (quit) {
1154 int i;
1155
1156 for (i = 0; i < nin; i++) {
1157 if (*buf == quit[*s]) {
1158 (*s)++;
1159 if (!quit[*s])
1160 return 0;
1161 buf++;
1162 nin--;
Pali Rohárb943eee2021-07-23 11:14:20 +02001163 } else {
Marek Behúne453bb42021-09-24 23:06:41 +02001164 if (kwboot_write(out, quit, *s) < 0)
1165 return -1;
1166 *s = 0;
Pali Rohárb943eee2021-07-23 11:14:20 +02001167 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001168 }
1169 }
1170
Marek Behúne453bb42021-09-24 23:06:41 +02001171 if (kwboot_write(out, buf, nin) < 0)
1172 return -1;
Luka Perkovd131ad62012-05-27 11:44:51 +00001173
1174 return 0;
1175}
1176
1177static int
1178kwboot_terminal(int tty)
1179{
1180 int rc, in, s;
Marek Behún46237e62021-09-24 23:06:40 +02001181 const char *quit = "\34c";
Luka Perkovd131ad62012-05-27 11:44:51 +00001182 struct termios otio, tio;
1183
1184 rc = -1;
1185
1186 in = STDIN_FILENO;
1187 if (isatty(in)) {
1188 rc = tcgetattr(in, &otio);
1189 if (!rc) {
1190 tio = otio;
1191 cfmakeraw(&tio);
1192 rc = tcsetattr(in, TCSANOW, &tio);
1193 }
1194 if (rc) {
1195 perror("tcsetattr");
1196 goto out;
1197 }
1198
1199 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
Marek Behún5fa04f42021-09-24 23:07:11 +02001200 quit[0] | 0100, quit[1]);
Luka Perkovd131ad62012-05-27 11:44:51 +00001201 } else
1202 in = -1;
1203
1204 rc = 0;
1205 s = 0;
1206
1207 do {
1208 fd_set rfds;
1209 int nfds = 0;
1210
Pali Rohár0a143412021-10-25 15:12:52 +02001211 FD_ZERO(&rfds);
Luka Perkovd131ad62012-05-27 11:44:51 +00001212 FD_SET(tty, &rfds);
1213 nfds = nfds < tty ? tty : nfds;
1214
1215 if (in >= 0) {
1216 FD_SET(in, &rfds);
1217 nfds = nfds < in ? in : nfds;
1218 }
1219
1220 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1221 if (nfds < 0)
1222 break;
1223
1224 if (FD_ISSET(tty, &rfds)) {
1225 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1226 if (rc)
1227 break;
1228 }
1229
Marek Behúnf30cb0d2021-09-24 23:06:39 +02001230 if (in >= 0 && FD_ISSET(in, &rfds)) {
Luka Perkovd131ad62012-05-27 11:44:51 +00001231 rc = kwboot_term_pipe(in, tty, quit, &s);
1232 if (rc)
1233 break;
1234 }
1235 } while (quit[s] != 0);
1236
Pali Rohárec0fe5b2021-07-23 11:14:18 +02001237 if (in >= 0)
1238 tcsetattr(in, TCSANOW, &otio);
Pali Rohár49a0a3b2021-07-23 11:14:19 +02001239 printf("\n");
Luka Perkovd131ad62012-05-27 11:44:51 +00001240out:
1241 return rc;
1242}
1243
1244static void *
Pali Rohár04ced022021-09-24 23:07:03 +02001245kwboot_read_image(const char *path, size_t *size, size_t reserve)
Luka Perkovd131ad62012-05-27 11:44:51 +00001246{
Pali Rohárddc04fa2021-09-24 23:06:55 +02001247 int rc, fd;
Luka Perkovd131ad62012-05-27 11:44:51 +00001248 struct stat st;
1249 void *img;
Pali Rohár04ced022021-09-24 23:07:03 +02001250 off_t tot;
Luka Perkovd131ad62012-05-27 11:44:51 +00001251
1252 rc = -1;
Luka Perkovd131ad62012-05-27 11:44:51 +00001253 img = NULL;
1254
1255 fd = open(path, O_RDONLY);
1256 if (fd < 0)
1257 goto out;
1258
1259 rc = fstat(fd, &st);
1260 if (rc)
1261 goto out;
1262
Pali Rohár04ced022021-09-24 23:07:03 +02001263 img = malloc(st.st_size + reserve);
1264 if (!img)
Luka Perkovd131ad62012-05-27 11:44:51 +00001265 goto out;
Pali Rohár04ced022021-09-24 23:07:03 +02001266
1267 tot = 0;
1268 while (tot < st.st_size) {
1269 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1270
1271 if (rd < 0)
1272 goto out;
1273
1274 tot += rd;
1275
1276 if (!rd && tot < st.st_size) {
1277 errno = EIO;
1278 goto out;
1279 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001280 }
1281
1282 rc = 0;
1283 *size = st.st_size;
1284out:
1285 if (rc && img) {
Pali Rohár04ced022021-09-24 23:07:03 +02001286 free(img);
Luka Perkovd131ad62012-05-27 11:44:51 +00001287 img = NULL;
1288 }
1289 if (fd >= 0)
1290 close(fd);
1291
1292 return img;
1293}
1294
1295static uint8_t
Marek Behúnfe2fd732021-09-24 23:07:01 +02001296kwboot_hdr_csum8(const void *hdr)
Luka Perkovd131ad62012-05-27 11:44:51 +00001297{
Marek Behúnfe2fd732021-09-24 23:07:01 +02001298 const uint8_t *data = hdr;
1299 uint8_t csum;
1300 size_t size;
1301
1302 size = kwbheader_size_for_csum(hdr);
Luka Perkovd131ad62012-05-27 11:44:51 +00001303
1304 for (csum = 0; size-- > 0; data++)
1305 csum += *data;
1306
1307 return csum;
1308}
1309
Pali Rohárad9a3ac2021-10-25 15:12:55 +02001310static uint32_t *
1311kwboot_img_csum32_ptr(void *img)
1312{
1313 struct main_hdr_v1 *hdr = img;
1314 uint32_t datasz;
1315
1316 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1317
1318 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1319}
1320
1321static uint32_t
1322kwboot_img_csum32(const void *img)
1323{
1324 const struct main_hdr_v1 *hdr = img;
1325 uint32_t datasz, csum = 0;
1326 const uint32_t *data;
1327
1328 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1329 if (datasz % sizeof(uint32_t))
1330 return 0;
1331
1332 data = img + le32_to_cpu(hdr->srcaddr);
1333 while (datasz > 0) {
1334 csum += le32_to_cpu(*data++);
1335 datasz -= 4;
1336 }
1337
1338 return cpu_to_le32(csum);
1339}
1340
Luka Perkovd131ad62012-05-27 11:44:51 +00001341static int
Pali Rohár550c9302021-09-24 23:06:57 +02001342kwboot_img_is_secure(void *img)
1343{
1344 struct opt_hdr_v1 *ohdr;
1345
1346 for_each_opt_hdr_v1 (ohdr, img)
1347 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1348 return 1;
1349
1350 return 0;
1351}
1352
Pali Rohárca272042021-09-24 23:07:05 +02001353static void *
Pali Rohár063cb352021-10-25 15:12:56 +02001354kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
Pali Rohárca272042021-09-24 23:07:05 +02001355{
Pali Rohárca272042021-09-24 23:07:05 +02001356 struct main_hdr_v1 *hdr = img;
Pali Rohár063cb352021-10-25 15:12:56 +02001357 void *result;
Pali Rohárca272042021-09-24 23:07:05 +02001358
Pali Rohár063cb352021-10-25 15:12:56 +02001359 /*
1360 * 32-bit checksum comes after end of image code, so we will be putting
1361 * new code there. So we get this pointer and then increase data size
1362 * (since increasing data size changes kwboot_img_csum32_ptr() return
1363 * value).
1364 */
1365 result = kwboot_img_csum32_ptr(img);
Pali Rohárca272042021-09-24 23:07:05 +02001366 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
Pali Rohár063cb352021-10-25 15:12:56 +02001367 *size += grow;
Pali Rohárca272042021-09-24 23:07:05 +02001368
Pali Rohár063cb352021-10-25 15:12:56 +02001369 return result;
Pali Rohárca272042021-09-24 23:07:05 +02001370}
1371
Pali Rohár04ced022021-09-24 23:07:03 +02001372static void
1373kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1374{
1375 uint32_t hdrsz, datasz, srcaddr;
1376 struct main_hdr_v1 *hdr = img;
Pali Rohárd656f5a2021-10-25 15:13:02 +02001377 struct opt_hdr_v1 *ohdr;
Pali Rohár04ced022021-09-24 23:07:03 +02001378 uint8_t *data;
1379
1380 srcaddr = le32_to_cpu(hdr->srcaddr);
1381
Pali Rohárd656f5a2021-10-25 15:13:02 +02001382 /* calculate real used space in kwbimage header */
1383 if (kwbimage_version(img) == 0) {
1384 hdrsz = kwbheader_size(img);
1385 } else {
1386 hdrsz = sizeof(*hdr);
1387 for_each_opt_hdr_v1 (ohdr, hdr)
1388 hdrsz += opt_hdr_v1_size(ohdr);
1389 }
1390
Pali Rohár04ced022021-09-24 23:07:03 +02001391 data = (uint8_t *)img + srcaddr;
1392 datasz = *size - srcaddr;
1393
1394 /* only move data if there is not enough space */
1395 if (hdrsz + grow > srcaddr) {
1396 size_t need = hdrsz + grow - srcaddr;
1397
1398 /* move data by enough bytes */
1399 memmove(data + need, data, datasz);
1400
1401 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1402 *size += need;
1403 }
1404
1405 if (kwbimage_version(img) == 1) {
1406 hdrsz += grow;
Pali Rohárd656f5a2021-10-25 15:13:02 +02001407 if (hdrsz > kwbheader_size(img)) {
1408 hdr->headersz_msb = hdrsz >> 16;
1409 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1410 }
Pali Rohár04ced022021-09-24 23:07:03 +02001411 }
1412}
1413
Pali Rohárca272042021-09-24 23:07:05 +02001414static void *
1415kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1416{
1417 struct main_hdr_v1 *hdr = img;
1418 struct opt_hdr_v1 *ohdr;
Pali Rohára85a71d2021-10-21 16:46:06 +02001419 uint32_t num_args;
1420 uint32_t offset;
Pali Rohárca272042021-09-24 23:07:05 +02001421 uint32_t ohdrsz;
Pali Roháre511cc32021-10-25 15:13:01 +02001422 uint8_t *prev_ext;
Pali Rohárca272042021-09-24 23:07:05 +02001423
Pali Rohár44691032022-01-12 18:20:52 +01001424 if (hdr->ext) {
Pali Rohárca272042021-09-24 23:07:05 +02001425 for_each_opt_hdr_v1 (ohdr, img)
1426 if (opt_hdr_v1_next(ohdr) == NULL)
1427 break;
1428
Pali Roháre511cc32021-10-25 15:13:01 +02001429 prev_ext = opt_hdr_v1_ext(ohdr);
1430 ohdr = _opt_hdr_v1_next(ohdr);
Pali Rohárca272042021-09-24 23:07:05 +02001431 } else {
Pali Rohárca272042021-09-24 23:07:05 +02001432 ohdr = (void *)(hdr + 1);
Pali Roháre511cc32021-10-25 15:13:01 +02001433 prev_ext = &hdr->ext;
Pali Rohárca272042021-09-24 23:07:05 +02001434 }
1435
Pali Rohára85a71d2021-10-21 16:46:06 +02001436 /*
1437 * ARM executable code inside the BIN header on some mvebu platforms
1438 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1439 * This requirement can be met by inserting dummy arguments into
1440 * BIN header, if needed.
1441 */
1442 offset = &ohdr->data[4] - (char *)img;
1443 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1444
1445 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1446 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1447
Pali Rohár44691032022-01-12 18:20:52 +01001448 *prev_ext = 1;
Pali Roháre511cc32021-10-25 15:13:01 +02001449
Pali Rohárca272042021-09-24 23:07:05 +02001450 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1451 ohdr->headersz_msb = ohdrsz >> 16;
1452 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1453
1454 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
Pali Rohára85a71d2021-10-21 16:46:06 +02001455 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
Pali Rohárca272042021-09-24 23:07:05 +02001456
Pali Rohára85a71d2021-10-21 16:46:06 +02001457 return &ohdr->data[4 + 4 * num_args];
Pali Rohárca272042021-09-24 23:07:05 +02001458}
1459
1460static void
Pali Rohár8dbe0272021-10-27 20:57:02 +02001461_inject_baudrate_change_code(void *img, size_t *size, int for_data,
Pali Rohár063cb352021-10-25 15:12:56 +02001462 int old_baud, int new_baud)
Pali Rohárca272042021-09-24 23:07:05 +02001463{
Pali Rohár063cb352021-10-25 15:12:56 +02001464 struct main_hdr_v1 *hdr = img;
Pali Rohár8dbe0272021-10-27 20:57:02 +02001465 uint32_t orig_datasz;
1466 uint32_t codesz;
Pali Rohár063cb352021-10-25 15:12:56 +02001467 uint8_t *code;
Pali Rohárca272042021-09-24 23:07:05 +02001468
Pali Rohár8dbe0272021-10-27 20:57:02 +02001469 if (for_data) {
Pali Rohár063cb352021-10-25 15:12:56 +02001470 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1471
Pali Rohár8dbe0272021-10-27 20:57:02 +02001472 codesz = sizeof(kwboot_baud_code) +
1473 sizeof(kwboot_baud_code_data_jump);
1474 code = kwboot_img_grow_data_right(img, size, codesz);
Pali Rohár063cb352021-10-25 15:12:56 +02001475 } else {
Pali Rohár8dbe0272021-10-27 20:57:02 +02001476 codesz = sizeof(kwboot_baud_code_binhdr_pre) +
1477 sizeof(kwboot_baud_code) +
1478 sizeof(kwboot_baud_code_binhdr_post);
Pali Rohár063cb352021-10-25 15:12:56 +02001479 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
Pali Rohár8dbe0272021-10-27 20:57:02 +02001480
1481 codesz = sizeof(kwboot_baud_code_binhdr_pre);
1482 memcpy(code, kwboot_baud_code_binhdr_pre, codesz);
1483 code += codesz;
Pali Rohárca272042021-09-24 23:07:05 +02001484 }
1485
Pali Rohár8dbe0272021-10-27 20:57:02 +02001486 codesz = sizeof(kwboot_baud_code) - 2 * sizeof(uint32_t);
1487 memcpy(code, kwboot_baud_code, codesz);
1488 code += codesz;
1489 *(uint32_t *)code = cpu_to_le32(old_baud);
1490 code += sizeof(uint32_t);
1491 *(uint32_t *)code = cpu_to_le32(new_baud);
1492 code += sizeof(uint32_t);
1493
1494 if (for_data) {
1495 codesz = sizeof(kwboot_baud_code_data_jump) - sizeof(uint32_t);
1496 memcpy(code, kwboot_baud_code_data_jump, codesz);
1497 code += codesz;
1498 *(uint32_t *)code = hdr->execaddr;
1499 code += sizeof(uint32_t);
1500 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) + orig_datasz);
1501 } else {
1502 codesz = sizeof(kwboot_baud_code_binhdr_post);
1503 memcpy(code, kwboot_baud_code_binhdr_post, codesz);
1504 code += codesz;
1505 }
Pali Rohárca272042021-09-24 23:07:05 +02001506}
1507
Pali Rohár550c9302021-09-24 23:06:57 +02001508static int
Pali Rohárca272042021-09-24 23:07:05 +02001509kwboot_img_patch(void *img, size_t *size, int baudrate)
Luka Perkovd131ad62012-05-27 11:44:51 +00001510{
Stefan Roesee29f1db2015-09-29 09:19:59 +02001511 struct main_hdr_v1 *hdr;
Pali Rohár792e4232021-09-24 23:06:58 +02001512 uint32_t srcaddr;
Luka Perkovd131ad62012-05-27 11:44:51 +00001513 uint8_t csum;
Marek Behún5c8f8122021-09-24 23:07:04 +02001514 size_t hdrsz;
Stefan Roesee29f1db2015-09-29 09:19:59 +02001515 int image_ver;
Pali Rohár550c9302021-09-24 23:06:57 +02001516 int is_secure;
Luka Perkovd131ad62012-05-27 11:44:51 +00001517
Luka Perkovd131ad62012-05-27 11:44:51 +00001518 hdr = img;
1519
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001520 if (*size < sizeof(struct main_hdr_v1))
1521 goto err;
Luka Perkovd131ad62012-05-27 11:44:51 +00001522
Marek Behúnacb0b382021-09-24 23:07:00 +02001523 image_ver = kwbimage_version(img);
Pali Rohár5029d7b2021-07-23 11:14:22 +02001524 if (image_ver != 0 && image_ver != 1) {
Stefan Roesee29f1db2015-09-29 09:19:59 +02001525 fprintf(stderr, "Invalid image header version\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001526 goto err;
Stefan Roesee29f1db2015-09-29 09:19:59 +02001527 }
1528
Marek Behúnfe2fd732021-09-24 23:07:01 +02001529 hdrsz = kwbheader_size(hdr);
Stefan Roesee29f1db2015-09-29 09:19:59 +02001530
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001531 if (*size < hdrsz)
1532 goto err;
Pali Rohár825a2ca2021-07-23 11:14:21 +02001533
Marek Behúnfe2fd732021-09-24 23:07:01 +02001534 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001535 if (csum != hdr->checksum)
1536 goto err;
Luka Perkovd131ad62012-05-27 11:44:51 +00001537
Pali Rohár792e4232021-09-24 23:06:58 +02001538 srcaddr = le32_to_cpu(hdr->srcaddr);
1539
1540 switch (hdr->blockid) {
1541 case IBR_HDR_SATA_ID:
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001542 if (srcaddr < 1)
1543 goto err;
1544
Pali Rohár792e4232021-09-24 23:06:58 +02001545 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1546 break;
1547
1548 case IBR_HDR_SDIO_ID:
1549 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1550 break;
1551
1552 case IBR_HDR_PEX_ID:
1553 if (srcaddr == 0xFFFFFFFF)
1554 hdr->srcaddr = cpu_to_le32(hdrsz);
1555 break;
Pali Rohárf2c644e2021-09-24 23:06:59 +02001556
1557 case IBR_HDR_SPI_ID:
1558 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1559 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1560 hdr->destaddr = cpu_to_le32(0x00800000);
1561 hdr->execaddr = cpu_to_le32(0x00800000);
1562 }
1563 break;
Pali Rohár792e4232021-09-24 23:06:58 +02001564 }
1565
Pali Rohár04ced022021-09-24 23:07:03 +02001566 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001567 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1568 goto err;
Pali Rohár04ced022021-09-24 23:07:03 +02001569
Pali Rohárad9a3ac2021-10-25 15:12:55 +02001570 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1571 goto err;
1572
Pali Rohár550c9302021-09-24 23:06:57 +02001573 is_secure = kwboot_img_is_secure(img);
Luka Perkovd131ad62012-05-27 11:44:51 +00001574
Pali Rohár550c9302021-09-24 23:06:57 +02001575 if (hdr->blockid != IBR_HDR_UART_ID) {
1576 if (is_secure) {
1577 fprintf(stderr,
1578 "Image has secure header with signature for non-UART booting\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001579 goto err;
Pali Rohár550c9302021-09-24 23:06:57 +02001580 }
1581
1582 kwboot_printv("Patching image boot signature to UART\n");
1583 hdr->blockid = IBR_HDR_UART_ID;
1584 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001585
Pali Rohár0089f612021-10-22 12:37:47 +02001586 if (!is_secure) {
Pali Rohár4bebab62021-10-25 15:12:58 +02001587 if (image_ver == 1) {
1588 /*
1589 * Tell BootROM to send BootROM messages to UART port
1590 * number 0 (used also for UART booting) with default
1591 * baudrate (which should be 115200) and do not touch
1592 * UART MPP configuration.
1593 */
1594 hdr->options &= ~0x1F;
1595 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1596 hdr->options |= 0 << 3;
1597 }
Pali Rohár0089f612021-10-22 12:37:47 +02001598 if (image_ver == 0)
1599 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1600 hdr->nandpagesize = 0;
1601 }
1602
Pali Rohárca272042021-09-24 23:07:05 +02001603 if (baudrate) {
Pali Rohárca272042021-09-24 23:07:05 +02001604 if (image_ver == 0) {
1605 fprintf(stderr,
1606 "Cannot inject code for changing baudrate into v0 image header\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001607 goto err;
Pali Rohárca272042021-09-24 23:07:05 +02001608 }
1609
1610 if (is_secure) {
1611 fprintf(stderr,
1612 "Cannot inject code for changing baudrate into image with secure header\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001613 goto err;
Pali Rohárca272042021-09-24 23:07:05 +02001614 }
1615
1616 /*
1617 * First inject code that changes the baudrate from the default
1618 * value of 115200 Bd to requested value. This code is inserted
1619 * as a new opt hdr, so it is executed by BootROM after the
1620 * header part is received.
1621 */
1622 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1623 baudrate);
Pali Rohár063cb352021-10-25 15:12:56 +02001624 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
Pali Rohárca272042021-09-24 23:07:05 +02001625
1626 /*
1627 * Now inject code that changes the baudrate back to 115200 Bd.
Pali Rohár063cb352021-10-25 15:12:56 +02001628 * This code is appended after the data part of the image, and
1629 * execaddr is changed so that it is executed before U-Boot
1630 * proper.
Pali Rohárca272042021-09-24 23:07:05 +02001631 */
1632 kwboot_printv("Injecting code for changing baudrate back\n");
Pali Rohár063cb352021-10-25 15:12:56 +02001633 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
Pali Rohárca272042021-09-24 23:07:05 +02001634
Pali Rohár82c5a0a2021-10-25 15:12:57 +02001635 /* Update the 32-bit data checksum */
1636 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1637
Pali Rohárca272042021-09-24 23:07:05 +02001638 /* recompute header size */
1639 hdrsz = kwbheader_size(hdr);
1640 }
1641
Pali Rohár04ced022021-09-24 23:07:03 +02001642 if (hdrsz % KWBOOT_XM_BLKSZ) {
Pali Roháred792c22021-10-25 15:13:00 +02001643 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
Pali Rohár04ced022021-09-24 23:07:03 +02001644
1645 if (is_secure) {
1646 fprintf(stderr, "Cannot align image with secure header\n");
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001647 goto err;
Pali Rohár04ced022021-09-24 23:07:03 +02001648 }
1649
1650 kwboot_printv("Aligning image header to Xmodem block size\n");
Pali Roháred792c22021-10-25 15:13:00 +02001651 kwboot_img_grow_hdr(img, size, grow);
Pali Rohár04ced022021-09-24 23:07:03 +02001652 }
1653
Marek Behúnfe2fd732021-09-24 23:07:01 +02001654 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
Luka Perkovd131ad62012-05-27 11:44:51 +00001655
Pali Rohár04ced022021-09-24 23:07:03 +02001656 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
Marek Behúnb4eea8f2021-09-24 23:07:12 +02001657 return 0;
1658err:
1659 errno = EINVAL;
1660 return -1;
Luka Perkovd131ad62012-05-27 11:44:51 +00001661}
1662
1663static void
1664kwboot_usage(FILE *stream, char *progname)
1665{
1666 fprintf(stream,
Kevin Smith8669dac2016-02-16 21:28:17 +00001667 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
Stefan Roese84899e22014-10-22 12:13:21 +02001668 progname);
Luka Perkovd131ad62012-05-27 11:44:51 +00001669 fprintf(stream, "\n");
Stefan Roese84899e22014-10-22 12:13:21 +02001670 fprintf(stream,
1671 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
Stefan Roese84899e22014-10-22 12:13:21 +02001672 fprintf(stream,
1673 " -D <image>: boot <image> without preamble (Dove)\n");
1674 fprintf(stream, " -d: enter debug mode\n");
1675 fprintf(stream, " -a: use timings for Armada XP\n");
Stefan Roese1c0df9e2015-05-29 13:25:04 +02001676 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
1677 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
Kevin Smith7497a6a2016-02-16 21:28:19 +00001678 fprintf(stream,
1679 " -o <block-timeo>: use specific xmodem block timeout\n");
Luka Perkovd131ad62012-05-27 11:44:51 +00001680 fprintf(stream, "\n");
1681 fprintf(stream, " -t: mini terminal\n");
1682 fprintf(stream, "\n");
1683 fprintf(stream, " -B <baud>: set baud rate\n");
1684 fprintf(stream, "\n");
1685}
1686
1687int
1688main(int argc, char **argv)
1689{
1690 const char *ttypath, *imgpath;
Pali Rohárddc04fa2021-09-24 23:06:55 +02001691 int rv, rc, tty, term;
Luka Perkovd131ad62012-05-27 11:44:51 +00001692 void *bootmsg;
Stefan Roese84899e22014-10-22 12:13:21 +02001693 void *debugmsg;
Luka Perkovd131ad62012-05-27 11:44:51 +00001694 void *img;
1695 size_t size;
Pali Rohárca272042021-09-24 23:07:05 +02001696 size_t after_img_rsv;
1697 int baudrate;
Luka Perkovd131ad62012-05-27 11:44:51 +00001698
1699 rv = 1;
1700 tty = -1;
1701 bootmsg = NULL;
Stefan Roese84899e22014-10-22 12:13:21 +02001702 debugmsg = NULL;
Luka Perkovd131ad62012-05-27 11:44:51 +00001703 imgpath = NULL;
1704 img = NULL;
1705 term = 0;
Luka Perkovd131ad62012-05-27 11:44:51 +00001706 size = 0;
Pali Rohárca272042021-09-24 23:07:05 +02001707 after_img_rsv = KWBOOT_XM_BLKSZ;
1708 baudrate = 115200;
Luka Perkovd131ad62012-05-27 11:44:51 +00001709
Pali Rohár75176dc2021-11-05 23:30:42 +01001710 printf("kwboot version %s\n", PLAIN_VERSION);
1711
Luka Perkovd131ad62012-05-27 11:44:51 +00001712 kwboot_verbose = isatty(STDOUT_FILENO);
1713
1714 do {
Kevin Smith7497a6a2016-02-16 21:28:19 +00001715 int c = getopt(argc, argv, "hb:ptaB:dD:q:s:o:");
Luka Perkovd131ad62012-05-27 11:44:51 +00001716 if (c < 0)
1717 break;
1718
1719 switch (c) {
1720 case 'b':
1721 bootmsg = kwboot_msg_boot;
1722 imgpath = optarg;
1723 break;
1724
Stefan Roese84899e22014-10-22 12:13:21 +02001725 case 'D':
1726 bootmsg = NULL;
1727 imgpath = optarg;
1728 break;
1729
1730 case 'd':
1731 debugmsg = kwboot_msg_debug;
1732 break;
1733
Luka Perkovd131ad62012-05-27 11:44:51 +00001734 case 'p':
Pali Rohárddc04fa2021-09-24 23:06:55 +02001735 /* nop, for backward compatibility */
Luka Perkovd131ad62012-05-27 11:44:51 +00001736 break;
1737
1738 case 't':
1739 term = 1;
1740 break;
1741
Stefan Roese84899e22014-10-22 12:13:21 +02001742 case 'a':
1743 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
1744 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1745 break;
1746
Stefan Roese1c0df9e2015-05-29 13:25:04 +02001747 case 'q':
1748 msg_req_delay = atoi(optarg);
1749 break;
1750
1751 case 's':
1752 msg_rsp_timeo = atoi(optarg);
1753 break;
1754
Kevin Smith7497a6a2016-02-16 21:28:19 +00001755 case 'o':
1756 blk_rsp_timeo = atoi(optarg);
1757 break;
1758
Luka Perkovd131ad62012-05-27 11:44:51 +00001759 case 'B':
Pali Rohárca272042021-09-24 23:07:05 +02001760 baudrate = atoi(optarg);
Luka Perkovd131ad62012-05-27 11:44:51 +00001761 break;
1762
1763 case 'h':
1764 rv = 0;
1765 default:
1766 goto usage;
1767 }
1768 } while (1);
1769
Stefan Roese84899e22014-10-22 12:13:21 +02001770 if (!bootmsg && !term && !debugmsg)
Luka Perkovd131ad62012-05-27 11:44:51 +00001771 goto usage;
1772
Luka Perkovd131ad62012-05-27 11:44:51 +00001773 if (argc - optind < 1)
1774 goto usage;
1775
1776 ttypath = argv[optind++];
1777
Pali Rohárca272042021-09-24 23:07:05 +02001778 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
Luka Perkovd131ad62012-05-27 11:44:51 +00001779 if (tty < 0) {
1780 perror(ttypath);
1781 goto out;
1782 }
1783
Pali Rohárca272042021-09-24 23:07:05 +02001784 if (baudrate == 115200)
1785 /* do not change baudrate during Xmodem to the same value */
1786 baudrate = 0;
1787 else
1788 /* ensure we have enough space for baudrate change code */
Pali Rohár8dbe0272021-10-27 20:57:02 +02001789 after_img_rsv += sizeof(struct opt_hdr_v1) + 8 + 16 +
1790 sizeof(kwboot_baud_code_binhdr_pre) +
Pali Rohár5923ef62021-10-25 15:12:54 +02001791 sizeof(kwboot_baud_code) +
Pali Rohár8dbe0272021-10-27 20:57:02 +02001792 sizeof(kwboot_baud_code_binhdr_post) +
1793 KWBOOT_XM_BLKSZ +
1794 sizeof(kwboot_baud_code) +
1795 sizeof(kwboot_baud_code_data_jump) +
Pali Rohár5923ef62021-10-25 15:12:54 +02001796 KWBOOT_XM_BLKSZ;
Pali Rohárca272042021-09-24 23:07:05 +02001797
Luka Perkovd131ad62012-05-27 11:44:51 +00001798 if (imgpath) {
Pali Rohárca272042021-09-24 23:07:05 +02001799 img = kwboot_read_image(imgpath, &size, after_img_rsv);
Luka Perkovd131ad62012-05-27 11:44:51 +00001800 if (!img) {
1801 perror(imgpath);
1802 goto out;
1803 }
Luka Perkovd131ad62012-05-27 11:44:51 +00001804
Pali Rohárca272042021-09-24 23:07:05 +02001805 rc = kwboot_img_patch(img, &size, baudrate);
Luka Perkovd131ad62012-05-27 11:44:51 +00001806 if (rc) {
1807 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1808 goto out;
1809 }
1810 }
1811
Stefan Roese84899e22014-10-22 12:13:21 +02001812 if (debugmsg) {
1813 rc = kwboot_debugmsg(tty, debugmsg);
1814 if (rc) {
1815 perror("debugmsg");
1816 goto out;
1817 }
Willy Tarreau3475a712018-07-03 12:10:30 -04001818 } else if (bootmsg) {
Luka Perkovd131ad62012-05-27 11:44:51 +00001819 rc = kwboot_bootmsg(tty, bootmsg);
1820 if (rc) {
1821 perror("bootmsg");
1822 goto out;
1823 }
1824 }
1825
1826 if (img) {
Pali Rohárca272042021-09-24 23:07:05 +02001827 rc = kwboot_xmodem(tty, img, size, baudrate);
Luka Perkovd131ad62012-05-27 11:44:51 +00001828 if (rc) {
1829 perror("xmodem");
1830 goto out;
1831 }
1832 }
1833
1834 if (term) {
1835 rc = kwboot_terminal(tty);
1836 if (rc && !(errno == EINTR)) {
1837 perror("terminal");
1838 goto out;
1839 }
1840 }
1841
1842 rv = 0;
1843out:
1844 if (tty >= 0)
1845 close(tty);
1846
1847 if (img)
Pali Rohár04ced022021-09-24 23:07:03 +02001848 free(img);
Luka Perkovd131ad62012-05-27 11:44:51 +00001849
1850 return rv;
1851
1852usage:
1853 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));
1854 goto out;
1855}