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_device.h>
  29 #include <linux/pm_runtime.h>
  30 #include <linux/spinlock.h>
  31 #include <linux/slab.h>
  32
  33 struct gpio_rcar_priv {
  34         void __iomem *base;
  35         spinlock_t lock;
  36         struct platform_device *pdev;
  37         struct gpio_chip gpio_chip;
  38         struct irq_chip irq_chip;
  39         struct clk *clk;
  40         unsigned int irq_parent;
  41         bool has_both_edge_trigger;
  42         bool needs_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 = gpiochip_get_data(gc);
  88
  89         gpio_rcar_write(p, INTMSK, ~BIT(irqd_to_hwirq(d)));
  90 }
  91
  92 static void gpio_rcar_irq_enable(struct irq_data *d)
  93 {
  94         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
  95         struct gpio_rcar_priv *p = gpiochip_get_data(gc);
  96
  97         gpio_rcar_write(p, MSKCLR, BIT(irqd_to_hwirq(d)));
  98 }
  99
 100 static void gpio_rcar_config_interrupt_input_mode(struct gpio_rcar_priv *p,
 101                                                   unsigned int hwirq,
 102                                                   bool active_high_rising_edge,
 103                                                   bool level_trigger,
 104                                                   bool both)
 105 {
 106         unsigned long flags;
 107
 108         /* follow steps in the GPIO documentation for
 109          * "Setting Edge-Sensitive Interrupt Input Mode" and
 110          * "Setting Level-Sensitive Interrupt Input Mode"
 111          */
 112
 113         spin_lock_irqsave(&p->lock, flags);
 114
 115         /* Configure postive or negative logic in POSNEG */
 116         gpio_rcar_modify_bit(p, POSNEG, hwirq, !active_high_rising_edge);
 117
 118         /* Configure edge or level trigger in EDGLEVEL */
 119         gpio_rcar_modify_bit(p, EDGLEVEL, hwirq, !level_trigger);
 120
 121         /* Select one edge or both edges in BOTHEDGE */
 122         if (p->has_both_edge_trigger)
 123                 gpio_rcar_modify_bit(p, BOTHEDGE, hwirq, both);
 124
 125         /* Select "Interrupt Input Mode" in IOINTSEL */
 126         gpio_rcar_modify_bit(p, IOINTSEL, hwirq, true);
 127
 128         /* Write INTCLR in case of edge trigger */
 129         if (!level_trigger)
 130                 gpio_rcar_write(p, INTCLR, BIT(hwirq));
 131
 132         spin_unlock_irqrestore(&p->lock, flags);
 133 }
 134
 135 static int gpio_rcar_irq_set_type(struct irq_data *d, unsigned int type)
 136 {
 137         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 138         struct gpio_rcar_priv *p = gpiochip_get_data(gc);
 139         unsigned int hwirq = irqd_to_hwirq(d);
 140
 141         dev_dbg(&p->pdev->dev, "sense irq = %d, type = %d\n", hwirq, type);
 142
 143         switch (type & IRQ_TYPE_SENSE_MASK) {
 144         case IRQ_TYPE_LEVEL_HIGH:
 145                 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, true,
 146                                                       false);
 147                 break;
 148         case IRQ_TYPE_LEVEL_LOW:
 149                 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, true,
 150                                                       false);
 151                 break;
 152         case IRQ_TYPE_EDGE_RISING:
 153                 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
 154                                                       false);
 155                 break;
 156         case IRQ_TYPE_EDGE_FALLING:
 157                 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, false,
 158                                                       false);
 159                 break;
 160         case IRQ_TYPE_EDGE_BOTH:
 161                 if (!p->has_both_edge_trigger)
 162                         return -EINVAL;
 163                 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false,
 164                                                       true);
 165                 break;
 166         default:
 167                 return -EINVAL;
 168         }
 169         return 0;
 170 }
 171
 172 static int gpio_rcar_irq_set_wake(struct irq_data *d, unsigned int on)
 173 {
 174         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 175         struct gpio_rcar_priv *p = gpiochip_get_data(gc);
 176         int error;
 177
 178         if (p->irq_parent) {
 179                 error = irq_set_irq_wake(p->irq_parent, on);
 180                 if (error) {
 181                         dev_dbg(&p->pdev->dev,
 182                                 "irq %u doesn't support irq_set_wake\n",
 183                                 p->irq_parent);
 184                         p->irq_parent = 0;
 185                 }
 186         }
 187
 188         if (!p->clk)
 189                 return 0;
 190
 191         if (on)
 192                 clk_enable(p->clk);
 193         else
 194                 clk_disable(p->clk);
 195
 196         return 0;
 197 }
 198
 199 static irqreturn_t gpio_rcar_irq_handler(int irq, void *dev_id)
 200 {
 201         struct gpio_rcar_priv *p = dev_id;
 202         u32 pending;
 203         unsigned int offset, irqs_handled = 0;
 204
 205         while ((pending = gpio_rcar_read(p, INTDT) &
 206                           gpio_rcar_read(p, INTMSK))) {
 207                 offset = __ffs(pending);
 208                 gpio_rcar_write(p, INTCLR, BIT(offset));
 209                 generic_handle_irq(irq_find_mapping(p->gpio_chip.irqdomain,
 210                                                     offset));
 211                 irqs_handled++;
 212         }
 213
 214         return irqs_handled ? IRQ_HANDLED : IRQ_NONE;
 215 }
 216
 217 static void gpio_rcar_config_general_input_output_mode(struct gpio_chip *chip,
 218                                                        unsigned int gpio,
 219                                                        bool output)
 220 {
 221         struct gpio_rcar_priv *p = gpiochip_get_data(chip);
 222         unsigned long flags;
 223
 224         /* follow steps in the GPIO documentation for
 225          * "Setting General Output Mode" and
 226          * "Setting General Input Mode"
 227          */
 228
 229         spin_lock_irqsave(&p->lock, flags);
 230
 231         /* Configure postive logic in POSNEG */
 232         gpio_rcar_modify_bit(p, POSNEG, gpio, false);
 233
 234         /* Select "General Input/Output Mode" in IOINTSEL */
 235         gpio_rcar_modify_bit(p, IOINTSEL, gpio, false);
 236
 237         /* Select Input Mode or Output Mode in INOUTSEL */
 238         gpio_rcar_modify_bit(p, INOUTSEL, gpio, output);
 239
 240         spin_unlock_irqrestore(&p->lock, flags);
 241 }
 242
 243 static int gpio_rcar_request(struct gpio_chip *chip, unsigned offset)
 244 {
 245         struct gpio_rcar_priv *p = gpiochip_get_data(chip);
 246         int error;
 247
 248         error = pm_runtime_get_sync(&p->pdev->dev);
 249         if (error < 0)
 250                 return error;
 251
 252         error = pinctrl_request_gpio(chip->base + offset);
 253         if (error)
 254                 pm_runtime_put(&p->pdev->dev);
 255
 256         return error;
 257 }
 258
 259 static void gpio_rcar_free(struct gpio_chip *chip, unsigned offset)
 260 {
 261         struct gpio_rcar_priv *p = gpiochip_get_data(chip);
 262
 263         pinctrl_free_gpio(chip->base + offset);
 264
 265         /*
 266          * Set the GPIO as an input to ensure that the next GPIO request won't
 267          * drive the GPIO pin as an output.
 268          */
 269         gpio_rcar_config_general_input_output_mode(chip, offset, false);
 270
 271         pm_runtime_put(&p->pdev->dev);
 272 }
 273
 274 static int gpio_rcar_direction_input(struct gpio_chip *chip, unsigned offset)
 275 {
 276         gpio_rcar_config_general_input_output_mode(chip, offset, false);
 277         return 0;
 278 }
 279
 280 static int gpio_rcar_get(struct gpio_chip *chip, unsigned offset)
 281 {
 282         u32 bit = BIT(offset);
 283
 284         /* testing on r8a7790 shows that INDT does not show correct pin state
 285          * when configured as output, so use OUTDT in case of output pins */
 286         if (gpio_rcar_read(gpiochip_get_data(chip), INOUTSEL) & bit)
 287                 return !!(gpio_rcar_read(gpiochip_get_data(chip), OUTDT) & bit);
 288         else
 289                 return !!(gpio_rcar_read(gpiochip_get_data(chip), INDT) & bit);
 290 }
 291
 292 static void gpio_rcar_set(struct gpio_chip *chip, unsigned offset, int value)
 293 {
 294         struct gpio_rcar_priv *p = gpiochip_get_data(chip);
 295         unsigned long flags;
 296
 297         spin_lock_irqsave(&p->lock, flags);
 298         gpio_rcar_modify_bit(p, OUTDT, offset, value);
 299         spin_unlock_irqrestore(&p->lock, flags);
 300 }
 301
 302 static void gpio_rcar_set_multiple(struct gpio_chip *chip, unsigned long *mask,
 303                                    unsigned long *bits)
 304 {
 305         struct gpio_rcar_priv *p = gpiochip_get_data(chip);
 306         unsigned long flags;
 307         u32 val, bankmask;
 308
 309         bankmask = mask[0] & GENMASK(chip->ngpio - 1, 0);
 310         if (!bankmask)
 311                 return;
 312
 313         spin_lock_irqsave(&p->lock, flags);
 314         val = gpio_rcar_read(p, OUTDT);
 315         val &= ~bankmask;
 316         val |= (bankmask & bits[0]);
 317         gpio_rcar_write(p, OUTDT, val);
 318         spin_unlock_irqrestore(&p->lock, flags);
 319 }
 320
 321 static int gpio_rcar_direction_output(struct gpio_chip *chip, unsigned offset,
 322                                       int value)
 323 {
 324         /* write GPIO value to output before selecting output mode of pin */
 325         gpio_rcar_set(chip, offset, value);
 326         gpio_rcar_config_general_input_output_mode(chip, offset, true);
 327         return 0;
 328 }
 329
 330 struct gpio_rcar_info {
 331         bool has_both_edge_trigger;
 332         bool needs_clk;
 333 };
 334
 335 static const struct gpio_rcar_info gpio_rcar_info_gen1 = {
 336         .has_both_edge_trigger = false,
 337         .needs_clk = false,
 338 };
 339
 340 static const struct gpio_rcar_info gpio_rcar_info_gen2 = {
 341         .has_both_edge_trigger = true,
 342         .needs_clk = true,
 343 };
 344
 345 static const struct of_device_id gpio_rcar_of_table[] = {
 346         {
 347                 .compatible = "renesas,gpio-r8a7743",
 348                 /* RZ/G1 GPIO is identical to R-Car Gen2. */
 349                 .data = &gpio_rcar_info_gen2,
 350         }, {
 351                 .compatible = "renesas,gpio-r8a7790",
 352                 .data = &gpio_rcar_info_gen2,
 353         }, {
 354                 .compatible = "renesas,gpio-r8a7791",
 355                 .data = &gpio_rcar_info_gen2,
 356         }, {
 357                 .compatible = "renesas,gpio-r8a7792",
 358                 .data = &gpio_rcar_info_gen2,
 359         }, {
 360                 .compatible = "renesas,gpio-r8a7793",
 361                 .data = &gpio_rcar_info_gen2,
 362         }, {
 363                 .compatible = "renesas,gpio-r8a7794",
 364                 .data = &gpio_rcar_info_gen2,
 365         }, {
 366                 .compatible = "renesas,gpio-r8a7795",
 367                 /* Gen3 GPIO is identical to Gen2. */
 368                 .data = &gpio_rcar_info_gen2,
 369         }, {
 370                 .compatible = "renesas,gpio-r8a7796",
 371                 /* Gen3 GPIO is identical to Gen2. */
 372                 .data = &gpio_rcar_info_gen2,
 373         }, {
 374                 .compatible = "renesas,rcar-gen1-gpio",
 375                 .data = &gpio_rcar_info_gen1,
 376         }, {
 377                 .compatible = "renesas,rcar-gen2-gpio",
 378                 .data = &gpio_rcar_info_gen2,
 379         }, {
 380                 .compatible = "renesas,rcar-gen3-gpio",
 381                 /* Gen3 GPIO is identical to Gen2. */
 382                 .data = &gpio_rcar_info_gen2,
 383         }, {
 384                 .compatible = "renesas,gpio-rcar",
 385                 .data = &gpio_rcar_info_gen1,
 386         }, {
 387                 /* Terminator */
 388         },
 389 };
 390
 391 MODULE_DEVICE_TABLE(of, gpio_rcar_of_table);
 392
 393 static int gpio_rcar_parse_dt(struct gpio_rcar_priv *p, unsigned int *npins)
 394 {
 395         struct device_node *np = p->pdev->dev.of_node;
 396         const struct of_device_id *match;
 397         const struct gpio_rcar_info *info;
 398         struct of_phandle_args args;
 399         int ret;
 400
 401         match = of_match_node(gpio_rcar_of_table, np);
 402         if (!match)
 403                 return -EINVAL;
 404
 405         info = match->data;
 406
 407         ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 0, &args);
 408         *npins = ret == 0 ? args.args[2] : RCAR_MAX_GPIO_PER_BANK;
 409         p->has_both_edge_trigger = info->has_both_edge_trigger;
 410         p->needs_clk = info->needs_clk;
 411
 412         if (*npins == 0 || *npins > RCAR_MAX_GPIO_PER_BANK) {
 413                 dev_warn(&p->pdev->dev,
 414                          "Invalid number of gpio lines %u, using %u\n", *npins,
 415                          RCAR_MAX_GPIO_PER_BANK);
 416                 *npins = RCAR_MAX_GPIO_PER_BANK;
 417         }
 418
 419         return 0;
 420 }
 421
 422 static int gpio_rcar_probe(struct platform_device *pdev)
 423 {
 424         struct gpio_rcar_priv *p;
 425         struct resource *io, *irq;
 426         struct gpio_chip *gpio_chip;
 427         struct irq_chip *irq_chip;
 428         struct device *dev = &pdev->dev;
 429         const char *name = dev_name(dev);
 430         unsigned int npins;
 431         int ret;
 432
 433         p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
 434         if (!p)
 435                 return -ENOMEM;
 436
 437         p->pdev = pdev;
 438         spin_lock_init(&p->lock);
 439
 440         /* Get device configuration from DT node */
 441         ret = gpio_rcar_parse_dt(p, &npins);
 442         if (ret < 0)
 443                 return ret;
 444
 445         platform_set_drvdata(pdev, p);
 446
 447         p->clk = devm_clk_get(dev, NULL);
 448         if (IS_ERR(p->clk)) {
 449                 if (p->needs_clk) {
 450                         dev_err(dev, "unable to get clock\n");
 451                         ret = PTR_ERR(p->clk);
 452                         goto err0;
 453                 }
 454                 p->clk = NULL;
 455         }
 456
 457         pm_runtime_enable(dev);
 458
 459         io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 460         irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 461
 462         if (!io || !irq) {
 463                 dev_err(dev, "missing IRQ or IOMEM\n");
 464                 ret = -EINVAL;
 465                 goto err0;
 466         }
 467
 468         p->base = devm_ioremap_nocache(dev, io->start, resource_size(io));
 469         if (!p->base) {
 470                 dev_err(dev, "failed to remap I/O memory\n");
 471                 ret = -ENXIO;
 472                 goto err0;
 473         }
 474
 475         gpio_chip = &p->gpio_chip;
 476         gpio_chip->request = gpio_rcar_request;
 477         gpio_chip->free = gpio_rcar_free;
 478         gpio_chip->direction_input = gpio_rcar_direction_input;
 479         gpio_chip->get = gpio_rcar_get;
 480         gpio_chip->direction_output = gpio_rcar_direction_output;
 481         gpio_chip->set = gpio_rcar_set;
 482         gpio_chip->set_multiple = gpio_rcar_set_multiple;
 483         gpio_chip->label = name;
 484         gpio_chip->parent = dev;
 485         gpio_chip->owner = THIS_MODULE;
 486         gpio_chip->base = -1;
 487         gpio_chip->ngpio = npins;
 488
 489         irq_chip = &p->irq_chip;
 490         irq_chip->name = name;
 491         irq_chip->parent_device = dev;
 492         irq_chip->irq_mask = gpio_rcar_irq_disable;
 493         irq_chip->irq_unmask = gpio_rcar_irq_enable;
 494         irq_chip->irq_set_type = gpio_rcar_irq_set_type;
 495         irq_chip->irq_set_wake = gpio_rcar_irq_set_wake;
 496         irq_chip->flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_MASK_ON_SUSPEND;
 497
 498         ret = gpiochip_add_data(gpio_chip, p);
 499         if (ret) {
 500                 dev_err(dev, "failed to add GPIO controller\n");
 501                 goto err0;
 502         }
 503
 504         ret = gpiochip_irqchip_add(gpio_chip, irq_chip, 0, handle_level_irq,
 505                                    IRQ_TYPE_NONE);
 506         if (ret) {
 507                 dev_err(dev, "cannot add irqchip\n");
 508                 goto err1;
 509         }
 510
 511         p->irq_parent = irq->start;
 512         if (devm_request_irq(dev, irq->start, gpio_rcar_irq_handler,
 513                              IRQF_SHARED, name, p)) {
 514                 dev_err(dev, "failed to request IRQ\n");
 515                 ret = -ENOENT;
 516                 goto err1;
 517         }
 518
 519         dev_info(dev, "driving %d GPIOs\n", npins);
 520
 521         return 0;
 522
 523 err1:
 524         gpiochip_remove(gpio_chip);
 525 err0:
 526         pm_runtime_disable(dev);
 527         return ret;
 528 }
 529
 530 static int gpio_rcar_remove(struct platform_device *pdev)
 531 {
 532         struct gpio_rcar_priv *p = platform_get_drvdata(pdev);
 533
 534         gpiochip_remove(&p->gpio_chip);
 535
 536         pm_runtime_disable(&pdev->dev);
 537         return 0;
 538 }
 539
 540 static struct platform_driver gpio_rcar_device_driver = {
 541         .probe          = gpio_rcar_probe,
 542         .remove         = gpio_rcar_remove,
 543         .driver         = {
 544                 .name   = "gpio_rcar",
 545                 .of_match_table = of_match_ptr(gpio_rcar_of_table),
 546         }
 547 };
 548
 549 module_platform_driver(gpio_rcar_device_driver);
 550
 551 MODULE_AUTHOR("Magnus Damm");
 552 MODULE_DESCRIPTION("Renesas R-Car GPIO Driver");
 553 MODULE_LICENSE("GPL v2");