drivers/bus/ti-sysc.c

   1 /*
   2  * ti-sysc.c - Texas Instruments sysc interconnect target driver
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
   9  * kind, whether express or implied; without even the implied warranty
  10  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #include <linux/io.h>
  15 #include <linux/clk.h>
  16 #include <linux/clkdev.h>
  17 #include <linux/delay.h>
  18 #include <linux/module.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/pm_domain.h>
  21 #include <linux/pm_runtime.h>
  22 #include <linux/reset.h>
  23 #include <linux/of_address.h>
  24 #include <linux/of_platform.h>
  25 #include <linux/slab.h>
  26 #include <linux/iopoll.h>
  27
  28 #include <linux/platform_data/ti-sysc.h>
  29
  30 #include <dt-bindings/bus/ti-sysc.h>
  31
  32 #define MAX_MODULE_SOFTRESET_WAIT               10000
  33
  34 static const char * const reg_names[] = { "rev", "sysc", "syss", };
  35
  36 enum sysc_clocks {
  37         SYSC_FCK,
  38         SYSC_ICK,
  39         SYSC_OPTFCK0,
  40         SYSC_OPTFCK1,
  41         SYSC_OPTFCK2,
  42         SYSC_OPTFCK3,
  43         SYSC_OPTFCK4,
  44         SYSC_OPTFCK5,
  45         SYSC_OPTFCK6,
  46         SYSC_OPTFCK7,
  47         SYSC_MAX_CLOCKS,
  48 };
  49
  50 static const char * const clock_names[SYSC_ICK + 1] = { "fck", "ick", };
  51
  52 #define SYSC_IDLEMODE_MASK              3
  53 #define SYSC_CLOCKACTIVITY_MASK         3
  54
  55 /**
  56  * struct sysc - TI sysc interconnect target module registers and capabilities
  57  * @dev: struct device pointer
  58  * @module_pa: physical address of the interconnect target module
  59  * @module_size: size of the interconnect target module
  60  * @module_va: virtual address of the interconnect target module
  61  * @offsets: register offsets from module base
  62  * @clocks: clocks used by the interconnect target module
  63  * @clock_roles: clock role names for the found clocks
  64  * @nr_clocks: number of clocks used by the interconnect target module
  65  * @legacy_mode: configured for legacy mode if set
  66  * @cap: interconnect target module capabilities
  67  * @cfg: interconnect target module configuration
  68  * @name: name if available
  69  * @revision: interconnect target module revision
  70  * @needs_resume: runtime resume needed on resume from suspend
  71  */
  72 struct sysc {
  73         struct device *dev;
  74         u64 module_pa;
  75         u32 module_size;
  76         void __iomem *module_va;
  77         int offsets[SYSC_MAX_REGS];
  78         struct clk **clocks;
  79         const char **clock_roles;
  80         int nr_clocks;
  81         struct reset_control *rsts;
  82         const char *legacy_mode;
  83         const struct sysc_capabilities *cap;
  84         struct sysc_config cfg;
  85         struct ti_sysc_cookie cookie;
  86         const char *name;
  87         u32 revision;
  88         bool enabled;
  89         bool needs_resume;
  90         unsigned int noirq_suspend:1;
  91         bool child_needs_resume;
  92         struct delayed_work idle_work;
  93 };
  94
  95 void sysc_write(struct sysc *ddata, int offset, u32 value)
  96 {
  97         writel_relaxed(value, ddata->module_va + offset);
  98 }
  99
 100 static u32 sysc_read(struct sysc *ddata, int offset)
 101 {
 102         if (ddata->cfg.quirks & SYSC_QUIRK_16BIT) {
 103                 u32 val;
 104
 105                 val = readw_relaxed(ddata->module_va + offset);
 106                 val |= (readw_relaxed(ddata->module_va + offset + 4) << 16);
 107
 108                 return val;
 109         }
 110
 111         return readl_relaxed(ddata->module_va + offset);
 112 }
 113
 114 static bool sysc_opt_clks_needed(struct sysc *ddata)
 115 {
 116         return !!(ddata->cfg.quirks & SYSC_QUIRK_OPT_CLKS_NEEDED);
 117 }
 118
 119 static u32 sysc_read_revision(struct sysc *ddata)
 120 {
 121         int offset = ddata->offsets[SYSC_REVISION];
 122
 123         if (offset < 0)
 124                 return 0;
 125
 126         return sysc_read(ddata, offset);
 127 }
 128
 129 static int sysc_get_one_clock(struct sysc *ddata, const char *name)
 130 {
 131         int error, i, index = -ENODEV;
 132
 133         if (!strncmp(clock_names[SYSC_FCK], name, 3))
 134                 index = SYSC_FCK;
 135         else if (!strncmp(clock_names[SYSC_ICK], name, 3))
 136                 index = SYSC_ICK;
 137
 138         if (index < 0) {
 139                 for (i = SYSC_OPTFCK0; i < SYSC_MAX_CLOCKS; i++) {
 140                         if (!ddata->clocks[i]) {
 141                                 index = i;
 142                                 break;
 143                         }
 144                 }
 145         }
 146
 147         if (index < 0) {
 148                 dev_err(ddata->dev, "clock %s not added\n", name);
 149                 return index;
 150         }
 151
 152         ddata->clocks[index] = devm_clk_get(ddata->dev, name);
 153         if (IS_ERR(ddata->clocks[index])) {
 154                 if (PTR_ERR(ddata->clocks[index]) == -ENOENT)
 155                         return 0;
 156
 157                 dev_err(ddata->dev, "clock get error for %s: %li\n",
 158                         name, PTR_ERR(ddata->clocks[index]));
 159
 160                 return PTR_ERR(ddata->clocks[index]);
 161         }
 162
 163         error = clk_prepare(ddata->clocks[index]);
 164         if (error) {
 165                 dev_err(ddata->dev, "clock prepare error for %s: %i\n",
 166                         name, error);
 167
 168                 return error;
 169         }
 170
 171         return 0;
 172 }
 173
 174 static int sysc_get_clocks(struct sysc *ddata)
 175 {
 176         struct device_node *np = ddata->dev->of_node;
 177         struct property *prop;
 178         const char *name;
 179         int nr_fck = 0, nr_ick = 0, i, error = 0;
 180
 181         ddata->clock_roles = devm_kcalloc(ddata->dev,
 182                                           SYSC_MAX_CLOCKS,
 183                                           sizeof(*ddata->clock_roles),
 184                                           GFP_KERNEL);
 185         if (!ddata->clock_roles)
 186                 return -ENOMEM;
 187
 188         of_property_for_each_string(np, "clock-names", prop, name) {
 189                 if (!strncmp(clock_names[SYSC_FCK], name, 3))
 190                         nr_fck++;
 191                 if (!strncmp(clock_names[SYSC_ICK], name, 3))
 192                         nr_ick++;
 193                 ddata->clock_roles[ddata->nr_clocks] = name;
 194                 ddata->nr_clocks++;
 195         }
 196
 197         if (ddata->nr_clocks < 1)
 198                 return 0;
 199
 200         if (ddata->nr_clocks > SYSC_MAX_CLOCKS) {
 201                 dev_err(ddata->dev, "too many clocks for %pOF\n", np);
 202
 203                 return -EINVAL;
 204         }
 205
 206         if (nr_fck > 1 || nr_ick > 1) {
 207                 dev_err(ddata->dev, "max one fck and ick for %pOF\n", np);
 208
 209                 return -EINVAL;
 210         }
 211
 212         ddata->clocks = devm_kcalloc(ddata->dev,
 213                                      ddata->nr_clocks, sizeof(*ddata->clocks),
 214                                      GFP_KERNEL);
 215         if (!ddata->clocks)
 216                 return -ENOMEM;
 217
 218         for (i = 0; i < ddata->nr_clocks; i++) {
 219                 error = sysc_get_one_clock(ddata, ddata->clock_roles[i]);
 220                 if (error && error != -ENOENT)
 221                         return error;
 222         }
 223
 224         return 0;
 225 }
 226
 227 /**
 228  * sysc_init_resets - reset module on init
 229  * @ddata: device driver data
 230  *
 231  * A module can have both OCP softreset control and external rstctrl.
 232  * If more complicated rstctrl resets are needed, please handle these
 233  * directly from the child device driver and map only the module reset
 234  * for the parent interconnect target module device.
 235  *
 236  * Automatic reset of the module on init can be skipped with the
 237  * "ti,no-reset-on-init" device tree property.
 238  */
 239 static int sysc_init_resets(struct sysc *ddata)
 240 {
 241         int error;
 242
 243         ddata->rsts =
 244                 devm_reset_control_array_get_optional_exclusive(ddata->dev);
 245         if (IS_ERR(ddata->rsts))
 246                 return PTR_ERR(ddata->rsts);
 247
 248         if (ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT)
 249                 goto deassert;
 250
 251         error = reset_control_assert(ddata->rsts);
 252         if (error)
 253                 return error;
 254
 255 deassert:
 256         error = reset_control_deassert(ddata->rsts);
 257         if (error)
 258                 return error;
 259
 260         return 0;
 261 }
 262
 263 /**
 264  * sysc_parse_and_check_child_range - parses module IO region from ranges
 265  * @ddata: device driver data
 266  *
 267  * In general we only need rev, syss, and sysc registers and not the whole
 268  * module range. But we do want the offsets for these registers from the
 269  * module base. This allows us to check them against the legacy hwmod
 270  * platform data. Let's also check the ranges are configured properly.
 271  */
 272 static int sysc_parse_and_check_child_range(struct sysc *ddata)
 273 {
 274         struct device_node *np = ddata->dev->of_node;
 275         const __be32 *ranges;
 276         u32 nr_addr, nr_size;
 277         int len, error;
 278
 279         ranges = of_get_property(np, "ranges", &len);
 280         if (!ranges) {
 281                 dev_err(ddata->dev, "missing ranges for %pOF\n", np);
 282
 283                 return -ENOENT;
 284         }
 285
 286         len /= sizeof(*ranges);
 287
 288         if (len < 3) {
 289                 dev_err(ddata->dev, "incomplete ranges for %pOF\n", np);
 290
 291                 return -EINVAL;
 292         }
 293
 294         error = of_property_read_u32(np, "#address-cells", &nr_addr);
 295         if (error)
 296                 return -ENOENT;
 297
 298         error = of_property_read_u32(np, "#size-cells", &nr_size);
 299         if (error)
 300                 return -ENOENT;
 301
 302         if (nr_addr != 1 || nr_size != 1) {
 303                 dev_err(ddata->dev, "invalid ranges for %pOF\n", np);
 304
 305                 return -EINVAL;
 306         }
 307
 308         ranges++;
 309         ddata->module_pa = of_translate_address(np, ranges++);
 310         ddata->module_size = be32_to_cpup(ranges);
 311
 312         return 0;
 313 }
 314
 315 static struct device_node *stdout_path;
 316
 317 static void sysc_init_stdout_path(struct sysc *ddata)
 318 {
 319         struct device_node *np = NULL;
 320         const char *uart;
 321
 322         if (IS_ERR(stdout_path))
 323                 return;
 324
 325         if (stdout_path)
 326                 return;
 327
 328         np = of_find_node_by_path("/chosen");
 329         if (!np)
 330                 goto err;
 331
 332         uart = of_get_property(np, "stdout-path", NULL);
 333         if (!uart)
 334                 goto err;
 335
 336         np = of_find_node_by_path(uart);
 337         if (!np)
 338                 goto err;
 339
 340         stdout_path = np;
 341
 342         return;
 343
 344 err:
 345         stdout_path = ERR_PTR(-ENODEV);
 346 }
 347
 348 static void sysc_check_quirk_stdout(struct sysc *ddata,
 349                                     struct device_node *np)
 350 {
 351         sysc_init_stdout_path(ddata);
 352         if (np != stdout_path)
 353                 return;
 354
 355         ddata->cfg.quirks |= SYSC_QUIRK_NO_IDLE_ON_INIT |
 356                                 SYSC_QUIRK_NO_RESET_ON_INIT;
 357 }
 358
 359 /**
 360  * sysc_check_one_child - check child configuration
 361  * @ddata: device driver data
 362  * @np: child device node
 363  *
 364  * Let's avoid messy situations where we have new interconnect target
 365  * node but children have "ti,hwmods". These belong to the interconnect
 366  * target node and are managed by this driver.
 367  */
 368 static int sysc_check_one_child(struct sysc *ddata,
 369                                 struct device_node *np)
 370 {
 371         const char *name;
 372
 373         name = of_get_property(np, "ti,hwmods", NULL);
 374         if (name)
 375                 dev_warn(ddata->dev, "really a child ti,hwmods property?");
 376
 377         sysc_check_quirk_stdout(ddata, np);
 378
 379         return 0;
 380 }
 381
 382 static int sysc_check_children(struct sysc *ddata)
 383 {
 384         struct device_node *child;
 385         int error;
 386
 387         for_each_child_of_node(ddata->dev->of_node, child) {
 388                 error = sysc_check_one_child(ddata, child);
 389                 if (error)
 390                         return error;
 391         }
 392
 393         return 0;
 394 }
 395
 396 /*
 397  * So far only I2C uses 16-bit read access with clockactivity with revision
 398  * in two registers with stride of 4. We can detect this based on the rev
 399  * register size to configure things far enough to be able to properly read
 400  * the revision register.
 401  */
 402 static void sysc_check_quirk_16bit(struct sysc *ddata, struct resource *res)
 403 {
 404         if (resource_size(res) == 8)
 405                 ddata->cfg.quirks |= SYSC_QUIRK_16BIT | SYSC_QUIRK_USE_CLOCKACT;
 406 }
 407
 408 /**
 409  * sysc_parse_one - parses the interconnect target module registers
 410  * @ddata: device driver data
 411  * @reg: register to parse
 412  */
 413 static int sysc_parse_one(struct sysc *ddata, enum sysc_registers reg)
 414 {
 415         struct resource *res;
 416         const char *name;
 417
 418         switch (reg) {
 419         case SYSC_REVISION:
 420         case SYSC_SYSCONFIG:
 421         case SYSC_SYSSTATUS:
 422                 name = reg_names[reg];
 423                 break;
 424         default:
 425                 return -EINVAL;
 426         }
 427
 428         res = platform_get_resource_byname(to_platform_device(ddata->dev),
 429                                            IORESOURCE_MEM, name);
 430         if (!res) {
 431                 ddata->offsets[reg] = -ENODEV;
 432
 433                 return 0;
 434         }
 435
 436         ddata->offsets[reg] = res->start - ddata->module_pa;
 437         if (reg == SYSC_REVISION)
 438                 sysc_check_quirk_16bit(ddata, res);
 439
 440         return 0;
 441 }
 442
 443 static int sysc_parse_registers(struct sysc *ddata)
 444 {
 445         int i, error;
 446
 447         for (i = 0; i < SYSC_MAX_REGS; i++) {
 448                 error = sysc_parse_one(ddata, i);
 449                 if (error)
 450                         return error;
 451         }
 452
 453         return 0;
 454 }
 455
 456 /**
 457  * sysc_check_registers - check for misconfigured register overlaps
 458  * @ddata: device driver data
 459  */
 460 static int sysc_check_registers(struct sysc *ddata)
 461 {
 462         int i, j, nr_regs = 0, nr_matches = 0;
 463
 464         for (i = 0; i < SYSC_MAX_REGS; i++) {
 465                 if (ddata->offsets[i] < 0)
 466                         continue;
 467
 468                 if (ddata->offsets[i] > (ddata->module_size - 4)) {
 469                         dev_err(ddata->dev, "register outside module range");
 470
 471                                 return -EINVAL;
 472                 }
 473
 474                 for (j = 0; j < SYSC_MAX_REGS; j++) {
 475                         if (ddata->offsets[j] < 0)
 476                                 continue;
 477
 478                         if (ddata->offsets[i] == ddata->offsets[j])
 479                                 nr_matches++;
 480                 }
 481                 nr_regs++;
 482         }
 483
 484         if (nr_regs < 1) {
 485                 dev_err(ddata->dev, "missing registers\n");
 486
 487                 return -EINVAL;
 488         }
 489
 490         if (nr_matches > nr_regs) {
 491                 dev_err(ddata->dev, "overlapping registers: (%i/%i)",
 492                         nr_regs, nr_matches);
 493
 494                 return -EINVAL;
 495         }
 496
 497         return 0;
 498 }
 499
 500 /**
 501  * syc_ioremap - ioremap register space for the interconnect target module
 502  * @ddata: device driver data
 503  *
 504  * Note that the interconnect target module registers can be anywhere
 505  * within the interconnect target module range. For example, SGX has
 506  * them at offset 0x1fc00 in the 32MB module address space. And cpsw
 507  * has them at offset 0x1200 in the CPSW_WR child. Usually the
 508  * the interconnect target module registers are at the beginning of
 509  * the module range though.
 510  */
 511 static int sysc_ioremap(struct sysc *ddata)
 512 {
 513         int size;
 514
 515         size = max3(ddata->offsets[SYSC_REVISION],
 516                     ddata->offsets[SYSC_SYSCONFIG],
 517                     ddata->offsets[SYSC_SYSSTATUS]);
 518
 519         if (size < 0 || (size + sizeof(u32)) > ddata->module_size)
 520                 return -EINVAL;
 521
 522         ddata->module_va = devm_ioremap(ddata->dev,
 523                                         ddata->module_pa,
 524                                         size + sizeof(u32));
 525         if (!ddata->module_va)
 526                 return -EIO;
 527
 528         return 0;
 529 }
 530
 531 /**
 532  * sysc_map_and_check_registers - ioremap and check device registers
 533  * @ddata: device driver data
 534  */
 535 static int sysc_map_and_check_registers(struct sysc *ddata)
 536 {
 537         int error;
 538
 539         error = sysc_parse_and_check_child_range(ddata);
 540         if (error)
 541                 return error;
 542
 543         error = sysc_check_children(ddata);
 544         if (error)
 545                 return error;
 546
 547         error = sysc_parse_registers(ddata);
 548         if (error)
 549                 return error;
 550
 551         error = sysc_ioremap(ddata);
 552         if (error)
 553                 return error;
 554
 555         error = sysc_check_registers(ddata);
 556         if (error)
 557                 return error;
 558
 559         return 0;
 560 }
 561
 562 /**
 563  * sysc_show_rev - read and show interconnect target module revision
 564  * @bufp: buffer to print the information to
 565  * @ddata: device driver data
 566  */
 567 static int sysc_show_rev(char *bufp, struct sysc *ddata)
 568 {
 569         int len;
 570
 571         if (ddata->offsets[SYSC_REVISION] < 0)
 572                 return sprintf(bufp, ":NA");
 573
 574         len = sprintf(bufp, ":%08x", ddata->revision);
 575
 576         return len;
 577 }
 578
 579 static int sysc_show_reg(struct sysc *ddata,
 580                          char *bufp, enum sysc_registers reg)
 581 {
 582         if (ddata->offsets[reg] < 0)
 583                 return sprintf(bufp, ":NA");
 584
 585         return sprintf(bufp, ":%x", ddata->offsets[reg]);
 586 }
 587
 588 static int sysc_show_name(char *bufp, struct sysc *ddata)
 589 {
 590         if (!ddata->name)
 591                 return 0;
 592
 593         return sprintf(bufp, ":%s", ddata->name);
 594 }
 595
 596 /**
 597  * sysc_show_registers - show information about interconnect target module
 598  * @ddata: device driver data
 599  */
 600 static void sysc_show_registers(struct sysc *ddata)
 601 {
 602         char buf[128];
 603         char *bufp = buf;
 604         int i;
 605
 606         for (i = 0; i < SYSC_MAX_REGS; i++)
 607                 bufp += sysc_show_reg(ddata, bufp, i);
 608
 609         bufp += sysc_show_rev(bufp, ddata);
 610         bufp += sysc_show_name(bufp, ddata);
 611
 612         dev_dbg(ddata->dev, "%llx:%x%s\n",
 613                 ddata->module_pa, ddata->module_size,
 614                 buf);
 615 }
 616
 617 static int __maybe_unused sysc_runtime_suspend(struct device *dev)
 618 {
 619         struct ti_sysc_platform_data *pdata;
 620         struct sysc *ddata;
 621         int error = 0, i;
 622
 623         ddata = dev_get_drvdata(dev);
 624
 625         if (!ddata->enabled)
 626                 return 0;
 627
 628         if (ddata->legacy_mode) {
 629                 pdata = dev_get_platdata(ddata->dev);
 630                 if (!pdata)
 631                         return 0;
 632
 633                 if (!pdata->idle_module)
 634                         return -ENODEV;
 635
 636                 error = pdata->idle_module(dev, &ddata->cookie);
 637                 if (error)
 638                         dev_err(dev, "%s: could not idle: %i\n",
 639                                 __func__, error);
 640
 641                 goto idled;
 642         }
 643
 644         for (i = 0; i < ddata->nr_clocks; i++) {
 645                 if (IS_ERR_OR_NULL(ddata->clocks[i]))
 646                         continue;
 647
 648                 if (i >= SYSC_OPTFCK0 && !sysc_opt_clks_needed(ddata))
 649                         break;
 650
 651                 clk_disable(ddata->clocks[i]);
 652         }
 653
 654 idled:
 655         ddata->enabled = false;
 656
 657         return error;
 658 }
 659
 660 static int __maybe_unused sysc_runtime_resume(struct device *dev)
 661 {
 662         struct ti_sysc_platform_data *pdata;
 663         struct sysc *ddata;
 664         int error = 0, i;
 665
 666         ddata = dev_get_drvdata(dev);
 667
 668         if (ddata->enabled)
 669                 return 0;
 670
 671         if (ddata->legacy_mode) {
 672                 pdata = dev_get_platdata(ddata->dev);
 673                 if (!pdata)
 674                         return 0;
 675
 676                 if (!pdata->enable_module)
 677                         return -ENODEV;
 678
 679                 error = pdata->enable_module(dev, &ddata->cookie);
 680                 if (error)
 681                         dev_err(dev, "%s: could not enable: %i\n",
 682                                 __func__, error);
 683
 684                 goto awake;
 685         }
 686
 687         for (i = 0; i < ddata->nr_clocks; i++) {
 688                 if (IS_ERR_OR_NULL(ddata->clocks[i]))
 689                         continue;
 690
 691                 if (i >= SYSC_OPTFCK0 && !sysc_opt_clks_needed(ddata))
 692                         break;
 693
 694                 error = clk_enable(ddata->clocks[i]);
 695                 if (error)
 696                         return error;
 697         }
 698
 699 awake:
 700         ddata->enabled = true;
 701
 702         return error;
 703 }
 704
 705 #ifdef CONFIG_PM_SLEEP
 706 static int sysc_suspend(struct device *dev)
 707 {
 708         struct sysc *ddata;
 709         int error;
 710
 711         ddata = dev_get_drvdata(dev);
 712
 713         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 714                 return 0;
 715
 716         if (!ddata->enabled || ddata->noirq_suspend)
 717                 return 0;
 718
 719         dev_dbg(ddata->dev, "%s %s\n", __func__,
 720                 ddata->name ? ddata->name : "");
 721
 722         error = pm_runtime_put_sync_suspend(dev);
 723         if (error == -EBUSY) {
 724                 dev_dbg(ddata->dev, "%s busy, tagging for noirq suspend %s\n",
 725                         __func__, ddata->name ? ddata->name : "");
 726
 727                 ddata->noirq_suspend = true;
 728
 729                 return 0;
 730         } else if (error < 0) {
 731                 dev_warn(ddata->dev, "%s cannot suspend %i %s\n",
 732                          __func__, error,
 733                          ddata->name ? ddata->name : "");
 734
 735                 return 0;
 736         }
 737
 738         ddata->needs_resume = true;
 739
 740         return 0;
 741 }
 742
 743 static int sysc_resume(struct device *dev)
 744 {
 745         struct sysc *ddata;
 746         int error;
 747
 748         ddata = dev_get_drvdata(dev);
 749
 750         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 751                 return 0;
 752
 753         if (!ddata->needs_resume || ddata->noirq_suspend)
 754                 return 0;
 755
 756         dev_dbg(ddata->dev, "%s %s\n", __func__,
 757                 ddata->name ? ddata->name : "");
 758
 759         error = pm_runtime_get_sync(dev);
 760         if (error < 0) {
 761                 dev_err(ddata->dev, "%s  error %i %s\n",
 762                         __func__, error,
 763                         ddata->name ? ddata->name : "");
 764
 765                 return error;
 766         }
 767
 768         ddata->needs_resume = false;
 769
 770         return 0;
 771 }
 772
 773 static int sysc_noirq_suspend(struct device *dev)
 774 {
 775         struct sysc *ddata;
 776         int error;
 777
 778         ddata = dev_get_drvdata(dev);
 779
 780         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 781                 return 0;
 782
 783         if (!ddata->enabled || !ddata->noirq_suspend)
 784                 return 0;
 785
 786         dev_dbg(ddata->dev, "%s %s\n", __func__,
 787                 ddata->name ? ddata->name : "");
 788
 789         error = sysc_runtime_suspend(dev);
 790         if (error) {
 791                 dev_warn(ddata->dev, "%s busy %i %s\n",
 792                          __func__, error, ddata->name ? ddata->name : "");
 793
 794                 return 0;
 795         }
 796
 797         ddata->needs_resume = true;
 798
 799         return 0;
 800 }
 801
 802 static int sysc_noirq_resume(struct device *dev)
 803 {
 804         struct sysc *ddata;
 805         int error;
 806
 807         ddata = dev_get_drvdata(dev);
 808
 809         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 810                 return 0;
 811
 812         if (!ddata->needs_resume || !ddata->noirq_suspend)
 813                 return 0;
 814
 815         dev_dbg(ddata->dev, "%s %s\n", __func__,
 816                 ddata->name ? ddata->name : "");
 817
 818         error = sysc_runtime_resume(dev);
 819         if (error) {
 820                 dev_warn(ddata->dev, "%s cannot resume %i %s\n",
 821                          __func__, error,
 822                          ddata->name ? ddata->name : "");
 823
 824                 return error;
 825         }
 826
 827         /* Maybe also reconsider clearing noirq_suspend at some point */
 828         ddata->needs_resume = false;
 829
 830         return 0;
 831 }
 832 #endif
 833
 834 static const struct dev_pm_ops sysc_pm_ops = {
 835         SET_SYSTEM_SLEEP_PM_OPS(sysc_suspend, sysc_resume)
 836         SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sysc_noirq_suspend, sysc_noirq_resume)
 837         SET_RUNTIME_PM_OPS(sysc_runtime_suspend,
 838                            sysc_runtime_resume,
 839                            NULL)
 840 };
 841
 842 /* Module revision register based quirks */
 843 struct sysc_revision_quirk {
 844         const char *name;
 845         u32 base;
 846         int rev_offset;
 847         int sysc_offset;
 848         int syss_offset;
 849         u32 revision;
 850         u32 revision_mask;
 851         u32 quirks;
 852 };
 853
 854 #define SYSC_QUIRK(optname, optbase, optrev, optsysc, optsyss,          \
 855                    optrev_val, optrevmask, optquirkmask)                \
 856         {                                                               \
 857                 .name = (optname),                                      \
 858                 .base = (optbase),                                      \
 859                 .rev_offset = (optrev),                                 \
 860                 .sysc_offset = (optsysc),                               \
 861                 .syss_offset = (optsyss),                               \
 862                 .revision = (optrev_val),                               \
 863                 .revision_mask = (optrevmask),                          \
 864                 .quirks = (optquirkmask),                               \
 865         }
 866
 867 static const struct sysc_revision_quirk sysc_revision_quirks[] = {
 868         /* These drivers need to be fixed to not use pm_runtime_irq_safe() */
 869         SYSC_QUIRK("gpio", 0, 0, 0x10, 0x114, 0x50600801, 0xffff0fff,
 870                    SYSC_QUIRK_LEGACY_IDLE | SYSC_QUIRK_OPT_CLKS_IN_RESET),
 871         SYSC_QUIRK("mmu", 0, 0, 0x10, 0x14, 0x00000020, 0xffffffff,
 872                    SYSC_QUIRK_LEGACY_IDLE),
 873         SYSC_QUIRK("mmu", 0, 0, 0x10, 0x14, 0x00000030, 0xffffffff,
 874                    SYSC_QUIRK_LEGACY_IDLE),
 875         SYSC_QUIRK("sham", 0, 0x100, 0x110, 0x114, 0x40000c03, 0xffffffff,
 876                    SYSC_QUIRK_LEGACY_IDLE),
 877         SYSC_QUIRK("smartreflex", 0, -1, 0x24, -1, 0x00000000, 0xffffffff,
 878                    SYSC_QUIRK_LEGACY_IDLE),
 879         SYSC_QUIRK("smartreflex", 0, -1, 0x38, -1, 0x00000000, 0xffffffff,
 880                    SYSC_QUIRK_LEGACY_IDLE),
 881         SYSC_QUIRK("timer", 0, 0, 0x10, 0x14, 0x00000015, 0xffffffff,
 882                    SYSC_QUIRK_LEGACY_IDLE),
 883         /* Some timers on omap4 and later */
 884         SYSC_QUIRK("timer", 0, 0, 0x10, -1, 0x4fff1301, 0xffffffff,
 885                    SYSC_QUIRK_LEGACY_IDLE),
 886         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x00000052, 0xffffffff,
 887                    SYSC_QUIRK_LEGACY_IDLE),
 888         /* Uarts on omap4 and later */
 889         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x50411e03, 0xffff00ff,
 890                    SYSC_QUIRK_LEGACY_IDLE),
 891         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x47422e03, 0xffffffff,
 892                    SYSC_QUIRK_LEGACY_IDLE),
 893
 894 #ifdef DEBUG
 895         SYSC_QUIRK("adc", 0, 0, 0x10, -1, 0x47300001, 0xffffffff, 0),
 896         SYSC_QUIRK("aess", 0, 0, 0x10, -1, 0x40000000, 0xffffffff, 0),
 897         SYSC_QUIRK("control", 0, 0, 0x10, -1, 0x40000900, 0xffffffff, 0),
 898         SYSC_QUIRK("cpgmac", 0, 0x1200, 0x1208, 0x1204, 0x4edb1902,
 899                    0xffff00f0, 0),
 900         SYSC_QUIRK("dcan", 0, 0, -1, -1, 0xffffffff, 0xffffffff, 0),
 901         SYSC_QUIRK("dcan", 0, 0, -1, -1, 0x00001401, 0xffffffff, 0),
 902         SYSC_QUIRK("dwc3", 0, 0, 0x10, -1, 0x500a0200, 0xffffffff, 0),
 903         SYSC_QUIRK("epwmss", 0, 0, 0x4, -1, 0x47400001, 0xffffffff, 0),
 904         SYSC_QUIRK("gpu", 0, 0x1fc00, 0x1fc10, -1, 0, 0, 0),
 905         SYSC_QUIRK("hdq1w", 0, 0, 0x14, 0x18, 0x00000006, 0xffffffff, 0),
 906         SYSC_QUIRK("hdq1w", 0, 0, 0x14, 0x18, 0x0000000a, 0xffffffff, 0),
 907         SYSC_QUIRK("hsi", 0, 0, 0x10, 0x14, 0x50043101, 0xffffffff, 0),
 908         SYSC_QUIRK("iss", 0, 0, 0x10, -1, 0x40000101, 0xffffffff, 0),
 909         SYSC_QUIRK("i2c", 0, 0, 0x10, 0x90, 0x5040000a, 0xfffffff0, 0),
 910         SYSC_QUIRK("lcdc", 0, 0, 0x54, -1, 0x4f201000, 0xffffffff, 0),
 911         SYSC_QUIRK("mcasp", 0, 0, 0x4, -1, 0x44306302, 0xffffffff, 0),
 912         SYSC_QUIRK("mcasp", 0, 0, 0x4, -1, 0x44307b02, 0xffffffff, 0),
 913         SYSC_QUIRK("mcbsp", 0, -1, 0x8c, -1, 0, 0, 0),
 914         SYSC_QUIRK("mcspi", 0, 0, 0x10, -1, 0x40300a0b, 0xffffffff, 0),
 915         SYSC_QUIRK("mcspi", 0, 0, 0x110, 0x114, 0x40300a0b, 0xffffffff, 0),
 916         SYSC_QUIRK("mailbox", 0, 0, 0x10, -1, 0x00000400, 0xffffffff, 0),
 917         SYSC_QUIRK("m3", 0, 0, -1, -1, 0x5f580105, 0x0fff0f00, 0),
 918         SYSC_QUIRK("ocp2scp", 0, 0, 0x10, 0x14, 0x50060005, 0xffffffff, 0),
 919         SYSC_QUIRK("ocp2scp", 0, 0, -1, -1, 0x50060007, 0xffffffff, 0),
 920         SYSC_QUIRK("padconf", 0, 0, 0x10, -1, 0x4fff0800, 0xffffffff, 0),
 921         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x40000100, 0xffffffff, 0),
 922         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x00004102, 0xffffffff, 0),
 923         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x40000400, 0xffffffff, 0),
 924         SYSC_QUIRK("scm", 0, 0, 0x10, -1, 0x40000900, 0xffffffff, 0),
 925         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x4e8b0100, 0xffffffff, 0),
 926         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x4f000100, 0xffffffff, 0),
 927         SYSC_QUIRK("scrm", 0, 0, -1, -1, 0x00000010, 0xffffffff, 0),
 928         SYSC_QUIRK("sdio", 0, 0, 0x10, -1, 0x40202301, 0xffffffff, 0),
 929         SYSC_QUIRK("sdio", 0, 0x2fc, 0x110, 0x114, 0x31010000, 0xffffffff, 0),
 930         SYSC_QUIRK("sdma", 0, 0, 0x2c, 0x28, 0x00010900, 0xffffffff, 0),
 931         SYSC_QUIRK("slimbus", 0, 0, 0x10, -1, 0x40000902, 0xffffffff, 0),
 932         SYSC_QUIRK("slimbus", 0, 0, 0x10, -1, 0x40002903, 0xffffffff, 0),
 933         SYSC_QUIRK("spinlock", 0, 0, 0x10, -1, 0x50020000, 0xffffffff, 0),
 934         SYSC_QUIRK("rng", 0, 0x1fe0, 0x1fe4, -1, 0x00000020, 0xffffffff, 0),
 935         SYSC_QUIRK("rtc", 0, 0x74, 0x78, -1, 0x4eb01908, 0xfffff0f0, 0),
 936         SYSC_QUIRK("timer32k", 0, 0, 0x4, -1, 0x00000060, 0xffffffff, 0),
 937         SYSC_QUIRK("usbhstll", 0, 0, 0x10, 0x14, 0x00000004, 0xffffffff, 0),
 938         SYSC_QUIRK("usb_host_hs", 0, 0, 0x10, 0x14, 0x50700100, 0xffffffff, 0),
 939         SYSC_QUIRK("usb_otg_hs", 0, 0x400, 0x404, 0x408, 0x00000050,
 940                    0xffffffff, 0),
 941         SYSC_QUIRK("wdt", 0, 0, 0x10, 0x14, 0x502a0500, 0xfffff0f0, 0),
 942         SYSC_QUIRK("vfpe", 0, 0, 0x104, -1, 0x4d001200, 0xffffffff, 0),
 943 #endif
 944 };
 945
 946 static void sysc_init_revision_quirks(struct sysc *ddata)
 947 {
 948         const struct sysc_revision_quirk *q;
 949         int i;
 950
 951         for (i = 0; i < ARRAY_SIZE(sysc_revision_quirks); i++) {
 952                 q = &sysc_revision_quirks[i];
 953
 954                 if (q->base && q->base != ddata->module_pa)
 955                         continue;
 956
 957                 if (q->rev_offset >= 0 &&
 958                     q->rev_offset != ddata->offsets[SYSC_REVISION])
 959                         continue;
 960
 961                 if (q->sysc_offset >= 0 &&
 962                     q->sysc_offset != ddata->offsets[SYSC_SYSCONFIG])
 963                         continue;
 964
 965                 if (q->syss_offset >= 0 &&
 966                     q->syss_offset != ddata->offsets[SYSC_SYSSTATUS])
 967                         continue;
 968
 969                 if (q->revision == ddata->revision ||
 970                     (q->revision & q->revision_mask) ==
 971                     (ddata->revision & q->revision_mask)) {
 972                         ddata->name = q->name;
 973                         ddata->cfg.quirks |= q->quirks;
 974                 }
 975         }
 976 }
 977
 978 static int sysc_reset(struct sysc *ddata)
 979 {
 980         int offset = ddata->offsets[SYSC_SYSCONFIG];
 981         int val;
 982
 983         if (ddata->legacy_mode || offset < 0 ||
 984             ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT)
 985                 return 0;
 986
 987         /*
 988          * Currently only support reset status in sysstatus.
 989          * Warn and return error in all other cases
 990          */
 991         if (!ddata->cfg.syss_mask) {
 992                 dev_err(ddata->dev, "No ti,syss-mask. Reset failed\n");
 993                 return -EINVAL;
 994         }
 995
 996         val = sysc_read(ddata, offset);
 997         val |= (0x1 << ddata->cap->regbits->srst_shift);
 998         sysc_write(ddata, offset, val);
 999
1000         /* Poll on reset status */
1001         offset = ddata->offsets[SYSC_SYSSTATUS];
1002
1003         return readl_poll_timeout(ddata->module_va + offset, val,
1004                                   (val & ddata->cfg.syss_mask) == 0x0,
1005                                   100, MAX_MODULE_SOFTRESET_WAIT);
1006 }
1007
1008 /* At this point the module is configured enough to read the revision */
1009 static int sysc_init_module(struct sysc *ddata)
1010 {
1011         int error;
1012
1013         if (ddata->cfg.quirks & SYSC_QUIRK_NO_IDLE_ON_INIT) {
1014                 ddata->revision = sysc_read_revision(ddata);
1015                 goto rev_quirks;
1016         }
1017
1018         error = pm_runtime_get_sync(ddata->dev);
1019         if (error < 0) {
1020                 pm_runtime_put_noidle(ddata->dev);
1021
1022                 return 0;
1023         }
1024
1025         error = sysc_reset(ddata);
1026         if (error) {
1027                 dev_err(ddata->dev, "Reset failed with %d\n", error);
1028                 pm_runtime_put_sync(ddata->dev);
1029
1030                 return error;
1031         }
1032
1033         ddata->revision = sysc_read_revision(ddata);
1034         pm_runtime_put_sync(ddata->dev);
1035
1036 rev_quirks:
1037         sysc_init_revision_quirks(ddata);
1038
1039         return 0;
1040 }
1041
1042 static int sysc_init_sysc_mask(struct sysc *ddata)
1043 {
1044         struct device_node *np = ddata->dev->of_node;
1045         int error;
1046         u32 val;
1047
1048         error = of_property_read_u32(np, "ti,sysc-mask", &val);
1049         if (error)
1050                 return 0;
1051
1052         if (val)
1053                 ddata->cfg.sysc_val = val & ddata->cap->sysc_mask;
1054         else
1055                 ddata->cfg.sysc_val = ddata->cap->sysc_mask;
1056
1057         return 0;
1058 }
1059
1060 static int sysc_init_idlemode(struct sysc *ddata, u8 *idlemodes,
1061                               const char *name)
1062 {
1063         struct device_node *np = ddata->dev->of_node;
1064         struct property *prop;
1065         const __be32 *p;
1066         u32 val;
1067
1068         of_property_for_each_u32(np, name, prop, p, val) {
1069                 if (val >= SYSC_NR_IDLEMODES) {
1070                         dev_err(ddata->dev, "invalid idlemode: %i\n", val);
1071                         return -EINVAL;
1072                 }
1073                 *idlemodes |=  (1 << val);
1074         }
1075
1076         return 0;
1077 }
1078
1079 static int sysc_init_idlemodes(struct sysc *ddata)
1080 {
1081         int error;
1082
1083         error = sysc_init_idlemode(ddata, &ddata->cfg.midlemodes,
1084                                    "ti,sysc-midle");
1085         if (error)
1086                 return error;
1087
1088         error = sysc_init_idlemode(ddata, &ddata->cfg.sidlemodes,
1089                                    "ti,sysc-sidle");
1090         if (error)
1091                 return error;
1092
1093         return 0;
1094 }
1095
1096 /*
1097  * Only some devices on omap4 and later have SYSCONFIG reset done
1098  * bit. We can detect this if there is no SYSSTATUS at all, or the
1099  * SYSTATUS bit 0 is not used. Note that some SYSSTATUS registers
1100  * have multiple bits for the child devices like OHCI and EHCI.
1101  * Depends on SYSC being parsed first.
1102  */
1103 static int sysc_init_syss_mask(struct sysc *ddata)
1104 {
1105         struct device_node *np = ddata->dev->of_node;
1106         int error;
1107         u32 val;
1108
1109         error = of_property_read_u32(np, "ti,syss-mask", &val);
1110         if (error) {
1111                 if ((ddata->cap->type == TI_SYSC_OMAP4 ||
1112                      ddata->cap->type == TI_SYSC_OMAP4_TIMER) &&
1113                     (ddata->cfg.sysc_val & SYSC_OMAP4_SOFTRESET))
1114                         ddata->cfg.quirks |= SYSC_QUIRK_RESET_STATUS;
1115
1116                 return 0;
1117         }
1118
1119         if (!(val & 1) && (ddata->cfg.sysc_val & SYSC_OMAP4_SOFTRESET))
1120                 ddata->cfg.quirks |= SYSC_QUIRK_RESET_STATUS;
1121
1122         ddata->cfg.syss_mask = val;
1123
1124         return 0;
1125 }
1126
1127 /*
1128  * Many child device drivers need to have fck and opt clocks available
1129  * to get the clock rate for device internal configuration etc.
1130  */
1131 static int sysc_child_add_named_clock(struct sysc *ddata,
1132                                       struct device *child,
1133                                       const char *name)
1134 {
1135         struct clk *clk;
1136         struct clk_lookup *l;
1137         int error = 0;
1138
1139         if (!name)
1140                 return 0;
1141
1142         clk = clk_get(child, name);
1143         if (!IS_ERR(clk)) {
1144                 clk_put(clk);
1145
1146                 return -EEXIST;
1147         }
1148
1149         clk = clk_get(ddata->dev, name);
1150         if (IS_ERR(clk))
1151                 return -ENODEV;
1152
1153         l = clkdev_create(clk, name, dev_name(child));
1154         if (!l)
1155                 error = -ENOMEM;
1156
1157         clk_put(clk);
1158
1159         return error;
1160 }
1161
1162 static int sysc_child_add_clocks(struct sysc *ddata,
1163                                  struct device *child)
1164 {
1165         int i, error;
1166
1167         for (i = 0; i < ddata->nr_clocks; i++) {
1168                 error = sysc_child_add_named_clock(ddata,
1169                                                    child,
1170                                                    ddata->clock_roles[i]);
1171                 if (error && error != -EEXIST) {
1172                         dev_err(ddata->dev, "could not add child clock %s: %i\n",
1173                                 ddata->clock_roles[i], error);
1174
1175                         return error;
1176                 }
1177         }
1178
1179         return 0;
1180 }
1181
1182 static struct device_type sysc_device_type = {
1183 };
1184
1185 static struct sysc *sysc_child_to_parent(struct device *dev)
1186 {
1187         struct device *parent = dev->parent;
1188
1189         if (!parent || parent->type != &sysc_device_type)
1190                 return NULL;
1191
1192         return dev_get_drvdata(parent);
1193 }
1194
1195 static int __maybe_unused sysc_child_runtime_suspend(struct device *dev)
1196 {
1197         struct sysc *ddata;
1198         int error;
1199
1200         ddata = sysc_child_to_parent(dev);
1201
1202         error = pm_generic_runtime_suspend(dev);
1203         if (error)
1204                 return error;
1205
1206         if (!ddata->enabled)
1207                 return 0;
1208
1209         return sysc_runtime_suspend(ddata->dev);
1210 }
1211
1212 static int __maybe_unused sysc_child_runtime_resume(struct device *dev)
1213 {
1214         struct sysc *ddata;
1215         int error;
1216
1217         ddata = sysc_child_to_parent(dev);
1218
1219         if (!ddata->enabled) {
1220                 error = sysc_runtime_resume(ddata->dev);
1221                 if (error < 0)
1222                         dev_err(ddata->dev,
1223                                 "%s error: %i\n", __func__, error);
1224         }
1225
1226         return pm_generic_runtime_resume(dev);
1227 }
1228
1229 #ifdef CONFIG_PM_SLEEP
1230 static int sysc_child_suspend_noirq(struct device *dev)
1231 {
1232         struct sysc *ddata;
1233         int error;
1234
1235         ddata = sysc_child_to_parent(dev);
1236
1237         dev_dbg(ddata->dev, "%s %s\n", __func__,
1238                 ddata->name ? ddata->name : "");
1239
1240         error = pm_generic_suspend_noirq(dev);
1241         if (error) {
1242                 dev_err(dev, "%s error at %i: %i\n",
1243                         __func__, __LINE__, error);
1244
1245                 return error;
1246         }
1247
1248         if (!pm_runtime_status_suspended(dev)) {
1249                 error = pm_generic_runtime_suspend(dev);
1250                 if (error) {
1251                         dev_warn(dev, "%s busy at %i: %i\n",
1252                                  __func__, __LINE__, error);
1253
1254                         return 0;
1255                 }
1256
1257                 error = sysc_runtime_suspend(ddata->dev);
1258                 if (error) {
1259                         dev_err(dev, "%s error at %i: %i\n",
1260                                 __func__, __LINE__, error);
1261
1262                         return error;
1263                 }
1264
1265                 ddata->child_needs_resume = true;
1266         }
1267
1268         return 0;
1269 }
1270
1271 static int sysc_child_resume_noirq(struct device *dev)
1272 {
1273         struct sysc *ddata;
1274         int error;
1275
1276         ddata = sysc_child_to_parent(dev);
1277
1278         dev_dbg(ddata->dev, "%s %s\n", __func__,
1279                 ddata->name ? ddata->name : "");
1280
1281         if (ddata->child_needs_resume) {
1282                 ddata->child_needs_resume = false;
1283
1284                 error = sysc_runtime_resume(ddata->dev);
1285                 if (error)
1286                         dev_err(ddata->dev,
1287                                 "%s runtime resume error: %i\n",
1288                                 __func__, error);
1289
1290                 error = pm_generic_runtime_resume(dev);
1291                 if (error)
1292                         dev_err(ddata->dev,
1293                                 "%s generic runtime resume: %i\n",
1294                                 __func__, error);
1295         }
1296
1297         return pm_generic_resume_noirq(dev);
1298 }
1299 #endif
1300
1301 struct dev_pm_domain sysc_child_pm_domain = {
1302         .ops = {
1303                 SET_RUNTIME_PM_OPS(sysc_child_runtime_suspend,
1304                                    sysc_child_runtime_resume,
1305                                    NULL)
1306                 USE_PLATFORM_PM_SLEEP_OPS
1307                 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sysc_child_suspend_noirq,
1308                                               sysc_child_resume_noirq)
1309         }
1310 };
1311
1312 /**
1313  * sysc_legacy_idle_quirk - handle children in omap_device compatible way
1314  * @ddata: device driver data
1315  * @child: child device driver
1316  *
1317  * Allow idle for child devices as done with _od_runtime_suspend().
1318  * Otherwise many child devices will not idle because of the permanent
1319  * parent usecount set in pm_runtime_irq_safe().
1320  *
1321  * Note that the long term solution is to just modify the child device
1322  * drivers to not set pm_runtime_irq_safe() and then this can be just
1323  * dropped.
1324  */
1325 static void sysc_legacy_idle_quirk(struct sysc *ddata, struct device *child)
1326 {
1327         if (!ddata->legacy_mode)
1328                 return;
1329
1330         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
1331                 dev_pm_domain_set(child, &sysc_child_pm_domain);
1332 }
1333
1334 static int sysc_notifier_call(struct notifier_block *nb,
1335                               unsigned long event, void *device)
1336 {
1337         struct device *dev = device;
1338         struct sysc *ddata;
1339         int error;
1340
1341         ddata = sysc_child_to_parent(dev);
1342         if (!ddata)
1343                 return NOTIFY_DONE;
1344
1345         switch (event) {
1346         case BUS_NOTIFY_ADD_DEVICE:
1347                 error = sysc_child_add_clocks(ddata, dev);
1348                 if (error)
1349                         return error;
1350                 sysc_legacy_idle_quirk(ddata, dev);
1351                 break;
1352         default:
1353                 break;
1354         }
1355
1356         return NOTIFY_DONE;
1357 }
1358
1359 static struct notifier_block sysc_nb = {
1360         .notifier_call = sysc_notifier_call,
1361 };
1362
1363 /* Device tree configured quirks */
1364 struct sysc_dts_quirk {
1365         const char *name;
1366         u32 mask;
1367 };
1368
1369 static const struct sysc_dts_quirk sysc_dts_quirks[] = {
1370         { .name = "ti,no-idle-on-init",
1371           .mask = SYSC_QUIRK_NO_IDLE_ON_INIT, },
1372         { .name = "ti,no-reset-on-init",
1373           .mask = SYSC_QUIRK_NO_RESET_ON_INIT, },
1374 };
1375
1376 static int sysc_init_dts_quirks(struct sysc *ddata)
1377 {
1378         struct device_node *np = ddata->dev->of_node;
1379         const struct property *prop;
1380         int i, len, error;
1381         u32 val;
1382
1383         ddata->legacy_mode = of_get_property(np, "ti,hwmods", NULL);
1384
1385         for (i = 0; i < ARRAY_SIZE(sysc_dts_quirks); i++) {
1386                 prop = of_get_property(np, sysc_dts_quirks[i].name, &len);
1387                 if (!prop)
1388                         continue;
1389
1390                 ddata->cfg.quirks |= sysc_dts_quirks[i].mask;
1391         }
1392
1393         error = of_property_read_u32(np, "ti,sysc-delay-us", &val);
1394         if (!error) {
1395                 if (val > 255) {
1396                         dev_warn(ddata->dev, "bad ti,sysc-delay-us: %i\n",
1397                                  val);
1398                 }
1399
1400                 ddata->cfg.srst_udelay = (u8)val;
1401         }
1402
1403         return 0;
1404 }
1405
1406 static void sysc_unprepare(struct sysc *ddata)
1407 {
1408         int i;
1409
1410         for (i = 0; i < SYSC_MAX_CLOCKS; i++) {
1411                 if (!IS_ERR_OR_NULL(ddata->clocks[i]))
1412                         clk_unprepare(ddata->clocks[i]);
1413         }
1414 }
1415
1416 /*
1417  * Common sysc register bits found on omap2, also known as type1
1418  */
1419 static const struct sysc_regbits sysc_regbits_omap2 = {
1420         .dmadisable_shift = -ENODEV,
1421         .midle_shift = 12,
1422         .sidle_shift = 3,
1423         .clkact_shift = 8,
1424         .emufree_shift = 5,
1425         .enwkup_shift = 2,
1426         .srst_shift = 1,
1427         .autoidle_shift = 0,
1428 };
1429
1430 static const struct sysc_capabilities sysc_omap2 = {
1431         .type = TI_SYSC_OMAP2,
1432         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY | SYSC_OMAP2_EMUFREE |
1433                      SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_SOFTRESET |
1434                      SYSC_OMAP2_AUTOIDLE,
1435         .regbits = &sysc_regbits_omap2,
1436 };
1437
1438 /* All omap2 and 3 timers, and timers 1, 2 & 10 on omap 4 and 5 */
1439 static const struct sysc_capabilities sysc_omap2_timer = {
1440         .type = TI_SYSC_OMAP2_TIMER,
1441         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY | SYSC_OMAP2_EMUFREE |
1442                      SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_SOFTRESET |
1443                      SYSC_OMAP2_AUTOIDLE,
1444         .regbits = &sysc_regbits_omap2,
1445         .mod_quirks = SYSC_QUIRK_USE_CLOCKACT,
1446 };
1447
1448 /*
1449  * SHAM2 (SHA1/MD5) sysc found on omap3, a variant of sysc_regbits_omap2
1450  * with different sidle position
1451  */
1452 static const struct sysc_regbits sysc_regbits_omap3_sham = {
1453         .dmadisable_shift = -ENODEV,
1454         .midle_shift = -ENODEV,
1455         .sidle_shift = 4,
1456         .clkact_shift = -ENODEV,
1457         .enwkup_shift = -ENODEV,
1458         .srst_shift = 1,
1459         .autoidle_shift = 0,
1460         .emufree_shift = -ENODEV,
1461 };
1462
1463 static const struct sysc_capabilities sysc_omap3_sham = {
1464         .type = TI_SYSC_OMAP3_SHAM,
1465         .sysc_mask = SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE,
1466         .regbits = &sysc_regbits_omap3_sham,
1467 };
1468
1469 /*
1470  * AES register bits found on omap3 and later, a variant of
1471  * sysc_regbits_omap2 with different sidle position
1472  */
1473 static const struct sysc_regbits sysc_regbits_omap3_aes = {
1474         .dmadisable_shift = -ENODEV,
1475         .midle_shift = -ENODEV,
1476         .sidle_shift = 6,
1477         .clkact_shift = -ENODEV,
1478         .enwkup_shift = -ENODEV,
1479         .srst_shift = 1,
1480         .autoidle_shift = 0,
1481         .emufree_shift = -ENODEV,
1482 };
1483
1484 static const struct sysc_capabilities sysc_omap3_aes = {
1485         .type = TI_SYSC_OMAP3_AES,
1486         .sysc_mask = SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE,
1487         .regbits = &sysc_regbits_omap3_aes,
1488 };
1489
1490 /*
1491  * Common sysc register bits found on omap4, also known as type2
1492  */
1493 static const struct sysc_regbits sysc_regbits_omap4 = {
1494         .dmadisable_shift = 16,
1495         .midle_shift = 4,
1496         .sidle_shift = 2,
1497         .clkact_shift = -ENODEV,
1498         .enwkup_shift = -ENODEV,
1499         .emufree_shift = 1,
1500         .srst_shift = 0,
1501         .autoidle_shift = -ENODEV,
1502 };
1503
1504 static const struct sysc_capabilities sysc_omap4 = {
1505         .type = TI_SYSC_OMAP4,
1506         .sysc_mask = SYSC_OMAP4_DMADISABLE | SYSC_OMAP4_FREEEMU |
1507                      SYSC_OMAP4_SOFTRESET,
1508         .regbits = &sysc_regbits_omap4,
1509 };
1510
1511 static const struct sysc_capabilities sysc_omap4_timer = {
1512         .type = TI_SYSC_OMAP4_TIMER,
1513         .sysc_mask = SYSC_OMAP4_DMADISABLE | SYSC_OMAP4_FREEEMU |
1514                      SYSC_OMAP4_SOFTRESET,
1515         .regbits = &sysc_regbits_omap4,
1516 };
1517
1518 /*
1519  * Common sysc register bits found on omap4, also known as type3
1520  */
1521 static const struct sysc_regbits sysc_regbits_omap4_simple = {
1522         .dmadisable_shift = -ENODEV,
1523         .midle_shift = 2,
1524         .sidle_shift = 0,
1525         .clkact_shift = -ENODEV,
1526         .enwkup_shift = -ENODEV,
1527         .srst_shift = -ENODEV,
1528         .emufree_shift = -ENODEV,
1529         .autoidle_shift = -ENODEV,
1530 };
1531
1532 static const struct sysc_capabilities sysc_omap4_simple = {
1533         .type = TI_SYSC_OMAP4_SIMPLE,
1534         .regbits = &sysc_regbits_omap4_simple,
1535 };
1536
1537 /*
1538  * SmartReflex sysc found on omap34xx
1539  */
1540 static const struct sysc_regbits sysc_regbits_omap34xx_sr = {
1541         .dmadisable_shift = -ENODEV,
1542         .midle_shift = -ENODEV,
1543         .sidle_shift = -ENODEV,
1544         .clkact_shift = 20,
1545         .enwkup_shift = -ENODEV,
1546         .srst_shift = -ENODEV,
1547         .emufree_shift = -ENODEV,
1548         .autoidle_shift = -ENODEV,
1549 };
1550
1551 static const struct sysc_capabilities sysc_34xx_sr = {
1552         .type = TI_SYSC_OMAP34XX_SR,
1553         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY,
1554         .regbits = &sysc_regbits_omap34xx_sr,
1555         .mod_quirks = SYSC_QUIRK_USE_CLOCKACT | SYSC_QUIRK_UNCACHED |
1556                       SYSC_QUIRK_LEGACY_IDLE,
1557 };
1558
1559 /*
1560  * SmartReflex sysc found on omap36xx and later
1561  */
1562 static const struct sysc_regbits sysc_regbits_omap36xx_sr = {
1563         .dmadisable_shift = -ENODEV,
1564         .midle_shift = -ENODEV,
1565         .sidle_shift = 24,
1566         .clkact_shift = -ENODEV,
1567         .enwkup_shift = 26,
1568         .srst_shift = -ENODEV,
1569         .emufree_shift = -ENODEV,
1570         .autoidle_shift = -ENODEV,
1571 };
1572
1573 static const struct sysc_capabilities sysc_36xx_sr = {
1574         .type = TI_SYSC_OMAP36XX_SR,
1575         .sysc_mask = SYSC_OMAP3_SR_ENAWAKEUP,
1576         .regbits = &sysc_regbits_omap36xx_sr,
1577         .mod_quirks = SYSC_QUIRK_UNCACHED | SYSC_QUIRK_LEGACY_IDLE,
1578 };
1579
1580 static const struct sysc_capabilities sysc_omap4_sr = {
1581         .type = TI_SYSC_OMAP4_SR,
1582         .regbits = &sysc_regbits_omap36xx_sr,
1583         .mod_quirks = SYSC_QUIRK_LEGACY_IDLE,
1584 };
1585
1586 /*
1587  * McASP register bits found on omap4 and later
1588  */
1589 static const struct sysc_regbits sysc_regbits_omap4_mcasp = {
1590         .dmadisable_shift = -ENODEV,
1591         .midle_shift = -ENODEV,
1592         .sidle_shift = 0,
1593         .clkact_shift = -ENODEV,
1594         .enwkup_shift = -ENODEV,
1595         .srst_shift = -ENODEV,
1596         .emufree_shift = -ENODEV,
1597         .autoidle_shift = -ENODEV,
1598 };
1599
1600 static const struct sysc_capabilities sysc_omap4_mcasp = {
1601         .type = TI_SYSC_OMAP4_MCASP,
1602         .regbits = &sysc_regbits_omap4_mcasp,
1603 };
1604
1605 /*
1606  * FS USB host found on omap4 and later
1607  */
1608 static const struct sysc_regbits sysc_regbits_omap4_usb_host_fs = {
1609         .dmadisable_shift = -ENODEV,
1610         .midle_shift = -ENODEV,
1611         .sidle_shift = 24,
1612         .clkact_shift = -ENODEV,
1613         .enwkup_shift = 26,
1614         .srst_shift = -ENODEV,
1615         .emufree_shift = -ENODEV,
1616         .autoidle_shift = -ENODEV,
1617 };
1618
1619 static const struct sysc_capabilities sysc_omap4_usb_host_fs = {
1620         .type = TI_SYSC_OMAP4_USB_HOST_FS,
1621         .sysc_mask = SYSC_OMAP2_ENAWAKEUP,
1622         .regbits = &sysc_regbits_omap4_usb_host_fs,
1623 };
1624
1625 static const struct sysc_regbits sysc_regbits_dra7_mcan = {
1626         .dmadisable_shift = -ENODEV,
1627         .midle_shift = -ENODEV,
1628         .sidle_shift = -ENODEV,
1629         .clkact_shift = -ENODEV,
1630         .enwkup_shift = 4,
1631         .srst_shift = 0,
1632         .emufree_shift = -ENODEV,
1633         .autoidle_shift = -ENODEV,
1634 };
1635
1636 static const struct sysc_capabilities sysc_dra7_mcan = {
1637         .type = TI_SYSC_DRA7_MCAN,
1638         .sysc_mask = SYSC_DRA7_MCAN_ENAWAKEUP | SYSC_OMAP4_SOFTRESET,
1639         .regbits = &sysc_regbits_dra7_mcan,
1640 };
1641
1642 static int sysc_init_pdata(struct sysc *ddata)
1643 {
1644         struct ti_sysc_platform_data *pdata = dev_get_platdata(ddata->dev);
1645         struct ti_sysc_module_data mdata;
1646         int error = 0;
1647
1648         if (!pdata || !ddata->legacy_mode)
1649                 return 0;
1650
1651         mdata.name = ddata->legacy_mode;
1652         mdata.module_pa = ddata->module_pa;
1653         mdata.module_size = ddata->module_size;
1654         mdata.offsets = ddata->offsets;
1655         mdata.nr_offsets = SYSC_MAX_REGS;
1656         mdata.cap = ddata->cap;
1657         mdata.cfg = &ddata->cfg;
1658
1659         if (!pdata->init_module)
1660                 return -ENODEV;
1661
1662         error = pdata->init_module(ddata->dev, &mdata, &ddata->cookie);
1663         if (error == -EEXIST)
1664                 error = 0;
1665
1666         return error;
1667 }
1668
1669 static int sysc_init_match(struct sysc *ddata)
1670 {
1671         const struct sysc_capabilities *cap;
1672
1673         cap = of_device_get_match_data(ddata->dev);
1674         if (!cap)
1675                 return -EINVAL;
1676
1677         ddata->cap = cap;
1678         if (ddata->cap)
1679                 ddata->cfg.quirks |= ddata->cap->mod_quirks;
1680
1681         return 0;
1682 }
1683
1684 static void ti_sysc_idle(struct work_struct *work)
1685 {
1686         struct sysc *ddata;
1687
1688         ddata = container_of(work, struct sysc, idle_work.work);
1689
1690         if (pm_runtime_active(ddata->dev))
1691                 pm_runtime_put_sync(ddata->dev);
1692 }
1693
1694 static const struct of_device_id sysc_match_table[] = {
1695         { .compatible = "simple-bus", },
1696         { /* sentinel */ },
1697 };
1698
1699 static int sysc_probe(struct platform_device *pdev)
1700 {
1701         struct ti_sysc_platform_data *pdata = dev_get_platdata(&pdev->dev);
1702         struct sysc *ddata;
1703         int error;
1704
1705         ddata = devm_kzalloc(&pdev->dev, sizeof(*ddata), GFP_KERNEL);
1706         if (!ddata)
1707                 return -ENOMEM;
1708
1709         ddata->dev = &pdev->dev;
1710         platform_set_drvdata(pdev, ddata);
1711
1712         error = sysc_init_match(ddata);
1713         if (error)
1714                 return error;
1715
1716         error = sysc_init_dts_quirks(ddata);
1717         if (error)
1718                 goto unprepare;
1719
1720         error = sysc_get_clocks(ddata);
1721         if (error)
1722                 return error;
1723
1724         error = sysc_map_and_check_registers(ddata);
1725         if (error)
1726                 goto unprepare;
1727
1728         error = sysc_init_sysc_mask(ddata);
1729         if (error)
1730                 goto unprepare;
1731
1732         error = sysc_init_idlemodes(ddata);
1733         if (error)
1734                 goto unprepare;
1735
1736         error = sysc_init_syss_mask(ddata);
1737         if (error)
1738                 goto unprepare;
1739
1740         error = sysc_init_pdata(ddata);
1741         if (error)
1742                 goto unprepare;
1743
1744         error = sysc_init_resets(ddata);
1745         if (error)
1746                 return error;
1747
1748         pm_runtime_enable(ddata->dev);
1749         error = sysc_init_module(ddata);
1750         if (error)
1751                 goto unprepare;
1752
1753         error = pm_runtime_get_sync(ddata->dev);
1754         if (error < 0) {
1755                 pm_runtime_put_noidle(ddata->dev);
1756                 pm_runtime_disable(ddata->dev);
1757                 goto unprepare;
1758         }
1759
1760         sysc_show_registers(ddata);
1761
1762         ddata->dev->type = &sysc_device_type;
1763         error = of_platform_populate(ddata->dev->of_node, sysc_match_table,
1764                                      pdata ? pdata->auxdata : NULL,
1765                                      ddata->dev);
1766         if (error)
1767                 goto err;
1768
1769         INIT_DELAYED_WORK(&ddata->idle_work, ti_sysc_idle);
1770
1771         /* At least earlycon won't survive without deferred idle */
1772         if (ddata->cfg.quirks & (SYSC_QUIRK_NO_IDLE_ON_INIT |
1773                                  SYSC_QUIRK_NO_RESET_ON_INIT)) {
1774                 schedule_delayed_work(&ddata->idle_work, 3000);
1775         } else {
1776                 pm_runtime_put(&pdev->dev);
1777         }
1778
1779         if (!of_get_available_child_count(ddata->dev->of_node))
1780                 reset_control_assert(ddata->rsts);
1781
1782         return 0;
1783
1784 err:
1785         pm_runtime_put_sync(&pdev->dev);
1786         pm_runtime_disable(&pdev->dev);
1787 unprepare:
1788         sysc_unprepare(ddata);
1789
1790         return error;
1791 }
1792
1793 static int sysc_remove(struct platform_device *pdev)
1794 {
1795         struct sysc *ddata = platform_get_drvdata(pdev);
1796         int error;
1797
1798         cancel_delayed_work_sync(&ddata->idle_work);
1799
1800         error = pm_runtime_get_sync(ddata->dev);
1801         if (error < 0) {
1802                 pm_runtime_put_noidle(ddata->dev);
1803                 pm_runtime_disable(ddata->dev);
1804                 goto unprepare;
1805         }
1806
1807         of_platform_depopulate(&pdev->dev);
1808
1809         pm_runtime_put_sync(&pdev->dev);
1810         pm_runtime_disable(&pdev->dev);
1811         reset_control_assert(ddata->rsts);
1812
1813 unprepare:
1814         sysc_unprepare(ddata);
1815
1816         return 0;
1817 }
1818
1819 static const struct of_device_id sysc_match[] = {
1820         { .compatible = "ti,sysc-omap2", .data = &sysc_omap2, },
1821         { .compatible = "ti,sysc-omap2-timer", .data = &sysc_omap2_timer, },
1822         { .compatible = "ti,sysc-omap4", .data = &sysc_omap4, },
1823         { .compatible = "ti,sysc-omap4-timer", .data = &sysc_omap4_timer, },
1824         { .compatible = "ti,sysc-omap4-simple", .data = &sysc_omap4_simple, },
1825         { .compatible = "ti,sysc-omap3430-sr", .data = &sysc_34xx_sr, },
1826         { .compatible = "ti,sysc-omap3630-sr", .data = &sysc_36xx_sr, },
1827         { .compatible = "ti,sysc-omap4-sr", .data = &sysc_omap4_sr, },
1828         { .compatible = "ti,sysc-omap3-sham", .data = &sysc_omap3_sham, },
1829         { .compatible = "ti,sysc-omap-aes", .data = &sysc_omap3_aes, },
1830         { .compatible = "ti,sysc-mcasp", .data = &sysc_omap4_mcasp, },
1831         { .compatible = "ti,sysc-usb-host-fs",
1832           .data = &sysc_omap4_usb_host_fs, },
1833         { .compatible = "ti,sysc-dra7-mcan", .data = &sysc_dra7_mcan, },
1834         {  },
1835 };
1836 MODULE_DEVICE_TABLE(of, sysc_match);
1837
1838 static struct platform_driver sysc_driver = {
1839         .probe          = sysc_probe,
1840         .remove         = sysc_remove,
1841         .driver         = {
1842                 .name   = "ti-sysc",
1843                 .of_match_table = sysc_match,
1844                 .pm = &sysc_pm_ops,
1845         },
1846 };
1847
1848 static int __init sysc_init(void)
1849 {
1850         bus_register_notifier(&platform_bus_type, &sysc_nb);
1851
1852         return platform_driver_register(&sysc_driver);
1853 }
1854 module_init(sysc_init);
1855
1856 static void __exit sysc_exit(void)
1857 {
1858         bus_unregister_notifier(&platform_bus_type, &sysc_nb);
1859         platform_driver_unregister(&sysc_driver);
1860 }
1861 module_exit(sysc_exit);
1862
1863 MODULE_DESCRIPTION("TI sysc interconnect target driver");
1864 MODULE_LICENSE("GPL v2");