Re: [PATCH v5 04/10] arm_ffa: introduce Arm FF-A low-level driver

Abdellatif El Khlifi
2022-10-14T10:41:04Z

On Mon, Oct 03, 2022 at 11:22:33AM -0400, Tom Rini wrote:
> On Mon, Oct 03, 2022 at 10:49:23AM +0200, Jens Wiklander wrote:
> > On Mon, Sep 26, 2022 at 03:08:21PM +0100, Abdellatif El Khlifi wrote:
> [snip]
> > > diff --git a/doc/README.ffa.drv b/doc/README.ffa.drv
> > > new file mode 100644
> > > index 0000000000..1c0a33deb8
> > > --- /dev/null
> > > +++ b/doc/README.ffa.drv
> > > @@ -0,0 +1,160 @@
> > > +Arm FF-A Driver
> > > +====================
> > > +
> > > +Introduction
> > > +--------------------
> > > +
> > > +FF-A stands for Firmware Framework for Arm A-profile processors.
> > > +
> > > +FF-A specifies interfaces that enable a pair of software sandboxes to communicate with each other. A sandbox aka partition could
> > > +be a VM in the Normal or Secure world, an application in S-EL0, or a Trusted OS in S-EL1.
> >
> > These lines are a bit long, from the coding guide lines:
> > The preferred limit on the length of a single line is 80 columns.
>
> Line length isn't a huge problem, we follow what the linux kernel allows
> these days. But, this needs to be in proper sphinx format, under
> doc/arch perhaps (unless Heinrich has another idea) and 'make htmldocs'
> must pass (I see a lot of formatting errors that will get tripped up on
> and fail).

In patchset v6, FF-A documentation is at doc/arch/arm64.ffa.rst and comes with Sphinx format.
'make htmldocs' passes.

>
> --
> Tom