Skip to contentSkip to conversation

gpio: generic regmap implementation

PATCH Superseded Michael Walle 2 participants 7 messages May 28, 2020

Subsystems (2)

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v5 cover gpio: generic regmap implementation

This series is a split off of the sl28cpld series:
https://lore.kernel.org/linux-gpio/[email protected]/

I wasn't sure if I should also include the gpiochip_irqchip_add_domain() patch here. So feel free to skip it. OTOH if you use interrupts with gpio-regmap it is quite handy.

For an actual user see the patch 11/16 ("gpio: add support for the sl28cpld GPIO controller") of the series above.

Changes since v4:
- add comment about can_sleep
- fix config->label typo
- add config->names property

Changes since v3:
- set reg_dat_base, that was actually broken
- fix typo
- fix swapped reg_in_dir/reg_out_dir documentation
- use "goto err" in error path in gpio_regmap_register()

Changes since v2:
See changelog in the former patch series.

Michael Walle (2):
gpiolib: Introduce gpiochip_irqchip_add_domain()
gpio: add a reusable generic gpio_chip using regmap

 drivers/gpio/Kconfig        |   4 +
 drivers/gpio/Makefile       |   1 +
 drivers/gpio/gpio-regmap.c  | 352 ++++++++++++++++++++++++++++++++++++
 drivers/gpio/gpiolib.c      |  20 ++
 include/linux/gpio-regmap.h |  70 +++++++
 include/linux/gpio/driver.h |   3 +
 6 files changed, 450 insertions(+)
 create mode 100644 drivers/gpio/gpio-regmap.c
 create mode 100644 include/linux/gpio-regmap.h
Signature · 1 line
2.20.1
#1 lore raw

PATCH v5 1/2 gpiolib: Introduce gpiochip_irqchip_add_domain()

The function connects an IRQ domain to a gpiochip and reuses gpiochip_to_irq() which is provided by gpiolib.

gpiochip_irqchip_* and regmap_irq partially provide the same functionality. This function will help to connect just the minimal functionality of the gpiochip_irqchip which is needed to work together with regmap-irq.

---
 drivers/gpio/gpiolib.c      | 20 ++++++++++++++++++++
 include/linux/gpio/driver.h |  3 +++
 2 files changed, 23 insertions(+)
drivers/gpio/gpiolib.c +20 -0
index eaa0e209188d..d07f763c9c0b 100644
@@ -2756,6 +2756,26 @@ int gpiochip_irqchip_add_key(struct gpio_chip *gc,
 }
 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key);
 
+/**
+ * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
+ * @gc: the gpiochip to add the irqchip to
+ * @domain: the irqdomain to add to the gpiochip
+ *
+ * This function adds an IRQ domain to the gpiochip.
+ */
+int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
+				struct irq_domain *domain)
+{
+	if (!domain)
+		return -EINVAL;
+
+	gc->to_irq = gpiochip_to_irq;
+	gc->irq.domain = domain;
+
+	return 0;
+}
+EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
+
 #else /* CONFIG_GPIOLIB_IRQCHIP */
 
 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
include/linux/gpio/driver.h +3 -0
index 8c41ae41b6bb..ee30065b6f61 100644
@@ -599,6 +599,9 @@ int gpiochip_irqchip_add_key(struct gpio_chip *gc,
 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
 				unsigned int offset);
 
+int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
+				struct irq_domain *domain);
+
 #ifdef CONFIG_LOCKDEP
 
 /*
Signature · 1 line
2.20.1
#2 lore raw

PATCH v5 2/2 gpio: add a reusable generic gpio_chip using regmap

In reply to Michael Walle

There are quite a lot simple GPIO controller which are using regmap to access the hardware. This driver tries to be a base to unify existing code into one place. This won't cover everything but it should be a good starting point.

It does not implement its own irq_chip because there is already a generic one for regmap based devices. Instead, the irq_chip will be instantiated in the parent driver and its irq domain will be associate to this driver.

For now it consists of the usual registers, like set (and an optional clear) data register, an input register and direction registers. Out-of-the-box, it supports consecutive register mappings and mappings where the registers have gaps between them with a linear mapping between GPIO offset and bit position. For weirder mappings the user can register its own .xlate().

---
 drivers/gpio/Kconfig        |   4 +
 drivers/gpio/Makefile       |   1 +
 drivers/gpio/gpio-regmap.c  | 352 ++++++++++++++++++++++++++++++++++++
 include/linux/gpio-regmap.h |  70 +++++++
 4 files changed, 427 insertions(+)
 create mode 100644 drivers/gpio/gpio-regmap.c
 create mode 100644 include/linux/gpio-regmap.h
drivers/gpio/Kconfig +4 -0
index 7d077be10a0f..bcacd9c74aa8 100644
@@ -73,6 +73,10 @@ config GPIO_GENERIC
 	depends on HAS_IOMEM # Only for IOMEM drivers
 	tristate
 
+config GPIO_REGMAP
+	depends on REGMAP
+	tristate
+
 # put drivers in the right section, in alphabetical order
 
 # This symbol is selected by both I2C and SPI expanders
drivers/gpio/Makefile +1 -0
index 65bf3940e33c..1e4894e0bf0f 100644
@@ -12,6 +12,7 @@ obj-$(CONFIG_GPIO_SYSFS)	+= gpiolib-sysfs.o
 obj-$(CONFIG_GPIO_ACPI)		+= gpiolib-acpi.o
 
 # Device drivers. Generally keep list sorted alphabetically
+obj-$(CONFIG_GPIO_REGMAP)	+= gpio-regmap.o
 obj-$(CONFIG_GPIO_GENERIC)	+= gpio-generic.o
 
 # directly supported by gpio-generic
drivers/gpio/gpio-regmap.c new file +352 -0

352 lines not on this page · raw message

include/linux/gpio-regmap.h new file +70 -0

70 lines not on this page · raw message

Signature · 1 line
2.20.1
#3 lore raw

Re: [PATCH v5 2/2] gpio: add a reusable generic gpio_chip using regmap

Am 2020-05-28 05:58, schrieb Michael Walle:

Quoted 27 lines

There are quite a lot simple GPIO controller which are using regmap to access the hardware. This driver tries to be a base to unify existing code into one place. This won't cover everything but it should be a good starting point.

It does not implement its own irq_chip because there is already a generic one for regmap based devices. Instead, the irq_chip will be instantiated in the parent driver and its irq domain will be associate to this driver.

For now it consists of the usual registers, like set (and an optional clear) data register, an input register and direction registers. Out-of-the-box, it supports consecutive register mappings and mappings where the registers have gaps between them with a linear mapping between GPIO offset and bit position. For weirder mappings the user can register its own .xlate().

---
 drivers/gpio/Kconfig        |   4 +
 drivers/gpio/Makefile       |   1 +
 drivers/gpio/gpio-regmap.c  | 352 ++++++++++++++++++++++++++++++++++++
 include/linux/gpio-regmap.h |  70 +++++++
 4 files changed, 427 insertions(+)
 create mode 100644 drivers/gpio/gpio-regmap.c
 create mode 100644 include/linux/gpio-regmap.h

[..]

Quoted 47 lines
include/linux/gpio-regmap.h new file +12 -0
@@ -0,0 +1,70 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef _LINUX_GPIO_REGMAP_H
+#define _LINUX_GPIO_REGMAP_H
+
+struct gpio_regmap;
+
+#define GPIO_REGMAP_ADDR_ZERO ((unsigned long)(-1))
+#define GPIO_REGMAP_ADDR(addr) ((addr) ? : GPIO_REGMAP_ADDR_ZERO)
+
+/**
+ * struct gpio_regmap_config - Description of a generic regmap 

gpio_chip.
+ *
+ * @parent: The parent device
+ * @regmap: The regmap used to access the registers
+ * given, the name of the device is used
+ * @label: (Optional) Descriptive name for GPIO controller.
+ * If not given, the name of the device is used.
+ * @ngpio: Number of GPIOs
+ * @names: (Optional) Array of names for gpios
+ * @reg_dat_base: (Optional) (in) register base address
+ * @reg_set_base: (Optional) set register base address
+ * @reg_clr_base: (Optional) clear register base address
+ * @reg_dir_in_base: (Optional) in setting register base address
+ * @reg_dir_out_base: (Optional) out setting register base address
+ * @reg_stride: (Optional) May be set if the registers (of the
+ * same type, dat, set, etc) are not consecutive.
+ * @ngpio_per_reg: Number of GPIOs per register
+ * @irq_domain: (Optional) IRQ domain if the controller is
+ * interrupt-capable
+ * @reg_mask_xlate: (Optional) Translates base address and GPIO
+ * offset to a register/bitmask pair. If not
+ * given the default gpio_regmap_simple_xlate()
+ * is used.
+ *
+ * The reg_mask_xlate translates a given base address and GPIO offset to
+ * register and mask pair. The base address is one of the given reg_*_base.
+ *
+ * All base addresses may have the special value GPIO_REGMAP_ADDR_ZERO
+ * which forces the address to the value 0.
+ */

include/linux/gpio-regmap.h line 47

Quoted 6 lines
include/linux/gpio-regmap.h new file +6 -0
+struct gpio_regmap_config {
+	struct device *parent;
+	struct regmap *regmap;
+
+	const char *label;
+	int ngpio;

damn.. I shouldn't send patches early in the morning. I've forgot to actually enable my GPIO driver before compiling. And of course.. it doesn't compile.

const char *const *names;

is missing here. So I have to send a v6 anyway. Let's wait what Linus and Bert says about the location of the gpio-regmap.h header.

Sorry for the noise.

-michael

Quoted 24 lines
include/linux/gpio-regmap.h new file +16 -0
+
+	unsigned int reg_dat_base;
+	unsigned int reg_set_base;
+	unsigned int reg_clr_base;
+	unsigned int reg_dir_in_base;
+	unsigned int reg_dir_out_base;
+	int reg_stride;
+	int ngpio_per_reg;
+	struct irq_domain *irq_domain;
+
+	int (*reg_mask_xlate)(struct gpio_regmap *gpio, unsigned int base,
+			      unsigned int offset, unsigned int *reg,
+			      unsigned int *mask);
+};
+
+struct gpio_regmap *gpio_regmap_register(const struct

gpio_regmap_config *config);

include/linux/gpio-regmap.h new file +7 -0
+void gpio_regmap_unregister(struct gpio_regmap *gpio);
+struct gpio_regmap *devm_gpio_regmap_register(struct device *dev,
+					      const struct gpio_regmap_config *config);
+void gpio_regmap_set_drvdata(struct gpio_regmap *gpio, void *data);
+void *gpio_regmap_get_drvdata(struct gpio_regmap *gpio);
+
+#endif /* _LINUX_GPIO_REGMAP_H */
#4 lore raw

Re: [PATCH v5 2/2] gpio: add a reusable generic gpio_chip using regmap

In reply to Michael Walle
Quoted 11 lines · Michael Walle

There are quite a lot simple GPIO controller which are using regmap to access the hardware. This driver tries to be a base to unify existing code into one place. This won't cover everything but it should be a good starting point.

It does not implement its own irq_chip because there is already a generic one for regmap based devices. Instead, the irq_chip will be instantiated in the parent driver and its irq domain will be associate to this driver.

Quoted 6 lines

For now it consists of the usual registers, like set (and an optional clear) data register, an input register and direction registers. Out-of-the-box, it supports consecutive register mappings and mappings where the registers have gaps between them with a linear mapping between GPIO offset and bit position. For weirder mappings the user can register its own .xlate().

More comments from me below.

...

Quoted 1 line

# Device drivers. Generally keep list sorted alphabetically

Hmm...

Quoted 2 lines

+obj-$(CONFIG_GPIO_REGMAP) += gpio-regmap.o
obj-$(CONFIG_GPIO_GENERIC) += gpio-generic.o

...is it?

...

Quoted 1 line

+ * Copyright 2019 Michael Walle <[email protected]>

2020?

...

drivers/gpio/gpio-regmap.c line 9

Quoted 2 lines
drivers/gpio/gpio-regmap.c new file +2 -0
+#include <linux/gpio/driver.h>
+#include <linux/gpio-regmap.h>

Yes, I would like to see this as gpio/regmap.h (in gpio folder).

...

drivers/gpio/gpio-regmap.c line 36

Quoted 3 lines
drivers/gpio/gpio-regmap.c new file +3 -0
+static unsigned int gpio_regmap_addr(unsigned int addr)
+{
+       return (addr == GPIO_REGMAP_ADDR_ZERO) ? 0 : addr;

I would prefer rather to have
if (...)
return 0;

return addr;

here, but any of them fine.

Quoted 1 line

+}

...

Quoted 2 lines

+/**
+ * gpio_regmap_simple_xlate() - translate base/offset to reg/mask

Don't you get plenty of complains from kernel doc validation script?

You forgot to describe all function parameters here.

Quoted 3 lines

+ *
+ * Use a simple linear mapping to translate the offset to the bitmask.
+ */

...

Quoted 1 line

+ return (val & mask) ? 1 : 0;

Hmm... many (new!) GPIO drivers are using !! instead of ternary. Can we do the same here?

...

drivers/gpio/gpio-regmap.c line 123

Quoted 13 lines
drivers/gpio/gpio-regmap.c new file +11 -0
+static int gpio_regmap_get_direction(struct gpio_chip *chip,
+                                    unsigned int offset)
+{
 
+       if (gpio->reg_dir_out_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_out_base);
+               invert = 0;
+       } else if (gpio->reg_dir_in_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_in_base);
+               invert = 1;
+       } else {
 
+               return GPIO_LINE_DIRECTION_IN;

Hmm... Doesn't it an erroneous case and we basically shouldn't be here?

drivers/gpio/gpio-regmap.c line 136

Quoted 6 lines
drivers/gpio/gpio-regmap.c new file +4 -0
+       }
 
+       if (!!(val & mask) ^ invert)
+               return GPIO_LINE_DIRECTION_OUT;
 
+       else

Redundant 'else'.

Quoted 6 lines
drivers/gpio/gpio-regmap.c new file +5 -0
+               return GPIO_LINE_DIRECTION_IN;
+}
 
+static int gpio_regmap_set_direction(struct gpio_chip *chip,
+                                    unsigned int offset, bool output)
+{

drivers/gpio/gpio-regmap.c line 154

Quoted 10 lines
drivers/gpio/gpio-regmap.c new file +8 -0
 
+       if (gpio->reg_dir_out_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_out_base);
+               invert = 0;
+       } else if (gpio->reg_dir_in_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_in_base);
+               invert = 1;
+       } else {
 
+               return 0;

Question as above.

drivers/gpio/gpio-regmap.c line 164

Quoted 6 lines
drivers/gpio/gpio-regmap.c new file +5 -0
+       }
 
+       if (!invert)
+               val = (output) ? mask : 0;
+       else
+               val = (output) ? 0 : mask;

Why not positive conditional?
Also, too many parentheses.

Quoted 2 lines
(quoted diff) +2 -0
+       return regmap_update_bits(gpio->regmap, reg, mask, val);
+}

...

Quoted 4 lines

+/**
+ * gpio_regmap_register() - Register a generic regmap GPIO controller

+ *

Extra blank line.

Quoted 4 lines

+ * @gpio: gpio_regmap device to register
+ *
+ * Returns 0 on success or an errno on failure.
+ */

...

drivers/gpio/gpio-regmap.c line 266

Quoted 4 lines
drivers/gpio/gpio-regmap.c new file +4 -0
+       if (!config->label)
+               chip->label = dev_name(config->parent);
+       else
+               chip->label = config->label;

Why not positive or here even ternary may look good

        chip->label = config->label ?: dev_name(config->parent);

...

drivers/gpio/gpio-regmap.c line 286

Quoted 3 lines
drivers/gpio/gpio-regmap.c new file +2 -0
+               ret = gpiochip_irqchip_add_domain(chip, config->irq_domain);
 
+               if (ret < 0)

Does ' < 0' make sense?

Quoted 1 line

+ goto err_remove_gpiochip;

...

Quoted 4 lines

+/**
+ * gpio_regmap_unregister() - Unregister a generic regmap GPIO controller

+ *

Extra blank line

Quoted 2 lines

+ * @gpio: gpio_regmap device to unregister
+ */

...

Quoted 4 lines

+/**
+ * devm_gpio_regmap_register() - resource managed gpio_regmap_register()

+ *

Ditto.

Quoted 7 lines

+ * @dev: device that is registering this GPIO device
+ * @gpio: gpio_regmap device to register
+ *
+ * Managed gpio_regmap_register(). For generic regmap GPIO device registered by
+ * this function, gpio_regmap_unregister() is automatically called on driver
+ * detach. See gpio_regmap_register() for more information.
+ */

...

drivers/gpio/gpio-regmap.c line 338

Quoted 3 lines
drivers/gpio/gpio-regmap.c new file +2 -0
+       gpio = gpio_regmap_register(config);
 
+

Extra blank line.

Quoted 6 lines
drivers/gpio/gpio-regmap.c new file +6 -0
+       if (!IS_ERR(gpio)) {
+               *ptr = gpio;
+               devres_add(dev, ptr);
+       } else {
+               devres_free(ptr);
+       }

...

include/linux/gpio-regmap.h line 5

Quoted 3 lines
include/linux/gpio-regmap.h new file +3 -0
+#ifndef _LINUX_GPIO_REGMAP_H
+#define _LINUX_GPIO_REGMAP_H
+

Missed a lot, i.e.

struct device;
struct irq_domain;
struct regmap;

include/linux/gpio-regmap.h line 13

Quoted 9 lines
include/linux/gpio-regmap.h new file +8 -0
+struct gpio_regmap;
+
+#define GPIO_REGMAP_ADDR_ZERO ((unsigned long)(-1))
+#define GPIO_REGMAP_ADDR(addr) ((addr) ? : GPIO_REGMAP_ADDR_ZERO)
+
+/**
+ * struct gpio_regmap_config - Description of a generic regmap gpio_chip.
 
+ *

Extra blank line.

Quoted 8 lines
+ * @parent:            The parent device
+ * @regmap:            The regmap used to access the registers
+ *                     given, the name of the device is used
+ * @label:             (Optional) Descriptive name for GPIO controller.
+ *                     If not given, the name of the device is used.
+ * @ngpio:             Number of GPIOs

+ * @names: (Optional) Array of names for gpios

I don't see it. You really need to enable kernel doc validation warnings.

Quoted 11 lines
+ * @reg_dat_base:      (Optional) (in) register base address
+ * @reg_set_base:      (Optional) set register base address
+ * @reg_clr_base:      (Optional) clear register base address
+ * @reg_dir_in_base:   (Optional) in setting register base address
+ * @reg_dir_out_base:  (Optional) out setting register base address

+ * @reg_stride: (Optional) May be set if the registers (of the
+ * same type, dat, set, etc) are not consecutive.
+ * @ngpio_per_reg: Number of GPIOs per register
+ * @irq_domain: (Optional) IRQ domain if the controller is
+ * interrupt-capable
+ * @reg_mask_xlate: (Optional) Translates base address and GPIO

Quoted 5 lines
+ *                     offset to a register/bitmask pair. If not
+ *                     given the default gpio_regmap_simple_xlate()
+ *                     is used.

+ *
+ * The reg_mask_xlate translates a given base address and GPIO offset to

'reg_mask_xlate' -> '->reg_mask_xlate()' or '@reg_mask_xlate' or special C function reference for kernel doc.

Quoted 1 line

+ * register and mask pair. The base address is one of the given reg_*_base.

'reg_*_base' -> 'register base addresses in this structure' ?

Quoted 3 lines

+ *
+ * All base addresses may have the special value GPIO_REGMAP_ADDR_ZERO
+ * which forces the address to the value 0.

Also, since we have no separate documentation, describe the rules, that some of the registers are actually required, and some maybe in conflict (these rules you have in register function).

Quoted 1 line

+ */

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#5 lore raw

Re: [PATCH v5 2/2] gpio: add a reusable generic gpio_chip using regmap

Am 2020-05-28 13:45, schrieb Andy Shevchenko:

Quoted 12 lines · Michael Walle
Quoted 11 lines

There are quite a lot simple GPIO controller which are using regmap to access the hardware. This driver tries to be a base to unify existing code into one place. This won't cover everything but it should be a good starting point.

It does not implement its own irq_chip because there is already a generic one for regmap based devices. Instead, the irq_chip will be instantiated in the parent driver and its irq domain will be associate to this driver.

Quoted 8 lines
Quoted 6 lines

For now it consists of the usual registers, like set (and an optional clear) data register, an input register and direction registers. Out-of-the-box, it supports consecutive register mappings and mappings where the registers have gaps between them with a linear mapping between GPIO offset and bit position. For weirder mappings the user can register its own .xlate().

More comments from me below.

Thanks for the review.

Quoted 4 lines

...

Quoted 8 lines
Quoted 1 line

# Device drivers. Generally keep list sorted alphabetically

Hmm...

Quoted 2 lines

+obj-$(CONFIG_GPIO_REGMAP) += gpio-regmap.o
obj-$(CONFIG_GPIO_GENERIC) += gpio-generic.o

...is it?

That's because gpio-regmap.o seems not be a driver and more of a generic thing (like gpio-generic.o) and gpio-generic.o has another rule two lines below and I don't want to put gpio-regmap.o in between.

Quoted 24 lines

...

Quoted 1 line

+ * Copyright 2019 Michael Walle <[email protected]>

2020?

...

drivers/gpio/gpio-regmap.c line 9

Quoted 2 lines
drivers/gpio/gpio-regmap.c new file +2 -0
+#include <linux/gpio/driver.h>
+#include <linux/gpio-regmap.h>

Yes, I would like to see this as gpio/regmap.h (in gpio folder).

...

drivers/gpio/gpio-regmap.c line 36

Quoted 3 lines
drivers/gpio/gpio-regmap.c new file +3 -0
+static unsigned int gpio_regmap_addr(unsigned int addr)
+{
+       return (addr == GPIO_REGMAP_ADDR_ZERO) ? 0 : addr;

I would prefer rather to have
if (...)
return 0;

Quoted 3 lines

return addr;

here, but any of them fine.

yes looks nicer.

Quoted 9 lines
Quoted 2 lines

+}

...

Quoted 2 lines

+/**
+ * gpio_regmap_simple_xlate() - translate base/offset to reg/mask

Don't you get plenty of complains from kernel doc validation script?

now that I know there is one, yes. there are many complains.

Quoted 7 lines

You forgot to describe all function parameters here.

Quoted 4 lines

+ *
+ * Use a simple linear mapping to translate the offset to the bitmask.
+ */

This is a leftover, I'm actually gonna remove it since its not exported anymore.

Quoted 7 lines

...

Quoted 1 line

+ return (val & mask) ? 1 : 0;

Hmm... many (new!) GPIO drivers are using !! instead of ternary. Can we do the same here?

ok

Quoted 15 lines

...

Quoted 11 lines
drivers/gpio/gpio-regmap.c new file +10 -0
+static int gpio_regmap_get_direction(struct gpio_chip *chip,
+                                    unsigned int offset)
+{
 
+       if (gpio->reg_dir_out_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_out_base);
+               invert = 0;
+       } else if (gpio->reg_dir_in_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_in_base);
+               invert = 1;
+       } else {
Quoted 3 lines
Quoted 1 line

+ return GPIO_LINE_DIRECTION_IN;

Hmm... Doesn't it an erroneous case and we basically shouldn't be here?

yeah, I'll return -EOPNOTSUPP. Better than just ignoring, right?

Quoted 9 lines

drivers/gpio/gpio-regmap.c line 136

Quoted 7 lines
drivers/gpio/gpio-regmap.c new file +4 -0
+       }
 
+       if (!!(val & mask) ^ invert)
+               return GPIO_LINE_DIRECTION_OUT;
 
+       else

Redundant 'else'.

IMHO, That looks really strange. like it has nothing to do with the if statement. I'd like to keep that one.

Quoted 16 lines
Quoted 15 lines
drivers/gpio/gpio-regmap.c new file +12 -0
+               return GPIO_LINE_DIRECTION_IN;
+}
 
+static int gpio_regmap_set_direction(struct gpio_chip *chip,
+                                    unsigned int offset, bool output)
+{
 
+       if (gpio->reg_dir_out_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_out_base);
+               invert = 0;
+       } else if (gpio->reg_dir_in_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_in_base);
+               invert = 1;
+       } else {
Quoted 3 lines
Quoted 1 line

+ return 0;

Question as above.

same answer ;)

Quoted 10 lines

drivers/gpio/gpio-regmap.c line 164

Quoted 7 lines
drivers/gpio/gpio-regmap.c new file +5 -0
+       }
 
+       if (!invert)
+               val = (output) ? mask : 0;
+       else
+               val = (output) ? 0 : mask;

Why not positive conditional?
Also, too many parentheses.

ok

Quoted 4 lines

Review

Quoted 3 lines
(quoted diff) +2 -0
+       return regmap_update_bits(gpio->regmap, reg, mask, val);
+}
Quoted 8 lines

...

Quoted 4 lines

+/**
+ * gpio_regmap_register() - Register a generic regmap GPIO controller

+ *

Extra blank line.

didn't know that. so ok for all kind of these comments.

Quoted 8 lines
Quoted 5 lines

+ * @gpio: gpio_regmap device to register
+ *
+ * Returns 0 on success or an errno on failure.
+ */

...

Quoted 8 lines

drivers/gpio/gpio-regmap.c line 266

Quoted 4 lines
drivers/gpio/gpio-regmap.c new file +4 -0
+       if (!config->label)
+               chip->label = dev_name(config->parent);
+       else
+               chip->label = config->label;

Why not positive or here even ternary may look good

        chip->label = config->label ?: dev_name(config->parent);

ok

Quoted 9 lines

...

Quoted 4 lines

+ ret = gpiochip_irqchip_add_domain(chip,
config->irq_domain);

+ if (ret < 0)

Does ' < 0' make sense?

more or less, I'll change it to "if (ret)"

Quoted 36 lines
Quoted 2 lines

+ goto err_remove_gpiochip;

...

Quoted 5 lines

+/**
+ * gpio_regmap_unregister() - Unregister a generic regmap GPIO controller

+ *

Extra blank line

Quoted 2 lines

+ * @gpio: gpio_regmap device to unregister
+ */

...

Quoted 5 lines

+/**
+ * devm_gpio_regmap_register() - resource managed gpio_regmap_register()

+ *

Ditto.

Quoted 9 lines

+ * @dev: device that is registering this GPIO device
+ * @gpio: gpio_regmap device to register
+ *
+ * Managed gpio_regmap_register(). For generic regmap GPIO device registered by
+ * this function, gpio_regmap_unregister() is automatically called on driver
+ * detach. See gpio_regmap_register() for more information.
+ */

Quoted 7 lines

...

drivers/gpio/gpio-regmap.c line 338

Quoted 3 lines
drivers/gpio/gpio-regmap.c new file +2 -0
+       gpio = gpio_regmap_register(config);
 
+

Extra blank line.

ok

Quoted 15 lines
Quoted 6 lines
drivers/gpio/gpio-regmap.c new file +6 -0
+       if (!IS_ERR(gpio)) {
+               *ptr = gpio;
+               devres_add(dev, ptr);
+       } else {
+               devres_free(ptr);
+       }

...

include/linux/gpio-regmap.h line 5

Quoted 3 lines
include/linux/gpio-regmap.h new file +3 -0
+#ifndef _LINUX_GPIO_REGMAP_H
+#define _LINUX_GPIO_REGMAP_H
+

Missed a lot, i.e.

Quoted 3 lines

struct device;
struct irq_domain;
struct regmap;

oops. right.

Quoted 22 lines
Quoted 11 lines
include/linux/gpio-regmap.h new file +7 -0
+struct gpio_regmap;
+
+#define GPIO_REGMAP_ADDR_ZERO ((unsigned long)(-1))
+#define GPIO_REGMAP_ADDR(addr) ((addr) ? : GPIO_REGMAP_ADDR_ZERO)
+
+/**
+ * struct gpio_regmap_config - Description of a generic regmap 

gpio_chip.

+ *

Extra blank line.

Quoted 7 lines
+ * @parent:            The parent device
+ * @regmap:            The regmap used to access the registers
+ *                     given, the name of the device is used
+ * @label:             (Optional) Descriptive name for GPIO 

controller.
+ * If not given, the name of the device is used.
+ * @ngpio: Number of GPIOs

Quoted 3 lines
Quoted 1 line

+ * @names: (Optional) Array of names for gpios

I don't see it. You really need to enable kernel doc validation warnings.

I've already noticed that in another mail.

Quoted 29 lines
Quoted 14 lines
+ * @reg_dat_base:      (Optional) (in) register base address
+ * @reg_set_base:      (Optional) set register base address
+ * @reg_clr_base:      (Optional) clear register base address
+ * @reg_dir_in_base:   (Optional) in setting register base address
+ * @reg_dir_out_base:  (Optional) out setting register base address

+ * @reg_stride: (Optional) May be set if the registers
(of the
+ * same type, dat, set, etc) are not consecutive.
+ * @ngpio_per_reg: Number of GPIOs per register
+ * @irq_domain: (Optional) IRQ domain if the
controller is
+ * interrupt-capable
+ * @reg_mask_xlate: (Optional) Translates base address and GPIO

Quoted 6 lines
+ *                     offset to a register/bitmask pair. If not
+ *                     given the default gpio_regmap_simple_xlate()
+ *                     is used.

+ *
+ * The reg_mask_xlate translates a given base address and GPIO offset to

'reg_mask_xlate' -> '->reg_mask_xlate()' or '@reg_mask_xlate' or special C function reference for kernel doc.

Quoted 2 lines

+ * register and mask pair. The base address is one of the given reg_*_base.

'reg_*_base' -> 'register base addresses in this structure' ?

Quoted 8 lines
Quoted 4 lines

+ *
+ * All base addresses may have the special value
GPIO_REGMAP_ADDR_ZERO
+ * which forces the address to the value 0.

Also, since we have no separate documentation, describe the rules, that some of the registers are actually required, and some maybe in conflict (these rules you have in register function).

ok

-michael

#6 lore raw

Re: [PATCH v5 2/2] gpio: add a reusable generic gpio_chip using regmap

Quoted 6 lines · Michael Walle

Am 2020-05-28 13:45, schrieb Andy Shevchenko:

Quoted 3 lines · Michael Walle

More comments from me below.

Thanks for the review.

You are welcome! Thanks for doing this actually.

(So, the not commented points I think you agreed with)

...

Quoted 7 lines
Quoted 7 lines
Quoted 1 line

# Device drivers. Generally keep list sorted alphabetically

Hmm...

Quoted 2 lines

+obj-$(CONFIG_GPIO_REGMAP) += gpio-regmap.o
obj-$(CONFIG_GPIO_GENERIC) += gpio-generic.o

Quoted 6 lines
Quoted 1 line

...is it?

That's because gpio-regmap.o seems not be a driver and more of a generic thing (like gpio-generic.o) and gpio-generic.o has another rule two lines
below and I don't want to put gpio-regmap.o in between.

OK!

...

Quoted 8 lines
Quoted 8 lines
Quoted 7 lines
drivers/gpio/gpio-regmap.c new file +7 -0
+       if (gpio->reg_dir_out_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_out_base);
+               invert = 0;
+       } else if (gpio->reg_dir_in_base) {
+               base = gpio_regmap_addr(gpio->reg_dir_in_base);
+               invert = 1;
+       } else {
Quoted 5 lines
Quoted 3 lines
Quoted 1 line

+ return GPIO_LINE_DIRECTION_IN;

Hmm... Doesn't it an erroneous case and we basically shouldn't be here?

yeah, I'll return -EOPNOTSUPP. Better than just ignoring, right?

Yes, that's what I meant.

...

Quoted 9 lines
Quoted 6 lines

drivers/gpio/gpio-regmap.c line 136

Quoted 4 lines
drivers/gpio/gpio-regmap.c new file +3 -0
+       if (!!(val & mask) ^ invert)
+               return GPIO_LINE_DIRECTION_OUT;
 
+       else

Redundant 'else'.

IMHO, That looks really strange. like it has nothing to do with the if statement. I'd like to keep that one.

We have many drivers done like that, but it's minor, so, up to you and maintainers.

Signature · 2 lines
With Best Regards,
Andy Shevchenko