[PATCH v1 0/2] gpio: update Realtek Otto documenentation

[PATCH v1 0/2] gpio: update Realtek Otto documenentation

[Sander Vanheule]

Amend some driver documentation that was missing from recent changes,
and add myself as maintainer for the driver, since that's pretty much
the de facto situation.

Sander Vanheule (2):
  gpio: realtek-otto: amend ctrl struct docs
  MAINTAINERS: add info for Realtek Otto GPIO

 MAINTAINERS                      |  7 +++++++
 drivers/gpio/gpio-realtek-otto.c | 10 ++++++++++
 2 files changed, 17 insertions(+)

-- 
2.36.1

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

[Sander Vanheule]

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(+)

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
-- 
2.36.1

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

[Sander Vanheule]

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

[PATCH v1 2/2] MAINTAINERS: add info for Realtek Otto GPIO

[Sander Vanheule]

Add an entry with the files for the Realtek Otto GPIO driver with myself
as maintainer. I am already listed as maintainer in the device tree
binding itself, but the driver had no explicit maintainer info yet.

Signed-off-by: Sander Vanheule <sander@svanheule.net>
---
 MAINTAINERS | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 651616ed8ae2..b173f9e3ee3c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -17009,6 +17009,13 @@ S:	Maintained
 F:	include/sound/rt*.h
 F:	sound/soc/codecs/rt*
 
+REALTEK OTTO GPIO
+M:	Sander Vanheule <sander@svanheule.net>
+L:	linux-gpio@vger.kernel.org
+S:	Maintained
+F:	Documentation/devicetree/bindings/gpio/realtek,otto-gpio.yaml
+F:	drivers/gpio/gpio-realtek-otto.c
+
 REALTEK OTTO WATCHDOG
 M:	Sander Vanheule <sander@svanheule.net>
 L:	linux-watchdog@vger.kernel.org
-- 
2.36.1