2 * Generic driver for memory-mapped GPIO controllers.
4 * Copyright 2008 MontaVista Software, Inc.
5 * Copyright 2008,2010 Anton Vorontsov <cbouatmailru@gmail.com>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
12 * ....``.```~~~~````.`.`.`.`.```````'',,,.........`````......`.......
14 * ..The simplest form of a GPIO controller that the driver supports is``
15 * `.just a single "data" register, where GPIO state can be read and/or `
16 * `,..written. ,,..``~~~~ .....``.`.`.~~.```.`.........``````.```````
19 _/~~|___/~| . ```~~~~~~ ___/___\___ ,~.`.`.`.`````.~~...,,,,...
20 __________|~$@~~~ %~ /o*o*o*o*o*o\ .. Implementing such a GPIO .
21 o ` ~~~~\___/~~~~ ` controller in FPGA is ,.`
22 `....trivial..'~`.```.```
24 * .```````~~~~`..`.``.``.
25 * . The driver supports `... ,..```.`~~~```````````````....````.``,,
26 * . big-endian notation, just`. .. A bit more sophisticated controllers ,
27 * . register the device with -be`. .with a pair of set/clear-bit registers ,
28 * `.. suffix. ```~~`````....`.` . affecting the data register and the .`
29 * ``.`.``...``` ```.. output pins are also supported.`
30 * ^^ `````.`````````.,``~``~``~~``````
32 * ,..`.`.`...````````````......`.`.`.`.`.`..`.`.`..
33 * .. The expectation is that in at least some cases . ,-~~~-,
34 * .this will be used with roll-your-own ASIC/FPGA .` \ /
35 * .logic in Verilog or VHDL. ~~~`````````..`````~~` \ /
36 * ..````````......``````````` \o_
40 * ...`````~~`.....``.`..........``````.`.``.```........``.
41 * ` 8, 16, 32 and 64 bits registers are supported, and``.
42 * . the number of GPIOs is determined by the width of ~
43 * .. the registers. ,............```.`.`..`.`.~~~.`.`.`~
47 #include <linux/init.h>
48 #include <linux/err.h>
49 #include <linux/bug.h>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/spinlock.h>
53 #include <linux/compiler.h>
54 #include <linux/types.h>
55 #include <linux/errno.h>
56 #include <linux/log2.h>
57 #include <linux/ioport.h>
59 #include <linux/gpio.h>
60 #include <linux/slab.h>
61 #include <linux/platform_device.h>
62 #include <linux/mod_devicetable.h>
63 #include <linux/basic_mmio_gpio.h>
65 static void bgpio_write8(void __iomem
*reg
, unsigned long data
)
70 static unsigned long bgpio_read8(void __iomem
*reg
)
75 static void bgpio_write16(void __iomem
*reg
, unsigned long data
)
80 static unsigned long bgpio_read16(void __iomem
*reg
)
85 static void bgpio_write32(void __iomem
*reg
, unsigned long data
)
90 static unsigned long bgpio_read32(void __iomem
*reg
)
95 #if BITS_PER_LONG >= 64
96 static void bgpio_write64(void __iomem
*reg
, unsigned long data
)
101 static unsigned long bgpio_read64(void __iomem
*reg
)
105 #endif /* BITS_PER_LONG >= 64 */
107 static void bgpio_write16be(void __iomem
*reg
, unsigned long data
)
109 iowrite16be(data
, reg
);
112 static unsigned long bgpio_read16be(void __iomem
*reg
)
114 return ioread16be(reg
);
117 static void bgpio_write32be(void __iomem
*reg
, unsigned long data
)
119 iowrite32be(data
, reg
);
122 static unsigned long bgpio_read32be(void __iomem
*reg
)
124 return ioread32be(reg
);
127 static unsigned long bgpio_pin2mask(struct bgpio_chip
*bgc
, unsigned int pin
)
132 static unsigned long bgpio_pin2mask_be(struct bgpio_chip
*bgc
,
135 return 1 << (bgc
->bits
- 1 - pin
);
138 static int bgpio_get_set(struct gpio_chip
*gc
, unsigned int gpio
)
140 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
141 unsigned long pinmask
= bgc
->pin2mask(bgc
, gpio
);
143 if (bgc
->dir
& pinmask
)
144 return !!(bgc
->read_reg(bgc
->reg_set
) & pinmask
);
146 return !!(bgc
->read_reg(bgc
->reg_dat
) & pinmask
);
149 static int bgpio_get(struct gpio_chip
*gc
, unsigned int gpio
)
151 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
153 return !!(bgc
->read_reg(bgc
->reg_dat
) & bgc
->pin2mask(bgc
, gpio
));
156 static void bgpio_set_none(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
160 static void bgpio_set(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
162 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
163 unsigned long mask
= bgc
->pin2mask(bgc
, gpio
);
166 spin_lock_irqsave(&bgc
->lock
, flags
);
173 bgc
->write_reg(bgc
->reg_dat
, bgc
->data
);
175 spin_unlock_irqrestore(&bgc
->lock
, flags
);
178 static void bgpio_set_with_clear(struct gpio_chip
*gc
, unsigned int gpio
,
181 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
182 unsigned long mask
= bgc
->pin2mask(bgc
, gpio
);
185 bgc
->write_reg(bgc
->reg_set
, mask
);
187 bgc
->write_reg(bgc
->reg_clr
, mask
);
190 static void bgpio_set_set(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
192 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
193 unsigned long mask
= bgc
->pin2mask(bgc
, gpio
);
196 spin_lock_irqsave(&bgc
->lock
, flags
);
203 bgc
->write_reg(bgc
->reg_set
, bgc
->data
);
205 spin_unlock_irqrestore(&bgc
->lock
, flags
);
208 static void bgpio_multiple_get_masks(struct bgpio_chip
*bgc
,
209 unsigned long *mask
, unsigned long *bits
,
210 unsigned long *set_mask
,
211 unsigned long *clear_mask
)
218 for (i
= 0; i
< bgc
->bits
; i
++) {
221 if (__test_and_clear_bit(i
, mask
)) {
222 if (test_bit(i
, bits
))
223 *set_mask
|= bgc
->pin2mask(bgc
, i
);
225 *clear_mask
|= bgc
->pin2mask(bgc
, i
);
230 static void bgpio_set_multiple_single_reg(struct bgpio_chip
*bgc
,
236 unsigned long set_mask
, clear_mask
;
238 spin_lock_irqsave(&bgc
->lock
, flags
);
240 bgpio_multiple_get_masks(bgc
, mask
, bits
, &set_mask
, &clear_mask
);
242 bgc
->data
|= set_mask
;
243 bgc
->data
&= ~clear_mask
;
245 bgc
->write_reg(reg
, bgc
->data
);
247 spin_unlock_irqrestore(&bgc
->lock
, flags
);
250 static void bgpio_set_multiple(struct gpio_chip
*gc
, unsigned long *mask
,
253 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
255 bgpio_set_multiple_single_reg(bgc
, mask
, bits
, bgc
->reg_dat
);
258 static void bgpio_set_multiple_set(struct gpio_chip
*gc
, unsigned long *mask
,
261 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
263 bgpio_set_multiple_single_reg(bgc
, mask
, bits
, bgc
->reg_set
);
266 static void bgpio_set_multiple_with_clear(struct gpio_chip
*gc
,
270 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
271 unsigned long set_mask
, clear_mask
;
273 bgpio_multiple_get_masks(bgc
, mask
, bits
, &set_mask
, &clear_mask
);
276 bgc
->write_reg(bgc
->reg_set
, set_mask
);
278 bgc
->write_reg(bgc
->reg_clr
, clear_mask
);
281 static int bgpio_simple_dir_in(struct gpio_chip
*gc
, unsigned int gpio
)
286 static int bgpio_dir_out_err(struct gpio_chip
*gc
, unsigned int gpio
,
292 static int bgpio_simple_dir_out(struct gpio_chip
*gc
, unsigned int gpio
,
295 gc
->set(gc
, gpio
, val
);
300 static int bgpio_dir_in(struct gpio_chip
*gc
, unsigned int gpio
)
302 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
305 spin_lock_irqsave(&bgc
->lock
, flags
);
307 bgc
->dir
&= ~bgc
->pin2mask(bgc
, gpio
);
308 bgc
->write_reg(bgc
->reg_dir
, bgc
->dir
);
310 spin_unlock_irqrestore(&bgc
->lock
, flags
);
315 static int bgpio_get_dir(struct gpio_chip
*gc
, unsigned int gpio
)
317 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
319 return (bgc
->read_reg(bgc
->reg_dir
) & bgc
->pin2mask(bgc
, gpio
)) ?
320 GPIOF_DIR_OUT
: GPIOF_DIR_IN
;
323 static int bgpio_dir_out(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
325 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
328 gc
->set(gc
, gpio
, val
);
330 spin_lock_irqsave(&bgc
->lock
, flags
);
332 bgc
->dir
|= bgc
->pin2mask(bgc
, gpio
);
333 bgc
->write_reg(bgc
->reg_dir
, bgc
->dir
);
335 spin_unlock_irqrestore(&bgc
->lock
, flags
);
340 static int bgpio_dir_in_inv(struct gpio_chip
*gc
, unsigned int gpio
)
342 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
345 spin_lock_irqsave(&bgc
->lock
, flags
);
347 bgc
->dir
|= bgc
->pin2mask(bgc
, gpio
);
348 bgc
->write_reg(bgc
->reg_dir
, bgc
->dir
);
350 spin_unlock_irqrestore(&bgc
->lock
, flags
);
355 static int bgpio_dir_out_inv(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
357 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
360 gc
->set(gc
, gpio
, val
);
362 spin_lock_irqsave(&bgc
->lock
, flags
);
364 bgc
->dir
&= ~bgc
->pin2mask(bgc
, gpio
);
365 bgc
->write_reg(bgc
->reg_dir
, bgc
->dir
);
367 spin_unlock_irqrestore(&bgc
->lock
, flags
);
372 static int bgpio_get_dir_inv(struct gpio_chip
*gc
, unsigned int gpio
)
374 struct bgpio_chip
*bgc
= to_bgpio_chip(gc
);
376 return (bgc
->read_reg(bgc
->reg_dir
) & bgc
->pin2mask(bgc
, gpio
)) ?
377 GPIOF_DIR_IN
: GPIOF_DIR_OUT
;
380 static int bgpio_setup_accessors(struct device
*dev
,
381 struct bgpio_chip
*bgc
,
388 bgc
->read_reg
= bgpio_read8
;
389 bgc
->write_reg
= bgpio_write8
;
393 bgc
->read_reg
= bgpio_read16be
;
394 bgc
->write_reg
= bgpio_write16be
;
396 bgc
->read_reg
= bgpio_read16
;
397 bgc
->write_reg
= bgpio_write16
;
402 bgc
->read_reg
= bgpio_read32be
;
403 bgc
->write_reg
= bgpio_write32be
;
405 bgc
->read_reg
= bgpio_read32
;
406 bgc
->write_reg
= bgpio_write32
;
409 #if BITS_PER_LONG >= 64
413 "64 bit big endian byte order unsupported\n");
416 bgc
->read_reg
= bgpio_read64
;
417 bgc
->write_reg
= bgpio_write64
;
420 #endif /* BITS_PER_LONG >= 64 */
422 dev_err(dev
, "unsupported data width %u bits\n", bgc
->bits
);
426 bgc
->pin2mask
= bit_be
? bgpio_pin2mask_be
: bgpio_pin2mask
;
432 * Create the device and allocate the resources. For setting GPIO's there are
433 * three supported configurations:
435 * - single input/output register resource (named "dat").
436 * - set/clear pair (named "set" and "clr").
437 * - single output register resource and single input resource ("set" and
440 * For the single output register, this drives a 1 by setting a bit and a zero
441 * by clearing a bit. For the set clr pair, this drives a 1 by setting a bit
442 * in the set register and clears it by setting a bit in the clear register.
443 * The configuration is detected by which resources are present.
445 * For setting the GPIO direction, there are three supported configurations:
447 * - simple bidirection GPIO that requires no configuration.
448 * - an output direction register (named "dirout") where a 1 bit
449 * indicates the GPIO is an output.
450 * - an input direction register (named "dirin") where a 1 bit indicates
451 * the GPIO is an input.
453 static int bgpio_setup_io(struct bgpio_chip
*bgc
,
467 bgc
->gc
.set
= bgpio_set_with_clear
;
468 bgc
->gc
.set_multiple
= bgpio_set_multiple_with_clear
;
469 } else if (set
&& !clr
) {
471 bgc
->gc
.set
= bgpio_set_set
;
472 bgc
->gc
.set_multiple
= bgpio_set_multiple_set
;
473 } else if (flags
& BGPIOF_NO_OUTPUT
) {
474 bgc
->gc
.set
= bgpio_set_none
;
475 bgc
->gc
.set_multiple
= NULL
;
477 bgc
->gc
.set
= bgpio_set
;
478 bgc
->gc
.set_multiple
= bgpio_set_multiple
;
481 if (!(flags
& BGPIOF_UNREADABLE_REG_SET
) &&
482 (flags
& BGPIOF_READ_OUTPUT_REG_SET
))
483 bgc
->gc
.get
= bgpio_get_set
;
485 bgc
->gc
.get
= bgpio_get
;
490 static int bgpio_setup_direction(struct bgpio_chip
*bgc
,
491 void __iomem
*dirout
,
495 if (dirout
&& dirin
) {
498 bgc
->reg_dir
= dirout
;
499 bgc
->gc
.direction_output
= bgpio_dir_out
;
500 bgc
->gc
.direction_input
= bgpio_dir_in
;
501 bgc
->gc
.get_direction
= bgpio_get_dir
;
503 bgc
->reg_dir
= dirin
;
504 bgc
->gc
.direction_output
= bgpio_dir_out_inv
;
505 bgc
->gc
.direction_input
= bgpio_dir_in_inv
;
506 bgc
->gc
.get_direction
= bgpio_get_dir_inv
;
508 if (flags
& BGPIOF_NO_OUTPUT
)
509 bgc
->gc
.direction_output
= bgpio_dir_out_err
;
511 bgc
->gc
.direction_output
= bgpio_simple_dir_out
;
512 bgc
->gc
.direction_input
= bgpio_simple_dir_in
;
518 static int bgpio_request(struct gpio_chip
*chip
, unsigned gpio_pin
)
520 if (gpio_pin
< chip
->ngpio
)
526 int bgpio_remove(struct bgpio_chip
*bgc
)
528 gpiochip_remove(&bgc
->gc
);
531 EXPORT_SYMBOL_GPL(bgpio_remove
);
533 int bgpio_init(struct bgpio_chip
*bgc
, struct device
*dev
,
534 unsigned long sz
, void __iomem
*dat
, void __iomem
*set
,
535 void __iomem
*clr
, void __iomem
*dirout
, void __iomem
*dirin
,
540 if (!is_power_of_2(sz
))
544 if (bgc
->bits
> BITS_PER_LONG
)
547 spin_lock_init(&bgc
->lock
);
549 bgc
->gc
.label
= dev_name(dev
);
551 bgc
->gc
.ngpio
= bgc
->bits
;
552 bgc
->gc
.request
= bgpio_request
;
554 ret
= bgpio_setup_io(bgc
, dat
, set
, clr
, flags
);
558 ret
= bgpio_setup_accessors(dev
, bgc
, flags
& BGPIOF_BIG_ENDIAN
,
559 flags
& BGPIOF_BIG_ENDIAN_BYTE_ORDER
);
563 ret
= bgpio_setup_direction(bgc
, dirout
, dirin
, flags
);
567 bgc
->data
= bgc
->read_reg(bgc
->reg_dat
);
568 if (bgc
->gc
.set
== bgpio_set_set
&&
569 !(flags
& BGPIOF_UNREADABLE_REG_SET
))
570 bgc
->data
= bgc
->read_reg(bgc
->reg_set
);
571 if (bgc
->reg_dir
&& !(flags
& BGPIOF_UNREADABLE_REG_DIR
))
572 bgc
->dir
= bgc
->read_reg(bgc
->reg_dir
);
576 EXPORT_SYMBOL_GPL(bgpio_init
);
578 #ifdef CONFIG_GPIO_GENERIC_PLATFORM
580 static void __iomem
*bgpio_map(struct platform_device
*pdev
,
582 resource_size_t sane_sz
)
587 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, name
);
591 sz
= resource_size(r
);
593 return IOMEM_ERR_PTR(-EINVAL
);
595 return devm_ioremap_resource(&pdev
->dev
, r
);
598 static int bgpio_pdev_probe(struct platform_device
*pdev
)
600 struct device
*dev
= &pdev
->dev
;
605 void __iomem
*dirout
;
608 unsigned long flags
= pdev
->id_entry
->driver_data
;
610 struct bgpio_chip
*bgc
;
611 struct bgpio_pdata
*pdata
= dev_get_platdata(dev
);
613 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "dat");
617 sz
= resource_size(r
);
619 dat
= bgpio_map(pdev
, "dat", sz
);
623 set
= bgpio_map(pdev
, "set", sz
);
627 clr
= bgpio_map(pdev
, "clr", sz
);
631 dirout
= bgpio_map(pdev
, "dirout", sz
);
633 return PTR_ERR(dirout
);
635 dirin
= bgpio_map(pdev
, "dirin", sz
);
637 return PTR_ERR(dirin
);
639 bgc
= devm_kzalloc(&pdev
->dev
, sizeof(*bgc
), GFP_KERNEL
);
643 err
= bgpio_init(bgc
, dev
, sz
, dat
, set
, clr
, dirout
, dirin
, flags
);
649 bgc
->gc
.label
= pdata
->label
;
650 bgc
->gc
.base
= pdata
->base
;
651 if (pdata
->ngpio
> 0)
652 bgc
->gc
.ngpio
= pdata
->ngpio
;
655 platform_set_drvdata(pdev
, bgc
);
657 return gpiochip_add(&bgc
->gc
);
660 static int bgpio_pdev_remove(struct platform_device
*pdev
)
662 struct bgpio_chip
*bgc
= platform_get_drvdata(pdev
);
664 return bgpio_remove(bgc
);
667 static const struct platform_device_id bgpio_id_table
[] = {
669 .name
= "basic-mmio-gpio",
672 .name
= "basic-mmio-gpio-be",
673 .driver_data
= BGPIOF_BIG_ENDIAN
,
677 MODULE_DEVICE_TABLE(platform
, bgpio_id_table
);
679 static struct platform_driver bgpio_driver
= {
681 .name
= "basic-mmio-gpio",
683 .id_table
= bgpio_id_table
,
684 .probe
= bgpio_pdev_probe
,
685 .remove
= bgpio_pdev_remove
,
688 module_platform_driver(bgpio_driver
);
690 #endif /* CONFIG_GPIO_GENERIC_PLATFORM */
692 MODULE_DESCRIPTION("Driver for basic memory-mapped GPIO controllers");
693 MODULE_AUTHOR("Anton Vorontsov <cbouatmailru@gmail.com>");
694 MODULE_LICENSE("GPL");