[libcamera-devel] [RFC PATCH] Documentation: IPU3 IPA Design guide

[Kieran Bingham]

On 16/09/2021 14:41, Laurent Pinchart wrote:
> Hi Kieran,
> 
> On Thu, Sep 16, 2021 at 01:36:43PM +0100, Kieran Bingham wrote:
>> On 13/09/2021 15:29, Umang Jain wrote:
>>> On 9/13/21 3:00 AM, Kieran Bingham wrote:
>>>> The IPU3 IPA implements the basic 3a using the ImgU ISP.
>>> 3a or 3A?
>>>>
>>>> Provide an overview document to describe it's operations, and provide a
>>>> block diagram to help visualise how the components are put together to
>>>> assist any new developers exploring the code.
>>>>
>>>> Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
>>>>
>>>> ---
>>>> This is really just an RFC: Particularly:
>>>>
>>>>   - Should this content actually live in Documentation?
>>>>     or is it more suited to a page under src/ipa/ipu3/...
>>>
>>>
>>> I would probably keep it under Documentation/ but there is already a IPA
>>> writing guide. So maybe we need a new dir, to document overviews of
>>> existing IPAs?
>>
>> Indeed, the existing document really describes the IPA IPC interfaces, I
>> wonder if it should be renamed ...
>>
>> The aim of this is to provide some overview on how the IPU3 IPA operates
>> from a higher level.
>>
>> Along with the discussions with Laurent, I'm going to move this to
>> src/ipa/ipu3/ipu3-ipa-design-guide.rst for now.
> 
> I had assumed it would be moved to ipu3.cpp. Seems like explicit
> communication would work better than assumptions.

Isn't it always ;-)

> I'm not sure I want to set a precedent of storing .rst documentation
> somewhere else than in the Documentation/ directory. If you want to keep
> it as .rst, I think it should stay there, and get compiled to catch
> errors. My preference would be ipu3.cpp though.

I don't mind it being in the 'doxygen' in ipu3.cpp - but then I /really/
conflict with what Jean-Michel has been doing, while this was aiming to
be separate.

I'll try to tackle that for v3, and incorporate src/ipa/ipu3 into the
Doxygen build ... and try to figure out if I can generate a distinct
'page' for this overview.


>> That will keep the overview document in the actual component for now.

--
Kieran