1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Pin Control and GPIO driver for SuperH Pin Function Controller. 4 * 5 * Authors: Magnus Damm, Paul Mundt, Laurent Pinchart 6 * 7 * Copyright (C) 2008 Magnus Damm 8 * Copyright (C) 2009 - 2012 Paul Mundt 9 */ 10 11 #define DRV_NAME "sh-pfc" 12 13 #include <linux/bitops.h> 14 #include <linux/err.h> 15 #include <linux/errno.h> 16 #include <linux/io.h> 17 #include <linux/ioport.h> 18 #include <linux/kernel.h> 19 #include <linux/init.h> 20 #include <linux/of.h> 21 #include <linux/of_device.h> 22 #include <linux/pinctrl/machine.h> 23 #include <linux/platform_device.h> 24 #include <linux/psci.h> 25 #include <linux/slab.h> 26 #include <linux/sys_soc.h> 27 28 #include "core.h" 29 30 static int sh_pfc_map_resources(struct sh_pfc *pfc, 31 struct platform_device *pdev) 32 { 33 struct sh_pfc_window *windows; 34 unsigned int *irqs = NULL; 35 unsigned int num_windows; 36 struct resource *res; 37 unsigned int i; 38 int num_irqs; 39 40 /* Count the MEM and IRQ resources. */ 41 for (num_windows = 0;; num_windows++) { 42 res = platform_get_resource(pdev, IORESOURCE_MEM, num_windows); 43 if (!res) 44 break; 45 } 46 if (num_windows == 0) 47 return -EINVAL; 48 49 num_irqs = platform_irq_count(pdev); 50 if (num_irqs < 0) 51 return num_irqs; 52 53 /* Allocate memory windows and IRQs arrays. */ 54 windows = devm_kcalloc(pfc->dev, num_windows, sizeof(*windows), 55 GFP_KERNEL); 56 if (windows == NULL) 57 return -ENOMEM; 58 59 pfc->num_windows = num_windows; 60 pfc->windows = windows; 61 62 if (num_irqs) { 63 irqs = devm_kcalloc(pfc->dev, num_irqs, sizeof(*irqs), 64 GFP_KERNEL); 65 if (irqs == NULL) 66 return -ENOMEM; 67 68 pfc->num_irqs = num_irqs; 69 pfc->irqs = irqs; 70 } 71 72 /* Fill them. */ 73 for (i = 0; i < num_windows; i++) { 74 res = platform_get_resource(pdev, IORESOURCE_MEM, i); 75 windows->phys = res->start; 76 windows->size = resource_size(res); 77 windows->virt = devm_ioremap_resource(pfc->dev, res); 78 if (IS_ERR(windows->virt)) 79 return -ENOMEM; 80 windows++; 81 } 82 for (i = 0; i < num_irqs; i++) 83 *irqs++ = platform_get_irq(pdev, i); 84 85 return 0; 86 } 87 88 static void __iomem *sh_pfc_phys_to_virt(struct sh_pfc *pfc, u32 reg) 89 { 90 struct sh_pfc_window *window; 91 phys_addr_t address = reg; 92 unsigned int i; 93 94 /* scan through physical windows and convert address */ 95 for (i = 0; i < pfc->num_windows; i++) { 96 window = pfc->windows + i; 97 98 if (address < window->phys) 99 continue; 100 101 if (address >= (window->phys + window->size)) 102 continue; 103 104 return window->virt + (address - window->phys); 105 } 106 107 BUG(); 108 return NULL; 109 } 110 111 int sh_pfc_get_pin_index(struct sh_pfc *pfc, unsigned int pin) 112 { 113 unsigned int offset; 114 unsigned int i; 115 116 for (i = 0, offset = 0; i < pfc->nr_ranges; ++i) { 117 const struct sh_pfc_pin_range *range = &pfc->ranges[i]; 118 119 if (pin <= range->end) 120 return pin >= range->start 121 ? offset + pin - range->start : -1; 122 123 offset += range->end - range->start + 1; 124 } 125 126 return -EINVAL; 127 } 128 129 static int sh_pfc_enum_in_range(u16 enum_id, const struct pinmux_range *r) 130 { 131 if (enum_id < r->begin) 132 return 0; 133 134 if (enum_id > r->end) 135 return 0; 136 137 return 1; 138 } 139 140 u32 sh_pfc_read_raw_reg(void __iomem *mapped_reg, unsigned int reg_width) 141 { 142 switch (reg_width) { 143 case 8: 144 return ioread8(mapped_reg); 145 case 16: 146 return ioread16(mapped_reg); 147 case 32: 148 return ioread32(mapped_reg); 149 } 150 151 BUG(); 152 return 0; 153 } 154 155 void sh_pfc_write_raw_reg(void __iomem *mapped_reg, unsigned int reg_width, 156 u32 data) 157 { 158 switch (reg_width) { 159 case 8: 160 iowrite8(data, mapped_reg); 161 return; 162 case 16: 163 iowrite16(data, mapped_reg); 164 return; 165 case 32: 166 iowrite32(data, mapped_reg); 167 return; 168 } 169 170 BUG(); 171 } 172 173 u32 sh_pfc_read(struct sh_pfc *pfc, u32 reg) 174 { 175 return sh_pfc_read_raw_reg(sh_pfc_phys_to_virt(pfc, reg), 32); 176 } 177 178 static void sh_pfc_unlock_reg(struct sh_pfc *pfc, u32 reg, u32 data) 179 { 180 u32 unlock; 181 182 if (!pfc->info->unlock_reg) 183 return; 184 185 if (pfc->info->unlock_reg >= 0x80000000UL) 186 unlock = pfc->info->unlock_reg; 187 else 188 /* unlock_reg is a mask */ 189 unlock = reg & ~pfc->info->unlock_reg; 190 191 sh_pfc_write_raw_reg(sh_pfc_phys_to_virt(pfc, unlock), 32, ~data); 192 } 193 194 void sh_pfc_write(struct sh_pfc *pfc, u32 reg, u32 data) 195 { 196 sh_pfc_unlock_reg(pfc, reg, data); 197 sh_pfc_write_raw_reg(sh_pfc_phys_to_virt(pfc, reg), 32, data); 198 } 199 200 static void sh_pfc_config_reg_helper(struct sh_pfc *pfc, 201 const struct pinmux_cfg_reg *crp, 202 unsigned int in_pos, 203 void __iomem **mapped_regp, u32 *maskp, 204 unsigned int *posp) 205 { 206 unsigned int k; 207 208 *mapped_regp = sh_pfc_phys_to_virt(pfc, crp->reg); 209 210 if (crp->field_width) { 211 *maskp = (1 << crp->field_width) - 1; 212 *posp = crp->reg_width - ((in_pos + 1) * crp->field_width); 213 } else { 214 *maskp = (1 << crp->var_field_width[in_pos]) - 1; 215 *posp = crp->reg_width; 216 for (k = 0; k <= in_pos; k++) 217 *posp -= crp->var_field_width[k]; 218 } 219 } 220 221 static void sh_pfc_write_config_reg(struct sh_pfc *pfc, 222 const struct pinmux_cfg_reg *crp, 223 unsigned int field, u32 value) 224 { 225 void __iomem *mapped_reg; 226 unsigned int pos; 227 u32 mask, data; 228 229 sh_pfc_config_reg_helper(pfc, crp, field, &mapped_reg, &mask, &pos); 230 231 dev_dbg(pfc->dev, "write_reg addr = %x, value = 0x%x, field = %u, " 232 "r_width = %u, f_width = %u\n", 233 crp->reg, value, field, crp->reg_width, hweight32(mask)); 234 235 mask = ~(mask << pos); 236 value = value << pos; 237 238 data = sh_pfc_read_raw_reg(mapped_reg, crp->reg_width); 239 data &= mask; 240 data |= value; 241 242 sh_pfc_unlock_reg(pfc, crp->reg, data); 243 sh_pfc_write_raw_reg(mapped_reg, crp->reg_width, data); 244 } 245 246 static int sh_pfc_get_config_reg(struct sh_pfc *pfc, u16 enum_id, 247 const struct pinmux_cfg_reg **crp, 248 unsigned int *fieldp, u32 *valuep) 249 { 250 unsigned int k = 0; 251 252 while (1) { 253 const struct pinmux_cfg_reg *config_reg = 254 pfc->info->cfg_regs + k; 255 unsigned int r_width = config_reg->reg_width; 256 unsigned int f_width = config_reg->field_width; 257 unsigned int curr_width; 258 unsigned int bit_pos; 259 unsigned int pos = 0; 260 unsigned int m = 0; 261 262 if (!r_width) 263 break; 264 265 for (bit_pos = 0; bit_pos < r_width; bit_pos += curr_width) { 266 u32 ncomb; 267 u32 n; 268 269 if (f_width) 270 curr_width = f_width; 271 else 272 curr_width = config_reg->var_field_width[m]; 273 274 ncomb = 1 << curr_width; 275 for (n = 0; n < ncomb; n++) { 276 if (config_reg->enum_ids[pos + n] == enum_id) { 277 *crp = config_reg; 278 *fieldp = m; 279 *valuep = n; 280 return 0; 281 } 282 } 283 pos += ncomb; 284 m++; 285 } 286 k++; 287 } 288 289 return -EINVAL; 290 } 291 292 static int sh_pfc_mark_to_enum(struct sh_pfc *pfc, u16 mark, int pos, 293 u16 *enum_idp) 294 { 295 const u16 *data = pfc->info->pinmux_data; 296 unsigned int k; 297 298 if (pos) { 299 *enum_idp = data[pos + 1]; 300 return pos + 1; 301 } 302 303 for (k = 0; k < pfc->info->pinmux_data_size; k++) { 304 if (data[k] == mark) { 305 *enum_idp = data[k + 1]; 306 return k + 1; 307 } 308 } 309 310 dev_err(pfc->dev, "cannot locate data/mark enum_id for mark %d\n", 311 mark); 312 return -EINVAL; 313 } 314 315 int sh_pfc_config_mux(struct sh_pfc *pfc, unsigned mark, int pinmux_type) 316 { 317 const struct pinmux_range *range; 318 int pos = 0; 319 320 switch (pinmux_type) { 321 case PINMUX_TYPE_GPIO: 322 case PINMUX_TYPE_FUNCTION: 323 range = NULL; 324 break; 325 326 #ifdef CONFIG_PINCTRL_SH_PFC_GPIO 327 case PINMUX_TYPE_OUTPUT: 328 range = &pfc->info->output; 329 break; 330 331 case PINMUX_TYPE_INPUT: 332 range = &pfc->info->input; 333 break; 334 #endif /* CONFIG_PINCTRL_SH_PFC_GPIO */ 335 336 default: 337 return -EINVAL; 338 } 339 340 /* Iterate over all the configuration fields we need to update. */ 341 while (1) { 342 const struct pinmux_cfg_reg *cr; 343 unsigned int field; 344 u16 enum_id; 345 u32 value; 346 int in_range; 347 int ret; 348 349 pos = sh_pfc_mark_to_enum(pfc, mark, pos, &enum_id); 350 if (pos < 0) 351 return pos; 352 353 if (!enum_id) 354 break; 355 356 /* Check if the configuration field selects a function. If it 357 * doesn't, skip the field if it's not applicable to the 358 * requested pinmux type. 359 */ 360 in_range = sh_pfc_enum_in_range(enum_id, &pfc->info->function); 361 if (!in_range) { 362 if (pinmux_type == PINMUX_TYPE_FUNCTION) { 363 /* Functions are allowed to modify all 364 * fields. 365 */ 366 in_range = 1; 367 } else if (pinmux_type != PINMUX_TYPE_GPIO) { 368 /* Input/output types can only modify fields 369 * that correspond to their respective ranges. 370 */ 371 in_range = sh_pfc_enum_in_range(enum_id, range); 372 373 /* 374 * special case pass through for fixed 375 * input-only or output-only pins without 376 * function enum register association. 377 */ 378 if (in_range && enum_id == range->force) 379 continue; 380 } 381 /* GPIOs are only allowed to modify function fields. */ 382 } 383 384 if (!in_range) 385 continue; 386 387 ret = sh_pfc_get_config_reg(pfc, enum_id, &cr, &field, &value); 388 if (ret < 0) 389 return ret; 390 391 sh_pfc_write_config_reg(pfc, cr, field, value); 392 } 393 394 return 0; 395 } 396 397 static int sh_pfc_init_ranges(struct sh_pfc *pfc) 398 { 399 struct sh_pfc_pin_range *range; 400 unsigned int nr_ranges; 401 unsigned int i; 402 403 if (pfc->info->pins[0].pin == (u16)-1) { 404 /* Pin number -1 denotes that the SoC doesn't report pin numbers 405 * in its pin arrays yet. Consider the pin numbers range as 406 * continuous and allocate a single range. 407 */ 408 pfc->nr_ranges = 1; 409 pfc->ranges = devm_kzalloc(pfc->dev, sizeof(*pfc->ranges), 410 GFP_KERNEL); 411 if (pfc->ranges == NULL) 412 return -ENOMEM; 413 414 pfc->ranges->start = 0; 415 pfc->ranges->end = pfc->info->nr_pins - 1; 416 pfc->nr_gpio_pins = pfc->info->nr_pins; 417 418 return 0; 419 } 420 421 /* Count, allocate and fill the ranges. The PFC SoC data pins array must 422 * be sorted by pin numbers, and pins without a GPIO port must come 423 * last. 424 */ 425 for (i = 1, nr_ranges = 1; i < pfc->info->nr_pins; ++i) { 426 if (pfc->info->pins[i-1].pin != pfc->info->pins[i].pin - 1) 427 nr_ranges++; 428 } 429 430 pfc->nr_ranges = nr_ranges; 431 pfc->ranges = devm_kcalloc(pfc->dev, nr_ranges, sizeof(*pfc->ranges), 432 GFP_KERNEL); 433 if (pfc->ranges == NULL) 434 return -ENOMEM; 435 436 range = pfc->ranges; 437 range->start = pfc->info->pins[0].pin; 438 439 for (i = 1; i < pfc->info->nr_pins; ++i) { 440 if (pfc->info->pins[i-1].pin == pfc->info->pins[i].pin - 1) 441 continue; 442 443 range->end = pfc->info->pins[i-1].pin; 444 if (!(pfc->info->pins[i-1].configs & SH_PFC_PIN_CFG_NO_GPIO)) 445 pfc->nr_gpio_pins = range->end + 1; 446 447 range++; 448 range->start = pfc->info->pins[i].pin; 449 } 450 451 range->end = pfc->info->pins[i-1].pin; 452 if (!(pfc->info->pins[i-1].configs & SH_PFC_PIN_CFG_NO_GPIO)) 453 pfc->nr_gpio_pins = range->end + 1; 454 455 return 0; 456 } 457 458 #ifdef CONFIG_OF 459 static const struct of_device_id sh_pfc_of_table[] = { 460 #ifdef CONFIG_PINCTRL_PFC_EMEV2 461 { 462 .compatible = "renesas,pfc-emev2", 463 .data = &emev2_pinmux_info, 464 }, 465 #endif 466 #ifdef CONFIG_PINCTRL_PFC_R8A73A4 467 { 468 .compatible = "renesas,pfc-r8a73a4", 469 .data = &r8a73a4_pinmux_info, 470 }, 471 #endif 472 #ifdef CONFIG_PINCTRL_PFC_R8A7740 473 { 474 .compatible = "renesas,pfc-r8a7740", 475 .data = &r8a7740_pinmux_info, 476 }, 477 #endif 478 #ifdef CONFIG_PINCTRL_PFC_R8A7742 479 { 480 .compatible = "renesas,pfc-r8a7742", 481 .data = &r8a7742_pinmux_info, 482 }, 483 #endif 484 #ifdef CONFIG_PINCTRL_PFC_R8A7743 485 { 486 .compatible = "renesas,pfc-r8a7743", 487 .data = &r8a7743_pinmux_info, 488 }, 489 #endif 490 #ifdef CONFIG_PINCTRL_PFC_R8A7744 491 { 492 .compatible = "renesas,pfc-r8a7744", 493 .data = &r8a7744_pinmux_info, 494 }, 495 #endif 496 #ifdef CONFIG_PINCTRL_PFC_R8A7745 497 { 498 .compatible = "renesas,pfc-r8a7745", 499 .data = &r8a7745_pinmux_info, 500 }, 501 #endif 502 #ifdef CONFIG_PINCTRL_PFC_R8A77470 503 { 504 .compatible = "renesas,pfc-r8a77470", 505 .data = &r8a77470_pinmux_info, 506 }, 507 #endif 508 #ifdef CONFIG_PINCTRL_PFC_R8A774A1 509 { 510 .compatible = "renesas,pfc-r8a774a1", 511 .data = &r8a774a1_pinmux_info, 512 }, 513 #endif 514 #ifdef CONFIG_PINCTRL_PFC_R8A774B1 515 { 516 .compatible = "renesas,pfc-r8a774b1", 517 .data = &r8a774b1_pinmux_info, 518 }, 519 #endif 520 #ifdef CONFIG_PINCTRL_PFC_R8A774C0 521 { 522 .compatible = "renesas,pfc-r8a774c0", 523 .data = &r8a774c0_pinmux_info, 524 }, 525 #endif 526 #ifdef CONFIG_PINCTRL_PFC_R8A774E1 527 { 528 .compatible = "renesas,pfc-r8a774e1", 529 .data = &r8a774e1_pinmux_info, 530 }, 531 #endif 532 #ifdef CONFIG_PINCTRL_PFC_R8A7778 533 { 534 .compatible = "renesas,pfc-r8a7778", 535 .data = &r8a7778_pinmux_info, 536 }, 537 #endif 538 #ifdef CONFIG_PINCTRL_PFC_R8A7779 539 { 540 .compatible = "renesas,pfc-r8a7779", 541 .data = &r8a7779_pinmux_info, 542 }, 543 #endif 544 #ifdef CONFIG_PINCTRL_PFC_R8A7790 545 { 546 .compatible = "renesas,pfc-r8a7790", 547 .data = &r8a7790_pinmux_info, 548 }, 549 #endif 550 #ifdef CONFIG_PINCTRL_PFC_R8A7791 551 { 552 .compatible = "renesas,pfc-r8a7791", 553 .data = &r8a7791_pinmux_info, 554 }, 555 #endif 556 #ifdef CONFIG_PINCTRL_PFC_R8A7792 557 { 558 .compatible = "renesas,pfc-r8a7792", 559 .data = &r8a7792_pinmux_info, 560 }, 561 #endif 562 #ifdef CONFIG_PINCTRL_PFC_R8A7793 563 { 564 .compatible = "renesas,pfc-r8a7793", 565 .data = &r8a7793_pinmux_info, 566 }, 567 #endif 568 #ifdef CONFIG_PINCTRL_PFC_R8A7794 569 { 570 .compatible = "renesas,pfc-r8a7794", 571 .data = &r8a7794_pinmux_info, 572 }, 573 #endif 574 /* 575 * Both r8a7795 entries must be present to make sanity checks work, but only 576 * the first entry is actually used. 577 * R-Car H3 ES1.x is matched using soc_device_match() instead. 578 */ 579 #ifdef CONFIG_PINCTRL_PFC_R8A77951 580 { 581 .compatible = "renesas,pfc-r8a7795", 582 .data = &r8a77951_pinmux_info, 583 }, 584 #endif 585 #ifdef CONFIG_PINCTRL_PFC_R8A77950 586 { 587 .compatible = "renesas,pfc-r8a7795", 588 .data = &r8a77950_pinmux_info, 589 }, 590 #endif 591 #ifdef CONFIG_PINCTRL_PFC_R8A77960 592 { 593 .compatible = "renesas,pfc-r8a7796", 594 .data = &r8a77960_pinmux_info, 595 }, 596 #endif 597 #ifdef CONFIG_PINCTRL_PFC_R8A77961 598 { 599 .compatible = "renesas,pfc-r8a77961", 600 .data = &r8a77961_pinmux_info, 601 }, 602 #endif 603 #ifdef CONFIG_PINCTRL_PFC_R8A77965 604 { 605 .compatible = "renesas,pfc-r8a77965", 606 .data = &r8a77965_pinmux_info, 607 }, 608 #endif 609 #ifdef CONFIG_PINCTRL_PFC_R8A77970 610 { 611 .compatible = "renesas,pfc-r8a77970", 612 .data = &r8a77970_pinmux_info, 613 }, 614 #endif 615 #ifdef CONFIG_PINCTRL_PFC_R8A77980 616 { 617 .compatible = "renesas,pfc-r8a77980", 618 .data = &r8a77980_pinmux_info, 619 }, 620 #endif 621 #ifdef CONFIG_PINCTRL_PFC_R8A77990 622 { 623 .compatible = "renesas,pfc-r8a77990", 624 .data = &r8a77990_pinmux_info, 625 }, 626 #endif 627 #ifdef CONFIG_PINCTRL_PFC_R8A77995 628 { 629 .compatible = "renesas,pfc-r8a77995", 630 .data = &r8a77995_pinmux_info, 631 }, 632 #endif 633 #ifdef CONFIG_PINCTRL_PFC_R8A779A0 634 { 635 .compatible = "renesas,pfc-r8a779a0", 636 .data = &r8a779a0_pinmux_info, 637 }, 638 #endif 639 #ifdef CONFIG_PINCTRL_PFC_SH73A0 640 { 641 .compatible = "renesas,pfc-sh73a0", 642 .data = &sh73a0_pinmux_info, 643 }, 644 #endif 645 { }, 646 }; 647 #endif 648 649 #if defined(CONFIG_PM_SLEEP) && defined(CONFIG_ARM_PSCI_FW) 650 static void sh_pfc_nop_reg(struct sh_pfc *pfc, u32 reg, unsigned int idx) 651 { 652 } 653 654 static void sh_pfc_save_reg(struct sh_pfc *pfc, u32 reg, unsigned int idx) 655 { 656 pfc->saved_regs[idx] = sh_pfc_read(pfc, reg); 657 } 658 659 static void sh_pfc_restore_reg(struct sh_pfc *pfc, u32 reg, unsigned int idx) 660 { 661 sh_pfc_write(pfc, reg, pfc->saved_regs[idx]); 662 } 663 664 static unsigned int sh_pfc_walk_regs(struct sh_pfc *pfc, 665 void (*do_reg)(struct sh_pfc *pfc, u32 reg, unsigned int idx)) 666 { 667 unsigned int i, n = 0; 668 669 if (pfc->info->cfg_regs) 670 for (i = 0; pfc->info->cfg_regs[i].reg; i++) 671 do_reg(pfc, pfc->info->cfg_regs[i].reg, n++); 672 673 if (pfc->info->drive_regs) 674 for (i = 0; pfc->info->drive_regs[i].reg; i++) 675 do_reg(pfc, pfc->info->drive_regs[i].reg, n++); 676 677 if (pfc->info->bias_regs) 678 for (i = 0; pfc->info->bias_regs[i].puen || 679 pfc->info->bias_regs[i].pud; i++) { 680 if (pfc->info->bias_regs[i].puen) 681 do_reg(pfc, pfc->info->bias_regs[i].puen, n++); 682 if (pfc->info->bias_regs[i].pud) 683 do_reg(pfc, pfc->info->bias_regs[i].pud, n++); 684 } 685 686 if (pfc->info->ioctrl_regs) 687 for (i = 0; pfc->info->ioctrl_regs[i].reg; i++) 688 do_reg(pfc, pfc->info->ioctrl_regs[i].reg, n++); 689 690 return n; 691 } 692 693 static int sh_pfc_suspend_init(struct sh_pfc *pfc) 694 { 695 unsigned int n; 696 697 /* This is the best we can do to check for the presence of PSCI */ 698 if (!psci_ops.cpu_suspend) 699 return 0; 700 701 n = sh_pfc_walk_regs(pfc, sh_pfc_nop_reg); 702 if (!n) 703 return 0; 704 705 pfc->saved_regs = devm_kmalloc_array(pfc->dev, n, 706 sizeof(*pfc->saved_regs), 707 GFP_KERNEL); 708 if (!pfc->saved_regs) 709 return -ENOMEM; 710 711 dev_dbg(pfc->dev, "Allocated space to save %u regs\n", n); 712 return 0; 713 } 714 715 static int sh_pfc_suspend_noirq(struct device *dev) 716 { 717 struct sh_pfc *pfc = dev_get_drvdata(dev); 718 719 if (pfc->saved_regs) 720 sh_pfc_walk_regs(pfc, sh_pfc_save_reg); 721 return 0; 722 } 723 724 static int sh_pfc_resume_noirq(struct device *dev) 725 { 726 struct sh_pfc *pfc = dev_get_drvdata(dev); 727 728 if (pfc->saved_regs) 729 sh_pfc_walk_regs(pfc, sh_pfc_restore_reg); 730 return 0; 731 } 732 733 static const struct dev_pm_ops sh_pfc_pm = { 734 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sh_pfc_suspend_noirq, sh_pfc_resume_noirq) 735 }; 736 #define DEV_PM_OPS &sh_pfc_pm 737 #else 738 static int sh_pfc_suspend_init(struct sh_pfc *pfc) { return 0; } 739 #define DEV_PM_OPS NULL 740 #endif /* CONFIG_PM_SLEEP && CONFIG_ARM_PSCI_FW */ 741 742 #ifdef DEBUG 743 #define SH_PFC_MAX_REGS 300 744 #define SH_PFC_MAX_ENUMS 3000 745 746 static unsigned int sh_pfc_errors __initdata; 747 static unsigned int sh_pfc_warnings __initdata; 748 static struct { 749 u32 reg; 750 u32 bits; 751 } *sh_pfc_regs __initdata; 752 static u32 sh_pfc_num_regs __initdata; 753 static u16 *sh_pfc_enums __initdata; 754 static u32 sh_pfc_num_enums __initdata; 755 756 #define sh_pfc_err(fmt, ...) \ 757 do { \ 758 pr_err("%s: " fmt, drvname, ##__VA_ARGS__); \ 759 sh_pfc_errors++; \ 760 } while (0) 761 #define sh_pfc_warn(fmt, ...) \ 762 do { \ 763 pr_warn("%s: " fmt, drvname, ##__VA_ARGS__); \ 764 sh_pfc_warnings++; \ 765 } while (0) 766 767 static bool __init is0s(const u16 *enum_ids, unsigned int n) 768 { 769 unsigned int i; 770 771 for (i = 0; i < n; i++) 772 if (enum_ids[i]) 773 return false; 774 775 return true; 776 } 777 778 static bool __init same_name(const char *a, const char *b) 779 { 780 if (!a || !b) 781 return false; 782 783 return !strcmp(a, b); 784 } 785 786 static void __init sh_pfc_check_reg(const char *drvname, u32 reg, u32 bits) 787 { 788 unsigned int i; 789 790 for (i = 0; i < sh_pfc_num_regs; i++) { 791 if (reg != sh_pfc_regs[i].reg) 792 continue; 793 794 if (bits & sh_pfc_regs[i].bits) 795 sh_pfc_err("reg 0x%x: bits 0x%x conflict\n", reg, 796 bits & sh_pfc_regs[i].bits); 797 798 sh_pfc_regs[i].bits |= bits; 799 return; 800 } 801 802 if (sh_pfc_num_regs == SH_PFC_MAX_REGS) { 803 pr_warn_once("%s: Please increase SH_PFC_MAX_REGS\n", drvname); 804 return; 805 } 806 807 sh_pfc_regs[sh_pfc_num_regs].reg = reg; 808 sh_pfc_regs[sh_pfc_num_regs].bits = bits; 809 sh_pfc_num_regs++; 810 } 811 812 static int __init sh_pfc_check_enum(const char *drvname, u16 enum_id) 813 { 814 unsigned int i; 815 816 for (i = 0; i < sh_pfc_num_enums; i++) { 817 if (enum_id == sh_pfc_enums[i]) 818 return -EINVAL; 819 } 820 821 if (sh_pfc_num_enums == SH_PFC_MAX_ENUMS) { 822 pr_warn_once("%s: Please increase SH_PFC_MAX_ENUMS\n", drvname); 823 return 0; 824 } 825 826 sh_pfc_enums[sh_pfc_num_enums++] = enum_id; 827 return 0; 828 } 829 830 static void __init sh_pfc_check_reg_enums(const char *drvname, u32 reg, 831 const u16 *enums, unsigned int n) 832 { 833 unsigned int i; 834 835 for (i = 0; i < n; i++) { 836 if (enums[i] && sh_pfc_check_enum(drvname, enums[i])) 837 sh_pfc_err("reg 0x%x enum_id %u conflict\n", reg, 838 enums[i]); 839 } 840 } 841 842 static void __init sh_pfc_check_pin(const struct sh_pfc_soc_info *info, 843 u32 reg, unsigned int pin) 844 { 845 const char *drvname = info->name; 846 unsigned int i; 847 848 if (pin == SH_PFC_PIN_NONE) 849 return; 850 851 for (i = 0; i < info->nr_pins; i++) { 852 if (pin == info->pins[i].pin) 853 return; 854 } 855 856 sh_pfc_err("reg 0x%x: pin %u not found\n", reg, pin); 857 } 858 859 static void __init sh_pfc_check_cfg_reg(const char *drvname, 860 const struct pinmux_cfg_reg *cfg_reg) 861 { 862 unsigned int i, n, rw, fw; 863 864 sh_pfc_check_reg(drvname, cfg_reg->reg, 865 GENMASK(cfg_reg->reg_width - 1, 0)); 866 867 if (cfg_reg->field_width) { 868 n = cfg_reg->reg_width / cfg_reg->field_width; 869 /* Skip field checks (done at build time) */ 870 goto check_enum_ids; 871 } 872 873 for (i = 0, n = 0, rw = 0; (fw = cfg_reg->var_field_width[i]); i++) { 874 if (fw > 3 && is0s(&cfg_reg->enum_ids[n], 1 << fw)) 875 sh_pfc_warn("reg 0x%x: reserved field [%u:%u] can be split to reduce table size\n", 876 cfg_reg->reg, rw, rw + fw - 1); 877 n += 1 << fw; 878 rw += fw; 879 } 880 881 if (rw != cfg_reg->reg_width) 882 sh_pfc_err("reg 0x%x: var_field_width declares %u instead of %u bits\n", 883 cfg_reg->reg, rw, cfg_reg->reg_width); 884 885 if (n != cfg_reg->nr_enum_ids) 886 sh_pfc_err("reg 0x%x: enum_ids[] has %u instead of %u values\n", 887 cfg_reg->reg, cfg_reg->nr_enum_ids, n); 888 889 check_enum_ids: 890 sh_pfc_check_reg_enums(drvname, cfg_reg->reg, cfg_reg->enum_ids, n); 891 } 892 893 static void __init sh_pfc_check_drive_reg(const struct sh_pfc_soc_info *info, 894 const struct pinmux_drive_reg *drive) 895 { 896 unsigned int i; 897 898 for (i = 0; i < ARRAY_SIZE(drive->fields); i++) { 899 const struct pinmux_drive_reg_field *field = &drive->fields[i]; 900 901 if (!field->pin && !field->offset && !field->size) 902 continue; 903 904 sh_pfc_check_reg(info->name, drive->reg, 905 GENMASK(field->offset + field->size - 1, 906 field->offset)); 907 908 sh_pfc_check_pin(info, drive->reg, field->pin); 909 } 910 } 911 912 static void __init sh_pfc_check_bias_reg(const struct sh_pfc_soc_info *info, 913 const struct pinmux_bias_reg *bias) 914 { 915 unsigned int i; 916 u32 bits; 917 918 for (i = 0, bits = 0; i < ARRAY_SIZE(bias->pins); i++) 919 if (bias->pins[i] != SH_PFC_PIN_NONE) 920 bits |= BIT(i); 921 922 if (bias->puen) 923 sh_pfc_check_reg(info->name, bias->puen, bits); 924 if (bias->pud) 925 sh_pfc_check_reg(info->name, bias->pud, bits); 926 for (i = 0; i < ARRAY_SIZE(bias->pins); i++) 927 sh_pfc_check_pin(info, bias->puen, bias->pins[i]); 928 } 929 930 static void __init sh_pfc_check_info(const struct sh_pfc_soc_info *info) 931 { 932 const struct pinmux_bias_reg *bias_regs = info->bias_regs; 933 const char *drvname = info->name; 934 unsigned int *refcnts; 935 unsigned int i, j, k; 936 937 pr_info("sh_pfc: Checking %s\n", drvname); 938 sh_pfc_num_regs = 0; 939 sh_pfc_num_enums = 0; 940 941 /* Check pins */ 942 for (i = 0; i < info->nr_pins; i++) { 943 const struct sh_pfc_pin *pin = &info->pins[i]; 944 945 if (!pin->name) { 946 sh_pfc_err("empty pin %u\n", i); 947 continue; 948 } 949 for (j = 0; j < i; j++) { 950 const struct sh_pfc_pin *pin2 = &info->pins[j]; 951 952 if (same_name(pin->name, pin2->name)) 953 sh_pfc_err("pin %s: name conflict\n", 954 pin->name); 955 956 if (pin->pin != (u16)-1 && pin->pin == pin2->pin) 957 sh_pfc_err("pin %s/%s: pin %u conflict\n", 958 pin->name, pin2->name, pin->pin); 959 960 if (pin->enum_id && pin->enum_id == pin2->enum_id) 961 sh_pfc_err("pin %s/%s: enum_id %u conflict\n", 962 pin->name, pin2->name, 963 pin->enum_id); 964 } 965 } 966 967 /* Check groups and functions */ 968 refcnts = kcalloc(info->nr_groups, sizeof(*refcnts), GFP_KERNEL); 969 if (!refcnts) 970 return; 971 972 for (i = 0; i < info->nr_functions; i++) { 973 const struct sh_pfc_function *func = &info->functions[i]; 974 975 if (!func->name) { 976 sh_pfc_err("empty function %u\n", i); 977 continue; 978 } 979 for (j = 0; j < i; j++) { 980 if (same_name(func->name, info->functions[j].name)) 981 sh_pfc_err("function %s: name conflict\n", 982 func->name); 983 } 984 for (j = 0; j < func->nr_groups; j++) { 985 for (k = 0; k < info->nr_groups; k++) { 986 if (same_name(func->groups[j], 987 info->groups[k].name)) { 988 refcnts[k]++; 989 break; 990 } 991 } 992 993 if (k == info->nr_groups) 994 sh_pfc_err("function %s: group %s not found\n", 995 func->name, func->groups[j]); 996 } 997 } 998 999 for (i = 0; i < info->nr_groups; i++) { 1000 const struct sh_pfc_pin_group *group = &info->groups[i]; 1001 1002 if (!group->name) { 1003 sh_pfc_err("empty group %u\n", i); 1004 continue; 1005 } 1006 for (j = 0; j < i; j++) { 1007 if (same_name(group->name, info->groups[j].name)) 1008 sh_pfc_err("group %s: name conflict\n", 1009 group->name); 1010 } 1011 if (!refcnts[i]) 1012 sh_pfc_err("orphan group %s\n", group->name); 1013 else if (refcnts[i] > 1) 1014 sh_pfc_warn("group %s referenced by %u functions\n", 1015 group->name, refcnts[i]); 1016 } 1017 1018 kfree(refcnts); 1019 1020 /* Check config register descriptions */ 1021 for (i = 0; info->cfg_regs && info->cfg_regs[i].reg; i++) 1022 sh_pfc_check_cfg_reg(drvname, &info->cfg_regs[i]); 1023 1024 /* Check drive strength registers */ 1025 for (i = 0; info->drive_regs && info->drive_regs[i].reg; i++) 1026 sh_pfc_check_drive_reg(info, &info->drive_regs[i]); 1027 1028 /* Check bias registers */ 1029 for (i = 0; bias_regs && (bias_regs[i].puen || bias_regs[i].pud); i++) 1030 sh_pfc_check_bias_reg(info, &bias_regs[i]); 1031 1032 /* Check ioctrl registers */ 1033 for (i = 0; info->ioctrl_regs && info->ioctrl_regs[i].reg; i++) 1034 sh_pfc_check_reg(drvname, info->ioctrl_regs[i].reg, U32_MAX); 1035 1036 /* Check data registers */ 1037 for (i = 0; info->data_regs && info->data_regs[i].reg; i++) { 1038 sh_pfc_check_reg(drvname, info->data_regs[i].reg, 1039 GENMASK(info->data_regs[i].reg_width - 1, 0)); 1040 sh_pfc_check_reg_enums(drvname, info->data_regs[i].reg, 1041 info->data_regs[i].enum_ids, 1042 info->data_regs[i].reg_width); 1043 } 1044 1045 #ifdef CONFIG_PINCTRL_SH_FUNC_GPIO 1046 /* Check function GPIOs */ 1047 for (i = 0; i < info->nr_func_gpios; i++) { 1048 const struct pinmux_func *func = &info->func_gpios[i]; 1049 1050 if (!func->name) { 1051 sh_pfc_err("empty function gpio %u\n", i); 1052 continue; 1053 } 1054 for (j = 0; j < i; j++) { 1055 if (same_name(func->name, info->func_gpios[j].name)) 1056 sh_pfc_err("func_gpio %s: name conflict\n", 1057 func->name); 1058 } 1059 if (sh_pfc_check_enum(drvname, func->enum_id)) 1060 sh_pfc_err("%s enum_id %u conflict\n", func->name, 1061 func->enum_id); 1062 } 1063 #endif 1064 } 1065 1066 static void __init sh_pfc_check_driver(const struct platform_driver *pdrv) 1067 { 1068 unsigned int i; 1069 1070 if (!IS_ENABLED(CONFIG_SUPERH) && 1071 !of_find_matching_node(NULL, pdrv->driver.of_match_table)) 1072 return; 1073 1074 sh_pfc_regs = kcalloc(SH_PFC_MAX_REGS, sizeof(*sh_pfc_regs), 1075 GFP_KERNEL); 1076 if (!sh_pfc_regs) 1077 return; 1078 1079 sh_pfc_enums = kcalloc(SH_PFC_MAX_ENUMS, sizeof(*sh_pfc_enums), 1080 GFP_KERNEL); 1081 if (!sh_pfc_enums) 1082 goto free_regs; 1083 1084 pr_warn("sh_pfc: Checking builtin pinmux tables\n"); 1085 1086 for (i = 0; pdrv->id_table[i].name[0]; i++) 1087 sh_pfc_check_info((void *)pdrv->id_table[i].driver_data); 1088 1089 #ifdef CONFIG_OF 1090 for (i = 0; pdrv->driver.of_match_table[i].compatible[0]; i++) 1091 sh_pfc_check_info(pdrv->driver.of_match_table[i].data); 1092 #endif 1093 1094 pr_warn("sh_pfc: Detected %u errors and %u warnings\n", sh_pfc_errors, 1095 sh_pfc_warnings); 1096 1097 kfree(sh_pfc_enums); 1098 free_regs: 1099 kfree(sh_pfc_regs); 1100 } 1101 1102 #else /* !DEBUG */ 1103 static inline void sh_pfc_check_driver(struct platform_driver *pdrv) {} 1104 #endif /* !DEBUG */ 1105 1106 #ifdef CONFIG_OF 1107 static const void *sh_pfc_quirk_match(void) 1108 { 1109 #ifdef CONFIG_PINCTRL_PFC_R8A77950 1110 const struct soc_device_attribute *match; 1111 static const struct soc_device_attribute quirks[] = { 1112 { 1113 .soc_id = "r8a7795", .revision = "ES1.*", 1114 .data = &r8a77950_pinmux_info, 1115 }, 1116 { /* sentinel */ } 1117 }; 1118 1119 match = soc_device_match(quirks); 1120 if (match) 1121 return match->data; 1122 #endif /* CONFIG_PINCTRL_PFC_R8A77950 */ 1123 1124 return NULL; 1125 } 1126 #endif /* CONFIG_OF */ 1127 1128 static int sh_pfc_probe(struct platform_device *pdev) 1129 { 1130 const struct sh_pfc_soc_info *info; 1131 struct sh_pfc *pfc; 1132 int ret; 1133 1134 #ifdef CONFIG_OF 1135 if (pdev->dev.of_node) { 1136 info = sh_pfc_quirk_match(); 1137 if (!info) 1138 info = of_device_get_match_data(&pdev->dev); 1139 } else 1140 #endif 1141 info = (const void *)platform_get_device_id(pdev)->driver_data; 1142 1143 pfc = devm_kzalloc(&pdev->dev, sizeof(*pfc), GFP_KERNEL); 1144 if (pfc == NULL) 1145 return -ENOMEM; 1146 1147 pfc->info = info; 1148 pfc->dev = &pdev->dev; 1149 1150 ret = sh_pfc_map_resources(pfc, pdev); 1151 if (unlikely(ret < 0)) 1152 return ret; 1153 1154 spin_lock_init(&pfc->lock); 1155 1156 if (info->ops && info->ops->init) { 1157 ret = info->ops->init(pfc); 1158 if (ret < 0) 1159 return ret; 1160 1161 /* .init() may have overridden pfc->info */ 1162 info = pfc->info; 1163 } 1164 1165 ret = sh_pfc_suspend_init(pfc); 1166 if (ret) 1167 return ret; 1168 1169 /* Enable dummy states for those platforms without pinctrl support */ 1170 if (!of_have_populated_dt()) 1171 pinctrl_provide_dummies(); 1172 1173 ret = sh_pfc_init_ranges(pfc); 1174 if (ret < 0) 1175 return ret; 1176 1177 /* 1178 * Initialize pinctrl bindings first 1179 */ 1180 ret = sh_pfc_register_pinctrl(pfc); 1181 if (unlikely(ret != 0)) 1182 return ret; 1183 1184 #ifdef CONFIG_PINCTRL_SH_PFC_GPIO 1185 /* 1186 * Then the GPIO chip 1187 */ 1188 ret = sh_pfc_register_gpiochip(pfc); 1189 if (unlikely(ret != 0)) { 1190 /* 1191 * If the GPIO chip fails to come up we still leave the 1192 * PFC state as it is, given that there are already 1193 * extant users of it that have succeeded by this point. 1194 */ 1195 dev_notice(pfc->dev, "failed to init GPIO chip, ignoring...\n"); 1196 } 1197 #endif 1198 1199 platform_set_drvdata(pdev, pfc); 1200 1201 dev_info(pfc->dev, "%s support registered\n", info->name); 1202 1203 return 0; 1204 } 1205 1206 static const struct platform_device_id sh_pfc_id_table[] = { 1207 #ifdef CONFIG_PINCTRL_PFC_SH7203 1208 { "pfc-sh7203", (kernel_ulong_t)&sh7203_pinmux_info }, 1209 #endif 1210 #ifdef CONFIG_PINCTRL_PFC_SH7264 1211 { "pfc-sh7264", (kernel_ulong_t)&sh7264_pinmux_info }, 1212 #endif 1213 #ifdef CONFIG_PINCTRL_PFC_SH7269 1214 { "pfc-sh7269", (kernel_ulong_t)&sh7269_pinmux_info }, 1215 #endif 1216 #ifdef CONFIG_PINCTRL_PFC_SH7720 1217 { "pfc-sh7720", (kernel_ulong_t)&sh7720_pinmux_info }, 1218 #endif 1219 #ifdef CONFIG_PINCTRL_PFC_SH7722 1220 { "pfc-sh7722", (kernel_ulong_t)&sh7722_pinmux_info }, 1221 #endif 1222 #ifdef CONFIG_PINCTRL_PFC_SH7723 1223 { "pfc-sh7723", (kernel_ulong_t)&sh7723_pinmux_info }, 1224 #endif 1225 #ifdef CONFIG_PINCTRL_PFC_SH7724 1226 { "pfc-sh7724", (kernel_ulong_t)&sh7724_pinmux_info }, 1227 #endif 1228 #ifdef CONFIG_PINCTRL_PFC_SH7734 1229 { "pfc-sh7734", (kernel_ulong_t)&sh7734_pinmux_info }, 1230 #endif 1231 #ifdef CONFIG_PINCTRL_PFC_SH7757 1232 { "pfc-sh7757", (kernel_ulong_t)&sh7757_pinmux_info }, 1233 #endif 1234 #ifdef CONFIG_PINCTRL_PFC_SH7785 1235 { "pfc-sh7785", (kernel_ulong_t)&sh7785_pinmux_info }, 1236 #endif 1237 #ifdef CONFIG_PINCTRL_PFC_SH7786 1238 { "pfc-sh7786", (kernel_ulong_t)&sh7786_pinmux_info }, 1239 #endif 1240 #ifdef CONFIG_PINCTRL_PFC_SHX3 1241 { "pfc-shx3", (kernel_ulong_t)&shx3_pinmux_info }, 1242 #endif 1243 { }, 1244 }; 1245 1246 static struct platform_driver sh_pfc_driver = { 1247 .probe = sh_pfc_probe, 1248 .id_table = sh_pfc_id_table, 1249 .driver = { 1250 .name = DRV_NAME, 1251 .of_match_table = of_match_ptr(sh_pfc_of_table), 1252 .pm = DEV_PM_OPS, 1253 }, 1254 }; 1255 1256 static int __init sh_pfc_init(void) 1257 { 1258 sh_pfc_check_driver(&sh_pfc_driver); 1259 return platform_driver_register(&sh_pfc_driver); 1260 } 1261 postcore_initcall(sh_pfc_init); 1262