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

[Nishanth Menon <nm@ti.com>]

On 17:35-20230725, Tom Rini wrote:
> On Tue, Jul 25, 2023 at 01:52:53PM -0500, Nishanth Menon wrote:
> 
[...]

> > +
> > +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.

Also, Robert pointed out I missed K3_PM_SYSTEM_SUSPEND=1 :(

I am wondering how to let people read a single page and know all the
steps to build the components needed instead of referring to other docs.

Are you thinking something like:
https://gist.github.com/nmenon/8c883ebf37a5d6021400cce9d76bfc35

I am not a sphinx expert, is this something you'd not like?

I have had feedback from multiple folks saying one single doc showing
all the build commands for the platform is what they are trying to get..
so this might be a good trade-off, perhaps?


[..]
> > +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.

I really did think of it, but then, if we did have config fragments, I
could have reused things, but at the moment, it is a different
defconfig.. hence, though it is same at the moment, I cant guarantee it.


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