[PATCH V4 8/8] doc: board: ti: Add BeaglePlay documentation

[Nishanth Menon]

On 19:04-20230824, Simon Glass wrote:
> Hi Nishanth,
> 
> On Tue, 22 Aug 2023 at 12:43, Nishanth Menon <nm at ti.com> wrote:
> >
> > Add base documentation for BeaglePlay
> >
> > Signed-off-by: Nishanth Menon <nm at ti.com>
> > ---
> > Cc: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
> >
> > Changes Since V3:
> > * Updated documentation to give a more clear overview of MMC partitions
> >   and flashing information.
> > * Added OpenOCD debug documentation
> > * Added LED status information and indication of various boot stages
> >
> > V3: https://lore.kernel.org/all/20230815164440.2713726-5-nm@ti.com/
> > V2: https://lore.kernel.org/u-boot/20230727234446.3651836-5-nm@ti.com/
> > V1: https://lore.kernel.org/all/20230725185253.2123433-7-nm@ti.com/
> >
> >  doc/board/ti/am62x_beagleplay.rst    | 256 ++++++++++
> >  doc/board/ti/img/beagleplay_emmc.svg | 697 +++++++++++++++++++++++++++
> >  doc/board/ti/k3.rst                  |   1 +
> >  3 files changed, 954 insertions(+)
> >  create mode 100644 doc/board/ti/am62x_beagleplay.rst
> >  create mode 100644 doc/board/ti/img/beagleplay_emmc.svg
> >
> > diff --git a/doc/board/ti/am62x_beagleplay.rst b/doc/board/ti/am62x_beagleplay.rst
> > new file mode 100644
> > index 000000000000..5adb7b4c9ace
> > --- /dev/null
> > +++ b/doc/board/ti/am62x_beagleplay.rst
> > @@ -0,0 +1,256 @@
> > +.. SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
> > +.. sectionauthor:: Nishanth Menon <nm at ti.com>
> > +
> > +AM62x Beagleboard.org Beagleplay
> > +================================
> > +
> > +Introduction:
> > +-------------
> > +
> > +BeagleBoard.org BeaglePlay is an easy to use, affordable open source
> > +hardware single board computer based on the Texas Instruments AM625
> > +SoC that allows you to create connected devices that work even at long
> > +distances using IEEE 802.15.4g LR-WPAN and IEEE 802.3cg 10Base-T1L.
> > +Expansion is provided over open standards based mikroBUS, Grove and
> > +QWIIC headers among other interfaces.
> > +
> > +Further information can be found at:
> > +
> > +* Product Page: https://beagleplay.org/
> > +* Hardware documentation: https://git.beagleboard.org/beagleplay/beagleplay
> > +
> > +Boot Flow:
> > +----------
> > +Below is the pictorial representation of boot flow:
> > +
> > +.. image:: img/boot_diagram_k3_current.svg
> > +  :alt: Boot flow diagram
> > +
> > +- On this platform, 'TI Foundational Security' (TIFS) functions as the
> > +  security enclave master while 'Device Manager' (DM), also known as the
> > +  'TISCI server' in "TI terminology", offers all the essential services.
> > +  The A53/M4F (Aux core) sends requests to TIFS/DM to accomplish these
> > +  services, as illustrated in the diagram above.
> > +
> > +Sources:
> > +--------
> > +.. include::  k3.rst
> > +    :start-after: .. k3_rst_include_start_boot_sources
> > +    :end-before: .. k3_rst_include_end_boot_sources
> > +
> > +Build procedure:
> > +----------------
> > +0. Setup the environment variables:
> > +
> > +.. include::  k3.rst
> > +    :start-after: .. k3_rst_include_start_common_env_vars_desc
> > +    :end-before: .. k3_rst_include_end_common_env_vars_desc
> > +
> > +.. include::  k3.rst
> > +    :start-after: .. k3_rst_include_start_board_env_vars_desc
> > +    :end-before: .. k3_rst_include_end_board_env_vars_desc
> > +
> > +Set the variables corresponding to this platform:
> > +
> > +.. include::  k3.rst
> > +    :start-after: .. k3_rst_include_start_common_env_vars_defn
> > +    :end-before: .. k3_rst_include_end_common_env_vars_defn
> > +.. code-block:: bash
> > +
> > + $ export UBOOT_CFG_CORTEXR="am62x_evm_r5_defconfig beagleplay_r5.config"
> > + $ export UBOOT_CFG_CORTEXA="am62x_evm_a53_defconfig beagleplay_a53.config"
> > + $ export TFA_BOARD=lite
> > + $ # we dont use any extra TFA parameters
> > + $ unset TFA_EXTRA_ARGS
> > + $ export OPTEE_PLATFORM=k3-am62x
> > + $ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
> > +
> > +.. include::  am62x_sk.rst
> > +    :start-after: .. am62x_evm_rst_include_start_build_steps
> > +    :end-before: .. am62x_evm_rst_include_end_build_steps
> > +
> > +Target Images
> > +--------------
> > +Copy the below images to an SD card and boot:
> > +
> > +* tiboot3-am62x-gp-evm.bin from R5 build as tiboot3.bin
> > +* tispl.bin_unsigned from Cortex-A build as tispl.bin
> > +* u-boot.img_unsigned from Cortex-A build as uboot.img
> 
> I just noticed - I think this should be u-boot.img

Thank you for catching.

> 
> Also I tried the mmc instructions and managed to brick the board. Is
Hmm.. This is just documenting what Robert has in his scripts[1]

> there a recovery procedure?

Oopsie.. Sorry you had to hit that..

> 
> I suppose I should have tries it on an SD card first. I thought that
> was what I was doing, but I didn't know about the internal mmc...

Recovery currently involves booting off sd and flashing the emmc up :(
unfortunately.. USB DFU etc are still work in progress.

A ready to go image such as [2] emmc flasher image might help speed
things up.

[1] https://git.beagleboard.org/beagleboard/repos-arm64/-/blob/main/bb-u-boot-beagleplay-mainline/suite/bookworm/debian/install-emmc.sh
[2] https://rcn-ee.net/rootfs/debian-arm64-12-bookworm-xfce-v5.10-ti/2023-08-24/
emmc flasher image

-- 
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3  1A34 DDB5 849D 1736 249D