1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Renesas R-Car GPIO Support 4 * 5 * Copyright (C) 2014 Renesas Electronics Corporation 6 * Copyright (C) 2013 Magnus Damm 7 */ 8 9 #include <linux/err.h> 10 #include <linux/gpio/driver.h> 11 #include <linux/init.h> 12 #include <linux/interrupt.h> 13 #include <linux/io.h> 14 #include <linux/ioport.h> 15 #include <linux/irq.h> 16 #include <linux/module.h> 17 #include <linux/of.h> 18 #include <linux/of_device.h> 19 #include <linux/pinctrl/consumer.h> 20 #include <linux/platform_device.h> 21 #include <linux/pm_runtime.h> 22 #include <linux/spinlock.h> 23 #include <linux/slab.h> 24 25 struct gpio_rcar_bank_info { 26 u32 iointsel; 27 u32 inoutsel; 28 u32 outdt; 29 u32 posneg; 30 u32 edglevel; 31 u32 bothedge; 32 u32 intmsk; 33 }; 34 35 struct gpio_rcar_info { 36 bool has_outdtsel; 37 bool has_both_edge_trigger; 38 bool has_always_in; 39 bool has_inen; 40 }; 41 42 struct gpio_rcar_priv { 43 void __iomem *base; 44 spinlock_t lock; 45 struct device *dev; 46 struct gpio_chip gpio_chip; 47 struct irq_chip irq_chip; 48 unsigned int irq_parent; 49 atomic_t wakeup_path; 50 struct gpio_rcar_info info; 51 struct gpio_rcar_bank_info bank_info; 52 }; 53 54 #define IOINTSEL 0x00 /* General IO/Interrupt Switching Register */ 55 #define INOUTSEL 0x04 /* General Input/Output Switching Register */ 56 #define OUTDT 0x08 /* General Output Register */ 57 #define INDT 0x0c /* General Input Register */ 58 #define INTDT 0x10 /* Interrupt Display Register */ 59 #define INTCLR 0x14 /* Interrupt Clear Register */ 60 #define INTMSK 0x18 /* Interrupt Mask Register */ 61 #define MSKCLR 0x1c /* Interrupt Mask Clear Register */ 62 #define POSNEG 0x20 /* Positive/Negative Logic Select Register */ 63 #define EDGLEVEL 0x24 /* Edge/level Select Register */ 64 #define FILONOFF 0x28 /* Chattering Prevention On/Off Register */ 65 #define OUTDTSEL 0x40 /* Output Data Select Register */ 66 #define BOTHEDGE 0x4c /* One Edge/Both Edge Select Register */ 67 #define INEN 0x50 /* General Input Enable Register */ 68 69 #define RCAR_MAX_GPIO_PER_BANK 32 70 71 static inline u32 gpio_rcar_read(struct gpio_rcar_priv *p, int offs) 72 { 73 return ioread32(p->base + offs); 74 } 75 76 static inline void gpio_rcar_write(struct gpio_rcar_priv *p, int offs, 77 u32 value) 78 { 79 iowrite32(value, p->base + offs); 80 } 81 82 static void gpio_rcar_modify_bit(struct gpio_rcar_priv *p, int offs, 83 int bit, bool value) 84 { 85 u32 tmp = gpio_rcar_read(p, offs); 86 87 if (value) 88 tmp |= BIT(bit); 89 else 90 tmp &= ~BIT(bit); 91 92 gpio_rcar_write(p, offs, tmp); 93 } 94 95 static void gpio_rcar_irq_disable(struct irq_data *d) 96 { 97 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 98 struct gpio_rcar_priv *p = gpiochip_get_data(gc); 99 100 gpio_rcar_write(p, INTMSK, ~BIT(irqd_to_hwirq(d))); 101 } 102 103 static void gpio_rcar_irq_enable(struct irq_data *d) 104 { 105 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 106 struct gpio_rcar_priv *p = gpiochip_get_data(gc); 107 108 gpio_rcar_write(p, MSKCLR, BIT(irqd_to_hwirq(d))); 109 } 110 111 static void gpio_rcar_config_interrupt_input_mode(struct gpio_rcar_priv *p, 112 unsigned int hwirq, 113 bool active_high_rising_edge, 114 bool level_trigger, 115 bool both) 116 { 117 unsigned long flags; 118 119 /* follow steps in the GPIO documentation for 120 * "Setting Edge-Sensitive Interrupt Input Mode" and 121 * "Setting Level-Sensitive Interrupt Input Mode" 122 */ 123 124 spin_lock_irqsave(&p->lock, flags); 125 126 /* Configure positive or negative logic in POSNEG */ 127 gpio_rcar_modify_bit(p, POSNEG, hwirq, !active_high_rising_edge); 128 129 /* Configure edge or level trigger in EDGLEVEL */ 130 gpio_rcar_modify_bit(p, EDGLEVEL, hwirq, !level_trigger); 131 132 /* Select one edge or both edges in BOTHEDGE */ 133 if (p->info.has_both_edge_trigger) 134 gpio_rcar_modify_bit(p, BOTHEDGE, hwirq, both); 135 136 /* Select "Interrupt Input Mode" in IOINTSEL */ 137 gpio_rcar_modify_bit(p, IOINTSEL, hwirq, true); 138 139 /* Write INTCLR in case of edge trigger */ 140 if (!level_trigger) 141 gpio_rcar_write(p, INTCLR, BIT(hwirq)); 142 143 spin_unlock_irqrestore(&p->lock, flags); 144 } 145 146 static int gpio_rcar_irq_set_type(struct irq_data *d, unsigned int type) 147 { 148 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 149 struct gpio_rcar_priv *p = gpiochip_get_data(gc); 150 unsigned int hwirq = irqd_to_hwirq(d); 151 152 dev_dbg(p->dev, "sense irq = %d, type = %d\n", hwirq, type); 153 154 switch (type & IRQ_TYPE_SENSE_MASK) { 155 case IRQ_TYPE_LEVEL_HIGH: 156 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, true, 157 false); 158 break; 159 case IRQ_TYPE_LEVEL_LOW: 160 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, true, 161 false); 162 break; 163 case IRQ_TYPE_EDGE_RISING: 164 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false, 165 false); 166 break; 167 case IRQ_TYPE_EDGE_FALLING: 168 gpio_rcar_config_interrupt_input_mode(p, hwirq, false, false, 169 false); 170 break; 171 case IRQ_TYPE_EDGE_BOTH: 172 if (!p->info.has_both_edge_trigger) 173 return -EINVAL; 174 gpio_rcar_config_interrupt_input_mode(p, hwirq, true, false, 175 true); 176 break; 177 default: 178 return -EINVAL; 179 } 180 return 0; 181 } 182 183 static int gpio_rcar_irq_set_wake(struct irq_data *d, unsigned int on) 184 { 185 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 186 struct gpio_rcar_priv *p = gpiochip_get_data(gc); 187 int error; 188 189 if (p->irq_parent) { 190 error = irq_set_irq_wake(p->irq_parent, on); 191 if (error) { 192 dev_dbg(p->dev, "irq %u doesn't support irq_set_wake\n", 193 p->irq_parent); 194 p->irq_parent = 0; 195 } 196 } 197 198 if (on) 199 atomic_inc(&p->wakeup_path); 200 else 201 atomic_dec(&p->wakeup_path); 202 203 return 0; 204 } 205 206 static irqreturn_t gpio_rcar_irq_handler(int irq, void *dev_id) 207 { 208 struct gpio_rcar_priv *p = dev_id; 209 u32 pending; 210 unsigned int offset, irqs_handled = 0; 211 212 while ((pending = gpio_rcar_read(p, INTDT) & 213 gpio_rcar_read(p, INTMSK))) { 214 offset = __ffs(pending); 215 gpio_rcar_write(p, INTCLR, BIT(offset)); 216 generic_handle_domain_irq(p->gpio_chip.irq.domain, 217 offset); 218 irqs_handled++; 219 } 220 221 return irqs_handled ? IRQ_HANDLED : IRQ_NONE; 222 } 223 224 static void gpio_rcar_config_general_input_output_mode(struct gpio_chip *chip, 225 unsigned int gpio, 226 bool output) 227 { 228 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 229 unsigned long flags; 230 231 /* follow steps in the GPIO documentation for 232 * "Setting General Output Mode" and 233 * "Setting General Input Mode" 234 */ 235 236 spin_lock_irqsave(&p->lock, flags); 237 238 /* Configure positive logic in POSNEG */ 239 gpio_rcar_modify_bit(p, POSNEG, gpio, false); 240 241 /* Select "General Input/Output Mode" in IOINTSEL */ 242 gpio_rcar_modify_bit(p, IOINTSEL, gpio, false); 243 244 /* Select Input Mode or Output Mode in INOUTSEL */ 245 gpio_rcar_modify_bit(p, INOUTSEL, gpio, output); 246 247 /* Select General Output Register to output data in OUTDTSEL */ 248 if (p->info.has_outdtsel && output) 249 gpio_rcar_modify_bit(p, OUTDTSEL, gpio, false); 250 251 spin_unlock_irqrestore(&p->lock, flags); 252 } 253 254 static int gpio_rcar_request(struct gpio_chip *chip, unsigned offset) 255 { 256 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 257 int error; 258 259 error = pm_runtime_get_sync(p->dev); 260 if (error < 0) { 261 pm_runtime_put(p->dev); 262 return error; 263 } 264 265 error = pinctrl_gpio_request(chip->base + offset); 266 if (error) 267 pm_runtime_put(p->dev); 268 269 return error; 270 } 271 272 static void gpio_rcar_free(struct gpio_chip *chip, unsigned offset) 273 { 274 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 275 276 pinctrl_gpio_free(chip->base + offset); 277 278 /* 279 * Set the GPIO as an input to ensure that the next GPIO request won't 280 * drive the GPIO pin as an output. 281 */ 282 gpio_rcar_config_general_input_output_mode(chip, offset, false); 283 284 pm_runtime_put(p->dev); 285 } 286 287 static int gpio_rcar_get_direction(struct gpio_chip *chip, unsigned int offset) 288 { 289 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 290 291 if (gpio_rcar_read(p, INOUTSEL) & BIT(offset)) 292 return GPIO_LINE_DIRECTION_OUT; 293 294 return GPIO_LINE_DIRECTION_IN; 295 } 296 297 static int gpio_rcar_direction_input(struct gpio_chip *chip, unsigned offset) 298 { 299 gpio_rcar_config_general_input_output_mode(chip, offset, false); 300 return 0; 301 } 302 303 static int gpio_rcar_get(struct gpio_chip *chip, unsigned offset) 304 { 305 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 306 u32 bit = BIT(offset); 307 308 /* 309 * Before R-Car Gen3, INDT does not show correct pin state when 310 * configured as output, so use OUTDT in case of output pins 311 */ 312 if (!p->info.has_always_in && (gpio_rcar_read(p, INOUTSEL) & bit)) 313 return !!(gpio_rcar_read(p, OUTDT) & bit); 314 else 315 return !!(gpio_rcar_read(p, INDT) & bit); 316 } 317 318 static int gpio_rcar_get_multiple(struct gpio_chip *chip, unsigned long *mask, 319 unsigned long *bits) 320 { 321 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 322 u32 bankmask, outputs, m, val = 0; 323 unsigned long flags; 324 325 bankmask = mask[0] & GENMASK(chip->ngpio - 1, 0); 326 if (chip->valid_mask) 327 bankmask &= chip->valid_mask[0]; 328 329 if (!bankmask) 330 return 0; 331 332 if (p->info.has_always_in) { 333 bits[0] = gpio_rcar_read(p, INDT) & bankmask; 334 return 0; 335 } 336 337 spin_lock_irqsave(&p->lock, flags); 338 outputs = gpio_rcar_read(p, INOUTSEL); 339 m = outputs & bankmask; 340 if (m) 341 val |= gpio_rcar_read(p, OUTDT) & m; 342 343 m = ~outputs & bankmask; 344 if (m) 345 val |= gpio_rcar_read(p, INDT) & m; 346 spin_unlock_irqrestore(&p->lock, flags); 347 348 bits[0] = val; 349 return 0; 350 } 351 352 static void gpio_rcar_set(struct gpio_chip *chip, unsigned offset, int value) 353 { 354 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 355 unsigned long flags; 356 357 spin_lock_irqsave(&p->lock, flags); 358 gpio_rcar_modify_bit(p, OUTDT, offset, value); 359 spin_unlock_irqrestore(&p->lock, flags); 360 } 361 362 static void gpio_rcar_set_multiple(struct gpio_chip *chip, unsigned long *mask, 363 unsigned long *bits) 364 { 365 struct gpio_rcar_priv *p = gpiochip_get_data(chip); 366 unsigned long flags; 367 u32 val, bankmask; 368 369 bankmask = mask[0] & GENMASK(chip->ngpio - 1, 0); 370 if (chip->valid_mask) 371 bankmask &= chip->valid_mask[0]; 372 373 if (!bankmask) 374 return; 375 376 spin_lock_irqsave(&p->lock, flags); 377 val = gpio_rcar_read(p, OUTDT); 378 val &= ~bankmask; 379 val |= (bankmask & bits[0]); 380 gpio_rcar_write(p, OUTDT, val); 381 spin_unlock_irqrestore(&p->lock, flags); 382 } 383 384 static int gpio_rcar_direction_output(struct gpio_chip *chip, unsigned offset, 385 int value) 386 { 387 /* write GPIO value to output before selecting output mode of pin */ 388 gpio_rcar_set(chip, offset, value); 389 gpio_rcar_config_general_input_output_mode(chip, offset, true); 390 return 0; 391 } 392 393 static const struct gpio_rcar_info gpio_rcar_info_gen1 = { 394 .has_outdtsel = false, 395 .has_both_edge_trigger = false, 396 .has_always_in = false, 397 .has_inen = false, 398 }; 399 400 static const struct gpio_rcar_info gpio_rcar_info_gen2 = { 401 .has_outdtsel = true, 402 .has_both_edge_trigger = true, 403 .has_always_in = false, 404 .has_inen = false, 405 }; 406 407 static const struct gpio_rcar_info gpio_rcar_info_gen3 = { 408 .has_outdtsel = true, 409 .has_both_edge_trigger = true, 410 .has_always_in = true, 411 .has_inen = false, 412 }; 413 414 static const struct gpio_rcar_info gpio_rcar_info_v3u = { 415 .has_outdtsel = true, 416 .has_both_edge_trigger = true, 417 .has_always_in = true, 418 .has_inen = true, 419 }; 420 421 static const struct of_device_id gpio_rcar_of_table[] = { 422 { 423 .compatible = "renesas,gpio-r8a779a0", 424 .data = &gpio_rcar_info_v3u, 425 }, { 426 .compatible = "renesas,rcar-gen1-gpio", 427 .data = &gpio_rcar_info_gen1, 428 }, { 429 .compatible = "renesas,rcar-gen2-gpio", 430 .data = &gpio_rcar_info_gen2, 431 }, { 432 .compatible = "renesas,rcar-gen3-gpio", 433 .data = &gpio_rcar_info_gen3, 434 }, { 435 .compatible = "renesas,gpio-rcar", 436 .data = &gpio_rcar_info_gen1, 437 }, { 438 /* Terminator */ 439 }, 440 }; 441 442 MODULE_DEVICE_TABLE(of, gpio_rcar_of_table); 443 444 static int gpio_rcar_parse_dt(struct gpio_rcar_priv *p, unsigned int *npins) 445 { 446 struct device_node *np = p->dev->of_node; 447 const struct gpio_rcar_info *info; 448 struct of_phandle_args args; 449 int ret; 450 451 info = of_device_get_match_data(p->dev); 452 p->info = *info; 453 454 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 0, &args); 455 *npins = ret == 0 ? args.args[2] : RCAR_MAX_GPIO_PER_BANK; 456 457 if (*npins == 0 || *npins > RCAR_MAX_GPIO_PER_BANK) { 458 dev_warn(p->dev, "Invalid number of gpio lines %u, using %u\n", 459 *npins, RCAR_MAX_GPIO_PER_BANK); 460 *npins = RCAR_MAX_GPIO_PER_BANK; 461 } 462 463 return 0; 464 } 465 466 static void gpio_rcar_enable_inputs(struct gpio_rcar_priv *p) 467 { 468 u32 mask = GENMASK(p->gpio_chip.ngpio - 1, 0); 469 470 /* Select "Input Enable" in INEN */ 471 if (p->gpio_chip.valid_mask) 472 mask &= p->gpio_chip.valid_mask[0]; 473 if (mask) 474 gpio_rcar_write(p, INEN, gpio_rcar_read(p, INEN) | mask); 475 } 476 477 static int gpio_rcar_probe(struct platform_device *pdev) 478 { 479 struct gpio_rcar_priv *p; 480 struct gpio_chip *gpio_chip; 481 struct irq_chip *irq_chip; 482 struct gpio_irq_chip *girq; 483 struct device *dev = &pdev->dev; 484 const char *name = dev_name(dev); 485 unsigned int npins; 486 int ret; 487 488 p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL); 489 if (!p) 490 return -ENOMEM; 491 492 p->dev = dev; 493 spin_lock_init(&p->lock); 494 495 /* Get device configuration from DT node */ 496 ret = gpio_rcar_parse_dt(p, &npins); 497 if (ret < 0) 498 return ret; 499 500 platform_set_drvdata(pdev, p); 501 502 pm_runtime_enable(dev); 503 504 ret = platform_get_irq(pdev, 0); 505 if (ret < 0) 506 goto err0; 507 p->irq_parent = ret; 508 509 p->base = devm_platform_ioremap_resource(pdev, 0); 510 if (IS_ERR(p->base)) { 511 ret = PTR_ERR(p->base); 512 goto err0; 513 } 514 515 gpio_chip = &p->gpio_chip; 516 gpio_chip->request = gpio_rcar_request; 517 gpio_chip->free = gpio_rcar_free; 518 gpio_chip->get_direction = gpio_rcar_get_direction; 519 gpio_chip->direction_input = gpio_rcar_direction_input; 520 gpio_chip->get = gpio_rcar_get; 521 gpio_chip->get_multiple = gpio_rcar_get_multiple; 522 gpio_chip->direction_output = gpio_rcar_direction_output; 523 gpio_chip->set = gpio_rcar_set; 524 gpio_chip->set_multiple = gpio_rcar_set_multiple; 525 gpio_chip->label = name; 526 gpio_chip->parent = dev; 527 gpio_chip->owner = THIS_MODULE; 528 gpio_chip->base = -1; 529 gpio_chip->ngpio = npins; 530 531 irq_chip = &p->irq_chip; 532 irq_chip->name = "gpio-rcar"; 533 irq_chip->irq_mask = gpio_rcar_irq_disable; 534 irq_chip->irq_unmask = gpio_rcar_irq_enable; 535 irq_chip->irq_set_type = gpio_rcar_irq_set_type; 536 irq_chip->irq_set_wake = gpio_rcar_irq_set_wake; 537 irq_chip->flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_MASK_ON_SUSPEND; 538 539 girq = &gpio_chip->irq; 540 girq->chip = irq_chip; 541 /* This will let us handle the parent IRQ in the driver */ 542 girq->parent_handler = NULL; 543 girq->num_parents = 0; 544 girq->parents = NULL; 545 girq->default_type = IRQ_TYPE_NONE; 546 girq->handler = handle_level_irq; 547 548 ret = gpiochip_add_data(gpio_chip, p); 549 if (ret) { 550 dev_err(dev, "failed to add GPIO controller\n"); 551 goto err0; 552 } 553 554 irq_domain_set_pm_device(gpio_chip->irq.domain, dev); 555 ret = devm_request_irq(dev, p->irq_parent, gpio_rcar_irq_handler, 556 IRQF_SHARED, name, p); 557 if (ret) { 558 dev_err(dev, "failed to request IRQ\n"); 559 goto err1; 560 } 561 562 if (p->info.has_inen) { 563 pm_runtime_get_sync(dev); 564 gpio_rcar_enable_inputs(p); 565 pm_runtime_put(dev); 566 } 567 568 dev_info(dev, "driving %d GPIOs\n", npins); 569 570 return 0; 571 572 err1: 573 gpiochip_remove(gpio_chip); 574 err0: 575 pm_runtime_disable(dev); 576 return ret; 577 } 578 579 static int gpio_rcar_remove(struct platform_device *pdev) 580 { 581 struct gpio_rcar_priv *p = platform_get_drvdata(pdev); 582 583 gpiochip_remove(&p->gpio_chip); 584 585 pm_runtime_disable(&pdev->dev); 586 return 0; 587 } 588 589 #ifdef CONFIG_PM_SLEEP 590 static int gpio_rcar_suspend(struct device *dev) 591 { 592 struct gpio_rcar_priv *p = dev_get_drvdata(dev); 593 594 p->bank_info.iointsel = gpio_rcar_read(p, IOINTSEL); 595 p->bank_info.inoutsel = gpio_rcar_read(p, INOUTSEL); 596 p->bank_info.outdt = gpio_rcar_read(p, OUTDT); 597 p->bank_info.intmsk = gpio_rcar_read(p, INTMSK); 598 p->bank_info.posneg = gpio_rcar_read(p, POSNEG); 599 p->bank_info.edglevel = gpio_rcar_read(p, EDGLEVEL); 600 if (p->info.has_both_edge_trigger) 601 p->bank_info.bothedge = gpio_rcar_read(p, BOTHEDGE); 602 603 if (atomic_read(&p->wakeup_path)) 604 device_set_wakeup_path(dev); 605 606 return 0; 607 } 608 609 static int gpio_rcar_resume(struct device *dev) 610 { 611 struct gpio_rcar_priv *p = dev_get_drvdata(dev); 612 unsigned int offset; 613 u32 mask; 614 615 for (offset = 0; offset < p->gpio_chip.ngpio; offset++) { 616 if (!gpiochip_line_is_valid(&p->gpio_chip, offset)) 617 continue; 618 619 mask = BIT(offset); 620 /* I/O pin */ 621 if (!(p->bank_info.iointsel & mask)) { 622 if (p->bank_info.inoutsel & mask) 623 gpio_rcar_direction_output( 624 &p->gpio_chip, offset, 625 !!(p->bank_info.outdt & mask)); 626 else 627 gpio_rcar_direction_input(&p->gpio_chip, 628 offset); 629 } else { 630 /* Interrupt pin */ 631 gpio_rcar_config_interrupt_input_mode( 632 p, 633 offset, 634 !(p->bank_info.posneg & mask), 635 !(p->bank_info.edglevel & mask), 636 !!(p->bank_info.bothedge & mask)); 637 638 if (p->bank_info.intmsk & mask) 639 gpio_rcar_write(p, MSKCLR, mask); 640 } 641 } 642 643 if (p->info.has_inen) 644 gpio_rcar_enable_inputs(p); 645 646 return 0; 647 } 648 #endif /* CONFIG_PM_SLEEP*/ 649 650 static SIMPLE_DEV_PM_OPS(gpio_rcar_pm_ops, gpio_rcar_suspend, gpio_rcar_resume); 651 652 static struct platform_driver gpio_rcar_device_driver = { 653 .probe = gpio_rcar_probe, 654 .remove = gpio_rcar_remove, 655 .driver = { 656 .name = "gpio_rcar", 657 .pm = &gpio_rcar_pm_ops, 658 .of_match_table = of_match_ptr(gpio_rcar_of_table), 659 } 660 }; 661 662 module_platform_driver(gpio_rcar_device_driver); 663 664 MODULE_AUTHOR("Magnus Damm"); 665 MODULE_DESCRIPTION("Renesas R-Car GPIO Driver"); 666 MODULE_LICENSE("GPL v2"); 667