[PATCH] media: uapi: Fix C3 ISP type references in kernel-doc

[PATCH] media: uapi: Fix C3 ISP type references in kernel-doc

[Karl Mehltretter]

The C3 ISP UAPI comments use singular names for the AWB, AE, and AF tap
point enums, and misspell the parameter block header struct. The
corresponding definitions already used the correct names when these
comments were introduced.

Refer to c3_isp_params_awb_tap_points, c3_isp_params_ae_tap_points,
c3_isp_params_af_tap_points, and c3_isp_params_block_header.

Fixes: 6d406187ebc0 ("media: uapi: Add stats info and parameters buffer for C3 ISP")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 include/uapi/linux/media/amlogic/c3-isp-config.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/uapi/linux/media/amlogic/c3-isp-config.h b/include/uapi/linux/media/amlogic/c3-isp-config.h
index 92db5dcdda181cb31665e230cc56b443fa37a0be..fc70b3124ccacff635a7d9c0135d4e3821ba1a33 100644
--- a/include/uapi/linux/media/amlogic/c3-isp-config.h
+++ b/include/uapi/linux/media/amlogic/c3-isp-config.h
@@ -247,7 +247,7 @@ enum c3_isp_params_awb_tap_points {
  * from :c:type:`c3_isp_params_block_type`
  *
  * @header: the C3 ISP parameters block header
- * @tap_point: the tap point from enum c3_isp_params_awb_tap_point
+ * @tap_point: the tap point from enum c3_isp_params_awb_tap_points
  * @satur_vald: AWB statistic over saturation control
  *		value: 0: disable, 1: enable
  * @horiz_zones_num: active number of hotizontal zones [0..32]
@@ -305,7 +305,7 @@ enum c3_isp_params_ae_tap_points {
  * @header: the C3 ISP parameters block header
  * @horiz_zones_num: active number of horizontal zones [0..17]
  * @vert_zones_num: active number of vertical zones [0..15]
- * @tap_point: the tap point from enum c3_isp_params_ae_tap_point
+ * @tap_point: the tap point from enum c3_isp_params_ae_tap_points
  * @zone_weight: array of weights for AE statistics zones [0..15]
  * @horiz_coord: the horizontal coordinate of points on the diagonal [0..2888]
  * @vert_coord: the vertical coordinate of points on the diagonal [0..2240]
@@ -342,7 +342,7 @@ enum c3_isp_params_af_tap_points {
  * from :c:type:`c3_isp_params_block_type`
  *
  * @header: the C3 ISP parameters block header
- * @tap_point: the tap point from enum c3_isp_params_af_tap_point
+ * @tap_point: the tap point from enum c3_isp_params_af_tap_points
  * @horiz_zones_num: active number of hotizontal zones [0..17]
  * @vert_zones_num: active number of vertical zones [0..15]
  * @reserved: applications must zero this array
@@ -487,7 +487,7 @@ struct c3_isp_params_blc {
  *	| | | b_gain = ...;                                               | | |
  *	| | | gb_gain = ...;                                              | | |
  *	| | +------------------ struct c3_isp_params_awb_config ----------+ | |
- *	| | | +---------- struct c3_isp_param_block_header header ------+ | | |
+ *	| | | +---------- struct c3_isp_params_block_header header -----+ | | |
  *	| | | | type = C3_ISP_PARAMS_BLOCK_AWB_CONFIG;                  | | | |
  *	| | | | flags = C3_ISP_PARAMS_BLOCK_FL_NONE;                    | | | |
  *	| | | | size = sizeof(struct c3_isp_params_awb_config)          | | | |
-- 
2.39.5 (Apple Git-154)

Re: [PATCH] media: uapi: Fix C3 ISP type references in kernel-doc

[Keke Li]

Hi Karl,

Thanks for your patch.

On 9/12/26 07:30, Karl Mehltretter wrote:
> [You don't often get email from kmehltretter@gmail.com. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
>
> [ EXTERNAL EMAIL ]
>
> The C3 ISP UAPI comments use singular names for the AWB, AE, and AF tap
> point enums, and misspell the parameter block header struct. The
> corresponding definitions already used the correct names when these
> comments were introduced.
>
> Refer to c3_isp_params_awb_tap_points, c3_isp_params_ae_tap_points,
> c3_isp_params_af_tap_points, and c3_isp_params_block_header.
>
> Fixes: 6d406187ebc0 ("media: uapi: Add stats info and parameters buffer for C3 ISP")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>   include/uapi/linux/media/amlogic/c3-isp-config.h | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/include/uapi/linux/media/amlogic/c3-isp-config.h b/include/uapi/linux/media/amlogic/c3-isp-config.h
> index 92db5dcdda181cb31665e230cc56b443fa37a0be..fc70b3124ccacff635a7d9c0135d4e3821ba1a33 100644
> --- a/include/uapi/linux/media/amlogic/c3-isp-config.h
> +++ b/include/uapi/linux/media/amlogic/c3-isp-config.h
> @@ -247,7 +247,7 @@ enum c3_isp_params_awb_tap_points {
>    * from :c:type:`c3_isp_params_block_type`
>    *
>    * @header: the C3 ISP parameters block header
> - * @tap_point: the tap point from enum c3_isp_params_awb_tap_point
> + * @tap_point: the tap point from enum c3_isp_params_awb_tap_points
>    * @satur_vald: AWB statistic over saturation control
>    *             value: 0: disable, 1: enable
>    * @horiz_zones_num: active number of hotizontal zones [0..32]
> @@ -305,7 +305,7 @@ enum c3_isp_params_ae_tap_points {
>    * @header: the C3 ISP parameters block header
>    * @horiz_zones_num: active number of horizontal zones [0..17]
>    * @vert_zones_num: active number of vertical zones [0..15]
> - * @tap_point: the tap point from enum c3_isp_params_ae_tap_point
> + * @tap_point: the tap point from enum c3_isp_params_ae_tap_points
>    * @zone_weight: array of weights for AE statistics zones [0..15]
>    * @horiz_coord: the horizontal coordinate of points on the diagonal [0..2888]
>    * @vert_coord: the vertical coordinate of points on the diagonal [0..2240]
> @@ -342,7 +342,7 @@ enum c3_isp_params_af_tap_points {
>    * from :c:type:`c3_isp_params_block_type`
>    *
>    * @header: the C3 ISP parameters block header
> - * @tap_point: the tap point from enum c3_isp_params_af_tap_point
> + * @tap_point: the tap point from enum c3_isp_params_af_tap_points
>    * @horiz_zones_num: active number of hotizontal zones [0..17]
>    * @vert_zones_num: active number of vertical zones [0..15]
>    * @reserved: applications must zero this array
> @@ -487,7 +487,7 @@ struct c3_isp_params_blc {
>    *     | | | b_gain = ...;                                               | | |
>    *     | | | gb_gain = ...;                                              | | |
>    *     | | +------------------ struct c3_isp_params_awb_config ----------+ | |
> - *     | | | +---------- struct c3_isp_param_block_header header ------+ | | |
> + *     | | | +---------- struct c3_isp_params_block_header header -----+ | | |
>    *     | | | | type = C3_ISP_PARAMS_BLOCK_AWB_CONFIG;                  | | | |
>    *     | | | | flags = C3_ISP_PARAMS_BLOCK_FL_NONE;                    | | | |
>    *     | | | | size = sizeof(struct c3_isp_params_awb_config)          | | | |


This change appears to be unnecessary.

Thanks!

> --
> 2.39.5 (Apple Git-154)
>