[PATCH v3] drm/xe/oa: Fix kernel doc warnings in xe_drm.h

[Michal Wajdeczko]

On 23.06.2024 22:31, Ashutosh Dixit wrote:
> Fix kernel doc warnings in xe_drm.h. Also eliminate private/non-abi enum
> definitions.
> 
> v2: Remove __DRM_XE_PERF_TYPE_MAX since it is unused (Michal)
> v3: Also remove DRM_XE_OA_PROPERTY_MAX since it can also be eliminated (Michal)
> 
> Suggested-by: Michal Wajdeczko <michal.wajdeczko at intel.com>
> Signed-off-by: Ashutosh Dixit <ashutosh.dixit at intel.com>

some nits below, but in general LGTM, so

Reviewed-by: Michal Wajdeczko <michal.wajdeczko at intel.com>

and I'm assuming it's not too late for such uabi fixups, but better to
wait for ack from Rodrigo

> ---
>  drivers/gpu/drm/xe/xe_oa.c | 3 ++-
>  include/uapi/drm/xe_drm.h  | 5 +----
>  2 files changed, 3 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/gpu/drm/xe/xe_oa.c b/drivers/gpu/drm/xe/xe_oa.c
> index 4168b51cf7b5..9263ae9a864e 100644
> --- a/drivers/gpu/drm/xe/xe_oa.c
> +++ b/drivers/gpu/drm/xe/xe_oa.c
> @@ -1684,6 +1684,7 @@ static const xe_oa_user_extension_fn xe_oa_user_extension_funcs[] = {
>  	[DRM_XE_OA_EXTENSION_SET_PROPERTY] = xe_oa_user_ext_set_property,
>  };
>  
> +#define MAX_USER_EXTENSIONS	16

nit: maybe it's worth to put small comment saying this is our choice to
limit number of nested user extensions we want to support (or at least
this is how I understood this)

nit: and this doesn't really look like OA specific limitation, so maybe
it's time to promote MAX_USER_EXTENSIONS to some shared location to make
it unified across driver

>  static int xe_oa_user_extensions(struct xe_oa *oa, u64 extension, int ext_number,
>  				 struct xe_oa_open_param *param)
>  {
> @@ -1692,7 +1693,7 @@ static int xe_oa_user_extensions(struct xe_oa *oa, u64 extension, int ext_number
>  	int err;
>  	u32 idx;
>  
> -	if (XE_IOCTL_DBG(oa->xe, ext_number >= DRM_XE_OA_PROPERTY_MAX))
> +	if (XE_IOCTL_DBG(oa->xe, ext_number >= MAX_USER_EXTENSIONS))
>  		return -E2BIG;
>  
>  	err = __copy_from_user(&ext, address, sizeof(ext));
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index 93e00be44b2d..b410553faa9b 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -1379,8 +1379,8 @@ struct drm_xe_wait_user_fence {
>   * enum drm_xe_perf_type - Perf stream types
>   */
>  enum drm_xe_perf_type {
> +	/** @DRM_XE_PERF_TYPE_OA: OA perf stream type */
>  	DRM_XE_PERF_TYPE_OA,
> -	__DRM_XE_PERF_TYPE_MAX, /* non-ABI */
>  };
>  
>  /**
> @@ -1611,9 +1611,6 @@ enum drm_xe_oa_property_id {
>  	 * pass along with @DRM_XE_OA_PROPERTY_EXEC_QUEUE_ID or will default to 0.
>  	 */
>  	DRM_XE_OA_PROPERTY_OA_ENGINE_INSTANCE,
> -
> -	/** @DRM_XE_OA_PROPERTY_MAX: non-ABI */
> -	DRM_XE_OA_PROPERTY_MAX
>  };
>  
>  /**