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 unsigned long bgpio_pin2mask(struct bgpio_chip *bgc, unsigned int pin)
112
static unsigned long bgpio_pin2mask_be(struct bgpio_chip *bgc,
115
return 1 << (bgc->bits - 1 - pin);
118
static int bgpio_get(struct gpio_chip *gc, unsigned int gpio)
120
struct bgpio_chip *bgc = to_bgpio_chip(gc);
122
return bgc->read_reg(bgc->reg_dat) & bgc->pin2mask(bgc, gpio);
125
static void bgpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
127
struct bgpio_chip *bgc = to_bgpio_chip(gc);
128
unsigned long mask = bgc->pin2mask(bgc, gpio);
131
spin_lock_irqsave(&bgc->lock, flags);
138
bgc->write_reg(bgc->reg_dat, bgc->data);
140
spin_unlock_irqrestore(&bgc->lock, flags);
143
static void bgpio_set_with_clear(struct gpio_chip *gc, unsigned int gpio,
146
struct bgpio_chip *bgc = to_bgpio_chip(gc);
147
unsigned long mask = bgc->pin2mask(bgc, gpio);
150
bgc->write_reg(bgc->reg_set, mask);
152
bgc->write_reg(bgc->reg_clr, mask);
155
static void bgpio_set_set(struct gpio_chip *gc, unsigned int gpio, int val)
157
struct bgpio_chip *bgc = to_bgpio_chip(gc);
158
unsigned long mask = bgc->pin2mask(bgc, gpio);
161
spin_lock_irqsave(&bgc->lock, flags);
168
bgc->write_reg(bgc->reg_set, bgc->data);
170
spin_unlock_irqrestore(&bgc->lock, flags);
173
static int bgpio_simple_dir_in(struct gpio_chip *gc, unsigned int gpio)
178
static int bgpio_simple_dir_out(struct gpio_chip *gc, unsigned int gpio,
181
gc->set(gc, gpio, val);
186
static int bgpio_dir_in(struct gpio_chip *gc, unsigned int gpio)
188
struct bgpio_chip *bgc = to_bgpio_chip(gc);
191
spin_lock_irqsave(&bgc->lock, flags);
193
bgc->dir &= ~bgc->pin2mask(bgc, gpio);
194
bgc->write_reg(bgc->reg_dir, bgc->dir);
196
spin_unlock_irqrestore(&bgc->lock, flags);
201
static int bgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val)
203
struct bgpio_chip *bgc = to_bgpio_chip(gc);
206
gc->set(gc, gpio, val);
208
spin_lock_irqsave(&bgc->lock, flags);
210
bgc->dir |= bgc->pin2mask(bgc, gpio);
211
bgc->write_reg(bgc->reg_dir, bgc->dir);
213
spin_unlock_irqrestore(&bgc->lock, flags);
218
static int bgpio_dir_in_inv(struct gpio_chip *gc, unsigned int gpio)
220
struct bgpio_chip *bgc = to_bgpio_chip(gc);
223
spin_lock_irqsave(&bgc->lock, flags);
225
bgc->dir |= bgc->pin2mask(bgc, gpio);
226
bgc->write_reg(bgc->reg_dir, bgc->dir);
228
spin_unlock_irqrestore(&bgc->lock, flags);
233
static int bgpio_dir_out_inv(struct gpio_chip *gc, unsigned int gpio, int val)
235
struct bgpio_chip *bgc = to_bgpio_chip(gc);
238
gc->set(gc, gpio, val);
240
spin_lock_irqsave(&bgc->lock, flags);
242
bgc->dir &= ~bgc->pin2mask(bgc, gpio);
243
bgc->write_reg(bgc->reg_dir, bgc->dir);
245
spin_unlock_irqrestore(&bgc->lock, flags);
250
static int bgpio_setup_accessors(struct device *dev,
251
struct bgpio_chip *bgc,
257
bgc->read_reg = bgpio_read8;
258
bgc->write_reg = bgpio_write8;
261
bgc->read_reg = bgpio_read16;
262
bgc->write_reg = bgpio_write16;
265
bgc->read_reg = bgpio_read32;
266
bgc->write_reg = bgpio_write32;
268
#if BITS_PER_LONG >= 64
270
bgc->read_reg = bgpio_read64;
271
bgc->write_reg = bgpio_write64;
273
#endif /* BITS_PER_LONG >= 64 */
275
dev_err(dev, "unsupported data width %u bits\n", bgc->bits);
279
bgc->pin2mask = be ? bgpio_pin2mask_be : bgpio_pin2mask;
285
* Create the device and allocate the resources. For setting GPIO's there are
286
* three supported configurations:
288
* - single input/output register resource (named "dat").
289
* - set/clear pair (named "set" and "clr").
290
* - single output register resource and single input resource ("set" and
293
* For the single output register, this drives a 1 by setting a bit and a zero
294
* by clearing a bit. For the set clr pair, this drives a 1 by setting a bit
295
* in the set register and clears it by setting a bit in the clear register.
296
* The configuration is detected by which resources are present.
298
* For setting the GPIO direction, there are three supported configurations:
300
* - simple bidirection GPIO that requires no configuration.
301
* - an output direction register (named "dirout") where a 1 bit
302
* indicates the GPIO is an output.
303
* - an input direction register (named "dirin") where a 1 bit indicates
304
* the GPIO is an input.
306
static int bgpio_setup_io(struct bgpio_chip *bgc,
319
bgc->gc.set = bgpio_set_with_clear;
320
} else if (set && !clr) {
322
bgc->gc.set = bgpio_set_set;
324
bgc->gc.set = bgpio_set;
327
bgc->gc.get = bgpio_get;
332
static int bgpio_setup_direction(struct bgpio_chip *bgc,
333
void __iomem *dirout,
336
if (dirout && dirin) {
339
bgc->reg_dir = dirout;
340
bgc->gc.direction_output = bgpio_dir_out;
341
bgc->gc.direction_input = bgpio_dir_in;
343
bgc->reg_dir = dirin;
344
bgc->gc.direction_output = bgpio_dir_out_inv;
345
bgc->gc.direction_input = bgpio_dir_in_inv;
347
bgc->gc.direction_output = bgpio_simple_dir_out;
348
bgc->gc.direction_input = bgpio_simple_dir_in;
354
int bgpio_remove(struct bgpio_chip *bgc)
356
int err = gpiochip_remove(&bgc->gc);
362
EXPORT_SYMBOL_GPL(bgpio_remove);
364
int bgpio_init(struct bgpio_chip *bgc, struct device *dev,
365
unsigned long sz, void __iomem *dat, void __iomem *set,
366
void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
371
if (!is_power_of_2(sz))
375
if (bgc->bits > BITS_PER_LONG)
378
spin_lock_init(&bgc->lock);
380
bgc->gc.label = dev_name(dev);
382
bgc->gc.ngpio = bgc->bits;
384
ret = bgpio_setup_io(bgc, dat, set, clr);
388
ret = bgpio_setup_accessors(dev, bgc, big_endian);
392
ret = bgpio_setup_direction(bgc, dirout, dirin);
396
bgc->data = bgc->read_reg(bgc->reg_dat);
400
EXPORT_SYMBOL_GPL(bgpio_init);
402
#ifdef CONFIG_GPIO_GENERIC_PLATFORM
404
static void __iomem *bgpio_map(struct platform_device *pdev,
406
resource_size_t sane_sz,
409
struct device *dev = &pdev->dev;
411
resource_size_t start;
417
r = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
421
sz = resource_size(r);
428
if (!devm_request_mem_region(dev, start, sz, r->name)) {
433
ret = devm_ioremap(dev, start, sz);
442
static int __devinit bgpio_pdev_probe(struct platform_device *pdev)
444
struct device *dev = &pdev->dev;
449
void __iomem *dirout;
454
struct bgpio_chip *bgc;
455
struct bgpio_pdata *pdata = dev_get_platdata(dev);
457
r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dat");
461
sz = resource_size(r);
463
dat = bgpio_map(pdev, "dat", sz, &err);
465
return err ? err : -EINVAL;
467
set = bgpio_map(pdev, "set", sz, &err);
471
clr = bgpio_map(pdev, "clr", sz, &err);
475
dirout = bgpio_map(pdev, "dirout", sz, &err);
479
dirin = bgpio_map(pdev, "dirin", sz, &err);
483
be = !strcmp(platform_get_device_id(pdev)->name, "basic-mmio-gpio-be");
485
bgc = devm_kzalloc(&pdev->dev, sizeof(*bgc), GFP_KERNEL);
489
err = bgpio_init(bgc, dev, sz, dat, set, clr, dirout, dirin, be);
494
bgc->gc.base = pdata->base;
495
if (pdata->ngpio > 0)
496
bgc->gc.ngpio = pdata->ngpio;
499
platform_set_drvdata(pdev, bgc);
501
return gpiochip_add(&bgc->gc);
504
static int __devexit bgpio_pdev_remove(struct platform_device *pdev)
506
struct bgpio_chip *bgc = platform_get_drvdata(pdev);
508
return bgpio_remove(bgc);
511
static const struct platform_device_id bgpio_id_table[] = {
512
{ "basic-mmio-gpio", },
513
{ "basic-mmio-gpio-be", },
516
MODULE_DEVICE_TABLE(platform, bgpio_id_table);
518
static struct platform_driver bgpio_driver = {
520
.name = "basic-mmio-gpio",
522
.id_table = bgpio_id_table,
523
.probe = bgpio_pdev_probe,
524
.remove = __devexit_p(bgpio_pdev_remove),
527
static int __init bgpio_platform_init(void)
529
return platform_driver_register(&bgpio_driver);
531
module_init(bgpio_platform_init);
533
static void __exit bgpio_platform_exit(void)
535
platform_driver_unregister(&bgpio_driver);
537
module_exit(bgpio_platform_exit);
539
#endif /* CONFIG_GPIO_GENERIC_PLATFORM */
541
MODULE_DESCRIPTION("Driver for basic memory-mapped GPIO controllers");
542
MODULE_AUTHOR("Anton Vorontsov <cbouatmailru@gmail.com>");
543
MODULE_LICENSE("GPL");