Re: [PATCH v9 09/20] drm/xe/vsec: Add DOC text for VSEC

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] drm/xe: documentation mismatch in xe_pmt_telem_read() returns
- [Low] drm/xe: typo 'setup up' in VSEC DOC text
--

commit 736841e08f59ea271b755582813f79005c246879
Author: Michael J. Ruhl <michael.j.ruhl@intel.com>

drm/xe/vsec: Add DOC text for VSEC

Add the necessary files and text to use the DOC system.

> diff --git a/drivers/gpu/drm/xe/xe_vsec.c b/drivers/gpu/drm/xe/xe_vsec.c
> index 1cb9a78ee0efd..ca5d02dce8189 100644
> --- a/drivers/gpu/drm/xe/xe_vsec.c
> +++ b/drivers/gpu/drm/xe/xe_vsec.c
> @@ -19,6 +19,17 @@
>  
>  #include "regs/xe_pmt.h"
>  
> +/**
> + * DOC: VSEC
> + *
> + * Some GPUs support the PMT feature.  For those that do, this API provides
> + * probe, discovery and usage (control and access) for GPUs that have PMT.
> + *
> + * PMT is usually accessed through a PCI function.  However, that is not always
> + * available, so the PMT intel_vsec_register() function can be used to setup up
                                                                         ^^^^^^^^

[Severity: Low]
This isn't a bug, but there is a typo (setup up) in the newly added VSEC
documentation header.

> + * PMT usage.
> + */
> +

[ ... ]

> @@ -140,6 +151,18 @@ static int xe_guid_decode(u32 guid, int *index, u32 *offset)
>  	return 0;
>  }
>  
> +/**
> + * xe_pmt_telem_read - Given a device and a PMT GUID, read data into a buffer
> + * @dev: valid Xe device
> + * @guid: PMT GUID (from the PMT discovery struct)
> + * @data: buffer to place data in
> + * @user_offset: a user offset relative to the beginning of the data to read
> + * @count: bytes to read
> + *
> + * Return:
> + * * -EINVAL for VF and PMT WATCHER requests
> + * * count   number of bytes read on success
> + */

[Severity: Low]
Is this documentation entirely accurate?

It claims to return -EINVAL for VF requests, but xe_pmt_telem_read() actually
uses an assertion (xe_assert) instead.

Additionally, the documentation completely omits the -ENODEV (from invalid
device IDs) and -ENODATA (from xe_pm_runtime_get_if_active failures) return
values.

>  int xe_pmt_telem_read(struct device *dev, u32 guid, u64 *data, loff_t user_offset,
>  		      u32 count)
>  {

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260916201139.2374531-22-michael.j.ruhl@intel.com?part=9