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: deviec driver data
 503  *
 504  * Note that the interconnect target module registers can be anywhere
 505  * within the first child device address space. For example, SGX has
 506  * them at offset 0x1fc00 in the 32MB module address space. We just
 507  * what we need around the interconnect target module registers.
 508  */
 509 static int sysc_ioremap(struct sysc *ddata)
 510 {
 511         u32 size = 0;
 512
 513         if (ddata->offsets[SYSC_SYSSTATUS] >= 0)
 514                 size = ddata->offsets[SYSC_SYSSTATUS];
 515         else if (ddata->offsets[SYSC_SYSCONFIG] >= 0)
 516                 size = ddata->offsets[SYSC_SYSCONFIG];
 517         else if (ddata->offsets[SYSC_REVISION] >= 0)
 518                 size = ddata->offsets[SYSC_REVISION];
 519         else
 520                 return -EINVAL;
 521
 522         size &= 0xfff00;
 523         size += SZ_256;
 524
 525         ddata->module_va = devm_ioremap(ddata->dev,
 526                                         ddata->module_pa,
 527                                         size);
 528         if (!ddata->module_va)
 529                 return -EIO;
 530
 531         return 0;
 532 }
 533
 534 /**
 535  * sysc_map_and_check_registers - ioremap and check device registers
 536  * @ddata: device driver data
 537  */
 538 static int sysc_map_and_check_registers(struct sysc *ddata)
 539 {
 540         int error;
 541
 542         error = sysc_parse_and_check_child_range(ddata);
 543         if (error)
 544                 return error;
 545
 546         error = sysc_check_children(ddata);
 547         if (error)
 548                 return error;
 549
 550         error = sysc_parse_registers(ddata);
 551         if (error)
 552                 return error;
 553
 554         error = sysc_ioremap(ddata);
 555         if (error)
 556                 return error;
 557
 558         error = sysc_check_registers(ddata);
 559         if (error)
 560                 return error;
 561
 562         return 0;
 563 }
 564
 565 /**
 566  * sysc_show_rev - read and show interconnect target module revision
 567  * @bufp: buffer to print the information to
 568  * @ddata: device driver data
 569  */
 570 static int sysc_show_rev(char *bufp, struct sysc *ddata)
 571 {
 572         int len;
 573
 574         if (ddata->offsets[SYSC_REVISION] < 0)
 575                 return sprintf(bufp, ":NA");
 576
 577         len = sprintf(bufp, ":%08x", ddata->revision);
 578
 579         return len;
 580 }
 581
 582 static int sysc_show_reg(struct sysc *ddata,
 583                          char *bufp, enum sysc_registers reg)
 584 {
 585         if (ddata->offsets[reg] < 0)
 586                 return sprintf(bufp, ":NA");
 587
 588         return sprintf(bufp, ":%x", ddata->offsets[reg]);
 589 }
 590
 591 static int sysc_show_name(char *bufp, struct sysc *ddata)
 592 {
 593         if (!ddata->name)
 594                 return 0;
 595
 596         return sprintf(bufp, ":%s", ddata->name);
 597 }
 598
 599 /**
 600  * sysc_show_registers - show information about interconnect target module
 601  * @ddata: device driver data
 602  */
 603 static void sysc_show_registers(struct sysc *ddata)
 604 {
 605         char buf[128];
 606         char *bufp = buf;
 607         int i;
 608
 609         for (i = 0; i < SYSC_MAX_REGS; i++)
 610                 bufp += sysc_show_reg(ddata, bufp, i);
 611
 612         bufp += sysc_show_rev(bufp, ddata);
 613         bufp += sysc_show_name(bufp, ddata);
 614
 615         dev_dbg(ddata->dev, "%llx:%x%s\n",
 616                 ddata->module_pa, ddata->module_size,
 617                 buf);
 618 }
 619
 620 static int __maybe_unused sysc_runtime_suspend(struct device *dev)
 621 {
 622         struct ti_sysc_platform_data *pdata;
 623         struct sysc *ddata;
 624         int error = 0, i;
 625
 626         ddata = dev_get_drvdata(dev);
 627
 628         if (!ddata->enabled)
 629                 return 0;
 630
 631         if (ddata->legacy_mode) {
 632                 pdata = dev_get_platdata(ddata->dev);
 633                 if (!pdata)
 634                         return 0;
 635
 636                 if (!pdata->idle_module)
 637                         return -ENODEV;
 638
 639                 error = pdata->idle_module(dev, &ddata->cookie);
 640                 if (error)
 641                         dev_err(dev, "%s: could not idle: %i\n",
 642                                 __func__, error);
 643
 644                 goto idled;
 645         }
 646
 647         for (i = 0; i < ddata->nr_clocks; i++) {
 648                 if (IS_ERR_OR_NULL(ddata->clocks[i]))
 649                         continue;
 650
 651                 if (i >= SYSC_OPTFCK0 && !sysc_opt_clks_needed(ddata))
 652                         break;
 653
 654                 clk_disable(ddata->clocks[i]);
 655         }
 656
 657 idled:
 658         ddata->enabled = false;
 659
 660         return error;
 661 }
 662
 663 static int __maybe_unused sysc_runtime_resume(struct device *dev)
 664 {
 665         struct ti_sysc_platform_data *pdata;
 666         struct sysc *ddata;
 667         int error = 0, i;
 668
 669         ddata = dev_get_drvdata(dev);
 670
 671         if (ddata->enabled)
 672                 return 0;
 673
 674         if (ddata->legacy_mode) {
 675                 pdata = dev_get_platdata(ddata->dev);
 676                 if (!pdata)
 677                         return 0;
 678
 679                 if (!pdata->enable_module)
 680                         return -ENODEV;
 681
 682                 error = pdata->enable_module(dev, &ddata->cookie);
 683                 if (error)
 684                         dev_err(dev, "%s: could not enable: %i\n",
 685                                 __func__, error);
 686
 687                 goto awake;
 688         }
 689
 690         for (i = 0; i < ddata->nr_clocks; i++) {
 691                 if (IS_ERR_OR_NULL(ddata->clocks[i]))
 692                         continue;
 693
 694                 if (i >= SYSC_OPTFCK0 && !sysc_opt_clks_needed(ddata))
 695                         break;
 696
 697                 error = clk_enable(ddata->clocks[i]);
 698                 if (error)
 699                         return error;
 700         }
 701
 702 awake:
 703         ddata->enabled = true;
 704
 705         return error;
 706 }
 707
 708 #ifdef CONFIG_PM_SLEEP
 709 static int sysc_suspend(struct device *dev)
 710 {
 711         struct sysc *ddata;
 712         int error;
 713
 714         ddata = dev_get_drvdata(dev);
 715
 716         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 717                 return 0;
 718
 719         if (!ddata->enabled || ddata->noirq_suspend)
 720                 return 0;
 721
 722         dev_dbg(ddata->dev, "%s %s\n", __func__,
 723                 ddata->name ? ddata->name : "");
 724
 725         error = pm_runtime_put_sync_suspend(dev);
 726         if (error == -EBUSY) {
 727                 dev_dbg(ddata->dev, "%s busy, tagging for noirq suspend %s\n",
 728                         __func__, ddata->name ? ddata->name : "");
 729
 730                 ddata->noirq_suspend = true;
 731
 732                 return 0;
 733         } else if (error < 0) {
 734                 dev_warn(ddata->dev, "%s cannot suspend %i %s\n",
 735                          __func__, error,
 736                          ddata->name ? ddata->name : "");
 737
 738                 return 0;
 739         }
 740
 741         ddata->needs_resume = true;
 742
 743         return 0;
 744 }
 745
 746 static int sysc_resume(struct device *dev)
 747 {
 748         struct sysc *ddata;
 749         int error;
 750
 751         ddata = dev_get_drvdata(dev);
 752
 753         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 754                 return 0;
 755
 756         if (!ddata->needs_resume || ddata->noirq_suspend)
 757                 return 0;
 758
 759         dev_dbg(ddata->dev, "%s %s\n", __func__,
 760                 ddata->name ? ddata->name : "");
 761
 762         error = pm_runtime_get_sync(dev);
 763         if (error < 0) {
 764                 dev_err(ddata->dev, "%s  error %i %s\n",
 765                         __func__, error,
 766                         ddata->name ? ddata->name : "");
 767
 768                 return error;
 769         }
 770
 771         ddata->needs_resume = false;
 772
 773         return 0;
 774 }
 775
 776 static int sysc_noirq_suspend(struct device *dev)
 777 {
 778         struct sysc *ddata;
 779         int error;
 780
 781         ddata = dev_get_drvdata(dev);
 782
 783         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 784                 return 0;
 785
 786         if (!ddata->enabled || !ddata->noirq_suspend)
 787                 return 0;
 788
 789         dev_dbg(ddata->dev, "%s %s\n", __func__,
 790                 ddata->name ? ddata->name : "");
 791
 792         error = sysc_runtime_suspend(dev);
 793         if (error) {
 794                 dev_warn(ddata->dev, "%s busy %i %s\n",
 795                          __func__, error, ddata->name ? ddata->name : "");
 796
 797                 return 0;
 798         }
 799
 800         ddata->needs_resume = true;
 801
 802         return 0;
 803 }
 804
 805 static int sysc_noirq_resume(struct device *dev)
 806 {
 807         struct sysc *ddata;
 808         int error;
 809
 810         ddata = dev_get_drvdata(dev);
 811
 812         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
 813                 return 0;
 814
 815         if (!ddata->needs_resume || !ddata->noirq_suspend)
 816                 return 0;
 817
 818         dev_dbg(ddata->dev, "%s %s\n", __func__,
 819                 ddata->name ? ddata->name : "");
 820
 821         error = sysc_runtime_resume(dev);
 822         if (error) {
 823                 dev_warn(ddata->dev, "%s cannot resume %i %s\n",
 824                          __func__, error,
 825                          ddata->name ? ddata->name : "");
 826
 827                 return error;
 828         }
 829
 830         /* Maybe also reconsider clearing noirq_suspend at some point */
 831         ddata->needs_resume = false;
 832
 833         return 0;
 834 }
 835 #endif
 836
 837 static const struct dev_pm_ops sysc_pm_ops = {
 838         SET_SYSTEM_SLEEP_PM_OPS(sysc_suspend, sysc_resume)
 839         SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sysc_noirq_suspend, sysc_noirq_resume)
 840         SET_RUNTIME_PM_OPS(sysc_runtime_suspend,
 841                            sysc_runtime_resume,
 842                            NULL)
 843 };
 844
 845 /* Module revision register based quirks */
 846 struct sysc_revision_quirk {
 847         const char *name;
 848         u32 base;
 849         int rev_offset;
 850         int sysc_offset;
 851         int syss_offset;
 852         u32 revision;
 853         u32 revision_mask;
 854         u32 quirks;
 855 };
 856
 857 #define SYSC_QUIRK(optname, optbase, optrev, optsysc, optsyss,          \
 858                    optrev_val, optrevmask, optquirkmask)                \
 859         {                                                               \
 860                 .name = (optname),                                      \
 861                 .base = (optbase),                                      \
 862                 .rev_offset = (optrev),                                 \
 863                 .sysc_offset = (optsysc),                               \
 864                 .syss_offset = (optsyss),                               \
 865                 .revision = (optrev_val),                               \
 866                 .revision_mask = (optrevmask),                          \
 867                 .quirks = (optquirkmask),                               \
 868         }
 869
 870 static const struct sysc_revision_quirk sysc_revision_quirks[] = {
 871         /* These drivers need to be fixed to not use pm_runtime_irq_safe() */
 872         SYSC_QUIRK("gpio", 0, 0, 0x10, 0x114, 0x50600801, 0xffff0fff,
 873                    SYSC_QUIRK_LEGACY_IDLE | SYSC_QUIRK_OPT_CLKS_IN_RESET),
 874         SYSC_QUIRK("mmu", 0, 0, 0x10, 0x14, 0x00000020, 0xffffffff,
 875                    SYSC_QUIRK_LEGACY_IDLE),
 876         SYSC_QUIRK("mmu", 0, 0, 0x10, 0x14, 0x00000030, 0xffffffff,
 877                    SYSC_QUIRK_LEGACY_IDLE),
 878         SYSC_QUIRK("sham", 0, 0x100, 0x110, 0x114, 0x40000c03, 0xffffffff,
 879                    SYSC_QUIRK_LEGACY_IDLE),
 880         SYSC_QUIRK("smartreflex", 0, -1, 0x24, -1, 0x00000000, 0xffffffff,
 881                    SYSC_QUIRK_LEGACY_IDLE),
 882         SYSC_QUIRK("smartreflex", 0, -1, 0x38, -1, 0x00000000, 0xffffffff,
 883                    SYSC_QUIRK_LEGACY_IDLE),
 884         SYSC_QUIRK("timer", 0, 0, 0x10, 0x14, 0x00000015, 0xffffffff,
 885                    SYSC_QUIRK_LEGACY_IDLE),
 886         /* Some timers on omap4 and later */
 887         SYSC_QUIRK("timer", 0, 0, 0x10, -1, 0x4fff1301, 0xffffffff,
 888                    SYSC_QUIRK_LEGACY_IDLE),
 889         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x00000052, 0xffffffff,
 890                    SYSC_QUIRK_LEGACY_IDLE),
 891         /* Uarts on omap4 and later */
 892         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x50411e03, 0xffff00ff,
 893                    SYSC_QUIRK_LEGACY_IDLE),
 894         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x47422e03, 0xffffffff,
 895                    SYSC_QUIRK_LEGACY_IDLE),
 896
 897 #ifdef DEBUG
 898         SYSC_QUIRK("adc", 0, 0, 0x10, -1, 0x47300001, 0xffffffff, 0),
 899         SYSC_QUIRK("aess", 0, 0, 0x10, -1, 0x40000000, 0xffffffff, 0),
 900         SYSC_QUIRK("control", 0, 0, 0x10, -1, 0x40000900, 0xffffffff, 0),
 901         SYSC_QUIRK("cpgmac", 0, 0x1200, 0x1208, 0x1204, 0x4edb1902,
 902                    0xffff00f0, 0),
 903         SYSC_QUIRK("dcan", 0, 0, -1, -1, 0xffffffff, 0xffffffff, 0),
 904         SYSC_QUIRK("dcan", 0, 0, -1, -1, 0x00001401, 0xffffffff, 0),
 905         SYSC_QUIRK("dwc3", 0, 0, 0x10, -1, 0x500a0200, 0xffffffff, 0),
 906         SYSC_QUIRK("epwmss", 0, 0, 0x4, -1, 0x47400001, 0xffffffff, 0),
 907         SYSC_QUIRK("gpu", 0, 0x1fc00, 0x1fc10, -1, 0, 0, 0),
 908         SYSC_QUIRK("hdq1w", 0, 0, 0x14, 0x18, 0x00000006, 0xffffffff, 0),
 909         SYSC_QUIRK("hdq1w", 0, 0, 0x14, 0x18, 0x0000000a, 0xffffffff, 0),
 910         SYSC_QUIRK("hsi", 0, 0, 0x10, 0x14, 0x50043101, 0xffffffff, 0),
 911         SYSC_QUIRK("iss", 0, 0, 0x10, -1, 0x40000101, 0xffffffff, 0),
 912         SYSC_QUIRK("i2c", 0, 0, 0x10, 0x90, 0x5040000a, 0xfffffff0, 0),
 913         SYSC_QUIRK("lcdc", 0, 0, 0x54, -1, 0x4f201000, 0xffffffff, 0),
 914         SYSC_QUIRK("mcasp", 0, 0, 0x4, -1, 0x44306302, 0xffffffff, 0),
 915         SYSC_QUIRK("mcasp", 0, 0, 0x4, -1, 0x44307b02, 0xffffffff, 0),
 916         SYSC_QUIRK("mcbsp", 0, -1, 0x8c, -1, 0, 0, 0),
 917         SYSC_QUIRK("mcspi", 0, 0, 0x10, -1, 0x40300a0b, 0xffffffff, 0),
 918         SYSC_QUIRK("mcspi", 0, 0, 0x110, 0x114, 0x40300a0b, 0xffffffff, 0),
 919         SYSC_QUIRK("mailbox", 0, 0, 0x10, -1, 0x00000400, 0xffffffff, 0),
 920         SYSC_QUIRK("m3", 0, 0, -1, -1, 0x5f580105, 0x0fff0f00, 0),
 921         SYSC_QUIRK("ocp2scp", 0, 0, 0x10, 0x14, 0x50060005, 0xffffffff, 0),
 922         SYSC_QUIRK("ocp2scp", 0, 0, -1, -1, 0x50060007, 0xffffffff, 0),
 923         SYSC_QUIRK("padconf", 0, 0, 0x10, -1, 0x4fff0800, 0xffffffff, 0),
 924         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x40000100, 0xffffffff, 0),
 925         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x00004102, 0xffffffff, 0),
 926         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x40000400, 0xffffffff, 0),
 927         SYSC_QUIRK("scm", 0, 0, 0x10, -1, 0x40000900, 0xffffffff, 0),
 928         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x4e8b0100, 0xffffffff, 0),
 929         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x4f000100, 0xffffffff, 0),
 930         SYSC_QUIRK("scrm", 0, 0, -1, -1, 0x00000010, 0xffffffff, 0),
 931         SYSC_QUIRK("sdio", 0, 0, 0x10, -1, 0x40202301, 0xffffffff, 0),
 932         SYSC_QUIRK("sdio", 0, 0x2fc, 0x110, 0x114, 0x31010000, 0xffffffff, 0),
 933         SYSC_QUIRK("sdma", 0, 0, 0x2c, 0x28, 0x00010900, 0xffffffff, 0),
 934         SYSC_QUIRK("slimbus", 0, 0, 0x10, -1, 0x40000902, 0xffffffff, 0),
 935         SYSC_QUIRK("slimbus", 0, 0, 0x10, -1, 0x40002903, 0xffffffff, 0),
 936         SYSC_QUIRK("spinlock", 0, 0, 0x10, -1, 0x50020000, 0xffffffff, 0),
 937         SYSC_QUIRK("rng", 0, 0x1fe0, 0x1fe4, -1, 0x00000020, 0xffffffff, 0),
 938         SYSC_QUIRK("rtc", 0, 0x74, 0x78, -1, 0x4eb01908, 0xfffff0f0, 0),
 939         SYSC_QUIRK("timer32k", 0, 0, 0x4, -1, 0x00000060, 0xffffffff, 0),
 940         SYSC_QUIRK("usbhstll", 0, 0, 0x10, 0x14, 0x00000004, 0xffffffff, 0),
 941         SYSC_QUIRK("usb_host_hs", 0, 0, 0x10, 0x14, 0x50700100, 0xffffffff, 0),
 942         SYSC_QUIRK("usb_otg_hs", 0, 0x400, 0x404, 0x408, 0x00000050,
 943                    0xffffffff, 0),
 944         SYSC_QUIRK("wdt", 0, 0, 0x10, 0x14, 0x502a0500, 0xfffff0f0, 0),
 945         SYSC_QUIRK("vfpe", 0, 0, 0x104, -1, 0x4d001200, 0xffffffff, 0),
 946 #endif
 947 };
 948
 949 static void sysc_init_revision_quirks(struct sysc *ddata)
 950 {
 951         const struct sysc_revision_quirk *q;
 952         int i;
 953
 954         for (i = 0; i < ARRAY_SIZE(sysc_revision_quirks); i++) {
 955                 q = &sysc_revision_quirks[i];
 956
 957                 if (q->base && q->base != ddata->module_pa)
 958                         continue;
 959
 960                 if (q->rev_offset >= 0 &&
 961                     q->rev_offset != ddata->offsets[SYSC_REVISION])
 962                         continue;
 963
 964                 if (q->sysc_offset >= 0 &&
 965                     q->sysc_offset != ddata->offsets[SYSC_SYSCONFIG])
 966                         continue;
 967
 968                 if (q->syss_offset >= 0 &&
 969                     q->syss_offset != ddata->offsets[SYSC_SYSSTATUS])
 970                         continue;
 971
 972                 if (q->revision == ddata->revision ||
 973                     (q->revision & q->revision_mask) ==
 974                     (ddata->revision & q->revision_mask)) {
 975                         ddata->name = q->name;
 976                         ddata->cfg.quirks |= q->quirks;
 977                 }
 978         }
 979 }
 980
 981 static int sysc_reset(struct sysc *ddata)
 982 {
 983         int offset = ddata->offsets[SYSC_SYSCONFIG];
 984         int val;
 985
 986         if (ddata->legacy_mode || offset < 0 ||
 987             ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT)
 988                 return 0;
 989
 990         /*
 991          * Currently only support reset status in sysstatus.
 992          * Warn and return error in all other cases
 993          */
 994         if (!ddata->cfg.syss_mask) {
 995                 dev_err(ddata->dev, "No ti,syss-mask. Reset failed\n");
 996                 return -EINVAL;
 997         }
 998
 999         val = sysc_read(ddata, offset);
1000         val |= (0x1 << ddata->cap->regbits->srst_shift);
1001         sysc_write(ddata, offset, val);
1002
1003         /* Poll on reset status */
1004         offset = ddata->offsets[SYSC_SYSSTATUS];
1005
1006         return readl_poll_timeout(ddata->module_va + offset, val,
1007                                   (val & ddata->cfg.syss_mask) == 0x0,
1008                                   100, MAX_MODULE_SOFTRESET_WAIT);
1009 }
1010
1011 /* At this point the module is configured enough to read the revision */
1012 static int sysc_init_module(struct sysc *ddata)
1013 {
1014         int error;
1015
1016         if (ddata->cfg.quirks & SYSC_QUIRK_NO_IDLE_ON_INIT) {
1017                 ddata->revision = sysc_read_revision(ddata);
1018                 goto rev_quirks;
1019         }
1020
1021         error = pm_runtime_get_sync(ddata->dev);
1022         if (error < 0) {
1023                 pm_runtime_put_noidle(ddata->dev);
1024
1025                 return 0;
1026         }
1027
1028         error = sysc_reset(ddata);
1029         if (error) {
1030                 dev_err(ddata->dev, "Reset failed with %d\n", error);
1031                 pm_runtime_put_sync(ddata->dev);
1032
1033                 return error;
1034         }
1035
1036         ddata->revision = sysc_read_revision(ddata);
1037         pm_runtime_put_sync(ddata->dev);
1038
1039 rev_quirks:
1040         sysc_init_revision_quirks(ddata);
1041
1042         return 0;
1043 }
1044
1045 static int sysc_init_sysc_mask(struct sysc *ddata)
1046 {
1047         struct device_node *np = ddata->dev->of_node;
1048         int error;
1049         u32 val;
1050
1051         error = of_property_read_u32(np, "ti,sysc-mask", &val);
1052         if (error)
1053                 return 0;
1054
1055         if (val)
1056                 ddata->cfg.sysc_val = val & ddata->cap->sysc_mask;
1057         else
1058                 ddata->cfg.sysc_val = ddata->cap->sysc_mask;
1059
1060         return 0;
1061 }
1062
1063 static int sysc_init_idlemode(struct sysc *ddata, u8 *idlemodes,
1064                               const char *name)
1065 {
1066         struct device_node *np = ddata->dev->of_node;
1067         struct property *prop;
1068         const __be32 *p;
1069         u32 val;
1070
1071         of_property_for_each_u32(np, name, prop, p, val) {
1072                 if (val >= SYSC_NR_IDLEMODES) {
1073                         dev_err(ddata->dev, "invalid idlemode: %i\n", val);
1074                         return -EINVAL;
1075                 }
1076                 *idlemodes |=  (1 << val);
1077         }
1078
1079         return 0;
1080 }
1081
1082 static int sysc_init_idlemodes(struct sysc *ddata)
1083 {
1084         int error;
1085
1086         error = sysc_init_idlemode(ddata, &ddata->cfg.midlemodes,
1087                                    "ti,sysc-midle");
1088         if (error)
1089                 return error;
1090
1091         error = sysc_init_idlemode(ddata, &ddata->cfg.sidlemodes,
1092                                    "ti,sysc-sidle");
1093         if (error)
1094                 return error;
1095
1096         return 0;
1097 }
1098
1099 /*
1100  * Only some devices on omap4 and later have SYSCONFIG reset done
1101  * bit. We can detect this if there is no SYSSTATUS at all, or the
1102  * SYSTATUS bit 0 is not used. Note that some SYSSTATUS registers
1103  * have multiple bits for the child devices like OHCI and EHCI.
1104  * Depends on SYSC being parsed first.
1105  */
1106 static int sysc_init_syss_mask(struct sysc *ddata)
1107 {
1108         struct device_node *np = ddata->dev->of_node;
1109         int error;
1110         u32 val;
1111
1112         error = of_property_read_u32(np, "ti,syss-mask", &val);
1113         if (error) {
1114                 if ((ddata->cap->type == TI_SYSC_OMAP4 ||
1115                      ddata->cap->type == TI_SYSC_OMAP4_TIMER) &&
1116                     (ddata->cfg.sysc_val & SYSC_OMAP4_SOFTRESET))
1117                         ddata->cfg.quirks |= SYSC_QUIRK_RESET_STATUS;
1118
1119                 return 0;
1120         }
1121
1122         if (!(val & 1) && (ddata->cfg.sysc_val & SYSC_OMAP4_SOFTRESET))
1123                 ddata->cfg.quirks |= SYSC_QUIRK_RESET_STATUS;
1124
1125         ddata->cfg.syss_mask = val;
1126
1127         return 0;
1128 }
1129
1130 /*
1131  * Many child device drivers need to have fck and opt clocks available
1132  * to get the clock rate for device internal configuration etc.
1133  */
1134 static int sysc_child_add_named_clock(struct sysc *ddata,
1135                                       struct device *child,
1136                                       const char *name)
1137 {
1138         struct clk *clk;
1139         struct clk_lookup *l;
1140         int error = 0;
1141
1142         if (!name)
1143                 return 0;
1144
1145         clk = clk_get(child, name);
1146         if (!IS_ERR(clk)) {
1147                 clk_put(clk);
1148
1149                 return -EEXIST;
1150         }
1151
1152         clk = clk_get(ddata->dev, name);
1153         if (IS_ERR(clk))
1154                 return -ENODEV;
1155
1156         l = clkdev_create(clk, name, dev_name(child));
1157         if (!l)
1158                 error = -ENOMEM;
1159
1160         clk_put(clk);
1161
1162         return error;
1163 }
1164
1165 static int sysc_child_add_clocks(struct sysc *ddata,
1166                                  struct device *child)
1167 {
1168         int i, error;
1169
1170         for (i = 0; i < ddata->nr_clocks; i++) {
1171                 error = sysc_child_add_named_clock(ddata,
1172                                                    child,
1173                                                    ddata->clock_roles[i]);
1174                 if (error && error != -EEXIST) {
1175                         dev_err(ddata->dev, "could not add child clock %s: %i\n",
1176                                 ddata->clock_roles[i], error);
1177
1178                         return error;
1179                 }
1180         }
1181
1182         return 0;
1183 }
1184
1185 static struct device_type sysc_device_type = {
1186 };
1187
1188 static struct sysc *sysc_child_to_parent(struct device *dev)
1189 {
1190         struct device *parent = dev->parent;
1191
1192         if (!parent || parent->type != &sysc_device_type)
1193                 return NULL;
1194
1195         return dev_get_drvdata(parent);
1196 }
1197
1198 static int __maybe_unused sysc_child_runtime_suspend(struct device *dev)
1199 {
1200         struct sysc *ddata;
1201         int error;
1202
1203         ddata = sysc_child_to_parent(dev);
1204
1205         error = pm_generic_runtime_suspend(dev);
1206         if (error)
1207                 return error;
1208
1209         if (!ddata->enabled)
1210                 return 0;
1211
1212         return sysc_runtime_suspend(ddata->dev);
1213 }
1214
1215 static int __maybe_unused sysc_child_runtime_resume(struct device *dev)
1216 {
1217         struct sysc *ddata;
1218         int error;
1219
1220         ddata = sysc_child_to_parent(dev);
1221
1222         if (!ddata->enabled) {
1223                 error = sysc_runtime_resume(ddata->dev);
1224                 if (error < 0)
1225                         dev_err(ddata->dev,
1226                                 "%s error: %i\n", __func__, error);
1227         }
1228
1229         return pm_generic_runtime_resume(dev);
1230 }
1231
1232 #ifdef CONFIG_PM_SLEEP
1233 static int sysc_child_suspend_noirq(struct device *dev)
1234 {
1235         struct sysc *ddata;
1236         int error;
1237
1238         ddata = sysc_child_to_parent(dev);
1239
1240         dev_dbg(ddata->dev, "%s %s\n", __func__,
1241                 ddata->name ? ddata->name : "");
1242
1243         error = pm_generic_suspend_noirq(dev);
1244         if (error) {
1245                 dev_err(dev, "%s error at %i: %i\n",
1246                         __func__, __LINE__, error);
1247
1248                 return error;
1249         }
1250
1251         if (!pm_runtime_status_suspended(dev)) {
1252                 error = pm_generic_runtime_suspend(dev);
1253                 if (error) {
1254                         dev_err(dev, "%s error at %i: %i\n",
1255                                 __func__, __LINE__, error);
1256
1257                         return error;
1258                 }
1259
1260                 error = sysc_runtime_suspend(ddata->dev);
1261                 if (error) {
1262                         dev_err(dev, "%s error at %i: %i\n",
1263                                 __func__, __LINE__, error);
1264
1265                         return error;
1266                 }
1267
1268                 ddata->child_needs_resume = true;
1269         }
1270
1271         return 0;
1272 }
1273
1274 static int sysc_child_resume_noirq(struct device *dev)
1275 {
1276         struct sysc *ddata;
1277         int error;
1278
1279         ddata = sysc_child_to_parent(dev);
1280
1281         dev_dbg(ddata->dev, "%s %s\n", __func__,
1282                 ddata->name ? ddata->name : "");
1283
1284         if (ddata->child_needs_resume) {
1285                 ddata->child_needs_resume = false;
1286
1287                 error = sysc_runtime_resume(ddata->dev);
1288                 if (error)
1289                         dev_err(ddata->dev,
1290                                 "%s runtime resume error: %i\n",
1291                                 __func__, error);
1292
1293                 error = pm_generic_runtime_resume(dev);
1294                 if (error)
1295                         dev_err(ddata->dev,
1296                                 "%s generic runtime resume: %i\n",
1297                                 __func__, error);
1298         }
1299
1300         return pm_generic_resume_noirq(dev);
1301 }
1302 #endif
1303
1304 struct dev_pm_domain sysc_child_pm_domain = {
1305         .ops = {
1306                 SET_RUNTIME_PM_OPS(sysc_child_runtime_suspend,
1307                                    sysc_child_runtime_resume,
1308                                    NULL)
1309                 USE_PLATFORM_PM_SLEEP_OPS
1310                 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sysc_child_suspend_noirq,
1311                                               sysc_child_resume_noirq)
1312         }
1313 };
1314
1315 /**
1316  * sysc_legacy_idle_quirk - handle children in omap_device compatible way
1317  * @ddata: device driver data
1318  * @child: child device driver
1319  *
1320  * Allow idle for child devices as done with _od_runtime_suspend().
1321  * Otherwise many child devices will not idle because of the permanent
1322  * parent usecount set in pm_runtime_irq_safe().
1323  *
1324  * Note that the long term solution is to just modify the child device
1325  * drivers to not set pm_runtime_irq_safe() and then this can be just
1326  * dropped.
1327  */
1328 static void sysc_legacy_idle_quirk(struct sysc *ddata, struct device *child)
1329 {
1330         if (!ddata->legacy_mode)
1331                 return;
1332
1333         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
1334                 dev_pm_domain_set(child, &sysc_child_pm_domain);
1335 }
1336
1337 static int sysc_notifier_call(struct notifier_block *nb,
1338                               unsigned long event, void *device)
1339 {
1340         struct device *dev = device;
1341         struct sysc *ddata;
1342         int error;
1343
1344         ddata = sysc_child_to_parent(dev);
1345         if (!ddata)
1346                 return NOTIFY_DONE;
1347
1348         switch (event) {
1349         case BUS_NOTIFY_ADD_DEVICE:
1350                 error = sysc_child_add_clocks(ddata, dev);
1351                 if (error)
1352                         return error;
1353                 sysc_legacy_idle_quirk(ddata, dev);
1354                 break;
1355         default:
1356                 break;
1357         }
1358
1359         return NOTIFY_DONE;
1360 }
1361
1362 static struct notifier_block sysc_nb = {
1363         .notifier_call = sysc_notifier_call,
1364 };
1365
1366 /* Device tree configured quirks */
1367 struct sysc_dts_quirk {
1368         const char *name;
1369         u32 mask;
1370 };
1371
1372 static const struct sysc_dts_quirk sysc_dts_quirks[] = {
1373         { .name = "ti,no-idle-on-init",
1374           .mask = SYSC_QUIRK_NO_IDLE_ON_INIT, },
1375         { .name = "ti,no-reset-on-init",
1376           .mask = SYSC_QUIRK_NO_RESET_ON_INIT, },
1377 };
1378
1379 static int sysc_init_dts_quirks(struct sysc *ddata)
1380 {
1381         struct device_node *np = ddata->dev->of_node;
1382         const struct property *prop;
1383         int i, len, error;
1384         u32 val;
1385
1386         ddata->legacy_mode = of_get_property(np, "ti,hwmods", NULL);
1387
1388         for (i = 0; i < ARRAY_SIZE(sysc_dts_quirks); i++) {
1389                 prop = of_get_property(np, sysc_dts_quirks[i].name, &len);
1390                 if (!prop)
1391                         continue;
1392
1393                 ddata->cfg.quirks |= sysc_dts_quirks[i].mask;
1394         }
1395
1396         error = of_property_read_u32(np, "ti,sysc-delay-us", &val);
1397         if (!error) {
1398                 if (val > 255) {
1399                         dev_warn(ddata->dev, "bad ti,sysc-delay-us: %i\n",
1400                                  val);
1401                 }
1402
1403                 ddata->cfg.srst_udelay = (u8)val;
1404         }
1405
1406         return 0;
1407 }
1408
1409 static void sysc_unprepare(struct sysc *ddata)
1410 {
1411         int i;
1412
1413         for (i = 0; i < SYSC_MAX_CLOCKS; i++) {
1414                 if (!IS_ERR_OR_NULL(ddata->clocks[i]))
1415                         clk_unprepare(ddata->clocks[i]);
1416         }
1417 }
1418
1419 /*
1420  * Common sysc register bits found on omap2, also known as type1
1421  */
1422 static const struct sysc_regbits sysc_regbits_omap2 = {
1423         .dmadisable_shift = -ENODEV,
1424         .midle_shift = 12,
1425         .sidle_shift = 3,
1426         .clkact_shift = 8,
1427         .emufree_shift = 5,
1428         .enwkup_shift = 2,
1429         .srst_shift = 1,
1430         .autoidle_shift = 0,
1431 };
1432
1433 static const struct sysc_capabilities sysc_omap2 = {
1434         .type = TI_SYSC_OMAP2,
1435         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY | SYSC_OMAP2_EMUFREE |
1436                      SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_SOFTRESET |
1437                      SYSC_OMAP2_AUTOIDLE,
1438         .regbits = &sysc_regbits_omap2,
1439 };
1440
1441 /* All omap2 and 3 timers, and timers 1, 2 & 10 on omap 4 and 5 */
1442 static const struct sysc_capabilities sysc_omap2_timer = {
1443         .type = TI_SYSC_OMAP2_TIMER,
1444         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY | SYSC_OMAP2_EMUFREE |
1445                      SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_SOFTRESET |
1446                      SYSC_OMAP2_AUTOIDLE,
1447         .regbits = &sysc_regbits_omap2,
1448         .mod_quirks = SYSC_QUIRK_USE_CLOCKACT,
1449 };
1450
1451 /*
1452  * SHAM2 (SHA1/MD5) sysc found on omap3, a variant of sysc_regbits_omap2
1453  * with different sidle position
1454  */
1455 static const struct sysc_regbits sysc_regbits_omap3_sham = {
1456         .dmadisable_shift = -ENODEV,
1457         .midle_shift = -ENODEV,
1458         .sidle_shift = 4,
1459         .clkact_shift = -ENODEV,
1460         .enwkup_shift = -ENODEV,
1461         .srst_shift = 1,
1462         .autoidle_shift = 0,
1463         .emufree_shift = -ENODEV,
1464 };
1465
1466 static const struct sysc_capabilities sysc_omap3_sham = {
1467         .type = TI_SYSC_OMAP3_SHAM,
1468         .sysc_mask = SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE,
1469         .regbits = &sysc_regbits_omap3_sham,
1470 };
1471
1472 /*
1473  * AES register bits found on omap3 and later, a variant of
1474  * sysc_regbits_omap2 with different sidle position
1475  */
1476 static const struct sysc_regbits sysc_regbits_omap3_aes = {
1477         .dmadisable_shift = -ENODEV,
1478         .midle_shift = -ENODEV,
1479         .sidle_shift = 6,
1480         .clkact_shift = -ENODEV,
1481         .enwkup_shift = -ENODEV,
1482         .srst_shift = 1,
1483         .autoidle_shift = 0,
1484         .emufree_shift = -ENODEV,
1485 };
1486
1487 static const struct sysc_capabilities sysc_omap3_aes = {
1488         .type = TI_SYSC_OMAP3_AES,
1489         .sysc_mask = SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE,
1490         .regbits = &sysc_regbits_omap3_aes,
1491 };
1492
1493 /*
1494  * Common sysc register bits found on omap4, also known as type2
1495  */
1496 static const struct sysc_regbits sysc_regbits_omap4 = {
1497         .dmadisable_shift = 16,
1498         .midle_shift = 4,
1499         .sidle_shift = 2,
1500         .clkact_shift = -ENODEV,
1501         .enwkup_shift = -ENODEV,
1502         .emufree_shift = 1,
1503         .srst_shift = 0,
1504         .autoidle_shift = -ENODEV,
1505 };
1506
1507 static const struct sysc_capabilities sysc_omap4 = {
1508         .type = TI_SYSC_OMAP4,
1509         .sysc_mask = SYSC_OMAP4_DMADISABLE | SYSC_OMAP4_FREEEMU |
1510                      SYSC_OMAP4_SOFTRESET,
1511         .regbits = &sysc_regbits_omap4,
1512 };
1513
1514 static const struct sysc_capabilities sysc_omap4_timer = {
1515         .type = TI_SYSC_OMAP4_TIMER,
1516         .sysc_mask = SYSC_OMAP4_DMADISABLE | SYSC_OMAP4_FREEEMU |
1517                      SYSC_OMAP4_SOFTRESET,
1518         .regbits = &sysc_regbits_omap4,
1519 };
1520
1521 /*
1522  * Common sysc register bits found on omap4, also known as type3
1523  */
1524 static const struct sysc_regbits sysc_regbits_omap4_simple = {
1525         .dmadisable_shift = -ENODEV,
1526         .midle_shift = 2,
1527         .sidle_shift = 0,
1528         .clkact_shift = -ENODEV,
1529         .enwkup_shift = -ENODEV,
1530         .srst_shift = -ENODEV,
1531         .emufree_shift = -ENODEV,
1532         .autoidle_shift = -ENODEV,
1533 };
1534
1535 static const struct sysc_capabilities sysc_omap4_simple = {
1536         .type = TI_SYSC_OMAP4_SIMPLE,
1537         .regbits = &sysc_regbits_omap4_simple,
1538 };
1539
1540 /*
1541  * SmartReflex sysc found on omap34xx
1542  */
1543 static const struct sysc_regbits sysc_regbits_omap34xx_sr = {
1544         .dmadisable_shift = -ENODEV,
1545         .midle_shift = -ENODEV,
1546         .sidle_shift = -ENODEV,
1547         .clkact_shift = 20,
1548         .enwkup_shift = -ENODEV,
1549         .srst_shift = -ENODEV,
1550         .emufree_shift = -ENODEV,
1551         .autoidle_shift = -ENODEV,
1552 };
1553
1554 static const struct sysc_capabilities sysc_34xx_sr = {
1555         .type = TI_SYSC_OMAP34XX_SR,
1556         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY,
1557         .regbits = &sysc_regbits_omap34xx_sr,
1558         .mod_quirks = SYSC_QUIRK_USE_CLOCKACT | SYSC_QUIRK_UNCACHED |
1559                       SYSC_QUIRK_LEGACY_IDLE,
1560 };
1561
1562 /*
1563  * SmartReflex sysc found on omap36xx and later
1564  */
1565 static const struct sysc_regbits sysc_regbits_omap36xx_sr = {
1566         .dmadisable_shift = -ENODEV,
1567         .midle_shift = -ENODEV,
1568         .sidle_shift = 24,
1569         .clkact_shift = -ENODEV,
1570         .enwkup_shift = 26,
1571         .srst_shift = -ENODEV,
1572         .emufree_shift = -ENODEV,
1573         .autoidle_shift = -ENODEV,
1574 };
1575
1576 static const struct sysc_capabilities sysc_36xx_sr = {
1577         .type = TI_SYSC_OMAP36XX_SR,
1578         .sysc_mask = SYSC_OMAP3_SR_ENAWAKEUP,
1579         .regbits = &sysc_regbits_omap36xx_sr,
1580         .mod_quirks = SYSC_QUIRK_UNCACHED | SYSC_QUIRK_LEGACY_IDLE,
1581 };
1582
1583 static const struct sysc_capabilities sysc_omap4_sr = {
1584         .type = TI_SYSC_OMAP4_SR,
1585         .regbits = &sysc_regbits_omap36xx_sr,
1586         .mod_quirks = SYSC_QUIRK_LEGACY_IDLE,
1587 };
1588
1589 /*
1590  * McASP register bits found on omap4 and later
1591  */
1592 static const struct sysc_regbits sysc_regbits_omap4_mcasp = {
1593         .dmadisable_shift = -ENODEV,
1594         .midle_shift = -ENODEV,
1595         .sidle_shift = 0,
1596         .clkact_shift = -ENODEV,
1597         .enwkup_shift = -ENODEV,
1598         .srst_shift = -ENODEV,
1599         .emufree_shift = -ENODEV,
1600         .autoidle_shift = -ENODEV,
1601 };
1602
1603 static const struct sysc_capabilities sysc_omap4_mcasp = {
1604         .type = TI_SYSC_OMAP4_MCASP,
1605         .regbits = &sysc_regbits_omap4_mcasp,
1606 };
1607
1608 /*
1609  * FS USB host found on omap4 and later
1610  */
1611 static const struct sysc_regbits sysc_regbits_omap4_usb_host_fs = {
1612         .dmadisable_shift = -ENODEV,
1613         .midle_shift = -ENODEV,
1614         .sidle_shift = 24,
1615         .clkact_shift = -ENODEV,
1616         .enwkup_shift = 26,
1617         .srst_shift = -ENODEV,
1618         .emufree_shift = -ENODEV,
1619         .autoidle_shift = -ENODEV,
1620 };
1621
1622 static const struct sysc_capabilities sysc_omap4_usb_host_fs = {
1623         .type = TI_SYSC_OMAP4_USB_HOST_FS,
1624         .sysc_mask = SYSC_OMAP2_ENAWAKEUP,
1625         .regbits = &sysc_regbits_omap4_usb_host_fs,
1626 };
1627
1628 static const struct sysc_regbits sysc_regbits_dra7_mcan = {
1629         .dmadisable_shift = -ENODEV,
1630         .midle_shift = -ENODEV,
1631         .sidle_shift = -ENODEV,
1632         .clkact_shift = -ENODEV,
1633         .enwkup_shift = 4,
1634         .srst_shift = 0,
1635         .emufree_shift = -ENODEV,
1636         .autoidle_shift = -ENODEV,
1637 };
1638
1639 static const struct sysc_capabilities sysc_dra7_mcan = {
1640         .type = TI_SYSC_DRA7_MCAN,
1641         .sysc_mask = SYSC_DRA7_MCAN_ENAWAKEUP | SYSC_OMAP4_SOFTRESET,
1642         .regbits = &sysc_regbits_dra7_mcan,
1643 };
1644
1645 static int sysc_init_pdata(struct sysc *ddata)
1646 {
1647         struct ti_sysc_platform_data *pdata = dev_get_platdata(ddata->dev);
1648         struct ti_sysc_module_data mdata;
1649         int error = 0;
1650
1651         if (!pdata || !ddata->legacy_mode)
1652                 return 0;
1653
1654         mdata.name = ddata->legacy_mode;
1655         mdata.module_pa = ddata->module_pa;
1656         mdata.module_size = ddata->module_size;
1657         mdata.offsets = ddata->offsets;
1658         mdata.nr_offsets = SYSC_MAX_REGS;
1659         mdata.cap = ddata->cap;
1660         mdata.cfg = &ddata->cfg;
1661
1662         if (!pdata->init_module)
1663                 return -ENODEV;
1664
1665         error = pdata->init_module(ddata->dev, &mdata, &ddata->cookie);
1666         if (error == -EEXIST)
1667                 error = 0;
1668
1669         return error;
1670 }
1671
1672 static int sysc_init_match(struct sysc *ddata)
1673 {
1674         const struct sysc_capabilities *cap;
1675
1676         cap = of_device_get_match_data(ddata->dev);
1677         if (!cap)
1678                 return -EINVAL;
1679
1680         ddata->cap = cap;
1681         if (ddata->cap)
1682                 ddata->cfg.quirks |= ddata->cap->mod_quirks;
1683
1684         return 0;
1685 }
1686
1687 static void ti_sysc_idle(struct work_struct *work)
1688 {
1689         struct sysc *ddata;
1690
1691         ddata = container_of(work, struct sysc, idle_work.work);
1692
1693         if (pm_runtime_active(ddata->dev))
1694                 pm_runtime_put_sync(ddata->dev);
1695 }
1696
1697 static const struct of_device_id sysc_match_table[] = {
1698         { .compatible = "simple-bus", },
1699         { /* sentinel */ },
1700 };
1701
1702 static int sysc_probe(struct platform_device *pdev)
1703 {
1704         struct ti_sysc_platform_data *pdata = dev_get_platdata(&pdev->dev);
1705         struct sysc *ddata;
1706         int error;
1707
1708         ddata = devm_kzalloc(&pdev->dev, sizeof(*ddata), GFP_KERNEL);
1709         if (!ddata)
1710                 return -ENOMEM;
1711
1712         ddata->dev = &pdev->dev;
1713         platform_set_drvdata(pdev, ddata);
1714
1715         error = sysc_init_match(ddata);
1716         if (error)
1717                 return error;
1718
1719         error = sysc_init_dts_quirks(ddata);
1720         if (error)
1721                 goto unprepare;
1722
1723         error = sysc_get_clocks(ddata);
1724         if (error)
1725                 return error;
1726
1727         error = sysc_map_and_check_registers(ddata);
1728         if (error)
1729                 goto unprepare;
1730
1731         error = sysc_init_sysc_mask(ddata);
1732         if (error)
1733                 goto unprepare;
1734
1735         error = sysc_init_idlemodes(ddata);
1736         if (error)
1737                 goto unprepare;
1738
1739         error = sysc_init_syss_mask(ddata);
1740         if (error)
1741                 goto unprepare;
1742
1743         error = sysc_init_pdata(ddata);
1744         if (error)
1745                 goto unprepare;
1746
1747         error = sysc_init_resets(ddata);
1748         if (error)
1749                 return error;
1750
1751         pm_runtime_enable(ddata->dev);
1752         error = sysc_init_module(ddata);
1753         if (error)
1754                 goto unprepare;
1755
1756         error = pm_runtime_get_sync(ddata->dev);
1757         if (error < 0) {
1758                 pm_runtime_put_noidle(ddata->dev);
1759                 pm_runtime_disable(ddata->dev);
1760                 goto unprepare;
1761         }
1762
1763         sysc_show_registers(ddata);
1764
1765         ddata->dev->type = &sysc_device_type;
1766         error = of_platform_populate(ddata->dev->of_node, sysc_match_table,
1767                                      pdata ? pdata->auxdata : NULL,
1768                                      ddata->dev);
1769         if (error)
1770                 goto err;
1771
1772         INIT_DELAYED_WORK(&ddata->idle_work, ti_sysc_idle);
1773
1774         /* At least earlycon won't survive without deferred idle */
1775         if (ddata->cfg.quirks & (SYSC_QUIRK_NO_IDLE_ON_INIT |
1776                                  SYSC_QUIRK_NO_RESET_ON_INIT)) {
1777                 schedule_delayed_work(&ddata->idle_work, 3000);
1778         } else {
1779                 pm_runtime_put(&pdev->dev);
1780         }
1781
1782         if (!of_get_available_child_count(ddata->dev->of_node))
1783                 reset_control_assert(ddata->rsts);
1784
1785         return 0;
1786
1787 err:
1788         pm_runtime_put_sync(&pdev->dev);
1789         pm_runtime_disable(&pdev->dev);
1790 unprepare:
1791         sysc_unprepare(ddata);
1792
1793         return error;
1794 }
1795
1796 static int sysc_remove(struct platform_device *pdev)
1797 {
1798         struct sysc *ddata = platform_get_drvdata(pdev);
1799         int error;
1800
1801         cancel_delayed_work_sync(&ddata->idle_work);
1802
1803         error = pm_runtime_get_sync(ddata->dev);
1804         if (error < 0) {
1805                 pm_runtime_put_noidle(ddata->dev);
1806                 pm_runtime_disable(ddata->dev);
1807                 goto unprepare;
1808         }
1809
1810         of_platform_depopulate(&pdev->dev);
1811
1812         pm_runtime_put_sync(&pdev->dev);
1813         pm_runtime_disable(&pdev->dev);
1814         reset_control_assert(ddata->rsts);
1815
1816 unprepare:
1817         sysc_unprepare(ddata);
1818
1819         return 0;
1820 }
1821
1822 static const struct of_device_id sysc_match[] = {
1823         { .compatible = "ti,sysc-omap2", .data = &sysc_omap2, },
1824         { .compatible = "ti,sysc-omap2-timer", .data = &sysc_omap2_timer, },
1825         { .compatible = "ti,sysc-omap4", .data = &sysc_omap4, },
1826         { .compatible = "ti,sysc-omap4-timer", .data = &sysc_omap4_timer, },
1827         { .compatible = "ti,sysc-omap4-simple", .data = &sysc_omap4_simple, },
1828         { .compatible = "ti,sysc-omap3430-sr", .data = &sysc_34xx_sr, },
1829         { .compatible = "ti,sysc-omap3630-sr", .data = &sysc_36xx_sr, },
1830         { .compatible = "ti,sysc-omap4-sr", .data = &sysc_omap4_sr, },
1831         { .compatible = "ti,sysc-omap3-sham", .data = &sysc_omap3_sham, },
1832         { .compatible = "ti,sysc-omap-aes", .data = &sysc_omap3_aes, },
1833         { .compatible = "ti,sysc-mcasp", .data = &sysc_omap4_mcasp, },
1834         { .compatible = "ti,sysc-usb-host-fs",
1835           .data = &sysc_omap4_usb_host_fs, },
1836         { .compatible = "ti,sysc-dra7-mcan", .data = &sysc_dra7_mcan, },
1837         {  },
1838 };
1839 MODULE_DEVICE_TABLE(of, sysc_match);
1840
1841 static struct platform_driver sysc_driver = {
1842         .probe          = sysc_probe,
1843         .remove         = sysc_remove,
1844         .driver         = {
1845                 .name   = "ti-sysc",
1846                 .of_match_table = sysc_match,
1847                 .pm = &sysc_pm_ops,
1848         },
1849 };
1850
1851 static int __init sysc_init(void)
1852 {
1853         bus_register_notifier(&platform_bus_type, &sysc_nb);
1854
1855         return platform_driver_register(&sysc_driver);
1856 }
1857 module_init(sysc_init);
1858
1859 static void __exit sysc_exit(void)
1860 {
1861         bus_unregister_notifier(&platform_bus_type, &sysc_nb);
1862         platform_driver_unregister(&sysc_driver);
1863 }
1864 module_exit(sysc_exit);
1865
1866 MODULE_DESCRIPTION("TI sysc interconnect target driver");
1867 MODULE_LICENSE("GPL v2");