[RFC,v5,00/15] Sub-device configuration models

Message

Sakari Ailus Feb. 3, 2025, 8:58 a.m. UTC

Hello everyone,

I've been recently working (with others) on sub-device streams support as
well as on internal pads. The two can be used to make sub-device
configuration more versatile.

At the same time, the added interfaces are much more useful if we require
specific semantics of those interfaces, so that the user space knows
exactly what e.g. a given selection target signifies. However, as the same
selection rectangle could be used for a different purpose on a non-raw
sensor device, we need a way to tell how should the user space determine
how to use a given interface.

I'm proposing to solve this problem by introducing sub-device
configuration models, and by the common raw sensor model, also present in
this patchset, in particular.

This has been (and will, for some time, continue to be) the reason why I
have reviewed few sensor driver related patches lately. As we're
introducing a new interface, it's beneficial to be able to use that
interface right from the start, rather than trying to later on offer
compatibility support, which is almost always a fair amount of work with
less than desirable results in the driver.

With this solved, I believe we can enable the use of the streams UAPI.

Comments are welcome.

RFC v4 is <[e-mail]> on LMML.

RFC v3 is <[e-mail]> on LMML.

RFC v2 (labelled as PATCH) is
<[e-mail]> on LMML.

RFC v1 is <[e-mail]> on LMML.

We may end up postponing merging three last patches (those adding
controls) until current control values are moved to sub-device (and video
device) state. Discussion is needed on the topic.

The compiled documentation can be found here
<URL:https://www.retiisi.eu/~sailus/v4l2/tmp/common-raw/output/userspace-api/media/v4l/dev-subdev.html#media-subdev-config-model-common-raw-sensor>.

since RFC v4:

- Document the use of luma formats for generic raw data on both mbus codes
  and V4L2 pixelformats, with new controls V4L2_CID_COLOUR_PATTERN and
  V4L2_CID_COLOUR_PATTERN_FLIP determine the pattern in different flipping
  configurations. This enables the use of generic pattern-agnostic formats
  whereas controls are used to express colour components and their order.

- Add a patch that reworks the metadata format 4ccs. These haven't been in
  use in any case so far.

- Improve documentation column widths.

since RFC v3:

- Fix binning control name in documentation.

- Note V4L2_CID_CONFIG_MODEL is read-only.

- Clarify wording in config model documentation based on Jacopo's
  comments.

- Clarify post-scaler digital crop behaviour.

since RFC v2:

- Remove the CROP_BOUNDS rectangle on the image data sink pad. It's
  redundant.

- Remove scaling from the sink compose rectangle, leaving binning and
  sub-sampling.

- Introduce scaling as well as post-scaler digital crop on source pad
  (image stream). This is a new patch, preceding control changes.

- Use monospace font for selection targets.

- Improvements in referring to previous configuration steps in text
  description.

since RFC v1:

- Rework the documentation according to the comments (spelling fixes,
  alignment mostly).
  
- Include separate patches for binning and sub-sampling controls.

- Allow binning, scaling and scaling to be configured using the compose
  rectangle. This will change to just scaling in the three last patches.

Sakari Ailus (15):
  media: Documentation: Rework embedded data documentation
  media: Documentation: Add a hyphen to list-based
  media: Documentation: Reword split of sensor driver to two classes
  media: Documentation: Add subdev configuration models, raw sensor
    model
  media: Documentation: Add scaling and post-scaler crop for common raw
  media: uapi: Add V4L2_CID_CONFIG_MODEL control
  media: uapi: Add V4L2_CID_COLOUR_PATTERN for describing colour
    patterns
  media: uapi: Correct generic CSI-2 metadata format 4cc
  media: uapi: Documentation: Improve column width hints for examples
  media: v4l: uapi: Add a control for colour pattern flipping effect
  media: Documentation: Document luma-only mbus codes and CFA for
    cameras
  media: uapi: Documentation: Use luma formats with CFA pattern control
  media: uapi: Add V4L2_CID_BINNING control for binning configuration
  media: uapi: Add controls for sub-sampling configuration
  media: Documentation: Add binning and sub-sampling controls

 .../media/drivers/camera-sensor.rst           |  66 ++-
 .../media/v4l/common-raw-sensor.dia           | 441 ++++++++++++++++++
 .../media/v4l/common-raw-sensor.svg           | 134 ++++++
 .../userspace-api/media/v4l/dev-subdev.rst    |   2 +
 .../media/v4l/ext-ctrls-camera.rst            |  40 ++
 .../media/v4l/ext-ctrls-image-process.rst     |   4 +
 .../media/v4l/ext-ctrls-image-source.rst      |  22 +
 .../media/v4l/metafmt-generic.rst             |  10 +-
 .../media/v4l/pixfmt-yuv-luma.rst             |   5 +
 .../media/v4l/subdev-config-model.rst         | 233 +++++++++
 drivers/media/v4l2-core/v4l2-ctrls-defs.c     |  12 +
 include/uapi/linux/v4l2-controls.h            |  27 ++
 include/uapi/linux/videodev2.h                |  12 +-
 13 files changed, 983 insertions(+), 25 deletions(-)
 create mode 100644 Documentation/userspace-api/media/v4l/common-raw-sensor.dia
 create mode 100644 Documentation/userspace-api/media/v4l/common-raw-sensor.svg
 create mode 100644 Documentation/userspace-api/media/v4l/subdev-config-model.rst