drivers/gpio/gpio-mmio.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Generic driver for memory-mapped GPIO controllers.
   4  *
   5  * Copyright 2008 MontaVista Software, Inc.
   6  * Copyright 2008,2010 Anton Vorontsov <cbouatmailru@gmail.com>
   7  *
   8  * ....``.```~~~~````.`.`.`.`.```````'',,,.........`````......`.......
   9  * ...``                                                         ```````..
  10  * ..The simplest form of a GPIO controller that the driver supports is``
  11  *  `.just a single "data" register, where GPIO state can be read and/or `
  12  *    `,..written. ,,..``~~~~ .....``.`.`.~~.```.`.........``````.```````
  13  *        `````````
  14                                     ___
  15 _/~~|___/~|   . ```~~~~~~       ___/___\___     ,~.`.`.`.`````.~~...,,,,...
  16 __________|~$@~~~        %~    /o*o*o*o*o*o\   .. Implementing such a GPIO .
  17 o        `                     ~~~~\___/~~~~    ` controller in FPGA is ,.`
  18                                                  `....trivial..'~`.```.```
  19  *                                                    ```````
  20  *  .```````~~~~`..`.``.``.
  21  * .  The driver supports  `...       ,..```.`~~~```````````````....````.``,,
  22  * .   big-endian notation, just`.  .. A bit more sophisticated controllers ,
  23  *  . register the device with -be`. .with a pair of set/clear-bit registers ,
  24  *   `.. suffix.  ```~~`````....`.`   . affecting the data register and the .`
  25  *     ``.`.``...```                  ```.. output pins are also supported.`
  26  *                        ^^             `````.`````````.,``~``~``~~``````
  27  *                                                   .                  ^^
  28  *   ,..`.`.`...````````````......`.`.`.`.`.`..`.`.`..
  29  * .. The expectation is that in at least some cases .    ,-~~~-,
  30  *  .this will be used with roll-your-own ASIC/FPGA .`     \   /
  31  *  .logic in Verilog or VHDL. ~~~`````````..`````~~`       \ /
  32  *  ..````````......```````````                             \o_
  33  *                                                           |
  34  *                              ^^                          / \
  35  *
  36  *           ...`````~~`.....``.`..........``````.`.``.```........``.
  37  *            `  8, 16, 32 and 64 bits registers are supported, and``.
  38  *            . the number of GPIOs is determined by the width of   ~
  39  *             .. the registers. ,............```.`.`..`.`.~~~.`.`.`~
  40  *               `.......````.```
  41  */
  42
  43 #include <linux/init.h>
  44 #include <linux/err.h>
  45 #include <linux/bug.h>
  46 #include <linux/kernel.h>
  47 #include <linux/module.h>
  48 #include <linux/spinlock.h>
  49 #include <linux/compiler.h>
  50 #include <linux/types.h>
  51 #include <linux/errno.h>
  52 #include <linux/log2.h>
  53 #include <linux/ioport.h>
  54 #include <linux/io.h>
  55 #include <linux/gpio/driver.h>
  56 #include <linux/slab.h>
  57 #include <linux/bitops.h>
  58 #include <linux/platform_device.h>
  59 #include <linux/mod_devicetable.h>
  60 #include <linux/of.h>
  61 #include <linux/of_device.h>
  62
  63 #include "gpiolib.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_line2mask(struct gpio_chip *gc, unsigned int line)
 128 {
 129         if (gc->be_bits)
 130                 return BIT(gc->bgpio_bits - 1 - line);
 131         return BIT(line);
 132 }
 133
 134 static int bgpio_get_set(struct gpio_chip *gc, unsigned int gpio)
 135 {
 136         unsigned long pinmask = bgpio_line2mask(gc, gpio);
 137         bool dir = !!(gc->bgpio_dir & pinmask);
 138
 139         if (dir)
 140                 return !!(gc->read_reg(gc->reg_set) & pinmask);
 141         else
 142                 return !!(gc->read_reg(gc->reg_dat) & pinmask);
 143 }
 144
 145 /*
 146  * This assumes that the bits in the GPIO register are in native endianness.
 147  * We only assign the function pointer if we have that.
 148  */
 149 static int bgpio_get_set_multiple(struct gpio_chip *gc, unsigned long *mask,
 150                                   unsigned long *bits)
 151 {
 152         unsigned long get_mask = 0;
 153         unsigned long set_mask = 0;
 154
 155         /* Make sure we first clear any bits that are zero when we read the register */
 156         *bits &= ~*mask;
 157
 158         set_mask = *mask & gc->bgpio_dir;
 159         get_mask = *mask & ~gc->bgpio_dir;
 160
 161         if (set_mask)
 162                 *bits |= gc->read_reg(gc->reg_set) & set_mask;
 163         if (get_mask)
 164                 *bits |= gc->read_reg(gc->reg_dat) & get_mask;
 165
 166         return 0;
 167 }
 168
 169 static int bgpio_get(struct gpio_chip *gc, unsigned int gpio)
 170 {
 171         return !!(gc->read_reg(gc->reg_dat) & bgpio_line2mask(gc, gpio));
 172 }
 173
 174 /*
 175  * This only works if the bits in the GPIO register are in native endianness.
 176  */
 177 static int bgpio_get_multiple(struct gpio_chip *gc, unsigned long *mask,
 178                               unsigned long *bits)
 179 {
 180         /* Make sure we first clear any bits that are zero when we read the register */
 181         *bits &= ~*mask;
 182         *bits |= gc->read_reg(gc->reg_dat) & *mask;
 183         return 0;
 184 }
 185
 186 /*
 187  * With big endian mirrored bit order it becomes more tedious.
 188  */
 189 static int bgpio_get_multiple_be(struct gpio_chip *gc, unsigned long *mask,
 190                                  unsigned long *bits)
 191 {
 192         unsigned long readmask = 0;
 193         unsigned long val;
 194         int bit;
 195
 196         /* Make sure we first clear any bits that are zero when we read the register */
 197         *bits &= ~*mask;
 198
 199         /* Create a mirrored mask */
 200         for_each_set_bit(bit, mask, gc->ngpio)
 201                 readmask |= bgpio_line2mask(gc, bit);
 202
 203         /* Read the register */
 204         val = gc->read_reg(gc->reg_dat) & readmask;
 205
 206         /*
 207          * Mirror the result into the "bits" result, this will give line 0
 208          * in bit 0 ... line 31 in bit 31 for a 32bit register.
 209          */
 210         for_each_set_bit(bit, &val, gc->ngpio)
 211                 *bits |= bgpio_line2mask(gc, bit);
 212
 213         return 0;
 214 }
 215
 216 static void bgpio_set_none(struct gpio_chip *gc, unsigned int gpio, int val)
 217 {
 218 }
 219
 220 static void bgpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
 221 {
 222         unsigned long mask = bgpio_line2mask(gc, gpio);
 223         unsigned long flags;
 224
 225         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 226
 227         if (val)
 228                 gc->bgpio_data |= mask;
 229         else
 230                 gc->bgpio_data &= ~mask;
 231
 232         gc->write_reg(gc->reg_dat, gc->bgpio_data);
 233
 234         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 235 }
 236
 237 static void bgpio_set_direct(struct gpio_chip *gc, unsigned int gpio, int val)
 238 {
 239         unsigned long mask = bgpio_line2mask(gc, gpio);
 240         unsigned long flags;
 241
 242         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 243
 244         gc->bgpio_data = gc->read_reg(gc->reg_dat);
 245
 246         if (val)
 247                 gc->bgpio_data |= mask;
 248         else
 249                 gc->bgpio_data &= ~mask;
 250
 251         gc->write_reg(gc->reg_dat, gc->bgpio_data);
 252
 253         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 254 }
 255
 256 static void bgpio_set_with_clear(struct gpio_chip *gc, unsigned int gpio,
 257                                  int val)
 258 {
 259         unsigned long mask = bgpio_line2mask(gc, gpio);
 260
 261         if (val)
 262                 gc->write_reg(gc->reg_set, mask);
 263         else
 264                 gc->write_reg(gc->reg_clr, mask);
 265 }
 266
 267 static void bgpio_set_set(struct gpio_chip *gc, unsigned int gpio, int val)
 268 {
 269         unsigned long mask = bgpio_line2mask(gc, gpio);
 270         unsigned long flags;
 271
 272         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 273
 274         if (val)
 275                 gc->bgpio_data |= mask;
 276         else
 277                 gc->bgpio_data &= ~mask;
 278
 279         gc->write_reg(gc->reg_set, gc->bgpio_data);
 280
 281         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 282 }
 283
 284 static void bgpio_multiple_get_masks(struct gpio_chip *gc,
 285                                      unsigned long *mask, unsigned long *bits,
 286                                      unsigned long *set_mask,
 287                                      unsigned long *clear_mask)
 288 {
 289         int i;
 290
 291         *set_mask = 0;
 292         *clear_mask = 0;
 293
 294         for_each_set_bit(i, mask, gc->bgpio_bits) {
 295                 if (test_bit(i, bits))
 296                         *set_mask |= bgpio_line2mask(gc, i);
 297                 else
 298                         *clear_mask |= bgpio_line2mask(gc, i);
 299         }
 300 }
 301
 302 static void bgpio_set_multiple_single_reg(struct gpio_chip *gc,
 303                                           unsigned long *mask,
 304                                           unsigned long *bits,
 305                                           void __iomem *reg)
 306 {
 307         unsigned long flags;
 308         unsigned long set_mask, clear_mask;
 309
 310         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 311
 312         bgpio_multiple_get_masks(gc, mask, bits, &set_mask, &clear_mask);
 313
 314         gc->bgpio_data |= set_mask;
 315         gc->bgpio_data &= ~clear_mask;
 316
 317         gc->write_reg(reg, gc->bgpio_data);
 318
 319         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 320 }
 321
 322 static void bgpio_set_multiple(struct gpio_chip *gc, unsigned long *mask,
 323                                unsigned long *bits)
 324 {
 325         bgpio_set_multiple_single_reg(gc, mask, bits, gc->reg_dat);
 326 }
 327
 328 static void bgpio_set_multiple_set(struct gpio_chip *gc, unsigned long *mask,
 329                                    unsigned long *bits)
 330 {
 331         bgpio_set_multiple_single_reg(gc, mask, bits, gc->reg_set);
 332 }
 333
 334 static void bgpio_set_multiple_with_clear(struct gpio_chip *gc,
 335                                           unsigned long *mask,
 336                                           unsigned long *bits)
 337 {
 338         unsigned long set_mask, clear_mask;
 339
 340         bgpio_multiple_get_masks(gc, mask, bits, &set_mask, &clear_mask);
 341
 342         if (set_mask)
 343                 gc->write_reg(gc->reg_set, set_mask);
 344         if (clear_mask)
 345                 gc->write_reg(gc->reg_clr, clear_mask);
 346 }
 347
 348 static void bgpio_set_multiple_direct(struct gpio_chip *gc,
 349                                       unsigned long *mask,
 350                                       unsigned long *bits)
 351 {
 352         unsigned long flags;
 353         unsigned long set_mask, clear_mask;
 354
 355         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 356
 357         bgpio_multiple_get_masks(gc, mask, bits, &set_mask, &clear_mask);
 358
 359         gc->bgpio_data = gc->read_reg(gc->reg_dat);
 360
 361         gc->bgpio_data |= set_mask;
 362         gc->bgpio_data &= ~clear_mask;
 363
 364         gc->write_reg(gc->reg_dat, gc->bgpio_data);
 365
 366         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 367 }
 368
 369 static int bgpio_simple_dir_in(struct gpio_chip *gc, unsigned int gpio)
 370 {
 371         return 0;
 372 }
 373
 374 static int bgpio_dir_out_err(struct gpio_chip *gc, unsigned int gpio,
 375                                 int val)
 376 {
 377         return -EINVAL;
 378 }
 379
 380 static int bgpio_simple_dir_out(struct gpio_chip *gc, unsigned int gpio,
 381                                 int val)
 382 {
 383         gc->set(gc, gpio, val);
 384
 385         return 0;
 386 }
 387
 388 static int bgpio_dir_in(struct gpio_chip *gc, unsigned int gpio)
 389 {
 390         unsigned long flags;
 391
 392         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 393
 394         gc->bgpio_dir &= ~bgpio_line2mask(gc, gpio);
 395
 396         if (gc->reg_dir_in)
 397                 gc->write_reg(gc->reg_dir_in, ~gc->bgpio_dir);
 398         if (gc->reg_dir_out)
 399                 gc->write_reg(gc->reg_dir_out, gc->bgpio_dir);
 400
 401         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 402
 403         return 0;
 404 }
 405
 406 static int bgpio_dir_in_direct(struct gpio_chip *gc, unsigned int gpio)
 407 {
 408         unsigned long flags;
 409
 410         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 411
 412         if (gc->reg_dir_in)
 413                 gc->bgpio_dir = ~gc->read_reg(gc->reg_dir_in);
 414         if (gc->reg_dir_out)
 415                 gc->bgpio_dir = gc->read_reg(gc->reg_dir_out);
 416
 417         gc->bgpio_dir &= ~bgpio_line2mask(gc, gpio);
 418
 419         if (gc->reg_dir_in)
 420                 gc->write_reg(gc->reg_dir_in, ~gc->bgpio_dir);
 421         if (gc->reg_dir_out)
 422                 gc->write_reg(gc->reg_dir_out, gc->bgpio_dir);
 423
 424         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 425
 426         return 0;
 427 }
 428
 429 static int bgpio_get_dir(struct gpio_chip *gc, unsigned int gpio)
 430 {
 431         /* Return 0 if output, 1 if input */
 432         if (gc->bgpio_dir_unreadable) {
 433                 if (gc->bgpio_dir & bgpio_line2mask(gc, gpio))
 434                         return GPIO_LINE_DIRECTION_OUT;
 435                 return GPIO_LINE_DIRECTION_IN;
 436         }
 437
 438         if (gc->reg_dir_out) {
 439                 if (gc->read_reg(gc->reg_dir_out) & bgpio_line2mask(gc, gpio))
 440                         return GPIO_LINE_DIRECTION_OUT;
 441                 return GPIO_LINE_DIRECTION_IN;
 442         }
 443
 444         if (gc->reg_dir_in)
 445                 if (!(gc->read_reg(gc->reg_dir_in) & bgpio_line2mask(gc, gpio)))
 446                         return GPIO_LINE_DIRECTION_OUT;
 447
 448         return GPIO_LINE_DIRECTION_IN;
 449 }
 450
 451 static void bgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val)
 452 {
 453         unsigned long flags;
 454
 455         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 456
 457         gc->bgpio_dir |= bgpio_line2mask(gc, gpio);
 458
 459         if (gc->reg_dir_in)
 460                 gc->write_reg(gc->reg_dir_in, ~gc->bgpio_dir);
 461         if (gc->reg_dir_out)
 462                 gc->write_reg(gc->reg_dir_out, gc->bgpio_dir);
 463
 464         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 465 }
 466
 467 static void bgpio_dir_out_direct(struct gpio_chip *gc, unsigned int gpio,
 468                                  int val)
 469 {
 470         unsigned long flags;
 471
 472         raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
 473
 474         if (gc->reg_dir_in)
 475                 gc->bgpio_dir = ~gc->read_reg(gc->reg_dir_in);
 476         if (gc->reg_dir_out)
 477                 gc->bgpio_dir = gc->read_reg(gc->reg_dir_out);
 478
 479         gc->bgpio_dir |= bgpio_line2mask(gc, gpio);
 480
 481         if (gc->reg_dir_in)
 482                 gc->write_reg(gc->reg_dir_in, ~gc->bgpio_dir);
 483         if (gc->reg_dir_out)
 484                 gc->write_reg(gc->reg_dir_out, gc->bgpio_dir);
 485
 486         raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
 487 }
 488
 489 static int bgpio_dir_out_dir_first(struct gpio_chip *gc, unsigned int gpio,
 490                                    int val)
 491 {
 492         bgpio_dir_out(gc, gpio, val);
 493         gc->set(gc, gpio, val);
 494         return 0;
 495 }
 496
 497 static int bgpio_dir_out_val_first(struct gpio_chip *gc, unsigned int gpio,
 498                                    int val)
 499 {
 500         gc->set(gc, gpio, val);
 501         bgpio_dir_out(gc, gpio, val);
 502         return 0;
 503 }
 504
 505 static int bgpio_dir_out_dir_first_direct(struct gpio_chip *gc,
 506                                           unsigned int gpio, int val)
 507 {
 508         bgpio_dir_out_direct(gc, gpio, val);
 509         gc->set(gc, gpio, val);
 510         return 0;
 511 }
 512
 513 static int bgpio_dir_out_val_first_direct(struct gpio_chip *gc,
 514                                           unsigned int gpio, int val)
 515 {
 516         gc->set(gc, gpio, val);
 517         bgpio_dir_out_direct(gc, gpio, val);
 518         return 0;
 519 }
 520
 521 static int bgpio_setup_accessors(struct device *dev,
 522                                  struct gpio_chip *gc,
 523                                  bool byte_be)
 524 {
 525
 526         switch (gc->bgpio_bits) {
 527         case 8:
 528                 gc->read_reg    = bgpio_read8;
 529                 gc->write_reg   = bgpio_write8;
 530                 break;
 531         case 16:
 532                 if (byte_be) {
 533                         gc->read_reg    = bgpio_read16be;
 534                         gc->write_reg   = bgpio_write16be;
 535                 } else {
 536                         gc->read_reg    = bgpio_read16;
 537                         gc->write_reg   = bgpio_write16;
 538                 }
 539                 break;
 540         case 32:
 541                 if (byte_be) {
 542                         gc->read_reg    = bgpio_read32be;
 543                         gc->write_reg   = bgpio_write32be;
 544                 } else {
 545                         gc->read_reg    = bgpio_read32;
 546                         gc->write_reg   = bgpio_write32;
 547                 }
 548                 break;
 549 #if BITS_PER_LONG >= 64
 550         case 64:
 551                 if (byte_be) {
 552                         dev_err(dev,
 553                                 "64 bit big endian byte order unsupported\n");
 554                         return -EINVAL;
 555                 } else {
 556                         gc->read_reg    = bgpio_read64;
 557                         gc->write_reg   = bgpio_write64;
 558                 }
 559                 break;
 560 #endif /* BITS_PER_LONG >= 64 */
 561         default:
 562                 dev_err(dev, "unsupported data width %u bits\n", gc->bgpio_bits);
 563                 return -EINVAL;
 564         }
 565
 566         return 0;
 567 }
 568
 569 /*
 570  * Create the device and allocate the resources.  For setting GPIO's there are
 571  * three supported configurations:
 572  *
 573  *      - single input/output register resource (named "dat").
 574  *      - set/clear pair (named "set" and "clr").
 575  *      - single output register resource and single input resource ("set" and
 576  *      dat").
 577  *
 578  * For the single output register, this drives a 1 by setting a bit and a zero
 579  * by clearing a bit.  For the set clr pair, this drives a 1 by setting a bit
 580  * in the set register and clears it by setting a bit in the clear register.
 581  * The configuration is detected by which resources are present.
 582  *
 583  * For setting the GPIO direction, there are three supported configurations:
 584  *
 585  *      - simple bidirection GPIO that requires no configuration.
 586  *      - an output direction register (named "dirout") where a 1 bit
 587  *      indicates the GPIO is an output.
 588  *      - an input direction register (named "dirin") where a 1 bit indicates
 589  *      the GPIO is an input.
 590  */
 591 static int bgpio_setup_io(struct gpio_chip *gc,
 592                           void __iomem *dat,
 593                           void __iomem *set,
 594                           void __iomem *clr,
 595                           unsigned long flags)
 596 {
 597
 598         gc->reg_dat = dat;
 599         if (!gc->reg_dat)
 600                 return -EINVAL;
 601
 602         if (set && clr) {
 603                 gc->reg_set = set;
 604                 gc->reg_clr = clr;
 605                 gc->set = bgpio_set_with_clear;
 606                 gc->set_multiple = bgpio_set_multiple_with_clear;
 607         } else if (set && !clr) {
 608                 gc->reg_set = set;
 609                 gc->set = bgpio_set_set;
 610                 gc->set_multiple = bgpio_set_multiple_set;
 611         } else if (flags & BGPIOF_NO_OUTPUT) {
 612                 gc->set = bgpio_set_none;
 613                 gc->set_multiple = NULL;
 614         } else if (flags & BGPIOF_REG_DIRECT) {
 615                 gc->set = bgpio_set_direct;
 616                 gc->set_multiple = bgpio_set_multiple_direct;
 617         } else {
 618                 gc->set = bgpio_set;
 619                 gc->set_multiple = bgpio_set_multiple;
 620         }
 621
 622         if (!(flags & BGPIOF_UNREADABLE_REG_SET) &&
 623             (flags & BGPIOF_READ_OUTPUT_REG_SET)) {
 624                 gc->get = bgpio_get_set;
 625                 if (!gc->be_bits)
 626                         gc->get_multiple = bgpio_get_set_multiple;
 627                 /*
 628                  * We deliberately avoid assigning the ->get_multiple() call
 629                  * for big endian mirrored registers which are ALSO reflecting
 630                  * their value in the set register when used as output. It is
 631                  * simply too much complexity, let the GPIO core fall back to
 632                  * reading each line individually in that fringe case.
 633                  */
 634         } else {
 635                 gc->get = bgpio_get;
 636                 if (gc->be_bits)
 637                         gc->get_multiple = bgpio_get_multiple_be;
 638                 else
 639                         gc->get_multiple = bgpio_get_multiple;
 640         }
 641
 642         return 0;
 643 }
 644
 645 static int bgpio_setup_direction(struct gpio_chip *gc,
 646                                  void __iomem *dirout,
 647                                  void __iomem *dirin,
 648                                  unsigned long flags)
 649 {
 650         if (dirout || dirin) {
 651                 gc->reg_dir_out = dirout;
 652                 gc->reg_dir_in = dirin;
 653                 if (flags & BGPIOF_REG_DIRECT) {
 654                         if (flags & BGPIOF_NO_SET_ON_INPUT)
 655                                 gc->direction_output =
 656                                         bgpio_dir_out_dir_first_direct;
 657                         else
 658                                 gc->direction_output =
 659                                         bgpio_dir_out_val_first_direct;
 660                         gc->direction_input = bgpio_dir_in_direct;
 661                 } else {
 662                         if (flags & BGPIOF_NO_SET_ON_INPUT)
 663                                 gc->direction_output = bgpio_dir_out_dir_first;
 664                         else
 665                                 gc->direction_output = bgpio_dir_out_val_first;
 666                         gc->direction_input = bgpio_dir_in;
 667                 }
 668                 gc->get_direction = bgpio_get_dir;
 669         } else {
 670                 if (flags & BGPIOF_NO_OUTPUT)
 671                         gc->direction_output = bgpio_dir_out_err;
 672                 else
 673                         gc->direction_output = bgpio_simple_dir_out;
 674                 gc->direction_input = bgpio_simple_dir_in;
 675         }
 676
 677         return 0;
 678 }
 679
 680 static int bgpio_request(struct gpio_chip *chip, unsigned gpio_pin)
 681 {
 682         if (gpio_pin < chip->ngpio)
 683                 return 0;
 684
 685         return -EINVAL;
 686 }
 687
 688 /**
 689  * bgpio_init() - Initialize generic GPIO accessor functions
 690  * @gc: the GPIO chip to set up
 691  * @dev: the parent device of the new GPIO chip (compulsory)
 692  * @sz: the size (width) of the MMIO registers in bytes, typically 1, 2 or 4
 693  * @dat: MMIO address for the register to READ the value of the GPIO lines, it
 694  *      is expected that a 1 in the corresponding bit in this register means the
 695  *      line is asserted
 696  * @set: MMIO address for the register to SET the value of the GPIO lines, it is
 697  *      expected that we write the line with 1 in this register to drive the GPIO line
 698  *      high.
 699  * @clr: MMIO address for the register to CLEAR the value of the GPIO lines, it is
 700  *      expected that we write the line with 1 in this register to drive the GPIO line
 701  *      low. It is allowed to leave this address as NULL, in that case the SET register
 702  *      will be assumed to also clear the GPIO lines, by actively writing the line
 703  *      with 0.
 704  * @dirout: MMIO address for the register to set the line as OUTPUT. It is assumed
 705  *      that setting a line to 1 in this register will turn that line into an
 706  *      output line. Conversely, setting the line to 0 will turn that line into
 707  *      an input.
 708  * @dirin: MMIO address for the register to set this line as INPUT. It is assumed
 709  *      that setting a line to 1 in this register will turn that line into an
 710  *      input line. Conversely, setting the line to 0 will turn that line into
 711  *      an output.
 712  * @flags: Different flags that will affect the behaviour of the device, such as
 713  *      endianness etc.
 714  */
 715 int bgpio_init(struct gpio_chip *gc, struct device *dev,
 716                unsigned long sz, void __iomem *dat, void __iomem *set,
 717                void __iomem *clr, void __iomem *dirout, void __iomem *dirin,
 718                unsigned long flags)
 719 {
 720         int ret;
 721
 722         if (!is_power_of_2(sz))
 723                 return -EINVAL;
 724
 725         gc->bgpio_bits = sz * 8;
 726         if (gc->bgpio_bits > BITS_PER_LONG)
 727                 return -EINVAL;
 728
 729         raw_spin_lock_init(&gc->bgpio_lock);
 730         gc->parent = dev;
 731         gc->label = dev_name(dev);
 732         gc->base = -1;
 733         gc->request = bgpio_request;
 734         gc->be_bits = !!(flags & BGPIOF_BIG_ENDIAN);
 735
 736         ret = gpiochip_get_ngpios(gc, dev);
 737         if (ret)
 738                 gc->ngpio = gc->bgpio_bits;
 739         else
 740                 gc->bgpio_bits = roundup_pow_of_two(round_up(gc->ngpio, 8));
 741
 742         ret = bgpio_setup_io(gc, dat, set, clr, flags);
 743         if (ret)
 744                 return ret;
 745
 746         ret = bgpio_setup_accessors(dev, gc, flags & BGPIOF_BIG_ENDIAN_BYTE_ORDER);
 747         if (ret)
 748                 return ret;
 749
 750         ret = bgpio_setup_direction(gc, dirout, dirin, flags);
 751         if (ret)
 752                 return ret;
 753
 754         gc->bgpio_data = gc->read_reg(gc->reg_dat);
 755         if (gc->set == bgpio_set_set &&
 756                         !(flags & BGPIOF_UNREADABLE_REG_SET))
 757                 gc->bgpio_data = gc->read_reg(gc->reg_set);
 758
 759         if (flags & BGPIOF_UNREADABLE_REG_DIR)
 760                 gc->bgpio_dir_unreadable = true;
 761
 762         /*
 763          * Inspect hardware to find initial direction setting.
 764          */
 765         if ((gc->reg_dir_out || gc->reg_dir_in) &&
 766             !(flags & BGPIOF_UNREADABLE_REG_DIR)) {
 767                 if (gc->reg_dir_out)
 768                         gc->bgpio_dir = gc->read_reg(gc->reg_dir_out);
 769                 else if (gc->reg_dir_in)
 770                         gc->bgpio_dir = ~gc->read_reg(gc->reg_dir_in);
 771                 /*
 772                  * If we have two direction registers, synchronise
 773                  * input setting to output setting, the library
 774                  * can not handle a line being input and output at
 775                  * the same time.
 776                  */
 777                 if (gc->reg_dir_out && gc->reg_dir_in)
 778                         gc->write_reg(gc->reg_dir_in, ~gc->bgpio_dir);
 779         }
 780
 781         return ret;
 782 }
 783 EXPORT_SYMBOL_GPL(bgpio_init);
 784
 785 #if IS_ENABLED(CONFIG_GPIO_GENERIC_PLATFORM)
 786
 787 static void __iomem *bgpio_map(struct platform_device *pdev,
 788                                const char *name,
 789                                resource_size_t sane_sz)
 790 {
 791         struct resource *r;
 792         resource_size_t sz;
 793
 794         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
 795         if (!r)
 796                 return NULL;
 797
 798         sz = resource_size(r);
 799         if (sz != sane_sz)
 800                 return IOMEM_ERR_PTR(-EINVAL);
 801
 802         return devm_ioremap_resource(&pdev->dev, r);
 803 }
 804
 805 #ifdef CONFIG_OF
 806 static const struct of_device_id bgpio_of_match[] = {
 807         { .compatible = "brcm,bcm6345-gpio" },
 808         { .compatible = "wd,mbl-gpio" },
 809         { .compatible = "ni,169445-nand-gpio" },
 810         { }
 811 };
 812 MODULE_DEVICE_TABLE(of, bgpio_of_match);
 813
 814 static struct bgpio_pdata *bgpio_parse_dt(struct platform_device *pdev,
 815                                           unsigned long *flags)
 816 {
 817         struct bgpio_pdata *pdata;
 818
 819         if (!of_match_device(bgpio_of_match, &pdev->dev))
 820                 return NULL;
 821
 822         pdata = devm_kzalloc(&pdev->dev, sizeof(struct bgpio_pdata),
 823                              GFP_KERNEL);
 824         if (!pdata)
 825                 return ERR_PTR(-ENOMEM);
 826
 827         pdata->base = -1;
 828
 829         if (of_device_is_big_endian(pdev->dev.of_node))
 830                 *flags |= BGPIOF_BIG_ENDIAN_BYTE_ORDER;
 831
 832         if (of_property_read_bool(pdev->dev.of_node, "no-output"))
 833                 *flags |= BGPIOF_NO_OUTPUT;
 834
 835         return pdata;
 836 }
 837 #else
 838 static struct bgpio_pdata *bgpio_parse_dt(struct platform_device *pdev,
 839                                           unsigned long *flags)
 840 {
 841         return NULL;
 842 }
 843 #endif /* CONFIG_OF */
 844
 845 static int bgpio_pdev_probe(struct platform_device *pdev)
 846 {
 847         struct device *dev = &pdev->dev;
 848         struct resource *r;
 849         void __iomem *dat;
 850         void __iomem *set;
 851         void __iomem *clr;
 852         void __iomem *dirout;
 853         void __iomem *dirin;
 854         unsigned long sz;
 855         unsigned long flags = 0;
 856         int err;
 857         struct gpio_chip *gc;
 858         struct bgpio_pdata *pdata;
 859
 860         pdata = bgpio_parse_dt(pdev, &flags);
 861         if (IS_ERR(pdata))
 862                 return PTR_ERR(pdata);
 863
 864         if (!pdata) {
 865                 pdata = dev_get_platdata(dev);
 866                 flags = pdev->id_entry->driver_data;
 867         }
 868
 869         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dat");
 870         if (!r)
 871                 return -EINVAL;
 872
 873         sz = resource_size(r);
 874
 875         dat = bgpio_map(pdev, "dat", sz);
 876         if (IS_ERR(dat))
 877                 return PTR_ERR(dat);
 878
 879         set = bgpio_map(pdev, "set", sz);
 880         if (IS_ERR(set))
 881                 return PTR_ERR(set);
 882
 883         clr = bgpio_map(pdev, "clr", sz);
 884         if (IS_ERR(clr))
 885                 return PTR_ERR(clr);
 886
 887         dirout = bgpio_map(pdev, "dirout", sz);
 888         if (IS_ERR(dirout))
 889                 return PTR_ERR(dirout);
 890
 891         dirin = bgpio_map(pdev, "dirin", sz);
 892         if (IS_ERR(dirin))
 893                 return PTR_ERR(dirin);
 894
 895         gc = devm_kzalloc(&pdev->dev, sizeof(*gc), GFP_KERNEL);
 896         if (!gc)
 897                 return -ENOMEM;
 898
 899         err = bgpio_init(gc, dev, sz, dat, set, clr, dirout, dirin, flags);
 900         if (err)
 901                 return err;
 902
 903         if (pdata) {
 904                 if (pdata->label)
 905                         gc->label = pdata->label;
 906                 gc->base = pdata->base;
 907                 if (pdata->ngpio > 0)
 908                         gc->ngpio = pdata->ngpio;
 909         }
 910
 911         platform_set_drvdata(pdev, gc);
 912
 913         return devm_gpiochip_add_data(&pdev->dev, gc, NULL);
 914 }
 915
 916 static const struct platform_device_id bgpio_id_table[] = {
 917         {
 918                 .name           = "basic-mmio-gpio",
 919                 .driver_data    = 0,
 920         }, {
 921                 .name           = "basic-mmio-gpio-be",
 922                 .driver_data    = BGPIOF_BIG_ENDIAN,
 923         },
 924         { }
 925 };
 926 MODULE_DEVICE_TABLE(platform, bgpio_id_table);
 927
 928 static struct platform_driver bgpio_driver = {
 929         .driver = {
 930                 .name = "basic-mmio-gpio",
 931                 .of_match_table = of_match_ptr(bgpio_of_match),
 932         },
 933         .id_table = bgpio_id_table,
 934         .probe = bgpio_pdev_probe,
 935 };
 936
 937 module_platform_driver(bgpio_driver);
 938
 939 #endif /* CONFIG_GPIO_GENERIC_PLATFORM */
 940
 941 MODULE_DESCRIPTION("Driver for basic memory-mapped GPIO controllers");
 942 MODULE_AUTHOR("Anton Vorontsov <cbouatmailru@gmail.com>");
 943 MODULE_LICENSE("GPL");