diff mbox series

[v1,1/2] gpio: realtek-otto: amend ctrl struct docs

Message ID 778b5c9f05c42c0963a5eca1c1c7e58b588a4bc7.1658477809.git.sander@svanheule.net
State New
Headers show
Series gpio: update Realtek Otto documenentation | expand

Commit Message

Sander Vanheule July 22, 2022, 8:19 a.m. UTC
Commit 512c5be35223 ("gpio: realtek-otto: Support reversed port
layouts") and commit 95fa6dbe58f2 ("gpio: realtek-otto: Support per-cpu
interrupts") updated the realtek_gpio_ctrl struct with new fields, but
the associated kernel-doc comment was not updated accordingly.

Signed-off-by: Sander Vanheule <sander@svanheule.net>
---
 drivers/gpio/gpio-realtek-otto.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Sander Vanheule July 23, 2022, 9:52 a.m. UTC | #1
Hi,

On Fri, 2022-07-22 at 10:19 +0200, Sander Vanheule wrote:
> Commit 512c5be35223 ("gpio: realtek-otto: Support reversed port
> layouts") and commit 95fa6dbe58f2 ("gpio: realtek-otto: Support per-cpu
> interrupts") updated the realtek_gpio_ctrl struct with new fields, but
> the associated kernel-doc comment was not updated accordingly.
> 
> Signed-off-by: Sander Vanheule <sander@svanheule.net>
> ---

I've just posted another patch to fix a driver issue, which conflicts with this
one. The fix should get merged first, we can come back to these patches later.

Best,
Sander

>  drivers/gpio/gpio-realtek-otto.c | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/drivers/gpio/gpio-realtek-otto.c b/drivers/gpio/gpio-realtek-
> otto.c
> index 63dcf42f7c20..a352fbfc3c28 100644
> --- a/drivers/gpio/gpio-realtek-otto.c
> +++ b/drivers/gpio/gpio-realtek-otto.c
> @@ -43,9 +43,19 @@
>   *
>   * @gc: Associated gpio_chip instance
>   * @base: Base address of the register block for a GPIO bank
> + * @cpumask_base: Base address of the interrupt routing registers
> + * @cpu_irq_maskable: Mask of CPUs that can be individually masked for IRQs
>   * @lock: Lock for accessing the IRQ registers and values
>   * @intr_mask: Mask for interrupts lines
>   * @intr_type: Interrupt type selection
> + * @port_offset_u8: Get offset of an 8b port value
> + * @port_offset_u16: Get offset of a 16b port value
> + *
> + * The DIR, DATA, and ISR registers consist of four u8 port values, packed
> into
> + * a single 32b register. Use @port_offset_u8 to get the correct offset
> inside
> + * that register. The IMR register consists of four u16 port values, packed
> + * into two 32b registers. Use @port_offset_u16 to get the correct offset for
> + * the u16 value, starting from the first register.
>   *
>   * Because the interrupt mask register (IMR) combines the function of IRQ
> type
>   * selection and masking, two extra values are stored. @intr_mask is used to
diff mbox series

Patch

diff --git a/drivers/gpio/gpio-realtek-otto.c b/drivers/gpio/gpio-realtek-otto.c
index 63dcf42f7c20..a352fbfc3c28 100644
--- a/drivers/gpio/gpio-realtek-otto.c
+++ b/drivers/gpio/gpio-realtek-otto.c
@@ -43,9 +43,19 @@ 
  *
  * @gc: Associated gpio_chip instance
  * @base: Base address of the register block for a GPIO bank
+ * @cpumask_base: Base address of the interrupt routing registers
+ * @cpu_irq_maskable: Mask of CPUs that can be individually masked for IRQs
  * @lock: Lock for accessing the IRQ registers and values
  * @intr_mask: Mask for interrupts lines
  * @intr_type: Interrupt type selection
+ * @port_offset_u8: Get offset of an 8b port value
+ * @port_offset_u16: Get offset of a 16b port value
+ *
+ * The DIR, DATA, and ISR registers consist of four u8 port values, packed into
+ * a single 32b register. Use @port_offset_u8 to get the correct offset inside
+ * that register. The IMR register consists of four u16 port values, packed
+ * into two 32b registers. Use @port_offset_u16 to get the correct offset for
+ * the u16 value, starting from the first register.
  *
  * Because the interrupt mask register (IMR) combines the function of IRQ type
  * selection and masking, two extra values are stored. @intr_mask is used to