blob: 6ec144baeb11f1d124586b53ba353db7da7adab9 [file] [log] [blame]
Anton Vorontsovaeec56e2010-10-27 15:33:15 -07001/*
Grant Likelyc103de22011-06-04 18:38:28 -06002 * Generic driver for memory-mapped GPIO controllers.
Anton Vorontsovaeec56e2010-10-27 15:33:15 -07003 *
4 * Copyright 2008 MontaVista Software, Inc.
5 * Copyright 2008,2010 Anton Vorontsov <cbouatmailru@gmail.com>
6 *
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.
11 *
12 * ....``.```~~~~````.`.`.`.`.```````'',,,.........`````......`.......
13 * ...`` ```````..
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. ,,..``~~~~ .....``.`.`.~~.```.`.........``````.```````
17 * `````````
18 ___
19_/~~|___/~| . ```~~~~~~ ___/___\___ ,~.`.`.`.`````.~~...,,,,...
20__________|~$@~~~ %~ /o*o*o*o*o*o\ .. Implementing such a GPIO .
21o ` ~~~~\___/~~~~ ` controller in FPGA is ,.`
22 `....trivial..'~`.```.```
23 * ```````
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 * ^^ `````.`````````.,``~``~``~~``````
31 * . ^^
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_
37 * |
38 * ^^ / \
39 *
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. ,............```.`.`..`.`.~~~.`.`.`~
44 * `.......````.```
45 */
46
47#include <linux/init.h>
Jamie Iles280df6b2011-05-20 00:40:19 -060048#include <linux/err.h>
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070049#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>
58#include <linux/io.h>
Linus Walleij0f4630f2015-12-04 14:02:58 +010059#include <linux/gpio/driver.h>
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070060#include <linux/slab.h>
Linus Walleij4b637392016-01-05 11:13:28 +010061#include <linux/bitops.h>
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070062#include <linux/platform_device.h>
63#include <linux/mod_devicetable.h>
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +020064#include <linux/of.h>
65#include <linux/of_device.h>
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070066
Jamie Iles8467afe2011-05-20 00:40:14 -060067static void bgpio_write8(void __iomem *reg, unsigned long data)
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070068{
Jamie Ilesfd996232011-05-20 00:40:17 -060069 writeb(data, reg);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070070}
71
Jamie Iles8467afe2011-05-20 00:40:14 -060072static unsigned long bgpio_read8(void __iomem *reg)
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070073{
Jamie Ilesfd996232011-05-20 00:40:17 -060074 return readb(reg);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -070075}
76
Jamie Iles8467afe2011-05-20 00:40:14 -060077static void bgpio_write16(void __iomem *reg, unsigned long data)
78{
Jamie Ilesfd996232011-05-20 00:40:17 -060079 writew(data, reg);
Jamie Iles8467afe2011-05-20 00:40:14 -060080}
81
82static unsigned long bgpio_read16(void __iomem *reg)
83{
Jamie Ilesfd996232011-05-20 00:40:17 -060084 return readw(reg);
Jamie Iles8467afe2011-05-20 00:40:14 -060085}
86
87static void bgpio_write32(void __iomem *reg, unsigned long data)
88{
Jamie Ilesfd996232011-05-20 00:40:17 -060089 writel(data, reg);
Jamie Iles8467afe2011-05-20 00:40:14 -060090}
91
92static unsigned long bgpio_read32(void __iomem *reg)
93{
Jamie Ilesfd996232011-05-20 00:40:17 -060094 return readl(reg);
Jamie Iles8467afe2011-05-20 00:40:14 -060095}
96
97#if BITS_PER_LONG >= 64
98static void bgpio_write64(void __iomem *reg, unsigned long data)
99{
Jamie Ilesfd996232011-05-20 00:40:17 -0600100 writeq(data, reg);
Jamie Iles8467afe2011-05-20 00:40:14 -0600101}
102
103static unsigned long bgpio_read64(void __iomem *reg)
104{
Jamie Ilesfd996232011-05-20 00:40:17 -0600105 return readq(reg);
Jamie Iles8467afe2011-05-20 00:40:14 -0600106}
107#endif /* BITS_PER_LONG >= 64 */
108
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100109static void bgpio_write16be(void __iomem *reg, unsigned long data)
110{
111 iowrite16be(data, reg);
112}
113
114static unsigned long bgpio_read16be(void __iomem *reg)
115{
116 return ioread16be(reg);
117}
118
119static void bgpio_write32be(void __iomem *reg, unsigned long data)
120{
121 iowrite32be(data, reg);
122}
123
124static unsigned long bgpio_read32be(void __iomem *reg)
125{
126 return ioread32be(reg);
127}
128
Linus Walleij0f4630f2015-12-04 14:02:58 +0100129static unsigned long bgpio_pin2mask(struct gpio_chip *gc, unsigned int pin)
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700130{
Linus Walleij4b637392016-01-05 11:13:28 +0100131 return BIT(pin);
Jamie Iles8467afe2011-05-20 00:40:14 -0600132}
133
Linus Walleij0f4630f2015-12-04 14:02:58 +0100134static unsigned long bgpio_pin2mask_be(struct gpio_chip *gc,
Jamie Iles8467afe2011-05-20 00:40:14 -0600135 unsigned int pin)
136{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100137 return BIT(gc->bgpio_bits - 1 - pin);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700138}
139
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300140static int bgpio_get_set(struct gpio_chip *gc, unsigned int gpio)
141{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100142 unsigned long pinmask = gc->pin2mask(gc, gpio);
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300143
Linus Walleij0f4630f2015-12-04 14:02:58 +0100144 if (gc->bgpio_dir & pinmask)
145 return !!(gc->read_reg(gc->reg_set) & pinmask);
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300146 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100147 return !!(gc->read_reg(gc->reg_dat) & pinmask);
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300148}
149
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700150static int bgpio_get(struct gpio_chip *gc, unsigned int gpio)
151{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100152 return !!(gc->read_reg(gc->reg_dat) & gc->pin2mask(gc, gpio));
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700153}
154
Rabin Vincent91492a42015-07-22 15:05:18 +0200155static void bgpio_set_none(struct gpio_chip *gc, unsigned int gpio, int val)
156{
157}
158
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700159static void bgpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
160{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100161 unsigned long mask = gc->pin2mask(gc, gpio);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700162 unsigned long flags;
163
Linus Walleij0f4630f2015-12-04 14:02:58 +0100164 spin_lock_irqsave(&gc->bgpio_lock, flags);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700165
166 if (val)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100167 gc->bgpio_data |= mask;
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700168 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100169 gc->bgpio_data &= ~mask;
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700170
Linus Walleij0f4630f2015-12-04 14:02:58 +0100171 gc->write_reg(gc->reg_dat, gc->bgpio_data);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700172
Linus Walleij0f4630f2015-12-04 14:02:58 +0100173 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700174}
175
Jamie Ilese027d6f2011-05-20 00:40:16 -0600176static void bgpio_set_with_clear(struct gpio_chip *gc, unsigned int gpio,
177 int val)
178{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100179 unsigned long mask = gc->pin2mask(gc, gpio);
Jamie Ilese027d6f2011-05-20 00:40:16 -0600180
181 if (val)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100182 gc->write_reg(gc->reg_set, mask);
Jamie Ilese027d6f2011-05-20 00:40:16 -0600183 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100184 gc->write_reg(gc->reg_clr, mask);
Jamie Ilese027d6f2011-05-20 00:40:16 -0600185}
186
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600187static void bgpio_set_set(struct gpio_chip *gc, unsigned int gpio, int val)
188{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100189 unsigned long mask = gc->pin2mask(gc, gpio);
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600190 unsigned long flags;
191
Linus Walleij0f4630f2015-12-04 14:02:58 +0100192 spin_lock_irqsave(&gc->bgpio_lock, flags);
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600193
194 if (val)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100195 gc->bgpio_data |= mask;
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600196 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100197 gc->bgpio_data &= ~mask;
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600198
Linus Walleij0f4630f2015-12-04 14:02:58 +0100199 gc->write_reg(gc->reg_set, gc->bgpio_data);
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600200
Linus Walleij0f4630f2015-12-04 14:02:58 +0100201 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600202}
203
Linus Walleij0f4630f2015-12-04 14:02:58 +0100204static void bgpio_multiple_get_masks(struct gpio_chip *gc,
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100205 unsigned long *mask, unsigned long *bits,
206 unsigned long *set_mask,
207 unsigned long *clear_mask)
208{
209 int i;
210
211 *set_mask = 0;
212 *clear_mask = 0;
213
Linus Walleij0f4630f2015-12-04 14:02:58 +0100214 for (i = 0; i < gc->bgpio_bits; i++) {
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100215 if (*mask == 0)
216 break;
217 if (__test_and_clear_bit(i, mask)) {
218 if (test_bit(i, bits))
Linus Walleij0f4630f2015-12-04 14:02:58 +0100219 *set_mask |= gc->pin2mask(gc, i);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100220 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100221 *clear_mask |= gc->pin2mask(gc, i);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100222 }
223 }
224}
225
Linus Walleij0f4630f2015-12-04 14:02:58 +0100226static void bgpio_set_multiple_single_reg(struct gpio_chip *gc,
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100227 unsigned long *mask,
228 unsigned long *bits,
229 void __iomem *reg)
230{
231 unsigned long flags;
232 unsigned long set_mask, clear_mask;
233
Linus Walleij0f4630f2015-12-04 14:02:58 +0100234 spin_lock_irqsave(&gc->bgpio_lock, flags);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100235
Linus Walleij0f4630f2015-12-04 14:02:58 +0100236 bgpio_multiple_get_masks(gc, mask, bits, &set_mask, &clear_mask);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100237
Linus Walleij0f4630f2015-12-04 14:02:58 +0100238 gc->bgpio_data |= set_mask;
239 gc->bgpio_data &= ~clear_mask;
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100240
Linus Walleij0f4630f2015-12-04 14:02:58 +0100241 gc->write_reg(reg, gc->bgpio_data);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100242
Linus Walleij0f4630f2015-12-04 14:02:58 +0100243 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100244}
245
246static void bgpio_set_multiple(struct gpio_chip *gc, unsigned long *mask,
247 unsigned long *bits)
248{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100249 bgpio_set_multiple_single_reg(gc, mask, bits, gc->reg_dat);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100250}
251
252static void bgpio_set_multiple_set(struct gpio_chip *gc, unsigned long *mask,
253 unsigned long *bits)
254{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100255 bgpio_set_multiple_single_reg(gc, mask, bits, gc->reg_set);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100256}
257
258static void bgpio_set_multiple_with_clear(struct gpio_chip *gc,
259 unsigned long *mask,
260 unsigned long *bits)
261{
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100262 unsigned long set_mask, clear_mask;
263
Linus Walleij0f4630f2015-12-04 14:02:58 +0100264 bgpio_multiple_get_masks(gc, mask, bits, &set_mask, &clear_mask);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100265
266 if (set_mask)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100267 gc->write_reg(gc->reg_set, set_mask);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100268 if (clear_mask)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100269 gc->write_reg(gc->reg_clr, clear_mask);
Rojhalat Ibrahim73c4ced2015-01-14 15:46:38 +0100270}
271
Jamie Iles31029112011-05-20 00:40:17 -0600272static int bgpio_simple_dir_in(struct gpio_chip *gc, unsigned int gpio)
273{
274 return 0;
275}
276
Rabin Vincent91492a42015-07-22 15:05:18 +0200277static int bgpio_dir_out_err(struct gpio_chip *gc, unsigned int gpio,
278 int val)
279{
280 return -EINVAL;
281}
282
Jamie Iles31029112011-05-20 00:40:17 -0600283static int bgpio_simple_dir_out(struct gpio_chip *gc, unsigned int gpio,
284 int val)
285{
286 gc->set(gc, gpio, val);
287
288 return 0;
289}
290
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700291static int bgpio_dir_in(struct gpio_chip *gc, unsigned int gpio)
292{
Jamie Iles31029112011-05-20 00:40:17 -0600293 unsigned long flags;
294
Linus Walleij0f4630f2015-12-04 14:02:58 +0100295 spin_lock_irqsave(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600296
Linus Walleij0f4630f2015-12-04 14:02:58 +0100297 gc->bgpio_dir &= ~gc->pin2mask(gc, gpio);
298 gc->write_reg(gc->reg_dir, gc->bgpio_dir);
Jamie Iles31029112011-05-20 00:40:17 -0600299
Linus Walleij0f4630f2015-12-04 14:02:58 +0100300 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600301
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700302 return 0;
303}
304
Philipp Zabeldb3b0fc2015-06-12 18:20:35 +0200305static int bgpio_get_dir(struct gpio_chip *gc, unsigned int gpio)
306{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100307 /* Return 0 if output, 1 of input */
308 return !(gc->read_reg(gc->reg_dir) & gc->pin2mask(gc, gpio));
Philipp Zabeldb3b0fc2015-06-12 18:20:35 +0200309}
310
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700311static int bgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val)
312{
Jamie Iles31029112011-05-20 00:40:17 -0600313 unsigned long flags;
314
Jamie Ilese027d6f2011-05-20 00:40:16 -0600315 gc->set(gc, gpio, val);
316
Linus Walleij0f4630f2015-12-04 14:02:58 +0100317 spin_lock_irqsave(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600318
Linus Walleij0f4630f2015-12-04 14:02:58 +0100319 gc->bgpio_dir |= gc->pin2mask(gc, gpio);
320 gc->write_reg(gc->reg_dir, gc->bgpio_dir);
Jamie Iles31029112011-05-20 00:40:17 -0600321
Linus Walleij0f4630f2015-12-04 14:02:58 +0100322 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600323
324 return 0;
325}
326
327static int bgpio_dir_in_inv(struct gpio_chip *gc, unsigned int gpio)
328{
Jamie Iles31029112011-05-20 00:40:17 -0600329 unsigned long flags;
330
Linus Walleij0f4630f2015-12-04 14:02:58 +0100331 spin_lock_irqsave(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600332
Linus Walleij0f4630f2015-12-04 14:02:58 +0100333 gc->bgpio_dir |= gc->pin2mask(gc, gpio);
334 gc->write_reg(gc->reg_dir, gc->bgpio_dir);
Jamie Iles31029112011-05-20 00:40:17 -0600335
Linus Walleij0f4630f2015-12-04 14:02:58 +0100336 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600337
338 return 0;
339}
340
341static int bgpio_dir_out_inv(struct gpio_chip *gc, unsigned int gpio, int val)
342{
Jamie Iles31029112011-05-20 00:40:17 -0600343 unsigned long flags;
344
345 gc->set(gc, gpio, val);
346
Linus Walleij0f4630f2015-12-04 14:02:58 +0100347 spin_lock_irqsave(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600348
Linus Walleij0f4630f2015-12-04 14:02:58 +0100349 gc->bgpio_dir &= ~gc->pin2mask(gc, gpio);
350 gc->write_reg(gc->reg_dir, gc->bgpio_dir);
Jamie Iles31029112011-05-20 00:40:17 -0600351
Linus Walleij0f4630f2015-12-04 14:02:58 +0100352 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600353
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700354 return 0;
355}
356
Philipp Zabeldb3b0fc2015-06-12 18:20:35 +0200357static int bgpio_get_dir_inv(struct gpio_chip *gc, unsigned int gpio)
358{
Linus Walleij0f4630f2015-12-04 14:02:58 +0100359 /* Return 0 if output, 1 if input */
360 return !!(gc->read_reg(gc->reg_dir) & gc->pin2mask(gc, gpio));
Philipp Zabeldb3b0fc2015-06-12 18:20:35 +0200361}
362
Jamie Iles280df6b2011-05-20 00:40:19 -0600363static int bgpio_setup_accessors(struct device *dev,
Linus Walleij0f4630f2015-12-04 14:02:58 +0100364 struct gpio_chip *gc,
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100365 bool bit_be,
366 bool byte_be)
Jamie Iles364b5e82011-05-20 00:40:16 -0600367{
Jamie Iles8467afe2011-05-20 00:40:14 -0600368
Linus Walleij0f4630f2015-12-04 14:02:58 +0100369 switch (gc->bgpio_bits) {
Jamie Iles8467afe2011-05-20 00:40:14 -0600370 case 8:
Linus Walleij0f4630f2015-12-04 14:02:58 +0100371 gc->read_reg = bgpio_read8;
372 gc->write_reg = bgpio_write8;
Jamie Iles8467afe2011-05-20 00:40:14 -0600373 break;
374 case 16:
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100375 if (byte_be) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100376 gc->read_reg = bgpio_read16be;
377 gc->write_reg = bgpio_write16be;
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100378 } else {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100379 gc->read_reg = bgpio_read16;
380 gc->write_reg = bgpio_write16;
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100381 }
Jamie Iles8467afe2011-05-20 00:40:14 -0600382 break;
383 case 32:
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100384 if (byte_be) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100385 gc->read_reg = bgpio_read32be;
386 gc->write_reg = bgpio_write32be;
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100387 } else {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100388 gc->read_reg = bgpio_read32;
389 gc->write_reg = bgpio_write32;
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100390 }
Jamie Iles8467afe2011-05-20 00:40:14 -0600391 break;
392#if BITS_PER_LONG >= 64
393 case 64:
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100394 if (byte_be) {
395 dev_err(dev,
396 "64 bit big endian byte order unsupported\n");
397 return -EINVAL;
398 } else {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100399 gc->read_reg = bgpio_read64;
400 gc->write_reg = bgpio_write64;
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100401 }
Jamie Iles8467afe2011-05-20 00:40:14 -0600402 break;
403#endif /* BITS_PER_LONG >= 64 */
404 default:
Linus Walleij0f4630f2015-12-04 14:02:58 +0100405 dev_err(dev, "unsupported data width %u bits\n", gc->bgpio_bits);
Jamie Iles8467afe2011-05-20 00:40:14 -0600406 return -EINVAL;
407 }
408
Linus Walleij0f4630f2015-12-04 14:02:58 +0100409 gc->pin2mask = bit_be ? bgpio_pin2mask_be : bgpio_pin2mask;
Jamie Iles8467afe2011-05-20 00:40:14 -0600410
411 return 0;
412}
413
Jamie Ilese027d6f2011-05-20 00:40:16 -0600414/*
415 * Create the device and allocate the resources. For setting GPIO's there are
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600416 * three supported configurations:
Jamie Ilese027d6f2011-05-20 00:40:16 -0600417 *
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600418 * - single input/output register resource (named "dat").
Jamie Ilese027d6f2011-05-20 00:40:16 -0600419 * - set/clear pair (named "set" and "clr").
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600420 * - single output register resource and single input resource ("set" and
421 * dat").
Jamie Ilese027d6f2011-05-20 00:40:16 -0600422 *
423 * For the single output register, this drives a 1 by setting a bit and a zero
424 * by clearing a bit. For the set clr pair, this drives a 1 by setting a bit
425 * in the set register and clears it by setting a bit in the clear register.
426 * The configuration is detected by which resources are present.
Jamie Iles31029112011-05-20 00:40:17 -0600427 *
428 * For setting the GPIO direction, there are three supported configurations:
429 *
430 * - simple bidirection GPIO that requires no configuration.
431 * - an output direction register (named "dirout") where a 1 bit
432 * indicates the GPIO is an output.
433 * - an input direction register (named "dirin") where a 1 bit indicates
434 * the GPIO is an input.
Jamie Ilese027d6f2011-05-20 00:40:16 -0600435 */
Linus Walleij0f4630f2015-12-04 14:02:58 +0100436static int bgpio_setup_io(struct gpio_chip *gc,
Jamie Iles280df6b2011-05-20 00:40:19 -0600437 void __iomem *dat,
438 void __iomem *set,
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300439 void __iomem *clr,
440 unsigned long flags)
Jamie Iles8467afe2011-05-20 00:40:14 -0600441{
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700442
Linus Walleij0f4630f2015-12-04 14:02:58 +0100443 gc->reg_dat = dat;
444 if (!gc->reg_dat)
Jamie Iles280df6b2011-05-20 00:40:19 -0600445 return -EINVAL;
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700446
Jamie Iles280df6b2011-05-20 00:40:19 -0600447 if (set && clr) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100448 gc->reg_set = set;
449 gc->reg_clr = clr;
450 gc->set = bgpio_set_with_clear;
451 gc->set_multiple = bgpio_set_multiple_with_clear;
Jamie Iles280df6b2011-05-20 00:40:19 -0600452 } else if (set && !clr) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100453 gc->reg_set = set;
454 gc->set = bgpio_set_set;
455 gc->set_multiple = bgpio_set_multiple_set;
Rabin Vincent91492a42015-07-22 15:05:18 +0200456 } else if (flags & BGPIOF_NO_OUTPUT) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100457 gc->set = bgpio_set_none;
458 gc->set_multiple = NULL;
Jamie Ilese027d6f2011-05-20 00:40:16 -0600459 } else {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100460 gc->set = bgpio_set;
461 gc->set_multiple = bgpio_set_multiple;
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700462 }
463
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300464 if (!(flags & BGPIOF_UNREADABLE_REG_SET) &&
465 (flags & BGPIOF_READ_OUTPUT_REG_SET))
Linus Walleij0f4630f2015-12-04 14:02:58 +0100466 gc->get = bgpio_get_set;
Vladimir Zapolskiyb19e7f52015-04-29 18:34:59 +0300467 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100468 gc->get = bgpio_get;
Jamie Ilesdd86a0c2011-05-20 00:40:16 -0600469
Jamie Ilese027d6f2011-05-20 00:40:16 -0600470 return 0;
471}
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700472
Linus Walleij0f4630f2015-12-04 14:02:58 +0100473static int bgpio_setup_direction(struct gpio_chip *gc,
Jamie Iles280df6b2011-05-20 00:40:19 -0600474 void __iomem *dirout,
Rabin Vincent91492a42015-07-22 15:05:18 +0200475 void __iomem *dirin,
476 unsigned long flags)
Jamie Iles31029112011-05-20 00:40:17 -0600477{
Jamie Iles280df6b2011-05-20 00:40:19 -0600478 if (dirout && dirin) {
Jamie Iles31029112011-05-20 00:40:17 -0600479 return -EINVAL;
Jamie Iles280df6b2011-05-20 00:40:19 -0600480 } else if (dirout) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100481 gc->reg_dir = dirout;
482 gc->direction_output = bgpio_dir_out;
483 gc->direction_input = bgpio_dir_in;
484 gc->get_direction = bgpio_get_dir;
Jamie Iles280df6b2011-05-20 00:40:19 -0600485 } else if (dirin) {
Linus Walleij0f4630f2015-12-04 14:02:58 +0100486 gc->reg_dir = dirin;
487 gc->direction_output = bgpio_dir_out_inv;
488 gc->direction_input = bgpio_dir_in_inv;
489 gc->get_direction = bgpio_get_dir_inv;
Jamie Iles31029112011-05-20 00:40:17 -0600490 } else {
Rabin Vincent91492a42015-07-22 15:05:18 +0200491 if (flags & BGPIOF_NO_OUTPUT)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100492 gc->direction_output = bgpio_dir_out_err;
Rabin Vincent91492a42015-07-22 15:05:18 +0200493 else
Linus Walleij0f4630f2015-12-04 14:02:58 +0100494 gc->direction_output = bgpio_simple_dir_out;
495 gc->direction_input = bgpio_simple_dir_in;
Jamie Iles31029112011-05-20 00:40:17 -0600496 }
497
498 return 0;
499}
500
Anthony Fee7b42e3d2014-05-19 18:49:14 +0100501static int bgpio_request(struct gpio_chip *chip, unsigned gpio_pin)
502{
503 if (gpio_pin < chip->ngpio)
504 return 0;
505
506 return -EINVAL;
507}
508
Linus Walleij0f4630f2015-12-04 14:02:58 +0100509int bgpio_init(struct gpio_chip *gc, struct device *dev,
Russell King4f5b0482011-09-14 16:22:29 -0700510 unsigned long sz, void __iomem *dat, void __iomem *set,
511 void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
Shawn Guo3e11f7b2012-05-19 21:34:58 +0800512 unsigned long flags)
Jamie Iles280df6b2011-05-20 00:40:19 -0600513{
Jamie Ilese027d6f2011-05-20 00:40:16 -0600514 int ret;
Jamie Ilese027d6f2011-05-20 00:40:16 -0600515
Jamie Iles280df6b2011-05-20 00:40:19 -0600516 if (!is_power_of_2(sz))
517 return -EINVAL;
Jamie Ilese027d6f2011-05-20 00:40:16 -0600518
Linus Walleij0f4630f2015-12-04 14:02:58 +0100519 gc->bgpio_bits = sz * 8;
520 if (gc->bgpio_bits > BITS_PER_LONG)
Jamie Iles280df6b2011-05-20 00:40:19 -0600521 return -EINVAL;
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700522
Linus Walleij0f4630f2015-12-04 14:02:58 +0100523 spin_lock_init(&gc->bgpio_lock);
524 gc->parent = dev;
525 gc->label = dev_name(dev);
526 gc->base = -1;
527 gc->ngpio = gc->bgpio_bits;
528 gc->request = bgpio_request;
Jamie Iles280df6b2011-05-20 00:40:19 -0600529
Linus Walleij0f4630f2015-12-04 14:02:58 +0100530 ret = bgpio_setup_io(gc, dat, set, clr, flags);
Jamie Iles280df6b2011-05-20 00:40:19 -0600531 if (ret)
532 return ret;
533
Linus Walleij0f4630f2015-12-04 14:02:58 +0100534 ret = bgpio_setup_accessors(dev, gc, flags & BGPIOF_BIG_ENDIAN,
Andreas Larsson2b78f1e2013-03-15 14:45:38 +0100535 flags & BGPIOF_BIG_ENDIAN_BYTE_ORDER);
Jamie Iles280df6b2011-05-20 00:40:19 -0600536 if (ret)
537 return ret;
538
Linus Walleij0f4630f2015-12-04 14:02:58 +0100539 ret = bgpio_setup_direction(gc, dirout, dirin, flags);
Jamie Iles31029112011-05-20 00:40:17 -0600540 if (ret)
541 return ret;
542
Linus Walleij0f4630f2015-12-04 14:02:58 +0100543 gc->bgpio_data = gc->read_reg(gc->reg_dat);
544 if (gc->set == bgpio_set_set &&
Shawn Guo3e11f7b2012-05-19 21:34:58 +0800545 !(flags & BGPIOF_UNREADABLE_REG_SET))
Linus Walleij0f4630f2015-12-04 14:02:58 +0100546 gc->bgpio_data = gc->read_reg(gc->reg_set);
547 if (gc->reg_dir && !(flags & BGPIOF_UNREADABLE_REG_DIR))
548 gc->bgpio_dir = gc->read_reg(gc->reg_dir);
Jamie Iles924e7a92011-05-20 00:40:15 -0600549
Jamie Iles280df6b2011-05-20 00:40:19 -0600550 return ret;
551}
552EXPORT_SYMBOL_GPL(bgpio_init);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700553
Christian Lamparter8f01c9d2016-04-29 02:53:14 +0200554#if IS_ENABLED(CONFIG_GPIO_GENERIC_PLATFORM)
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700555
Jamie Iles280df6b2011-05-20 00:40:19 -0600556static void __iomem *bgpio_map(struct platform_device *pdev,
557 const char *name,
Heiner Kallweit8d240262015-09-30 23:52:36 +0200558 resource_size_t sane_sz)
Jamie Iles280df6b2011-05-20 00:40:19 -0600559{
Jamie Iles280df6b2011-05-20 00:40:19 -0600560 struct resource *r;
Jamie Iles280df6b2011-05-20 00:40:19 -0600561 resource_size_t sz;
Jamie Iles280df6b2011-05-20 00:40:19 -0600562
563 r = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
Heiner Kallweit8d240262015-09-30 23:52:36 +0200564 if (!r)
Guenter Roeckb2f68b62015-10-21 00:12:00 -0700565 return NULL;
Jamie Iles280df6b2011-05-20 00:40:19 -0600566
567 sz = resource_size(r);
Heiner Kallweit8d240262015-09-30 23:52:36 +0200568 if (sz != sane_sz)
569 return IOMEM_ERR_PTR(-EINVAL);
Jamie Iles280df6b2011-05-20 00:40:19 -0600570
Heiner Kallweit8d240262015-09-30 23:52:36 +0200571 return devm_ioremap_resource(&pdev->dev, r);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700572}
573
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +0200574#ifdef CONFIG_OF
575static const struct of_device_id bgpio_of_match[] = {
Christian Lamparterc0d30ec2016-05-13 23:07:12 +0200576 { .compatible = "wd,mbl-gpio" },
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +0200577 { }
578};
579MODULE_DEVICE_TABLE(of, bgpio_of_match);
580
581static struct bgpio_pdata *bgpio_parse_dt(struct platform_device *pdev,
582 unsigned long *flags)
583{
584 struct bgpio_pdata *pdata;
585
586 if (!of_match_device(bgpio_of_match, &pdev->dev))
587 return NULL;
588
589 pdata = devm_kzalloc(&pdev->dev, sizeof(struct bgpio_pdata),
590 GFP_KERNEL);
591 if (!pdata)
592 return ERR_PTR(-ENOMEM);
593
594 pdata->base = -1;
595
Christian Lamparterc0d30ec2016-05-13 23:07:12 +0200596 if (of_property_read_bool(pdev->dev.of_node, "no-output"))
597 *flags |= BGPIOF_NO_OUTPUT;
598
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +0200599 return pdata;
600}
601#else
602static struct bgpio_pdata *bgpio_parse_dt(struct platform_device *pdev,
603 unsigned long *flags)
604{
605 return NULL;
606}
607#endif /* CONFIG_OF */
608
Bill Pemberton38363092012-11-19 13:22:34 -0500609static int bgpio_pdev_probe(struct platform_device *pdev)
Jamie Iles280df6b2011-05-20 00:40:19 -0600610{
611 struct device *dev = &pdev->dev;
612 struct resource *r;
613 void __iomem *dat;
614 void __iomem *set;
615 void __iomem *clr;
616 void __iomem *dirout;
617 void __iomem *dirin;
618 unsigned long sz;
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +0200619 unsigned long flags = 0;
Jamie Iles280df6b2011-05-20 00:40:19 -0600620 int err;
Linus Walleij0f4630f2015-12-04 14:02:58 +0100621 struct gpio_chip *gc;
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +0200622 struct bgpio_pdata *pdata;
623
624 pdata = bgpio_parse_dt(pdev, &flags);
625 if (IS_ERR(pdata))
626 return PTR_ERR(pdata);
627
628 if (!pdata) {
629 pdata = dev_get_platdata(dev);
630 flags = pdev->id_entry->driver_data;
631 }
Jamie Iles280df6b2011-05-20 00:40:19 -0600632
633 r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dat");
634 if (!r)
635 return -EINVAL;
636
637 sz = resource_size(r);
638
Heiner Kallweit8d240262015-09-30 23:52:36 +0200639 dat = bgpio_map(pdev, "dat", sz);
640 if (IS_ERR(dat))
641 return PTR_ERR(dat);
Jamie Iles280df6b2011-05-20 00:40:19 -0600642
Heiner Kallweit8d240262015-09-30 23:52:36 +0200643 set = bgpio_map(pdev, "set", sz);
644 if (IS_ERR(set))
645 return PTR_ERR(set);
Jamie Iles280df6b2011-05-20 00:40:19 -0600646
Heiner Kallweit8d240262015-09-30 23:52:36 +0200647 clr = bgpio_map(pdev, "clr", sz);
648 if (IS_ERR(clr))
649 return PTR_ERR(clr);
Jamie Iles280df6b2011-05-20 00:40:19 -0600650
Heiner Kallweit8d240262015-09-30 23:52:36 +0200651 dirout = bgpio_map(pdev, "dirout", sz);
652 if (IS_ERR(dirout))
653 return PTR_ERR(dirout);
Jamie Iles280df6b2011-05-20 00:40:19 -0600654
Heiner Kallweit8d240262015-09-30 23:52:36 +0200655 dirin = bgpio_map(pdev, "dirin", sz);
656 if (IS_ERR(dirin))
657 return PTR_ERR(dirin);
Jamie Iles280df6b2011-05-20 00:40:19 -0600658
Linus Walleij0f4630f2015-12-04 14:02:58 +0100659 gc = devm_kzalloc(&pdev->dev, sizeof(*gc), GFP_KERNEL);
660 if (!gc)
Jamie Iles280df6b2011-05-20 00:40:19 -0600661 return -ENOMEM;
662
Linus Walleij0f4630f2015-12-04 14:02:58 +0100663 err = bgpio_init(gc, dev, sz, dat, set, clr, dirout, dirin, flags);
Jamie Iles280df6b2011-05-20 00:40:19 -0600664 if (err)
665 return err;
666
667 if (pdata) {
Pawel Moll781f6d72014-01-30 13:18:57 +0000668 if (pdata->label)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100669 gc->label = pdata->label;
670 gc->base = pdata->base;
Jamie Iles280df6b2011-05-20 00:40:19 -0600671 if (pdata->ngpio > 0)
Linus Walleij0f4630f2015-12-04 14:02:58 +0100672 gc->ngpio = pdata->ngpio;
Jamie Iles280df6b2011-05-20 00:40:19 -0600673 }
674
Linus Walleij0f4630f2015-12-04 14:02:58 +0100675 platform_set_drvdata(pdev, gc);
Jamie Iles280df6b2011-05-20 00:40:19 -0600676
Laxman Dewanganc05f8132016-02-22 17:43:28 +0530677 return devm_gpiochip_add_data(&pdev->dev, gc, NULL);
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700678}
679
680static const struct platform_device_id bgpio_id_table[] = {
Alexander Shiyan19338532014-03-16 09:10:34 +0400681 {
682 .name = "basic-mmio-gpio",
683 .driver_data = 0,
684 }, {
685 .name = "basic-mmio-gpio-be",
686 .driver_data = BGPIOF_BIG_ENDIAN,
687 },
688 { }
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700689};
690MODULE_DEVICE_TABLE(platform, bgpio_id_table);
691
692static struct platform_driver bgpio_driver = {
693 .driver = {
694 .name = "basic-mmio-gpio",
Álvaro Fernández Rojase6986132016-05-13 23:07:11 +0200695 .of_match_table = of_match_ptr(bgpio_of_match),
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700696 },
697 .id_table = bgpio_id_table,
Jamie Iles280df6b2011-05-20 00:40:19 -0600698 .probe = bgpio_pdev_probe,
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700699};
700
Mark Brown6f614152011-12-08 00:24:00 +0800701module_platform_driver(bgpio_driver);
Jamie Iles280df6b2011-05-20 00:40:19 -0600702
Grant Likelyc103de22011-06-04 18:38:28 -0600703#endif /* CONFIG_GPIO_GENERIC_PLATFORM */
Anton Vorontsovaeec56e2010-10-27 15:33:15 -0700704
705MODULE_DESCRIPTION("Driver for basic memory-mapped GPIO controllers");
706MODULE_AUTHOR("Anton Vorontsov <cbouatmailru@gmail.com>");
707MODULE_LICENSE("GPL");