[RFC/PATCH,2/3] Documentation: Move platform support to user documentation

25968 diff mbox series

Platform support is split in three places: a short list in the libcamera
architecture document (in the developers section), a page for the ISP
feature matrix, and a page for camera sensors. Centralize all this in
the users section by moving the short platform support list to a
standalone page, and move the other two pages as children in the index.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/index.rst                  |  5 +----
 Documentation/libcamera_architecture.rst | 18 -----------------
 Documentation/meson.build                |  1 +
 Documentation/platform_support.rst       | 25 ++++++++++++++++++++++++
 4 files changed, 27 insertions(+), 22 deletions(-)
 create mode 100644 Documentation/platform_support.rst

Hi Laurent

On Mon, Jan 26, 2026 at 09:01:40PM +0200, Laurent Pinchart wrote:
> Platform support is split in three places: a short list in the libcamera
> architecture document (in the developers section), a page for the ISP
> feature matrix, and a page for camera sensors. Centralize all this in
> the users section by moving the short platform support list to a
> standalone page, and move the other two pages as children in the index.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/index.rst                  |  5 +----
>  Documentation/libcamera_architecture.rst | 18 -----------------
>  Documentation/meson.build                |  1 +
>  Documentation/platform_support.rst       | 25 ++++++++++++++++++++++++
>  4 files changed, 27 insertions(+), 22 deletions(-)
>  create mode 100644 Documentation/platform_support.rst
>
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 03c3d0b4aff6..988feedf8387 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -9,8 +9,7 @@
>     Introduction <self>
>     Feature Requirements <feature_requirements>
>     Runtime configuration <runtime_configuration>
> -   ISP feature support matrix <isp-feature-matrix>
> -   Camera Sensor support <sensor-support>
> +   Platform Support <platform_support>
>     Application Writer's Guide <guides/application-developer>
>     Python Bindings <python-bindings>
>     Public API <public-api/index>
> @@ -36,5 +35,3 @@
>
>     Lens driver requirements <lens_driver_requirements>
>     Sensor driver requirements <sensor_driver_requirements>
> -
> -
> diff --git a/Documentation/libcamera_architecture.rst b/Documentation/libcamera_architecture.rst
> index ee67102a30a6..73888e499128 100644
> --- a/Documentation/libcamera_architecture.rst
> +++ b/Documentation/libcamera_architecture.rst
> @@ -141,21 +141,3 @@ Helpers and Support Classes
>    self-contained support classes, even if such code is present only once in the
>    code base, in order to keep the source code clean and easy to read. This
>    should be the case for instance for plugin management.
> -
> -Platform Support
> -----------------
> -
> -The library currently supports the following hardware platforms specifically
> -with dedicated pipeline handlers:
> -
> -   - Arm Mali-C55
> -   - Intel IPU3 (ipu3)
> -   - NXP i.MX8MP (imx8-isi and rkisp1)
> -   - RaspberryPi 3, 4 and zero (rpi/vc4)
> -   - Rockchip RK3399 (rkisp1)
> -
> -Furthermore, generic platform support is provided for the following:
> -
> -   - USB video device class cameras (uvcvideo)
> -   - iMX7, IPU6, Allwinner Sun6i (simple)
> -   - Virtual media controller driver for test use cases (vimc)
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index 51899c19c166..a156bd0b9ca7 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -168,6 +168,7 @@ if sphinx.found()
>          'lens_driver_requirements.rst',
>          'libcamera_architecture.rst',
>          'mali-c55.dot',
> +        'platform_support.rst',
>          'public-api/index.rst',
>          'python-bindings.rst',
>          'runtime_configuration.rst',
> diff --git a/Documentation/platform_support.rst b/Documentation/platform_support.rst
> new file mode 100644
> index 000000000000..2c3d62cb7e2c
> --- /dev/null
> +++ b/Documentation/platform_support.rst
> @@ -0,0 +1,25 @@
> +.. SPDX-License-Identifier: CC-BY-SA-4.0
> +
> +Platform Support
> +================
> +
> +The library currently supports the following hardware platforms specifically
> +with dedicated pipeline handlers:
> +
> +   - Arm Mali-C55

I would list Renesas RZ/V2H (mali-c55)

as you lists SoC names for the other entries

> +   - Intel IPU3 (ipu3)
> +   - NXP i.MX8MP (imx8-isi and rkisp1)
> +   - RaspberryPi 3, 4 and zero (rpi/vc4)

RaspberryPi 5 seems missing

> +   - Rockchip RK3399 (rkisp1)

and 3288

I understand this patch only moves code around, but it's worth adding
the new entries on top

Thanks
  j

> +
> +Furthermore, generic platform support is provided for the following:
> +
> +   - USB video device class cameras (uvcvideo)
> +   - iMX7, IPU6, Allwinner Sun6i (simple)
> +   - Virtual media controller driver for test use cases (vimc)
> +
> +.. toctree::
> +   :hidden:
> +
> +   ISP feature support matrix <isp-feature-matrix>
> +   Camera Sensor support <sensor-support>
> --
> Regards,
>
> Laurent Pinchart
>

On Tue, Jan 27, 2026 at 09:48:42AM +0100, Jacopo Mondi wrote:
> On Mon, Jan 26, 2026 at 09:01:40PM +0200, Laurent Pinchart wrote:
> > Platform support is split in three places: a short list in the libcamera
> > architecture document (in the developers section), a page for the ISP
> > feature matrix, and a page for camera sensors. Centralize all this in
> > the users section by moving the short platform support list to a
> > standalone page, and move the other two pages as children in the index.
> >
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >  Documentation/index.rst                  |  5 +----
> >  Documentation/libcamera_architecture.rst | 18 -----------------
> >  Documentation/meson.build                |  1 +
> >  Documentation/platform_support.rst       | 25 ++++++++++++++++++++++++
> >  4 files changed, 27 insertions(+), 22 deletions(-)
> >  create mode 100644 Documentation/platform_support.rst
> >
> > diff --git a/Documentation/index.rst b/Documentation/index.rst
> > index 03c3d0b4aff6..988feedf8387 100644
> > --- a/Documentation/index.rst
> > +++ b/Documentation/index.rst
> > @@ -9,8 +9,7 @@
> >     Introduction <self>
> >     Feature Requirements <feature_requirements>
> >     Runtime configuration <runtime_configuration>
> > -   ISP feature support matrix <isp-feature-matrix>
> > -   Camera Sensor support <sensor-support>
> > +   Platform Support <platform_support>
> >     Application Writer's Guide <guides/application-developer>
> >     Python Bindings <python-bindings>
> >     Public API <public-api/index>
> > @@ -36,5 +35,3 @@
> >
> >     Lens driver requirements <lens_driver_requirements>
> >     Sensor driver requirements <sensor_driver_requirements>
> > -
> > -
> > diff --git a/Documentation/libcamera_architecture.rst b/Documentation/libcamera_architecture.rst
> > index ee67102a30a6..73888e499128 100644
> > --- a/Documentation/libcamera_architecture.rst
> > +++ b/Documentation/libcamera_architecture.rst
> > @@ -141,21 +141,3 @@ Helpers and Support Classes
> >    self-contained support classes, even if such code is present only once in the
> >    code base, in order to keep the source code clean and easy to read. This
> >    should be the case for instance for plugin management.
> > -
> > -Platform Support
> > -----------------
> > -
> > -The library currently supports the following hardware platforms specifically
> > -with dedicated pipeline handlers:
> > -
> > -   - Arm Mali-C55
> > -   - Intel IPU3 (ipu3)
> > -   - NXP i.MX8MP (imx8-isi and rkisp1)
> > -   - RaspberryPi 3, 4 and zero (rpi/vc4)
> > -   - Rockchip RK3399 (rkisp1)
> > -
> > -Furthermore, generic platform support is provided for the following:
> > -
> > -   - USB video device class cameras (uvcvideo)
> > -   - iMX7, IPU6, Allwinner Sun6i (simple)
> > -   - Virtual media controller driver for test use cases (vimc)
> > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > index 51899c19c166..a156bd0b9ca7 100644
> > --- a/Documentation/meson.build
> > +++ b/Documentation/meson.build
> > @@ -168,6 +168,7 @@ if sphinx.found()
> >          'lens_driver_requirements.rst',
> >          'libcamera_architecture.rst',
> >          'mali-c55.dot',
> > +        'platform_support.rst',
> >          'public-api/index.rst',
> >          'python-bindings.rst',
> >          'runtime_configuration.rst',
> > diff --git a/Documentation/platform_support.rst b/Documentation/platform_support.rst
> > new file mode 100644
> > index 000000000000..2c3d62cb7e2c
> > --- /dev/null
> > +++ b/Documentation/platform_support.rst
> > @@ -0,0 +1,25 @@
> > +.. SPDX-License-Identifier: CC-BY-SA-4.0
> > +
> > +Platform Support
> > +================
> > +
> > +The library currently supports the following hardware platforms specifically
> > +with dedicated pipeline handlers:
> > +
> > +   - Arm Mali-C55
> 
> I would list Renesas RZ/V2H (mali-c55)
> 
> as you lists SoC names for the other entries
> 
> > +   - Intel IPU3 (ipu3)
> > +   - NXP i.MX8MP (imx8-isi and rkisp1)
> > +   - RaspberryPi 3, 4 and zero (rpi/vc4)
> 
> RaspberryPi 5 seems missing
> 
> > +   - Rockchip RK3399 (rkisp1)
> 
> and 3288
> 
> I understand this patch only moves code around, but it's worth adding
> the new entries on top

It is. Patches are welcome :-)

> > +
> > +Furthermore, generic platform support is provided for the following:
> > +
> > +   - USB video device class cameras (uvcvideo)
> > +   - iMX7, IPU6, Allwinner Sun6i (simple)
> > +   - Virtual media controller driver for test use cases (vimc)

This needs to be extended (and probably restructured) too.

> > +
> > +.. toctree::
> > +   :hidden:
> > +
> > +   ISP feature support matrix <isp-feature-matrix>
> > +   Camera Sensor support <sensor-support>