kwboot.1 2.5 KB

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