[PATCH 6/6] doc: board: ti: Add beagleplay documentation

[Tom Rini]

On Tue, Jul 25, 2023 at 01:52:53PM -0500, Nishanth Menon wrote:

> Add base documentation for beagleplay
> 
> Signed-off-by: Nishanth Menon <nm at ti.com>
> ---
>  doc/board/ti/am62x_beagleplay.rst | 169 ++++++++++++++++++++++++++++++
>  doc/board/ti/k3.rst               |   1 +
>  2 files changed, 170 insertions(+)
>  create mode 100644 doc/board/ti/am62x_beagleplay.rst

I think we have some room to improve things here, some right now and
some as follow-up work.

[snip]
> +Sources:
> +--------
> +1. Trusted Firmware-A:
> +	Tree: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/
> +	Branch: master
> +
> +2. OP-TEE:
> +	Tree: https://github.com/OP-TEE/optee_os.git
> +	Branch: master
> +
> +3. U-Boot:
> +	Tree: https://source.denx.de/u-boot/u-boot
> +	Branch: master
> +
> +4. TI Linux Firmware:
> +	Tree: git://git.ti.com/processor-firmware/ti-linux-firmware.git
> +	Branch: ti-linux-firmware
> +
> +Build procedure:
> +----------------
> +1. Trusted Firmware-A:
> +
> +.. code-block:: bash
> +
> + $ make CROSS_COMPILE=aarch64-none-linux-gnu- ARCH=aarch64 PLAT=k3 \
> +        TARGET_BOARD=lite SPD=opteed
> +
> +2. OP-TEE:
> +
> +.. code-block:: bash
> +
> + $ make PLATFORM=k3 CFG_ARM64_core=y CROSS_COMPILE=arm-none-linux-gnueabihf- \
> +        CROSS_COMPILE64=aarch64-none-linux-gnu-

So, we have some generic wording on how to build TF-A and OP-TEE up in
doc/board/ti/k3.rst. It should be made clearer if needed that unless
otherwise indicated, top of tree is expected to be used for TF-A/OP-TEE
and ti-linux-firmware for the ti-linux-firmware repo. Then just state
that TF-A should be which of {lite|generic|j784s4} as it is a $family
device.  And we then drop much of the duplication here.

> +3. U-Boot:
> +
> +* 3.1 R5:
> +
> +.. code-block:: bash
> +
> + $ make ARCH=arm am62x_beagleplay_r5_defconfig
> + $ make ARCH=arm CROSS_COMPILE=arm-none-linux-gnueabihf- \
> +        BINMAN_INDIRS=<path/to/ti-linux-firmware>
> +
> +* 3.2 A53:
> +
> +.. code-block:: bash
> +
> + $ make ARCH=arm am62x_beagleplay_a53_defconfig
> + $ make ARCH=arm CROSS_COMPILE=aarch64-none-linux-gnu- \
> +        BL31=<path/to/trusted-firmware-a/dir>/build/k3/lite/release/bl31.bin \
> +        TEE=<path/to/optee_os/dir>/out/arm-plat-k3/core/tee-raw.bin \
> +        BINMAN_INDIRS=<path/to/ti-linux-firmware>

And can drop this.

> +Target Images
> +--------------
> +Copy the below images to an SD card and boot:
> +
> +* tiboot3-am62x-gp-evm.bin from step 3.1 as tiboot3.bin
> +* tispl.bin_unsigned from step 3.2 as tispl.bin
> +* u-boot.img_unsigned from step 3.2 as uboot.img

Then reword this to be "from R5" or "from Axx" build.

> +Image formats:
> +--------------
> +
> +The Image format follows the standard AM62X image format [1]_.
> +
> +A53 SPL DDR Memory Layout
> +-------------------------

This is unchanged for all AM62 platforms, yes? That should be in a
generic am62 doc.

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20230725/52136c2b/attachment.sig>