blob: 5a7c53ce8929b515cd0f640d88b0932f928e08b0 [file] [log] [blame]
Luka Perkovdff289642012-05-27 11:44:51 +00001/*
Stefan Roesebb5c4282014-10-22 12:13:21 +02002 * Boot a Marvell SoC, with Xmodem over UART0.
Marek Behúndb5b53e2021-09-24 23:07:13 +02003 * supports Kirkwood, Dove, Armada 370, Armada XP, Armada 375, Armada 38x and
4 * Armada 39x
Luka Perkovdff289642012-05-27 11:44:51 +00005 *
6 * (c) 2012 Daniel Stodden <daniel.stodden@gmail.com>
Pali Roháraa98a1e2021-09-24 23:07:14 +02007 * (c) 2021 Pali Rohár <pali@kernel.org>
8 * (c) 2021 Marek Behún <marek.behun@nic.cz>
Luka Perkovdff289642012-05-27 11:44:51 +00009 *
10 * References: marvell.com, "88F6180, 88F6190, 88F6192, and 88F6281
11 * Integrated Controller: Functional Specifications" December 2,
12 * 2008. Chapter 24.2 "BootROM Firmware".
13 */
14
Stefan Roese04ec0d32016-01-07 14:12:04 +010015#include "kwbimage.h"
16#include "mkimage.h"
Pali Rohár3c703aaf2021-09-24 23:06:42 +020017#include "version.h"
Stefan Roese04ec0d32016-01-07 14:12:04 +010018
Luka Perkovdff289642012-05-27 11:44:51 +000019#include <stdlib.h>
20#include <stdio.h>
21#include <string.h>
22#include <stdarg.h>
Stefan Roese04ec0d32016-01-07 14:12:04 +010023#include <image.h>
Luka Perkovdff289642012-05-27 11:44:51 +000024#include <libgen.h>
25#include <fcntl.h>
26#include <errno.h>
27#include <unistd.h>
28#include <stdint.h>
Marek Behún2d9f2452021-09-24 23:06:52 +020029#include <time.h>
Luka Perkovdff289642012-05-27 11:44:51 +000030#include <sys/stat.h>
31
Pali Rohárfd935e92021-09-24 23:07:06 +020032#ifdef __linux__
33#include "termios_linux.h"
34#else
35#include <termios.h>
36#endif
37
Luka Perkovdff289642012-05-27 11:44:51 +000038/*
39 * Marvell BootROM UART Sensing
40 */
41
42static unsigned char kwboot_msg_boot[] = {
43 0xBB, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
44};
45
Stefan Roesebb5c4282014-10-22 12:13:21 +020046static unsigned char kwboot_msg_debug[] = {
47 0xDD, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77
48};
49
50/* Defines known to work on Kirkwood */
Luka Perkovdff289642012-05-27 11:44:51 +000051#define KWBOOT_MSG_REQ_DELAY 10 /* ms */
52#define KWBOOT_MSG_RSP_TIMEO 50 /* ms */
53
Stefan Roesebb5c4282014-10-22 12:13:21 +020054/* Defines known to work on Armada XP */
55#define KWBOOT_MSG_REQ_DELAY_AXP 1000 /* ms */
56#define KWBOOT_MSG_RSP_TIMEO_AXP 1000 /* ms */
57
Luka Perkovdff289642012-05-27 11:44:51 +000058/*
59 * Xmodem Transfers
60 */
61
62#define SOH 1 /* sender start of block header */
63#define EOT 4 /* sender end of block transfer */
64#define ACK 6 /* target block ack */
65#define NAK 21 /* target block negative ack */
Luka Perkovdff289642012-05-27 11:44:51 +000066
Pali Rohárbed18ef2021-09-24 23:06:48 +020067#define KWBOOT_XM_BLKSZ 128 /* xmodem block size */
68
Luka Perkovdff289642012-05-27 11:44:51 +000069struct kwboot_block {
70 uint8_t soh;
71 uint8_t pnum;
72 uint8_t _pnum;
Pali Rohárbed18ef2021-09-24 23:06:48 +020073 uint8_t data[KWBOOT_XM_BLKSZ];
Luka Perkovdff289642012-05-27 11:44:51 +000074 uint8_t csum;
Pali Rohárf01adfd2021-07-23 11:14:14 +020075} __packed;
Luka Perkovdff289642012-05-27 11:44:51 +000076
Pali Rohárdef98382022-01-25 18:13:00 +010077#define KWBOOT_BLK_RSP_TIMEO 2000 /* ms */
Marek Behún2d9f2452021-09-24 23:06:52 +020078#define KWBOOT_HDR_RSP_TIMEO 10000 /* ms */
Luka Perkovdff289642012-05-27 11:44:51 +000079
Pali Rohár6303a232021-10-27 20:57:02 +020080/* ARM code to change baudrate */
Pali Rohár2a8b7692021-09-24 23:07:05 +020081static unsigned char kwboot_baud_code[] = {
82 /* ; #define UART_BASE 0xd0012000 */
Pali Rohár2a8b7692021-09-24 23:07:05 +020083 /* ; #define DLL 0x00 */
84 /* ; #define DLH 0x04 */
85 /* ; #define LCR 0x0c */
86 /* ; #define DLAB 0x80 */
87 /* ; #define LSR 0x14 */
Pali Rohár2a8b7692021-09-24 23:07:05 +020088 /* ; #define TEMT 0x40 */
89 /* ; #define DIV_ROUND(a, b) ((a + b/2) / b) */
90 /* ; */
91 /* ; u32 set_baudrate(u32 old_b, u32 new_b) { */
Pali Rohár2a8b7692021-09-24 23:07:05 +020092 /* ; while */
93 /* ; (!(readl(UART_BASE + LSR) & TEMT)); */
94 /* ; u32 lcr = readl(UART_BASE + LCR); */
95 /* ; writel(UART_BASE + LCR, lcr | DLAB); */
96 /* ; u8 old_dll = readl(UART_BASE + DLL); */
97 /* ; u8 old_dlh = readl(UART_BASE + DLH); */
98 /* ; u16 old_dl = old_dll | (old_dlh << 8); */
99 /* ; u32 clk = old_b * old_dl; */
100 /* ; u16 new_dl = DIV_ROUND(clk, new_b); */
101 /* ; u8 new_dll = new_dl & 0xff; */
102 /* ; u8 new_dlh = (new_dl >> 8) & 0xff; */
103 /* ; writel(UART_BASE + DLL, new_dll); */
104 /* ; writel(UART_BASE + DLH, new_dlh); */
105 /* ; writel(UART_BASE + LCR, lcr & ~DLAB); */
Pali Rohár9e624c92021-10-27 20:57:00 +0200106 /* ; msleep(5); */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200107 /* ; return 0; */
108 /* ; } */
109
Pali Rohár2a8b7692021-09-24 23:07:05 +0200110 /* ; r0 = UART_BASE */
Pali Rohár15b16e52021-10-27 20:57:01 +0200111 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
112 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200113
Pali Rohár2a8b7692021-09-24 23:07:05 +0200114 /* ; Wait until Transmitter FIFO is Empty */
115 /* .Lloop_txempty: */
116 /* ; r1 = UART_BASE[LSR] & TEMT */
117 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
118 0x40, 0x00, 0x11, 0xe3, /* tst r1, #0x40 */
119 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_txempty */
120
121 /* ; Set Divisor Latch Access Bit */
122 /* ; UART_BASE[LCR] |= DLAB */
123 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
124 0x80, 0x10, 0x81, 0xe3, /* orr r1, r1, #0x80 */
125 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
126
127 /* ; Read current Divisor Latch */
128 /* ; r1 = UART_BASE[DLH]<<8 | UART_BASE[DLL] */
129 0x00, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x00] */
130 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
131 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
132 0x04, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x04] */
133 0xff, 0x10, 0x01, 0xe2, /* and r1, r1, #0xff */
134 0x41, 0x14, 0xa0, 0xe1, /* asr r1, r1, #8 */
135 0x02, 0x10, 0x81, 0xe1, /* orr r1, r1, r2 */
136
137 /* ; Read old baudrate value */
138 /* ; r2 = old_baudrate */
Pali Rohár2d760ed2021-11-01 14:00:02 +0100139 0x74, 0x20, 0x9f, 0xe5, /* ldr r2, old_baudrate */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200140
141 /* ; Calculate base clock */
142 /* ; r1 = r2 * r1 */
143 0x92, 0x01, 0x01, 0xe0, /* mul r1, r2, r1 */
144
145 /* ; Read new baudrate value */
Pali Rohár9e624c92021-10-27 20:57:00 +0200146 /* ; r2 = new_baudrate */
Pali Rohár2d760ed2021-11-01 14:00:02 +0100147 0x70, 0x20, 0x9f, 0xe5, /* ldr r2, new_baudrate */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200148
149 /* ; Calculate new Divisor Latch */
150 /* ; r1 = DIV_ROUND(r1, r2) = */
151 /* ; = (r1 + r2/2) / r2 */
152 0xa2, 0x10, 0x81, 0xe0, /* add r1, r1, r2, lsr #1 */
153 0x02, 0x40, 0xa0, 0xe1, /* mov r4, r2 */
154 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
155 /* .Lloop_div1: */
156 0x84, 0x40, 0xa0, 0x91, /* movls r4, r4, lsl #1 */
157 0xa1, 0x00, 0x54, 0xe1, /* cmp r4, r1, lsr #1 */
158 0xfc, 0xff, 0xff, 0x9a, /* bls .Lloop_div1 */
159 0x00, 0x30, 0xa0, 0xe3, /* mov r3, #0 */
160 /* .Lloop_div2: */
161 0x04, 0x00, 0x51, 0xe1, /* cmp r1, r4 */
162 0x04, 0x10, 0x41, 0x20, /* subhs r1, r1, r4 */
163 0x03, 0x30, 0xa3, 0xe0, /* adc r3, r3, r3 */
164 0xa4, 0x40, 0xa0, 0xe1, /* mov r4, r4, lsr #1 */
165 0x02, 0x00, 0x54, 0xe1, /* cmp r4, r2 */
166 0xf9, 0xff, 0xff, 0x2a, /* bhs .Lloop_div2 */
167 0x03, 0x10, 0xa0, 0xe1, /* mov r1, r3 */
168
169 /* ; Set new Divisor Latch Low */
170 /* ; UART_BASE[DLL] = r1 & 0xff */
171 0x01, 0x20, 0xa0, 0xe1, /* mov r2, r1 */
172 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
173 0x00, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x00] */
174
175 /* ; Set new Divisor Latch High */
176 /* ; UART_BASE[DLH] = r1>>8 & 0xff */
177 0x41, 0x24, 0xa0, 0xe1, /* asr r2, r1, #8 */
178 0xff, 0x20, 0x02, 0xe2, /* and r2, r2, #0xff */
179 0x04, 0x20, 0x80, 0xe5, /* str r2, [r0, #0x04] */
180
181 /* ; Clear Divisor Latch Access Bit */
182 /* ; UART_BASE[LCR] &= ~DLAB */
183 0x0c, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x0c] */
184 0x80, 0x10, 0xc1, 0xe3, /* bic r1, r1, #0x80 */
185 0x0c, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0c] */
186
Pali Rohár9e624c92021-10-27 20:57:00 +0200187 /* ; Loop 0x2dc000 (2998272) cycles */
188 /* ; which is about 5ms on 1200 MHz CPU */
189 /* ; r1 = 0x2dc000 */
190 0xb7, 0x19, 0xa0, 0xe3, /* mov r1, #0x2dc000 */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200191 /* .Lloop_sleep: */
192 0x01, 0x10, 0x41, 0xe2, /* sub r1, r1, #1 */
193 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
194 0xfc, 0xff, 0xff, 0x1a, /* bne .Lloop_sleep */
195
Pali Rohár2d760ed2021-11-01 14:00:02 +0100196 /* ; Jump to the end of execution */
197 0x01, 0x00, 0x00, 0xea, /* b end */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200198
199 /* ; Placeholder for old baudrate value */
200 /* old_baudrate: */
201 0x00, 0x00, 0x00, 0x00, /* .word 0 */
202
203 /* ; Placeholder for new baudrate value */
204 /* new_baudrate: */
205 0x00, 0x00, 0x00, 0x00, /* .word 0 */
Pali Rohár6303a232021-10-27 20:57:02 +0200206
207 /* end: */
208};
209
Pali Rohár2d760ed2021-11-01 14:00:02 +0100210/* ARM code from binary header executed by BootROM before changing baudrate */
Pali Rohár6303a232021-10-27 20:57:02 +0200211static unsigned char kwboot_baud_code_binhdr_pre[] = {
Pali Rohár2d760ed2021-11-01 14:00:02 +0100212 /* ; #define UART_BASE 0xd0012000 */
213 /* ; #define THR 0x00 */
214 /* ; #define LSR 0x14 */
215 /* ; #define THRE 0x20 */
216 /* ; */
217 /* ; void send_preamble(void) { */
218 /* ; const u8 *str = "$baudratechange"; */
219 /* ; u8 c; */
220 /* ; do { */
221 /* ; while */
222 /* ; ((readl(UART_BASE + LSR) & THRE)); */
223 /* ; c = *str++; */
224 /* ; writel(UART_BASE + THR, c); */
225 /* ; } while (c); */
226 /* ; } */
227
228 /* ; Preserve registers for BootROM */
Pali Rohár6303a232021-10-27 20:57:02 +0200229 0xfe, 0x5f, 0x2d, 0xe9, /* push { r1 - r12, lr } */
Pali Rohár2d760ed2021-11-01 14:00:02 +0100230
231 /* ; r0 = UART_BASE */
232 0x0d, 0x02, 0xa0, 0xe3, /* mov r0, #0xd0000000 */
233 0x12, 0x0a, 0x80, 0xe3, /* orr r0, r0, #0x12000 */
234
235 /* ; r2 = address of preamble string */
236 0x00, 0x20, 0x8f, 0xe2, /* adr r2, .Lstr_preamble */
237
238 /* ; Skip preamble data section */
239 0x03, 0x00, 0x00, 0xea, /* b .Lloop_preamble */
240
241 /* ; Preamble string */
242 /* .Lstr_preamble: */
243 0x24, 0x62, 0x61, 0x75, /* .asciz "$baudratechange" */
244 0x64, 0x72, 0x61, 0x74,
245 0x65, 0x63, 0x68, 0x61,
246 0x6e, 0x67, 0x65, 0x00,
247
248 /* ; Send preamble string over UART */
249 /* .Lloop_preamble: */
250 /* */
251 /* ; Wait until Transmitter Holding is Empty */
252 /* .Lloop_thre: */
253 /* ; r1 = UART_BASE[LSR] & THRE */
254 0x14, 0x10, 0x90, 0xe5, /* ldr r1, [r0, #0x14] */
255 0x20, 0x00, 0x11, 0xe3, /* tst r1, #0x20 */
256 0xfc, 0xff, 0xff, 0x0a, /* beq .Lloop_thre */
257
258 /* ; Put character into Transmitter FIFO */
259 /* ; r1 = *r2++ */
260 0x01, 0x10, 0xd2, 0xe4, /* ldrb r1, [r2], #1 */
261 /* ; UART_BASE[THR] = r1 */
262 0x00, 0x10, 0x80, 0xe5, /* str r1, [r0, #0x0] */
263
264 /* ; Loop until end of preamble string */
265 0x00, 0x00, 0x51, 0xe3, /* cmp r1, #0 */
266 0xf8, 0xff, 0xff, 0x1a, /* bne .Lloop_preamble */
Pali Rohár6303a232021-10-27 20:57:02 +0200267};
268
Pali Rohár2d760ed2021-11-01 14:00:02 +0100269/* ARM code for returning from binary header back to BootROM */
Pali Rohár6303a232021-10-27 20:57:02 +0200270static unsigned char kwboot_baud_code_binhdr_post[] = {
271 /* ; Return 0 - no error */
272 0x00, 0x00, 0xa0, 0xe3, /* mov r0, #0 */
273 0xfe, 0x9f, 0xbd, 0xe8, /* pop { r1 - r12, pc } */
Pali Rohár2a8b7692021-09-24 23:07:05 +0200274};
275
Pali Rohár6303a232021-10-27 20:57:02 +0200276/* ARM code for jumping to the original image exec_addr */
277static unsigned char kwboot_baud_code_data_jump[] = {
278 0x04, 0xf0, 0x1f, 0xe5, /* ldr pc, exec_addr */
279 /* ; Placeholder for exec_addr */
280 /* exec_addr: */
281 0x00, 0x00, 0x00, 0x00, /* .word 0 */
282};
Pali Rohár2a8b7692021-09-24 23:07:05 +0200283
284static const char kwb_baud_magic[16] = "$baudratechange";
285
Luka Perkovdff289642012-05-27 11:44:51 +0000286static int kwboot_verbose;
287
Stefan Roesebb5c4282014-10-22 12:13:21 +0200288static int msg_req_delay = KWBOOT_MSG_REQ_DELAY;
289static int msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO;
Kevin Smith4d31a842016-02-16 21:28:19 +0000290static int blk_rsp_timeo = KWBOOT_BLK_RSP_TIMEO;
Stefan Roesebb5c4282014-10-22 12:13:21 +0200291
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200292static ssize_t
293kwboot_write(int fd, const char *buf, size_t len)
294{
Pali Rohár5350df12022-01-25 18:13:10 +0100295 ssize_t tot = 0;
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200296
297 while (tot < len) {
298 ssize_t wr = write(fd, buf + tot, len - tot);
299
Pali Rohár5350df12022-01-25 18:13:10 +0100300 if (wr < 0 && errno == EINTR)
301 continue;
302 else if (wr < 0)
303 return wr;
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200304
305 tot += wr;
306 }
307
308 return tot;
309}
310
Luka Perkovdff289642012-05-27 11:44:51 +0000311static void
312kwboot_printv(const char *fmt, ...)
313{
314 va_list ap;
315
316 if (kwboot_verbose) {
317 va_start(ap, fmt);
318 vprintf(fmt, ap);
319 va_end(ap);
320 fflush(stdout);
321 }
322}
323
324static void
325__spinner(void)
326{
327 const char seq[] = { '-', '\\', '|', '/' };
328 const int div = 8;
329 static int state, bs;
330
331 if (state % div == 0) {
332 fputc(bs, stdout);
333 fputc(seq[state / div % sizeof(seq)], stdout);
334 fflush(stdout);
335 }
336
337 bs = '\b';
338 state++;
339}
340
341static void
342kwboot_spinner(void)
343{
344 if (kwboot_verbose)
345 __spinner();
346}
347
348static void
349__progress(int pct, char c)
350{
351 const int width = 70;
352 static const char *nl = "";
353 static int pos;
354
355 if (pos % width == 0)
356 printf("%s%3d %% [", nl, pct);
357
358 fputc(c, stdout);
359
360 nl = "]\n";
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200361 pos = (pos + 1) % width;
Luka Perkovdff289642012-05-27 11:44:51 +0000362
363 if (pct == 100) {
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200364 while (pos && pos++ < width)
Luka Perkovdff289642012-05-27 11:44:51 +0000365 fputc(' ', stdout);
366 fputs(nl, stdout);
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200367 nl = "";
368 pos = 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000369 }
370
371 fflush(stdout);
372
373}
374
375static void
376kwboot_progress(int _pct, char c)
377{
378 static int pct;
379
380 if (_pct != -1)
381 pct = _pct;
382
383 if (kwboot_verbose)
384 __progress(pct, c);
Pali Rohárd01b9ce2021-09-24 23:06:46 +0200385
386 if (pct == 100)
387 pct = 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000388}
389
390static int
391kwboot_tty_recv(int fd, void *buf, size_t len, int timeo)
392{
393 int rc, nfds;
394 fd_set rfds;
395 struct timeval tv;
396 ssize_t n;
397
398 rc = -1;
399
400 FD_ZERO(&rfds);
401 FD_SET(fd, &rfds);
402
403 tv.tv_sec = 0;
404 tv.tv_usec = timeo * 1000;
405 if (tv.tv_usec > 1000000) {
406 tv.tv_sec += tv.tv_usec / 1000000;
407 tv.tv_usec %= 1000000;
408 }
409
410 do {
411 nfds = select(fd + 1, &rfds, NULL, NULL, &tv);
Pali Rohár613bd8b2022-01-25 18:13:11 +0100412 if (nfds < 0 && errno == EINTR)
413 continue;
414 else if (nfds < 0)
Luka Perkovdff289642012-05-27 11:44:51 +0000415 goto out;
Pali Rohár613bd8b2022-01-25 18:13:11 +0100416 else if (!nfds) {
Luka Perkovdff289642012-05-27 11:44:51 +0000417 errno = ETIMEDOUT;
418 goto out;
419 }
420
421 n = read(fd, buf, len);
Pali Rohár613bd8b2022-01-25 18:13:11 +0100422 if (n < 0 && errno == EINTR)
423 continue;
424 else if (n <= 0)
Luka Perkovdff289642012-05-27 11:44:51 +0000425 goto out;
426
427 buf = (char *)buf + n;
428 len -= n;
429 } while (len > 0);
430
431 rc = 0;
432out:
433 return rc;
434}
435
436static int
Pali Rohárf2acbba2021-10-27 20:56:59 +0200437kwboot_tty_send(int fd, const void *buf, size_t len, int nodrain)
Luka Perkovdff289642012-05-27 11:44:51 +0000438{
Stefan Roesebb5c4282014-10-22 12:13:21 +0200439 if (!buf)
440 return 0;
441
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200442 if (kwboot_write(fd, buf, len) < 0)
443 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +0000444
Pali Rohárf2acbba2021-10-27 20:56:59 +0200445 if (nodrain)
446 return 0;
447
Marek Behúnd3bc5c32021-09-24 23:06:41 +0200448 return tcdrain(fd);
Luka Perkovdff289642012-05-27 11:44:51 +0000449}
450
451static int
452kwboot_tty_send_char(int fd, unsigned char c)
453{
Pali Rohárf2acbba2021-10-27 20:56:59 +0200454 return kwboot_tty_send(fd, &c, 1, 0);
Luka Perkovdff289642012-05-27 11:44:51 +0000455}
456
457static speed_t
Pali Rohár2a8b7692021-09-24 23:07:05 +0200458kwboot_tty_baudrate_to_speed(int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +0000459{
460 switch (baudrate) {
Pali Rohár2a8b7692021-09-24 23:07:05 +0200461#ifdef B4000000
462 case 4000000:
463 return B4000000;
464#endif
465#ifdef B3500000
466 case 3500000:
467 return B3500000;
468#endif
469#ifdef B3000000
470 case 3000000:
471 return B3000000;
472#endif
473#ifdef B2500000
474 case 2500000:
475 return B2500000;
476#endif
477#ifdef B2000000
478 case 2000000:
479 return B2000000;
480#endif
481#ifdef B1500000
482 case 1500000:
483 return B1500000;
484#endif
485#ifdef B1152000
486 case 1152000:
487 return B1152000;
488#endif
489#ifdef B1000000
490 case 1000000:
491 return B1000000;
492#endif
493#ifdef B921600
494 case 921600:
495 return B921600;
496#endif
497#ifdef B614400
498 case 614400:
499 return B614400;
500#endif
501#ifdef B576000
502 case 576000:
503 return B576000;
504#endif
505#ifdef B500000
506 case 500000:
507 return B500000;
508#endif
509#ifdef B460800
510 case 460800:
511 return B460800;
512#endif
513#ifdef B307200
514 case 307200:
515 return B307200;
516#endif
517#ifdef B230400
518 case 230400:
519 return B230400;
520#endif
521#ifdef B153600
522 case 153600:
523 return B153600;
524#endif
525#ifdef B115200
Luka Perkovdff289642012-05-27 11:44:51 +0000526 case 115200:
527 return B115200;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200528#endif
529#ifdef B76800
530 case 76800:
531 return B76800;
532#endif
533#ifdef B57600
Luka Perkovdff289642012-05-27 11:44:51 +0000534 case 57600:
535 return B57600;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200536#endif
537#ifdef B38400
Luka Perkovdff289642012-05-27 11:44:51 +0000538 case 38400:
539 return B38400;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200540#endif
541#ifdef B19200
Luka Perkovdff289642012-05-27 11:44:51 +0000542 case 19200:
543 return B19200;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200544#endif
545#ifdef B9600
Luka Perkovdff289642012-05-27 11:44:51 +0000546 case 9600:
547 return B9600;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200548#endif
549#ifdef B4800
550 case 4800:
551 return B4800;
552#endif
553#ifdef B2400
554 case 2400:
555 return B2400;
556#endif
557#ifdef B1800
558 case 1800:
559 return B1800;
560#endif
561#ifdef B1200
562 case 1200:
563 return B1200;
564#endif
565#ifdef B600
566 case 600:
567 return B600;
568#endif
569#ifdef B300
570 case 300:
571 return B300;
572#endif
573#ifdef B200
574 case 200:
575 return B200;
576#endif
577#ifdef B150
578 case 150:
579 return B150;
580#endif
581#ifdef B134
582 case 134:
583 return B134;
584#endif
585#ifdef B110
586 case 110:
587 return B110;
588#endif
589#ifdef B75
590 case 75:
591 return B75;
592#endif
593#ifdef B50
594 case 50:
595 return B50;
596#endif
597 default:
Pali Rohárfd935e92021-09-24 23:07:06 +0200598#ifdef BOTHER
599 return BOTHER;
600#else
Pali Rohár2a8b7692021-09-24 23:07:05 +0200601 return B0;
Pali Rohárfd935e92021-09-24 23:07:06 +0200602#endif
Luka Perkovdff289642012-05-27 11:44:51 +0000603 }
Pali Rohár2a8b7692021-09-24 23:07:05 +0200604}
605
606static int
Marek Behún67835492021-09-24 23:07:07 +0200607_is_within_tolerance(int value, int reference, int tolerance)
608{
609 return 100 * value >= reference * (100 - tolerance) &&
610 100 * value <= reference * (100 + tolerance);
611}
612
613static int
Pali Rohár2a8b7692021-09-24 23:07:05 +0200614kwboot_tty_change_baudrate(int fd, int baudrate)
615{
616 struct termios tio;
617 speed_t speed;
618 int rc;
619
620 rc = tcgetattr(fd, &tio);
621 if (rc)
622 return rc;
623
624 speed = kwboot_tty_baudrate_to_speed(baudrate);
625 if (speed == B0) {
626 errno = EINVAL;
627 return -1;
628 }
629
Pali Rohárfd935e92021-09-24 23:07:06 +0200630#ifdef BOTHER
631 if (speed == BOTHER)
632 tio.c_ospeed = tio.c_ispeed = baudrate;
633#endif
634
Pali Rohár2a8b7692021-09-24 23:07:05 +0200635 rc = cfsetospeed(&tio, speed);
636 if (rc)
637 return rc;
638
639 rc = cfsetispeed(&tio, speed);
640 if (rc)
641 return rc;
Luka Perkovdff289642012-05-27 11:44:51 +0000642
Pali Rohár2a8b7692021-09-24 23:07:05 +0200643 rc = tcsetattr(fd, TCSANOW, &tio);
644 if (rc)
645 return rc;
646
Marek Behún67835492021-09-24 23:07:07 +0200647 rc = tcgetattr(fd, &tio);
648 if (rc)
649 return rc;
650
651 if (cfgetospeed(&tio) != speed || cfgetispeed(&tio) != speed)
652 goto baud_fail;
653
654#ifdef BOTHER
655 /*
656 * Check whether set baudrate is within 3% tolerance.
657 * If BOTHER is defined, Linux always fills out c_ospeed / c_ispeed
658 * with real values.
659 */
660 if (!_is_within_tolerance(tio.c_ospeed, baudrate, 3))
661 goto baud_fail;
662
663 if (!_is_within_tolerance(tio.c_ispeed, baudrate, 3))
664 goto baud_fail;
665#endif
666
Pali Rohár2a8b7692021-09-24 23:07:05 +0200667 return 0;
Marek Behún67835492021-09-24 23:07:07 +0200668
669baud_fail:
670 fprintf(stderr, "Could not set baudrate to requested value\n");
671 errno = EINVAL;
672 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +0000673}
674
675static int
Pali Rohár2a8b7692021-09-24 23:07:05 +0200676kwboot_open_tty(const char *path, int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +0000677{
Pali Rohár2bffe242021-09-24 23:07:10 +0200678 int rc, fd, flags;
Luka Perkovdff289642012-05-27 11:44:51 +0000679 struct termios tio;
680
681 rc = -1;
682
Marek Behún6c598c32021-09-24 23:07:11 +0200683 fd = open(path, O_RDWR | O_NOCTTY | O_NDELAY);
Luka Perkovdff289642012-05-27 11:44:51 +0000684 if (fd < 0)
685 goto out;
686
Pali Rohár909a0b92021-09-24 23:07:08 +0200687 rc = tcgetattr(fd, &tio);
688 if (rc)
689 goto out;
Luka Perkovdff289642012-05-27 11:44:51 +0000690
Pali Rohár909a0b92021-09-24 23:07:08 +0200691 cfmakeraw(&tio);
Marek Behún6c598c32021-09-24 23:07:11 +0200692 tio.c_cflag |= CREAD | CLOCAL;
Pali Rohár40003a02021-10-25 15:12:53 +0200693 tio.c_cflag &= ~(CSTOPB | HUPCL | CRTSCTS);
Luka Perkovdff289642012-05-27 11:44:51 +0000694 tio.c_cc[VMIN] = 1;
Pali Rohár12095b22021-09-24 23:07:09 +0200695 tio.c_cc[VTIME] = 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000696
Luka Perkovdff289642012-05-27 11:44:51 +0000697 rc = tcsetattr(fd, TCSANOW, &tio);
698 if (rc)
699 goto out;
700
Pali Rohár2bffe242021-09-24 23:07:10 +0200701 flags = fcntl(fd, F_GETFL);
702 if (flags < 0)
703 goto out;
704
705 rc = fcntl(fd, F_SETFL, flags & ~O_NDELAY);
706 if (rc)
707 goto out;
708
Pali Rohár2a8b7692021-09-24 23:07:05 +0200709 rc = kwboot_tty_change_baudrate(fd, baudrate);
710 if (rc)
711 goto out;
712
Luka Perkovdff289642012-05-27 11:44:51 +0000713 rc = fd;
714out:
715 if (rc < 0) {
716 if (fd >= 0)
717 close(fd);
718 }
719
720 return rc;
721}
722
723static int
724kwboot_bootmsg(int tty, void *msg)
725{
Pali Roháre68c27bd2022-01-25 18:13:08 +0100726 struct kwboot_block block;
Luka Perkovdff289642012-05-27 11:44:51 +0000727 int rc;
728 char c;
Jon Nettleton0e428ee2018-08-13 18:24:38 +0300729 int count;
Luka Perkovdff289642012-05-27 11:44:51 +0000730
Stefan Roesebb5c4282014-10-22 12:13:21 +0200731 if (msg == NULL)
732 kwboot_printv("Please reboot the target into UART boot mode...");
733 else
734 kwboot_printv("Sending boot message. Please reboot the target...");
Luka Perkovdff289642012-05-27 11:44:51 +0000735
736 do {
737 rc = tcflush(tty, TCIOFLUSH);
738 if (rc)
739 break;
740
Jon Nettleton0e428ee2018-08-13 18:24:38 +0300741 for (count = 0; count < 128; count++) {
Pali Rohárf2acbba2021-10-27 20:56:59 +0200742 rc = kwboot_tty_send(tty, msg, 8, 0);
Pali Roháre3a18282022-03-02 11:49:18 +0100743 if (rc)
744 break;
Luka Perkovdff289642012-05-27 11:44:51 +0000745 }
746
Stefan Roesebb5c4282014-10-22 12:13:21 +0200747 rc = kwboot_tty_recv(tty, &c, 1, msg_rsp_timeo);
Luka Perkovdff289642012-05-27 11:44:51 +0000748
749 kwboot_spinner();
750
751 } while (rc || c != NAK);
752
753 kwboot_printv("\n");
754
Pali Roháre68c27bd2022-01-25 18:13:08 +0100755 if (rc)
756 return rc;
757
758 /*
759 * At this stage we have sent more boot message patterns and BootROM
760 * (at least on Armada XP and 385) started interpreting sent bytes as
761 * part of xmodem packets. If BootROM is expecting SOH byte as start of
762 * a xmodem packet and it receives byte 0xff, then it throws it away and
763 * sends a NAK reply to host. If BootROM does not receive any byte for
764 * 2s when expecting some continuation of the xmodem packet, it throws
765 * away the partially received xmodem data and sends NAK reply to host.
766 *
767 * Therefore for starting xmodem transfer we have two options: Either
768 * wait 2s or send 132 0xff bytes (which is the size of xmodem packet)
769 * to ensure that BootROM throws away any partially received data.
770 */
771
772 /* flush output queue with remaining boot message patterns */
Pali Roháre3a18282022-03-02 11:49:18 +0100773 rc = tcflush(tty, TCOFLUSH);
774 if (rc) {
775 perror("Failed to flush output queue");
776 return rc;
777 }
Pali Roháre68c27bd2022-01-25 18:13:08 +0100778
779 /* send one xmodem packet with 0xff bytes to force BootROM to re-sync */
780 memset(&block, 0xff, sizeof(block));
Pali Roháre3a18282022-03-02 11:49:18 +0100781 rc = kwboot_tty_send(tty, &block, sizeof(block), 0);
782 if (rc) {
783 perror("Failed to send sync sequence");
784 return rc;
785 }
Pali Roháre68c27bd2022-01-25 18:13:08 +0100786
787 /*
788 * Sending 132 bytes via 115200B/8-N-1 takes 11.45 ms, reading 132 bytes
789 * takes 11.45 ms, so waiting for 30 ms should be enough.
790 */
791 usleep(30 * 1000);
792
793 /* flush remaining NAK replies from input queue */
Pali Roháre3a18282022-03-02 11:49:18 +0100794 rc = tcflush(tty, TCIFLUSH);
795 if (rc) {
796 perror("Failed to flush input queue");
797 return rc;
798 }
Pali Roháre68c27bd2022-01-25 18:13:08 +0100799
800 return 0;
Luka Perkovdff289642012-05-27 11:44:51 +0000801}
802
803static int
Stefan Roesebb5c4282014-10-22 12:13:21 +0200804kwboot_debugmsg(int tty, void *msg)
805{
806 int rc;
807
808 kwboot_printv("Sending debug message. Please reboot the target...");
809
810 do {
811 char buf[16];
812
813 rc = tcflush(tty, TCIOFLUSH);
814 if (rc)
815 break;
816
Pali Rohárf2acbba2021-10-27 20:56:59 +0200817 rc = kwboot_tty_send(tty, msg, 8, 0);
Pali Roháre3a18282022-03-02 11:49:18 +0100818 if (rc)
819 break;
Stefan Roesebb5c4282014-10-22 12:13:21 +0200820
821 rc = kwboot_tty_recv(tty, buf, 16, msg_rsp_timeo);
822
823 kwboot_spinner();
824
825 } while (rc);
826
827 kwboot_printv("\n");
828
829 return rc;
830}
831
Pali Rohár58cf04de2021-09-24 23:06:44 +0200832static size_t
Luka Perkovdff289642012-05-27 11:44:51 +0000833kwboot_xm_makeblock(struct kwboot_block *block, const void *data,
834 size_t size, int pnum)
835{
Marek Behúnedb63242021-09-24 23:06:45 +0200836 size_t i, n;
Luka Perkovdff289642012-05-27 11:44:51 +0000837
Stefan Roesebb5c4282014-10-22 12:13:21 +0200838 block->soh = SOH;
Luka Perkovdff289642012-05-27 11:44:51 +0000839 block->pnum = pnum;
840 block->_pnum = ~block->pnum;
841
Pali Rohárbed18ef2021-09-24 23:06:48 +0200842 n = size < KWBOOT_XM_BLKSZ ? size : KWBOOT_XM_BLKSZ;
Luka Perkovdff289642012-05-27 11:44:51 +0000843 memcpy(&block->data[0], data, n);
Pali Rohárbed18ef2021-09-24 23:06:48 +0200844 memset(&block->data[n], 0, KWBOOT_XM_BLKSZ - n);
Luka Perkovdff289642012-05-27 11:44:51 +0000845
846 block->csum = 0;
847 for (i = 0; i < n; i++)
848 block->csum += block->data[i];
849
850 return n;
851}
852
Marek Behún2d9f2452021-09-24 23:06:52 +0200853static uint64_t
854_now(void)
855{
856 struct timespec ts;
857
858 if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
859 static int err_print;
860
861 if (!err_print) {
862 perror("clock_gettime() does not work");
863 err_print = 1;
864 }
865
866 /* this will just make the timeout not work */
867 return -1ULL;
868 }
869
870 return ts.tv_sec * 1000ULL + (ts.tv_nsec + 500000) / 1000000;
871}
872
Luka Perkovdff289642012-05-27 11:44:51 +0000873static int
Marek Behúneabacb82021-09-24 23:06:49 +0200874_is_xm_reply(char c)
875{
Pali Rohár6af14292022-01-25 18:13:03 +0100876 return c == ACK || c == NAK;
Marek Behúneabacb82021-09-24 23:06:49 +0200877}
878
879static int
Pali Rohár42c61a42021-09-24 23:06:54 +0200880_xm_reply_to_error(int c)
881{
882 int rc = -1;
883
884 switch (c) {
885 case ACK:
886 rc = 0;
887 break;
888 case NAK:
889 errno = EBADMSG;
890 break;
Pali Rohár42c61a42021-09-24 23:06:54 +0200891 default:
892 errno = EPROTO;
893 break;
894 }
895
896 return rc;
897}
898
899static int
Pali Rohár2a8b7692021-09-24 23:07:05 +0200900kwboot_baud_magic_handle(int fd, char c, int baudrate)
901{
902 static size_t rcv_len;
903
904 if (rcv_len < sizeof(kwb_baud_magic)) {
905 /* try to recognize whole magic word */
906 if (c == kwb_baud_magic[rcv_len]) {
907 rcv_len++;
908 } else {
909 printf("%.*s%c", (int)rcv_len, kwb_baud_magic, c);
910 fflush(stdout);
911 rcv_len = 0;
912 }
913 }
914
915 if (rcv_len == sizeof(kwb_baud_magic)) {
916 /* magic word received */
917 kwboot_printv("\nChanging baudrate to %d Bd\n", baudrate);
918
919 return kwboot_tty_change_baudrate(fd, baudrate) ? : 1;
920 } else {
921 return 0;
922 }
923}
924
925static int
Pali Rohár230d4f82022-01-25 18:13:04 +0100926kwboot_xm_recv_reply(int fd, char *c, int stop_on_non_xm,
Pali Roháre4529bd2022-01-25 18:13:02 +0100927 int ignore_nak_reply,
Pali Rohár959e8502021-10-25 15:13:04 +0200928 int allow_non_xm, int *non_xm_print,
Pali Rohár2a8b7692021-09-24 23:07:05 +0200929 int baudrate, int *baud_changed)
Pali Rohárd06d5202021-09-24 23:06:50 +0200930{
Marek Behún2d9f2452021-09-24 23:06:52 +0200931 int timeout = allow_non_xm ? KWBOOT_HDR_RSP_TIMEO : blk_rsp_timeo;
Marek Behún0a3b85a2021-09-24 23:06:53 +0200932 uint64_t recv_until = _now() + timeout;
Pali Rohárd06d5202021-09-24 23:06:50 +0200933 int rc;
934
935 while (1) {
Marek Behún2d9f2452021-09-24 23:06:52 +0200936 rc = kwboot_tty_recv(fd, c, 1, timeout);
Pali Rohárd06d5202021-09-24 23:06:50 +0200937 if (rc) {
938 if (errno != ETIMEDOUT)
939 return rc;
Marek Behún0a3b85a2021-09-24 23:06:53 +0200940 else if (allow_non_xm && *non_xm_print)
Marek Behún2d9f2452021-09-24 23:06:52 +0200941 return -1;
942 else
943 *c = NAK;
Pali Rohárd06d5202021-09-24 23:06:50 +0200944 }
945
946 /* If received xmodem reply, end. */
Pali Roháre4529bd2022-01-25 18:13:02 +0100947 if (_is_xm_reply(*c)) {
948 if (*c == NAK && ignore_nak_reply) {
949 timeout = recv_until - _now();
950 if (timeout >= 0)
951 continue;
952 }
Pali Rohárd06d5202021-09-24 23:06:50 +0200953 break;
Pali Roháre4529bd2022-01-25 18:13:02 +0100954 }
Pali Rohárd06d5202021-09-24 23:06:50 +0200955
956 /*
Pali Rohár2a8b7692021-09-24 23:07:05 +0200957 * If receiving/printing non-xmodem text output is allowed and
958 * such a byte was received, we want to increase receiving time
959 * and either:
960 * - print the byte, if it is not part of baudrate change magic
961 * sequence while baudrate change was requested (-B option)
962 * - change baudrate
Marek Behún0a3b85a2021-09-24 23:06:53 +0200963 * Otherwise decrease timeout by time elapsed.
Pali Rohárd06d5202021-09-24 23:06:50 +0200964 */
965 if (allow_non_xm) {
Marek Behún2d9f2452021-09-24 23:06:52 +0200966 recv_until = _now() + timeout;
Pali Rohár2a8b7692021-09-24 23:07:05 +0200967
968 if (baudrate && !*baud_changed) {
969 rc = kwboot_baud_magic_handle(fd, *c, baudrate);
970 if (rc == 1)
971 *baud_changed = 1;
972 else if (!rc)
973 *non_xm_print = 1;
974 else
975 return rc;
976 } else if (!baudrate || !*baud_changed) {
977 putchar(*c);
978 fflush(stdout);
979 *non_xm_print = 1;
980 }
Marek Behún0a3b85a2021-09-24 23:06:53 +0200981 } else {
Pali Rohár230d4f82022-01-25 18:13:04 +0100982 if (stop_on_non_xm)
Pali Rohár959e8502021-10-25 15:13:04 +0200983 break;
Marek Behún0a3b85a2021-09-24 23:06:53 +0200984 timeout = recv_until - _now();
985 if (timeout < 0) {
986 errno = ETIMEDOUT;
987 return -1;
988 }
Pali Rohárd06d5202021-09-24 23:06:50 +0200989 }
990 }
991
992 return 0;
993}
994
995static int
996kwboot_xm_sendblock(int fd, struct kwboot_block *block, int allow_non_xm,
Pali Rohár80241ce2022-01-25 18:13:05 +0100997 int *done_print, int baudrate, int allow_retries)
Luka Perkovdff289642012-05-27 11:44:51 +0000998{
Pali Rohár2a8b7692021-09-24 23:07:05 +0200999 int non_xm_print, baud_changed;
1000 int rc, err, retries;
Luka Perkovdff289642012-05-27 11:44:51 +00001001 char c;
1002
Pali Rohárd06d5202021-09-24 23:06:50 +02001003 *done_print = 0;
Pali Rohár6daa5612021-10-27 20:56:58 +02001004 non_xm_print = 0;
1005 baud_changed = 0;
Pali Rohárd06d5202021-09-24 23:06:50 +02001006
Pali Roháre665c6a2021-10-25 15:13:03 +02001007 retries = 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001008 do {
Pali Rohárf2acbba2021-10-27 20:56:59 +02001009 rc = kwboot_tty_send(fd, block, sizeof(*block), 1);
Luka Perkovdff289642012-05-27 11:44:51 +00001010 if (rc)
Pali Rohár6af14292022-01-25 18:13:03 +01001011 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001012
Pali Rohárd06d5202021-09-24 23:06:50 +02001013 if (allow_non_xm && !*done_print) {
1014 kwboot_progress(100, '.');
1015 kwboot_printv("Done\n");
1016 *done_print = 1;
1017 }
Stefan Roesebb5c4282014-10-22 12:13:21 +02001018
Pali Rohár959e8502021-10-25 15:13:04 +02001019 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Roháre4529bd2022-01-25 18:13:02 +01001020 retries > 8,
Pali Rohár959e8502021-10-25 15:13:04 +02001021 allow_non_xm, &non_xm_print,
Pali Rohár2a8b7692021-09-24 23:07:05 +02001022 baudrate, &baud_changed);
Pali Rohárd06d5202021-09-24 23:06:50 +02001023 if (rc)
Pali Rohár6af14292022-01-25 18:13:03 +01001024 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001025
Pali Rohárb3760f92022-01-25 18:13:06 +01001026 if (!allow_non_xm && c != ACK) {
1027 if (c == NAK && allow_retries && retries + 1 < 16)
1028 kwboot_progress(-1, '+');
1029 else
1030 kwboot_progress(-1, 'E');
1031 }
Pali Rohár80241ce2022-01-25 18:13:05 +01001032 } while (c == NAK && allow_retries && retries++ < 16);
Luka Perkovdff289642012-05-27 11:44:51 +00001033
Marek Behúnbcc5e042021-09-24 23:06:51 +02001034 if (non_xm_print)
1035 kwboot_printv("\n");
1036
Pali Rohár2a8b7692021-09-24 23:07:05 +02001037 if (allow_non_xm && baudrate && !baud_changed) {
1038 fprintf(stderr, "Baudrate was not changed\n");
Pali Rohár2a8b7692021-09-24 23:07:05 +02001039 errno = EPROTO;
Pali Rohár6af14292022-01-25 18:13:03 +01001040 return -1;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001041 }
1042
Pali Rohár42c61a42021-09-24 23:06:54 +02001043 return _xm_reply_to_error(c);
Pali Rohár6af14292022-01-25 18:13:03 +01001044err:
Pali Rohár2a8b7692021-09-24 23:07:05 +02001045 err = errno;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001046 kwboot_printv("\n");
1047 errno = err;
1048 return rc;
Pali Rohár42c61a42021-09-24 23:06:54 +02001049}
Luka Perkovdff289642012-05-27 11:44:51 +00001050
Pali Rohár42c61a42021-09-24 23:06:54 +02001051static int
1052kwboot_xm_finish(int fd)
1053{
1054 int rc, retries;
1055 char c;
Luka Perkovdff289642012-05-27 11:44:51 +00001056
Pali Rohár42c61a42021-09-24 23:06:54 +02001057 kwboot_printv("Finishing transfer\n");
1058
Pali Roháre665c6a2021-10-25 15:13:03 +02001059 retries = 0;
Pali Rohár42c61a42021-09-24 23:06:54 +02001060 do {
1061 rc = kwboot_tty_send_char(fd, EOT);
1062 if (rc)
1063 return rc;
1064
Pali Rohár959e8502021-10-25 15:13:04 +02001065 rc = kwboot_xm_recv_reply(fd, &c, retries < 3,
Pali Roháre4529bd2022-01-25 18:13:02 +01001066 retries > 8,
Pali Rohár959e8502021-10-25 15:13:04 +02001067 0, NULL, 0, NULL);
Pali Rohár42c61a42021-09-24 23:06:54 +02001068 if (rc)
1069 return rc;
Pali Roháre665c6a2021-10-25 15:13:03 +02001070 } while (c == NAK && retries++ < 16);
Pali Rohár42c61a42021-09-24 23:06:54 +02001071
1072 return _xm_reply_to_error(c);
Luka Perkovdff289642012-05-27 11:44:51 +00001073}
1074
1075static int
Pali Rohárbed18ef2021-09-24 23:06:48 +02001076kwboot_xmodem_one(int tty, int *pnum, int header, const uint8_t *data,
Pali Rohár2a8b7692021-09-24 23:07:05 +02001077 size_t size, int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +00001078{
Pali Rohárd06d5202021-09-24 23:06:50 +02001079 int done_print = 0;
Pali Rohárbed18ef2021-09-24 23:06:48 +02001080 size_t sent, left;
1081 int rc;
Luka Perkovdff289642012-05-27 11:44:51 +00001082
Pali Rohárbed18ef2021-09-24 23:06:48 +02001083 kwboot_printv("Sending boot image %s (%zu bytes)...\n",
1084 header ? "header" : "data", size);
Luka Perkovdff289642012-05-27 11:44:51 +00001085
Pali Rohárbed18ef2021-09-24 23:06:48 +02001086 left = size;
1087 sent = 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001088
Pali Rohárbed18ef2021-09-24 23:06:48 +02001089 while (sent < size) {
Luka Perkovdff289642012-05-27 11:44:51 +00001090 struct kwboot_block block;
Pali Rohárd06d5202021-09-24 23:06:50 +02001091 int last_block;
Pali Rohárbed18ef2021-09-24 23:06:48 +02001092 size_t blksz;
Luka Perkovdff289642012-05-27 11:44:51 +00001093
Pali Rohárbed18ef2021-09-24 23:06:48 +02001094 blksz = kwboot_xm_makeblock(&block, data, left, (*pnum)++);
1095 data += blksz;
Luka Perkovdff289642012-05-27 11:44:51 +00001096
Pali Rohárd06d5202021-09-24 23:06:50 +02001097 last_block = (left <= blksz);
1098
Pali Rohár80241ce2022-01-25 18:13:05 +01001099 /*
1100 * Handling of repeated xmodem packets is completely broken in
1101 * Armada 385 BootROM - it completely ignores xmodem packet
1102 * numbers, they are only used for checksum verification.
1103 * BootROM can handle a retry of the xmodem packet only during
1104 * the transmission of kwbimage header and only if BootROM
1105 * itself sent NAK response to previous attempt (it does it on
1106 * checksum failure). During the transmission of kwbimage data
1107 * part, BootROM always expects next xmodem packet, even if it
1108 * sent NAK to previous attempt - there is absolutely no way to
1109 * repair incorrectly transmitted xmodem packet during kwbimage
1110 * data part upload. Also, if kwboot receives non-ACK/NAK
1111 * response (meaning that original BootROM response was damaged
1112 * on UART) there is no way to detect if BootROM accepted xmodem
1113 * packet or not and no way to check if kwboot could repeat the
1114 * packet or not.
1115 *
1116 * Stop transfer and return failure if kwboot receives unknown
1117 * reply if non-xmodem reply is not allowed (for all xmodem
1118 * packets except the last header packet) or when non-ACK reply
1119 * is received during data part transfer.
1120 */
Pali Rohárd06d5202021-09-24 23:06:50 +02001121 rc = kwboot_xm_sendblock(tty, &block, header && last_block,
Pali Rohár80241ce2022-01-25 18:13:05 +01001122 &done_print, baudrate, header);
Luka Perkovdff289642012-05-27 11:44:51 +00001123 if (rc)
1124 goto out;
1125
Pali Rohárbed18ef2021-09-24 23:06:48 +02001126 sent += blksz;
1127 left -= blksz;
1128
Pali Rohárd06d5202021-09-24 23:06:50 +02001129 if (!done_print)
1130 kwboot_progress(sent * 100 / size, '.');
Pali Rohárbed18ef2021-09-24 23:06:48 +02001131 }
Luka Perkovdff289642012-05-27 11:44:51 +00001132
Pali Rohárd06d5202021-09-24 23:06:50 +02001133 if (!done_print)
1134 kwboot_printv("Done\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001135
Pali Rohárbed18ef2021-09-24 23:06:48 +02001136 return 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001137out:
Pali Rohár5ed896f2021-09-24 23:06:47 +02001138 kwboot_printv("\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001139 return rc;
Pali Rohárbed18ef2021-09-24 23:06:48 +02001140}
1141
1142static int
Pali Rohár2a8b7692021-09-24 23:07:05 +02001143kwboot_xmodem(int tty, const void *_img, size_t size, int baudrate)
Pali Rohárbed18ef2021-09-24 23:06:48 +02001144{
1145 const uint8_t *img = _img;
1146 int rc, pnum;
1147 size_t hdrsz;
1148
Marek Behúnd1b0b032021-09-24 23:07:01 +02001149 hdrsz = kwbheader_size(img);
Pali Rohárbed18ef2021-09-24 23:06:48 +02001150
Pali Rohár400b5cf2021-11-05 23:29:58 +01001151 /*
1152 * If header size is not aligned to xmodem block size (which applies
1153 * for all images in kwbimage v0 format) then we have to ensure that
1154 * the last xmodem block of header contains beginning of the data
1155 * followed by the header. So align header size to xmodem block size.
1156 */
1157 hdrsz += (KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ) % KWBOOT_XM_BLKSZ;
1158
Pali Rohárbed18ef2021-09-24 23:06:48 +02001159 pnum = 1;
1160
Pali Rohár2a8b7692021-09-24 23:07:05 +02001161 rc = kwboot_xmodem_one(tty, &pnum, 1, img, hdrsz, baudrate);
Pali Rohárbed18ef2021-09-24 23:06:48 +02001162 if (rc)
1163 return rc;
1164
Pali Rohár400b5cf2021-11-05 23:29:58 +01001165 /*
1166 * If we have already sent image data as a part of the last
1167 * xmodem header block then we have nothing more to send.
1168 */
1169 if (hdrsz < size) {
1170 img += hdrsz;
1171 size -= hdrsz;
1172 rc = kwboot_xmodem_one(tty, &pnum, 0, img, size, 0);
1173 if (rc)
1174 return rc;
1175 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001176
1177 rc = kwboot_xm_finish(tty);
Pali Rohárbed18ef2021-09-24 23:06:48 +02001178 if (rc)
1179 return rc;
Luka Perkovdff289642012-05-27 11:44:51 +00001180
Pali Rohár2a8b7692021-09-24 23:07:05 +02001181 if (baudrate) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001182 kwboot_printv("\nChanging baudrate back to 115200 Bd\n\n");
1183 rc = kwboot_tty_change_baudrate(tty, 115200);
1184 if (rc)
1185 return rc;
1186 }
1187
1188 return 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001189}
1190
1191static int
Marek Behúnea5b2b32021-09-24 23:06:40 +02001192kwboot_term_pipe(int in, int out, const char *quit, int *s)
Luka Perkovdff289642012-05-27 11:44:51 +00001193{
Pali Rohár111779f2022-02-03 17:45:20 +01001194 char buf[128];
Marek Behúnd3bc5c32021-09-24 23:06:41 +02001195 ssize_t nin;
Luka Perkovdff289642012-05-27 11:44:51 +00001196
Pali Rohár111779f2022-02-03 17:45:20 +01001197 nin = read(in, buf, sizeof(buf));
Willy Tarreauab7e8a12018-07-03 12:10:31 -04001198 if (nin <= 0)
Luka Perkovdff289642012-05-27 11:44:51 +00001199 return -1;
1200
1201 if (quit) {
1202 int i;
1203
1204 for (i = 0; i < nin; i++) {
Pali Rohár111779f2022-02-03 17:45:20 +01001205 if (buf[i] == quit[*s]) {
Luka Perkovdff289642012-05-27 11:44:51 +00001206 (*s)++;
Pali Rohár111779f2022-02-03 17:45:20 +01001207 if (!quit[*s]) {
Pali Rohár6a5d1312022-02-18 12:24:13 +01001208 nin = (i > *s) ? (i - *s) : 0;
Pali Rohár111779f2022-02-03 17:45:20 +01001209 break;
1210 }
Pali Rohár48615ba2021-07-23 11:14:20 +02001211 } else {
Pali Rohár111779f2022-02-03 17:45:20 +01001212 if (*s > i && kwboot_write(out, quit, *s - i) < 0)
Marek Behúnd3bc5c32021-09-24 23:06:41 +02001213 return -1;
1214 *s = 0;
Pali Rohár48615ba2021-07-23 11:14:20 +02001215 }
Luka Perkovdff289642012-05-27 11:44:51 +00001216 }
Pali Rohár111779f2022-02-03 17:45:20 +01001217
1218 if (i == nin)
Pali Rohár6a5d1312022-02-18 12:24:13 +01001219 nin -= (nin > *s) ? *s : nin;
Luka Perkovdff289642012-05-27 11:44:51 +00001220 }
1221
Marek Behúnd3bc5c32021-09-24 23:06:41 +02001222 if (kwboot_write(out, buf, nin) < 0)
1223 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +00001224
1225 return 0;
1226}
1227
1228static int
1229kwboot_terminal(int tty)
1230{
1231 int rc, in, s;
Marek Behúnea5b2b32021-09-24 23:06:40 +02001232 const char *quit = "\34c";
Luka Perkovdff289642012-05-27 11:44:51 +00001233 struct termios otio, tio;
1234
1235 rc = -1;
1236
1237 in = STDIN_FILENO;
1238 if (isatty(in)) {
1239 rc = tcgetattr(in, &otio);
1240 if (!rc) {
1241 tio = otio;
1242 cfmakeraw(&tio);
1243 rc = tcsetattr(in, TCSANOW, &tio);
1244 }
1245 if (rc) {
1246 perror("tcsetattr");
1247 goto out;
1248 }
1249
1250 kwboot_printv("[Type Ctrl-%c + %c to quit]\r\n",
Marek Behún6c598c32021-09-24 23:07:11 +02001251 quit[0] | 0100, quit[1]);
Luka Perkovdff289642012-05-27 11:44:51 +00001252 } else
1253 in = -1;
1254
1255 rc = 0;
1256 s = 0;
1257
1258 do {
1259 fd_set rfds;
1260 int nfds = 0;
1261
Pali Rohárc1efca42021-10-25 15:12:52 +02001262 FD_ZERO(&rfds);
Luka Perkovdff289642012-05-27 11:44:51 +00001263 FD_SET(tty, &rfds);
1264 nfds = nfds < tty ? tty : nfds;
1265
1266 if (in >= 0) {
1267 FD_SET(in, &rfds);
1268 nfds = nfds < in ? in : nfds;
1269 }
1270
1271 nfds = select(nfds + 1, &rfds, NULL, NULL, NULL);
1272 if (nfds < 0)
1273 break;
1274
1275 if (FD_ISSET(tty, &rfds)) {
1276 rc = kwboot_term_pipe(tty, STDOUT_FILENO, NULL, NULL);
1277 if (rc)
1278 break;
1279 }
1280
Marek Behún4eb55de2021-09-24 23:06:39 +02001281 if (in >= 0 && FD_ISSET(in, &rfds)) {
Luka Perkovdff289642012-05-27 11:44:51 +00001282 rc = kwboot_term_pipe(in, tty, quit, &s);
1283 if (rc)
1284 break;
1285 }
1286 } while (quit[s] != 0);
1287
Pali Roháreafc9692021-07-23 11:14:18 +02001288 if (in >= 0)
1289 tcsetattr(in, TCSANOW, &otio);
Pali Rohár049cf912021-07-23 11:14:19 +02001290 printf("\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001291out:
1292 return rc;
1293}
1294
1295static void *
Pali Rohárd9355bf2021-09-24 23:07:03 +02001296kwboot_read_image(const char *path, size_t *size, size_t reserve)
Luka Perkovdff289642012-05-27 11:44:51 +00001297{
Pali Rohár4d276012021-09-24 23:06:55 +02001298 int rc, fd;
Luka Perkovdff289642012-05-27 11:44:51 +00001299 struct stat st;
1300 void *img;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001301 off_t tot;
Luka Perkovdff289642012-05-27 11:44:51 +00001302
1303 rc = -1;
Luka Perkovdff289642012-05-27 11:44:51 +00001304 img = NULL;
1305
1306 fd = open(path, O_RDONLY);
1307 if (fd < 0)
1308 goto out;
1309
1310 rc = fstat(fd, &st);
1311 if (rc)
1312 goto out;
1313
Pali Rohárd9355bf2021-09-24 23:07:03 +02001314 img = malloc(st.st_size + reserve);
1315 if (!img)
Luka Perkovdff289642012-05-27 11:44:51 +00001316 goto out;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001317
1318 tot = 0;
1319 while (tot < st.st_size) {
1320 ssize_t rd = read(fd, img + tot, st.st_size - tot);
1321
1322 if (rd < 0)
1323 goto out;
1324
1325 tot += rd;
1326
1327 if (!rd && tot < st.st_size) {
1328 errno = EIO;
1329 goto out;
1330 }
Luka Perkovdff289642012-05-27 11:44:51 +00001331 }
1332
1333 rc = 0;
1334 *size = st.st_size;
1335out:
1336 if (rc && img) {
Pali Rohárd9355bf2021-09-24 23:07:03 +02001337 free(img);
Luka Perkovdff289642012-05-27 11:44:51 +00001338 img = NULL;
1339 }
1340 if (fd >= 0)
1341 close(fd);
1342
1343 return img;
1344}
1345
1346static uint8_t
Marek Behúnd1b0b032021-09-24 23:07:01 +02001347kwboot_hdr_csum8(const void *hdr)
Luka Perkovdff289642012-05-27 11:44:51 +00001348{
Marek Behúnd1b0b032021-09-24 23:07:01 +02001349 const uint8_t *data = hdr;
1350 uint8_t csum;
1351 size_t size;
1352
1353 size = kwbheader_size_for_csum(hdr);
Luka Perkovdff289642012-05-27 11:44:51 +00001354
1355 for (csum = 0; size-- > 0; data++)
1356 csum += *data;
1357
1358 return csum;
1359}
1360
Pali Rohár0b659e52021-10-25 15:12:55 +02001361static uint32_t *
1362kwboot_img_csum32_ptr(void *img)
1363{
1364 struct main_hdr_v1 *hdr = img;
1365 uint32_t datasz;
1366
1367 datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1368
1369 return img + le32_to_cpu(hdr->srcaddr) + datasz;
1370}
1371
1372static uint32_t
1373kwboot_img_csum32(const void *img)
1374{
1375 const struct main_hdr_v1 *hdr = img;
1376 uint32_t datasz, csum = 0;
1377 const uint32_t *data;
1378
1379 datasz = le32_to_cpu(hdr->blocksize) - sizeof(csum);
1380 if (datasz % sizeof(uint32_t))
1381 return 0;
1382
1383 data = img + le32_to_cpu(hdr->srcaddr);
1384 while (datasz > 0) {
1385 csum += le32_to_cpu(*data++);
1386 datasz -= 4;
1387 }
1388
1389 return cpu_to_le32(csum);
1390}
1391
Luka Perkovdff289642012-05-27 11:44:51 +00001392static int
Pali Rohár5725e0c2021-09-24 23:06:57 +02001393kwboot_img_is_secure(void *img)
1394{
1395 struct opt_hdr_v1 *ohdr;
1396
1397 for_each_opt_hdr_v1 (ohdr, img)
1398 if (ohdr->headertype == OPT_HDR_V1_SECURE_TYPE)
1399 return 1;
1400
1401 return 0;
1402}
1403
Pali Rohár2a8b7692021-09-24 23:07:05 +02001404static void *
Pali Roháraed39f22021-10-25 15:12:56 +02001405kwboot_img_grow_data_right(void *img, size_t *size, size_t grow)
Pali Rohár2a8b7692021-09-24 23:07:05 +02001406{
Pali Rohár2a8b7692021-09-24 23:07:05 +02001407 struct main_hdr_v1 *hdr = img;
Pali Roháraed39f22021-10-25 15:12:56 +02001408 void *result;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001409
Pali Roháraed39f22021-10-25 15:12:56 +02001410 /*
1411 * 32-bit checksum comes after end of image code, so we will be putting
1412 * new code there. So we get this pointer and then increase data size
1413 * (since increasing data size changes kwboot_img_csum32_ptr() return
1414 * value).
1415 */
1416 result = kwboot_img_csum32_ptr(img);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001417 hdr->blocksize = cpu_to_le32(le32_to_cpu(hdr->blocksize) + grow);
Pali Roháraed39f22021-10-25 15:12:56 +02001418 *size += grow;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001419
Pali Roháraed39f22021-10-25 15:12:56 +02001420 return result;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001421}
1422
Pali Rohárd9355bf2021-09-24 23:07:03 +02001423static void
1424kwboot_img_grow_hdr(void *img, size_t *size, size_t grow)
1425{
1426 uint32_t hdrsz, datasz, srcaddr;
1427 struct main_hdr_v1 *hdr = img;
Pali Rohár6fa97092021-10-25 15:13:02 +02001428 struct opt_hdr_v1 *ohdr;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001429 uint8_t *data;
1430
1431 srcaddr = le32_to_cpu(hdr->srcaddr);
1432
Pali Rohár6fa97092021-10-25 15:13:02 +02001433 /* calculate real used space in kwbimage header */
1434 if (kwbimage_version(img) == 0) {
1435 hdrsz = kwbheader_size(img);
1436 } else {
1437 hdrsz = sizeof(*hdr);
1438 for_each_opt_hdr_v1 (ohdr, hdr)
1439 hdrsz += opt_hdr_v1_size(ohdr);
1440 }
1441
Pali Rohárd9355bf2021-09-24 23:07:03 +02001442 data = (uint8_t *)img + srcaddr;
1443 datasz = *size - srcaddr;
1444
1445 /* only move data if there is not enough space */
1446 if (hdrsz + grow > srcaddr) {
1447 size_t need = hdrsz + grow - srcaddr;
1448
1449 /* move data by enough bytes */
1450 memmove(data + need, data, datasz);
1451
1452 hdr->srcaddr = cpu_to_le32(srcaddr + need);
1453 *size += need;
1454 }
1455
1456 if (kwbimage_version(img) == 1) {
1457 hdrsz += grow;
Pali Rohár6fa97092021-10-25 15:13:02 +02001458 if (hdrsz > kwbheader_size(img)) {
1459 hdr->headersz_msb = hdrsz >> 16;
1460 hdr->headersz_lsb = cpu_to_le16(hdrsz & 0xffff);
1461 }
Pali Rohárd9355bf2021-09-24 23:07:03 +02001462 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001463}
1464
1465static void *
1466kwboot_add_bin_ohdr_v1(void *img, size_t *size, uint32_t binsz)
1467{
1468 struct main_hdr_v1 *hdr = img;
1469 struct opt_hdr_v1 *ohdr;
Pali Rohár87cc3c92021-10-21 16:46:06 +02001470 uint32_t num_args;
1471 uint32_t offset;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001472 uint32_t ohdrsz;
Pali Rohár90eb9002021-10-25 15:13:01 +02001473 uint8_t *prev_ext;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001474
Pali Rohár32eec192022-01-12 18:20:52 +01001475 if (hdr->ext) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001476 for_each_opt_hdr_v1 (ohdr, img)
1477 if (opt_hdr_v1_next(ohdr) == NULL)
1478 break;
1479
Pali Rohár90eb9002021-10-25 15:13:01 +02001480 prev_ext = opt_hdr_v1_ext(ohdr);
1481 ohdr = _opt_hdr_v1_next(ohdr);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001482 } else {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001483 ohdr = (void *)(hdr + 1);
Pali Rohár90eb9002021-10-25 15:13:01 +02001484 prev_ext = &hdr->ext;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001485 }
1486
Pali Rohár87cc3c92021-10-21 16:46:06 +02001487 /*
1488 * ARM executable code inside the BIN header on some mvebu platforms
1489 * (e.g. A370, AXP) must always be aligned with the 128-bit boundary.
1490 * This requirement can be met by inserting dummy arguments into
1491 * BIN header, if needed.
1492 */
1493 offset = &ohdr->data[4] - (char *)img;
1494 num_args = ((16 - offset % 16) % 16) / sizeof(uint32_t);
1495
1496 ohdrsz = sizeof(*ohdr) + 4 + 4 * num_args + binsz + 4;
1497 kwboot_img_grow_hdr(hdr, size, ohdrsz);
1498
Pali Rohár32eec192022-01-12 18:20:52 +01001499 *prev_ext = 1;
Pali Rohár90eb9002021-10-25 15:13:01 +02001500
Pali Rohár2a8b7692021-09-24 23:07:05 +02001501 ohdr->headertype = OPT_HDR_V1_BINARY_TYPE;
1502 ohdr->headersz_msb = ohdrsz >> 16;
1503 ohdr->headersz_lsb = cpu_to_le16(ohdrsz & 0xffff);
1504
1505 memset(&ohdr->data[0], 0, ohdrsz - sizeof(*ohdr));
Pali Rohár87cc3c92021-10-21 16:46:06 +02001506 *(uint32_t *)&ohdr->data[0] = cpu_to_le32(num_args);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001507
Pali Rohár87cc3c92021-10-21 16:46:06 +02001508 return &ohdr->data[4 + 4 * num_args];
Pali Rohárd9355bf2021-09-24 23:07:03 +02001509}
1510
Pali Rohár2a8b7692021-09-24 23:07:05 +02001511static void
Pali Rohár6303a232021-10-27 20:57:02 +02001512_inject_baudrate_change_code(void *img, size_t *size, int for_data,
Pali Roháraed39f22021-10-25 15:12:56 +02001513 int old_baud, int new_baud)
Pali Rohár2a8b7692021-09-24 23:07:05 +02001514{
Pali Roháraed39f22021-10-25 15:12:56 +02001515 struct main_hdr_v1 *hdr = img;
Pali Rohár6303a232021-10-27 20:57:02 +02001516 uint32_t orig_datasz;
1517 uint32_t codesz;
Pali Roháraed39f22021-10-25 15:12:56 +02001518 uint8_t *code;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001519
Pali Rohár6303a232021-10-27 20:57:02 +02001520 if (for_data) {
Pali Roháraed39f22021-10-25 15:12:56 +02001521 orig_datasz = le32_to_cpu(hdr->blocksize) - sizeof(uint32_t);
1522
Pali Rohár6303a232021-10-27 20:57:02 +02001523 codesz = sizeof(kwboot_baud_code) +
1524 sizeof(kwboot_baud_code_data_jump);
1525 code = kwboot_img_grow_data_right(img, size, codesz);
1526 } else {
1527 codesz = sizeof(kwboot_baud_code_binhdr_pre) +
1528 sizeof(kwboot_baud_code) +
1529 sizeof(kwboot_baud_code_binhdr_post);
1530 code = kwboot_add_bin_ohdr_v1(img, size, codesz);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001531
Pali Rohár6303a232021-10-27 20:57:02 +02001532 codesz = sizeof(kwboot_baud_code_binhdr_pre);
1533 memcpy(code, kwboot_baud_code_binhdr_pre, codesz);
1534 code += codesz;
1535 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001536
Pali Rohár6303a232021-10-27 20:57:02 +02001537 codesz = sizeof(kwboot_baud_code) - 2 * sizeof(uint32_t);
1538 memcpy(code, kwboot_baud_code, codesz);
1539 code += codesz;
1540 *(uint32_t *)code = cpu_to_le32(old_baud);
1541 code += sizeof(uint32_t);
1542 *(uint32_t *)code = cpu_to_le32(new_baud);
1543 code += sizeof(uint32_t);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001544
Pali Rohár6303a232021-10-27 20:57:02 +02001545 if (for_data) {
1546 codesz = sizeof(kwboot_baud_code_data_jump) - sizeof(uint32_t);
1547 memcpy(code, kwboot_baud_code_data_jump, codesz);
1548 code += codesz;
1549 *(uint32_t *)code = hdr->execaddr;
1550 code += sizeof(uint32_t);
1551 hdr->execaddr = cpu_to_le32(le32_to_cpu(hdr->destaddr) + orig_datasz);
Pali Roháraed39f22021-10-25 15:12:56 +02001552 } else {
Pali Rohár6303a232021-10-27 20:57:02 +02001553 codesz = sizeof(kwboot_baud_code_binhdr_post);
1554 memcpy(code, kwboot_baud_code_binhdr_post, codesz);
1555 code += codesz;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001556 }
Pali Rohár2a8b7692021-09-24 23:07:05 +02001557}
1558
Pali Rohár5725e0c2021-09-24 23:06:57 +02001559static int
Pali Rohár2a8b7692021-09-24 23:07:05 +02001560kwboot_img_patch(void *img, size_t *size, int baudrate)
Luka Perkovdff289642012-05-27 11:44:51 +00001561{
Stefan Roesec74165d2015-09-29 09:19:59 +02001562 struct main_hdr_v1 *hdr;
Pali Rohár88255af2021-09-24 23:06:58 +02001563 uint32_t srcaddr;
Luka Perkovdff289642012-05-27 11:44:51 +00001564 uint8_t csum;
Marek Behún811821e2021-09-24 23:07:04 +02001565 size_t hdrsz;
Stefan Roesec74165d2015-09-29 09:19:59 +02001566 int image_ver;
Pali Rohár5725e0c2021-09-24 23:06:57 +02001567 int is_secure;
Luka Perkovdff289642012-05-27 11:44:51 +00001568
Luka Perkovdff289642012-05-27 11:44:51 +00001569 hdr = img;
1570
Marek Behún3e6117e2021-09-24 23:07:12 +02001571 if (*size < sizeof(struct main_hdr_v1))
1572 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001573
Marek Behúnfa9caec2021-09-24 23:07:00 +02001574 image_ver = kwbimage_version(img);
Pali Rohárb572ac42021-07-23 11:14:22 +02001575 if (image_ver != 0 && image_ver != 1) {
Stefan Roesec74165d2015-09-29 09:19:59 +02001576 fprintf(stderr, "Invalid image header version\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001577 goto err;
Luka Perkovdff289642012-05-27 11:44:51 +00001578 }
1579
Marek Behúnd1b0b032021-09-24 23:07:01 +02001580 hdrsz = kwbheader_size(hdr);
Stefan Roesec74165d2015-09-29 09:19:59 +02001581
Marek Behún3e6117e2021-09-24 23:07:12 +02001582 if (*size < hdrsz)
1583 goto err;
Pali Rohár12281162021-07-23 11:14:21 +02001584
Marek Behúnd1b0b032021-09-24 23:07:01 +02001585 csum = kwboot_hdr_csum8(hdr) - hdr->checksum;
Marek Behún3e6117e2021-09-24 23:07:12 +02001586 if (csum != hdr->checksum)
1587 goto err;
Stefan Roesec74165d2015-09-29 09:19:59 +02001588
Pali Rohár88255af2021-09-24 23:06:58 +02001589 srcaddr = le32_to_cpu(hdr->srcaddr);
1590
1591 switch (hdr->blockid) {
1592 case IBR_HDR_SATA_ID:
Marek Behún3e6117e2021-09-24 23:07:12 +02001593 if (srcaddr < 1)
1594 goto err;
1595
Pali Rohár88255af2021-09-24 23:06:58 +02001596 hdr->srcaddr = cpu_to_le32((srcaddr - 1) * 512);
1597 break;
1598
1599 case IBR_HDR_SDIO_ID:
1600 hdr->srcaddr = cpu_to_le32(srcaddr * 512);
1601 break;
1602
1603 case IBR_HDR_PEX_ID:
1604 if (srcaddr == 0xFFFFFFFF)
1605 hdr->srcaddr = cpu_to_le32(hdrsz);
1606 break;
Pali Rohár398d4152021-09-24 23:06:59 +02001607
1608 case IBR_HDR_SPI_ID:
1609 if (hdr->destaddr == cpu_to_le32(0xFFFFFFFF)) {
1610 kwboot_printv("Patching destination and execution addresses from SPI/NOR XIP area to DDR area 0x00800000\n");
1611 hdr->destaddr = cpu_to_le32(0x00800000);
1612 hdr->execaddr = cpu_to_le32(0x00800000);
1613 }
1614 break;
Pali Rohár88255af2021-09-24 23:06:58 +02001615 }
1616
Pali Rohárd9355bf2021-09-24 23:07:03 +02001617 if (hdrsz > le32_to_cpu(hdr->srcaddr) ||
Marek Behún3e6117e2021-09-24 23:07:12 +02001618 *size < le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize))
1619 goto err;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001620
Pali Rohár0b659e52021-10-25 15:12:55 +02001621 if (kwboot_img_csum32(img) != *kwboot_img_csum32_ptr(img))
1622 goto err;
1623
Pali Rohár5725e0c2021-09-24 23:06:57 +02001624 is_secure = kwboot_img_is_secure(img);
Luka Perkovdff289642012-05-27 11:44:51 +00001625
Pali Rohár5725e0c2021-09-24 23:06:57 +02001626 if (hdr->blockid != IBR_HDR_UART_ID) {
1627 if (is_secure) {
1628 fprintf(stderr,
1629 "Image has secure header with signature for non-UART booting\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001630 goto err;
Pali Rohár5725e0c2021-09-24 23:06:57 +02001631 }
1632
1633 kwboot_printv("Patching image boot signature to UART\n");
1634 hdr->blockid = IBR_HDR_UART_ID;
1635 }
Luka Perkovdff289642012-05-27 11:44:51 +00001636
Pali Rohár3024ebd2021-10-22 12:37:47 +02001637 if (!is_secure) {
Pali Rohár71db3622021-10-25 15:12:58 +02001638 if (image_ver == 1) {
1639 /*
1640 * Tell BootROM to send BootROM messages to UART port
1641 * number 0 (used also for UART booting) with default
1642 * baudrate (which should be 115200) and do not touch
1643 * UART MPP configuration.
1644 */
Pali Roháre4b8fca2022-01-25 18:13:13 +01001645 hdr->flags |= 0x1;
Pali Rohár71db3622021-10-25 15:12:58 +02001646 hdr->options &= ~0x1F;
1647 hdr->options |= MAIN_HDR_V1_OPT_BAUD_DEFAULT;
1648 hdr->options |= 0 << 3;
1649 }
Pali Rohár3024ebd2021-10-22 12:37:47 +02001650 if (image_ver == 0)
1651 ((struct main_hdr_v0 *)img)->nandeccmode = IBR_HDR_ECC_DISABLED;
1652 hdr->nandpagesize = 0;
1653 }
1654
Pali Rohár2a8b7692021-09-24 23:07:05 +02001655 if (baudrate) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001656 if (image_ver == 0) {
1657 fprintf(stderr,
1658 "Cannot inject code for changing baudrate into v0 image header\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001659 goto err;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001660 }
1661
1662 if (is_secure) {
1663 fprintf(stderr,
1664 "Cannot inject code for changing baudrate into image with secure header\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001665 goto err;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001666 }
1667
1668 /*
1669 * First inject code that changes the baudrate from the default
1670 * value of 115200 Bd to requested value. This code is inserted
1671 * as a new opt hdr, so it is executed by BootROM after the
1672 * header part is received.
1673 */
1674 kwboot_printv("Injecting binary header code for changing baudrate to %d Bd\n",
1675 baudrate);
Pali Roháraed39f22021-10-25 15:12:56 +02001676 _inject_baudrate_change_code(img, size, 0, 115200, baudrate);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001677
1678 /*
1679 * Now inject code that changes the baudrate back to 115200 Bd.
Pali Roháraed39f22021-10-25 15:12:56 +02001680 * This code is appended after the data part of the image, and
1681 * execaddr is changed so that it is executed before U-Boot
1682 * proper.
Pali Rohár2a8b7692021-09-24 23:07:05 +02001683 */
1684 kwboot_printv("Injecting code for changing baudrate back\n");
Pali Roháraed39f22021-10-25 15:12:56 +02001685 _inject_baudrate_change_code(img, size, 1, baudrate, 115200);
Pali Rohár2a8b7692021-09-24 23:07:05 +02001686
Pali Rohárf625a222021-10-25 15:12:57 +02001687 /* Update the 32-bit data checksum */
1688 *kwboot_img_csum32_ptr(img) = kwboot_img_csum32(img);
1689
Pali Rohár2a8b7692021-09-24 23:07:05 +02001690 /* recompute header size */
1691 hdrsz = kwbheader_size(hdr);
1692 }
1693
Pali Rohárd9355bf2021-09-24 23:07:03 +02001694 if (hdrsz % KWBOOT_XM_BLKSZ) {
Pali Rohár085d9ce2021-10-25 15:13:00 +02001695 size_t grow = KWBOOT_XM_BLKSZ - hdrsz % KWBOOT_XM_BLKSZ;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001696
1697 if (is_secure) {
1698 fprintf(stderr, "Cannot align image with secure header\n");
Marek Behún3e6117e2021-09-24 23:07:12 +02001699 goto err;
Pali Rohárd9355bf2021-09-24 23:07:03 +02001700 }
1701
1702 kwboot_printv("Aligning image header to Xmodem block size\n");
Pali Rohár085d9ce2021-10-25 15:13:00 +02001703 kwboot_img_grow_hdr(img, size, grow);
Pali Rohárd9355bf2021-09-24 23:07:03 +02001704 }
1705
Marek Behúnd1b0b032021-09-24 23:07:01 +02001706 hdr->checksum = kwboot_hdr_csum8(hdr) - csum;
Luka Perkovdff289642012-05-27 11:44:51 +00001707
Pali Rohárd9355bf2021-09-24 23:07:03 +02001708 *size = le32_to_cpu(hdr->srcaddr) + le32_to_cpu(hdr->blocksize);
Marek Behún3e6117e2021-09-24 23:07:12 +02001709 return 0;
1710err:
1711 errno = EINVAL;
1712 return -1;
Luka Perkovdff289642012-05-27 11:44:51 +00001713}
1714
1715static void
1716kwboot_usage(FILE *stream, char *progname)
1717{
1718 fprintf(stream,
Kevin Smith6c7c1ba2016-02-16 21:28:17 +00001719 "Usage: %s [OPTIONS] [-b <image> | -D <image> ] [-B <baud> ] <TTY>\n",
Stefan Roesebb5c4282014-10-22 12:13:21 +02001720 progname);
Luka Perkovdff289642012-05-27 11:44:51 +00001721 fprintf(stream, "\n");
Stefan Roesebb5c4282014-10-22 12:13:21 +02001722 fprintf(stream,
1723 " -b <image>: boot <image> with preamble (Kirkwood, Armada 370/XP)\n");
Stefan Roesebb5c4282014-10-22 12:13:21 +02001724 fprintf(stream,
1725 " -D <image>: boot <image> without preamble (Dove)\n");
1726 fprintf(stream, " -d: enter debug mode\n");
1727 fprintf(stream, " -a: use timings for Armada XP\n");
Stefan Roesef7f509d2015-05-29 13:25:04 +02001728 fprintf(stream, " -q <req-delay>: use specific request-delay\n");
1729 fprintf(stream, " -s <resp-timeo>: use specific response-timeout\n");
Kevin Smith4d31a842016-02-16 21:28:19 +00001730 fprintf(stream,
1731 " -o <block-timeo>: use specific xmodem block timeout\n");
Luka Perkovdff289642012-05-27 11:44:51 +00001732 fprintf(stream, "\n");
1733 fprintf(stream, " -t: mini terminal\n");
1734 fprintf(stream, "\n");
1735 fprintf(stream, " -B <baud>: set baud rate\n");
1736 fprintf(stream, "\n");
1737}
1738
1739int
1740main(int argc, char **argv)
1741{
1742 const char *ttypath, *imgpath;
Pali Rohár4d276012021-09-24 23:06:55 +02001743 int rv, rc, tty, term;
Luka Perkovdff289642012-05-27 11:44:51 +00001744 void *bootmsg;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001745 void *debugmsg;
Luka Perkovdff289642012-05-27 11:44:51 +00001746 void *img;
1747 size_t size;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001748 size_t after_img_rsv;
1749 int baudrate;
Pali Rohár48953362022-01-25 18:13:07 +01001750 int prev_optind;
1751 int c;
Luka Perkovdff289642012-05-27 11:44:51 +00001752
1753 rv = 1;
1754 tty = -1;
1755 bootmsg = NULL;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001756 debugmsg = NULL;
Luka Perkovdff289642012-05-27 11:44:51 +00001757 imgpath = NULL;
1758 img = NULL;
1759 term = 0;
Luka Perkovdff289642012-05-27 11:44:51 +00001760 size = 0;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001761 after_img_rsv = KWBOOT_XM_BLKSZ;
1762 baudrate = 115200;
Luka Perkovdff289642012-05-27 11:44:51 +00001763
Pali Rohár73ae7aa2021-11-05 23:30:42 +01001764 printf("kwboot version %s\n", PLAIN_VERSION);
1765
Luka Perkovdff289642012-05-27 11:44:51 +00001766 kwboot_verbose = isatty(STDOUT_FILENO);
1767
1768 do {
Pali Rohár48953362022-01-25 18:13:07 +01001769 prev_optind = optind;
1770 c = getopt(argc, argv, "hbptaB:dD:q:s:o:");
Luka Perkovdff289642012-05-27 11:44:51 +00001771 if (c < 0)
1772 break;
1773
1774 switch (c) {
1775 case 'b':
Pali Rohár48953362022-01-25 18:13:07 +01001776 if (imgpath || bootmsg || debugmsg)
1777 goto usage;
Luka Perkovdff289642012-05-27 11:44:51 +00001778 bootmsg = kwboot_msg_boot;
Pali Rohár48953362022-01-25 18:13:07 +01001779 if (prev_optind == optind)
1780 goto usage;
Pali Rohárcf91fa82022-02-07 10:12:24 +01001781 if (optind < argc - 1 && argv[optind] && argv[optind][0] != '-')
Pali Rohár48953362022-01-25 18:13:07 +01001782 imgpath = argv[optind++];
Luka Perkovdff289642012-05-27 11:44:51 +00001783 break;
1784
Stefan Roesebb5c4282014-10-22 12:13:21 +02001785 case 'D':
Pali Rohár48953362022-01-25 18:13:07 +01001786 if (imgpath || bootmsg || debugmsg)
1787 goto usage;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001788 bootmsg = NULL;
1789 imgpath = optarg;
1790 break;
1791
1792 case 'd':
Pali Rohár48953362022-01-25 18:13:07 +01001793 if (imgpath || bootmsg || debugmsg)
1794 goto usage;
Stefan Roesebb5c4282014-10-22 12:13:21 +02001795 debugmsg = kwboot_msg_debug;
1796 break;
1797
Luka Perkovdff289642012-05-27 11:44:51 +00001798 case 'p':
Pali Rohár4d276012021-09-24 23:06:55 +02001799 /* nop, for backward compatibility */
Luka Perkovdff289642012-05-27 11:44:51 +00001800 break;
1801
1802 case 't':
1803 term = 1;
1804 break;
1805
Stefan Roesebb5c4282014-10-22 12:13:21 +02001806 case 'a':
1807 msg_req_delay = KWBOOT_MSG_REQ_DELAY_AXP;
1808 msg_rsp_timeo = KWBOOT_MSG_RSP_TIMEO_AXP;
1809 break;
1810
Stefan Roesef7f509d2015-05-29 13:25:04 +02001811 case 'q':
1812 msg_req_delay = atoi(optarg);
1813 break;
1814
1815 case 's':
1816 msg_rsp_timeo = atoi(optarg);
1817 break;
1818
Kevin Smith4d31a842016-02-16 21:28:19 +00001819 case 'o':
1820 blk_rsp_timeo = atoi(optarg);
1821 break;
1822
Luka Perkovdff289642012-05-27 11:44:51 +00001823 case 'B':
Pali Rohár2a8b7692021-09-24 23:07:05 +02001824 baudrate = atoi(optarg);
Luka Perkovdff289642012-05-27 11:44:51 +00001825 break;
1826
1827 case 'h':
1828 rv = 0;
1829 default:
1830 goto usage;
1831 }
1832 } while (1);
1833
Pali Rohár577506c2022-01-25 18:13:12 +01001834 if (!bootmsg && !term && !debugmsg && !imgpath)
Luka Perkovdff289642012-05-27 11:44:51 +00001835 goto usage;
1836
Luka Perkovdff289642012-05-27 11:44:51 +00001837 ttypath = argv[optind++];
1838
Pali Rohár48953362022-01-25 18:13:07 +01001839 if (optind != argc)
1840 goto usage;
1841
Pali Rohár2a8b7692021-09-24 23:07:05 +02001842 tty = kwboot_open_tty(ttypath, imgpath ? 115200 : baudrate);
Luka Perkovdff289642012-05-27 11:44:51 +00001843 if (tty < 0) {
1844 perror(ttypath);
1845 goto out;
1846 }
1847
Pali Rohár2a8b7692021-09-24 23:07:05 +02001848 if (baudrate == 115200)
1849 /* do not change baudrate during Xmodem to the same value */
1850 baudrate = 0;
1851 else
1852 /* ensure we have enough space for baudrate change code */
Pali Rohár6303a232021-10-27 20:57:02 +02001853 after_img_rsv += sizeof(struct opt_hdr_v1) + 8 + 16 +
1854 sizeof(kwboot_baud_code_binhdr_pre) +
1855 sizeof(kwboot_baud_code) +
1856 sizeof(kwboot_baud_code_binhdr_post) +
Pali Rohárd8774392021-10-25 15:12:54 +02001857 KWBOOT_XM_BLKSZ +
Pali Rohárd8774392021-10-25 15:12:54 +02001858 sizeof(kwboot_baud_code) +
Pali Rohár6303a232021-10-27 20:57:02 +02001859 sizeof(kwboot_baud_code_data_jump) +
Pali Rohárd8774392021-10-25 15:12:54 +02001860 KWBOOT_XM_BLKSZ;
Pali Rohár2a8b7692021-09-24 23:07:05 +02001861
Luka Perkovdff289642012-05-27 11:44:51 +00001862 if (imgpath) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001863 img = kwboot_read_image(imgpath, &size, after_img_rsv);
Luka Perkovdff289642012-05-27 11:44:51 +00001864 if (!img) {
1865 perror(imgpath);
1866 goto out;
1867 }
Luka Perkovdff289642012-05-27 11:44:51 +00001868
Pali Rohár2a8b7692021-09-24 23:07:05 +02001869 rc = kwboot_img_patch(img, &size, baudrate);
Luka Perkovdff289642012-05-27 11:44:51 +00001870 if (rc) {
1871 fprintf(stderr, "%s: Invalid image.\n", imgpath);
1872 goto out;
1873 }
1874 }
1875
Stefan Roesebb5c4282014-10-22 12:13:21 +02001876 if (debugmsg) {
1877 rc = kwboot_debugmsg(tty, debugmsg);
1878 if (rc) {
1879 perror("debugmsg");
1880 goto out;
1881 }
Willy Tarreaue8f8a7c2018-07-03 12:10:30 -04001882 } else if (bootmsg) {
Luka Perkovdff289642012-05-27 11:44:51 +00001883 rc = kwboot_bootmsg(tty, bootmsg);
1884 if (rc) {
1885 perror("bootmsg");
1886 goto out;
1887 }
1888 }
1889
1890 if (img) {
Pali Rohár2a8b7692021-09-24 23:07:05 +02001891 rc = kwboot_xmodem(tty, img, size, baudrate);
Luka Perkovdff289642012-05-27 11:44:51 +00001892 if (rc) {
1893 perror("xmodem");
1894 goto out;
1895 }
1896 }
1897
1898 if (term) {
1899 rc = kwboot_terminal(tty);
1900 if (rc && !(errno == EINTR)) {
1901 perror("terminal");
1902 goto out;
1903 }
1904 }
1905
1906 rv = 0;
1907out:
1908 if (tty >= 0)
1909 close(tty);
1910
1911 if (img)
Pali Rohárd9355bf2021-09-24 23:07:03 +02001912 free(img);
Luka Perkovdff289642012-05-27 11:44:51 +00001913
1914 return rv;
1915
1916usage:
1917 kwboot_usage(rv ? stderr : stdout, basename(argv[0]));
1918 goto out;
1919}