[v10,0/12] media: rkisp1: Extensible parameters and companding

Message

Jacopo Mondi Aug. 8, 2024, 8:40 p.m. UTC

v9->v10
- Fix spelling error in format documentation

- Specify in uAPI header that only V1 of the extensible parameters format is
  supported

	--- a/include/uapi/linux/rkisp1-config.h
	+++ b/include/uapi/linux/rkisp1-config.h
	@@ -1514,6 +1514,12 @@ enum rksip1_ext_param_buffer_version {
	  * indicated version and return an error if the desired version is not
	  * supported.
	  *
	+ * Currently the single RKISP1_EXT_PARAM_BUFFER_V1 version is supported.
	+ * When a new format version will be added, a mechanism for userspace to query
	+ * the supported format versions will be implemented in the form of a read-only
	+ * V4L2 control. If such control is not available, userspace should assume only
	+ * RKISP1_EXT_PARAM_BUFFER_V1 is supported by the driver.
	+ *

- Validate parameters format version in the driver

	--- a/drivers/media/platform/rockchip/rkisp1/rkisp1-params.c
	+++ b/drivers/media/platform/rockchip/rkisp1/rkisp1-params.c
	@@ -2585,6 +2585,14 @@ static int rkisp1_params_prepare_ext_params(struct rkisp1_params *params,

	+	/* Only v1 is supported at the moment. */
	+	if (cfg->version != RKISP1_EXT_PARAM_BUFFER_V1) {
	+		dev_dbg(params->rkisp1->dev,
	+			"Unsupported extensible format version: %u\n",
	+			cfg->version);
	+		return -EINVAL;
	+	}
	+
 	/* Validate the size reported in the parameters buffer header. */
 	cfg_size = header_size + cfg->data_size;
 	if (cfg_size != payload_size) {

v8->v9:
- Redefine the enable/disable flags as suggested by Hans
- Specify in uAPI doc that 'flags = ENABLE | DISABLE' is not valid
- Check flags validity in rkisp1-params.c

v7->v8:
- uAPI:
  - Make the 'size' field of the header block an u32. Remove the
    __attribute__((aligned(8)) from the header declaration as it's now 8 bytes
    long
  - Make the 'enable' field of the header block a bitmask of flags. I introduced

	enum rkisp1_ext_params_block_flags {
		RKISP1_EXT_PARAMS_BLOCK_DISABLE	= 0x1,
		RKISP1_EXT_PARAMS_BLOCK_ENABLE	= 0x2,
	};

   to allow user-space to configure a block without changing its power state (by
   not setting any flag).

- driver:

  - As the 'enable' field is now a bitmask, the handling of the block enablment
    had to change as well. In example, for BLS:

	@@ -1626,7 +1626,7 @@ rkisp1_ext_params_bls(struct rkisp1_params *params,
	 {
		const struct rkisp1_ext_params_bls_config *bls = &block->bls;

	-       if (bls->header.enable == RKISP1_EXT_PARAMS_BLOCK_DISABLE) {
	+       if (bls->header.flags & RKISP1_EXT_PARAMS_BLOCK_DISABLE) {
			rkisp1_param_clear_bits(params, RKISP1_CIF_ISP_BLS_CTRL,
						RKISP1_CIF_ISP_BLS_ENA);
			return;
	@@ -1634,7 +1634,8 @@ rkisp1_ext_params_bls(struct rkisp1_params *params,

		rkisp1_bls_config(params, &bls->config);

	-       if (!(params->enabled_blocks & BIT(RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS)))
	+       if ((bls->header.flags & RKISP1_EXT_PARAMS_BLOCK_ENABLE) &&
	+           !(params->enabled_blocks & BIT(bls->header.type)))
			rkisp1_param_set_bits(params, RKISP1_CIF_ISP_BLS_CTRL,
					      RKISP1_CIF_ISP_BLS_ENA);
	 }

   this requires userspace to specify the DISABLE/ENABLE flags and not rely
   on the fact that !enable meant 'disable' as in v7

v6->v7:
- Collect [PATCH v2 0/5] media: rkisp1: Add support for the companding block
- Fix GOC handling
- Fix newly introduced errors in checkstyle and documentation reported by
  https://gitlab.freedesktop.org/linux-media/users/jmondi/-/pipelines/1231492

v5->v6:
- Collect [v5.2 6/7] from Laurent
- Collect Paul's tags
- Add extra validation for unexpected data after the payload end as
  suggested by Sakari

v4->v5:
- Refine validation of the ext params buffer following Laurent's suggestion
- perform memcpy of the parameters buffer after sizes validation

v3->v4:
- Introduce 'union rkisp1_ext_params_config' to avoid casts in the block
  handlers

v2->v3:
- Address Laurent's comments on the uAPI:
  - rename $block_config with  just 'config'
  - reduce header size
  - rename a few fields/blocks

- Address Laurent's comment on the params node:
  - Use the plane payload for memcpy() and buffer validation
  - drop buf_out_validate() and use buf_prepare() only
  - validate the total buffer size against the buffer payload
  - use const pointers where possible

v1->v2:
- re-order patches to introduce parameters buffer caching for the existing
  "fixed" format before introducing the "extensible" format
- align all structures to 64-bit boundaries in the uAPI
- remove NO_CHANGE enablement state and cache a bitmask of enabled blocks
- address review comments in documentation

The VeriSilicon ISP8000 IP, supported through the rkisp1 driver in the Linux
kernel, is integrated in several SoCs from different vendors. Different
revisions of the IP differ in the number of supported features and in the
register space location assigned to specific ISP blocks.

The current configuration parameters format, defined in
include/uapi/linux/rkisp1-config.h is realized by a C structure (struct
rkisp1_params_cfg) which wraps other structures that allows to configure
specific ISP blocks. The layout of the parameters buffer is part of the Linux
kernel uAPI and can hardly be extended or modified to adapt it to different
revisions of the same IP.

This series proposes the introduction of a new parameters format for the RkISP1
(without dropping support for the existing one) which is designed with the goals
of being:

1) versioned: can be changed without breaking existing applications
2) extensible: new blocks and parameters can be added without breaking the uABI

To do so, a new 'struct rkisp1_ext_params_cfg' type is introduced. It wraps an
header and a data buffer, which userspace fills with configuration blocks
for each ISP block it intends to configure. The parameters buffer is thus of
different effective sizes, depending on the number of blocks userspace intends
to configure.

The kernel driver parses the data block and decides, based on the versioning
number and the platform it operates on, how to handle each block.

The parameters format is very similar to the parameters format implemented
in the in-review Mali C55 ISP driver [1]

CI pipeline [2]

[1] https://lore.kernel.org/linux-media/[e-mail]/
[2] https://gitlab.freedesktop.org/linux-media/users/jmondi/-/pipelines/1242260


Jacopo Mondi (7):
  media: uapi: rkisp1-config: Add extensible params format
  media: uapi: videodev2: Add V4L2_META_FMT_RK_ISP1_EXT_PARAMS
  media: rkisp1: Add struct rkisp1_params_buffer
  media: rkisp1: Copy the parameters buffer
  media: rkisp1: Cache the currently active format
  media: rkisp1: Implement extensible params support
  media: rkisp1: Implement s_fmt/try_fmt

Laurent Pinchart (2):
  media: rkisp1: Add helper function to swap colour channels
  media: rkisp1: Add features mask to extensible block handlers

Paul Elder (3):
  media: rkisp1: Add register definitions for the companding block
  media: rkisp1: Add feature flags for BLS and compand
  media: rkisp1: Add support for the companding block

 Documentation/admin-guide/media/rkisp1.rst    |   11 +-
 .../media/v4l/metafmt-rkisp1.rst              |   57 +-
 .../platform/rockchip/rkisp1/rkisp1-common.c  |   14 +
 .../platform/rockchip/rkisp1/rkisp1-common.h  |   38 +-
 .../platform/rockchip/rkisp1/rkisp1-dev.c     |    9 +-
 .../platform/rockchip/rkisp1/rkisp1-params.c  | 1041 +++++++++++++++--
 .../platform/rockchip/rkisp1/rkisp1-regs.h    |   23 +
 .../platform/rockchip/rkisp1/rkisp1-stats.c   |   51 +-
 drivers/media/v4l2-core/v4l2-ioctl.c          |    1 +
 include/uapi/linux/rkisp1-config.h            |  578 +++++++++
 include/uapi/linux/videodev2.h                |    1 +
 11 files changed, 1667 insertions(+), 157 deletions(-)

--
2.45.2