[PATCH] accel: Arm Ethos-U NPU: fix all uapi kernel-doc warnings

[PATCH] accel: Arm Ethos-U NPU: fix all uapi kernel-doc warnings

[Randy Dunlap]

Use correct struct names, struct member names, and kernel-doc
format to resolve all kernel-doc warnings:

Warning: include/uapi/drm/ethosu_accel.h:81 expecting prototype for struct
 drm_ethosu_gpu_info. Prototype was for struct drm_ethosu_npu_info instead
Warning: include/uapi/drm/ethosu_accel.h:81 struct member 'config' not
 described in 'drm_ethosu_npu_info'
Warning: include/uapi/drm/ethosu_accel.h:81 struct member 'sram_size' not
 described in 'drm_ethosu_npu_info'

Warning: include/uapi/drm/ethosu_accel.h:172 expecting prototype for struct
 drm_ethosu_wait_bo. Prototype was for struct drm_ethosu_bo_wait instead
Warning: include/uapi/drm/ethosu_accel.h:172 struct member 'handle' not
 described in 'drm_ethosu_bo_wait'
Warning: include/uapi/drm/ethosu_accel.h:172 struct member 'pad' not
 described in 'drm_ethosu_bo_wait'
Warning: include/uapi/drm/ethosu_accel.h:172 struct member 'timeout_ns' not
 described in 'drm_ethosu_bo_wait'

Warning: include/uapi/drm/ethosu_accel.h:208 struct member 'cmd_bo' not
 described in 'drm_ethosu_job'
Warning: include/uapi/drm/ethosu_accel.h:208 struct member 'sram_size' not
 described in 'drm_ethosu_job'
Warning: include/uapi/drm/ethosu_accel.h:208 struct member
 'region_bo_handles' not described in 'drm_ethosu_job'

Warning: include/uapi/drm/ethosu_accel.h:224 struct member 'jobs' not
 described in 'drm_ethosu_submit'
Warning: include/uapi/drm/ethosu_accel.h:224 struct member 'job_count' not
 described in 'drm_ethosu_submit'
Warning: include/uapi/drm/ethosu_accel.h:224 struct member 'pad' not
 described in 'drm_ethosu_submit'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Rob Herring <robh@kernel.org>
Cc: Tomeu Vizoso <tomeu@tomeuvizoso.net>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: David Airlie <airlied@gmail.com>
Cc: Simona Vetter <simona@ffwll.ch>

 include/uapi/drm/ethosu_accel.h |   24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

--- linux-next-20260226.orig/include/uapi/drm/ethosu_accel.h
+++ linux-next-20260226/include/uapi/drm/ethosu_accel.h
@@ -60,7 +60,7 @@ enum drm_ethosu_dev_query_type {
 };
 
 /**
- * struct drm_ethosu_gpu_info - NPU information
+ * struct drm_ethosu_npu_info - NPU information
  *
  * Structure grouping all queryable information relating to the NPU.
  */
@@ -75,9 +75,10 @@ struct drm_ethosu_npu_info {
 #define DRM_ETHOSU_VERSION_MINOR(x)		(((x) >> 4) & 0xff)
 #define DRM_ETHOSU_VERSION_STATUS(x)		((x) & 0xf)
 
-	/** @gpu_rev: GPU revision. */
+	/** @config: NPU revision. */
 	__u32 config;
 
+	/** @sram_size: NPU SRAM size (KB) */
 	__u32 sram_size;
 };
 
@@ -159,7 +160,7 @@ struct drm_ethosu_bo_mmap_offset {
 };
 
 /**
- * struct drm_ethosu_wait_bo - ioctl argument for waiting for
+ * struct drm_ethosu_bo_wait - ioctl argument for waiting for
  * completion of the last DRM_ETHOSU_SUBMIT on a BO.
  *
  * This is useful for cases where multiple processes might be
@@ -167,9 +168,12 @@ struct drm_ethosu_bo_mmap_offset {
  * completed.
  */
 struct drm_ethosu_bo_wait {
+	/** @handle: BO handle */
 	__u32 handle;
+	/** @pad: Reserved, must be zero. */
 	__u32 pad;
-	__s64 timeout_ns;	/* absolute */
+	/** @timeout_ns: Absolute timeout in ns. */
+	__s64 timeout_ns;
 };
 
 struct drm_ethosu_cmdstream_bo_create {
@@ -197,14 +201,14 @@ struct drm_ethosu_cmdstream_bo_create {
  * sequentially on the same core, to benefit from memory residency in SRAM.
  */
 struct drm_ethosu_job {
-	/** Input: BO handle for cmdstream. */
+	/** @cmd_bo: Input: BO handle for cmdstream. */
 	__u32 cmd_bo;
 
-	/** Input: Amount of SRAM to use. */
+	/** @sram_size: Input: Amount of SRAM to use. */
 	__u32 sram_size;
 
 #define ETHOSU_MAX_REGIONS	8
-	/** Input: Array of BO handles for each region. */
+	/** @region_bo_handles: Input: Array of BO handles for each region. */
 	__u32 region_bo_handles[ETHOSU_MAX_REGIONS];
 };
 
@@ -214,13 +218,13 @@ struct drm_ethosu_job {
  * The kernel will schedule the execution of these jobs in dependency order.
  */
 struct drm_ethosu_submit {
-	/** Input: Pointer to an array of struct drm_ethosu_job. */
+	/** @jobs: Input: Pointer to an array of struct drm_ethosu_job. */
 	__u64 jobs;
 
-	/** Input: Number of jobs passed in. */
+	/** @job_count: Input: Number of jobs passed in. */
 	__u32 job_count;
 
-	/** Reserved, must be zero. */
+	/** @pad: Reserved, must be zero. */
 	__u32 pad;
 };
 

Claude review: accel: Arm Ethos-U NPU: fix all uapi kernel-doc warnings

[Claude Code Review Bot]

Overall Series Review

Subject: accel: Arm Ethos-U NPU: fix all uapi kernel-doc warnings
Author: Randy Dunlap <rdunlap@infradead.org>
Patches: 1
Reviewed: 2026-02-27T11:37:35.738578

---

This is a single-patch series that fixes kernel-doc warnings in the Arm Ethos-U NPU UAPI header (`include/uapi/drm/ethosu_accel.h`). All changes are documentation-only — correcting struct names in doc comments, adding missing `@member:` tags, and using proper kernel-doc format. The patch is straightforward, correct, and resolves all 12 listed warnings.

**Verdict: Looks good.** This is a clean documentation fix with no functional impact.

---
Generated by Claude Code Patch Reviewer

Claude review: accel: Arm Ethos-U NPU: fix all uapi kernel-doc warnings

[Claude Code Review Bot]

Patch Review

**Correctness: All changes verified against the actual struct definitions.**

1. **Struct name fixes** — Both are clearly correct:
   - `struct drm_ethosu_gpu_info` → `struct drm_ethosu_npu_info` (matches actual struct at line 67)
   - `struct drm_ethosu_wait_bo` → `struct drm_ethosu_bo_wait` (matches actual struct at line 170)

2. **Member name fix** — Correct:
   - `@gpu_rev: GPU revision.` → `@config: NPU revision.` — the field is indeed named `config`, not `gpu_rev`

3. **Added missing member docs** — All correct and follow existing style:
   - `@sram_size` in `drm_ethosu_npu_info`
   - `@handle`, `@pad`, `@timeout_ns` in `drm_ethosu_bo_wait`

4. **Added `@member:` prefixes** to existing comments — Correct for:
   - `@cmd_bo`, `@sram_size`, `@region_bo_handles` in `drm_ethosu_job`
   - `@jobs`, `@job_count`, `@pad` in `drm_ethosu_submit`

**Minor nit (not worth a respin):** The added `@sram_size` doc at line 81:
```c
/** @sram_size: NPU SRAM size (KB) */
```
is missing a trailing period, while the adjacent `@config` line has one:
```c
/** @config: NPU revision. */
```
This is cosmetic and inconsistency exists elsewhere in the file, so not worth blocking on.

**One question to consider:** The description `@config: NPU revision.` — "NPU revision" was carried over from the original `@gpu_rev: GPU revision.` description. Whether "revision" is the most accurate description for a field named `config` is debatable, but it's what was already there (modulo the GPU→NPU correction), and the original author of the struct presumably had a reason. This is fine as-is.

**Reviewed-by worthy.** No issues found.

---
Generated by Claude Code Patch Reviewer