]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/gpio/gpio-generic.c
802e6d2c64e9ea4b74ff2fdda5f0d2eb8924185f
[karo-tx-linux.git] / drivers / gpio / gpio-generic.c
1 /*
2  * Generic driver for memory-mapped GPIO controllers.
3  *
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 .
21 o        `                     ~~~~\___/~~~~    ` 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>
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>
58 #include <linux/io.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>
64
65 static void bgpio_write8(void __iomem *reg, unsigned long data)
66 {
67         writeb(data, reg);
68 }
69
70 static unsigned long bgpio_read8(void __iomem *reg)
71 {
72         return readb(reg);
73 }
74
75 static void bgpio_write16(void __iomem *reg, unsigned long data)
76 {
77         writew(data, reg);
78 }
79
80 static unsigned long bgpio_read16(void __iomem *reg)
81 {
82         return readw(reg);
83 }
84
85 static void bgpio_write32(void __iomem *reg, unsigned long data)
86 {
87         writel(data, reg);
88 }
89
90 static unsigned long bgpio_read32(void __iomem *reg)
91 {
92         return readl(reg);
93 }
94
95 #if BITS_PER_LONG >= 64
96 static void bgpio_write64(void __iomem *reg, unsigned long data)
97 {
98         writeq(data, reg);
99 }
100
101 static unsigned long bgpio_read64(void __iomem *reg)
102 {
103         return readq(reg);
104 }
105 #endif /* BITS_PER_LONG >= 64 */
106
107 static void bgpio_write16be(void __iomem *reg, unsigned long data)
108 {
109         iowrite16be(data, reg);
110 }
111
112 static unsigned long bgpio_read16be(void __iomem *reg)
113 {
114         return ioread16be(reg);
115 }
116
117 static void bgpio_write32be(void __iomem *reg, unsigned long data)
118 {
119         iowrite32be(data, reg);
120 }
121
122 static unsigned long bgpio_read32be(void __iomem *reg)
123 {
124         return ioread32be(reg);
125 }
126
127 static unsigned long bgpio_pin2mask(struct bgpio_chip *bgc, unsigned int pin)
128 {
129         return 1 << pin;
130 }
131
132 static unsigned long bgpio_pin2mask_be(struct bgpio_chip *bgc,
133                                        unsigned int pin)
134 {
135         return 1 << (bgc->bits - 1 - pin);
136 }
137
138 static int bgpio_get_set(struct gpio_chip *gc, unsigned int gpio)
139 {
140         struct bgpio_chip *bgc = to_bgpio_chip(gc);
141         unsigned long pinmask = bgc->pin2mask(bgc, gpio);
142
143         if (bgc->dir & pinmask)
144                 return bgc->read_reg(bgc->reg_set) & pinmask;
145         else
146                 return bgc->read_reg(bgc->reg_dat) & pinmask;
147 }
148
149 static int bgpio_get(struct gpio_chip *gc, unsigned int gpio)
150 {
151         struct bgpio_chip *bgc = to_bgpio_chip(gc);
152
153         return !!(bgc->read_reg(bgc->reg_dat) & bgc->pin2mask(bgc, gpio));
154 }
155
156 static void bgpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
157 {
158         struct bgpio_chip *bgc = to_bgpio_chip(gc);
159         unsigned long mask = bgc->pin2mask(bgc, gpio);
160         unsigned long flags;
161
162         spin_lock_irqsave(&bgc->lock, flags);
163
164         if (val)
165                 bgc->data |= mask;
166         else
167                 bgc->data &= ~mask;
168
169         bgc->write_reg(bgc->reg_dat, bgc->data);
170
171         spin_unlock_irqrestore(&bgc->lock, flags);
172 }
173
174 static void bgpio_set_with_clear(struct gpio_chip *gc, unsigned int gpio,
175                                  int val)
176 {
177         struct bgpio_chip *bgc = to_bgpio_chip(gc);
178         unsigned long mask = bgc->pin2mask(bgc, gpio);
179
180         if (val)
181                 bgc->write_reg(bgc->reg_set, mask);
182         else
183                 bgc->write_reg(bgc->reg_clr, mask);
184 }
185
186 static void bgpio_set_set(struct gpio_chip *gc, unsigned int gpio, int val)
187 {
188         struct bgpio_chip *bgc = to_bgpio_chip(gc);
189         unsigned long mask = bgc->pin2mask(bgc, gpio);
190         unsigned long flags;
191
192         spin_lock_irqsave(&bgc->lock, flags);
193
194         if (val)
195                 bgc->data |= mask;
196         else
197                 bgc->data &= ~mask;
198
199         bgc->write_reg(bgc->reg_set, bgc->data);
200
201         spin_unlock_irqrestore(&bgc->lock, flags);
202 }
203
204 static void bgpio_multiple_get_masks(struct bgpio_chip *bgc,
205                                      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
214         for (i = 0; i < bgc->bits; i++) {
215                 if (*mask == 0)
216                         break;
217                 if (__test_and_clear_bit(i, mask)) {
218                         if (test_bit(i, bits))
219                                 *set_mask |= bgc->pin2mask(bgc, i);
220                         else
221                                 *clear_mask |= bgc->pin2mask(bgc, i);
222                 }
223         }
224 }
225
226 static void bgpio_set_multiple_single_reg(struct bgpio_chip *bgc,
227                                           unsigned long *mask,
228                                           unsigned long *bits,
229                                           void __iomem *reg)
230 {
231         unsigned long flags;
232         unsigned long set_mask, clear_mask;
233
234         spin_lock_irqsave(&bgc->lock, flags);
235
236         bgpio_multiple_get_masks(bgc, mask, bits, &set_mask, &clear_mask);
237
238         bgc->data |= set_mask;
239         bgc->data &= ~clear_mask;
240
241         bgc->write_reg(reg, bgc->data);
242
243         spin_unlock_irqrestore(&bgc->lock, flags);
244 }
245
246 static void bgpio_set_multiple(struct gpio_chip *gc, unsigned long *mask,
247                                unsigned long *bits)
248 {
249         struct bgpio_chip *bgc = to_bgpio_chip(gc);
250
251         bgpio_set_multiple_single_reg(bgc, mask, bits, bgc->reg_dat);
252 }
253
254 static void bgpio_set_multiple_set(struct gpio_chip *gc, unsigned long *mask,
255                                    unsigned long *bits)
256 {
257         struct bgpio_chip *bgc = to_bgpio_chip(gc);
258
259         bgpio_set_multiple_single_reg(bgc, mask, bits, bgc->reg_set);
260 }
261
262 static void bgpio_set_multiple_with_clear(struct gpio_chip *gc,
263                                           unsigned long *mask,
264                                           unsigned long *bits)
265 {
266         struct bgpio_chip *bgc = to_bgpio_chip(gc);
267         unsigned long set_mask, clear_mask;
268
269         bgpio_multiple_get_masks(bgc, mask, bits, &set_mask, &clear_mask);
270
271         if (set_mask)
272                 bgc->write_reg(bgc->reg_set, set_mask);
273         if (clear_mask)
274                 bgc->write_reg(bgc->reg_clr, clear_mask);
275 }
276
277 static int bgpio_simple_dir_in(struct gpio_chip *gc, unsigned int gpio)
278 {
279         return 0;
280 }
281
282 static int bgpio_simple_dir_out(struct gpio_chip *gc, unsigned int gpio,
283                                 int val)
284 {
285         gc->set(gc, gpio, val);
286
287         return 0;
288 }
289
290 static int bgpio_dir_in(struct gpio_chip *gc, unsigned int gpio)
291 {
292         struct bgpio_chip *bgc = to_bgpio_chip(gc);
293         unsigned long flags;
294
295         spin_lock_irqsave(&bgc->lock, flags);
296
297         bgc->dir &= ~bgc->pin2mask(bgc, gpio);
298         bgc->write_reg(bgc->reg_dir, bgc->dir);
299
300         spin_unlock_irqrestore(&bgc->lock, flags);
301
302         return 0;
303 }
304
305 static int bgpio_get_dir(struct gpio_chip *gc, unsigned int gpio)
306 {
307         struct bgpio_chip *bgc = to_bgpio_chip(gc);
308
309         return (bgc->read_reg(bgc->reg_dir) & bgc->pin2mask(bgc, gpio)) ?
310                GPIOF_DIR_OUT : GPIOF_DIR_IN;
311 }
312
313 static int bgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val)
314 {
315         struct bgpio_chip *bgc = to_bgpio_chip(gc);
316         unsigned long flags;
317
318         gc->set(gc, gpio, val);
319
320         spin_lock_irqsave(&bgc->lock, flags);
321
322         bgc->dir |= bgc->pin2mask(bgc, gpio);
323         bgc->write_reg(bgc->reg_dir, bgc->dir);
324
325         spin_unlock_irqrestore(&bgc->lock, flags);
326
327         return 0;
328 }
329
330 static int bgpio_dir_in_inv(struct gpio_chip *gc, unsigned int gpio)
331 {
332         struct bgpio_chip *bgc = to_bgpio_chip(gc);
333         unsigned long flags;
334
335         spin_lock_irqsave(&bgc->lock, flags);
336
337         bgc->dir |= bgc->pin2mask(bgc, gpio);
338         bgc->write_reg(bgc->reg_dir, bgc->dir);
339
340         spin_unlock_irqrestore(&bgc->lock, flags);
341
342         return 0;
343 }
344
345 static int bgpio_dir_out_inv(struct gpio_chip *gc, unsigned int gpio, int val)
346 {
347         struct bgpio_chip *bgc = to_bgpio_chip(gc);
348         unsigned long flags;
349
350         gc->set(gc, gpio, val);
351
352         spin_lock_irqsave(&bgc->lock, flags);
353
354         bgc->dir &= ~bgc->pin2mask(bgc, gpio);
355         bgc->write_reg(bgc->reg_dir, bgc->dir);
356
357         spin_unlock_irqrestore(&bgc->lock, flags);
358
359         return 0;
360 }
361
362 static int bgpio_get_dir_inv(struct gpio_chip *gc, unsigned int gpio)
363 {
364         struct bgpio_chip *bgc = to_bgpio_chip(gc);
365
366         return (bgc->read_reg(bgc->reg_dir) & bgc->pin2mask(bgc, gpio)) ?
367                GPIOF_DIR_IN : GPIOF_DIR_OUT;
368 }
369
370 static int bgpio_setup_accessors(struct device *dev,
371                                  struct bgpio_chip *bgc,
372                                  bool bit_be,
373                                  bool byte_be)
374 {
375
376         switch (bgc->bits) {
377         case 8:
378                 bgc->read_reg   = bgpio_read8;
379                 bgc->write_reg  = bgpio_write8;
380                 break;
381         case 16:
382                 if (byte_be) {
383                         bgc->read_reg   = bgpio_read16be;
384                         bgc->write_reg  = bgpio_write16be;
385                 } else {
386                         bgc->read_reg   = bgpio_read16;
387                         bgc->write_reg  = bgpio_write16;
388                 }
389                 break;
390         case 32:
391                 if (byte_be) {
392                         bgc->read_reg   = bgpio_read32be;
393                         bgc->write_reg  = bgpio_write32be;
394                 } else {
395                         bgc->read_reg   = bgpio_read32;
396                         bgc->write_reg  = bgpio_write32;
397                 }
398                 break;
399 #if BITS_PER_LONG >= 64
400         case 64:
401                 if (byte_be) {
402                         dev_err(dev,
403                                 "64 bit big endian byte order unsupported\n");
404                         return -EINVAL;
405                 } else {
406                         bgc->read_reg   = bgpio_read64;
407                         bgc->write_reg  = bgpio_write64;
408                 }
409                 break;
410 #endif /* BITS_PER_LONG >= 64 */
411         default:
412                 dev_err(dev, "unsupported data width %u bits\n", bgc->bits);
413                 return -EINVAL;
414         }
415
416         bgc->pin2mask = bit_be ? bgpio_pin2mask_be : bgpio_pin2mask;
417
418         return 0;
419 }
420
421 /*
422  * Create the device and allocate the resources.  For setting GPIO's there are
423  * three supported configurations:
424  *
425  *      - single input/output register resource (named "dat").
426  *      - set/clear pair (named "set" and "clr").
427  *      - single output register resource and single input resource ("set" and
428  *      dat").
429  *
430  * For the single output register, this drives a 1 by setting a bit and a zero
431  * by clearing a bit.  For the set clr pair, this drives a 1 by setting a bit
432  * in the set register and clears it by setting a bit in the clear register.
433  * The configuration is detected by which resources are present.
434  *
435  * For setting the GPIO direction, there are three supported configurations:
436  *
437  *      - simple bidirection GPIO that requires no configuration.
438  *      - an output direction register (named "dirout") where a 1 bit
439  *      indicates the GPIO is an output.
440  *      - an input direction register (named "dirin") where a 1 bit indicates
441  *      the GPIO is an input.
442  */
443 static int bgpio_setup_io(struct bgpio_chip *bgc,
444                           void __iomem *dat,
445                           void __iomem *set,
446                           void __iomem *clr,
447                           unsigned long flags)
448 {
449
450         bgc->reg_dat = dat;
451         if (!bgc->reg_dat)
452                 return -EINVAL;
453
454         if (set && clr) {
455                 bgc->reg_set = set;
456                 bgc->reg_clr = clr;
457                 bgc->gc.set = bgpio_set_with_clear;
458                 bgc->gc.set_multiple = bgpio_set_multiple_with_clear;
459         } else if (set && !clr) {
460                 bgc->reg_set = set;
461                 bgc->gc.set = bgpio_set_set;
462                 bgc->gc.set_multiple = bgpio_set_multiple_set;
463         } else {
464                 bgc->gc.set = bgpio_set;
465                 bgc->gc.set_multiple = bgpio_set_multiple;
466         }
467
468         if (!(flags & BGPIOF_UNREADABLE_REG_SET) &&
469             (flags & BGPIOF_READ_OUTPUT_REG_SET))
470                 bgc->gc.get = bgpio_get_set;
471         else
472                 bgc->gc.get = bgpio_get;
473
474         return 0;
475 }
476
477 static int bgpio_setup_direction(struct bgpio_chip *bgc,
478                                  void __iomem *dirout,
479                                  void __iomem *dirin)
480 {
481         if (dirout && dirin) {
482                 return -EINVAL;
483         } else if (dirout) {
484                 bgc->reg_dir = dirout;
485                 bgc->gc.direction_output = bgpio_dir_out;
486                 bgc->gc.direction_input = bgpio_dir_in;
487                 bgc->gc.get_direction = bgpio_get_dir;
488         } else if (dirin) {
489                 bgc->reg_dir = dirin;
490                 bgc->gc.direction_output = bgpio_dir_out_inv;
491                 bgc->gc.direction_input = bgpio_dir_in_inv;
492                 bgc->gc.get_direction = bgpio_get_dir_inv;
493         } else {
494                 bgc->gc.direction_output = bgpio_simple_dir_out;
495                 bgc->gc.direction_input = bgpio_simple_dir_in;
496         }
497
498         return 0;
499 }
500
501 static 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
509 int bgpio_remove(struct bgpio_chip *bgc)
510 {
511         gpiochip_remove(&bgc->gc);
512         return 0;
513 }
514 EXPORT_SYMBOL_GPL(bgpio_remove);
515
516 int bgpio_init(struct bgpio_chip *bgc, struct device *dev,
517                unsigned long sz, void __iomem *dat, void __iomem *set,
518                void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
519                unsigned long flags)
520 {
521         int ret;
522
523         if (!is_power_of_2(sz))
524                 return -EINVAL;
525
526         bgc->bits = sz * 8;
527         if (bgc->bits > BITS_PER_LONG)
528                 return -EINVAL;
529
530         spin_lock_init(&bgc->lock);
531         bgc->gc.dev = dev;
532         bgc->gc.label = dev_name(dev);
533         bgc->gc.base = -1;
534         bgc->gc.ngpio = bgc->bits;
535         bgc->gc.request = bgpio_request;
536
537         ret = bgpio_setup_io(bgc, dat, set, clr, flags);
538         if (ret)
539                 return ret;
540
541         ret = bgpio_setup_accessors(dev, bgc, flags & BGPIOF_BIG_ENDIAN,
542                                     flags & BGPIOF_BIG_ENDIAN_BYTE_ORDER);
543         if (ret)
544                 return ret;
545
546         ret = bgpio_setup_direction(bgc, dirout, dirin);
547         if (ret)
548                 return ret;
549
550         bgc->data = bgc->read_reg(bgc->reg_dat);
551         if (bgc->gc.set == bgpio_set_set &&
552                         !(flags & BGPIOF_UNREADABLE_REG_SET))
553                 bgc->data = bgc->read_reg(bgc->reg_set);
554         if (bgc->reg_dir && !(flags & BGPIOF_UNREADABLE_REG_DIR))
555                 bgc->dir = bgc->read_reg(bgc->reg_dir);
556
557         return ret;
558 }
559 EXPORT_SYMBOL_GPL(bgpio_init);
560
561 #ifdef CONFIG_GPIO_GENERIC_PLATFORM
562
563 static void __iomem *bgpio_map(struct platform_device *pdev,
564                                const char *name,
565                                resource_size_t sane_sz,
566                                int *err)
567 {
568         struct device *dev = &pdev->dev;
569         struct resource *r;
570         resource_size_t start;
571         resource_size_t sz;
572         void __iomem *ret;
573
574         *err = 0;
575
576         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
577         if (!r)
578                 return NULL;
579
580         sz = resource_size(r);
581         if (sz != sane_sz) {
582                 *err = -EINVAL;
583                 return NULL;
584         }
585
586         start = r->start;
587         if (!devm_request_mem_region(dev, start, sz, r->name)) {
588                 *err = -EBUSY;
589                 return NULL;
590         }
591
592         ret = devm_ioremap(dev, start, sz);
593         if (!ret) {
594                 *err = -ENOMEM;
595                 return NULL;
596         }
597
598         return ret;
599 }
600
601 static int bgpio_pdev_probe(struct platform_device *pdev)
602 {
603         struct device *dev = &pdev->dev;
604         struct resource *r;
605         void __iomem *dat;
606         void __iomem *set;
607         void __iomem *clr;
608         void __iomem *dirout;
609         void __iomem *dirin;
610         unsigned long sz;
611         unsigned long flags = pdev->id_entry->driver_data;
612         int err;
613         struct bgpio_chip *bgc;
614         struct bgpio_pdata *pdata = dev_get_platdata(dev);
615
616         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dat");
617         if (!r)
618                 return -EINVAL;
619
620         sz = resource_size(r);
621
622         dat = bgpio_map(pdev, "dat", sz, &err);
623         if (!dat)
624                 return err ? err : -EINVAL;
625
626         set = bgpio_map(pdev, "set", sz, &err);
627         if (err)
628                 return err;
629
630         clr = bgpio_map(pdev, "clr", sz, &err);
631         if (err)
632                 return err;
633
634         dirout = bgpio_map(pdev, "dirout", sz, &err);
635         if (err)
636                 return err;
637
638         dirin = bgpio_map(pdev, "dirin", sz, &err);
639         if (err)
640                 return err;
641
642         bgc = devm_kzalloc(&pdev->dev, sizeof(*bgc), GFP_KERNEL);
643         if (!bgc)
644                 return -ENOMEM;
645
646         err = bgpio_init(bgc, dev, sz, dat, set, clr, dirout, dirin, flags);
647         if (err)
648                 return err;
649
650         if (pdata) {
651                 if (pdata->label)
652                         bgc->gc.label = pdata->label;
653                 bgc->gc.base = pdata->base;
654                 if (pdata->ngpio > 0)
655                         bgc->gc.ngpio = pdata->ngpio;
656         }
657
658         platform_set_drvdata(pdev, bgc);
659
660         return gpiochip_add(&bgc->gc);
661 }
662
663 static int bgpio_pdev_remove(struct platform_device *pdev)
664 {
665         struct bgpio_chip *bgc = platform_get_drvdata(pdev);
666
667         return bgpio_remove(bgc);
668 }
669
670 static const struct platform_device_id bgpio_id_table[] = {
671         {
672                 .name           = "basic-mmio-gpio",
673                 .driver_data    = 0,
674         }, {
675                 .name           = "basic-mmio-gpio-be",
676                 .driver_data    = BGPIOF_BIG_ENDIAN,
677         },
678         { }
679 };
680 MODULE_DEVICE_TABLE(platform, bgpio_id_table);
681
682 static struct platform_driver bgpio_driver = {
683         .driver = {
684                 .name = "basic-mmio-gpio",
685         },
686         .id_table = bgpio_id_table,
687         .probe = bgpio_pdev_probe,
688         .remove = bgpio_pdev_remove,
689 };
690
691 module_platform_driver(bgpio_driver);
692
693 #endif /* CONFIG_GPIO_GENERIC_PLATFORM */
694
695 MODULE_DESCRIPTION("Driver for basic memory-mapped GPIO controllers");
696 MODULE_AUTHOR("Anton Vorontsov <cbouatmailru@gmail.com>");
697 MODULE_LICENSE("GPL");