Skip to contentSkip to conversation

gpio: realtek-otto: fix kernel-doc warnings

PATCH Applied Rosen Penev 2 participants 2 messages May 28 GPIO

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gpio: realtek-otto: fix kernel-doc warnings

Add the missing 'struct' keyword in the kernel-doc comment for realtek_gpio_ctrl, and document the @cpumask_base and @cpu_irq_maskable members that were added later but never described. Also fix the mismatch between documented @imr_line_pos and the actual member name line_imr_pos.

Fixes W=1 warning:

Warning: drivers/gpio/gpio-realtek-otto.c:66 cannot understand function prototype: 'struct realtek_gpio_ctrl'

Assisted-by Opencode:BigPickle
---
 drivers/gpio/gpio-realtek-otto.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/gpio/gpio-realtek-otto.c +4 -2
index 5e3152c2e51a..37ef56f45318 100644
@@ -40,16 +40,18 @@
 #define REALTEK_GPIO_PORTS_PER_BANK	4
 
 /**
- * realtek_gpio_ctrl - Realtek Otto GPIO driver data
+ * struct realtek_gpio_ctrl - Realtek Otto GPIO driver data
  *
  * @chip: Associated gpio_generic_chip instance
  * @base: Base address of the register block for a GPIO bank
+ * @cpumask_base: Base address of the per-CPU interrupt mask registers
+ * @cpu_irq_maskable: CPUs that can receive GPIO interrupts
  * @lock: Lock for accessing the IRQ registers and values
  * @intr_mask: Mask for interrupts lines
  * @intr_type: Interrupt type selection
  * @bank_read: Read a bank setting as a single 32-bit value
  * @bank_write: Write a bank setting as a single 32-bit value
- * @imr_line_pos: Bit shift of an IRQ line's IMR value.
+ * @line_imr_pos: Bit shift of an IRQ line's IMR value.
  *
  * The DIR, DATA, and ISR registers consist of four 8-bit port values, packed
  * into a single 32-bit register. Use @bank_read (@bank_write) to get (assign)
Signature · 1 line
2.54.0
#1 lore raw
Quoted 9 lines · Rosen Penev

Add the missing 'struct' keyword in the kernel-doc comment for realtek_gpio_ctrl, and document the @cpumask_base and @cpu_irq_maskable members that were added later but never described. Also fix the mismatch between documented @imr_line_pos and the actual member name line_imr_pos.

Fixes W=1 warning:

[...]

Applied, thanks!

[1/1] gpio: realtek-otto: fix kernel-doc warnings

      https://git.kernel.org/brgl/c/5974454ab26a5351abe4897f7110a68120d170fa

Best regards,

Signature · 1 line
Bartosz Golaszewski <[email protected]>