Re: [PATCH v12 6/7] doc: spacemit: flash on K1 SoC based boards

[Yixun Lan <dlan@kernel.org>]

hi Eric,

On 17:11 Sun 06 Sep     , Eric Chung wrote:
> Add document on how to flash images into eMMC of K1 SoC based boards.
> 
> Signed-off-by: Eric Chung <eric.chung@riscstar.com>
> 
> ---
> v9:
> - Add to generate the partition table of SD card.
> v3:
> - Add document on how to flash images into SD card.
> ---
>  board/spacemit/k1/MAINTAINERS |   2 +-
>  doc/board/spacemit/index.rst  |   1 +
>  doc/board/spacemit/k1-mmc.rst | 271 ++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 273 insertions(+), 1 deletion(-)
> 
> diff --git a/board/spacemit/k1/MAINTAINERS b/board/spacemit/k1/MAINTAINERS
> index 4b2bc4ecfc10..e12288a206e0 100644
> --- a/board/spacemit/k1/MAINTAINERS
> +++ b/board/spacemit/k1/MAINTAINERS
> @@ -6,7 +6,7 @@ S:	Maintained
>  F:	arch/riscv/dts/k1-*-u-boot.dtsi
>  F:	board/spacemit/k1/
>  F:	configs/spacemit_k1_defconfig
> -F:	doc/board/spacemit/bananapi-f3.rst
> +F:	doc/board/spacemit/
>  F:	drivers/gpio/spacemit_gpio.c
>  F:	drivers/i2c/k1_i2c.c
>  F:	drivers/mmc/spacemit_sdhci.c
> diff --git a/doc/board/spacemit/index.rst b/doc/board/spacemit/index.rst
> index a5e35ee12ab6..71854e5735bd 100644
> --- a/doc/board/spacemit/index.rst
> +++ b/doc/board/spacemit/index.rst
> @@ -6,5 +6,6 @@ SpacemiT
>     :maxdepth: 1
>  
>     bananapi-f3
> +   k1-mmc
>     k1-spl
>  
> diff --git a/doc/board/spacemit/k1-mmc.rst b/doc/board/spacemit/k1-mmc.rst
> new file mode 100644
> index 000000000000..0be5d5fa1c39
> --- /dev/null
> +++ b/doc/board/spacemit/k1-mmc.rst
> @@ -0,0 +1,271 @@
> +.. SPDX-License-Identifier: GPL-2.0-or-later
> +
> +SpacemiT K1 eMMC and SD Card Boot Guide
> +=======================================
> +
> +This guide covers two separate methods for booting and flashing U-Boot on
> +SpacemiT K1 based boards:
> +
> +1. **eMMC Flash**: Flashing U-Boot and SPL images to eMMC via USB fastboot.
> +2. **SD Card Boot**: Creating a bootable Bianbu SD card and optionally
> +   replacing U-Boot on the card.
> +
> +Tested boards: Banana Pi BPI-F3, MusePi Pro.
> +
> +
> +Chapter 1: eMMC Flash (U-Boot via USB Fastboot)
> +===============================================
> +
> +SpacemiT K1 U-Boot Flash Guide
> +==============================
> +
> +This guide explains how to flash U-Boot on SpacemiT K1 based boards. It covers
> +flashing images via USB fastboot.
> +
> +.. note::
> +
> +   This procedure flashes images to eMMC over USB fastboot. The fastboot
> +   function is not enabled in our SPL yet, so the download stage runs the
> +   SpacemiT released SPL; our built FSBL.bin and fit.itb are the images
> +   written to eMMC and used on the next normal boot.
> +
..
> +Prerequisites
> +~~~~~~~~~~~~~
.. first label here

> +
> +- A SpacemiT K1 board with USB Type-C and UART access
> +- USB-to-UART adapter (3.3V TTL)
> +- ``minicom`` or equivalent serial terminal, configured at 115200 8N1
> +- ``fastboot`` and ``flashserver`` tool on the host
> +
> +Hardware Setup
> +~~~~~~~~~~~~~~
> +


...


> +Chapter 2: SD Card Boot
> +=======================
> +
> +
> +SpacemiT K1 Bianbu SD Card Image Flashing and U-Boot Update Guide
> +==================================================================
> +
> +This guide explains how to prepare a bootable SD card with Bianbu OS for
> +SpacemiT K1 based boards and how to replace the U-Boot binary on the SD
> +card with a custom build.
> +
> +Prerequisites
> +~~~~~~~~~~~~~
second one, so this trigger a CI warning, snip from the log..

looking for now-outdated files... /builds/u-boot/custodians/u-boot-spacemit/doc/board/spacemit/k1-mmc.rst:186: WARNING: duplicate label board/spacemit/k1-mmc:prerequisites,

so how about adding an additional name of this specific procedure?
for first:   Prerequisites to flash
for second:  Prerequisites to boot

-- 
Yixun Lan (dlan)