drivers/gpio/gpio-rcar.c

   1 /*
   2  * Renesas R-Car GPIO Support
   3  *
   4  *  Copyright (C) 2014 Renesas Electronics Corporation
   5  *  Copyright (C) 2013 Magnus Damm
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  */
  16
  17 #include <linux/clk.h>
  18 #include <linux/err.h>
  19 #include <linux/gpio.h>
  20 #include <linux/init.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/io.h>
  23 #include <linux/ioport.h>
  24 #include <linux/irq.h>
  25 #include <linux/module.h>
  26 #include <linux/of.h>
  27 #include <linux/pinctrl/consumer.h>
  28 #include <linux/platform_data/gpio-rcar.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/pm_runtime.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/slab.h>
  33
  34 struct gpio_rcar_priv {
  35         void __iomem *base;
  36         spinlock_t lock;
  37         struct gpio_rcar_config config;
  38         struct platform_device *pdev;
  39         struct gpio_chip gpio_chip;
  40         struct irq_chip irq_chip;
  41         unsigned int irq_parent;
  42         struct clk *clk;
  43 };
  44
  45 #define IOINTSEL 0x00   /* General IO/Interrupt Switching Register */
  46 #define INOUTSEL 0x04   /* General Input/Output Switching Register */
  47 #define OUTDT 0x08      /* General Output Register */
  48 #define INDT 0x0c       /* General Input Register */
  49 #define INTDT 0x10      /* Interrupt Display Register */
  50 #define INTCLR 0x14     /* Interrupt Clear Register */
  51 #define INTMSK 0x18     /* Interrupt Mask Register */
  52 #define MSKCLR 0x1c     /* Interrupt Mask Clear Register */
  53 #define POSNEG 0x20     /* Positive/Negative Logic Select Register */
  54 #define EDGLEVEL 0x24   /* Edge/level Select Register */
  55 #define FILONOFF 0x28   /* Chattering Prevention On/Off Register */
  56 #define BOTHEDGE 0x4c   /* One Edge/Both Edge Select Register */
  57
  58 #define RCAR_MAX_GPIO_PER_BANK          32
  59
  60 static inline u32 gpio_rcar_read(struct gpio_rcar_priv *p, int offs)
  61 {
  62         return ioread32(p->base + offs);
  63 }
  64
  65 static inline void gpio_rcar_write(struct gpio_rcar_priv *p, int offs,
  66                                    u32 value)
  67 {
  68         iowrite32(value, p->base + offs);
  69 }
  70
  71 static void gpio_rcar_modify_bit(struct gpio_rcar_priv *p, int offs,
  72                                  int bit, bool value)
  73 {
  74         u32 tmp = gpio_rcar_read(p, offs);
  75
  76         if (value)
  77                 tmp |= BIT(bit);
  78         else
  79                 tmp &= ~BIT(bit);
  80
  81         gpio_rcar_write(p, offs, tmp);
  82 }
  83
  84 static void gpio_rcar_irq_disable(struct irq_data *d)
  85 {
  86         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
  87         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
  88                                                 gpio_chip);
  89
  90         gpio_rcar_write(p, INTMSK, ~BIT(irqd_to_hwirq(d)));
  91 }
  92
  93 static void gpio_rcar_irq_enable(struct irq_data *d)
  94 {
  95         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
  96         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
  97                                                 gpio_chip);
  98
  99         gpio_rcar_write(p, MSKCLR, BIT(irqd_to_hwirq(d)));
 100 }
 101
 102 static void gpio_rcar_config_interrupt_input_mode(struct gpio_rcar_priv *p,
 103                                                   unsigned int hwirq,
 104                                                   bool active_high_rising_edge,
 105                                                   bool level_trigger,
 106                                                   bool both)
 107 {
 108         unsigned long flags;
 109
 110         /* follow steps in the GPIO documentation for
 111          * "Setting Edge-Sensitive Interrupt Input Mode" and
 112          * "Setting Level-Sensitive Interrupt Input Mode"
 113          */
 114
 115         spin_lock_irqsave(&p->lock, flags);
 116
 117         /* Configure postive or negative logic in POSNEG */
 118         gpio_rcar_modify_bit(p, POSNEG, hwirq, !active_high_rising_edge);
 119
 120         /* Configure edge or level trigger in EDGLEVEL */
 121         gpio_rcar_modify_bit(p, EDGLEVEL, hwirq, !level_trigger);
 122
 123         /* Select one edge or both edges in BOTHEDGE */
 124         if (p->config.has_both_edge_trigger)
 125                 gpio_rcar_modify_bit(p, BOTHEDGE, hwirq, both);
 126
 127         /* Select "Interrupt Input Mode" in IOINTSEL */
 128         gpio_rcar_modify_bit(p, IOINTSEL, hwirq, true);
 129
 130         /* Write INTCLR in case of edge trigger */
 131         if (!level_trigger)
 132                 gpio_rcar_write(p, INTCLR, BIT(hwirq));
 133
 134         spin_unlock_irqrestore(&p->lock, flags);
 135 }
 136
 137 static int gpio_rcar_irq_set_type(struct irq_data *d, unsigned int type)
 138 {
 139         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 140         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
 141                                                 gpio_chip);
 142         unsigned int hwirq = irqd_to_hwirq(d);
 143
 144         dev_dbg(&p->pdev->dev, "sense irq = %d, type = %d\n", hwirq, type);
 145
 146         switch (type & IRQ_TYPE_SENSE_MASK) {
 147         case IRQ_TYPE_LEVEL_HIGH:
 148                 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, true,
 149                                                       false);
 150                 break;
 151         case IRQ_TYPE_LEVEL_LOW:
 152                 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, true,
 153                                                       false);
 154                 break;
 155         case IRQ_TYPE_EDGE_RISING:
 156                 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
 157                                                       false);
 158                 break;
 159         case IRQ_TYPE_EDGE_FALLING:
 160                 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, false,
 161                                                       false);
 162                 break;
 163         case IRQ_TYPE_EDGE_BOTH:
 164                 if (!p->config.has_both_edge_trigger)
 165                         return -EINVAL;
 166                 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
 167                                                       true);
 168                 break;
 169         default:
 170                 return -EINVAL;
 171         }
 172         return 0;
 173 }
 174
 175 static int gpio_rcar_irq_set_wake(struct irq_data *d, unsigned int on)
 176 {
 177         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 178         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
 179                                                 gpio_chip);
 180         int error;
 181
 182         if (p->irq_parent) {
 183                 error = irq_set_irq_wake(p->irq_parent, on);
 184                 if (error) {
 185                         dev_dbg(&p->pdev->dev,
 186                                 "irq %u doesn't support irq_set_wake\n",
 187                                 p->irq_parent);
 188                         p->irq_parent = 0;
 189                 }
 190         }
 191
 192         if (!p->clk)
 193                 return 0;
 194
 195         if (on)
 196                 clk_enable(p->clk);
 197         else
 198                 clk_disable(p->clk);
 199
 200         return 0;
 201 }
 202
 203 static void gpio_rcar_irq_bus_lock(struct irq_data *d)
 204 {
 205         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 206         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
 207                                                 gpio_chip);
 208
 209         pm_runtime_get_sync(&p->pdev->dev);
 210 }
 211
 212 static void gpio_rcar_irq_bus_sync_unlock(struct irq_data *d)
 213 {
 214         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 215         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
 216                                                 gpio_chip);
 217
 218         pm_runtime_put(&p->pdev->dev);
 219 }
 220
 221
 222 static int gpio_rcar_irq_request_resources(struct irq_data *d)
 223 {
 224         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 225         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
 226                                                 gpio_chip);
 227         int error;
 228
 229         error = pm_runtime_get_sync(&p->pdev->dev);
 230         if (error < 0)
 231                 return error;
 232
 233         return 0;
 234 }
 235
 236 static void gpio_rcar_irq_release_resources(struct irq_data *d)
 237 {
 238         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 239         struct gpio_rcar_priv *p = container_of(gc, struct gpio_rcar_priv,
 240                                                 gpio_chip);
 241
 242         pm_runtime_put(&p->pdev->dev);
 243 }
 244
 245 static irqreturn_t gpio_rcar_irq_handler(int irq, void *dev_id)
 246 {
 247         struct gpio_rcar_priv *p = dev_id;
 248         u32 pending;
 249         unsigned int offset, irqs_handled = 0;
 250
 251         while ((pending = gpio_rcar_read(p, INTDT) &
 252                           gpio_rcar_read(p, INTMSK))) {
 253                 offset = __ffs(pending);
 254                 gpio_rcar_write(p, INTCLR, BIT(offset));
 255                 generic_handle_irq(irq_find_mapping(p->gpio_chip.irqdomain,
 256                                                     offset));
 257                 irqs_handled++;
 258         }
 259
 260         return irqs_handled ? IRQ_HANDLED : IRQ_NONE;
 261 }
 262
 263 static inline struct gpio_rcar_priv *gpio_to_priv(struct gpio_chip *chip)
 264 {
 265         return container_of(chip, struct gpio_rcar_priv, gpio_chip);
 266 }
 267
 268 static void gpio_rcar_config_general_input_output_mode(struct gpio_chip *chip,
 269                                                        unsigned int gpio,
 270                                                        bool output)
 271 {
 272         struct gpio_rcar_priv *p = gpio_to_priv(chip);
 273         unsigned long flags;
 274
 275         /* follow steps in the GPIO documentation for
 276          * "Setting General Output Mode" and
 277          * "Setting General Input Mode"
 278          */
 279
 280         spin_lock_irqsave(&p->lock, flags);
 281
 282         /* Configure postive logic in POSNEG */
 283         gpio_rcar_modify_bit(p, POSNEG, gpio, false);
 284
 285         /* Select "General Input/Output Mode" in IOINTSEL */
 286         gpio_rcar_modify_bit(p, IOINTSEL, gpio, false);
 287
 288         /* Select Input Mode or Output Mode in INOUTSEL */
 289         gpio_rcar_modify_bit(p, INOUTSEL, gpio, output);
 290
 291         spin_unlock_irqrestore(&p->lock, flags);
 292 }
 293
 294 static int gpio_rcar_request(struct gpio_chip *chip, unsigned offset)
 295 {
 296         struct gpio_rcar_priv *p = gpio_to_priv(chip);
 297         int error;
 298
 299         error = pm_runtime_get_sync(&p->pdev->dev);
 300         if (error < 0)
 301                 return error;
 302
 303         error = pinctrl_request_gpio(chip->base + offset);
 304         if (error)
 305                 pm_runtime_put(&p->pdev->dev);
 306
 307         return error;
 308 }
 309
 310 static void gpio_rcar_free(struct gpio_chip *chip, unsigned offset)
 311 {
 312         struct gpio_rcar_priv *p = gpio_to_priv(chip);
 313
 314         pinctrl_free_gpio(chip->base + offset);
 315
 316         /* Set the GPIO as an input to ensure that the next GPIO request won't
 317          * drive the GPIO pin as an output.
 318          */
 319         gpio_rcar_config_general_input_output_mode(chip, offset, false);
 320
 321         pm_runtime_put(&p->pdev->dev);
 322 }
 323
 324 static int gpio_rcar_direction_input(struct gpio_chip *chip, unsigned offset)
 325 {
 326         gpio_rcar_config_general_input_output_mode(chip, offset, false);
 327         return 0;
 328 }
 329
 330 static int gpio_rcar_get(struct gpio_chip *chip, unsigned offset)
 331 {
 332         u32 bit = BIT(offset);
 333
 334         /* testing on r8a7790 shows that INDT does not show correct pin state
 335          * when configured as output, so use OUTDT in case of output pins */
 336         if (gpio_rcar_read(gpio_to_priv(chip), INOUTSEL) & bit)
 337                 return !!(gpio_rcar_read(gpio_to_priv(chip), OUTDT) & bit);
 338         else
 339                 return !!(gpio_rcar_read(gpio_to_priv(chip), INDT) & bit);
 340 }
 341
 342 static void gpio_rcar_set(struct gpio_chip *chip, unsigned offset, int value)
 343 {
 344         struct gpio_rcar_priv *p = gpio_to_priv(chip);
 345         unsigned long flags;
 346
 347         spin_lock_irqsave(&p->lock, flags);
 348         gpio_rcar_modify_bit(p, OUTDT, offset, value);
 349         spin_unlock_irqrestore(&p->lock, flags);
 350 }
 351
 352 static int gpio_rcar_direction_output(struct gpio_chip *chip, unsigned offset,
 353                                       int value)
 354 {
 355         /* write GPIO value to output before selecting output mode of pin */
 356         gpio_rcar_set(chip, offset, value);
 357         gpio_rcar_config_general_input_output_mode(chip, offset, true);
 358         return 0;
 359 }
 360
 361 struct gpio_rcar_info {
 362         bool has_both_edge_trigger;
 363 };
 364
 365 static const struct gpio_rcar_info gpio_rcar_info_gen1 = {
 366         .has_both_edge_trigger = false,
 367 };
 368
 369 static const struct gpio_rcar_info gpio_rcar_info_gen2 = {
 370         .has_both_edge_trigger = true,
 371 };
 372
 373 static const struct of_device_id gpio_rcar_of_table[] = {
 374         {
 375                 .compatible = "renesas,gpio-r8a7790",
 376                 .data = &gpio_rcar_info_gen2,
 377         }, {
 378                 .compatible = "renesas,gpio-r8a7791",
 379                 .data = &gpio_rcar_info_gen2,
 380         }, {
 381                 .compatible = "renesas,gpio-r8a7793",
 382                 .data = &gpio_rcar_info_gen2,
 383         }, {
 384                 .compatible = "renesas,gpio-r8a7794",
 385                 .data = &gpio_rcar_info_gen2,
 386         }, {
 387                 .compatible = "renesas,gpio-r8a7795",
 388                 /* Gen3 GPIO is identical to Gen2. */
 389                 .data = &gpio_rcar_info_gen2,
 390         }, {
 391                 .compatible = "renesas,gpio-rcar",
 392                 .data = &gpio_rcar_info_gen1,
 393         }, {
 394                 /* Terminator */
 395         },
 396 };
 397
 398 MODULE_DEVICE_TABLE(of, gpio_rcar_of_table);
 399
 400 static int gpio_rcar_parse_pdata(struct gpio_rcar_priv *p)
 401 {
 402         struct gpio_rcar_config *pdata = dev_get_platdata(&p->pdev->dev);
 403         struct device_node *np = p->pdev->dev.of_node;
 404         struct of_phandle_args args;
 405         int ret;
 406
 407         if (pdata) {
 408                 p->config = *pdata;
 409         } else if (IS_ENABLED(CONFIG_OF) && np) {
 410                 const struct of_device_id *match;
 411                 const struct gpio_rcar_info *info;
 412
 413                 match = of_match_node(gpio_rcar_of_table, np);
 414                 if (!match)
 415                         return -EINVAL;
 416
 417                 info = match->data;
 418
 419                 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 0,
 420                                                        &args);
 421                 p->config.number_of_pins = ret == 0 ? args.args[2]
 422                                          : RCAR_MAX_GPIO_PER_BANK;
 423                 p->config.gpio_base = -1;
 424                 p->config.has_both_edge_trigger = info->has_both_edge_trigger;
 425         }
 426
 427         if (p->config.number_of_pins == 0 ||
 428             p->config.number_of_pins > RCAR_MAX_GPIO_PER_BANK) {
 429                 dev_warn(&p->pdev->dev,
 430                          "Invalid number of gpio lines %u, using %u\n",
 431                          p->config.number_of_pins, RCAR_MAX_GPIO_PER_BANK);
 432                 p->config.number_of_pins = RCAR_MAX_GPIO_PER_BANK;
 433         }
 434
 435         return 0;
 436 }
 437
 438 static int gpio_rcar_probe(struct platform_device *pdev)
 439 {
 440         struct gpio_rcar_priv *p;
 441         struct resource *io, *irq;
 442         struct gpio_chip *gpio_chip;
 443         struct irq_chip *irq_chip;
 444         struct device *dev = &pdev->dev;
 445         const char *name = dev_name(dev);
 446         int ret;
 447
 448         p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
 449         if (!p)
 450                 return -ENOMEM;
 451
 452         p->pdev = pdev;
 453         spin_lock_init(&p->lock);
 454
 455         /* Get device configuration from DT node or platform data. */
 456         ret = gpio_rcar_parse_pdata(p);
 457         if (ret < 0)
 458                 return ret;
 459
 460         platform_set_drvdata(pdev, p);
 461
 462         p->clk = devm_clk_get(dev, NULL);
 463         if (IS_ERR(p->clk)) {
 464                 dev_warn(dev, "unable to get clock\n");
 465                 p->clk = NULL;
 466         }
 467
 468         pm_runtime_enable(dev);
 469
 470         io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 471         irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 472
 473         if (!io || !irq) {
 474                 dev_err(dev, "missing IRQ or IOMEM\n");
 475                 ret = -EINVAL;
 476                 goto err0;
 477         }
 478
 479         p->base = devm_ioremap_nocache(dev, io->start, resource_size(io));
 480         if (!p->base) {
 481                 dev_err(dev, "failed to remap I/O memory\n");
 482                 ret = -ENXIO;
 483                 goto err0;
 484         }
 485
 486         gpio_chip = &p->gpio_chip;
 487         gpio_chip->request = gpio_rcar_request;
 488         gpio_chip->free = gpio_rcar_free;
 489         gpio_chip->direction_input = gpio_rcar_direction_input;
 490         gpio_chip->get = gpio_rcar_get;
 491         gpio_chip->direction_output = gpio_rcar_direction_output;
 492         gpio_chip->set = gpio_rcar_set;
 493         gpio_chip->label = name;
 494         gpio_chip->dev = dev;
 495         gpio_chip->owner = THIS_MODULE;
 496         gpio_chip->base = p->config.gpio_base;
 497         gpio_chip->ngpio = p->config.number_of_pins;
 498
 499         irq_chip = &p->irq_chip;
 500         irq_chip->name = name;
 501         irq_chip->irq_mask = gpio_rcar_irq_disable;
 502         irq_chip->irq_unmask = gpio_rcar_irq_enable;
 503         irq_chip->irq_set_type = gpio_rcar_irq_set_type;
 504         irq_chip->irq_set_wake = gpio_rcar_irq_set_wake;
 505         irq_chip->irq_bus_lock = gpio_rcar_irq_bus_lock;
 506         irq_chip->irq_bus_sync_unlock = gpio_rcar_irq_bus_sync_unlock;
 507         irq_chip->irq_request_resources = gpio_rcar_irq_request_resources;
 508         irq_chip->irq_release_resources = gpio_rcar_irq_release_resources;
 509         irq_chip->flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_MASK_ON_SUSPEND;
 510
 511         ret = gpiochip_add(gpio_chip);
 512         if (ret) {
 513                 dev_err(dev, "failed to add GPIO controller\n");
 514                 goto err0;
 515         }
 516
 517         ret = gpiochip_irqchip_add(gpio_chip, irq_chip, p->config.irq_base,
 518                                    handle_level_irq, IRQ_TYPE_NONE);
 519         if (ret) {
 520                 dev_err(dev, "cannot add irqchip\n");
 521                 goto err1;
 522         }
 523
 524         p->irq_parent = irq->start;
 525         if (devm_request_irq(dev, irq->start, gpio_rcar_irq_handler,
 526                              IRQF_SHARED, name, p)) {
 527                 dev_err(dev, "failed to request IRQ\n");
 528                 ret = -ENOENT;
 529                 goto err1;
 530         }
 531
 532         dev_info(dev, "driving %d GPIOs\n", p->config.number_of_pins);
 533
 534         /* warn in case of mismatch if irq base is specified */
 535         if (p->config.irq_base) {
 536                 ret = irq_find_mapping(gpio_chip->irqdomain, 0);
 537                 if (p->config.irq_base != ret)
 538                         dev_warn(dev, "irq base mismatch (%u/%u)\n",
 539                                  p->config.irq_base, ret);
 540         }
 541
 542         if (p->config.pctl_name) {
 543                 ret = gpiochip_add_pin_range(gpio_chip, p->config.pctl_name, 0,
 544                                              gpio_chip->base, gpio_chip->ngpio);
 545                 if (ret < 0)
 546                         dev_warn(dev, "failed to add pin range\n");
 547         }
 548
 549         return 0;
 550
 551 err1:
 552         gpiochip_remove(gpio_chip);
 553 err0:
 554         pm_runtime_disable(dev);
 555         return ret;
 556 }
 557
 558 static int gpio_rcar_remove(struct platform_device *pdev)
 559 {
 560         struct gpio_rcar_priv *p = platform_get_drvdata(pdev);
 561
 562         gpiochip_remove(&p->gpio_chip);
 563
 564         pm_runtime_disable(&pdev->dev);
 565         return 0;
 566 }
 567
 568 static struct platform_driver gpio_rcar_device_driver = {
 569         .probe          = gpio_rcar_probe,
 570         .remove         = gpio_rcar_remove,
 571         .driver         = {
 572                 .name   = "gpio_rcar",
 573                 .of_match_table = of_match_ptr(gpio_rcar_of_table),
 574         }
 575 };
 576
 577 module_platform_driver(gpio_rcar_device_driver);
 578
 579 MODULE_AUTHOR("Magnus Damm");
 580 MODULE_DESCRIPTION("Renesas R-Car GPIO Driver");
 581 MODULE_LICENSE("GPL v2");