drm/i915/gvt: Fix intel_vgpu_gpa_to_mmio_offset kernel docs

intel_vgpu_gpa_to_mmio_offset states that it returns
'Zero on success, negative error code if failed'
in the kernel docs.

This is false.  The function actually returns
'The MMIO offset of the given GPA'.
Correct the docs.

Signed-off-by: Jonathan Cavitt <jonathan.cavitt@intel.com>
Reviewed-by: Andi Shyti <andi.shyti@linux.intel.com>
Reviewed-by: Zhenyu Wang <zhenyuw.linux@gmail.com>
Signed-off-by: Andi Shyti <andi.shyti@linux.intel.com>
Link: https://lore.kernel.org/r/20250916174317.76521-6-jonathan.cavitt@intel.com
This commit is contained in:
Jonathan Cavitt
2025-09-16 17:43:20 +00:00
committed by Andi Shyti
parent f80fb92174
commit 96e556ef5c

View File

@@ -49,7 +49,7 @@
* @gpa: guest physical address
*
* Returns:
* Zero on success, negative error code if failed
* The MMIO offset of the given GPA
*/
int intel_vgpu_gpa_to_mmio_offset(struct intel_vgpu *vgpu, u64 gpa)
{