From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 474A0C432BE for ; Fri, 27 Aug 2021 01:38:20 +0000 (UTC) Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 7141960F4F for ; Fri, 27 Aug 2021 01:38:19 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 7141960F4F Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=lists.denx.de Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 1D04283210; Fri, 27 Aug 2021 03:38:17 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="Ucw6YJ30"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 218208322B; Fri, 27 Aug 2021 03:38:15 +0200 (CEST) Received: from mail-il1-x135.google.com (mail-il1-x135.google.com [IPv6:2607:f8b0:4864:20::135]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 4C4FA82EBB for ; Fri, 27 Aug 2021 03:38:07 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=judge.packham@gmail.com Received: by mail-il1-x135.google.com with SMTP id v2so5337036ilg.12 for ; Thu, 26 Aug 2021 18:38:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=+NPXZZAPHpwGuDE/aJzFLNyD0FWnuwQRR1hDUN6TsXQ=; b=Ucw6YJ307HloZ5tH6fqhmWbpt0kQc6dgLB5u1az/cjb0GcIv3uVCiBryNuXfVW9rKz 9UzFOZkOcF4o4bMAb+tmWok7y02YLPwx4vROb9+HRIV3bphSaS6V+W2/BhTAZ8VrLSpI yW1LvaxKbS0IIa07jm3t5OBnVKze+hnYq5Hk/m/DoHxiVvzY7Acz2HMFaC2yzqUE20F0 QXLj9X/7M+2EQNv8TLVD2c6hrpFAaG0FS9Q6lBRVpfOk1Y0nqsnS/od8EADnekpnChem AWqx81SxL6634o3p5niD+/TAEt+cL4zNWqoW8gZR/QuA98e6cU/Pg+9c2OkDg7XiaKeD fE7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=+NPXZZAPHpwGuDE/aJzFLNyD0FWnuwQRR1hDUN6TsXQ=; b=X9IxJ2FA2vllQvz0BnEgSQuMRMULS6jYYxKF9UsTc/3szg7uZxXjRI2uyIqKe8W4qD 8Yia0eRUkHkLvWgsKwvYGYqkNyRI5cs6hBFqZkgYL+l3oPnb7BYK5GFIAEtjU44vGlIl q2wyMWsOdOEmU9KIQ1Yb90qLimOG7z4XSq13ZcAWE2quH7KrpDC2sQvmBAOZ/nU+WX0S U+qw7pSp6G08JP8Lc9OKuUgsDs4JvJOHtPnBR1cSJvUrfzQ8Xwz0RQVeJ+gj7+b30eBa fSgFzLAAiVx7EZ94shkxAniqMsI4y3nu8OFmzND3kM0ICpidegz0B7I/zn3VXQx8Xm+k TXQQ== X-Gm-Message-State: AOAM533gvD+HERnIaBxDywbEfUnlhL+ep8UrmxW3VpiXTuIQ2xuwfS0c C0/EeXJwJoDJokp3LIpoHM77zN1RReVPkSSoPik= X-Google-Smtp-Source: ABdhPJyTDv+KeZIV9EESORTL7kdWPxzY9VMoXiaH38fMkyjypqXgvx00x7Sdv7HLICeJ8iSJCBhgj9AmmtXKlSGGuH4= X-Received: by 2002:a05:6e02:1d06:: with SMTP id i6mr4787064ila.113.1630028285840; Thu, 26 Aug 2021 18:38:05 -0700 (PDT) MIME-Version: 1.0 References: <20210825134634.3959-1-marek.behun@nic.cz> <20210825134634.3959-29-marek.behun@nic.cz> In-Reply-To: <20210825134634.3959-29-marek.behun@nic.cz> From: Chris Packham Date: Fri, 27 Aug 2021 13:37:54 +1200 Message-ID: Subject: Re: [PATCH u-boot-marvell 28/29] doc/kwboot.1: Update man page To: =?UTF-8?B?TWFyZWsgQmVow7pu?= Cc: Stefan Roese , u-boot , =?UTF-8?B?UGF2b2wgUm9ow6Fy?= , Baruch Siach , Dennis Gilmore , Mario Six , Jon Nettleton Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.2 at phobos.denx.de X-Virus-Status: Clean On Thu, Aug 26, 2021 at 1:46 AM Marek Beh=C3=BAn wrote= : > > Update man page for the kwboot utility. > > Signed-off-by: Marek Beh=C3=BAn > --- > 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 l= ink. > .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. > .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 > Luka Perkov > .br > David Purdy > +.br > +Pali Roh=C3=A1r > +.br > +Marek Beh=C3=BAn > -- > 2.31.1 >