Coldfire generic GPIO (m68knommu)
RFC 1/14 Coldfire generic GPIO (m68knommu)
The basic Coldfire generic gpio implementation.
arch/m68k/include/asm/gpio.h new file +238 -0
@@ -0,0 +1,238 @@ +/* + * Coldfire generic GPIO support + * + * (C) Copyright 2009, Steven King <[email protected]> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. +*/ + +#ifndef mcfgpio_h +#define mcfgpio_h + +#include <linux/io.h> +#include <asm-generic/gpio.h> +#include <asm/coldfire.h> +#include <asm/mcfsim.h> + +/* + * The Freescale Coldfire family is quite varied in how they implement GPIO. + * Some parts have 8 bit ports, some have 16bit and some have 32bit; some have + * only one port, others have multiple ports; some have a single data latch + * for both input and output, others have a separate pin data register to read + * input; some require a read-modify-write access to change an output, others + * have set and clear registers for some of the outputs; Some have all the + * GPIOs in a single control area, others have some GPIOs implemented in + * different modules. + * + * This implementation attempts accomodate the differences while presenting + * a generic interface that will optimize to as few instructions as possible. + */ +#if defined(CONFIG_M5206) || defined(CONFIG_M5206e) || \ + defined(CONFIG_M520x) || defined(CONFIG_M523x) || \ + defined(CONFIG_M527x) || defined(CONFIG_M528x) || defined(CONFIG_M532x) + +/* These parts have GPIO organized by 8 bit ports */ + +#define MCFGPIO_PORTTYPE u8 +#define MCFGPIO_PORTSIZE 8 +#define mcfgpio_read(port) __raw_readb(port) +#define mcfgpio_write(data, port) __raw_writeb(data, port) + +#elif defined(CONFIG_M5307) || defined(CONFIG_M5407) || defined(CONFIG_M5272) + +/* These parts have GPIO organized by 16 bit ports */ + +#define MCFGPIO_PORTTYPE u16 +#define MCFGPIO_PORTSIZE 16 +#define mcfgpio_read(port) __raw_readw(port) +#define mcfgpio_write(data, port) __raw_writew(data, port) + +#elif defined(CONFIG_M5249) + +/* These parts have GPIO organized by 32 bit ports */ + +#define MCFGPIO_PORTTYPE u32 +#define MCFGPIO_PORTSIZE 32 +#define mcfgpio_read(port) __raw_readl(port) +#define mcfgpio_write(data, port) __raw_writel(data, port) + +#endif + +#define mcfgpio_bit(gpio) (1 << ((gpio) % MCFGPIO_PORTSIZE)) +#define mcfgpio_port(gpio) ((gpio) / MCFGPIO_PORTSIZE) + +#if defined(CONFIG_M520x) || defined(CONFIG_M523x) || \ + defined(CONFIG_M527x) || defined(CONFIG_M528x) || defined(CONFIG_M532x) +/* + * These parts have an 'Edge' Port module (external interrupt/GPIO) which uses + * read-modify-write to change an output and a GPIO module which has separate + * set/clr registers to directly change outputs with a single write access. + */ +#if defined(CONFIG_M528x) +/* + * The 528x also has GPIOs in other modules (GPT, QADC) which use + * read-modify-write as well as those controlled by the EPORT and GPIO modules. + */ +#define MCFGPIO_SCR_START 40 +#else +#define MCFGPIO_SCR_START 8 +#endif + +#define MCFGPIO_SETR_PORT(gpio) (MCFGPIO_SETR + \ + mcfgpio_port(gpio - MCFGPIO_SCR_START)) + +#define MCFGPIO_CLRR_PORT(gpio) (MCFGPIO_CLRR + \ + mcfgpio_port(gpio - MCFGPIO_SCR_START)) +#else + +#define MCFGPIO_SCR_START MCFGPIO_PIN_MAX +/* with MCFGPIO_SCR == MCFGPIO_PIN_MAX, these will be optimized away */ +#define MCFGPIO_SETR_PORT(gpio) 0 +#define MCFGPIO_CLRR_PORT(gpio) 0 + +#endif +/* + * Coldfire specific helper functions + */ + +/* return the port pin data register for a gpio */ +static inline u32 __mcf_gpio_ppdr(unsigned gpio) +{ +#if defined(CONFIG_M5206) || defined(CONFIG_M5206e) || \ + defined(CONFIG_M5307) || defined(CONFIG_M5407) + return MCFSIM_PADAT; +#elif defined(CONFIG_M5272) + if (gpio < 16) + return MCFSIM_PADAT; + else if (gpio < 32) + return MCFSIM_PBDAT; + else + return MCFSIM_PCDAT; +#elif defined(CONFIG_M5249) + if (gpio < 32) + return MCFSIM2_GPIOREAD; + else + return MCFSIM2_GPIO1READ; +#elif defined(CONFIG_M520x) || defined(CONFIG_M523x) || \ + defined(CONFIG_M527x) || defined(CONFIG_M528x) || defined(CONFIG_M532x) + if (gpio < 8) + return MCFEPORT_EPPDR; +#if defined(CONFIG_M528x) + else if (gpio < 16) + return MCFGPTA_GPTPORT; + else if (gpio < 24) + return MCFGPTB_GPTPORT; + else if (gpio < 32) + return MCFQADC_PORTQA; + else if (gpio < 40) + return MCFQADC_PORTQB; +#endif + else + return MCFGPIO_PPDR + mcfgpio_port(gpio - MCFGPIO_SCR_START); +#endif +} + +/* return the port output data register for a gpio */ +static inline u32 __mcf_gpio_podr(unsigned gpio) +{ +#if defined(CONFIG_M5206) || defined(CONFIG_M5206e) || \ + defined(CONFIG_M5307) || defined(CONFIG_M5407) + return MCFSIM_PADAT; +#elif defined(CONFIG_M5272) + if (gpio < 16) + return MCFSIM_PADAT; + else if (gpio < 32) + return MCFSIM_PBDAT; + else + return MCFSIM_PCDAT; +#elif defined(CONFIG_M5249) + if (gpio < 32) + return MCFSIM2_GPIOWRITE; + else + return MCFSIM2_GPIO1WRITE; +#elif defined(CONFIG_M520x) || defined(CONFIG_M523x) || \ + defined(CONFIG_M527x) || defined(CONFIG_M528x) || defined(CONFIG_M532x) + if (gpio < 8) + return MCFEPORT_EPDR; +#if defined(CONFIG_M528x) + else if (gpio < 16) + return MCFGPTA_GPTPORT; + else if (gpio < 24) + return MCFGPTB_GPTPORT; + else if (gpio < 32) + return MCFQADC_PORTQA; + else if (gpio < 40) + return MCFQADC_PORTQB; +#endif + else + return MCFGPIO_PODR + mcfgpio_port(gpio - MCFGPIO_SCR_START); +#endif +} + +/* + * The Generic GPIO functions + * + * If the gpio is a compile time constant and is one of the Coldfire gpios, + * use the inline version, otherwise dispatch thru gpiolib. + */ + +static inline int gpio_get_value(unsigned gpio) +{ + if (__builtin_constant_p(gpio) && gpio < MCFGPIO_PIN_MAX) + return mcfgpio_read(__mcf_gpio_ppdr(gpio)) & mcfgpio_bit(gpio); + else + return __gpio_get_value(gpio); +} + +static inline void gpio_set_value(unsigned gpio, int value) +{ + if (__builtin_constant_p(gpio) && gpio < MCFGPIO_PIN_MAX) { + if (gpio < MCFGPIO_SCR_START) { + unsigned long flags; + MCFGPIO_PORTTYPE data; + + local_irq_save(flags); + data = mcfgpio_read(__mcf_gpio_podr(gpio)); + if (value) + data |= mcfgpio_bit(gpio); + else + data &= ~mcfgpio_bit(gpio); + mcfgpio_write(data, __mcf_gpio_podr(gpio)); + local_irq_restore(flags); + } else { + if (value) + mcfgpio_write(mcfgpio_bit(gpio), + MCFGPIO_SETR_PORT(gpio)); + else + mcfgpio_write(~mcfgpio_bit(gpio), + MCFGPIO_CLRR_PORT(gpio)); + } + } else + __gpio_set_value(gpio, value); +} + +static inline int gpio_to_irq(unsigned gpio) +{ + return (gpio < MCFGPIO_IRQ_MAX) ? gpio + MCFGPIO_IRQ_VECBASE : -EINVAL; +} + +static inline int irq_to_gpio(unsigned irq) +{ + return (irq >= MCFGPIO_IRQ_VECBASE && + irq < (MCFGPIO_IRQ_VECBASE + MCFGPIO_IRQ_MAX)) ? + irq - MCFGPIO_IRQ_VECBASE : -ENXIO; +} + +static inline int gpio_cansleep(unsigned gpio) +{ + return gpio < MCFGPIO_PIN_MAX ? 0 : __gpio_cansleep(gpio); +} + +#endif
(quoted diff) +0 -0
b/arch/m68knommu/platform/coldfire/gpio.c
new file mode 100644
index 0000000..c2504b9
arch/m68knommu/platform/coldfire/gpio.c new file +1969 -0
1,969 lines not on this page · raw message
Hi Steven,
Quoted 132 lines · Steven King
The basic Coldfire generic gpio implementation.
Signed-off-by Steven King <[email protected]>arch/m68knommu/platform/coldfire/gpio.c new file +122
-0@@ -0,0 +1,1969 @@ +/* +* Coldfire generic GPIO support. +* +* (C) Copyright 2009, Steven King <[email protected]> +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation; version 2 of the License. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +*/ + +#include <linux/kernel.h> +#include <linux/init.h> +#include <linux/sysdev.h> + +#include <asm/gpio.h> +#include <asm/pinmux.h> + +struct mcf_gpio_chip { +struct gpio_chip gpio_chip; +void __iomem *pddr; +void __iomem *podr; +void __iomem *ppdr; +void __iomem *setr; +void __iomem *clrr; +const u8 *gpio_to_pinmux; +}; + +#define MCF_CHIP (chip) container_of(chip, struct mcf_gpio_chip, gpio_chip) + +static int mcf_gpio_direction_input (struct gpio_chip *chip,unsigned offset) +{ +unsigned long flags; +MCFGPIO_PORTTYPE dir; +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +local_irq_save (flags); + dir =mcfgpio_read (mcf_chip->pddr); + dir &= ~mcfgpio_bit (chip->base + offset); +mcfgpio_write (dir, mcf_chip->pddr); +local_irq_restore (flags); + +return 0 ; +} + +static int mcf_gpio_get_value (struct gpio_chip *chip,unsigned offset) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +return mcfgpio_read (mcf_chip->ppdr) &mcfgpio_bit (chip->base + offset); +} + +static int mcf_gpio_direction_output (struct gpio_chip *chip,unsigned offset, +int value) +{ +unsigned long flags; +MCFGPIO_PORTTYPE data; +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +local_irq_save (flags); +/* write the value to the output latch */ + data =mcfgpio_read (mcf_chip->podr); +if (value) + data |=mcfgpio_bit (chip->base + offset); +else + data &= ~mcfgpio_bit (chip->base + offset); +mcfgpio_write (data, mcf_chip->podr); + +/* now set the direction to output */ + data =mcfgpio_read (mcf_chip->pddr); + data |=mcfgpio_bit (chip->base + offset); +mcfgpio_write (data, mcf_chip->pddr); +local_irq_restore (flags); + +return 0 ; +} + +static void mcf_gpio_set_value (struct gpio_chip *chip,unsigned offset, +int value) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +unsigned long flags; +MCFGPIO_PORTTYPE data; + +local_irq_save (flags); + data =mcfgpio_read (mcf_chip->podr); +if (value) + data |=mcfgpio_bit (chip->base + offset); +else + data &= ~mcfgpio_bit (chip->base + offset); +mcfgpio_write (data, mcf_chip->podr); +local_irq_restore (flags); +} + +#if defined(CONFIG_M520x) || defined(CONFIG_M523x) || \ + defined(CONFIG_M527x) || defined(CONFIG_M528x) || defined(CONFIG_M532x) +static void mcf_gpio_set_value_fast (struct gpio_chip *chip,unsigned offset, +int value) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +if (value) +mcfgpio_write (mcfgpio_bit (chip->base + offset), mcf_chip->setr); +else +mcfgpio_write (~mcfgpio_bit (chip->base + offset), mcf_chip->clrr); +} +#endif +static int mcf_gpio_request (struct gpio_chip *chip,unsigned offset) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +return mcf_chip->gpio_to_pinmux ? +mcf_pinmux_request (mcf_chip->gpio_to_pinmux[offset],0 ) :0 ; +} + +static void mcf_gpio_free (struct gpio_chip *chip,unsigned offset) +{
arch/m68knommu/platform/coldfire/gpio.c line 132
Quoted 10 lines
arch/m68knommu/platform/coldfire/gpio.c new file +10
-0+struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +mcf_gpio_direction_input (chip, offset); + +if (mcf_chip->gpio_to_pinmux) +mcf_pinmux_release (mcf_chip->gpio_to_pinmux[offset],0 ); +} + +static struct mcf_gpio_chip mcf_gpio_chips[] = { +#if defined(CONFIG_M5206 ) || defined(CONFIG_M5206e)
I would rather see this table's contents in the per-platform setup code (so under ~/arch/m68knommu/platform/m5206, etc). Associated with each family members specific code. I would have a gpio.c in each platform directory just for this.
Keep the common code above in coldfire/gpio.c (the support functions could obviously no longer be static). When new family members are created/added this common coldfire/gpio.c won't need to be touched.
Otherwise I don't see any specific problems with it.
Regards
Greg
Quoted 16 lines
arch/m68knommu/platform/coldfire/gpio.c new file +16
-0+ { + .gpio_chip = { + .label = "PP", + .request = mcf_gpio_request, + .free = mcf_gpio_free, + .direction_input = mcf_gpio_direction_input, + .direction_output = mcf_gpio_direction_output, + .get = mcf_gpio_get_value, + .set = mcf_gpio_set_value, + .ngpio = 8, + }, + .pddr = MCFSIM_PADDR, + .podr = MCFSIM_PADAT, + .ppdr = MCFSIM_PADAT, + }, +#elif defined(CONFIG_M520x)
...
Quoted 1 line
Signature · 5 lines
------------------------------------------------------------------------ Greg Ungerer -- Principal Engineer EMAIL: [email protected] SnapGear, a McAfee Company PHONE: +61 7 3435 2888 825 Stanley St, FAX: +61 7 3891 3630 Woolloongabba, QLD, 4102, Australia WEB: http://www.SnapGear.com
Quoted 152 lines · On Wednesday, March 18, 2009 11:32:44 Greg Ungerer wrote:
Hi Steven,
Quoted 133 lines · Steven King
The basic Coldfire generic gpio implementation.
Signed-off-by Steven King <[email protected]>arch/m68knommu/platform/coldfire/gpio.c new file +33
-0@@ -0,0 +1,1969 @@ +/* +* Coldfire generic GPIO support. +* +* (C) Copyright 2009, Steven King <[email protected]> +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation; version 2 of the License. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +*/ + +#include <linux/kernel.h> +#include <linux/init.h> +#include <linux/sysdev.h> + +#include <asm/gpio.h> +#include <asm/pinmux.h> + +struct mcf_gpio_chip { +struct gpio_chip gpio_chip; +void __iomem *pddr; +void __iomem *podr; +void __iomem *ppdr; +void __iomem *setr; +void __iomem *clrr; +const u8 *gpio_to_pinmux; +}; + +#define MCF_CHIP (chip) container_of(chip, struct mcf_gpio_chip,
gpio_chip) +
+static intmcf_gpio_direction_input(struct gpio_chip *chip, unsigned offset)+{arch/m68knommu/platform/coldfire/gpio.c new file +21
-0+unsigned long flags; +MCFGPIO_PORTTYPE dir; +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +local_irq_save (flags); + dir =mcfgpio_read (mcf_chip->pddr); + dir &= ~mcfgpio_bit (chip->base + offset); +mcfgpio_write (dir, mcf_chip->pddr); +local_irq_restore (flags); + +return 0 ; +} + +static int mcf_gpio_get_value (struct gpio_chip *chip,unsigned offset) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +return mcfgpio_read (mcf_chip->ppdr) &mcfgpio_bit (chip->base + offset); +} + +static int mcf_gpio_direction_output(struct gpio_chip *chip, unsignedoffset, + int value)
arch/m68knommu/platform/coldfire/gpio.c new file +43
-0+{ +unsigned long flags; +MCFGPIO_PORTTYPE data; +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +local_irq_save (flags); +/* write the value to the output latch */ + data =mcfgpio_read (mcf_chip->podr); +if (value) + data |=mcfgpio_bit (chip->base + offset); +else + data &= ~mcfgpio_bit (chip->base + offset); +mcfgpio_write (data, mcf_chip->podr); + +/* now set the direction to output */ + data =mcfgpio_read (mcf_chip->pddr); + data |=mcfgpio_bit (chip->base + offset); +mcfgpio_write (data, mcf_chip->pddr); +local_irq_restore (flags); + +return 0 ; +} + +static void mcf_gpio_set_value (struct gpio_chip *chip,unsigned offset, +int value) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +unsigned long flags; +MCFGPIO_PORTTYPE data; + +local_irq_save (flags); + data =mcfgpio_read (mcf_chip->podr); +if (value) + data |=mcfgpio_bit (chip->base + offset); +else + data &= ~mcfgpio_bit (chip->base + offset); +mcfgpio_write (data, mcf_chip->podr); +local_irq_restore (flags); +} + +#if defined(CONFIG_M520x) || defined(CONFIG_M523x) || \ + defined(CONFIG_M527x) || defined(CONFIG_M528x) ||
defined(CONFIG_M532x)+static void mcf_gpio_set_value_fast(structgpio_chip*chip, unsigned offset, + int value)arch/m68knommu/platform/coldfire/gpio.c new file +19
-0+{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +if (value) +mcfgpio_write (mcfgpio_bit (chip->base + offset), mcf_chip->setr); +else +mcfgpio_write (~mcfgpio_bit (chip->base + offset), mcf_chip->clrr); +} +#endif +static int mcf_gpio_request (struct gpio_chip *chip,unsigned offset) +{ +struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +return mcf_chip->gpio_to_pinmux ? +mcf_pinmux_request (mcf_chip->gpio_to_pinmux[offset],0 ) :0 ; +} + +static void mcf_gpio_free (struct gpio_chip *chip,unsigned offset) +{arch/m68knommu/platform/coldfire/gpio.c line 132
Quoted 10 lines
arch/m68knommu/platform/coldfire/gpio.c new file +10
-0+struct mcf_gpio_chip *mcf_chip =MCF_CHIP (chip); + +mcf_gpio_direction_input (chip, offset); + +if (mcf_chip->gpio_to_pinmux) +mcf_pinmux_release (mcf_chip->gpio_to_pinmux[offset],0 ); +} + +static struct mcf_gpio_chip mcf_gpio_chips[] = { +#if defined(CONFIG_M5206 ) || defined(CONFIG_M5206e)I would rather see this table's contents in the per-platform setup code (so under ~/arch/m68knommu/platform/m5206, etc). Associated with each family members specific code. I would have a
gpio.cin each platform directory just for this.
Quoted 4 lines
Keep the common code above in
coldfire/gpio.c(the support functions could obviously no longer be static). When new family members are created/added this commoncoldfire/gpio.cwon't need to be touched.
Yeah, I was trying to keep the implementation details static as much as possible. Having a per-platform table means the struct mcf_gpio_chip also needs to go into a header which I found mildly aesthetically unpleasing. Oh well.
Quoted 1 line
Otherwise I don't see any specific problems with it.
Cool. I'll fold the per-platform table into the next version of the patch which adds pinmux support (and which definately is going to require per-platform files).
Signature · 1 line
Steven King -- sfking at fdwdc dot com