Skip to contentSkip to conversation

drivers/gpio: Altera soft IP GPIO driver

PATCH Superseded [email protected] 4 participants 4 messages Nov 28, 2013 – Dec 4, 2013

Subsystems (3)

v5 of 10 Superseded Latest is v10 →

lore
Share & tools
lore
#0 lore raw

PATCH v5 1/1 drivers/gpio: Altera soft IP GPIO driver

From: Tien Hock Loh <[email protected]>

Add driver support for Altera GPIO soft IP, including interrupts and I/O. Tested on Altera CV SoC board using dipsw and LED using LED framework.

---
 .../devicetree/bindings/gpio/gpio-altera.txt       |  42 +++
 drivers/gpio/Kconfig                               |   7 +
 drivers/gpio/Makefile                              |   1 +
 drivers/gpio/gpio-altera.c                         | 394 +++++++++++++++++++++
 4 files changed, 444 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-altera.txt
 create mode 100644 drivers/gpio/gpio-altera.c
Documentation/devicetree/bindings/gpio/gpio-altera.txt new file +42 -0
new file mode 100644
index 0000000..8367767
@@ -0,0 +1,42 @@
+Altera GPIO controller bindings
+
+Required properties:
+- compatible:
+  - "altr,pio-1.0"
+- reg: Physical base address and length of the controller's registers.
+- #gpio-cells : Should be 1
+  - The first cell is the gpio offset number
+- gpio-controller : Marks the device node as a GPIO controller.
+- #interrupt-cells : Should be 1.
+  - The first cell is the GPIO offset number within the GPIO controller.
+- interrupts: Specify the interrupt.
+- interrupt-controller: Mark the device node as an interrupt controller
+
+Altera GPIO specific properties:
+- altr,gpio-bank-width: Width of the GPIO bank. This defines how many pins the
+  GPIO device has. Ranges between 1-32. Optional and defaults to 32 is not
+  specified.
+- altr,interrupt_trigger: Specifies the interrupt trigger type the GPIO
+  hardware is synthesized. This field is required if the Altera GPIO controller
+  used has IRQ enabled as the interrupt type is not software controlled,
+  but hardware synthesized. Required if GPIO is used as an interrupt
+  controller. The value is defined in <dt-bindings/interrupt-controller/irq.h>
+  Only the following flags are supported:
+    IRQ_TYPE_EDGE_RISING
+    IRQ_TYPE_EDGE_FALLING
+    IRQ_TYPE_EDGE_BOTH
+    IRQ_TYPE_LEVEL_HIGH
+
+Example:
+
+gpio_altr: gpio_altr {
+    compatible = "altr,pio-1.0";
+    reg = <0xff200000 0x10>;
+    interrupts = <0 45 4>;
+    altr,gpio-bank-width = <32>;
+    altr,interrupt_trigger = <0>;
+    #gpio-cells = <1>;
+    gpio-controller;
+    #interrupt-cells = <1>;
+    interrupt-controller;
+};
drivers/gpio/Kconfig +7 -0
index 0f04444..acd67de 100644
@@ -121,6 +121,13 @@ config GPIO_GENERIC_PLATFORM
 	help
 	  Say yes here to support basic platform_device memory-mapped GPIO controllers.
 
+config GPIO_ALTERA
+       tristate "Altera GPIO"
+       select IRQ_DOMAIN
+       depends on OF_GPIO
+       help
+         Say yes here to support the Altera PIO device.
+
 config GPIO_IT8761E
 	tristate "IT8761E GPIO support"
 	depends on X86  # unconditional access to IO space.
drivers/gpio/Makefile +1 -0
index 7971e36..a326fd2 100644
@@ -14,6 +14,7 @@ obj-$(CONFIG_GPIO_74X164)	+= gpio-74x164.o
 obj-$(CONFIG_GPIO_ADNP)		+= gpio-adnp.o
 obj-$(CONFIG_GPIO_ADP5520)	+= gpio-adp5520.o
 obj-$(CONFIG_GPIO_ADP5588)	+= gpio-adp5588.o
+obj-$(CONFIG_GPIO_ALTERA)  	+= gpio-altera.o
 obj-$(CONFIG_GPIO_AMD8111)	+= gpio-amd8111.o
 obj-$(CONFIG_GPIO_ARIZONA)	+= gpio-arizona.o
 obj-$(CONFIG_GPIO_BCM_KONA)	+= gpio-bcm-kona.o
drivers/gpio/gpio-altera.c new file +394 -0

394 lines not on this page · raw message

Signature · 1 line
1.7.11.GIT
#1 lore raw
Quoted 7 lines · On Thu, Nov 28, 2013 at 11:15 +0800, [email protected] wrote:

From: Tien Hock Loh <[email protected]>

Add driver support for Altera GPIO soft IP, including interrupts and I/O. Tested on Altera CV SoC board using dipsw and LED using LED framework.

Quoted 8 lines
---
 .../devicetree/bindings/gpio/gpio-altera.txt       |  42 +++
 drivers/gpio/Kconfig                               |   7 +
 drivers/gpio/Makefile                              |   1 +
 drivers/gpio/gpio-altera.c                         | 394 +++++++++++++++++++++
 4 files changed, 444 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-altera.txt
 create mode 100644 drivers/gpio/gpio-altera.c

Oh, I only now noticed that you sent v5 while I just replied to v4 (they were a mere 24 hours apart). Allow people to see and read a submission before you emit updates. And provide a description of what has changed so one need not guess.

virtually yours
Gerhard Sittig

Signature · 3 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr. 5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-0 Fax: +49-8142-66989-80  Email: [email protected]
#2 lore raw

Noted. I'll wait for a while before sending out new patches going forward.

Quoted 29 lines · Gerhard Sittig
Quoted 7 lines · On Thu, Nov 28, 2013 at 11:15 +0800, [email protected] wrote:

From: Tien Hock Loh <[email protected]>

Add driver support for Altera GPIO soft IP, including interrupts and I/O. Tested on Altera CV SoC board using dipsw and LED using LED framework.

Quoted 8 lines
---
 .../devicetree/bindings/gpio/gpio-altera.txt       |  42 +++
 drivers/gpio/Kconfig                               |   7 +
 drivers/gpio/Makefile                              |   1 +
 drivers/gpio/gpio-altera.c                         | 394 +++++++++++++++++++++
 4 files changed, 444 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-altera.txt
 create mode 100644 drivers/gpio/gpio-altera.c

Oh, I only now noticed that you sent v5 while I just replied to v4 (they were a mere 24 hours apart). Allow people to see and read a submission before you emit updates. And provide a description of what has changed so one need not guess.

virtually yours
Gerhard Sittig
--
DENX Software Engineering GmbH, MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr. 5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-0 Fax: +49-8142-66989-80 Email: [email protected]

#3 lore raw
In reply to [email protected]
Quoted 6 lines · On Thu, Nov 28, 2013 at 4:15 AM, <[email protected]> wrote:

From: Tien Hock Loh <[email protected]>

Add driver support for Altera GPIO soft IP, including interrupts and I/O. Tested on Altera CV SoC board using dipsw and LED using LED framework.

Overall it looks good (some stuff to fix below).

I want an ACK from some device tree maintainer on the bindings, ideally.

Documentation/devicetree/bindings/gpio/gpio-altera.txt line 28

Quoted 10 lines

+- altr,interrupt_trigger: Specifies the interrupt trigger type the GPIO

Documentation/devicetree/bindings/gpio/gpio-altera.txt new file +9 -0
+  hardware is synthesized. This field is required if the Altera GPIO controller
+  used has IRQ enabled as the interrupt type is not software controlled,
+  but hardware synthesized. Required if GPIO is used as an interrupt
+  controller. The value is defined in <dt-bindings/interrupt-controller/irq.h>
+  Only the following flags are supported:
+    IRQ_TYPE_EDGE_RISING
+    IRQ_TYPE_EDGE_FALLING
+    IRQ_TYPE_EDGE_BOTH
+    IRQ_TYPE_LEVEL_HIGH

I remember discussing this, and it's OK from my side.

drivers/gpio/gpio-altera.c line 50

Quoted 13 lines
drivers/gpio/gpio-altera.c new file +13 -0
+/**
+* struct altera_gpio_chip
+* @mmchip              : memory mapped chip structure.
+* @irq                 : irq domain that this driver is registered to.
+* @gpio_lock           : synchronization lock so that new irq/set/get requests
+                         will be blocked until the current one completes.
+* @interrupt_trigger   : specifies the hardware configured IRQ trigger type
+                         (rising, falling, both, high)
+* @mapped_irq          : kernel mapped irq number.
+*/
+struct altera_gpio_chip {
+       struct of_mm_gpio_chip mmchip;
+       struct irq_domain *irq;

Argh that's a bad member name for an irqdomain, please just call this "domain" like the other drivers do.

drivers/gpio/gpio-altera.c line 54

Quoted 4 lines
drivers/gpio/gpio-altera.c new file +4 -0
+       spinlock_t gpio_lock;
+       int interrupt_trigger;
+       int edge_type;
+       int mapped_irq;

Why are you keeping this around? Well I guess I might figure out...

Quoted 12 lines
drivers/gpio/gpio-altera.c new file +12 -0
+static int altera_gpio_irq_set_type(struct irq_data *d,
+                               unsigned int type)
+{
+       struct altera_gpio_chip *altera_gc = irq_data_get_irq_chip_data(d);
+
+       if (type == IRQ_TYPE_NONE)
+               return 0;
+
+       if (type == IRQ_TYPE_LEVEL_HIGH &&
+               altera_gc->interrupt_trigger == IRQ_TYPE_LEVEL_HIGH) {
+               return 0;
+       } else {

drivers/gpio/gpio-altera.c line 108

Quoted 10 lines
drivers/gpio/gpio-altera.c new file +10 -0
+               if (type == IRQ_TYPE_EDGE_RISING &&
+                       altera_gc->interrupt_trigger == IRQ_TYPE_EDGE_RISING)
+                       return 0;
+               else if (type == IRQ_TYPE_EDGE_FALLING &&
+                       altera_gc->interrupt_trigger == IRQ_TYPE_EDGE_FALLING)
+                       return 0;
+               else if (type == IRQ_TYPE_EDGE_BOTH &&
+                       altera_gc->interrupt_trigger == IRQ_TYPE_EDGE_BOTH)
+                       return 0;
+       }

There is something very convoluted about this non-special else clause. It can be just a else if like all the others, right?

drivers/gpio/gpio-altera.c line 118

Quoted 6 lines
drivers/gpio/gpio-altera.c new file +6 -0
+static struct irq_chip altera_irq_chip = {
+       .name           = "altera-gpio",
+       .irq_mask       = altera_gpio_irq_mask,
+       .irq_unmask     = altera_gpio_irq_unmask,
+       .irq_set_type   = altera_gpio_irq_set_type,
+};

We have added new APIs to flag GPIO lines as IRQs. Please implement this in the .irq_startup()/.irq_shutdown() callbacks in accordance with the style of
e.g. this patch:
http://marc.info/?l=linux-gpio&m=138571851304612&w=2

Note that you need to call unmask/mask from these callbacks.

drivers/gpio/gpio-altera.c line 124

Quoted 5 lines
drivers/gpio/gpio-altera.c new file +5 -0
+static int altera_gpio_get(struct gpio_chip *gc, unsigned offset)
+{
+       struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
+
+       return (readl(mm_gc->regs + ALTERA_GPIO_DATA) >> offset) & 1;

Use this style to clamp a bit to {0,1}:

return !!(readl(mm_gc->regs + ALTERA_GPIO_DATA) & BIT(offset));

drivers/gpio/gpio-altera.c line 137

Quoted 11 lines
drivers/gpio/gpio-altera.c new file +11 -0
+static void altera_gpio_set(struct gpio_chip *gc, unsigned offset, int value)
+{
+       struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
+       struct altera_gpio_chip *chip = container_of(mm_gc,
+                               struct altera_gpio_chip, mmchip);
+       unsigned long flags;
+       unsigned int data_reg;
+
+       spin_lock_irqsave(&chip->gpio_lock, flags);
+       data_reg = readl(mm_gc->regs + ALTERA_GPIO_DATA);
+       data_reg = (data_reg & ~BIT(offset)) | (value << offset);

This has the same arithmetic effect but is easier to read:

if (value)
data_reg |= BIT(offset);
else
data_reg &= ~BIT(offset);

drivers/gpio/gpio-altera.c line 172

Quoted 13 lines
drivers/gpio/gpio-altera.c new file +13 -0
+static int altera_gpio_direction_output(struct gpio_chip *gc,
+               unsigned offset, int value)
+{
+       struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
+       struct altera_gpio_chip *chip = container_of(mm_gc,
+                               struct altera_gpio_chip, mmchip);
+       unsigned long flags;
+       unsigned int data_reg, gpio_ddr;
+
+       spin_lock_irqsave(&chip->gpio_lock, flags);
+       /* Sets the GPIO value */
+       data_reg = readl(mm_gc->regs + ALTERA_GPIO_DATA);
+       data_reg = (data_reg & ~BIT(offset)) | (value << offset);

Same comment. As for set().

drivers/gpio/gpio-altera.c line 193

Quoted 10 lines
drivers/gpio/gpio-altera.c new file +10 -0
+static int altera_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
+{
+       struct of_mm_gpio_chip *mm_gc = to_of_mm_gpio_chip(gc);
+       struct altera_gpio_chip *altera_gc = container_of(mm_gc,
+                               struct altera_gpio_chip, mmchip);
+
+       if (!altera_gc->irq)
+               return -ENXIO;
+       if (offset < altera_gc->mmchip.gc.ngpio)
+               return irq_create_mapping(altera_gc->irq, offset);

Recently we have established that you should call irq_create_mapping() for all valid IRQs in probe() and just use irq_find_mapping() here, as it is valid semantics to use an IRQ in an irq_chip without converting it from a GPIO line first.

This is because in DT use cases you may use an interrupt from an interrupt-controller without first calling gpio_to_irq() and then this explodes.

So please fix this...

drivers/gpio/gpio-altera.c line 206

Quoted 9 lines
drivers/gpio/gpio-altera.c new file +9 -0
+static void altera_gpio_irq_handler(unsigned int irq, struct irq_desc *desc)
+{
+       struct altera_gpio_chip *altera_gc = irq_desc_get_handler_data(desc);
+       struct irq_chip *chip = irq_desc_get_chip(desc);
+       struct of_mm_gpio_chip *mm_gc = &altera_gc->mmchip;
+       unsigned long status;
+
+       int i;
+       chip->irq_mask(&desc->irq_data);

Why do you call mask()/unmask()?

All interrupt handlers are called with interrupts disabled, I bet you can just delete these two calls.

drivers/gpio/gpio-altera.c line 216

Quoted 10 lines
drivers/gpio/gpio-altera.c new file +10 -0
+
+       /* Handling for level trigger and edge trigger is different */
+       if (altera_gc->interrupt_trigger == IRQ_TYPE_LEVEL_HIGH) {
+               status = readl_relaxed(mm_gc->regs + ALTERA_GPIO_DATA);
+               status &= readl_relaxed(mm_gc->regs + ALTERA_GPIO_IRQ_MASK);
+
+               for (i = 0; i < mm_gc->gc.ngpio; i++) {
+                       if (BIT(i) & status) {
+                               generic_handle_irq(irq_linear_revmap(
+                                       altera_gc->irq, i));

Why do you do it like that?

What us wrong with this:

generic_handle_irq(irq_find_mapping(altera_gc->domain, i))

?

drivers/gpio/gpio-altera.c line 228

Quoted 12 lines
drivers/gpio/gpio-altera.c new file +12 -0
+                       }
+               }
+       } else {
+               while ((status =
+                       (readl_relaxed(mm_gc->regs + ALTERA_GPIO_EDGE_CAP) &
+                       readl_relaxed(mm_gc->regs + ALTERA_GPIO_IRQ_MASK)))) {
+                       writel_relaxed(status,
+                               mm_gc->regs + ALTERA_GPIO_EDGE_CAP);
+                       for (i = 0; i < mm_gc->gc.ngpio; i++) {
+                               if (BIT(i) & status) {
+                                       generic_handle_irq(irq_linear_revmap(
+                                               altera_gc->irq, i));

Dito.

drivers/gpio/gpio-altera.c line 234

Quoted 6 lines
drivers/gpio/gpio-altera.c new file +6 -0
+                               }
+                       }
+               }
+       }
+
+       chip->irq_eoi(irq_desc_get_irq_data(desc));

I don't think you should call that directly either. Why do you do this?

Quoted 1 line

+ chip->irq_unmask(&desc->irq_data);

See above about mask/unmask.

drivers/gpio/gpio-altera.c line 246

Quoted 9 lines
drivers/gpio/gpio-altera.c new file +9 -0
+static int altera_gpio_irq_map(struct irq_domain *h, unsigned int virq,
+                               irq_hw_number_t hw_irq_num)
+{
+       irq_set_chip_data(virq, h->host_data);
+       irq_set_chip_and_handler(virq, &altera_irq_chip, handle_level_irq);
+       irq_set_irq_type(virq, IRQ_TYPE_NONE);
+
+       return 0;
+}

Rename the argument "virq" to just irq. These IRQs are not really virtual any more than any other Linux IRQ.

(...)

drivers/gpio/gpio-altera.c line 304

Quoted 2 lines
drivers/gpio/gpio-altera.c new file +2 -0
+       altera_gc->irq = irq_domain_add_linear(node, altera_gc->mmchip.gc.ngpio,
+                               &altera_gpio_irq_ops, altera_gc);

Here you should call irq_create_map() for all valid IRQs.

Quoted 9 lines
drivers/gpio/gpio-altera.c new file +9 -0
+static int altera_gpio_remove(struct platform_device *pdev)
+{
+       unsigned int irq, i;
+       int status;
+       struct altera_gpio_chip *altera_gc = platform_get_drvdata(pdev);
+
+       status = gpiochip_remove(&altera_gc->mmchip.gc);
+
+       if (status < 0)

drivers/gpio/gpio-altera.c line 354

Quoted 10 lines
drivers/gpio/gpio-altera.c new file +10 -0
+               return status;
+
+       if (altera_gc->irq) {
+               irq_dispose_mapping(altera_gc->mapped_irq);
+
+               for (i = 0; i < altera_gc->mmchip.gc.ngpio; i++) {
+                       irq = irq_find_mapping(altera_gc->irq, i);
+                       if (irq > 0)
+                               irq_dispose_mapping(irq);
+               }

Look, you're already disposing all mappings properly :-)

Yours,
Linus Walleij