]>
Commit | Line | Data |
---|---|---|
d131ad68 LP |
1 | .TH KWBOOT 1 "2012-05-19" |
2 | ||
3 | .SH NAME | |
4 | kwboot \- Boot Marvell Kirkwood SoCs over a serial link. | |
5 | .SH SYNOPSIS | |
6 | .B kwboot | |
7 | .RB [ "-b \fIimage\fP" ] | |
8 | .RB [ "-p" ] | |
9 | .RB [ "-t" ] | |
10 | .RB [ "-B \fIbaudrate\fP" ] | |
11 | .RB \fITTY\fP | |
12 | .SH "DESCRIPTION" | |
13 | ||
14 | The \fBmkimage\fP program boots boards based on Marvell's Kirkwood | |
15 | platform over their integrated UART. Boot image files will typically | |
16 | contain a second stage boot loader, such as U-Boot. The image file | |
17 | must conform to Marvell's BootROM firmware image format | |
18 | (\fIkwbimage\fP), created using a tool such as \fBmkimage\fP. | |
19 | ||
20 | Following power-up or a system reset, system BootROM code polls the | |
21 | UART for a brief period of time, sensing a handshake message which | |
22 | initiates an image upload. This program sends this boot message until | |
23 | it receives a positive acknowledgement. The image is transfered using | |
24 | Xmodem. | |
25 | ||
26 | Additionally, this program implements a minimal terminal mode, which | |
27 | can be used either standalone, or entered immediately following boot | |
28 | image transfer completion. This is often useful to catch early boot | |
29 | messages, or to manually interrupt a default boot procedure performed | |
30 | by the second-stage loader. | |
31 | ||
32 | .SH "OPTIONS" | |
33 | ||
34 | .TP | |
35 | .BI "\-b \fIimage\fP" | |
36 | Handshake; then upload file \fIimage\fP over \fITTY\fP. | |
37 | ||
38 | Note that for the encapsulated boot code to be executed, \fIimage\fP | |
39 | must be of type "UART boot" (0x69). Boot images of different types, | |
40 | such as backup images of vendor firmware downloaded from flash memory | |
41 | (type 0x8B), will not work (or not as expected). See \fB-p\fP for a | |
42 | workaround. | |
43 | ||
44 | This mode writes handshake status and upload progress indication to | |
45 | stdout. | |
46 | ||
47 | .TP | |
48 | .BI "\-p" | |
49 | In combination with \fB-b\fP, patches the header in \fIimage\fP prior | |
50 | to upload, to "UART boot" type. | |
51 | ||
52 | This option attempts on-the-fly conversion of some none-UART image | |
53 | types, such as images which were originally formatted to be stored in | |
54 | flash memory. | |
55 | ||
56 | Conversion is performed in memory. The contents of \fIimage\fP will | |
57 | not be altered. | |
58 | ||
59 | .TP | |
60 | .BI "\-t" | |
61 | Run a terminal program, connecting standard input and output to | |
62 | .RB \fITTY\fP. | |
63 | ||
64 | If used in combination with \fB-b\fP, terminal mode is entered | |
65 | immediately following a successful image upload. | |
66 | ||
67 | If standard I/O streams connect to a console, this mode will terminate | |
68 | after receiving 'ctrl-\\' followed by 'c' from console input. | |
69 | ||
70 | .TP | |
71 | .BI "\-B \fIbaudrate\fP" | |
72 | Adjust the baud rate on \fITTY\fP. Default rate is 115200. | |
73 | ||
74 | .SH "SEE ALSO" | |
75 | .PP | |
76 | \fBmkimage\fP(1) | |
77 | ||
78 | .SH "AUTHORS" | |
79 | ||
80 | Daniel Stodden <daniel.stodden@gmail.com> | |
81 | .br | |
3fdf7596 | 82 | Luka Perkov <luka@openwrt.org> |
d131ad68 LP |
83 | .br |
84 | David Purdy <david.c.purdy@gmail.com> |