| Message ID | 20240621145406.119088-2-jacopo.mondi@ideasonboard.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | media: rkisp1: Implement support for extensible parameters | expand |
Hi Jacopo, Thank you for the patch. On Fri, Jun 21, 2024 at 04:53:59PM +0200, Jacopo Mondi wrote: > Add to the rkisp1-config.h header data types and documentation of > the extensible parameters format. > > Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> > --- > include/uapi/linux/rkisp1-config.h | 497 +++++++++++++++++++++++++++++ > 1 file changed, 497 insertions(+) > > diff --git a/include/uapi/linux/rkisp1-config.h b/include/uapi/linux/rkisp1-config.h > index 6eeaf8bf2362..900e04a67a81 100644 > --- a/include/uapi/linux/rkisp1-config.h > +++ b/include/uapi/linux/rkisp1-config.h > @@ -996,4 +996,501 @@ struct rkisp1_stat_buffer { > struct rkisp1_cif_isp_stat params; > }; > > +/*---------- PART3: Extensible Configuration Parameters ------------*/ > + > +/** > + * enum rkisp1_ext_params_block_type - RkISP1 extensible params block type > + * > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS: Black level subtraction > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC: Defect pixel cluster correction > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG: Sensor de-gamma > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS: Auto white balance gains > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT: ISP filtering > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM: Bayer de-mosaic > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK: Cross-talk correction > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC: Gamma out correction > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF: De-noise pre-filter > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH: De-noise pre-filter strength > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC: Color processing > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_IE: Image effects > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC: Lens shading correction > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS: Auto white balance statistics > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS: Histogram statistics > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS: Auto exposure statistics > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS: Auto-focus statistics > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL: Sentinel > + */ > +enum rkisp1_ext_params_block_type { > + RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_IE, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS, > + RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL, > +}; > + > +/** > + * enum rkisp1_ext_params_block_enable - RkISP1 extensible parameter block > + * enable flags > + * > + * @RKISP1_EXT_PARAMS_BLOCK_DISABLE: Disable the HW block > + * @RKISP1_EXT_PARAMS_BLOCK_ENABLE: Enable the HW block > + */ > +enum rkisp1_ext_params_block_enable { > + RKISP1_EXT_PARAMS_BLOCK_DISABLE, > + RKISP1_EXT_PARAMS_BLOCK_ENABLE, > +}; > + > +/** > + * struct rkisp1_ext_params_block_header - RkISP1 extensible parameter block > + * header > + * > + * This structure represents the common part of all the ISP configuration > + * blocks. Each parameters block shall embed an instance of this structure type > + * as its first member, followed by the block-specific configuration data. The > + * driver inspects this common header to discern the block type and its size and > + * properly handle the block content by casting it to the correct block-specific > + * type. > + * > + * The @type field is one of the values enumerated by > + * :c:type:`rkisp1_ext_params_block_type` and specifies how the data should be > + * interpreted by the driver. The @size field specifies the size of the > + * parameters block and is used by the driver for validation purposes. > + * > + * The @enable field specifies the ISP block enablement state. The possible > + * enablement states are enumerated by :c:type:`rkisp1_ext_params_block_enable`. > + * When userspace needs to configure and enable an ISP block it shall fully > + * populate the block configuration and the @enable flag shall be set to > + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. When userspace simply wants to disable the > + * ISP block the @enable flag shall be set to RKISP1_EXT_PARAMS_BLOCK_DISABLE. > + * The driver ignores the rest of the block configuration structure in this > + * case. > + * > + * If a new configuration of an ISP block has to be applied userspace shall > + * fully populate the ISP block configuration and set the @enable flag to > + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. > + * > + * Userspace is responsible for correctly populating the parameters block header > + * fields (@type, @enable and @size) and correctly populate the block-specific s/correctly populate // > + * parameters. > + * > + * For example: > + * > + * .. code-block:: c > + * > + * void populate_bls(struct rkisp1_ext_params_block_header *block) { > + * struct rkisp1_ext_params_bls_config *bls = > + * (struct rkisp1_ext_params_bls_config *)block; > + * > + * block->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > + * block->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > + * block->header.size = sizeof(struct rkisp1_ext_params_bls_config); "block" is already the header, so block->type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; block->enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; block->size = sizeof(struct rkisp1_ext_params_bls_config); However I would write bls->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; bls->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; bls->header.size = sizeof(*bls); Passing the struct type as an argument to sizeof() seems error-prone, and using the same variable name on the left-hand side of -> and as the sizeof() parameter improves readability and should make copy&paste errors more apparent (and likely result in them being caught by the compiler). > + * > + * bls->bls_config.enable_auto = 0; > + * bls->bls_config.fixed_val.r = blackLevelRed_; > + * bls->bls_config.fixed_val.gr = blackLevelGreenR_; > + * bls->bls_config.fixed_val.gb = blackLevelGreenB_; > + * bls->bls_config.fixed_val.b = blackLevelBlue_; > + * } > + * > + * @type: The parameters block type, see > + * :c:type:`rkisp1_ext_params_block_type` > + * @enable: The block enable flag, see > + * :c:type:`rkisp1_ext_params_block_enable` > + * @size: Size (in bytes) of the parameters block, including this header > + */ > +struct rkisp1_ext_params_block_header { > + __u32 type; > + __u32 enable; > + __u32 size; Would it be useful to use __u16 for all those fields ? The size of the header would be reduced from 16 to 8 bytes. We will never have more than 64k blocks or enable states :-) I really don't expect any block size of more than 64kB for this ISP, but if that's a concern, the size could remain a __u32. > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_bls_config - RkISP1 extensible params BLS config > + * > + * RkISP1 extensible parameters Black Level Subtraction configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @bls_config: Black Level Subtraction configuration, see > + * :c:type:`rkisp1_cif_isp_bls_config` > + */ > +struct rkisp1_ext_params_bls_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_bls_config bls_config; All the blocks have a similar structure, with a header and a config structure using the existing parameters structure definitions. I think I would rename the "*_config" field names to just "config", adding the prefix here makes lines longer and doesn't improve readability. Compare the existing example above bls->bls_config.enable_auto = 0; bls->bls_config.fixed_val.r = blackLevelRed_; bls->bls_config.fixed_val.gr = blackLevelGreenR_; bls->bls_config.fixed_val.gb = blackLevelGreenB_; bls->bls_config.fixed_val.b = blackLevelBlue_; with bls->config.enable_auto = 0; bls->config.fixed_val.r = blackLevelRed_; bls->config.fixed_val.gr = blackLevelGreenR_; bls->config.fixed_val.gb = blackLevelGreenB_; bls->config.fixed_val.b = blackLevelBlue_; Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_dpcc_config - RkISP1 extensible params DPCC config > + * > + * RkISP1 extensible parameters Defective Pixel Cluster Correction configuration > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @dpcc_config: Defective Pixel Cluster Correction configuration, see > + * :c:type:`rkisp1_cif_isp_dpcc_config` > + */ > +struct rkisp1_ext_params_dpcc_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_dpcc_config dpcc_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_sdg_config - RkISP1 extensible params SDG config > + * > + * RkISP1 extensible parameters Sensor Degamma configuration block. Identified > + * by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @sdg_config: Sensor Degamma configuration, see > + * :c:type:`rkisp1_cif_isp_sdg_config` > + */ > +struct rkisp1_ext_params_sdg_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_sdg_config sdg_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_lsc_config - RkISP1 extensible params LSC config > + * > + * RkISP1 extensible parameters Lens Shading Correction configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @lsc_config: Lens Shading Correction configuration, see > + * :c:type:`rkisp1_cif_isp_lsc_config` > + */ > +struct rkisp1_ext_params_lsc_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_lsc_config lsc_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_awb_gain_config - RkISP1 extensible params AWB > + * gain config > + * > + * RkISP1 extensible parameters Auto-White Balance Gains configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @awb_config: Auto-White Balance Gains configuration, see > + * :c:type:`rkisp1_cif_isp_awb_gain_config` > + */ > +struct rkisp1_ext_params_awb_gain_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_awb_gain_config awb_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_flt_config - RkISP1 extensible params FLT config > + * > + * RkISP1 extensible parameters Filter configuration block. Identified by > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @flt_config: Filter configuration, see > + * :c:type:`rkisp1_cif_isp_flt_config` > + */ > +struct rkisp1_ext_params_flt_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_flt_config flt_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_bdm_config - RkISP1 extensible params BDM config > + * > + * RkISP1 extensible parameters Demosaicing configuration block. Identified by > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @bdm_config: Demosaicing configuration, see > + * :c:type:`rkisp1_cif_isp_bdm_config` > + */ > +struct rkisp1_ext_params_bdm_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_bdm_config bdm_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_ctk_config - RkISP1 extensible params CTK config > + * > + * RkISP1 extensible parameters Cross-Talk configuration block. Identified by > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @ctk_config: Cross-Talk configuration, see > + * :c:type:`rkisp1_cif_isp_ctk_config` > + */ > +struct rkisp1_ext_params_ctk_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_ctk_config ctk_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_goc_config - RkISP1 extensible params GOC config > + * > + * RkISP1 extensible parameters Gamma-Out configuration block. Identified by > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @goc_config: Gamma-Out configuration, see > + * :c:type:`rkisp1_cif_isp_goc_config` > + */ > +struct rkisp1_ext_params_goc_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_goc_config goc_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_dpf_config - RkISP1 extensible params DPF config > + * > + * RkISP1 extensible parameters De-noise Pre-Filter configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @dpf_config: De-noise Pre-Filter configuration, see > + * :c:type:`rkisp1_cif_isp_dpf_config` > + */ > +struct rkisp1_ext_params_dpf_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_dpf_config dpf_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_dpf_strength_config - RkISP1 extensible params DPF > + * strength config > + * > + * RkISP1 extensible parameters De-noise Pre-Filter strength configuration > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @dpf_strength_config: De-noise Pre-Filter strength configuration, see > + * :c:type:`rkisp1_cif_isp_dpf_strength_config` > + */ > +struct rkisp1_ext_params_dpf_strength_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_dpf_strength_config dpf_strength_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_cproc_config - RkISP1 extensible params CPROC config > + * > + * RkISP1 extensible parameters Color Processing configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @cproc_config: Color processing configuration, see > + * :c:type:`rkisp1_cif_isp_cproc_config` > + */ > +struct rkisp1_ext_params_cproc_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_cproc_config cproc_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_ie_config - RkISP1 extensible params IE config > + * > + * RkISP1 extensible parameters Image Effect configuration block. Identified by > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_IE`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @ie_config: Image Effect configuration, see > + * :c:type:`rkisp1_cif_isp_ie_config` > + */ > +struct rkisp1_ext_params_ie_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_ie_config ie_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_awb_meas_config - RkISP1 extensible params AWB > + * Meas config > + * > + * RkISP1 extensible parameters Auto-White Balance Measurement configuration > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @awb_meas_config: Auto-White Balance measure configuration, see > + * :c:type:`rkisp1_cif_isp_awb_meas_config` > + */ > +struct rkisp1_ext_params_awb_meas_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_awb_meas_config awb_meas_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_hst_config - RkISP1 extensible params Histogram config > + * > + * RkISP1 extensible parameters Histogram statistics configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @hst_config: Histogram statistics configuration, see > + * :c:type:`rkisp1_cif_isp_hst_config` > + */ > +struct rkisp1_ext_params_hst_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_hst_config hst_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_aec_config - RkISP1 extensible params AEC config > + * > + * RkISP1 extensible parameters Auto-Exposure statistics configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @aec_config: Auto-Exposure statistics configuration, see > + * :c:type:`rkisp1_cif_isp_aec_config` > + */ > +struct rkisp1_ext_params_aec_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_aec_config aec_config; > +} __attribute__((aligned(8))); > + > +/** > + * struct rkisp1_ext_params_afc_config - RkISP1 extensible params AFC config > + * > + * RkISP1 extensible parameters Auto-Focus statistics configuration block. > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS`. > + * > + * @header: The RkISP1 extensible parameters header, see > + * :c:type:`rkisp1_ext_params_block_header` > + * @afc_config: Auto-Focus statistics configuration, see > + * :c:type:`rkisp1_cif_isp_afc_config` > + */ > +struct rkisp1_ext_params_afc_config { > + struct rkisp1_ext_params_block_header header; > + struct rkisp1_cif_isp_afc_config afc_config; > +} __attribute__((aligned(8))); > + > +#define RKISP1_EXT_PARAMS_MAX_SIZE \ > + (sizeof(struct rkisp1_ext_params_bls_config) +\ > + sizeof(struct rkisp1_ext_params_dpcc_config) +\ > + sizeof(struct rkisp1_ext_params_sdg_config) +\ > + sizeof(struct rkisp1_ext_params_lsc_config) +\ > + sizeof(struct rkisp1_ext_params_awb_gain_config) +\ > + sizeof(struct rkisp1_ext_params_flt_config) +\ > + sizeof(struct rkisp1_ext_params_bdm_config) +\ > + sizeof(struct rkisp1_ext_params_ctk_config) +\ > + sizeof(struct rkisp1_ext_params_goc_config) +\ > + sizeof(struct rkisp1_ext_params_dpf_config) +\ > + sizeof(struct rkisp1_ext_params_dpf_strength_config) +\ > + sizeof(struct rkisp1_ext_params_cproc_config) +\ > + sizeof(struct rkisp1_ext_params_ie_config) +\ > + sizeof(struct rkisp1_ext_params_awb_meas_config) +\ > + sizeof(struct rkisp1_ext_params_hst_config) +\ > + sizeof(struct rkisp1_ext_params_aec_config) +\ > + sizeof(struct rkisp1_ext_params_afc_config)) > + > +/** > + * enum rksip1_ext_param_buffer_version - RkISP1 extensible parameters version > + * > + * @RKISP1_EXT_PARAM_BUFFER_V1: First version of RkISP1 extensible parameters > + */ > +enum rksip1_ext_param_buffer_version { > + RKISP1_EXT_PARAM_BUFFER_V1 = 1, > +}; > + > +/** > + * struct rkisp1_ext_params_cfg - RkISP1 extensible parameters configuration > + * > + * This struct contains the configuration parameters of the RkISP1 ISP > + * algorithms, serialized by userspace into a data buffer. Each configuration > + * parameter block is represented by a block-specific structure which contains a > + * :c:type:`rkisp1_ext_params_block_header` entry as first member. Userspace > + * populates the @data buffer with configuration parameters for the blocks that > + * it intends to configure. As a consequence, the data buffer effective size > + * changes according to the number of ISP blocks that userspace intends to > + * configure and is set by userspace in the @total_size field. > + * > + * The parameters buffer is versioned by the @version field to allow modifying > + * and extending its definition. Userspace shall populate the @version field to > + * inform the driver about the version it intends to use. The driver will parse > + * and handle the @data buffer according to the data layout specific to the > + * indicated version and return an error if the desired version is not > + * supported. > + * > + * For each ISP block that userspace wants to configure, a block-specific > + * structure is appended to the @data buffer, one after the other without gaps > + * in between nor overlaps. Userspace shall populate the @total_size field with > + * the effective size, in bytes, of the @data buffer. > + * > + * The expected memory layout of the parameters buffer is:: > + * > + * +-------------------- struct rkisp1_ext_params_cfg -------------------+ > + * | version = RKISP_EXT_PARAMS_BUFFER_V1; | > + * | total_size = sizeof(struct rkisp1_ext_params_bls_config) | > + * | sizeof(struct rkisp1_ext_params_dpcc_config); | > + * | +------------------------- data ---------------------------------+ | > + * | | +------------- struct rkisp1_ext_params_bls_config -----------+ | | > + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | > + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS; | | | | > + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | > + * | | | | size = sizeof(struct rkisp1_ext_params_bls_config); | | | | > + * | | | +---------------------------------------------------------+ | | | > + * | | | +---------- struct rkisp1_cif_isp_bls_config -------------+ | | | > + * | | | | enable_auto = 0; | | | | > + * | | | | fixed_val.r = 256; | | | | > + * | | | | fixed_val.gr = 256; | | | | > + * | | | | fixed_val.gb = 256; | | | | > + * | | | | fixed_val.b = 256; | | | | > + * | | | +---------------------------------------------------------+ | | | > + * | | +------------ struct rkisp1_ext_params_dpcc_config -----------+ | | > + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | > + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC; | | | | > + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | > + * | | | | size = sizeof(struct rkisp1_ext_params_dpcc_config); | | | | > + * | | | +---------------------------------------------------------+ | | | > + * | | | +---------- struct rkisp1_cif_isp_dpcc_config ------------+ | | | > + * | | | | mode = RKISP1_CIF_ISP_DPCC_MODE_STAGE1_ENABLE; | | | | > + * | | | | output_mode = | | | | > + * | | | | RKISP1_CIF_ISP_DPCC_OUTPUT_MODE_STAGE1_INCL_G_CENTER; | | | | > + * | | | | set_use = ... ; | | | | > + * | | | | ... = ... ; | | | | > + * | | | +---------------------------------------------------------+ | | | > + * | | +-------------------------------------------------------------+ | | > + * | +-----------------------------------------------------------------+ | > + * +---------------------------------------------------------------------+ > + * > + * @version: The RkISP1 extensible parameters buffer version, see > + * :c:type:`rksip1_ext_param_buffer_version` > + * @total_size: The RkISP1 configuration data effective size, excluding this > + * header > + * @data: The RkISP1 extensible configuration data blocks > + */ > +struct rkisp1_ext_params_cfg { > + __u32 version; > + __u32 total_size; > + __u8 data[RKISP1_EXT_PARAMS_MAX_SIZE]; > +}; > + > #endif /* _UAPI_RKISP1_CONFIG_H */
On Sat, Jun 29, 2024 at 03:18:39PM +0300, Laurent Pinchart wrote: > Hi Jacopo, > > Thank you for the patch. > > On Fri, Jun 21, 2024 at 04:53:59PM +0200, Jacopo Mondi wrote: > > Add to the rkisp1-config.h header data types and documentation of > > the extensible parameters format. > > > > Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> > > --- > > include/uapi/linux/rkisp1-config.h | 497 +++++++++++++++++++++++++++++ > > 1 file changed, 497 insertions(+) > > > > diff --git a/include/uapi/linux/rkisp1-config.h b/include/uapi/linux/rkisp1-config.h > > index 6eeaf8bf2362..900e04a67a81 100644 > > --- a/include/uapi/linux/rkisp1-config.h > > +++ b/include/uapi/linux/rkisp1-config.h > > @@ -996,4 +996,501 @@ struct rkisp1_stat_buffer { > > struct rkisp1_cif_isp_stat params; > > }; > > > > +/*---------- PART3: Extensible Configuration Parameters ------------*/ > > + > > +/** > > + * enum rkisp1_ext_params_block_type - RkISP1 extensible params block type > > + * > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS: Black level subtraction > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC: Defect pixel cluster correction > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG: Sensor de-gamma > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS: Auto white balance gains > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT: ISP filtering > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM: Bayer de-mosaic > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK: Cross-talk correction > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC: Gamma out correction > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF: De-noise pre-filter > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH: De-noise pre-filter strength > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC: Color processing > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_IE: Image effects > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC: Lens shading correction > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS: Auto white balance statistics > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS: Histogram statistics > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS: Auto exposure statistics > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS: Auto-focus statistics > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL: Sentinel > > + */ > > +enum rkisp1_ext_params_block_type { > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_IE, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS, > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL, Another comment, I wouldn't include the sentinel here. This file is part of the UAPI, and who knows what userspace breakage could happen when the value of RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL changes in a new kernel version. > > +}; > > + > > +/** > > + * enum rkisp1_ext_params_block_enable - RkISP1 extensible parameter block > > + * enable flags > > + * > > + * @RKISP1_EXT_PARAMS_BLOCK_DISABLE: Disable the HW block > > + * @RKISP1_EXT_PARAMS_BLOCK_ENABLE: Enable the HW block > > + */ > > +enum rkisp1_ext_params_block_enable { > > + RKISP1_EXT_PARAMS_BLOCK_DISABLE, > > + RKISP1_EXT_PARAMS_BLOCK_ENABLE, > > +}; > > + > > +/** > > + * struct rkisp1_ext_params_block_header - RkISP1 extensible parameter block > > + * header > > + * > > + * This structure represents the common part of all the ISP configuration > > + * blocks. Each parameters block shall embed an instance of this structure type > > + * as its first member, followed by the block-specific configuration data. The > > + * driver inspects this common header to discern the block type and its size and > > + * properly handle the block content by casting it to the correct block-specific > > + * type. > > + * > > + * The @type field is one of the values enumerated by > > + * :c:type:`rkisp1_ext_params_block_type` and specifies how the data should be > > + * interpreted by the driver. The @size field specifies the size of the > > + * parameters block and is used by the driver for validation purposes. > > + * > > + * The @enable field specifies the ISP block enablement state. The possible > > + * enablement states are enumerated by :c:type:`rkisp1_ext_params_block_enable`. > > + * When userspace needs to configure and enable an ISP block it shall fully > > + * populate the block configuration and the @enable flag shall be set to > > + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. When userspace simply wants to disable the > > + * ISP block the @enable flag shall be set to RKISP1_EXT_PARAMS_BLOCK_DISABLE. > > + * The driver ignores the rest of the block configuration structure in this > > + * case. > > + * > > + * If a new configuration of an ISP block has to be applied userspace shall > > + * fully populate the ISP block configuration and set the @enable flag to > > + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. > > + * > > + * Userspace is responsible for correctly populating the parameters block header > > + * fields (@type, @enable and @size) and correctly populate the block-specific > > s/correctly populate // > > > + * parameters. > > + * > > + * For example: > > + * > > + * .. code-block:: c > > + * > > + * void populate_bls(struct rkisp1_ext_params_block_header *block) { > > + * struct rkisp1_ext_params_bls_config *bls = > > + * (struct rkisp1_ext_params_bls_config *)block; > > + * > > + * block->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > > + * block->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > > + * block->header.size = sizeof(struct rkisp1_ext_params_bls_config); > > "block" is already the header, so > > block->type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > block->enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > block->size = sizeof(struct rkisp1_ext_params_bls_config); > > However I would write > > bls->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > bls->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > bls->header.size = sizeof(*bls); > > Passing the struct type as an argument to sizeof() seems error-prone, > and using the same variable name on the left-hand side of -> and as the > sizeof() parameter improves readability and should make copy&paste > errors more apparent (and likely result in them being caught by the > compiler). > > > + * > > + * bls->bls_config.enable_auto = 0; > > + * bls->bls_config.fixed_val.r = blackLevelRed_; > > + * bls->bls_config.fixed_val.gr = blackLevelGreenR_; > > + * bls->bls_config.fixed_val.gb = blackLevelGreenB_; > > + * bls->bls_config.fixed_val.b = blackLevelBlue_; > > + * } > > + * > > + * @type: The parameters block type, see > > + * :c:type:`rkisp1_ext_params_block_type` > > + * @enable: The block enable flag, see > > + * :c:type:`rkisp1_ext_params_block_enable` > > + * @size: Size (in bytes) of the parameters block, including this header > > + */ > > +struct rkisp1_ext_params_block_header { > > + __u32 type; > > + __u32 enable; > > + __u32 size; > > Would it be useful to use __u16 for all those fields ? The size of the > header would be reduced from 16 to 8 bytes. We will never have more than > 64k blocks or enable states :-) I really don't expect any block size of > more than 64kB for this ISP, but if that's a concern, the size could > remain a __u32. > > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_bls_config - RkISP1 extensible params BLS config > > + * > > + * RkISP1 extensible parameters Black Level Subtraction configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @bls_config: Black Level Subtraction configuration, see > > + * :c:type:`rkisp1_cif_isp_bls_config` > > + */ > > +struct rkisp1_ext_params_bls_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_bls_config bls_config; > > All the blocks have a similar structure, with a header and a config > structure using the existing parameters structure definitions. I think I > would rename the "*_config" field names to just "config", adding the > prefix here makes lines longer and doesn't improve readability. Compare > the existing example above > > bls->bls_config.enable_auto = 0; > bls->bls_config.fixed_val.r = blackLevelRed_; > bls->bls_config.fixed_val.gr = blackLevelGreenR_; > bls->bls_config.fixed_val.gb = blackLevelGreenB_; > bls->bls_config.fixed_val.b = blackLevelBlue_; > > with > > bls->config.enable_auto = 0; > bls->config.fixed_val.r = blackLevelRed_; > bls->config.fixed_val.gr = blackLevelGreenR_; > bls->config.fixed_val.gb = blackLevelGreenB_; > bls->config.fixed_val.b = blackLevelBlue_; > > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_dpcc_config - RkISP1 extensible params DPCC config > > + * > > + * RkISP1 extensible parameters Defective Pixel Cluster Correction configuration > > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @dpcc_config: Defective Pixel Cluster Correction configuration, see > > + * :c:type:`rkisp1_cif_isp_dpcc_config` > > + */ > > +struct rkisp1_ext_params_dpcc_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_dpcc_config dpcc_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_sdg_config - RkISP1 extensible params SDG config > > + * > > + * RkISP1 extensible parameters Sensor Degamma configuration block. Identified > > + * by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @sdg_config: Sensor Degamma configuration, see > > + * :c:type:`rkisp1_cif_isp_sdg_config` > > + */ > > +struct rkisp1_ext_params_sdg_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_sdg_config sdg_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_lsc_config - RkISP1 extensible params LSC config > > + * > > + * RkISP1 extensible parameters Lens Shading Correction configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @lsc_config: Lens Shading Correction configuration, see > > + * :c:type:`rkisp1_cif_isp_lsc_config` > > + */ > > +struct rkisp1_ext_params_lsc_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_lsc_config lsc_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_awb_gain_config - RkISP1 extensible params AWB > > + * gain config > > + * > > + * RkISP1 extensible parameters Auto-White Balance Gains configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @awb_config: Auto-White Balance Gains configuration, see > > + * :c:type:`rkisp1_cif_isp_awb_gain_config` > > + */ > > +struct rkisp1_ext_params_awb_gain_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_awb_gain_config awb_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_flt_config - RkISP1 extensible params FLT config > > + * > > + * RkISP1 extensible parameters Filter configuration block. Identified by > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @flt_config: Filter configuration, see > > + * :c:type:`rkisp1_cif_isp_flt_config` > > + */ > > +struct rkisp1_ext_params_flt_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_flt_config flt_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_bdm_config - RkISP1 extensible params BDM config > > + * > > + * RkISP1 extensible parameters Demosaicing configuration block. Identified by > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @bdm_config: Demosaicing configuration, see > > + * :c:type:`rkisp1_cif_isp_bdm_config` > > + */ > > +struct rkisp1_ext_params_bdm_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_bdm_config bdm_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_ctk_config - RkISP1 extensible params CTK config > > + * > > + * RkISP1 extensible parameters Cross-Talk configuration block. Identified by > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @ctk_config: Cross-Talk configuration, see > > + * :c:type:`rkisp1_cif_isp_ctk_config` > > + */ > > +struct rkisp1_ext_params_ctk_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_ctk_config ctk_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_goc_config - RkISP1 extensible params GOC config > > + * > > + * RkISP1 extensible parameters Gamma-Out configuration block. Identified by > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @goc_config: Gamma-Out configuration, see > > + * :c:type:`rkisp1_cif_isp_goc_config` > > + */ > > +struct rkisp1_ext_params_goc_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_goc_config goc_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_dpf_config - RkISP1 extensible params DPF config > > + * > > + * RkISP1 extensible parameters De-noise Pre-Filter configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @dpf_config: De-noise Pre-Filter configuration, see > > + * :c:type:`rkisp1_cif_isp_dpf_config` > > + */ > > +struct rkisp1_ext_params_dpf_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_dpf_config dpf_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_dpf_strength_config - RkISP1 extensible params DPF > > + * strength config > > + * > > + * RkISP1 extensible parameters De-noise Pre-Filter strength configuration > > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @dpf_strength_config: De-noise Pre-Filter strength configuration, see > > + * :c:type:`rkisp1_cif_isp_dpf_strength_config` > > + */ > > +struct rkisp1_ext_params_dpf_strength_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_dpf_strength_config dpf_strength_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_cproc_config - RkISP1 extensible params CPROC config > > + * > > + * RkISP1 extensible parameters Color Processing configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @cproc_config: Color processing configuration, see > > + * :c:type:`rkisp1_cif_isp_cproc_config` > > + */ > > +struct rkisp1_ext_params_cproc_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_cproc_config cproc_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_ie_config - RkISP1 extensible params IE config > > + * > > + * RkISP1 extensible parameters Image Effect configuration block. Identified by > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_IE`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @ie_config: Image Effect configuration, see > > + * :c:type:`rkisp1_cif_isp_ie_config` > > + */ > > +struct rkisp1_ext_params_ie_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_ie_config ie_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_awb_meas_config - RkISP1 extensible params AWB > > + * Meas config > > + * > > + * RkISP1 extensible parameters Auto-White Balance Measurement configuration > > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @awb_meas_config: Auto-White Balance measure configuration, see > > + * :c:type:`rkisp1_cif_isp_awb_meas_config` > > + */ > > +struct rkisp1_ext_params_awb_meas_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_awb_meas_config awb_meas_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_hst_config - RkISP1 extensible params Histogram config > > + * > > + * RkISP1 extensible parameters Histogram statistics configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @hst_config: Histogram statistics configuration, see > > + * :c:type:`rkisp1_cif_isp_hst_config` > > + */ > > +struct rkisp1_ext_params_hst_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_hst_config hst_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_aec_config - RkISP1 extensible params AEC config > > + * > > + * RkISP1 extensible parameters Auto-Exposure statistics configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @aec_config: Auto-Exposure statistics configuration, see > > + * :c:type:`rkisp1_cif_isp_aec_config` > > + */ > > +struct rkisp1_ext_params_aec_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_aec_config aec_config; > > +} __attribute__((aligned(8))); > > + > > +/** > > + * struct rkisp1_ext_params_afc_config - RkISP1 extensible params AFC config > > + * > > + * RkISP1 extensible parameters Auto-Focus statistics configuration block. > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS`. > > + * > > + * @header: The RkISP1 extensible parameters header, see > > + * :c:type:`rkisp1_ext_params_block_header` > > + * @afc_config: Auto-Focus statistics configuration, see > > + * :c:type:`rkisp1_cif_isp_afc_config` > > + */ > > +struct rkisp1_ext_params_afc_config { > > + struct rkisp1_ext_params_block_header header; > > + struct rkisp1_cif_isp_afc_config afc_config; > > +} __attribute__((aligned(8))); > > + > > +#define RKISP1_EXT_PARAMS_MAX_SIZE \ > > + (sizeof(struct rkisp1_ext_params_bls_config) +\ > > + sizeof(struct rkisp1_ext_params_dpcc_config) +\ > > + sizeof(struct rkisp1_ext_params_sdg_config) +\ > > + sizeof(struct rkisp1_ext_params_lsc_config) +\ > > + sizeof(struct rkisp1_ext_params_awb_gain_config) +\ > > + sizeof(struct rkisp1_ext_params_flt_config) +\ > > + sizeof(struct rkisp1_ext_params_bdm_config) +\ > > + sizeof(struct rkisp1_ext_params_ctk_config) +\ > > + sizeof(struct rkisp1_ext_params_goc_config) +\ > > + sizeof(struct rkisp1_ext_params_dpf_config) +\ > > + sizeof(struct rkisp1_ext_params_dpf_strength_config) +\ > > + sizeof(struct rkisp1_ext_params_cproc_config) +\ > > + sizeof(struct rkisp1_ext_params_ie_config) +\ > > + sizeof(struct rkisp1_ext_params_awb_meas_config) +\ > > + sizeof(struct rkisp1_ext_params_hst_config) +\ > > + sizeof(struct rkisp1_ext_params_aec_config) +\ > > + sizeof(struct rkisp1_ext_params_afc_config)) > > + > > +/** > > + * enum rksip1_ext_param_buffer_version - RkISP1 extensible parameters version > > + * > > + * @RKISP1_EXT_PARAM_BUFFER_V1: First version of RkISP1 extensible parameters > > + */ > > +enum rksip1_ext_param_buffer_version { > > + RKISP1_EXT_PARAM_BUFFER_V1 = 1, > > +}; > > + > > +/** > > + * struct rkisp1_ext_params_cfg - RkISP1 extensible parameters configuration > > + * > > + * This struct contains the configuration parameters of the RkISP1 ISP > > + * algorithms, serialized by userspace into a data buffer. Each configuration > > + * parameter block is represented by a block-specific structure which contains a > > + * :c:type:`rkisp1_ext_params_block_header` entry as first member. Userspace > > + * populates the @data buffer with configuration parameters for the blocks that > > + * it intends to configure. As a consequence, the data buffer effective size > > + * changes according to the number of ISP blocks that userspace intends to > > + * configure and is set by userspace in the @total_size field. > > + * > > + * The parameters buffer is versioned by the @version field to allow modifying > > + * and extending its definition. Userspace shall populate the @version field to > > + * inform the driver about the version it intends to use. The driver will parse > > + * and handle the @data buffer according to the data layout specific to the > > + * indicated version and return an error if the desired version is not > > + * supported. > > + * > > + * For each ISP block that userspace wants to configure, a block-specific > > + * structure is appended to the @data buffer, one after the other without gaps > > + * in between nor overlaps. Userspace shall populate the @total_size field with > > + * the effective size, in bytes, of the @data buffer. > > + * > > + * The expected memory layout of the parameters buffer is:: > > + * > > + * +-------------------- struct rkisp1_ext_params_cfg -------------------+ > > + * | version = RKISP_EXT_PARAMS_BUFFER_V1; | > > + * | total_size = sizeof(struct rkisp1_ext_params_bls_config) | > > + * | sizeof(struct rkisp1_ext_params_dpcc_config); | > > + * | +------------------------- data ---------------------------------+ | > > + * | | +------------- struct rkisp1_ext_params_bls_config -----------+ | | > > + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | > > + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS; | | | | > > + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | > > + * | | | | size = sizeof(struct rkisp1_ext_params_bls_config); | | | | > > + * | | | +---------------------------------------------------------+ | | | > > + * | | | +---------- struct rkisp1_cif_isp_bls_config -------------+ | | | > > + * | | | | enable_auto = 0; | | | | > > + * | | | | fixed_val.r = 256; | | | | > > + * | | | | fixed_val.gr = 256; | | | | > > + * | | | | fixed_val.gb = 256; | | | | > > + * | | | | fixed_val.b = 256; | | | | > > + * | | | +---------------------------------------------------------+ | | | > > + * | | +------------ struct rkisp1_ext_params_dpcc_config -----------+ | | > > + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | > > + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC; | | | | > > + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | > > + * | | | | size = sizeof(struct rkisp1_ext_params_dpcc_config); | | | | > > + * | | | +---------------------------------------------------------+ | | | > > + * | | | +---------- struct rkisp1_cif_isp_dpcc_config ------------+ | | | > > + * | | | | mode = RKISP1_CIF_ISP_DPCC_MODE_STAGE1_ENABLE; | | | | > > + * | | | | output_mode = | | | | > > + * | | | | RKISP1_CIF_ISP_DPCC_OUTPUT_MODE_STAGE1_INCL_G_CENTER; | | | | > > + * | | | | set_use = ... ; | | | | > > + * | | | | ... = ... ; | | | | > > + * | | | +---------------------------------------------------------+ | | | > > + * | | +-------------------------------------------------------------+ | | > > + * | +-----------------------------------------------------------------+ | > > + * +---------------------------------------------------------------------+ > > + * > > + * @version: The RkISP1 extensible parameters buffer version, see > > + * :c:type:`rksip1_ext_param_buffer_version` > > + * @total_size: The RkISP1 configuration data effective size, excluding this > > + * header > > + * @data: The RkISP1 extensible configuration data blocks > > + */ > > +struct rkisp1_ext_params_cfg { > > + __u32 version; > > + __u32 total_size; > > + __u8 data[RKISP1_EXT_PARAMS_MAX_SIZE]; > > +}; > > + > > #endif /* _UAPI_RKISP1_CONFIG_H */
On Sat, Jun 29, 2024 at 05:20:32PM +0300, Laurent Pinchart wrote: > On Sat, Jun 29, 2024 at 03:18:39PM +0300, Laurent Pinchart wrote: > > Hi Jacopo, > > > > Thank you for the patch. > > > > On Fri, Jun 21, 2024 at 04:53:59PM +0200, Jacopo Mondi wrote: > > > Add to the rkisp1-config.h header data types and documentation of > > > the extensible parameters format. > > > > > > Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> > > > --- > > > include/uapi/linux/rkisp1-config.h | 497 +++++++++++++++++++++++++++++ > > > 1 file changed, 497 insertions(+) > > > > > > diff --git a/include/uapi/linux/rkisp1-config.h b/include/uapi/linux/rkisp1-config.h > > > index 6eeaf8bf2362..900e04a67a81 100644 > > > --- a/include/uapi/linux/rkisp1-config.h > > > +++ b/include/uapi/linux/rkisp1-config.h > > > @@ -996,4 +996,501 @@ struct rkisp1_stat_buffer { > > > struct rkisp1_cif_isp_stat params; > > > }; > > > > > > +/*---------- PART3: Extensible Configuration Parameters ------------*/ > > > + > > > +/** > > > + * enum rkisp1_ext_params_block_type - RkISP1 extensible params block type > > > + * > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS: Black level subtraction > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC: Defect pixel cluster correction > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG: Sensor de-gamma > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS: Auto white balance gains > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT: ISP filtering > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM: Bayer de-mosaic > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK: Cross-talk correction > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC: Gamma out correction > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF: De-noise pre-filter > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH: De-noise pre-filter strength > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC: Color processing > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_IE: Image effects > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC: Lens shading correction > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS: Auto white balance statistics > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS: Histogram statistics > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS: Auto exposure statistics > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS: Auto-focus statistics > > > + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL: Sentinel > > > + */ > > > +enum rkisp1_ext_params_block_type { > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_IE, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS, > > > + RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL, > > Another comment, I wouldn't include the sentinel here. This file is part > of the UAPI, and who knows what userspace breakage could happen when the > value of RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL changes in a new kernel > version. > > > > +}; > > > + > > > +/** > > > + * enum rkisp1_ext_params_block_enable - RkISP1 extensible parameter block > > > + * enable flags > > > + * > > > + * @RKISP1_EXT_PARAMS_BLOCK_DISABLE: Disable the HW block > > > + * @RKISP1_EXT_PARAMS_BLOCK_ENABLE: Enable the HW block > > > + */ > > > +enum rkisp1_ext_params_block_enable { > > > + RKISP1_EXT_PARAMS_BLOCK_DISABLE, > > > + RKISP1_EXT_PARAMS_BLOCK_ENABLE, > > > +}; > > > + > > > +/** > > > + * struct rkisp1_ext_params_block_header - RkISP1 extensible parameter block > > > + * header > > > + * > > > + * This structure represents the common part of all the ISP configuration > > > + * blocks. Each parameters block shall embed an instance of this structure type > > > + * as its first member, followed by the block-specific configuration data. The > > > + * driver inspects this common header to discern the block type and its size and > > > + * properly handle the block content by casting it to the correct block-specific > > > + * type. > > > + * > > > + * The @type field is one of the values enumerated by > > > + * :c:type:`rkisp1_ext_params_block_type` and specifies how the data should be > > > + * interpreted by the driver. The @size field specifies the size of the > > > + * parameters block and is used by the driver for validation purposes. > > > + * > > > + * The @enable field specifies the ISP block enablement state. The possible > > > + * enablement states are enumerated by :c:type:`rkisp1_ext_params_block_enable`. > > > + * When userspace needs to configure and enable an ISP block it shall fully > > > + * populate the block configuration and the @enable flag shall be set to > > > + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. When userspace simply wants to disable the > > > + * ISP block the @enable flag shall be set to RKISP1_EXT_PARAMS_BLOCK_DISABLE. > > > + * The driver ignores the rest of the block configuration structure in this > > > + * case. > > > + * > > > + * If a new configuration of an ISP block has to be applied userspace shall > > > + * fully populate the ISP block configuration and set the @enable flag to > > > + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. > > > + * > > > + * Userspace is responsible for correctly populating the parameters block header > > > + * fields (@type, @enable and @size) and correctly populate the block-specific > > > > s/correctly populate // > > > > > + * parameters. > > > + * > > > + * For example: > > > + * > > > + * .. code-block:: c > > > + * > > > + * void populate_bls(struct rkisp1_ext_params_block_header *block) { > > > + * struct rkisp1_ext_params_bls_config *bls = > > > + * (struct rkisp1_ext_params_bls_config *)block; > > > + * > > > + * block->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > > > + * block->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > > > + * block->header.size = sizeof(struct rkisp1_ext_params_bls_config); > > > > "block" is already the header, so > > > > block->type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > > block->enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > > block->size = sizeof(struct rkisp1_ext_params_bls_config); > > > > However I would write > > > > bls->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; > > bls->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; > > bls->header.size = sizeof(*bls); > > > > Passing the struct type as an argument to sizeof() seems error-prone, > > and using the same variable name on the left-hand side of -> and as the > > sizeof() parameter improves readability and should make copy&paste > > errors more apparent (and likely result in them being caught by the > > compiler). > > > > > + * > > > + * bls->bls_config.enable_auto = 0; > > > + * bls->bls_config.fixed_val.r = blackLevelRed_; > > > + * bls->bls_config.fixed_val.gr = blackLevelGreenR_; > > > + * bls->bls_config.fixed_val.gb = blackLevelGreenB_; > > > + * bls->bls_config.fixed_val.b = blackLevelBlue_; > > > + * } > > > + * > > > + * @type: The parameters block type, see > > > + * :c:type:`rkisp1_ext_params_block_type` > > > + * @enable: The block enable flag, see > > > + * :c:type:`rkisp1_ext_params_block_enable` > > > + * @size: Size (in bytes) of the parameters block, including this header > > > + */ > > > +struct rkisp1_ext_params_block_header { > > > + __u32 type; > > > + __u32 enable; > > > + __u32 size; > > > > Would it be useful to use __u16 for all those fields ? The size of the > > header would be reduced from 16 to 8 bytes. We will never have more than > > 64k blocks or enable states :-) I really don't expect any block size of > > more than 64kB for this ISP, but if that's a concern, the size could > > remain a __u32. > > > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_bls_config - RkISP1 extensible params BLS config > > > + * > > > + * RkISP1 extensible parameters Black Level Subtraction configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @bls_config: Black Level Subtraction configuration, see > > > + * :c:type:`rkisp1_cif_isp_bls_config` > > > + */ > > > +struct rkisp1_ext_params_bls_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_bls_config bls_config; > > > > All the blocks have a similar structure, with a header and a config > > structure using the existing parameters structure definitions. I think I > > would rename the "*_config" field names to just "config", adding the > > prefix here makes lines longer and doesn't improve readability. Compare > > the existing example above > > > > bls->bls_config.enable_auto = 0; > > bls->bls_config.fixed_val.r = blackLevelRed_; > > bls->bls_config.fixed_val.gr = blackLevelGreenR_; > > bls->bls_config.fixed_val.gb = blackLevelGreenB_; > > bls->bls_config.fixed_val.b = blackLevelBlue_; > > > > with > > > > bls->config.enable_auto = 0; > > bls->config.fixed_val.r = blackLevelRed_; > > bls->config.fixed_val.gr = blackLevelGreenR_; > > bls->config.fixed_val.gb = blackLevelGreenB_; > > bls->config.fixed_val.b = blackLevelBlue_; > > > > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > > > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_dpcc_config - RkISP1 extensible params DPCC config > > > + * > > > + * RkISP1 extensible parameters Defective Pixel Cluster Correction configuration > > > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @dpcc_config: Defective Pixel Cluster Correction configuration, see > > > + * :c:type:`rkisp1_cif_isp_dpcc_config` > > > + */ > > > +struct rkisp1_ext_params_dpcc_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_dpcc_config dpcc_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_sdg_config - RkISP1 extensible params SDG config > > > + * > > > + * RkISP1 extensible parameters Sensor Degamma configuration block. Identified > > > + * by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @sdg_config: Sensor Degamma configuration, see > > > + * :c:type:`rkisp1_cif_isp_sdg_config` > > > + */ > > > +struct rkisp1_ext_params_sdg_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_sdg_config sdg_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_lsc_config - RkISP1 extensible params LSC config > > > + * > > > + * RkISP1 extensible parameters Lens Shading Correction configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @lsc_config: Lens Shading Correction configuration, see > > > + * :c:type:`rkisp1_cif_isp_lsc_config` > > > + */ > > > +struct rkisp1_ext_params_lsc_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_lsc_config lsc_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_awb_gain_config - RkISP1 extensible params AWB > > > + * gain config > > > + * > > > + * RkISP1 extensible parameters Auto-White Balance Gains configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @awb_config: Auto-White Balance Gains configuration, see > > > + * :c:type:`rkisp1_cif_isp_awb_gain_config` > > > + */ > > > +struct rkisp1_ext_params_awb_gain_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_awb_gain_config awb_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_flt_config - RkISP1 extensible params FLT config > > > + * > > > + * RkISP1 extensible parameters Filter configuration block. Identified by > > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @flt_config: Filter configuration, see > > > + * :c:type:`rkisp1_cif_isp_flt_config` > > > + */ > > > +struct rkisp1_ext_params_flt_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_flt_config flt_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_bdm_config - RkISP1 extensible params BDM config > > > + * > > > + * RkISP1 extensible parameters Demosaicing configuration block. Identified by > > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @bdm_config: Demosaicing configuration, see > > > + * :c:type:`rkisp1_cif_isp_bdm_config` > > > + */ > > > +struct rkisp1_ext_params_bdm_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_bdm_config bdm_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_ctk_config - RkISP1 extensible params CTK config > > > + * > > > + * RkISP1 extensible parameters Cross-Talk configuration block. Identified by > > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @ctk_config: Cross-Talk configuration, see > > > + * :c:type:`rkisp1_cif_isp_ctk_config` > > > + */ > > > +struct rkisp1_ext_params_ctk_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_ctk_config ctk_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_goc_config - RkISP1 extensible params GOC config > > > + * > > > + * RkISP1 extensible parameters Gamma-Out configuration block. Identified by > > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @goc_config: Gamma-Out configuration, see > > > + * :c:type:`rkisp1_cif_isp_goc_config` > > > + */ > > > +struct rkisp1_ext_params_goc_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_goc_config goc_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_dpf_config - RkISP1 extensible params DPF config > > > + * > > > + * RkISP1 extensible parameters De-noise Pre-Filter configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @dpf_config: De-noise Pre-Filter configuration, see > > > + * :c:type:`rkisp1_cif_isp_dpf_config` > > > + */ > > > +struct rkisp1_ext_params_dpf_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_dpf_config dpf_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_dpf_strength_config - RkISP1 extensible params DPF > > > + * strength config > > > + * > > > + * RkISP1 extensible parameters De-noise Pre-Filter strength configuration > > > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @dpf_strength_config: De-noise Pre-Filter strength configuration, see > > > + * :c:type:`rkisp1_cif_isp_dpf_strength_config` > > > + */ > > > +struct rkisp1_ext_params_dpf_strength_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_dpf_strength_config dpf_strength_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_cproc_config - RkISP1 extensible params CPROC config > > > + * > > > + * RkISP1 extensible parameters Color Processing configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @cproc_config: Color processing configuration, see > > > + * :c:type:`rkisp1_cif_isp_cproc_config` > > > + */ > > > +struct rkisp1_ext_params_cproc_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_cproc_config cproc_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_ie_config - RkISP1 extensible params IE config > > > + * > > > + * RkISP1 extensible parameters Image Effect configuration block. Identified by > > > + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_IE`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @ie_config: Image Effect configuration, see > > > + * :c:type:`rkisp1_cif_isp_ie_config` > > > + */ > > > +struct rkisp1_ext_params_ie_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_ie_config ie_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_awb_meas_config - RkISP1 extensible params AWB > > > + * Meas config > > > + * > > > + * RkISP1 extensible parameters Auto-White Balance Measurement configuration > > > + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @awb_meas_config: Auto-White Balance measure configuration, see > > > + * :c:type:`rkisp1_cif_isp_awb_meas_config` > > > + */ > > > +struct rkisp1_ext_params_awb_meas_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_awb_meas_config awb_meas_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_hst_config - RkISP1 extensible params Histogram config > > > + * > > > + * RkISP1 extensible parameters Histogram statistics configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @hst_config: Histogram statistics configuration, see > > > + * :c:type:`rkisp1_cif_isp_hst_config` > > > + */ > > > +struct rkisp1_ext_params_hst_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_hst_config hst_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_aec_config - RkISP1 extensible params AEC config > > > + * > > > + * RkISP1 extensible parameters Auto-Exposure statistics configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @aec_config: Auto-Exposure statistics configuration, see > > > + * :c:type:`rkisp1_cif_isp_aec_config` > > > + */ > > > +struct rkisp1_ext_params_aec_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_aec_config aec_config; > > > +} __attribute__((aligned(8))); > > > + > > > +/** > > > + * struct rkisp1_ext_params_afc_config - RkISP1 extensible params AFC config > > > + * > > > + * RkISP1 extensible parameters Auto-Focus statistics configuration block. > > > + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS`. > > > + * > > > + * @header: The RkISP1 extensible parameters header, see > > > + * :c:type:`rkisp1_ext_params_block_header` > > > + * @afc_config: Auto-Focus statistics configuration, see > > > + * :c:type:`rkisp1_cif_isp_afc_config` > > > + */ > > > +struct rkisp1_ext_params_afc_config { > > > + struct rkisp1_ext_params_block_header header; > > > + struct rkisp1_cif_isp_afc_config afc_config; > > > +} __attribute__((aligned(8))); > > > + > > > +#define RKISP1_EXT_PARAMS_MAX_SIZE \ > > > + (sizeof(struct rkisp1_ext_params_bls_config) +\ > > > + sizeof(struct rkisp1_ext_params_dpcc_config) +\ > > > + sizeof(struct rkisp1_ext_params_sdg_config) +\ > > > + sizeof(struct rkisp1_ext_params_lsc_config) +\ > > > + sizeof(struct rkisp1_ext_params_awb_gain_config) +\ > > > + sizeof(struct rkisp1_ext_params_flt_config) +\ > > > + sizeof(struct rkisp1_ext_params_bdm_config) +\ > > > + sizeof(struct rkisp1_ext_params_ctk_config) +\ > > > + sizeof(struct rkisp1_ext_params_goc_config) +\ > > > + sizeof(struct rkisp1_ext_params_dpf_config) +\ > > > + sizeof(struct rkisp1_ext_params_dpf_strength_config) +\ > > > + sizeof(struct rkisp1_ext_params_cproc_config) +\ > > > + sizeof(struct rkisp1_ext_params_ie_config) +\ > > > + sizeof(struct rkisp1_ext_params_awb_meas_config) +\ > > > + sizeof(struct rkisp1_ext_params_hst_config) +\ > > > + sizeof(struct rkisp1_ext_params_aec_config) +\ > > > + sizeof(struct rkisp1_ext_params_afc_config)) > > > + > > > +/** > > > + * enum rksip1_ext_param_buffer_version - RkISP1 extensible parameters version > > > + * > > > + * @RKISP1_EXT_PARAM_BUFFER_V1: First version of RkISP1 extensible parameters > > > + */ > > > +enum rksip1_ext_param_buffer_version { > > > + RKISP1_EXT_PARAM_BUFFER_V1 = 1, > > > +}; > > > + > > > +/** > > > + * struct rkisp1_ext_params_cfg - RkISP1 extensible parameters configuration > > > + * > > > + * This struct contains the configuration parameters of the RkISP1 ISP > > > + * algorithms, serialized by userspace into a data buffer. Each configuration > > > + * parameter block is represented by a block-specific structure which contains a > > > + * :c:type:`rkisp1_ext_params_block_header` entry as first member. Userspace > > > + * populates the @data buffer with configuration parameters for the blocks that > > > + * it intends to configure. As a consequence, the data buffer effective size > > > + * changes according to the number of ISP blocks that userspace intends to > > > + * configure and is set by userspace in the @total_size field. > > > + * > > > + * The parameters buffer is versioned by the @version field to allow modifying > > > + * and extending its definition. Userspace shall populate the @version field to > > > + * inform the driver about the version it intends to use. The driver will parse > > > + * and handle the @data buffer according to the data layout specific to the > > > + * indicated version and return an error if the desired version is not > > > + * supported. > > > + * > > > + * For each ISP block that userspace wants to configure, a block-specific > > > + * structure is appended to the @data buffer, one after the other without gaps > > > + * in between nor overlaps. Userspace shall populate the @total_size field with > > > + * the effective size, in bytes, of the @data buffer. > > > + * > > > + * The expected memory layout of the parameters buffer is:: > > > + * > > > + * +-------------------- struct rkisp1_ext_params_cfg -------------------+ > > > + * | version = RKISP_EXT_PARAMS_BUFFER_V1; | > > > + * | total_size = sizeof(struct rkisp1_ext_params_bls_config) | > > > + * | sizeof(struct rkisp1_ext_params_dpcc_config); | > > > + * | +------------------------- data ---------------------------------+ | > > > + * | | +------------- struct rkisp1_ext_params_bls_config -----------+ | | > > > + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | > > > + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS; | | | | > > > + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | > > > + * | | | | size = sizeof(struct rkisp1_ext_params_bls_config); | | | | > > > + * | | | +---------------------------------------------------------+ | | | > > > + * | | | +---------- struct rkisp1_cif_isp_bls_config -------------+ | | | > > > + * | | | | enable_auto = 0; | | | | > > > + * | | | | fixed_val.r = 256; | | | | > > > + * | | | | fixed_val.gr = 256; | | | | > > > + * | | | | fixed_val.gb = 256; | | | | > > > + * | | | | fixed_val.b = 256; | | | | > > > + * | | | +---------------------------------------------------------+ | | | > > > + * | | +------------ struct rkisp1_ext_params_dpcc_config -----------+ | | > > > + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | > > > + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC; | | | | > > > + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | > > > + * | | | | size = sizeof(struct rkisp1_ext_params_dpcc_config); | | | | > > > + * | | | +---------------------------------------------------------+ | | | > > > + * | | | +---------- struct rkisp1_cif_isp_dpcc_config ------------+ | | | > > > + * | | | | mode = RKISP1_CIF_ISP_DPCC_MODE_STAGE1_ENABLE; | | | | > > > + * | | | | output_mode = | | | | > > > + * | | | | RKISP1_CIF_ISP_DPCC_OUTPUT_MODE_STAGE1_INCL_G_CENTER; | | | | > > > + * | | | | set_use = ... ; | | | | > > > + * | | | | ... = ... ; | | | | > > > + * | | | +---------------------------------------------------------+ | | | > > > + * | | +-------------------------------------------------------------+ | | > > > + * | +-----------------------------------------------------------------+ | > > > + * +---------------------------------------------------------------------+ > > > + * > > > + * @version: The RkISP1 extensible parameters buffer version, see > > > + * :c:type:`rksip1_ext_param_buffer_version` > > > + * @total_size: The RkISP1 configuration data effective size, excluding this > > > + * header > > > + * @data: The RkISP1 extensible configuration data blocks > > > + */ > > > +struct rkisp1_ext_params_cfg { > > > + __u32 version; > > > + __u32 total_size; And yet another comment: as this is the data size, how about naming it data_size ? While reviewing other patches I had to read the documentation a few times to check if total_size included the header of this structure. > > > + __u8 data[RKISP1_EXT_PARAMS_MAX_SIZE]; > > > +}; > > > + > > > #endif /* _UAPI_RKISP1_CONFIG_H */
diff --git a/include/uapi/linux/rkisp1-config.h b/include/uapi/linux/rkisp1-config.h index 6eeaf8bf2362..900e04a67a81 100644 --- a/include/uapi/linux/rkisp1-config.h +++ b/include/uapi/linux/rkisp1-config.h @@ -996,4 +996,501 @@ struct rkisp1_stat_buffer { struct rkisp1_cif_isp_stat params; }; +/*---------- PART3: Extensible Configuration Parameters ------------*/ + +/** + * enum rkisp1_ext_params_block_type - RkISP1 extensible params block type + * + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS: Black level subtraction + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC: Defect pixel cluster correction + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG: Sensor de-gamma + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS: Auto white balance gains + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT: ISP filtering + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM: Bayer de-mosaic + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK: Cross-talk correction + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC: Gamma out correction + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF: De-noise pre-filter + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH: De-noise pre-filter strength + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC: Color processing + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_IE: Image effects + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC: Lens shading correction + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS: Auto white balance statistics + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS: Histogram statistics + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS: Auto exposure statistics + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS: Auto-focus statistics + * @RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL: Sentinel + */ +enum rkisp1_ext_params_block_type { + RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS, + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC, + RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG, + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS, + RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT, + RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM, + RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK, + RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC, + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF, + RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH, + RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC, + RKISP1_EXT_PARAMS_BLOCK_TYPE_IE, + RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC, + RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS, + RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS, + RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS, + RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS, + RKISP1_EXT_PARAMS_BLOCK_TYPE_SENTINEL, +}; + +/** + * enum rkisp1_ext_params_block_enable - RkISP1 extensible parameter block + * enable flags + * + * @RKISP1_EXT_PARAMS_BLOCK_DISABLE: Disable the HW block + * @RKISP1_EXT_PARAMS_BLOCK_ENABLE: Enable the HW block + */ +enum rkisp1_ext_params_block_enable { + RKISP1_EXT_PARAMS_BLOCK_DISABLE, + RKISP1_EXT_PARAMS_BLOCK_ENABLE, +}; + +/** + * struct rkisp1_ext_params_block_header - RkISP1 extensible parameter block + * header + * + * This structure represents the common part of all the ISP configuration + * blocks. Each parameters block shall embed an instance of this structure type + * as its first member, followed by the block-specific configuration data. The + * driver inspects this common header to discern the block type and its size and + * properly handle the block content by casting it to the correct block-specific + * type. + * + * The @type field is one of the values enumerated by + * :c:type:`rkisp1_ext_params_block_type` and specifies how the data should be + * interpreted by the driver. The @size field specifies the size of the + * parameters block and is used by the driver for validation purposes. + * + * The @enable field specifies the ISP block enablement state. The possible + * enablement states are enumerated by :c:type:`rkisp1_ext_params_block_enable`. + * When userspace needs to configure and enable an ISP block it shall fully + * populate the block configuration and the @enable flag shall be set to + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. When userspace simply wants to disable the + * ISP block the @enable flag shall be set to RKISP1_EXT_PARAMS_BLOCK_DISABLE. + * The driver ignores the rest of the block configuration structure in this + * case. + * + * If a new configuration of an ISP block has to be applied userspace shall + * fully populate the ISP block configuration and set the @enable flag to + * RKISP1_EXT_PARAMS_BLOCK_ENABLE. + * + * Userspace is responsible for correctly populating the parameters block header + * fields (@type, @enable and @size) and correctly populate the block-specific + * parameters. + * + * For example: + * + * .. code-block:: c + * + * void populate_bls(struct rkisp1_ext_params_block_header *block) { + * struct rkisp1_ext_params_bls_config *bls = + * (struct rkisp1_ext_params_bls_config *)block; + * + * block->header.type = RKISP1_EXT_PARAMS_BLOCK_ID_BLS; + * block->header.enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; + * block->header.size = sizeof(struct rkisp1_ext_params_bls_config); + * + * bls->bls_config.enable_auto = 0; + * bls->bls_config.fixed_val.r = blackLevelRed_; + * bls->bls_config.fixed_val.gr = blackLevelGreenR_; + * bls->bls_config.fixed_val.gb = blackLevelGreenB_; + * bls->bls_config.fixed_val.b = blackLevelBlue_; + * } + * + * @type: The parameters block type, see + * :c:type:`rkisp1_ext_params_block_type` + * @enable: The block enable flag, see + * :c:type:`rkisp1_ext_params_block_enable` + * @size: Size (in bytes) of the parameters block, including this header + */ +struct rkisp1_ext_params_block_header { + __u32 type; + __u32 enable; + __u32 size; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_bls_config - RkISP1 extensible params BLS config + * + * RkISP1 extensible parameters Black Level Subtraction configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @bls_config: Black Level Subtraction configuration, see + * :c:type:`rkisp1_cif_isp_bls_config` + */ +struct rkisp1_ext_params_bls_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_bls_config bls_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_dpcc_config - RkISP1 extensible params DPCC config + * + * RkISP1 extensible parameters Defective Pixel Cluster Correction configuration + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @dpcc_config: Defective Pixel Cluster Correction configuration, see + * :c:type:`rkisp1_cif_isp_dpcc_config` + */ +struct rkisp1_ext_params_dpcc_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_dpcc_config dpcc_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_sdg_config - RkISP1 extensible params SDG config + * + * RkISP1 extensible parameters Sensor Degamma configuration block. Identified + * by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_SDG`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @sdg_config: Sensor Degamma configuration, see + * :c:type:`rkisp1_cif_isp_sdg_config` + */ +struct rkisp1_ext_params_sdg_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_sdg_config sdg_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_lsc_config - RkISP1 extensible params LSC config + * + * RkISP1 extensible parameters Lens Shading Correction configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_LSC`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @lsc_config: Lens Shading Correction configuration, see + * :c:type:`rkisp1_cif_isp_lsc_config` + */ +struct rkisp1_ext_params_lsc_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_lsc_config lsc_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_awb_gain_config - RkISP1 extensible params AWB + * gain config + * + * RkISP1 extensible parameters Auto-White Balance Gains configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_GAINS`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @awb_config: Auto-White Balance Gains configuration, see + * :c:type:`rkisp1_cif_isp_awb_gain_config` + */ +struct rkisp1_ext_params_awb_gain_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_awb_gain_config awb_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_flt_config - RkISP1 extensible params FLT config + * + * RkISP1 extensible parameters Filter configuration block. Identified by + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_FLT`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @flt_config: Filter configuration, see + * :c:type:`rkisp1_cif_isp_flt_config` + */ +struct rkisp1_ext_params_flt_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_flt_config flt_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_bdm_config - RkISP1 extensible params BDM config + * + * RkISP1 extensible parameters Demosaicing configuration block. Identified by + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_BDM`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @bdm_config: Demosaicing configuration, see + * :c:type:`rkisp1_cif_isp_bdm_config` + */ +struct rkisp1_ext_params_bdm_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_bdm_config bdm_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_ctk_config - RkISP1 extensible params CTK config + * + * RkISP1 extensible parameters Cross-Talk configuration block. Identified by + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CTK`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @ctk_config: Cross-Talk configuration, see + * :c:type:`rkisp1_cif_isp_ctk_config` + */ +struct rkisp1_ext_params_ctk_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_ctk_config ctk_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_goc_config - RkISP1 extensible params GOC config + * + * RkISP1 extensible parameters Gamma-Out configuration block. Identified by + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_GOC`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @goc_config: Gamma-Out configuration, see + * :c:type:`rkisp1_cif_isp_goc_config` + */ +struct rkisp1_ext_params_goc_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_goc_config goc_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_dpf_config - RkISP1 extensible params DPF config + * + * RkISP1 extensible parameters De-noise Pre-Filter configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @dpf_config: De-noise Pre-Filter configuration, see + * :c:type:`rkisp1_cif_isp_dpf_config` + */ +struct rkisp1_ext_params_dpf_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_dpf_config dpf_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_dpf_strength_config - RkISP1 extensible params DPF + * strength config + * + * RkISP1 extensible parameters De-noise Pre-Filter strength configuration + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_DPF_STRENGTH`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @dpf_strength_config: De-noise Pre-Filter strength configuration, see + * :c:type:`rkisp1_cif_isp_dpf_strength_config` + */ +struct rkisp1_ext_params_dpf_strength_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_dpf_strength_config dpf_strength_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_cproc_config - RkISP1 extensible params CPROC config + * + * RkISP1 extensible parameters Color Processing configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_CPROC`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @cproc_config: Color processing configuration, see + * :c:type:`rkisp1_cif_isp_cproc_config` + */ +struct rkisp1_ext_params_cproc_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_cproc_config cproc_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_ie_config - RkISP1 extensible params IE config + * + * RkISP1 extensible parameters Image Effect configuration block. Identified by + * :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_IE`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @ie_config: Image Effect configuration, see + * :c:type:`rkisp1_cif_isp_ie_config` + */ +struct rkisp1_ext_params_ie_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_ie_config ie_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_awb_meas_config - RkISP1 extensible params AWB + * Meas config + * + * RkISP1 extensible parameters Auto-White Balance Measurement configuration + * block. Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AWB_MEAS`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @awb_meas_config: Auto-White Balance measure configuration, see + * :c:type:`rkisp1_cif_isp_awb_meas_config` + */ +struct rkisp1_ext_params_awb_meas_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_awb_meas_config awb_meas_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_hst_config - RkISP1 extensible params Histogram config + * + * RkISP1 extensible parameters Histogram statistics configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_HST_MEAS`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @hst_config: Histogram statistics configuration, see + * :c:type:`rkisp1_cif_isp_hst_config` + */ +struct rkisp1_ext_params_hst_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_hst_config hst_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_aec_config - RkISP1 extensible params AEC config + * + * RkISP1 extensible parameters Auto-Exposure statistics configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AEC_MEAS`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @aec_config: Auto-Exposure statistics configuration, see + * :c:type:`rkisp1_cif_isp_aec_config` + */ +struct rkisp1_ext_params_aec_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_aec_config aec_config; +} __attribute__((aligned(8))); + +/** + * struct rkisp1_ext_params_afc_config - RkISP1 extensible params AFC config + * + * RkISP1 extensible parameters Auto-Focus statistics configuration block. + * Identified by :c:type:`RKISP1_EXT_PARAMS_BLOCK_TYPE_AFC_MEAS`. + * + * @header: The RkISP1 extensible parameters header, see + * :c:type:`rkisp1_ext_params_block_header` + * @afc_config: Auto-Focus statistics configuration, see + * :c:type:`rkisp1_cif_isp_afc_config` + */ +struct rkisp1_ext_params_afc_config { + struct rkisp1_ext_params_block_header header; + struct rkisp1_cif_isp_afc_config afc_config; +} __attribute__((aligned(8))); + +#define RKISP1_EXT_PARAMS_MAX_SIZE \ + (sizeof(struct rkisp1_ext_params_bls_config) +\ + sizeof(struct rkisp1_ext_params_dpcc_config) +\ + sizeof(struct rkisp1_ext_params_sdg_config) +\ + sizeof(struct rkisp1_ext_params_lsc_config) +\ + sizeof(struct rkisp1_ext_params_awb_gain_config) +\ + sizeof(struct rkisp1_ext_params_flt_config) +\ + sizeof(struct rkisp1_ext_params_bdm_config) +\ + sizeof(struct rkisp1_ext_params_ctk_config) +\ + sizeof(struct rkisp1_ext_params_goc_config) +\ + sizeof(struct rkisp1_ext_params_dpf_config) +\ + sizeof(struct rkisp1_ext_params_dpf_strength_config) +\ + sizeof(struct rkisp1_ext_params_cproc_config) +\ + sizeof(struct rkisp1_ext_params_ie_config) +\ + sizeof(struct rkisp1_ext_params_awb_meas_config) +\ + sizeof(struct rkisp1_ext_params_hst_config) +\ + sizeof(struct rkisp1_ext_params_aec_config) +\ + sizeof(struct rkisp1_ext_params_afc_config)) + +/** + * enum rksip1_ext_param_buffer_version - RkISP1 extensible parameters version + * + * @RKISP1_EXT_PARAM_BUFFER_V1: First version of RkISP1 extensible parameters + */ +enum rksip1_ext_param_buffer_version { + RKISP1_EXT_PARAM_BUFFER_V1 = 1, +}; + +/** + * struct rkisp1_ext_params_cfg - RkISP1 extensible parameters configuration + * + * This struct contains the configuration parameters of the RkISP1 ISP + * algorithms, serialized by userspace into a data buffer. Each configuration + * parameter block is represented by a block-specific structure which contains a + * :c:type:`rkisp1_ext_params_block_header` entry as first member. Userspace + * populates the @data buffer with configuration parameters for the blocks that + * it intends to configure. As a consequence, the data buffer effective size + * changes according to the number of ISP blocks that userspace intends to + * configure and is set by userspace in the @total_size field. + * + * The parameters buffer is versioned by the @version field to allow modifying + * and extending its definition. Userspace shall populate the @version field to + * inform the driver about the version it intends to use. The driver will parse + * and handle the @data buffer according to the data layout specific to the + * indicated version and return an error if the desired version is not + * supported. + * + * For each ISP block that userspace wants to configure, a block-specific + * structure is appended to the @data buffer, one after the other without gaps + * in between nor overlaps. Userspace shall populate the @total_size field with + * the effective size, in bytes, of the @data buffer. + * + * The expected memory layout of the parameters buffer is:: + * + * +-------------------- struct rkisp1_ext_params_cfg -------------------+ + * | version = RKISP_EXT_PARAMS_BUFFER_V1; | + * | total_size = sizeof(struct rkisp1_ext_params_bls_config) | + * | sizeof(struct rkisp1_ext_params_dpcc_config); | + * | +------------------------- data ---------------------------------+ | + * | | +------------- struct rkisp1_ext_params_bls_config -----------+ | | + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_BLS; | | | | + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | + * | | | | size = sizeof(struct rkisp1_ext_params_bls_config); | | | | + * | | | +---------------------------------------------------------+ | | | + * | | | +---------- struct rkisp1_cif_isp_bls_config -------------+ | | | + * | | | | enable_auto = 0; | | | | + * | | | | fixed_val.r = 256; | | | | + * | | | | fixed_val.gr = 256; | | | | + * | | | | fixed_val.gb = 256; | | | | + * | | | | fixed_val.b = 256; | | | | + * | | | +---------------------------------------------------------+ | | | + * | | +------------ struct rkisp1_ext_params_dpcc_config -----------+ | | + * | | | +-------- struct rkisp1_ext_params_block_header ---------+ | | | + * | | | | type = RKISP1_EXT_PARAMS_BLOCK_TYPE_DPCC; | | | | + * | | | | enable = RKISP1_EXT_PARAMS_BLOCK_ENABLE; | | | | + * | | | | size = sizeof(struct rkisp1_ext_params_dpcc_config); | | | | + * | | | +---------------------------------------------------------+ | | | + * | | | +---------- struct rkisp1_cif_isp_dpcc_config ------------+ | | | + * | | | | mode = RKISP1_CIF_ISP_DPCC_MODE_STAGE1_ENABLE; | | | | + * | | | | output_mode = | | | | + * | | | | RKISP1_CIF_ISP_DPCC_OUTPUT_MODE_STAGE1_INCL_G_CENTER; | | | | + * | | | | set_use = ... ; | | | | + * | | | | ... = ... ; | | | | + * | | | +---------------------------------------------------------+ | | | + * | | +-------------------------------------------------------------+ | | + * | +-----------------------------------------------------------------+ | + * +---------------------------------------------------------------------+ + * + * @version: The RkISP1 extensible parameters buffer version, see + * :c:type:`rksip1_ext_param_buffer_version` + * @total_size: The RkISP1 configuration data effective size, excluding this + * header + * @data: The RkISP1 extensible configuration data blocks + */ +struct rkisp1_ext_params_cfg { + __u32 version; + __u32 total_size; + __u8 data[RKISP1_EXT_PARAMS_MAX_SIZE]; +}; + #endif /* _UAPI_RKISP1_CONFIG_H */
Add to the rkisp1-config.h header data types and documentation of the extensible parameters format. Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> --- include/uapi/linux/rkisp1-config.h | 497 +++++++++++++++++++++++++++++ 1 file changed, 497 insertions(+)