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 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 smtp.lore.kernel.org (Postfix) with ESMTPS id A414EC433EF for ; Tue, 14 Dec 2021 01:08:20 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id A4EDB82A59; Tue, 14 Dec 2021 02:08:17 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=fail (p=none dis=none) header.from=arm.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Received: by phobos.denx.de (Postfix, from userid 109) id 9A6FA82F5E; Tue, 14 Dec 2021 02:08:15 +0100 (CET) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by phobos.denx.de (Postfix) with ESMTP id F36E081EB2 for ; Tue, 14 Dec 2021 02:08:09 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=arm.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=andre.przywara@arm.com Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 12FAF6D; Mon, 13 Dec 2021 17:08:09 -0800 (PST) Received: from slackpad.fritz.box (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 74F173F5A1; Mon, 13 Dec 2021 17:08:07 -0800 (PST) Date: Tue, 14 Dec 2021 01:07:58 +0000 From: Andre Przywara To: Jernej =?UTF-8?B?xaBrcmFiZWM=?= Cc: Jagan Teki , Simon Glass , Tom Rini , u-boot@lists.denx.de, Samuel Holland , Chen-Yu Tsai , Maxime Ripard , Icenowy Zheng , linux-sunxi@lists.linux.dev Subject: Re: [PATCH] sunxi: add board documentation Message-ID: <20211214010758.37ea91b4@slackpad.fritz.box> In-Reply-To: <3402428.iIbC2pHGDl@kista> References: <20211213010322.10726-1-andre.przywara@arm.com> <3402428.iIbC2pHGDl@kista> Organization: Arm Ltd. X-Mailer: Claws Mail 3.17.1 (GTK+ 2.24.31; x86_64-slackware-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.38 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 Mon, 13 Dec 2021 18:20:37 +0100 Jernej =C5=A0krabec wrote: Hi Jernej, thanks for having a look! > Dne ponedeljek, 13. december 2021 ob 02:03:22 CET je Andre Przywara=20 > napisal(a): > > Add some long overdue instructions for building and installing U-Boot on > > Allwinner SoC based boards. > > This describes the building process, including TF-A and crust, plus > > installation to SD card, eMMC and SPI flash, both from Linux and U-Boot > > itself. Also describe FEL booting. > >=20 > > Signed-off-by: Andre Przywara > > --- > > Hi, > >=20 > > please have a look whether this makes sense. Feel free to just try =20 > something, > > and point out ambiguities or missing bits. For missing topics, please > > send a follow-up patch ;-) =20 >=20 > This documentation seems to include all of board/sunxi/README.sunxi64 and= =20 > README.nand. I think it would make sense to remove those files. If any fi= le gets=20 > out of sync for any reason, it would be very confusing for end user. Indeed, I think README.sunxi64 is redundant now. I didn't look at README.nand too closely, but since I don't even mention NAND, I don't think it can be removed just yet. I guess I just convert it to RST and move it into this directory. > I would also remove all non-essential command parameters, so all commands= are=20 > as simple as possible. Power users will know about them anyway and non-sk= illed=20 > users might perceive that it's harder that it really is. I have in mind "= -j5 - > s" for make, "-v -p" for sunxi-fel I see, makes sense. > and DEBUG=3D1 for TF-A (maybe I missed some=20 > places). Actually, DEBUG=3D1 could be mentioned afterwards as troubleshoo= ting=20 > step. In my experience, stable version of TF-A was never source of boot i= ssues=20 > nor it provided any useful information for debugging anything else. Well, I'd tend to keep DEBUG=3D1 enabled, this lists the regulators enabled, which helps debugging. Also in the past DEBUG=3D0 was very silent, which wasn't helpful to verify that TF-A actually started. Do you typically build or recommend DEBUG=3D0? > Some comments bellow. >=20 > >=20 > > Also this is quite long, shall this be split up in two (or more) files? > >=20 > > This is what rst.ninjs.org made of it, if you prefer to read it formatt= ed: > > https://paste.c-net.org/PleasantNeedy > >=20 > > Cheers, > > Andre > >=20 > > doc/board/allwinner/index.rst | 9 + > > doc/board/allwinner/sunxi.rst | 304 ++++++++++++++++++++++++++++++++++ > > 2 files changed, 313 insertions(+) > > create mode 100644 doc/board/allwinner/index.rst > > create mode 100644 doc/board/allwinner/sunxi.rst > >=20 > > diff --git a/doc/board/allwinner/index.rst b/doc/board/allwinner/index.= rst > > new file mode 100644 > > index 00000000000..7352ccd5c0a > > --- /dev/null > > +++ b/doc/board/allwinner/index.rst > > @@ -0,0 +1,9 @@ > > +.. SPDX-License-Identifier: GPL-2.0+ > > + > > +Allwinner (sunxi) boards > > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D > > + > > +.. toctree:: > > + :maxdepth: 2 > > + > > + sunxi > > diff --git a/doc/board/allwinner/sunxi.rst b/doc/board/allwinner/sunxi.= rst > > new file mode 100644 > > index 00000000000..693eb32e168 > > --- /dev/null > > +++ b/doc/board/allwinner/sunxi.rst > > @@ -0,0 +1,304 @@ > > +.. SPDX-License-Identifier: GPL-2.0+ > > +.. Copyright (C) 2021 Arm Ltd. > > + > > +Allwinner SoC based boards > > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D > > +For boards using an Allwinner ARM based SoC ("sunxi"), the U-Boot build > > +system generates a single integrated image file: ``u-boot-sunxi-with- = =20 > spl.bin.`` > > +This file can be used on SD cards, eMMC devices, SPI flash and for the > > +USB-OTG based boot method (FEL). To build this file: > > + > > +* For 64-bit SoCs, build Trusted Firmware (TF-A, formerly known as ATF= ) =20 > first, > > + you will need its ``bl31.bin``. See below for more details. > > +* Optionally on 64-bit SoCs, build the crust management processor firm= ware. > > +* Build U-Boot:: > > + > > + $ export BL31=3D/path/to/bl31.bin # required for 64-bit SoCs > > + $ export SCP=3D/src/crust/build/scp/scp.bin # optional for some 64-b= it =20 > SoCs >=20 > NIT: I guess path for SCP could be in same form, at least first part? Yeah, makes sense. > > + $ make _defconfig > > + $ make -j5 -s > > +* Transfer to an uSD card (see below for more details):: > > + > > + $ dd if=3Du-boot-sunxi-with-spl.bin of=3D/dev/sdX bs=3D8k seek=3D1 = =20 >=20 > Most, if not all, distros require root for above command, so $ -> #? I se= e=20 > that you used # below. Alternative would be to prepend command with sudo,= =20 > which is imo more beginners friendly. Ah, good catch! > > +* Boot and enjoy! > > + > > +For more details, and alternative boot locations or installations, see= =20 > below. > > + > > +Building Arm Trusted Firmware (TF-A) > > +------------------------------------ > > +Boards using a 64-bit Soc (A64, H5, H6, H616, R329) require the BL31 s= tage =20 > of > > +the `Arm Trusted Firmware-A`_ firmware. This provides the reference > > +implementation of secure software for Armv8-A, offering PSCI and SMCCC > > +services. Allwinner support is fully mainlined. To build bl31.bin:: > > + > > + $ git clone https://git.trustedfirmware.org/TF-A/trusted-firmware-a.= git > > + $ cd trusted-firmware-a > > + $ make CROSS_COMPILE=3Daarch64-linux-gnu- PLAT=3Dsun50i_a64 DEBUG=3D1 > > + $ export BL31=3D$(pwd)/build/sun50i_a64/debug/bl31.bin > > + > > +The target platform (``PLAT=3D``) for A64 and H5 SoCs is sun50i_a64, f= or the =20 > H6 > > +sun50i_h6, for the H616 sun50i_h616, and for the R329 sun50i_r329. Use= :: > > + > > + $ find plat/allwinner -name platform.mk > > + > > +to find all supported platforms. `docs/plat/allwinner.rst`_ contains m= ore > > +information and lists some build options. > > + > > +Building the Crust management processor firmware > > +------------------------------------------------ > > +For some SoCs and boards, the integrated OpenRISC management controlle= r can > > +be used to provide power management services, foremost suspend to RAM. > > +There is a community supported Open Source implementation called `crus= t`_, > > +which runs on most SoCs featuring a management controller. > > + > > +This firmware part is optional, setting the SCP environment variable to > > +/dev/null avoids the warning message when building without one. > > + > > +To build crust's scp.bin, you need an OpenRISC (or1k) cross compiler, = =20 > then:: > > + > > + $ git clone https://github.com/crust-firmware/crust.git > > + $ cd crust > > + $ make _defconfig > > + $ make CROSS_COMPILE=3Dor1k-none-elf- scp =20 >=20 > I guess it would be good to point out that compiler prefix may not be the= same=20 > on all distros. For example, Arch packages this compiler and proper prefi= x=20 > there is or1k-elf- which also works just fine. I feel I shouldn't spend too much time on this, instead just point to crust's README. Thanks, Andre >=20 > Best regards, > Jernej >=20 > > + $ export SCP=3D$(pwd)/build/scp/scp.bin > > + > > +Find a list of supported board configurations in the `configs/`_ direc= tory. > > + > > +Building the U-Boot image > > +------------------------- > > +Find the U-Boot defconfig file for your board first. Those files live = in > > +the ``configs/`` directory; you can grep for the stub name of the devi= cetree > > +file, if you know that, or for the SoC name to find the right version:: > > + > > + $ git grep -l MACH_SUN8I_H3 configs > > + $ git grep -l sun50i-h6-orangepi-3 configs > > + > > +The `linux-sunxi`_ wiki also lists the name of the defconfig file in t= he > > +respective board page. Then use this defconfig file to create the .con= fig > > +file, and build the image:: > > + > > + $ make _defconfig > > + $ make -j5 > > + > > +For 64-bit boards, this requires either the BL31 environment variable = to be > > +set (as shown above in the TF-A build example), or it to be supplied o= n the > > +build command line:: > > + > > + $ make BL31=3D/src/tf-a.git/build/sun50i_h616/debug/bl31.bin -j5 -s > > + > > +The same applies to the (optional) SCP firmware. > > + > > +The file containing everything you need is called ``u-boot-sunxi-with-= =20 > spl.bin``, > > +you will find it in the root folder of your U-Boot (build) tree. Excep= t for > > +raw NAND flash devices this very same file can be used for any boot so= urce. > > +It will contain the SPL image, fitted with the proper signature recogn= ised =20 > by > > +the BROM, and the required checksum. Also it will contain at least U-B= oot > > +proper, either wrapped in the legacy U-Boot image format, or in a FIT = =20 > image. > > +The board's devicetree is also included, either appended to the U-Boot= =20 > proper > > +image, or contained in the FIT image. If required by the SoC, this FIT= file =20 > will > > +also include the other firmware images. > > + > > +Installing U-Boot > > +----------------- > > + > > +Installing on a (micro-) SD card > > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > > +All Allwinner SoCs will try to find a boot image at sector 16 (8KB) of > > +an SD card, connected to the first MMC controller. To transfer the gen= erated > > +image to an SD card, from any Linux device (including the board itself= ) =20 > with > > +an (micro-)SD card reader, type:: > > + > > + # dd if=3Du-boot-sunxi-with-spl.bin of=3D/dev/sdX bs=3D1k seek=3D8 > > + > > +``/dev/sdx`` needs to be replaced with the block device name of the SD= card > > +reader. On some machines this could be ``/dev/mmcblkX``. > > +Newer SoCs (starting from H3), also look at sector 256 (128KB) for the > > +signature (after having checked the 8KB location). Installing the firm= ware > > +there has the advantage of not overlapping with a GPT partition table.= =20 > Simply > > +replace the "``seek=3D8``" above with "``seek=3D128``". > > + > > +You can also use an existing (mainline) U-Boot to write to the SD card= . =20 > Load > > +the generated U-Boot image somewhere into DRAM (via ``ext4load``, =20 > ``fatload``, > > +or ``tftpboot``), then write to MMC device 0:: > > + > > + =3D> fatload mmc 0:1 $kernel_addr_r u-boot-sunxi-with-spl.bin > > + =3D> mmc dev 0 > > + =3D> mmc write $kernel_addr_r 0x10 0x7f0 > > + > > +To use the alternative boot location on newer SoCs:: > > + > > + =3D> mmc write $kernel_addr_r 0x100 0x700 > > + > > +Installing on eMMC (on-board flash memory) > > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > > +Some boards have a soldered eMMC chip, some other boards have an eMMC = =20 > socket > > +to receive an optional eMMC module. U-Boot can be installed to those c= hips, > > +to boot without an SD card inserted. The Boot-ROM can boot either from= the > > +regular user data partition, or from one of the separate eMMC boot =20 > partitions. > > +U-Boot can be installed either from a running Linux instance on the de= vice, > > +from a running (mainline) U-Boot, or via an adapter for the (removable) > > +eMMC module. > > + > > +Installing on an eMMC user data partition from Linux > > +```````````````````````````````````````````````````` > > +If you have a running Linux instance on the device, and have somehow c= opied > > +over the image file to that device, you can write the image directly i= nto =20 > the > > +eMMC device from there. > > +Find the name of the block device file first, it is one of the > > +``/dev/mmcblk`` devices. eMMC devices typically also list a > > +``/dev/mmcblkboot0`` partition (see below), this helps you to tell = it =20 > apart > > +from the SD card device. > > +To install onto the user data partition:: > > + > > + # dd if=3Du-boot-sunxi-with-spl.bin of=3D/dev/dev/mmcblkX bs=3D1k = seek=3D8 > > + > > +Similar to SD cards, the BROM in newer SoCs (H3 and above) also checks > > +sector 256 of an eMMC, so you can use "``seek=3D128``" as well. > > + > > +Installing on an eMMC boot partition from Linux > > +``````````````````````````````````````````````` > > +In the following examples, ``/dev/mmcblkX`` needs to be replaced with = the =20 > block > > +device name of the eMMC device. The eMMC device can be recognised by a= lso > > +listing the boot partitions (``/dev/mmcblkXboot0``) in ``/proc/ =20 > partitions``. > > + > > +To allow booting from one of the eMMC boot partitions, this one needs = to be > > +enabled first. This only needs to be done once, as this setting is > > +persistent, even though the boot partition can be disabled or changed = again > > +any time later:: > > + > > + # apt-get install mmc-utils > > + # mmc bootbus set single_hs x1 x4 /dev/mmcblkX > > + # mmc bootpart enable 1 1 /dev/mmcblkX > > + > > +The first "1" in the last command points to the boot partition number = to be > > +used, typically devices offer two boot partitions. > > + > > +By default Linux disables write access to the boot partitions, to prev= ent > > +accidental overwrites. You need to disable the write protection (until= the > > +next reboot), then can write the U-Boot image to the *first* sector of= the > > +selected boot partition:: > > + > > + # echo 0 > /sys/block/mmcblkXboot0/force_ro > > + # dd if=3Du-boot-sunxi-with-spl.bin of=3D/dev/mmcblkXboot0 bs=3D1k > > + > > +Installing on an eMMC user data partition from U-Boot > > +````````````````````````````````````````````````````` > > +You can also write the generated image file to an SD card, boot the de= vice > > +from there, and burn the very same image to the eMMC device from U-Boo= t. > > +The following commands copy the image from the SD card to the eMMC dev= ice:: > > + > > + =3D> mmc dev 0 > > + =3D> mmc read $kernel_addr_r 0x10 0x7f0 > > + =3D> mmc dev 1 > > + =3D> mmc write $kernel_addr_r 0x10 0x7f0 > > + > > +You can also copy an image from the 8K offset of an SD card to the 128K > > +offset of the eMMC (or any combination), just change the "``0x10 0x7f0= ``" =20 > above > > +to "``0x100 0x700``", respectively. Of course the image file can be lo= aded =20 > via > > +any other loading method, including ``fatload``, ``ext4load``, =20 > ``tftpboot``. > > + > > +Installing on an eMMC boot partition from U-Boot > > +```````````````````````````````````````````````` > > +The selected eMMC boot partition needs to be initially enabled first (= same > > +as in Linux above), you can do this from U-Boot with:: > > + > > + =3D> mmc dev 1 > > + =3D> mmc bootbus 1 1 0 0 > > + =3D> mmc partconf 1 1 1 1 > > + > > +The first "1" in both commands denotes the MMC device number. The seco= nd "1" > > +in the partconf command sets the required ``BOOT_ACK`` option, the las= t two =20 > "1"s > > +selects the active boot partition and the target for the next data acc= ess, > > +respectively. So for the next "``mmc write``" command to address one o= f the =20 > boot > > +partitions, the last number must either be "1" or "2", "0" would switc= h =20 > (back) > > +to the normal user data partition. > > + > > +Then load the ``u-boot-sunxi-with-spl.bin`` image file into DRAM, eith= er by > > +reading directly from an SD card or eMMC user data partition, or from a > > +file system or TFTP (see above), and transfer it to the boot partition= :: > > + > > + =3D> tftpboot $kernel_addr_r u-boot-sunxi-with-spl.bin > > + =3D> mmc write $kernel_addr_r 0 0x7f0 > > + > > +After that the device should boot from the selected boot partition, wh= ich =20 > takes > > +precedence over booting from the user data partition. > > + > > +Installing on SPI flash > > +^^^^^^^^^^^^^^^^^^^^^^^ > > +Some devices have a SPI NOR flash chip soldered on the board. If it is > > +connected to the SPI0 pins on PortC, the BROM can also boot from there. > > +Typically the SPI flash has the lowest boot priority, so SD card and e= MMC > > +devices will be considered first. > > + > > +Installing on SPI flash from Linux > > +`````````````````````````````````` > > +If the devicetree enables and describes the SPI flash device, you can = access > > +the SPI flash content from Linux, using the `MTD utils`_:: > > + > > + # apt-get install mtd-utils > > + # mtdinfo > > + # mtd_debug erase /dev/mtdX 0 0xf0000 > > + # mtd_debug write /dev/mtdX 0 0xf0000 u-boot-sunxi-with-spl.bin > > + > > +``/dev/mtdX`` needs to be replaced with the respective device name, as= =20 > listed > > +in the output of ``mtdinfo``. > > + > > +Installing on SPI flash from U-Boot > > +``````````````````````````````````` > > +If SPI flash driver and command support (``CONFIG_CMD_SF``) is enabled= in =20 > the > > +U-Boot configuration, the image file can be installed via U-Boot as we= ll:: > > + > > + =3D> tftpboot $kernel_addr_r u-boot-sunxi-with-spl.bin > > + =3D> sf probe > > + =3D> sf erase 0 +0xf0000 > > + =3D> sf write $kernel_addr_r 0 $filesize > > + > > +Installing on SPI flash via USB in FEL mode > > +``````````````````````````````````````````` > > +If the device is in FEL mode (see below), the SPI flash can also be fi= lled > > +with the sunxi-fel utility, via an USB(-OTG) cable from any USB host = =20 > machine:: > > + > > + $ sunxi-fel -v -p spiflash-write 0 u-boot-sunxi-with-spl.bin > > + > > +Booting via the USB(-OTG) FEL mode > > +---------------------------------- > > +If none of the boot locations checked by the BROM contain a medium or = valid > > +signature, the BROM will enter the so-called FEL mode, in which it will > > +listen to commands from a host on the SoC's USB-OTG interface. Those = =20 > commands > > +allow to read from and write to arbitrary memory locations, also to st= art > > +execution at any address, which allows to bootstrap a board solely via= an > > +USB cable. Some boards feature a "FEL" or "U-Boot" button, which forces > > +FEL mode despite a valid boot location being present. The same can be = =20 > achieved > > +via a `magic binary`_ on an SD card, which allows to enter FEL mode on= any > > +board. > > + > > +To use FEL booting, let the board enter FEL mode, via any of the menti= oned > > +methods (no boot media, FEL button, SD card with FEL binary), then con= nect > > +a USB cable to the board's USB OTG port. Some boards (Pine64, TV boxes= ) =20 > don't > > +have a separate OTG port. In this case mostly one of the USB-A ports is > > +connected to USB0, and can be used via a non-standard USB-A to USB-A c= able. > > + > > +Typically there is no on-board indication of FEL mode, other than a ne= w USB > > +device appearing on the connected host computer. The USB vendor/device= ID > > +is 1f3a:efe8. Mostly this will identify as "sunxi SoC OTG connector in > > +FEL/flashing mode", but older distributions might still report "Onda > > +(unverified) V972 tablet in flashing mode". > > + > > +The `sunxi_fel`_ tool implements the proprietary BROM protocol, and al= lows =20 > to > > +bootstrap U-Boot by just providing our venerable u-boot-sunxi-with- =20 > spl.bin:: > > + > > + $ sudo apt-get install sunxi-tools > > + $ sunxi-fel -v -p uboot u-boot-sunxi-with-spl.bin > > + > > +Additional binaries like a kernel, an initial ramdisk or a boot script= , can > > +also be uploaded via FEL, check the Wiki's `FEL page`_ for more detail= s. > > + > > +.. _`Arm Trusted Firmware-A`: https://www.trustedfirmware.org/project= s/tf-a/ > > +.. _`docs/plat/allwinner.rst`: https://trustedfirmware-a.readthedocs.i= o/en/ =20 > latest/plat/allwinner.html > > +.. _`crust`: https://github.com/crust-firmware/crust > > +.. _`configs/`: https://github.com/crust-firmware/crust/tree/master/co= nfigs > > +.. _`linux-sunxi`: https://linux-sunxi.org > > +.. _`MTD utils`: http://www.linux-mtd.infradead.org/ > > +.. _`magic binary`: https://github.com/linux-sunxi/sunxi-tools/raw/mas= ter/ =20 > bin/fel-sdboot.sunxi > > +.. _`sunxi_fel`: https://github.com/linux-sunxi/sunxi-tools > > +.. _`FEL page`: https://linux-sunxi.org/FEL/USBBoot > > --=20 > > 2.17.6 > >=20 > > =20 >=20 >=20 >=20