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/driver.h>
60 #include <linux/slab.h>
61 #include <linux/bitops.h>
62 #include <linux/platform_device.h>
63 #include <linux/mod_devicetable.h>
65 #include <linux/of_device.h>
67 static void bgpio_write8(void __iomem
*reg
, unsigned long data
)
72 static unsigned long bgpio_read8(void __iomem
*reg
)
77 static void bgpio_write16(void __iomem
*reg
, unsigned long data
)
82 static unsigned long bgpio_read16(void __iomem
*reg
)
87 static void bgpio_write32(void __iomem
*reg
, unsigned long data
)
92 static unsigned long bgpio_read32(void __iomem
*reg
)
97 #if BITS_PER_LONG >= 64
98 static void bgpio_write64(void __iomem
*reg
, unsigned long data
)
103 static unsigned long bgpio_read64(void __iomem
*reg
)
107 #endif /* BITS_PER_LONG >= 64 */
109 static void bgpio_write16be(void __iomem
*reg
, unsigned long data
)
111 iowrite16be(data
, reg
);
114 static unsigned long bgpio_read16be(void __iomem
*reg
)
116 return ioread16be(reg
);
119 static void bgpio_write32be(void __iomem
*reg
, unsigned long data
)
121 iowrite32be(data
, reg
);
124 static unsigned long bgpio_read32be(void __iomem
*reg
)
126 return ioread32be(reg
);
129 static unsigned long bgpio_line2mask(struct gpio_chip
*gc
, unsigned int line
)
132 return BIT(gc
->bgpio_bits
- 1 - line
);
136 static int bgpio_get_set(struct gpio_chip
*gc
, unsigned int gpio
)
138 unsigned long pinmask
= bgpio_line2mask(gc
, gpio
);
140 if (gc
->bgpio_dir
& pinmask
)
141 return !!(gc
->read_reg(gc
->reg_set
) & pinmask
);
143 return !!(gc
->read_reg(gc
->reg_dat
) & pinmask
);
147 * This assumes that the bits in the GPIO register are in native endianness.
148 * We only assign the function pointer if we have that.
150 static int bgpio_get_set_multiple(struct gpio_chip
*gc
, unsigned long *mask
,
153 unsigned long get_mask
= 0;
154 unsigned long set_mask
= 0;
157 while ((bit
= find_next_bit(mask
, gc
->ngpio
, bit
)) != gc
->ngpio
) {
158 if (gc
->bgpio_dir
& BIT(bit
))
159 set_mask
|= BIT(bit
);
161 get_mask
|= BIT(bit
);
165 *bits
|= gc
->read_reg(gc
->reg_set
) & set_mask
;
167 *bits
|= gc
->read_reg(gc
->reg_dat
) & get_mask
;
172 static int bgpio_get(struct gpio_chip
*gc
, unsigned int gpio
)
174 return !!(gc
->read_reg(gc
->reg_dat
) & bgpio_line2mask(gc
, gpio
));
178 * This only works if the bits in the GPIO register are in native endianness.
179 * It is dirt simple and fast in this case. (Also the most common case.)
181 static int bgpio_get_multiple(struct gpio_chip
*gc
, unsigned long *mask
,
185 *bits
= gc
->read_reg(gc
->reg_dat
) & *mask
;
190 * With big endian mirrored bit order it becomes more tedious.
192 static int bgpio_get_multiple_be(struct gpio_chip
*gc
, unsigned long *mask
,
195 unsigned long readmask
= 0;
199 /* Create a mirrored mask */
201 while ((bit
= find_next_bit(mask
, gc
->ngpio
, bit
)) != gc
->ngpio
)
202 readmask
|= bgpio_line2mask(gc
, bit
);
204 /* Read the register */
205 val
= gc
->read_reg(gc
->reg_dat
) & readmask
;
208 * Mirror the result into the "bits" result, this will give line 0
209 * in bit 0 ... line 31 in bit 31 for a 32bit register.
212 while ((bit
= find_next_bit(&val
, gc
->ngpio
, bit
)) != gc
->ngpio
)
213 *bits
|= bgpio_line2mask(gc
, bit
);
218 static void bgpio_set_none(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
222 static void bgpio_set(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
224 unsigned long mask
= bgpio_line2mask(gc
, gpio
);
227 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
230 gc
->bgpio_data
|= mask
;
232 gc
->bgpio_data
&= ~mask
;
234 gc
->write_reg(gc
->reg_dat
, gc
->bgpio_data
);
236 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
239 static void bgpio_set_with_clear(struct gpio_chip
*gc
, unsigned int gpio
,
242 unsigned long mask
= bgpio_line2mask(gc
, gpio
);
245 gc
->write_reg(gc
->reg_set
, mask
);
247 gc
->write_reg(gc
->reg_clr
, mask
);
250 static void bgpio_set_set(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
252 unsigned long mask
= bgpio_line2mask(gc
, gpio
);
255 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
258 gc
->bgpio_data
|= mask
;
260 gc
->bgpio_data
&= ~mask
;
262 gc
->write_reg(gc
->reg_set
, gc
->bgpio_data
);
264 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
267 static void bgpio_multiple_get_masks(struct gpio_chip
*gc
,
268 unsigned long *mask
, unsigned long *bits
,
269 unsigned long *set_mask
,
270 unsigned long *clear_mask
)
277 for (i
= 0; i
< gc
->bgpio_bits
; i
++) {
280 if (__test_and_clear_bit(i
, mask
)) {
281 if (test_bit(i
, bits
))
282 *set_mask
|= bgpio_line2mask(gc
, i
);
284 *clear_mask
|= bgpio_line2mask(gc
, i
);
289 static void bgpio_set_multiple_single_reg(struct gpio_chip
*gc
,
295 unsigned long set_mask
, clear_mask
;
297 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
299 bgpio_multiple_get_masks(gc
, mask
, bits
, &set_mask
, &clear_mask
);
301 gc
->bgpio_data
|= set_mask
;
302 gc
->bgpio_data
&= ~clear_mask
;
304 gc
->write_reg(reg
, gc
->bgpio_data
);
306 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
309 static void bgpio_set_multiple(struct gpio_chip
*gc
, unsigned long *mask
,
312 bgpio_set_multiple_single_reg(gc
, mask
, bits
, gc
->reg_dat
);
315 static void bgpio_set_multiple_set(struct gpio_chip
*gc
, unsigned long *mask
,
318 bgpio_set_multiple_single_reg(gc
, mask
, bits
, gc
->reg_set
);
321 static void bgpio_set_multiple_with_clear(struct gpio_chip
*gc
,
325 unsigned long set_mask
, clear_mask
;
327 bgpio_multiple_get_masks(gc
, mask
, bits
, &set_mask
, &clear_mask
);
330 gc
->write_reg(gc
->reg_set
, set_mask
);
332 gc
->write_reg(gc
->reg_clr
, clear_mask
);
335 static int bgpio_simple_dir_in(struct gpio_chip
*gc
, unsigned int gpio
)
340 static int bgpio_dir_out_err(struct gpio_chip
*gc
, unsigned int gpio
,
346 static int bgpio_simple_dir_out(struct gpio_chip
*gc
, unsigned int gpio
,
349 gc
->set(gc
, gpio
, val
);
354 static int bgpio_dir_in(struct gpio_chip
*gc
, unsigned int gpio
)
358 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
360 gc
->bgpio_dir
&= ~bgpio_line2mask(gc
, gpio
);
361 gc
->write_reg(gc
->reg_dir
, gc
->bgpio_dir
);
363 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
368 static int bgpio_get_dir(struct gpio_chip
*gc
, unsigned int gpio
)
370 /* Return 0 if output, 1 of input */
371 return !(gc
->read_reg(gc
->reg_dir
) & bgpio_line2mask(gc
, gpio
));
374 static int bgpio_dir_out(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
378 gc
->set(gc
, gpio
, val
);
380 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
382 gc
->bgpio_dir
|= bgpio_line2mask(gc
, gpio
);
383 gc
->write_reg(gc
->reg_dir
, gc
->bgpio_dir
);
385 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
390 static int bgpio_dir_in_inv(struct gpio_chip
*gc
, unsigned int gpio
)
394 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
396 gc
->bgpio_dir
|= bgpio_line2mask(gc
, gpio
);
397 gc
->write_reg(gc
->reg_dir
, gc
->bgpio_dir
);
399 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
404 static int bgpio_dir_out_inv(struct gpio_chip
*gc
, unsigned int gpio
, int val
)
408 gc
->set(gc
, gpio
, val
);
410 spin_lock_irqsave(&gc
->bgpio_lock
, flags
);
412 gc
->bgpio_dir
&= ~bgpio_line2mask(gc
, gpio
);
413 gc
->write_reg(gc
->reg_dir
, gc
->bgpio_dir
);
415 spin_unlock_irqrestore(&gc
->bgpio_lock
, flags
);
420 static int bgpio_get_dir_inv(struct gpio_chip
*gc
, unsigned int gpio
)
422 /* Return 0 if output, 1 if input */
423 return !!(gc
->read_reg(gc
->reg_dir
) & bgpio_line2mask(gc
, gpio
));
426 static int bgpio_setup_accessors(struct device
*dev
,
427 struct gpio_chip
*gc
,
431 switch (gc
->bgpio_bits
) {
433 gc
->read_reg
= bgpio_read8
;
434 gc
->write_reg
= bgpio_write8
;
438 gc
->read_reg
= bgpio_read16be
;
439 gc
->write_reg
= bgpio_write16be
;
441 gc
->read_reg
= bgpio_read16
;
442 gc
->write_reg
= bgpio_write16
;
447 gc
->read_reg
= bgpio_read32be
;
448 gc
->write_reg
= bgpio_write32be
;
450 gc
->read_reg
= bgpio_read32
;
451 gc
->write_reg
= bgpio_write32
;
454 #if BITS_PER_LONG >= 64
458 "64 bit big endian byte order unsupported\n");
461 gc
->read_reg
= bgpio_read64
;
462 gc
->write_reg
= bgpio_write64
;
465 #endif /* BITS_PER_LONG >= 64 */
467 dev_err(dev
, "unsupported data width %u bits\n", gc
->bgpio_bits
);
475 * Create the device and allocate the resources. For setting GPIO's there are
476 * three supported configurations:
478 * - single input/output register resource (named "dat").
479 * - set/clear pair (named "set" and "clr").
480 * - single output register resource and single input resource ("set" and
483 * For the single output register, this drives a 1 by setting a bit and a zero
484 * by clearing a bit. For the set clr pair, this drives a 1 by setting a bit
485 * in the set register and clears it by setting a bit in the clear register.
486 * The configuration is detected by which resources are present.
488 * For setting the GPIO direction, there are three supported configurations:
490 * - simple bidirection GPIO that requires no configuration.
491 * - an output direction register (named "dirout") where a 1 bit
492 * indicates the GPIO is an output.
493 * - an input direction register (named "dirin") where a 1 bit indicates
494 * the GPIO is an input.
496 static int bgpio_setup_io(struct gpio_chip
*gc
,
510 gc
->set
= bgpio_set_with_clear
;
511 gc
->set_multiple
= bgpio_set_multiple_with_clear
;
512 } else if (set
&& !clr
) {
514 gc
->set
= bgpio_set_set
;
515 gc
->set_multiple
= bgpio_set_multiple_set
;
516 } else if (flags
& BGPIOF_NO_OUTPUT
) {
517 gc
->set
= bgpio_set_none
;
518 gc
->set_multiple
= NULL
;
521 gc
->set_multiple
= bgpio_set_multiple
;
524 if (!(flags
& BGPIOF_UNREADABLE_REG_SET
) &&
525 (flags
& BGPIOF_READ_OUTPUT_REG_SET
)) {
526 gc
->get
= bgpio_get_set
;
528 gc
->get_multiple
= bgpio_get_set_multiple
;
530 * We deliberately avoid assigning the ->get_multiple() call
531 * for big endian mirrored registers which are ALSO reflecting
532 * their value in the set register when used as output. It is
533 * simply too much complexity, let the GPIO core fall back to
534 * reading each line individually in that fringe case.
539 gc
->get_multiple
= bgpio_get_multiple_be
;
541 gc
->get_multiple
= bgpio_get_multiple
;
547 static int bgpio_setup_direction(struct gpio_chip
*gc
,
548 void __iomem
*dirout
,
552 if (dirout
&& dirin
) {
555 gc
->reg_dir
= dirout
;
556 gc
->direction_output
= bgpio_dir_out
;
557 gc
->direction_input
= bgpio_dir_in
;
558 gc
->get_direction
= bgpio_get_dir
;
561 gc
->direction_output
= bgpio_dir_out_inv
;
562 gc
->direction_input
= bgpio_dir_in_inv
;
563 gc
->get_direction
= bgpio_get_dir_inv
;
565 if (flags
& BGPIOF_NO_OUTPUT
)
566 gc
->direction_output
= bgpio_dir_out_err
;
568 gc
->direction_output
= bgpio_simple_dir_out
;
569 gc
->direction_input
= bgpio_simple_dir_in
;
575 static int bgpio_request(struct gpio_chip
*chip
, unsigned gpio_pin
)
577 if (gpio_pin
< chip
->ngpio
)
583 int bgpio_init(struct gpio_chip
*gc
, struct device
*dev
,
584 unsigned long sz
, void __iomem
*dat
, void __iomem
*set
,
585 void __iomem
*clr
, void __iomem
*dirout
, void __iomem
*dirin
,
590 if (!is_power_of_2(sz
))
593 gc
->bgpio_bits
= sz
* 8;
594 if (gc
->bgpio_bits
> BITS_PER_LONG
)
597 spin_lock_init(&gc
->bgpio_lock
);
599 gc
->label
= dev_name(dev
);
601 gc
->ngpio
= gc
->bgpio_bits
;
602 gc
->request
= bgpio_request
;
603 gc
->be_bits
= !!(flags
& BGPIOF_BIG_ENDIAN
);
605 ret
= bgpio_setup_io(gc
, dat
, set
, clr
, flags
);
609 ret
= bgpio_setup_accessors(dev
, gc
, flags
& BGPIOF_BIG_ENDIAN_BYTE_ORDER
);
613 ret
= bgpio_setup_direction(gc
, dirout
, dirin
, flags
);
617 gc
->bgpio_data
= gc
->read_reg(gc
->reg_dat
);
618 if (gc
->set
== bgpio_set_set
&&
619 !(flags
& BGPIOF_UNREADABLE_REG_SET
))
620 gc
->bgpio_data
= gc
->read_reg(gc
->reg_set
);
621 if (gc
->reg_dir
&& !(flags
& BGPIOF_UNREADABLE_REG_DIR
))
622 gc
->bgpio_dir
= gc
->read_reg(gc
->reg_dir
);
626 EXPORT_SYMBOL_GPL(bgpio_init
);
628 #if IS_ENABLED(CONFIG_GPIO_GENERIC_PLATFORM)
630 static void __iomem
*bgpio_map(struct platform_device
*pdev
,
632 resource_size_t sane_sz
)
637 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, name
);
641 sz
= resource_size(r
);
643 return IOMEM_ERR_PTR(-EINVAL
);
645 return devm_ioremap_resource(&pdev
->dev
, r
);
649 static const struct of_device_id bgpio_of_match
[] = {
650 { .compatible
= "brcm,bcm6345-gpio" },
651 { .compatible
= "wd,mbl-gpio" },
652 { .compatible
= "ni,169445-nand-gpio" },
655 MODULE_DEVICE_TABLE(of
, bgpio_of_match
);
657 static struct bgpio_pdata
*bgpio_parse_dt(struct platform_device
*pdev
,
658 unsigned long *flags
)
660 struct bgpio_pdata
*pdata
;
662 if (!of_match_device(bgpio_of_match
, &pdev
->dev
))
665 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(struct bgpio_pdata
),
668 return ERR_PTR(-ENOMEM
);
672 if (of_device_is_big_endian(pdev
->dev
.of_node
))
673 *flags
|= BGPIOF_BIG_ENDIAN_BYTE_ORDER
;
675 if (of_property_read_bool(pdev
->dev
.of_node
, "no-output"))
676 *flags
|= BGPIOF_NO_OUTPUT
;
681 static struct bgpio_pdata
*bgpio_parse_dt(struct platform_device
*pdev
,
682 unsigned long *flags
)
686 #endif /* CONFIG_OF */
688 static int bgpio_pdev_probe(struct platform_device
*pdev
)
690 struct device
*dev
= &pdev
->dev
;
695 void __iomem
*dirout
;
698 unsigned long flags
= 0;
700 struct gpio_chip
*gc
;
701 struct bgpio_pdata
*pdata
;
703 pdata
= bgpio_parse_dt(pdev
, &flags
);
705 return PTR_ERR(pdata
);
708 pdata
= dev_get_platdata(dev
);
709 flags
= pdev
->id_entry
->driver_data
;
712 r
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
, "dat");
716 sz
= resource_size(r
);
718 dat
= bgpio_map(pdev
, "dat", sz
);
722 set
= bgpio_map(pdev
, "set", sz
);
726 clr
= bgpio_map(pdev
, "clr", sz
);
730 dirout
= bgpio_map(pdev
, "dirout", sz
);
732 return PTR_ERR(dirout
);
734 dirin
= bgpio_map(pdev
, "dirin", sz
);
736 return PTR_ERR(dirin
);
738 gc
= devm_kzalloc(&pdev
->dev
, sizeof(*gc
), GFP_KERNEL
);
742 err
= bgpio_init(gc
, dev
, sz
, dat
, set
, clr
, dirout
, dirin
, flags
);
748 gc
->label
= pdata
->label
;
749 gc
->base
= pdata
->base
;
750 if (pdata
->ngpio
> 0)
751 gc
->ngpio
= pdata
->ngpio
;
754 platform_set_drvdata(pdev
, gc
);
756 return devm_gpiochip_add_data(&pdev
->dev
, gc
, NULL
);
759 static const struct platform_device_id bgpio_id_table
[] = {
761 .name
= "basic-mmio-gpio",
764 .name
= "basic-mmio-gpio-be",
765 .driver_data
= BGPIOF_BIG_ENDIAN
,
769 MODULE_DEVICE_TABLE(platform
, bgpio_id_table
);
771 static struct platform_driver bgpio_driver
= {
773 .name
= "basic-mmio-gpio",
774 .of_match_table
= of_match_ptr(bgpio_of_match
),
776 .id_table
= bgpio_id_table
,
777 .probe
= bgpio_pdev_probe
,
780 module_platform_driver(bgpio_driver
);
782 #endif /* CONFIG_GPIO_GENERIC_PLATFORM */
784 MODULE_DESCRIPTION("Driver for basic memory-mapped GPIO controllers");
785 MODULE_AUTHOR("Anton Vorontsov <cbouatmailru@gmail.com>");
786 MODULE_LICENSE("GPL");