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