[PATCH u-boot-marvell 28/29] doc/kwboot.1: Update man page

[Pali Rohár]

On Friday 27 August 2021 10:13:01 Pali Rohár wrote:
> On Friday 27 August 2021 13:37:54 Chris Packham wrote:
> > On Thu, Aug 26, 2021 at 1:46 AM Marek Behún <marek.behun at nic.cz> wrote:
> > >
> > > Update man page for the kwboot utility.
> > >
> > > Signed-off-by: Marek Behún <marek.behun at nic.cz>
> > > ---
> > >  doc/kwboot.1 | 58 ++++++++++++++++++++++++++++++++++------------------
> > >  1 file changed, 38 insertions(+), 20 deletions(-)
> > >
> > > diff --git a/doc/kwboot.1 b/doc/kwboot.1
> > > index 1e9ca268f7..cf113b8b27 100644
> > > --- a/doc/kwboot.1
> > > +++ b/doc/kwboot.1
> > > @@ -1,21 +1,22 @@
> > > -.TH KWBOOT 1 "2012-05-19"
> > > +.TH KWBOOT 1 "2021-08-25"
> > >
> > >  .SH NAME
> > > -kwboot \- Boot Marvell Kirkwood SoCs over a serial link.
> > > +kwboot \- Boot Marvell Kirkwood (and others 32-bit) SoCs over a serial link.
> > >  .SH SYNOPSIS
> > >  .B kwboot
> > >  .RB [ "-b \fIimage\fP" ]
> > > -.RB [ "-p" ]
> > >  .RB [ "-t" ]
> > 
> > I notice there's no mention of -d might be good to add it while we're here.
> 
> Option -d is broken and does not work. So not mentioning it here is a
> good idea. Maybe I could look at it and try to fix in future...

Anyway, it looks like that A385 bootrom has bugs in debug console and so
-d is on this SoC unusable. When I enter into debug mode, boorom
somehow does not send output from (debug) commands over UART. But it
sends ECHO over UART...

> > >  .RB [ "-B \fIbaudrate\fP" ]
> > >  .RB \fITTY\fP
> > >  .SH "DESCRIPTION"
> > >
> > > -The \fBmkimage\fP program boots boards based on Marvell's Kirkwood
> > > -platform over their integrated UART. Boot image files will typically
> > > +The \fBkwboot\fP program boots boards based on Marvell's 32-bit
> > > +platforms including Orion, Kirkwood, Dove, Discovery, AXP, A37x, A38x
> > > +and A39x over their integrated UART. Boot image files will typically
> > >  contain a second stage boot loader, such as U-Boot. The image file
> > >  must conform to Marvell's BootROM firmware image format
> > > -(\fIkwbimage\fP), created using a tool such as \fBmkimage\fP.
> > > +(\fIkwbimage v0\fP or \fIv1\fP), created using a tool such as
> > > +\fBmkimage\fP.
> > >
> > >  Following power-up or a system reset, system BootROM code polls the
> > >  UART for a brief period of time, sensing a handshake message which
> > > @@ -36,25 +37,23 @@ by the second-stage loader.
> > >  Handshake; then upload file \fIimage\fP over \fITTY\fP.
> > >
> > >  Note that for the encapsulated boot code to be executed, \fIimage\fP
> > > -must be of type "UART boot" (0x69). Boot images of different types,
> > > -such as backup images of vendor firmware downloaded from flash memory
> > > -(type 0x8B), will not work (or not as expected). See \fB-p\fP for a
> > > -workaround.
> > > +must be of type "UART boot" (0x69). The \fBkwboot\fP program changes
> > > +this type automatically, unless the \fIimage\fP is signed, in which
> > > +case it cannot be changed.
> > >
> > >  This mode writes handshake status and upload progress indication to
> > > -stdout.
> > > +stdout. It is possible that \fIimage\fP contains an optional binary
> > > +code in it's header which may also print some output via UART (for
> > > +example U-Boot SPL does this). In such a case, this output is also
> > > +written to stdout after the header is sent.
> > >
> > >  .TP
> > >  .BI "\-p"
> > > -In combination with \fB-b\fP, patches the header in \fIimage\fP prior
> > > -to upload, to "UART boot" type.
> > > +Obsolete. Does nothing.
> > >
> > > -This option attempts on-the-fly conversion of some none-UART image
> > > -types, such as images which were originally formatted to be stored in
> > > -flash memory.
> > > -
> > > -Conversion is performed in memory. The contents of \fIimage\fP will
> > > -not be altered.
> > > +In the past, when this option was used, the program patched the header
> > > +in the image prior upload, to "UART boot" type. This is now done by
> > > +default.
> > >
> > >  .TP
> > >  .BI "\-t"
> > > @@ -69,7 +68,22 @@ after receiving 'ctrl-\\' followed by 'c' from console input.
> > >
> > >  .TP
> > >  .BI "\-B \fIbaudrate\fP"
> > > -Adjust the baud rate on \fITTY\fP. Default rate is 115200.
> > > +If used in combination with \fB-b\fP, inject into the image header
> > > +code that changes baud rate to \fIbaudrate\fP after uploading image
> > > +header, and code that changes the baud rate back to the default
> > > +(115200 Bd) before executing payload, and also adjust the baud rate
> > > +on \fITTY\fP correspondingly. This can make the upload significantly
> > > +faster.
> > > +
> > > +If used in combination with \fB-t\fP, adjust the baud rate to
> > > +\fIbaudrate\fP on \fITTY\fP before starting terminal.
> > > +
> > > +If both \fB-b\fP and \fB-t\fP are used, the baud rate is changed
> > > +back to 115200 after the upload.
> > > +
> > > +Tested values for \fIbaudrate\fP for Armada 38x include: 115200,
> > > +230400, 460800, 500000, 576000, 921600, 1000000, 1152000, 1500000,
> > > +2000000, 2500000, 3125000, 4000000 and 5150000.
> > >
> > >  .SH "SEE ALSO"
> > >  .PP
> > > @@ -82,3 +96,7 @@ Daniel Stodden <daniel.stodden at gmail.com>
> > >  Luka Perkov <luka at openwrt.org>
> > >  .br
> > >  David Purdy <david.c.purdy at gmail.com>
> > > +.br
> > > +Pali Rohár <pali at kernel.org>
> > > +.br
> > > +Marek Behún <marek.behun at nic.cz>
> > > --
> > > 2.31.1
> > >