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

[Tom Rini]

On Tue, Jul 25, 2023 at 05:00:15PM -0500, Nishanth Menon wrote:
> 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 :(

Ugh, how many platforms is that variable valid for?

> 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 was thinking something more literal and just not have specific
copy/paste instructions as you have to fill in a real path to the other
files.  Just a link back to the K3 doc portion about building the other
things.

> 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?

Bah!  Then we really need to figure out how to do something that is not
literal copy/paste/minor edit, for every platform.  But I've not played
with doing something like that before.

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

Hunh?  This isn't even a we have different SRAMs thing.  Pick some
values, use them every time, and note that they could be modified if
needed, but it's not suggested as there's many implications to doing so.
Especially since this is the SPL map.

-- 
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/f9f170e5/attachment.sig>