2 * linux/arch/arm/mach-at91/gpio.c
4 * Copyright (C) 2005 HP Labs
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
12 #include <linux/clk.h>
13 #include <linux/errno.h>
14 #include <linux/interrupt.h>
15 #include <linux/irq.h>
16 #include <linux/debugfs.h>
17 #include <linux/seq_file.h>
18 #include <linux/kernel.h>
19 #include <linux/list.h>
20 #include <linux/module.h>
23 #include <mach/hardware.h>
24 #include <mach/at91_pio.h>
25 #include <mach/gpio.h>
31 struct at91_gpio_chip
{
32 struct gpio_chip chip
;
33 struct at91_gpio_chip
*next
; /* Bank sharing same clock */
34 struct at91_gpio_bank
*bank
; /* Bank definition */
35 void __iomem
*regbase
; /* Base of register bank */
38 #define to_at91_gpio_chip(c) container_of(c, struct at91_gpio_chip, chip)
40 static void at91_gpiolib_dbg_show(struct seq_file
*s
, struct gpio_chip
*chip
);
41 static void at91_gpiolib_set(struct gpio_chip
*chip
, unsigned offset
, int val
);
42 static int at91_gpiolib_get(struct gpio_chip
*chip
, unsigned offset
);
43 static int at91_gpiolib_direction_output(struct gpio_chip
*chip
,
44 unsigned offset
, int val
);
45 static int at91_gpiolib_direction_input(struct gpio_chip
*chip
,
48 #define AT91_GPIO_CHIP(name, base_gpio, nr_gpio) \
52 .direction_input = at91_gpiolib_direction_input, \
53 .direction_output = at91_gpiolib_direction_output, \
54 .get = at91_gpiolib_get, \
55 .set = at91_gpiolib_set, \
56 .dbg_show = at91_gpiolib_dbg_show, \
62 static struct at91_gpio_chip gpio_chip
[] = {
63 AT91_GPIO_CHIP("A", 0x00 + PIN_BASE
, 32),
64 AT91_GPIO_CHIP("B", 0x20 + PIN_BASE
, 32),
65 AT91_GPIO_CHIP("C", 0x40 + PIN_BASE
, 32),
66 AT91_GPIO_CHIP("D", 0x60 + PIN_BASE
, 32),
67 AT91_GPIO_CHIP("E", 0x80 + PIN_BASE
, 32),
70 static int gpio_banks
;
72 static inline void __iomem
*pin_to_controller(unsigned pin
)
76 if (likely(pin
< gpio_banks
))
77 return gpio_chip
[pin
].regbase
;
82 static inline unsigned pin_to_mask(unsigned pin
)
85 return 1 << (pin
% 32);
89 /*--------------------------------------------------------------------------*/
91 /* Not all hardware capabilities are exposed through these calls; they
92 * only encapsulate the most common features and modes. (So if you
93 * want to change signals in groups, do it directly.)
95 * Bootloaders will usually handle some of the pin multiplexing setup.
96 * The intent is certainly that by the time Linux is fully booted, all
97 * pins should have been fully initialized. These setup calls should
98 * only be used by board setup routines, or possibly in driver probe().
100 * For bootloaders doing all that setup, these calls could be inlined
101 * as NOPs so Linux won't duplicate any setup code
106 * mux the pin to the "GPIO" peripheral role.
108 int __init_or_module
at91_set_GPIO_periph(unsigned pin
, int use_pullup
)
110 void __iomem
*pio
= pin_to_controller(pin
);
111 unsigned mask
= pin_to_mask(pin
);
115 __raw_writel(mask
, pio
+ PIO_IDR
);
116 __raw_writel(mask
, pio
+ (use_pullup
? PIO_PUER
: PIO_PUDR
));
117 __raw_writel(mask
, pio
+ PIO_PER
);
120 EXPORT_SYMBOL(at91_set_GPIO_periph
);
124 * mux the pin to the "A" internal peripheral role.
126 int __init_or_module
at91_set_A_periph(unsigned pin
, int use_pullup
)
128 void __iomem
*pio
= pin_to_controller(pin
);
129 unsigned mask
= pin_to_mask(pin
);
134 __raw_writel(mask
, pio
+ PIO_IDR
);
135 __raw_writel(mask
, pio
+ (use_pullup
? PIO_PUER
: PIO_PUDR
));
136 __raw_writel(mask
, pio
+ PIO_ASR
);
137 __raw_writel(mask
, pio
+ PIO_PDR
);
140 EXPORT_SYMBOL(at91_set_A_periph
);
144 * mux the pin to the "B" internal peripheral role.
146 int __init_or_module
at91_set_B_periph(unsigned pin
, int use_pullup
)
148 void __iomem
*pio
= pin_to_controller(pin
);
149 unsigned mask
= pin_to_mask(pin
);
154 __raw_writel(mask
, pio
+ PIO_IDR
);
155 __raw_writel(mask
, pio
+ (use_pullup
? PIO_PUER
: PIO_PUDR
));
156 __raw_writel(mask
, pio
+ PIO_BSR
);
157 __raw_writel(mask
, pio
+ PIO_PDR
);
160 EXPORT_SYMBOL(at91_set_B_periph
);
164 * mux the pin to the gpio controller (instead of "A" or "B" peripheral), and
165 * configure it for an input.
167 int __init_or_module
at91_set_gpio_input(unsigned pin
, int use_pullup
)
169 void __iomem
*pio
= pin_to_controller(pin
);
170 unsigned mask
= pin_to_mask(pin
);
175 __raw_writel(mask
, pio
+ PIO_IDR
);
176 __raw_writel(mask
, pio
+ (use_pullup
? PIO_PUER
: PIO_PUDR
));
177 __raw_writel(mask
, pio
+ PIO_ODR
);
178 __raw_writel(mask
, pio
+ PIO_PER
);
181 EXPORT_SYMBOL(at91_set_gpio_input
);
185 * mux the pin to the gpio controller (instead of "A" or "B" peripheral),
186 * and configure it for an output.
188 int __init_or_module
at91_set_gpio_output(unsigned pin
, int value
)
190 void __iomem
*pio
= pin_to_controller(pin
);
191 unsigned mask
= pin_to_mask(pin
);
196 __raw_writel(mask
, pio
+ PIO_IDR
);
197 __raw_writel(mask
, pio
+ PIO_PUDR
);
198 __raw_writel(mask
, pio
+ (value
? PIO_SODR
: PIO_CODR
));
199 __raw_writel(mask
, pio
+ PIO_OER
);
200 __raw_writel(mask
, pio
+ PIO_PER
);
203 EXPORT_SYMBOL(at91_set_gpio_output
);
207 * enable/disable the glitch filter; mostly used with IRQ handling.
209 int __init_or_module
at91_set_deglitch(unsigned pin
, int is_on
)
211 void __iomem
*pio
= pin_to_controller(pin
);
212 unsigned mask
= pin_to_mask(pin
);
216 __raw_writel(mask
, pio
+ (is_on
? PIO_IFER
: PIO_IFDR
));
219 EXPORT_SYMBOL(at91_set_deglitch
);
222 * enable/disable the multi-driver; This is only valid for output and
223 * allows the output pin to run as an open collector output.
225 int __init_or_module
at91_set_multi_drive(unsigned pin
, int is_on
)
227 void __iomem
*pio
= pin_to_controller(pin
);
228 unsigned mask
= pin_to_mask(pin
);
233 __raw_writel(mask
, pio
+ (is_on
? PIO_MDER
: PIO_MDDR
));
236 EXPORT_SYMBOL(at91_set_multi_drive
);
239 * assuming the pin is muxed as a gpio output, set its value.
241 int at91_set_gpio_value(unsigned pin
, int value
)
243 void __iomem
*pio
= pin_to_controller(pin
);
244 unsigned mask
= pin_to_mask(pin
);
248 __raw_writel(mask
, pio
+ (value
? PIO_SODR
: PIO_CODR
));
251 EXPORT_SYMBOL(at91_set_gpio_value
);
255 * read the pin's value (works even if it's not muxed as a gpio).
257 int at91_get_gpio_value(unsigned pin
)
259 void __iomem
*pio
= pin_to_controller(pin
);
260 unsigned mask
= pin_to_mask(pin
);
265 pdsr
= __raw_readl(pio
+ PIO_PDSR
);
266 return (pdsr
& mask
) != 0;
268 EXPORT_SYMBOL(at91_get_gpio_value
);
270 /*--------------------------------------------------------------------------*/
274 static u32 wakeups
[MAX_GPIO_BANKS
];
275 static u32 backups
[MAX_GPIO_BANKS
];
277 static int gpio_irq_set_wake(unsigned pin
, unsigned state
)
279 unsigned mask
= pin_to_mask(pin
);
280 unsigned bank
= (pin
- PIN_BASE
) / 32;
282 if (unlikely(bank
>= MAX_GPIO_BANKS
))
286 wakeups
[bank
] |= mask
;
288 wakeups
[bank
] &= ~mask
;
290 set_irq_wake(gpio_chip
[bank
].bank
->id
, state
);
295 void at91_gpio_suspend(void)
299 for (i
= 0; i
< gpio_banks
; i
++) {
300 void __iomem
*pio
= gpio_chip
[i
].regbase
;
302 backups
[i
] = __raw_readl(pio
+ PIO_IMR
);
303 __raw_writel(backups
[i
], pio
+ PIO_IDR
);
304 __raw_writel(wakeups
[i
], pio
+ PIO_IER
);
307 clk_disable(gpio_chip
[i
].bank
->clock
);
309 #ifdef CONFIG_PM_DEBUG
310 printk(KERN_DEBUG
"GPIO-%c may wake for %08x\n", 'A'+i
, wakeups
[i
]);
316 void at91_gpio_resume(void)
320 for (i
= 0; i
< gpio_banks
; i
++) {
321 void __iomem
*pio
= gpio_chip
[i
].regbase
;
324 clk_enable(gpio_chip
[i
].bank
->clock
);
326 __raw_writel(wakeups
[i
], pio
+ PIO_IDR
);
327 __raw_writel(backups
[i
], pio
+ PIO_IER
);
332 #define gpio_irq_set_wake NULL
336 /* Several AIC controller irqs are dispatched through this GPIO handler.
337 * To use any AT91_PIN_* as an externally triggered IRQ, first call
338 * at91_set_gpio_input() then maybe enable its glitch filter.
339 * Then just request_irq() with the pin ID; it works like any ARM IRQ
340 * handler, though it always triggers on rising and falling edges.
342 * Alternatively, certain pins may be used directly as IRQ0..IRQ6 after
343 * configuring them with at91_set_a_periph() or at91_set_b_periph().
344 * IRQ0..IRQ6 should be configurable, e.g. level vs edge triggering.
347 static void gpio_irq_mask(unsigned pin
)
349 void __iomem
*pio
= pin_to_controller(pin
);
350 unsigned mask
= pin_to_mask(pin
);
353 __raw_writel(mask
, pio
+ PIO_IDR
);
356 static void gpio_irq_unmask(unsigned pin
)
358 void __iomem
*pio
= pin_to_controller(pin
);
359 unsigned mask
= pin_to_mask(pin
);
362 __raw_writel(mask
, pio
+ PIO_IER
);
365 static int gpio_irq_type(unsigned pin
, unsigned type
)
369 case IRQ_TYPE_EDGE_BOTH
:
376 static struct irq_chip gpio_irqchip
= {
378 .mask
= gpio_irq_mask
,
379 .unmask
= gpio_irq_unmask
,
380 .set_type
= gpio_irq_type
,
381 .set_wake
= gpio_irq_set_wake
,
384 static void gpio_irq_handler(unsigned irq
, struct irq_desc
*desc
)
387 struct irq_desc
*gpio
;
388 struct at91_gpio_chip
*at91_gpio
;
392 at91_gpio
= get_irq_chip_data(irq
);
393 pio
= at91_gpio
->regbase
;
395 /* temporarily mask (level sensitive) parent IRQ */
396 desc
->chip
->ack(irq
);
398 /* Reading ISR acks pending (edge triggered) GPIO interrupts.
399 * When there none are pending, we're finished unless we need
400 * to process multiple banks (like ID_PIOCDE on sam9263).
402 isr
= __raw_readl(pio
+ PIO_ISR
) & __raw_readl(pio
+ PIO_IMR
);
404 if (!at91_gpio
->next
)
406 at91_gpio
= at91_gpio
->next
;
407 pio
= at91_gpio
->regbase
;
411 pin
= at91_gpio
->chip
.base
;
412 gpio
= &irq_desc
[pin
];
416 if (unlikely(gpio
->depth
)) {
418 * The core ARM interrupt handler lazily disables IRQs so
419 * another IRQ must be generated before it actually gets
420 * here to be disabled on the GPIO controller.
425 generic_handle_irq(pin
);
432 desc
->chip
->unmask(irq
);
433 /* now it may re-trigger */
436 /*--------------------------------------------------------------------------*/
438 #ifdef CONFIG_DEBUG_FS
440 static int at91_gpio_show(struct seq_file
*s
, void *unused
)
445 seq_printf(s
, "Pin\t");
446 for (bank
= 0; bank
< gpio_banks
; bank
++) {
447 seq_printf(s
, "PIO%c\t", 'A' + bank
);
449 seq_printf(s
, "\n\n");
451 /* print pin status */
452 for (j
= 0; j
< 32; j
++) {
453 seq_printf(s
, "%i:\t", j
);
455 for (bank
= 0; bank
< gpio_banks
; bank
++) {
456 unsigned pin
= PIN_BASE
+ (32 * bank
) + j
;
457 void __iomem
*pio
= pin_to_controller(pin
);
458 unsigned mask
= pin_to_mask(pin
);
460 if (__raw_readl(pio
+ PIO_PSR
) & mask
)
461 seq_printf(s
, "GPIO:%s", __raw_readl(pio
+ PIO_PDSR
) & mask
? "1" : "0");
463 seq_printf(s
, "%s", __raw_readl(pio
+ PIO_ABSR
) & mask
? "B" : "A");
474 static int at91_gpio_open(struct inode
*inode
, struct file
*file
)
476 return single_open(file
, at91_gpio_show
, NULL
);
479 static const struct file_operations at91_gpio_operations
= {
480 .open
= at91_gpio_open
,
483 .release
= single_release
,
486 static int __init
at91_gpio_debugfs_init(void)
488 /* /sys/kernel/debug/at91_gpio */
489 (void) debugfs_create_file("at91_gpio", S_IFREG
| S_IRUGO
, NULL
, NULL
, &at91_gpio_operations
);
492 postcore_initcall(at91_gpio_debugfs_init
);
496 /*--------------------------------------------------------------------------*/
499 * This lock class tells lockdep that GPIO irqs are in a different
500 * category than their parents, so it won't report false recursion.
502 static struct lock_class_key gpio_lock_class
;
505 * Called from the processor-specific init to enable GPIO interrupt support.
507 void __init
at91_gpio_irq_setup(void)
510 struct at91_gpio_chip
*this, *prev
;
512 for (pioc
= 0, pin
= PIN_BASE
, this = gpio_chip
, prev
= NULL
;
514 prev
= this, this++) {
515 unsigned id
= this->bank
->id
;
518 __raw_writel(~0, this->regbase
+ PIO_IDR
);
520 for (i
= 0, pin
= this->chip
.base
; i
< 32; i
++, pin
++) {
521 lockdep_set_class(&irq_desc
[pin
].lock
, &gpio_lock_class
);
524 * Can use the "simple" and not "edge" handler since it's
525 * shorter, and the AIC handles interrupts sanely.
527 set_irq_chip(pin
, &gpio_irqchip
);
528 set_irq_handler(pin
, handle_simple_irq
);
529 set_irq_flags(pin
, IRQF_VALID
);
532 /* The toplevel handler handles one bank of GPIOs, except
533 * AT91SAM9263_ID_PIOCDE handles three... PIOC is first in
534 * the list, so we only set up that handler.
536 if (prev
&& prev
->next
== this)
539 set_irq_chip_data(id
, this);
540 set_irq_chained_handler(id
, gpio_irq_handler
);
542 pr_info("AT91: %d gpio irqs in %d banks\n", pin
- PIN_BASE
, gpio_banks
);
545 /* gpiolib support */
546 static int at91_gpiolib_direction_input(struct gpio_chip
*chip
,
549 struct at91_gpio_chip
*at91_gpio
= to_at91_gpio_chip(chip
);
550 void __iomem
*pio
= at91_gpio
->regbase
;
551 unsigned mask
= 1 << offset
;
553 __raw_writel(mask
, pio
+ PIO_ODR
);
557 static int at91_gpiolib_direction_output(struct gpio_chip
*chip
,
558 unsigned offset
, int val
)
560 struct at91_gpio_chip
*at91_gpio
= to_at91_gpio_chip(chip
);
561 void __iomem
*pio
= at91_gpio
->regbase
;
562 unsigned mask
= 1 << offset
;
564 __raw_writel(mask
, pio
+ (val
? PIO_SODR
: PIO_CODR
));
565 __raw_writel(mask
, pio
+ PIO_OER
);
569 static int at91_gpiolib_get(struct gpio_chip
*chip
, unsigned offset
)
571 struct at91_gpio_chip
*at91_gpio
= to_at91_gpio_chip(chip
);
572 void __iomem
*pio
= at91_gpio
->regbase
;
573 unsigned mask
= 1 << offset
;
576 pdsr
= __raw_readl(pio
+ PIO_PDSR
);
577 return (pdsr
& mask
) != 0;
580 static void at91_gpiolib_set(struct gpio_chip
*chip
, unsigned offset
, int val
)
582 struct at91_gpio_chip
*at91_gpio
= to_at91_gpio_chip(chip
);
583 void __iomem
*pio
= at91_gpio
->regbase
;
584 unsigned mask
= 1 << offset
;
586 __raw_writel(mask
, pio
+ (val
? PIO_SODR
: PIO_CODR
));
589 static void at91_gpiolib_dbg_show(struct seq_file
*s
, struct gpio_chip
*chip
)
593 for (i
= 0; i
< chip
->ngpio
; i
++) {
594 unsigned pin
= chip
->base
+ i
;
595 void __iomem
*pio
= pin_to_controller(pin
);
596 unsigned mask
= pin_to_mask(pin
);
597 const char *gpio_label
;
599 gpio_label
= gpiochip_is_requested(chip
, i
);
601 seq_printf(s
, "[%s] GPIO%s%d: ",
602 gpio_label
, chip
->label
, i
);
603 if (__raw_readl(pio
+ PIO_PSR
) & mask
)
604 seq_printf(s
, "[gpio] %s\n",
605 at91_get_gpio_value(pin
) ?
608 seq_printf(s
, "[periph %s]\n",
609 __raw_readl(pio
+ PIO_ABSR
) &
616 * Called from the processor-specific init to enable GPIO pin support.
618 void __init
at91_gpio_init(struct at91_gpio_bank
*data
, int nr_banks
)
621 struct at91_gpio_chip
*at91_gpio
, *last
= NULL
;
623 BUG_ON(nr_banks
> MAX_GPIO_BANKS
);
625 gpio_banks
= nr_banks
;
627 for (i
= 0; i
< nr_banks
; i
++) {
628 at91_gpio
= &gpio_chip
[i
];
630 at91_gpio
->bank
= &data
[i
];
631 at91_gpio
->chip
.base
= PIN_BASE
+ i
* 32;
632 at91_gpio
->regbase
= at91_gpio
->bank
->offset
+
633 (void __iomem
*)AT91_VA_BASE_SYS
;
635 /* enable PIO controller's clock */
636 clk_enable(at91_gpio
->bank
->clock
);
638 /* AT91SAM9263_ID_PIOCDE groups PIOC, PIOD, PIOE */
639 if (last
&& last
->bank
->id
== at91_gpio
->bank
->id
)
640 last
->next
= at91_gpio
;
643 gpiochip_add(&at91_gpio
->chip
);