Commit 3cbf5e3c46e6 ("gpu: host1x: Allow entries in BO caches to be
freed") added a kernel-doc comment for struct host1x_bo_ops that only
describes the .pin and .unpin callbacks. Since include/linux/host1x.h
is pulled into Documentation/gpu/tegra.rst, this produces four
kernel-doc warnings during the htmldocs build:
include/linux/host1x.h:159 struct member 'get' not described in
'host1x_bo_ops'
include/linux/host1x.h:159 struct member 'put' not described in
'host1x_bo_ops'
include/linux/host1x.h:159 struct member 'mmap' not described in
'host1x_bo_ops'
include/linux/host1x.h:159 struct member 'munmap' not described in
'host1x_bo_ops'
Describe .get, .put, .mmap and .munmap, based on how they are used by
host1x_bo_get(), host1x_bo_put(), host1x_bo_mmap() and
host1x_bo_munmap(), and on the Tegra DRM implementations in
drivers/gpu/drm/tegra/gem.c.
The warnings were found by running scripts/kernel-doc over the headers
pulled into the htmldocs build. An AI coding assistant (Claude Opus
5.5) was used to locate the warnings and draft this change; it was
verified with scripts/kernel-doc (no warnings left) and checkpatch.
Fixes: 3cbf5e3c46e6 ("gpu: host1x: Allow entries in BO caches to be freed")
Signed-off-by: Amit Patole <[email protected]>
---
Comment-only change. Built with W=1 on x86_64 (drivers/gpu/host1x/,
COMPILE_TEST) with no new warnings.
---
include/linux/host1x.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/linux/host1x.h b/include/linux/host1x.h
index e7ba601b2afb..7027adb9bff5 100644
--- a/include/linux/host1x.h
+++ b/include/linux/host1x.h
@@ -146,8 +146,12 @@ static inline struct host1x_bo_mapping
*to_host1x_bo_mapping(struct kref *ref)
/**
* struct host1x_bo_ops - operations implemented by a host1x_bo provider
*
+ * @get: take a reference to the bo and return it.
+ * @put: drop a reference to the bo.
* @pin: create a DMA mapping. Implementation must not touch the bo's refcount.
* @unpin: destroy a DMA mapping. Implementation must not touch the bo's
refcount.
+ * @mmap: map the bo into the kernel's address space and return the address.
+ * @munmap: unmap a kernel mapping previously returned by @mmap.
*/
struct host1x_bo_ops {
struct host1x_bo *(*get)(struct host1x_bo *bo);
---
base-commit: 05441d697f7f9a927264f4058cbbc6a03dfcac9d
change-id: 20261105-kdoc-host1x-bo-ops-7ae7a3554fb1
Best regards,
--
Amit Patole <[email protected]>
