]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/bus/ti-sysc.c
Merge tag 'powerpc-5.5-2' of git://git.kernel.org/pub/scm/linux/kernel/git/powerpc/linux
[linux.git] / drivers / bus / ti-sysc.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * ti-sysc.c - Texas Instruments sysc interconnect target driver
4  */
5
6 #include <linux/io.h>
7 #include <linux/clk.h>
8 #include <linux/clkdev.h>
9 #include <linux/delay.h>
10 #include <linux/module.h>
11 #include <linux/platform_device.h>
12 #include <linux/pm_domain.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/reset.h>
15 #include <linux/of_address.h>
16 #include <linux/of_platform.h>
17 #include <linux/slab.h>
18 #include <linux/iopoll.h>
19
20 #include <linux/platform_data/ti-sysc.h>
21
22 #include <dt-bindings/bus/ti-sysc.h>
23
24 #define MAX_MODULE_SOFTRESET_WAIT               10000
25
26 static const char * const reg_names[] = { "rev", "sysc", "syss", };
27
28 enum sysc_clocks {
29         SYSC_FCK,
30         SYSC_ICK,
31         SYSC_OPTFCK0,
32         SYSC_OPTFCK1,
33         SYSC_OPTFCK2,
34         SYSC_OPTFCK3,
35         SYSC_OPTFCK4,
36         SYSC_OPTFCK5,
37         SYSC_OPTFCK6,
38         SYSC_OPTFCK7,
39         SYSC_MAX_CLOCKS,
40 };
41
42 static const char * const clock_names[SYSC_MAX_CLOCKS] = {
43         "fck", "ick", "opt0", "opt1", "opt2", "opt3", "opt4",
44         "opt5", "opt6", "opt7",
45 };
46
47 #define SYSC_IDLEMODE_MASK              3
48 #define SYSC_CLOCKACTIVITY_MASK         3
49
50 /**
51  * struct sysc - TI sysc interconnect target module registers and capabilities
52  * @dev: struct device pointer
53  * @module_pa: physical address of the interconnect target module
54  * @module_size: size of the interconnect target module
55  * @module_va: virtual address of the interconnect target module
56  * @offsets: register offsets from module base
57  * @mdata: ti-sysc to hwmod translation data for a module
58  * @clocks: clocks used by the interconnect target module
59  * @clock_roles: clock role names for the found clocks
60  * @nr_clocks: number of clocks used by the interconnect target module
61  * @rsts: resets used by the interconnect target module
62  * @legacy_mode: configured for legacy mode if set
63  * @cap: interconnect target module capabilities
64  * @cfg: interconnect target module configuration
65  * @cookie: data used by legacy platform callbacks
66  * @name: name if available
67  * @revision: interconnect target module revision
68  * @enabled: sysc runtime enabled status
69  * @needs_resume: runtime resume needed on resume from suspend
70  * @child_needs_resume: runtime resume needed for child on resume from suspend
71  * @disable_on_idle: status flag used for disabling modules with resets
72  * @idle_work: work structure used to perform delayed idle on a module
73  * @clk_enable_quirk: module specific clock enable quirk
74  * @clk_disable_quirk: module specific clock disable quirk
75  * @reset_done_quirk: module specific reset done quirk
76  * @module_enable_quirk: module specific enable quirk
77  * @module_disable_quirk: module specific disable quirk
78  */
79 struct sysc {
80         struct device *dev;
81         u64 module_pa;
82         u32 module_size;
83         void __iomem *module_va;
84         int offsets[SYSC_MAX_REGS];
85         struct ti_sysc_module_data *mdata;
86         struct clk **clocks;
87         const char **clock_roles;
88         int nr_clocks;
89         struct reset_control *rsts;
90         const char *legacy_mode;
91         const struct sysc_capabilities *cap;
92         struct sysc_config cfg;
93         struct ti_sysc_cookie cookie;
94         const char *name;
95         u32 revision;
96         unsigned int enabled:1;
97         unsigned int needs_resume:1;
98         unsigned int child_needs_resume:1;
99         struct delayed_work idle_work;
100         void (*clk_enable_quirk)(struct sysc *sysc);
101         void (*clk_disable_quirk)(struct sysc *sysc);
102         void (*reset_done_quirk)(struct sysc *sysc);
103         void (*module_enable_quirk)(struct sysc *sysc);
104         void (*module_disable_quirk)(struct sysc *sysc);
105 };
106
107 static void sysc_parse_dts_quirks(struct sysc *ddata, struct device_node *np,
108                                   bool is_child);
109
110 static void sysc_write(struct sysc *ddata, int offset, u32 value)
111 {
112         if (ddata->cfg.quirks & SYSC_QUIRK_16BIT) {
113                 writew_relaxed(value & 0xffff, ddata->module_va + offset);
114
115                 /* Only i2c revision has LO and HI register with stride of 4 */
116                 if (ddata->offsets[SYSC_REVISION] >= 0 &&
117                     offset == ddata->offsets[SYSC_REVISION]) {
118                         u16 hi = value >> 16;
119
120                         writew_relaxed(hi, ddata->module_va + offset + 4);
121                 }
122
123                 return;
124         }
125
126         writel_relaxed(value, ddata->module_va + offset);
127 }
128
129 static u32 sysc_read(struct sysc *ddata, int offset)
130 {
131         if (ddata->cfg.quirks & SYSC_QUIRK_16BIT) {
132                 u32 val;
133
134                 val = readw_relaxed(ddata->module_va + offset);
135
136                 /* Only i2c revision has LO and HI register with stride of 4 */
137                 if (ddata->offsets[SYSC_REVISION] >= 0 &&
138                     offset == ddata->offsets[SYSC_REVISION]) {
139                         u16 tmp = readw_relaxed(ddata->module_va + offset + 4);
140
141                         val |= tmp << 16;
142                 }
143
144                 return val;
145         }
146
147         return readl_relaxed(ddata->module_va + offset);
148 }
149
150 static bool sysc_opt_clks_needed(struct sysc *ddata)
151 {
152         return !!(ddata->cfg.quirks & SYSC_QUIRK_OPT_CLKS_NEEDED);
153 }
154
155 static u32 sysc_read_revision(struct sysc *ddata)
156 {
157         int offset = ddata->offsets[SYSC_REVISION];
158
159         if (offset < 0)
160                 return 0;
161
162         return sysc_read(ddata, offset);
163 }
164
165 static u32 sysc_read_sysconfig(struct sysc *ddata)
166 {
167         int offset = ddata->offsets[SYSC_SYSCONFIG];
168
169         if (offset < 0)
170                 return 0;
171
172         return sysc_read(ddata, offset);
173 }
174
175 static u32 sysc_read_sysstatus(struct sysc *ddata)
176 {
177         int offset = ddata->offsets[SYSC_SYSSTATUS];
178
179         if (offset < 0)
180                 return 0;
181
182         return sysc_read(ddata, offset);
183 }
184
185 static int sysc_add_named_clock_from_child(struct sysc *ddata,
186                                            const char *name,
187                                            const char *optfck_name)
188 {
189         struct device_node *np = ddata->dev->of_node;
190         struct device_node *child;
191         struct clk_lookup *cl;
192         struct clk *clock;
193         const char *n;
194
195         if (name)
196                 n = name;
197         else
198                 n = optfck_name;
199
200         /* Does the clock alias already exist? */
201         clock = of_clk_get_by_name(np, n);
202         if (!IS_ERR(clock)) {
203                 clk_put(clock);
204
205                 return 0;
206         }
207
208         child = of_get_next_available_child(np, NULL);
209         if (!child)
210                 return -ENODEV;
211
212         clock = devm_get_clk_from_child(ddata->dev, child, name);
213         if (IS_ERR(clock))
214                 return PTR_ERR(clock);
215
216         /*
217          * Use clkdev_add() instead of clkdev_alloc() to avoid the MAX_DEV_ID
218          * limit for clk_get(). If cl ever needs to be freed, it should be done
219          * with clkdev_drop().
220          */
221         cl = kcalloc(1, sizeof(*cl), GFP_KERNEL);
222         if (!cl)
223                 return -ENOMEM;
224
225         cl->con_id = n;
226         cl->dev_id = dev_name(ddata->dev);
227         cl->clk = clock;
228         clkdev_add(cl);
229
230         clk_put(clock);
231
232         return 0;
233 }
234
235 static int sysc_init_ext_opt_clock(struct sysc *ddata, const char *name)
236 {
237         const char *optfck_name;
238         int error, index;
239
240         if (ddata->nr_clocks < SYSC_OPTFCK0)
241                 index = SYSC_OPTFCK0;
242         else
243                 index = ddata->nr_clocks;
244
245         if (name)
246                 optfck_name = name;
247         else
248                 optfck_name = clock_names[index];
249
250         error = sysc_add_named_clock_from_child(ddata, name, optfck_name);
251         if (error)
252                 return error;
253
254         ddata->clock_roles[index] = optfck_name;
255         ddata->nr_clocks++;
256
257         return 0;
258 }
259
260 static int sysc_get_one_clock(struct sysc *ddata, const char *name)
261 {
262         int error, i, index = -ENODEV;
263
264         if (!strncmp(clock_names[SYSC_FCK], name, 3))
265                 index = SYSC_FCK;
266         else if (!strncmp(clock_names[SYSC_ICK], name, 3))
267                 index = SYSC_ICK;
268
269         if (index < 0) {
270                 for (i = SYSC_OPTFCK0; i < SYSC_MAX_CLOCKS; i++) {
271                         if (!ddata->clocks[i]) {
272                                 index = i;
273                                 break;
274                         }
275                 }
276         }
277
278         if (index < 0) {
279                 dev_err(ddata->dev, "clock %s not added\n", name);
280                 return index;
281         }
282
283         ddata->clocks[index] = devm_clk_get(ddata->dev, name);
284         if (IS_ERR(ddata->clocks[index])) {
285                 dev_err(ddata->dev, "clock get error for %s: %li\n",
286                         name, PTR_ERR(ddata->clocks[index]));
287
288                 return PTR_ERR(ddata->clocks[index]);
289         }
290
291         error = clk_prepare(ddata->clocks[index]);
292         if (error) {
293                 dev_err(ddata->dev, "clock prepare error for %s: %i\n",
294                         name, error);
295
296                 return error;
297         }
298
299         return 0;
300 }
301
302 static int sysc_get_clocks(struct sysc *ddata)
303 {
304         struct device_node *np = ddata->dev->of_node;
305         struct property *prop;
306         const char *name;
307         int nr_fck = 0, nr_ick = 0, i, error = 0;
308
309         ddata->clock_roles = devm_kcalloc(ddata->dev,
310                                           SYSC_MAX_CLOCKS,
311                                           sizeof(*ddata->clock_roles),
312                                           GFP_KERNEL);
313         if (!ddata->clock_roles)
314                 return -ENOMEM;
315
316         of_property_for_each_string(np, "clock-names", prop, name) {
317                 if (!strncmp(clock_names[SYSC_FCK], name, 3))
318                         nr_fck++;
319                 if (!strncmp(clock_names[SYSC_ICK], name, 3))
320                         nr_ick++;
321                 ddata->clock_roles[ddata->nr_clocks] = name;
322                 ddata->nr_clocks++;
323         }
324
325         if (ddata->nr_clocks < 1)
326                 return 0;
327
328         if ((ddata->cfg.quirks & SYSC_QUIRK_EXT_OPT_CLOCK)) {
329                 error = sysc_init_ext_opt_clock(ddata, NULL);
330                 if (error)
331                         return error;
332         }
333
334         if (ddata->nr_clocks > SYSC_MAX_CLOCKS) {
335                 dev_err(ddata->dev, "too many clocks for %pOF\n", np);
336
337                 return -EINVAL;
338         }
339
340         if (nr_fck > 1 || nr_ick > 1) {
341                 dev_err(ddata->dev, "max one fck and ick for %pOF\n", np);
342
343                 return -EINVAL;
344         }
345
346         ddata->clocks = devm_kcalloc(ddata->dev,
347                                      ddata->nr_clocks, sizeof(*ddata->clocks),
348                                      GFP_KERNEL);
349         if (!ddata->clocks)
350                 return -ENOMEM;
351
352         for (i = 0; i < SYSC_MAX_CLOCKS; i++) {
353                 const char *name = ddata->clock_roles[i];
354
355                 if (!name)
356                         continue;
357
358                 error = sysc_get_one_clock(ddata, name);
359                 if (error)
360                         return error;
361         }
362
363         return 0;
364 }
365
366 static int sysc_enable_main_clocks(struct sysc *ddata)
367 {
368         struct clk *clock;
369         int i, error;
370
371         if (!ddata->clocks)
372                 return 0;
373
374         for (i = 0; i < SYSC_OPTFCK0; i++) {
375                 clock = ddata->clocks[i];
376
377                 /* Main clocks may not have ick */
378                 if (IS_ERR_OR_NULL(clock))
379                         continue;
380
381                 error = clk_enable(clock);
382                 if (error)
383                         goto err_disable;
384         }
385
386         return 0;
387
388 err_disable:
389         for (i--; i >= 0; i--) {
390                 clock = ddata->clocks[i];
391
392                 /* Main clocks may not have ick */
393                 if (IS_ERR_OR_NULL(clock))
394                         continue;
395
396                 clk_disable(clock);
397         }
398
399         return error;
400 }
401
402 static void sysc_disable_main_clocks(struct sysc *ddata)
403 {
404         struct clk *clock;
405         int i;
406
407         if (!ddata->clocks)
408                 return;
409
410         for (i = 0; i < SYSC_OPTFCK0; i++) {
411                 clock = ddata->clocks[i];
412                 if (IS_ERR_OR_NULL(clock))
413                         continue;
414
415                 clk_disable(clock);
416         }
417 }
418
419 static int sysc_enable_opt_clocks(struct sysc *ddata)
420 {
421         struct clk *clock;
422         int i, error;
423
424         if (!ddata->clocks)
425                 return 0;
426
427         for (i = SYSC_OPTFCK0; i < SYSC_MAX_CLOCKS; i++) {
428                 clock = ddata->clocks[i];
429
430                 /* Assume no holes for opt clocks */
431                 if (IS_ERR_OR_NULL(clock))
432                         return 0;
433
434                 error = clk_enable(clock);
435                 if (error)
436                         goto err_disable;
437         }
438
439         return 0;
440
441 err_disable:
442         for (i--; i >= 0; i--) {
443                 clock = ddata->clocks[i];
444                 if (IS_ERR_OR_NULL(clock))
445                         continue;
446
447                 clk_disable(clock);
448         }
449
450         return error;
451 }
452
453 static void sysc_disable_opt_clocks(struct sysc *ddata)
454 {
455         struct clk *clock;
456         int i;
457
458         if (!ddata->clocks)
459                 return;
460
461         for (i = SYSC_OPTFCK0; i < SYSC_MAX_CLOCKS; i++) {
462                 clock = ddata->clocks[i];
463
464                 /* Assume no holes for opt clocks */
465                 if (IS_ERR_OR_NULL(clock))
466                         return;
467
468                 clk_disable(clock);
469         }
470 }
471
472 static void sysc_clkdm_deny_idle(struct sysc *ddata)
473 {
474         struct ti_sysc_platform_data *pdata;
475
476         if (ddata->legacy_mode)
477                 return;
478
479         pdata = dev_get_platdata(ddata->dev);
480         if (pdata && pdata->clkdm_deny_idle)
481                 pdata->clkdm_deny_idle(ddata->dev, &ddata->cookie);
482 }
483
484 static void sysc_clkdm_allow_idle(struct sysc *ddata)
485 {
486         struct ti_sysc_platform_data *pdata;
487
488         if (ddata->legacy_mode)
489                 return;
490
491         pdata = dev_get_platdata(ddata->dev);
492         if (pdata && pdata->clkdm_allow_idle)
493                 pdata->clkdm_allow_idle(ddata->dev, &ddata->cookie);
494 }
495
496 /**
497  * sysc_init_resets - init rstctrl reset line if configured
498  * @ddata: device driver data
499  *
500  * See sysc_rstctrl_reset_deassert().
501  */
502 static int sysc_init_resets(struct sysc *ddata)
503 {
504         ddata->rsts =
505                 devm_reset_control_get_optional_shared(ddata->dev, "rstctrl");
506         if (IS_ERR(ddata->rsts))
507                 return PTR_ERR(ddata->rsts);
508
509         return 0;
510 }
511
512 /**
513  * sysc_parse_and_check_child_range - parses module IO region from ranges
514  * @ddata: device driver data
515  *
516  * In general we only need rev, syss, and sysc registers and not the whole
517  * module range. But we do want the offsets for these registers from the
518  * module base. This allows us to check them against the legacy hwmod
519  * platform data. Let's also check the ranges are configured properly.
520  */
521 static int sysc_parse_and_check_child_range(struct sysc *ddata)
522 {
523         struct device_node *np = ddata->dev->of_node;
524         const __be32 *ranges;
525         u32 nr_addr, nr_size;
526         int len, error;
527
528         ranges = of_get_property(np, "ranges", &len);
529         if (!ranges) {
530                 dev_err(ddata->dev, "missing ranges for %pOF\n", np);
531
532                 return -ENOENT;
533         }
534
535         len /= sizeof(*ranges);
536
537         if (len < 3) {
538                 dev_err(ddata->dev, "incomplete ranges for %pOF\n", np);
539
540                 return -EINVAL;
541         }
542
543         error = of_property_read_u32(np, "#address-cells", &nr_addr);
544         if (error)
545                 return -ENOENT;
546
547         error = of_property_read_u32(np, "#size-cells", &nr_size);
548         if (error)
549                 return -ENOENT;
550
551         if (nr_addr != 1 || nr_size != 1) {
552                 dev_err(ddata->dev, "invalid ranges for %pOF\n", np);
553
554                 return -EINVAL;
555         }
556
557         ranges++;
558         ddata->module_pa = of_translate_address(np, ranges++);
559         ddata->module_size = be32_to_cpup(ranges);
560
561         return 0;
562 }
563
564 static struct device_node *stdout_path;
565
566 static void sysc_init_stdout_path(struct sysc *ddata)
567 {
568         struct device_node *np = NULL;
569         const char *uart;
570
571         if (IS_ERR(stdout_path))
572                 return;
573
574         if (stdout_path)
575                 return;
576
577         np = of_find_node_by_path("/chosen");
578         if (!np)
579                 goto err;
580
581         uart = of_get_property(np, "stdout-path", NULL);
582         if (!uart)
583                 goto err;
584
585         np = of_find_node_by_path(uart);
586         if (!np)
587                 goto err;
588
589         stdout_path = np;
590
591         return;
592
593 err:
594         stdout_path = ERR_PTR(-ENODEV);
595 }
596
597 static void sysc_check_quirk_stdout(struct sysc *ddata,
598                                     struct device_node *np)
599 {
600         sysc_init_stdout_path(ddata);
601         if (np != stdout_path)
602                 return;
603
604         ddata->cfg.quirks |= SYSC_QUIRK_NO_IDLE_ON_INIT |
605                                 SYSC_QUIRK_NO_RESET_ON_INIT;
606 }
607
608 /**
609  * sysc_check_one_child - check child configuration
610  * @ddata: device driver data
611  * @np: child device node
612  *
613  * Let's avoid messy situations where we have new interconnect target
614  * node but children have "ti,hwmods". These belong to the interconnect
615  * target node and are managed by this driver.
616  */
617 static void sysc_check_one_child(struct sysc *ddata,
618                                  struct device_node *np)
619 {
620         const char *name;
621
622         name = of_get_property(np, "ti,hwmods", NULL);
623         if (name)
624                 dev_warn(ddata->dev, "really a child ti,hwmods property?");
625
626         sysc_check_quirk_stdout(ddata, np);
627         sysc_parse_dts_quirks(ddata, np, true);
628 }
629
630 static void sysc_check_children(struct sysc *ddata)
631 {
632         struct device_node *child;
633
634         for_each_child_of_node(ddata->dev->of_node, child)
635                 sysc_check_one_child(ddata, child);
636 }
637
638 /*
639  * So far only I2C uses 16-bit read access with clockactivity with revision
640  * in two registers with stride of 4. We can detect this based on the rev
641  * register size to configure things far enough to be able to properly read
642  * the revision register.
643  */
644 static void sysc_check_quirk_16bit(struct sysc *ddata, struct resource *res)
645 {
646         if (resource_size(res) == 8)
647                 ddata->cfg.quirks |= SYSC_QUIRK_16BIT | SYSC_QUIRK_USE_CLOCKACT;
648 }
649
650 /**
651  * sysc_parse_one - parses the interconnect target module registers
652  * @ddata: device driver data
653  * @reg: register to parse
654  */
655 static int sysc_parse_one(struct sysc *ddata, enum sysc_registers reg)
656 {
657         struct resource *res;
658         const char *name;
659
660         switch (reg) {
661         case SYSC_REVISION:
662         case SYSC_SYSCONFIG:
663         case SYSC_SYSSTATUS:
664                 name = reg_names[reg];
665                 break;
666         default:
667                 return -EINVAL;
668         }
669
670         res = platform_get_resource_byname(to_platform_device(ddata->dev),
671                                            IORESOURCE_MEM, name);
672         if (!res) {
673                 ddata->offsets[reg] = -ENODEV;
674
675                 return 0;
676         }
677
678         ddata->offsets[reg] = res->start - ddata->module_pa;
679         if (reg == SYSC_REVISION)
680                 sysc_check_quirk_16bit(ddata, res);
681
682         return 0;
683 }
684
685 static int sysc_parse_registers(struct sysc *ddata)
686 {
687         int i, error;
688
689         for (i = 0; i < SYSC_MAX_REGS; i++) {
690                 error = sysc_parse_one(ddata, i);
691                 if (error)
692                         return error;
693         }
694
695         return 0;
696 }
697
698 /**
699  * sysc_check_registers - check for misconfigured register overlaps
700  * @ddata: device driver data
701  */
702 static int sysc_check_registers(struct sysc *ddata)
703 {
704         int i, j, nr_regs = 0, nr_matches = 0;
705
706         for (i = 0; i < SYSC_MAX_REGS; i++) {
707                 if (ddata->offsets[i] < 0)
708                         continue;
709
710                 if (ddata->offsets[i] > (ddata->module_size - 4)) {
711                         dev_err(ddata->dev, "register outside module range");
712
713                                 return -EINVAL;
714                 }
715
716                 for (j = 0; j < SYSC_MAX_REGS; j++) {
717                         if (ddata->offsets[j] < 0)
718                                 continue;
719
720                         if (ddata->offsets[i] == ddata->offsets[j])
721                                 nr_matches++;
722                 }
723                 nr_regs++;
724         }
725
726         if (nr_matches > nr_regs) {
727                 dev_err(ddata->dev, "overlapping registers: (%i/%i)",
728                         nr_regs, nr_matches);
729
730                 return -EINVAL;
731         }
732
733         return 0;
734 }
735
736 /**
737  * syc_ioremap - ioremap register space for the interconnect target module
738  * @ddata: device driver data
739  *
740  * Note that the interconnect target module registers can be anywhere
741  * within the interconnect target module range. For example, SGX has
742  * them at offset 0x1fc00 in the 32MB module address space. And cpsw
743  * has them at offset 0x1200 in the CPSW_WR child. Usually the
744  * the interconnect target module registers are at the beginning of
745  * the module range though.
746  */
747 static int sysc_ioremap(struct sysc *ddata)
748 {
749         int size;
750
751         if (ddata->offsets[SYSC_REVISION] < 0 &&
752             ddata->offsets[SYSC_SYSCONFIG] < 0 &&
753             ddata->offsets[SYSC_SYSSTATUS] < 0) {
754                 size = ddata->module_size;
755         } else {
756                 size = max3(ddata->offsets[SYSC_REVISION],
757                             ddata->offsets[SYSC_SYSCONFIG],
758                             ddata->offsets[SYSC_SYSSTATUS]);
759
760                 if (size < SZ_1K)
761                         size = SZ_1K;
762
763                 if ((size + sizeof(u32)) > ddata->module_size)
764                         size = ddata->module_size;
765         }
766
767         ddata->module_va = devm_ioremap(ddata->dev,
768                                         ddata->module_pa,
769                                         size + sizeof(u32));
770         if (!ddata->module_va)
771                 return -EIO;
772
773         return 0;
774 }
775
776 /**
777  * sysc_map_and_check_registers - ioremap and check device registers
778  * @ddata: device driver data
779  */
780 static int sysc_map_and_check_registers(struct sysc *ddata)
781 {
782         int error;
783
784         error = sysc_parse_and_check_child_range(ddata);
785         if (error)
786                 return error;
787
788         sysc_check_children(ddata);
789
790         error = sysc_parse_registers(ddata);
791         if (error)
792                 return error;
793
794         error = sysc_ioremap(ddata);
795         if (error)
796                 return error;
797
798         error = sysc_check_registers(ddata);
799         if (error)
800                 return error;
801
802         return 0;
803 }
804
805 /**
806  * sysc_show_rev - read and show interconnect target module revision
807  * @bufp: buffer to print the information to
808  * @ddata: device driver data
809  */
810 static int sysc_show_rev(char *bufp, struct sysc *ddata)
811 {
812         int len;
813
814         if (ddata->offsets[SYSC_REVISION] < 0)
815                 return sprintf(bufp, ":NA");
816
817         len = sprintf(bufp, ":%08x", ddata->revision);
818
819         return len;
820 }
821
822 static int sysc_show_reg(struct sysc *ddata,
823                          char *bufp, enum sysc_registers reg)
824 {
825         if (ddata->offsets[reg] < 0)
826                 return sprintf(bufp, ":NA");
827
828         return sprintf(bufp, ":%x", ddata->offsets[reg]);
829 }
830
831 static int sysc_show_name(char *bufp, struct sysc *ddata)
832 {
833         if (!ddata->name)
834                 return 0;
835
836         return sprintf(bufp, ":%s", ddata->name);
837 }
838
839 /**
840  * sysc_show_registers - show information about interconnect target module
841  * @ddata: device driver data
842  */
843 static void sysc_show_registers(struct sysc *ddata)
844 {
845         char buf[128];
846         char *bufp = buf;
847         int i;
848
849         for (i = 0; i < SYSC_MAX_REGS; i++)
850                 bufp += sysc_show_reg(ddata, bufp, i);
851
852         bufp += sysc_show_rev(bufp, ddata);
853         bufp += sysc_show_name(bufp, ddata);
854
855         dev_dbg(ddata->dev, "%llx:%x%s\n",
856                 ddata->module_pa, ddata->module_size,
857                 buf);
858 }
859
860 #define SYSC_IDLE_MASK  (SYSC_NR_IDLEMODES - 1)
861 #define SYSC_CLOCACT_ICK        2
862
863 /* Caller needs to manage sysc_clkdm_deny_idle() and sysc_clkdm_allow_idle() */
864 static int sysc_enable_module(struct device *dev)
865 {
866         struct sysc *ddata;
867         const struct sysc_regbits *regbits;
868         u32 reg, idlemodes, best_mode;
869
870         ddata = dev_get_drvdata(dev);
871         if (ddata->offsets[SYSC_SYSCONFIG] == -ENODEV)
872                 return 0;
873
874         regbits = ddata->cap->regbits;
875         reg = sysc_read(ddata, ddata->offsets[SYSC_SYSCONFIG]);
876
877         /* Set CLOCKACTIVITY, we only use it for ick */
878         if (regbits->clkact_shift >= 0 &&
879             (ddata->cfg.quirks & SYSC_QUIRK_USE_CLOCKACT ||
880              ddata->cfg.sysc_val & BIT(regbits->clkact_shift)))
881                 reg |= SYSC_CLOCACT_ICK << regbits->clkact_shift;
882
883         /* Set SIDLE mode */
884         idlemodes = ddata->cfg.sidlemodes;
885         if (!idlemodes || regbits->sidle_shift < 0)
886                 goto set_midle;
887
888         if (ddata->cfg.quirks & (SYSC_QUIRK_SWSUP_SIDLE |
889                                  SYSC_QUIRK_SWSUP_SIDLE_ACT)) {
890                 best_mode = SYSC_IDLE_NO;
891         } else {
892                 best_mode = fls(ddata->cfg.sidlemodes) - 1;
893                 if (best_mode > SYSC_IDLE_MASK) {
894                         dev_err(dev, "%s: invalid sidlemode\n", __func__);
895                         return -EINVAL;
896                 }
897
898                 /* Set WAKEUP */
899                 if (regbits->enwkup_shift >= 0 &&
900                     ddata->cfg.sysc_val & BIT(regbits->enwkup_shift))
901                         reg |= BIT(regbits->enwkup_shift);
902         }
903
904         reg &= ~(SYSC_IDLE_MASK << regbits->sidle_shift);
905         reg |= best_mode << regbits->sidle_shift;
906         sysc_write(ddata, ddata->offsets[SYSC_SYSCONFIG], reg);
907
908 set_midle:
909         /* Set MIDLE mode */
910         idlemodes = ddata->cfg.midlemodes;
911         if (!idlemodes || regbits->midle_shift < 0)
912                 goto set_autoidle;
913
914         best_mode = fls(ddata->cfg.midlemodes) - 1;
915         if (best_mode > SYSC_IDLE_MASK) {
916                 dev_err(dev, "%s: invalid midlemode\n", __func__);
917                 return -EINVAL;
918         }
919
920         if (ddata->cfg.quirks & SYSC_QUIRK_SWSUP_MSTANDBY)
921                 best_mode = SYSC_IDLE_NO;
922
923         reg &= ~(SYSC_IDLE_MASK << regbits->midle_shift);
924         reg |= best_mode << regbits->midle_shift;
925         sysc_write(ddata, ddata->offsets[SYSC_SYSCONFIG], reg);
926
927 set_autoidle:
928         /* Autoidle bit must enabled separately if available */
929         if (regbits->autoidle_shift >= 0 &&
930             ddata->cfg.sysc_val & BIT(regbits->autoidle_shift)) {
931                 reg |= 1 << regbits->autoidle_shift;
932                 sysc_write(ddata, ddata->offsets[SYSC_SYSCONFIG], reg);
933         }
934
935         if (ddata->module_enable_quirk)
936                 ddata->module_enable_quirk(ddata);
937
938         return 0;
939 }
940
941 static int sysc_best_idle_mode(u32 idlemodes, u32 *best_mode)
942 {
943         if (idlemodes & BIT(SYSC_IDLE_SMART_WKUP))
944                 *best_mode = SYSC_IDLE_SMART_WKUP;
945         else if (idlemodes & BIT(SYSC_IDLE_SMART))
946                 *best_mode = SYSC_IDLE_SMART;
947         else if (idlemodes & BIT(SYSC_IDLE_FORCE))
948                 *best_mode = SYSC_IDLE_FORCE;
949         else
950                 return -EINVAL;
951
952         return 0;
953 }
954
955 /* Caller needs to manage sysc_clkdm_deny_idle() and sysc_clkdm_allow_idle() */
956 static int sysc_disable_module(struct device *dev)
957 {
958         struct sysc *ddata;
959         const struct sysc_regbits *regbits;
960         u32 reg, idlemodes, best_mode;
961         int ret;
962
963         ddata = dev_get_drvdata(dev);
964         if (ddata->offsets[SYSC_SYSCONFIG] == -ENODEV)
965                 return 0;
966
967         if (ddata->module_disable_quirk)
968                 ddata->module_disable_quirk(ddata);
969
970         regbits = ddata->cap->regbits;
971         reg = sysc_read(ddata, ddata->offsets[SYSC_SYSCONFIG]);
972
973         /* Set MIDLE mode */
974         idlemodes = ddata->cfg.midlemodes;
975         if (!idlemodes || regbits->midle_shift < 0)
976                 goto set_sidle;
977
978         ret = sysc_best_idle_mode(idlemodes, &best_mode);
979         if (ret) {
980                 dev_err(dev, "%s: invalid midlemode\n", __func__);
981                 return ret;
982         }
983
984         if (ddata->cfg.quirks & SYSC_QUIRK_SWSUP_MSTANDBY)
985                 best_mode = SYSC_IDLE_FORCE;
986
987         reg &= ~(SYSC_IDLE_MASK << regbits->midle_shift);
988         reg |= best_mode << regbits->midle_shift;
989         sysc_write(ddata, ddata->offsets[SYSC_SYSCONFIG], reg);
990
991 set_sidle:
992         /* Set SIDLE mode */
993         idlemodes = ddata->cfg.sidlemodes;
994         if (!idlemodes || regbits->sidle_shift < 0)
995                 return 0;
996
997         if (ddata->cfg.quirks & SYSC_QUIRK_SWSUP_SIDLE) {
998                 best_mode = SYSC_IDLE_FORCE;
999         } else {
1000                 ret = sysc_best_idle_mode(idlemodes, &best_mode);
1001                 if (ret) {
1002                         dev_err(dev, "%s: invalid sidlemode\n", __func__);
1003                         return ret;
1004                 }
1005         }
1006
1007         reg &= ~(SYSC_IDLE_MASK << regbits->sidle_shift);
1008         reg |= best_mode << regbits->sidle_shift;
1009         if (regbits->autoidle_shift >= 0 &&
1010             ddata->cfg.sysc_val & BIT(regbits->autoidle_shift))
1011                 reg |= 1 << regbits->autoidle_shift;
1012         sysc_write(ddata, ddata->offsets[SYSC_SYSCONFIG], reg);
1013
1014         return 0;
1015 }
1016
1017 static int __maybe_unused sysc_runtime_suspend_legacy(struct device *dev,
1018                                                       struct sysc *ddata)
1019 {
1020         struct ti_sysc_platform_data *pdata;
1021         int error;
1022
1023         pdata = dev_get_platdata(ddata->dev);
1024         if (!pdata)
1025                 return 0;
1026
1027         if (!pdata->idle_module)
1028                 return -ENODEV;
1029
1030         error = pdata->idle_module(dev, &ddata->cookie);
1031         if (error)
1032                 dev_err(dev, "%s: could not idle: %i\n",
1033                         __func__, error);
1034
1035         reset_control_assert(ddata->rsts);
1036
1037         return 0;
1038 }
1039
1040 static int __maybe_unused sysc_runtime_resume_legacy(struct device *dev,
1041                                                      struct sysc *ddata)
1042 {
1043         struct ti_sysc_platform_data *pdata;
1044         int error;
1045
1046         pdata = dev_get_platdata(ddata->dev);
1047         if (!pdata)
1048                 return 0;
1049
1050         if (!pdata->enable_module)
1051                 return -ENODEV;
1052
1053         error = pdata->enable_module(dev, &ddata->cookie);
1054         if (error)
1055                 dev_err(dev, "%s: could not enable: %i\n",
1056                         __func__, error);
1057
1058         reset_control_deassert(ddata->rsts);
1059
1060         return 0;
1061 }
1062
1063 static int __maybe_unused sysc_runtime_suspend(struct device *dev)
1064 {
1065         struct sysc *ddata;
1066         int error = 0;
1067
1068         ddata = dev_get_drvdata(dev);
1069
1070         if (!ddata->enabled)
1071                 return 0;
1072
1073         sysc_clkdm_deny_idle(ddata);
1074
1075         if (ddata->legacy_mode) {
1076                 error = sysc_runtime_suspend_legacy(dev, ddata);
1077                 if (error)
1078                         goto err_allow_idle;
1079         } else {
1080                 error = sysc_disable_module(dev);
1081                 if (error)
1082                         goto err_allow_idle;
1083         }
1084
1085         sysc_disable_main_clocks(ddata);
1086
1087         if (sysc_opt_clks_needed(ddata))
1088                 sysc_disable_opt_clocks(ddata);
1089
1090         ddata->enabled = false;
1091
1092 err_allow_idle:
1093         reset_control_assert(ddata->rsts);
1094
1095         sysc_clkdm_allow_idle(ddata);
1096
1097         return error;
1098 }
1099
1100 static int __maybe_unused sysc_runtime_resume(struct device *dev)
1101 {
1102         struct sysc *ddata;
1103         int error = 0;
1104
1105         ddata = dev_get_drvdata(dev);
1106
1107         if (ddata->enabled)
1108                 return 0;
1109
1110
1111         sysc_clkdm_deny_idle(ddata);
1112
1113         if (sysc_opt_clks_needed(ddata)) {
1114                 error = sysc_enable_opt_clocks(ddata);
1115                 if (error)
1116                         goto err_allow_idle;
1117         }
1118
1119         error = sysc_enable_main_clocks(ddata);
1120         if (error)
1121                 goto err_opt_clocks;
1122
1123         reset_control_deassert(ddata->rsts);
1124
1125         if (ddata->legacy_mode) {
1126                 error = sysc_runtime_resume_legacy(dev, ddata);
1127                 if (error)
1128                         goto err_main_clocks;
1129         } else {
1130                 error = sysc_enable_module(dev);
1131                 if (error)
1132                         goto err_main_clocks;
1133         }
1134
1135         ddata->enabled = true;
1136
1137         sysc_clkdm_allow_idle(ddata);
1138
1139         return 0;
1140
1141 err_main_clocks:
1142         sysc_disable_main_clocks(ddata);
1143 err_opt_clocks:
1144         if (sysc_opt_clks_needed(ddata))
1145                 sysc_disable_opt_clocks(ddata);
1146 err_allow_idle:
1147         sysc_clkdm_allow_idle(ddata);
1148
1149         return error;
1150 }
1151
1152 static int __maybe_unused sysc_noirq_suspend(struct device *dev)
1153 {
1154         struct sysc *ddata;
1155
1156         ddata = dev_get_drvdata(dev);
1157
1158         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
1159                 return 0;
1160
1161         return pm_runtime_force_suspend(dev);
1162 }
1163
1164 static int __maybe_unused sysc_noirq_resume(struct device *dev)
1165 {
1166         struct sysc *ddata;
1167
1168         ddata = dev_get_drvdata(dev);
1169
1170         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
1171                 return 0;
1172
1173         return pm_runtime_force_resume(dev);
1174 }
1175
1176 static const struct dev_pm_ops sysc_pm_ops = {
1177         SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sysc_noirq_suspend, sysc_noirq_resume)
1178         SET_RUNTIME_PM_OPS(sysc_runtime_suspend,
1179                            sysc_runtime_resume,
1180                            NULL)
1181 };
1182
1183 /* Module revision register based quirks */
1184 struct sysc_revision_quirk {
1185         const char *name;
1186         u32 base;
1187         int rev_offset;
1188         int sysc_offset;
1189         int syss_offset;
1190         u32 revision;
1191         u32 revision_mask;
1192         u32 quirks;
1193 };
1194
1195 #define SYSC_QUIRK(optname, optbase, optrev, optsysc, optsyss,          \
1196                    optrev_val, optrevmask, optquirkmask)                \
1197         {                                                               \
1198                 .name = (optname),                                      \
1199                 .base = (optbase),                                      \
1200                 .rev_offset = (optrev),                                 \
1201                 .sysc_offset = (optsysc),                               \
1202                 .syss_offset = (optsyss),                               \
1203                 .revision = (optrev_val),                               \
1204                 .revision_mask = (optrevmask),                          \
1205                 .quirks = (optquirkmask),                               \
1206         }
1207
1208 static const struct sysc_revision_quirk sysc_revision_quirks[] = {
1209         /* These drivers need to be fixed to not use pm_runtime_irq_safe() */
1210         SYSC_QUIRK("gpio", 0, 0, 0x10, 0x114, 0x50600801, 0xffff00ff,
1211                    SYSC_QUIRK_LEGACY_IDLE | SYSC_QUIRK_OPT_CLKS_IN_RESET),
1212         SYSC_QUIRK("mmu", 0, 0, 0x10, 0x14, 0x00000020, 0xffffffff,
1213                    SYSC_QUIRK_LEGACY_IDLE),
1214         SYSC_QUIRK("mmu", 0, 0, 0x10, 0x14, 0x00000030, 0xffffffff,
1215                    SYSC_QUIRK_LEGACY_IDLE),
1216         SYSC_QUIRK("sham", 0, 0x100, 0x110, 0x114, 0x40000c03, 0xffffffff,
1217                    SYSC_QUIRK_LEGACY_IDLE),
1218         SYSC_QUIRK("smartreflex", 0, -1, 0x24, -1, 0x00000000, 0xffffffff,
1219                    SYSC_QUIRK_LEGACY_IDLE),
1220         SYSC_QUIRK("smartreflex", 0, -1, 0x38, -1, 0x00000000, 0xffffffff,
1221                    SYSC_QUIRK_LEGACY_IDLE),
1222         SYSC_QUIRK("timer", 0, 0, 0x10, 0x14, 0x00000015, 0xffffffff,
1223                    0),
1224         /* Some timers on omap4 and later */
1225         SYSC_QUIRK("timer", 0, 0, 0x10, -1, 0x50002100, 0xffffffff,
1226                    0),
1227         SYSC_QUIRK("timer", 0, 0, 0x10, -1, 0x4fff1301, 0xffff00ff,
1228                    0),
1229         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x00000046, 0xffffffff,
1230                    SYSC_QUIRK_SWSUP_SIDLE | SYSC_QUIRK_LEGACY_IDLE),
1231         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x00000052, 0xffffffff,
1232                    SYSC_QUIRK_SWSUP_SIDLE | SYSC_QUIRK_LEGACY_IDLE),
1233         /* Uarts on omap4 and later */
1234         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x50411e03, 0xffff00ff,
1235                    SYSC_QUIRK_SWSUP_SIDLE_ACT | SYSC_QUIRK_LEGACY_IDLE),
1236         SYSC_QUIRK("uart", 0, 0x50, 0x54, 0x58, 0x47422e03, 0xffffffff,
1237                    SYSC_QUIRK_SWSUP_SIDLE_ACT | SYSC_QUIRK_LEGACY_IDLE),
1238
1239         /* Quirks that need to be set based on the module address */
1240         SYSC_QUIRK("mcpdm", 0x40132000, 0, 0x10, -1, 0x50000800, 0xffffffff,
1241                    SYSC_QUIRK_EXT_OPT_CLOCK | SYSC_QUIRK_NO_RESET_ON_INIT |
1242                    SYSC_QUIRK_SWSUP_SIDLE),
1243
1244         /* Quirks that need to be set based on detected module */
1245         SYSC_QUIRK("hdq1w", 0, 0, 0x14, 0x18, 0x00000006, 0xffffffff,
1246                    SYSC_MODULE_QUIRK_HDQ1W),
1247         SYSC_QUIRK("hdq1w", 0, 0, 0x14, 0x18, 0x0000000a, 0xffffffff,
1248                    SYSC_MODULE_QUIRK_HDQ1W),
1249         SYSC_QUIRK("i2c", 0, 0, 0x20, 0x10, 0x00000036, 0x000000ff,
1250                    SYSC_MODULE_QUIRK_I2C),
1251         SYSC_QUIRK("i2c", 0, 0, 0x20, 0x10, 0x0000003c, 0x000000ff,
1252                    SYSC_MODULE_QUIRK_I2C),
1253         SYSC_QUIRK("i2c", 0, 0, 0x20, 0x10, 0x00000040, 0x000000ff,
1254                    SYSC_MODULE_QUIRK_I2C),
1255         SYSC_QUIRK("i2c", 0, 0, 0x10, 0x90, 0x5040000a, 0xfffff0f0,
1256                    SYSC_MODULE_QUIRK_I2C),
1257         SYSC_QUIRK("gpu", 0x50000000, 0x14, -1, -1, 0x00010201, 0xffffffff, 0),
1258         SYSC_QUIRK("gpu", 0x50000000, 0xfe00, 0xfe10, -1, 0x40000000 , 0xffffffff,
1259                    SYSC_MODULE_QUIRK_SGX),
1260         SYSC_QUIRK("usb_otg_hs", 0, 0x400, 0x404, 0x408, 0x00000050,
1261                    0xffffffff, SYSC_QUIRK_SWSUP_SIDLE | SYSC_QUIRK_SWSUP_MSTANDBY),
1262         SYSC_QUIRK("usb_otg_hs", 0, 0, 0x10, -1, 0x4ea2080d, 0xffffffff,
1263                    SYSC_QUIRK_SWSUP_SIDLE | SYSC_QUIRK_SWSUP_MSTANDBY),
1264         SYSC_QUIRK("wdt", 0, 0, 0x10, 0x14, 0x502a0500, 0xfffff0f0,
1265                    SYSC_MODULE_QUIRK_WDT),
1266         /* Watchdog on am3 and am4 */
1267         SYSC_QUIRK("wdt", 0x44e35000, 0, 0x10, 0x14, 0x502a0500, 0xfffff0f0,
1268                    SYSC_MODULE_QUIRK_WDT | SYSC_QUIRK_SWSUP_SIDLE),
1269
1270 #ifdef DEBUG
1271         SYSC_QUIRK("adc", 0, 0, 0x10, -1, 0x47300001, 0xffffffff, 0),
1272         SYSC_QUIRK("atl", 0, 0, -1, -1, 0x0a070100, 0xffffffff, 0),
1273         SYSC_QUIRK("aess", 0, 0, 0x10, -1, 0x40000000, 0xffffffff, 0),
1274         SYSC_QUIRK("cm", 0, 0, -1, -1, 0x40000301, 0xffffffff, 0),
1275         SYSC_QUIRK("control", 0, 0, 0x10, -1, 0x40000900, 0xffffffff, 0),
1276         SYSC_QUIRK("cpgmac", 0, 0x1200, 0x1208, 0x1204, 0x4edb1902,
1277                    0xffff00f0, 0),
1278         SYSC_QUIRK("dcan", 0, 0x20, -1, -1, 0xa3170504, 0xffffffff, 0),
1279         SYSC_QUIRK("dcan", 0, 0x20, -1, -1, 0x4edb1902, 0xffffffff, 0),
1280         SYSC_QUIRK("dmic", 0, 0, 0x10, -1, 0x50010000, 0xffffffff, 0),
1281         SYSC_QUIRK("dwc3", 0, 0, 0x10, -1, 0x500a0200, 0xffffffff, 0),
1282         SYSC_QUIRK("d2d", 0x4a0b6000, 0, 0x10, 0x14, 0x00000010, 0xffffffff, 0),
1283         SYSC_QUIRK("d2d", 0x4a0cd000, 0, 0x10, 0x14, 0x00000010, 0xffffffff, 0),
1284         SYSC_QUIRK("epwmss", 0, 0, 0x4, -1, 0x47400001, 0xffffffff, 0),
1285         SYSC_QUIRK("gpu", 0, 0x1fc00, 0x1fc10, -1, 0, 0, 0),
1286         SYSC_QUIRK("gpu", 0, 0xfe00, 0xfe10, -1, 0x40000000 , 0xffffffff, 0),
1287         SYSC_QUIRK("hsi", 0, 0, 0x10, 0x14, 0x50043101, 0xffffffff, 0),
1288         SYSC_QUIRK("iss", 0, 0, 0x10, -1, 0x40000101, 0xffffffff, 0),
1289         SYSC_QUIRK("lcdc", 0, 0, 0x54, -1, 0x4f201000, 0xffffffff, 0),
1290         SYSC_QUIRK("mcasp", 0, 0, 0x4, -1, 0x44306302, 0xffffffff, 0),
1291         SYSC_QUIRK("mcasp", 0, 0, 0x4, -1, 0x44307b02, 0xffffffff, 0),
1292         SYSC_QUIRK("mcbsp", 0, -1, 0x8c, -1, 0, 0, 0),
1293         SYSC_QUIRK("mcspi", 0, 0, 0x10, -1, 0x40300a0b, 0xffff00ff, 0),
1294         SYSC_QUIRK("mcspi", 0, 0, 0x110, 0x114, 0x40300a0b, 0xffffffff, 0),
1295         SYSC_QUIRK("mailbox", 0, 0, 0x10, -1, 0x00000400, 0xffffffff, 0),
1296         SYSC_QUIRK("m3", 0, 0, -1, -1, 0x5f580105, 0x0fff0f00, 0),
1297         SYSC_QUIRK("ocp2scp", 0, 0, 0x10, 0x14, 0x50060005, 0xfffffff0, 0),
1298         SYSC_QUIRK("ocp2scp", 0, 0, -1, -1, 0x50060007, 0xffffffff, 0),
1299         SYSC_QUIRK("padconf", 0, 0, 0x10, -1, 0x4fff0800, 0xffffffff, 0),
1300         SYSC_QUIRK("padconf", 0, 0, -1, -1, 0x40001100, 0xffffffff, 0),
1301         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x40000100, 0xffffffff, 0),
1302         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x00004102, 0xffffffff, 0),
1303         SYSC_QUIRK("prcm", 0, 0, -1, -1, 0x40000400, 0xffffffff, 0),
1304         SYSC_QUIRK("scm", 0, 0, 0x10, -1, 0x40000900, 0xffffffff, 0),
1305         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x4e8b0100, 0xffffffff, 0),
1306         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x4f000100, 0xffffffff, 0),
1307         SYSC_QUIRK("scm", 0, 0, -1, -1, 0x40000900, 0xffffffff, 0),
1308         SYSC_QUIRK("scrm", 0, 0, -1, -1, 0x00000010, 0xffffffff, 0),
1309         SYSC_QUIRK("sdio", 0, 0, 0x10, -1, 0x40202301, 0xffff0ff0, 0),
1310         SYSC_QUIRK("sdio", 0, 0x2fc, 0x110, 0x114, 0x31010000, 0xffffffff, 0),
1311         SYSC_QUIRK("sdma", 0, 0, 0x2c, 0x28, 0x00010900, 0xffffffff, 0),
1312         SYSC_QUIRK("slimbus", 0, 0, 0x10, -1, 0x40000902, 0xffffffff, 0),
1313         SYSC_QUIRK("slimbus", 0, 0, 0x10, -1, 0x40002903, 0xffffffff, 0),
1314         SYSC_QUIRK("spinlock", 0, 0, 0x10, -1, 0x50020000, 0xffffffff, 0),
1315         SYSC_QUIRK("rng", 0, 0x1fe0, 0x1fe4, -1, 0x00000020, 0xffffffff, 0),
1316         SYSC_QUIRK("rtc", 0, 0x74, 0x78, -1, 0x4eb01908, 0xffff00f0, 0),
1317         SYSC_QUIRK("timer32k", 0, 0, 0x4, -1, 0x00000060, 0xffffffff, 0),
1318         SYSC_QUIRK("usbhstll", 0, 0, 0x10, 0x14, 0x00000004, 0xffffffff, 0),
1319         SYSC_QUIRK("usbhstll", 0, 0, 0x10, 0x14, 0x00000008, 0xffffffff, 0),
1320         SYSC_QUIRK("usb_host_hs", 0, 0, 0x10, 0x14, 0x50700100, 0xffffffff, 0),
1321         SYSC_QUIRK("usb_host_hs", 0, 0, 0x10, -1, 0x50700101, 0xffffffff, 0),
1322         SYSC_QUIRK("vfpe", 0, 0, 0x104, -1, 0x4d001200, 0xffffffff, 0),
1323 #endif
1324 };
1325
1326 /*
1327  * Early quirks based on module base and register offsets only that are
1328  * needed before the module revision can be read
1329  */
1330 static void sysc_init_early_quirks(struct sysc *ddata)
1331 {
1332         const struct sysc_revision_quirk *q;
1333         int i;
1334
1335         for (i = 0; i < ARRAY_SIZE(sysc_revision_quirks); i++) {
1336                 q = &sysc_revision_quirks[i];
1337
1338                 if (!q->base)
1339                         continue;
1340
1341                 if (q->base != ddata->module_pa)
1342                         continue;
1343
1344                 if (q->rev_offset >= 0 &&
1345                     q->rev_offset != ddata->offsets[SYSC_REVISION])
1346                         continue;
1347
1348                 if (q->sysc_offset >= 0 &&
1349                     q->sysc_offset != ddata->offsets[SYSC_SYSCONFIG])
1350                         continue;
1351
1352                 if (q->syss_offset >= 0 &&
1353                     q->syss_offset != ddata->offsets[SYSC_SYSSTATUS])
1354                         continue;
1355
1356                 ddata->name = q->name;
1357                 ddata->cfg.quirks |= q->quirks;
1358         }
1359 }
1360
1361 /* Quirks that also consider the revision register value */
1362 static void sysc_init_revision_quirks(struct sysc *ddata)
1363 {
1364         const struct sysc_revision_quirk *q;
1365         int i;
1366
1367         for (i = 0; i < ARRAY_SIZE(sysc_revision_quirks); i++) {
1368                 q = &sysc_revision_quirks[i];
1369
1370                 if (q->base && q->base != ddata->module_pa)
1371                         continue;
1372
1373                 if (q->rev_offset >= 0 &&
1374                     q->rev_offset != ddata->offsets[SYSC_REVISION])
1375                         continue;
1376
1377                 if (q->sysc_offset >= 0 &&
1378                     q->sysc_offset != ddata->offsets[SYSC_SYSCONFIG])
1379                         continue;
1380
1381                 if (q->syss_offset >= 0 &&
1382                     q->syss_offset != ddata->offsets[SYSC_SYSSTATUS])
1383                         continue;
1384
1385                 if (q->revision == ddata->revision ||
1386                     (q->revision & q->revision_mask) ==
1387                     (ddata->revision & q->revision_mask)) {
1388                         ddata->name = q->name;
1389                         ddata->cfg.quirks |= q->quirks;
1390                 }
1391         }
1392 }
1393
1394 /* 1-wire needs module's internal clocks enabled for reset */
1395 static void sysc_clk_enable_quirk_hdq1w(struct sysc *ddata)
1396 {
1397         int offset = 0x0c;      /* HDQ_CTRL_STATUS */
1398         u16 val;
1399
1400         val = sysc_read(ddata, offset);
1401         val |= BIT(5);
1402         sysc_write(ddata, offset, val);
1403 }
1404
1405 /* I2C needs extra enable bit toggling for reset */
1406 static void sysc_clk_quirk_i2c(struct sysc *ddata, bool enable)
1407 {
1408         int offset;
1409         u16 val;
1410
1411         /* I2C_CON, omap2/3 is different from omap4 and later */
1412         if ((ddata->revision & 0xffffff00) == 0x001f0000)
1413                 offset = 0x24;
1414         else
1415                 offset = 0xa4;
1416
1417         /* I2C_EN */
1418         val = sysc_read(ddata, offset);
1419         if (enable)
1420                 val |= BIT(15);
1421         else
1422                 val &= ~BIT(15);
1423         sysc_write(ddata, offset, val);
1424 }
1425
1426 static void sysc_clk_enable_quirk_i2c(struct sysc *ddata)
1427 {
1428         sysc_clk_quirk_i2c(ddata, true);
1429 }
1430
1431 static void sysc_clk_disable_quirk_i2c(struct sysc *ddata)
1432 {
1433         sysc_clk_quirk_i2c(ddata, false);
1434 }
1435
1436 /* 36xx SGX needs a quirk for to bypass OCP IPG interrupt logic */
1437 static void sysc_module_enable_quirk_sgx(struct sysc *ddata)
1438 {
1439         int offset = 0xff08;    /* OCP_DEBUG_CONFIG */
1440         u32 val = BIT(31);      /* THALIA_INT_BYPASS */
1441
1442         sysc_write(ddata, offset, val);
1443 }
1444
1445 /* Watchdog timer needs a disable sequence after reset */
1446 static void sysc_reset_done_quirk_wdt(struct sysc *ddata)
1447 {
1448         int wps, spr, error;
1449         u32 val;
1450
1451         wps = 0x34;
1452         spr = 0x48;
1453
1454         sysc_write(ddata, spr, 0xaaaa);
1455         error = readl_poll_timeout(ddata->module_va + wps, val,
1456                                    !(val & 0x10), 100,
1457                                    MAX_MODULE_SOFTRESET_WAIT);
1458         if (error)
1459                 dev_warn(ddata->dev, "wdt disable step1 failed\n");
1460
1461         sysc_write(ddata, spr, 0x5555);
1462         error = readl_poll_timeout(ddata->module_va + wps, val,
1463                                    !(val & 0x10), 100,
1464                                    MAX_MODULE_SOFTRESET_WAIT);
1465         if (error)
1466                 dev_warn(ddata->dev, "wdt disable step2 failed\n");
1467 }
1468
1469 static void sysc_init_module_quirks(struct sysc *ddata)
1470 {
1471         if (ddata->legacy_mode || !ddata->name)
1472                 return;
1473
1474         if (ddata->cfg.quirks & SYSC_MODULE_QUIRK_HDQ1W) {
1475                 ddata->clk_enable_quirk = sysc_clk_enable_quirk_hdq1w;
1476
1477                 return;
1478         }
1479
1480         if (ddata->cfg.quirks & SYSC_MODULE_QUIRK_I2C) {
1481                 ddata->clk_enable_quirk = sysc_clk_enable_quirk_i2c;
1482                 ddata->clk_disable_quirk = sysc_clk_disable_quirk_i2c;
1483
1484                 return;
1485         }
1486
1487         if (ddata->cfg.quirks & SYSC_MODULE_QUIRK_SGX)
1488                 ddata->module_enable_quirk = sysc_module_enable_quirk_sgx;
1489
1490         if (ddata->cfg.quirks & SYSC_MODULE_QUIRK_WDT) {
1491                 ddata->reset_done_quirk = sysc_reset_done_quirk_wdt;
1492                 ddata->module_disable_quirk = sysc_reset_done_quirk_wdt;
1493         }
1494 }
1495
1496 static int sysc_clockdomain_init(struct sysc *ddata)
1497 {
1498         struct ti_sysc_platform_data *pdata = dev_get_platdata(ddata->dev);
1499         struct clk *fck = NULL, *ick = NULL;
1500         int error;
1501
1502         if (!pdata || !pdata->init_clockdomain)
1503                 return 0;
1504
1505         switch (ddata->nr_clocks) {
1506         case 2:
1507                 ick = ddata->clocks[SYSC_ICK];
1508                 /* fallthrough */
1509         case 1:
1510                 fck = ddata->clocks[SYSC_FCK];
1511                 break;
1512         case 0:
1513                 return 0;
1514         }
1515
1516         error = pdata->init_clockdomain(ddata->dev, fck, ick, &ddata->cookie);
1517         if (!error || error == -ENODEV)
1518                 return 0;
1519
1520         return error;
1521 }
1522
1523 /*
1524  * Note that pdata->init_module() typically does a reset first. After
1525  * pdata->init_module() is done, PM runtime can be used for the interconnect
1526  * target module.
1527  */
1528 static int sysc_legacy_init(struct sysc *ddata)
1529 {
1530         struct ti_sysc_platform_data *pdata = dev_get_platdata(ddata->dev);
1531         int error;
1532
1533         if (!pdata || !pdata->init_module)
1534                 return 0;
1535
1536         error = pdata->init_module(ddata->dev, ddata->mdata, &ddata->cookie);
1537         if (error == -EEXIST)
1538                 error = 0;
1539
1540         return error;
1541 }
1542
1543 /*
1544  * Note that the caller must ensure the interconnect target module is enabled
1545  * before calling reset. Otherwise reset will not complete.
1546  */
1547 static int sysc_reset(struct sysc *ddata)
1548 {
1549         int sysc_offset, syss_offset, sysc_val, rstval, error = 0;
1550         u32 sysc_mask, syss_done;
1551
1552         sysc_offset = ddata->offsets[SYSC_SYSCONFIG];
1553         syss_offset = ddata->offsets[SYSC_SYSSTATUS];
1554
1555         if (ddata->legacy_mode || sysc_offset < 0 ||
1556             ddata->cap->regbits->srst_shift < 0 ||
1557             ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT)
1558                 return 0;
1559
1560         sysc_mask = BIT(ddata->cap->regbits->srst_shift);
1561
1562         if (ddata->cfg.quirks & SYSS_QUIRK_RESETDONE_INVERTED)
1563                 syss_done = 0;
1564         else
1565                 syss_done = ddata->cfg.syss_mask;
1566
1567         if (ddata->clk_disable_quirk)
1568                 ddata->clk_disable_quirk(ddata);
1569
1570         sysc_val = sysc_read_sysconfig(ddata);
1571         sysc_val |= sysc_mask;
1572         sysc_write(ddata, sysc_offset, sysc_val);
1573
1574         if (ddata->clk_enable_quirk)
1575                 ddata->clk_enable_quirk(ddata);
1576
1577         /* Poll on reset status */
1578         if (syss_offset >= 0) {
1579                 error = readx_poll_timeout(sysc_read_sysstatus, ddata, rstval,
1580                                            (rstval & ddata->cfg.syss_mask) ==
1581                                            syss_done,
1582                                            100, MAX_MODULE_SOFTRESET_WAIT);
1583
1584         } else if (ddata->cfg.quirks & SYSC_QUIRK_RESET_STATUS) {
1585                 error = readx_poll_timeout(sysc_read_sysconfig, ddata, rstval,
1586                                            !(rstval & sysc_mask),
1587                                            100, MAX_MODULE_SOFTRESET_WAIT);
1588         }
1589
1590         if (ddata->reset_done_quirk)
1591                 ddata->reset_done_quirk(ddata);
1592
1593         return error;
1594 }
1595
1596 /*
1597  * At this point the module is configured enough to read the revision but
1598  * module may not be completely configured yet to use PM runtime. Enable
1599  * all clocks directly during init to configure the quirks needed for PM
1600  * runtime based on the revision register.
1601  */
1602 static int sysc_init_module(struct sysc *ddata)
1603 {
1604         int error = 0;
1605
1606         error = sysc_clockdomain_init(ddata);
1607         if (error)
1608                 return error;
1609
1610         sysc_clkdm_deny_idle(ddata);
1611
1612         /*
1613          * Always enable clocks. The bootloader may or may not have enabled
1614          * the related clocks.
1615          */
1616         error = sysc_enable_opt_clocks(ddata);
1617         if (error)
1618                 return error;
1619
1620         error = sysc_enable_main_clocks(ddata);
1621         if (error)
1622                 goto err_opt_clocks;
1623
1624         if (!(ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT)) {
1625                 error = reset_control_deassert(ddata->rsts);
1626                 if (error)
1627                         goto err_main_clocks;
1628         }
1629
1630         ddata->revision = sysc_read_revision(ddata);
1631         sysc_init_revision_quirks(ddata);
1632         sysc_init_module_quirks(ddata);
1633
1634         if (ddata->legacy_mode) {
1635                 error = sysc_legacy_init(ddata);
1636                 if (error)
1637                         goto err_reset;
1638         }
1639
1640         if (!ddata->legacy_mode) {
1641                 error = sysc_enable_module(ddata->dev);
1642                 if (error)
1643                         goto err_reset;
1644         }
1645
1646         error = sysc_reset(ddata);
1647         if (error)
1648                 dev_err(ddata->dev, "Reset failed with %d\n", error);
1649
1650         if (error && !ddata->legacy_mode)
1651                 sysc_disable_module(ddata->dev);
1652
1653 err_reset:
1654         if (error && !(ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT))
1655                 reset_control_assert(ddata->rsts);
1656
1657 err_main_clocks:
1658         if (error)
1659                 sysc_disable_main_clocks(ddata);
1660 err_opt_clocks:
1661         /* No re-enable of clockdomain autoidle to prevent module autoidle */
1662         if (error) {
1663                 sysc_disable_opt_clocks(ddata);
1664                 sysc_clkdm_allow_idle(ddata);
1665         }
1666
1667         return error;
1668 }
1669
1670 static int sysc_init_sysc_mask(struct sysc *ddata)
1671 {
1672         struct device_node *np = ddata->dev->of_node;
1673         int error;
1674         u32 val;
1675
1676         error = of_property_read_u32(np, "ti,sysc-mask", &val);
1677         if (error)
1678                 return 0;
1679
1680         ddata->cfg.sysc_val = val & ddata->cap->sysc_mask;
1681
1682         return 0;
1683 }
1684
1685 static int sysc_init_idlemode(struct sysc *ddata, u8 *idlemodes,
1686                               const char *name)
1687 {
1688         struct device_node *np = ddata->dev->of_node;
1689         struct property *prop;
1690         const __be32 *p;
1691         u32 val;
1692
1693         of_property_for_each_u32(np, name, prop, p, val) {
1694                 if (val >= SYSC_NR_IDLEMODES) {
1695                         dev_err(ddata->dev, "invalid idlemode: %i\n", val);
1696                         return -EINVAL;
1697                 }
1698                 *idlemodes |=  (1 << val);
1699         }
1700
1701         return 0;
1702 }
1703
1704 static int sysc_init_idlemodes(struct sysc *ddata)
1705 {
1706         int error;
1707
1708         error = sysc_init_idlemode(ddata, &ddata->cfg.midlemodes,
1709                                    "ti,sysc-midle");
1710         if (error)
1711                 return error;
1712
1713         error = sysc_init_idlemode(ddata, &ddata->cfg.sidlemodes,
1714                                    "ti,sysc-sidle");
1715         if (error)
1716                 return error;
1717
1718         return 0;
1719 }
1720
1721 /*
1722  * Only some devices on omap4 and later have SYSCONFIG reset done
1723  * bit. We can detect this if there is no SYSSTATUS at all, or the
1724  * SYSTATUS bit 0 is not used. Note that some SYSSTATUS registers
1725  * have multiple bits for the child devices like OHCI and EHCI.
1726  * Depends on SYSC being parsed first.
1727  */
1728 static int sysc_init_syss_mask(struct sysc *ddata)
1729 {
1730         struct device_node *np = ddata->dev->of_node;
1731         int error;
1732         u32 val;
1733
1734         error = of_property_read_u32(np, "ti,syss-mask", &val);
1735         if (error) {
1736                 if ((ddata->cap->type == TI_SYSC_OMAP4 ||
1737                      ddata->cap->type == TI_SYSC_OMAP4_TIMER) &&
1738                     (ddata->cfg.sysc_val & SYSC_OMAP4_SOFTRESET))
1739                         ddata->cfg.quirks |= SYSC_QUIRK_RESET_STATUS;
1740
1741                 return 0;
1742         }
1743
1744         if (!(val & 1) && (ddata->cfg.sysc_val & SYSC_OMAP4_SOFTRESET))
1745                 ddata->cfg.quirks |= SYSC_QUIRK_RESET_STATUS;
1746
1747         ddata->cfg.syss_mask = val;
1748
1749         return 0;
1750 }
1751
1752 /*
1753  * Many child device drivers need to have fck and opt clocks available
1754  * to get the clock rate for device internal configuration etc.
1755  */
1756 static int sysc_child_add_named_clock(struct sysc *ddata,
1757                                       struct device *child,
1758                                       const char *name)
1759 {
1760         struct clk *clk;
1761         struct clk_lookup *l;
1762         int error = 0;
1763
1764         if (!name)
1765                 return 0;
1766
1767         clk = clk_get(child, name);
1768         if (!IS_ERR(clk)) {
1769                 clk_put(clk);
1770
1771                 return -EEXIST;
1772         }
1773
1774         clk = clk_get(ddata->dev, name);
1775         if (IS_ERR(clk))
1776                 return -ENODEV;
1777
1778         l = clkdev_create(clk, name, dev_name(child));
1779         if (!l)
1780                 error = -ENOMEM;
1781
1782         clk_put(clk);
1783
1784         return error;
1785 }
1786
1787 static int sysc_child_add_clocks(struct sysc *ddata,
1788                                  struct device *child)
1789 {
1790         int i, error;
1791
1792         for (i = 0; i < ddata->nr_clocks; i++) {
1793                 error = sysc_child_add_named_clock(ddata,
1794                                                    child,
1795                                                    ddata->clock_roles[i]);
1796                 if (error && error != -EEXIST) {
1797                         dev_err(ddata->dev, "could not add child clock %s: %i\n",
1798                                 ddata->clock_roles[i], error);
1799
1800                         return error;
1801                 }
1802         }
1803
1804         return 0;
1805 }
1806
1807 static struct device_type sysc_device_type = {
1808 };
1809
1810 static struct sysc *sysc_child_to_parent(struct device *dev)
1811 {
1812         struct device *parent = dev->parent;
1813
1814         if (!parent || parent->type != &sysc_device_type)
1815                 return NULL;
1816
1817         return dev_get_drvdata(parent);
1818 }
1819
1820 static int __maybe_unused sysc_child_runtime_suspend(struct device *dev)
1821 {
1822         struct sysc *ddata;
1823         int error;
1824
1825         ddata = sysc_child_to_parent(dev);
1826
1827         error = pm_generic_runtime_suspend(dev);
1828         if (error)
1829                 return error;
1830
1831         if (!ddata->enabled)
1832                 return 0;
1833
1834         return sysc_runtime_suspend(ddata->dev);
1835 }
1836
1837 static int __maybe_unused sysc_child_runtime_resume(struct device *dev)
1838 {
1839         struct sysc *ddata;
1840         int error;
1841
1842         ddata = sysc_child_to_parent(dev);
1843
1844         if (!ddata->enabled) {
1845                 error = sysc_runtime_resume(ddata->dev);
1846                 if (error < 0)
1847                         dev_err(ddata->dev,
1848                                 "%s error: %i\n", __func__, error);
1849         }
1850
1851         return pm_generic_runtime_resume(dev);
1852 }
1853
1854 #ifdef CONFIG_PM_SLEEP
1855 static int sysc_child_suspend_noirq(struct device *dev)
1856 {
1857         struct sysc *ddata;
1858         int error;
1859
1860         ddata = sysc_child_to_parent(dev);
1861
1862         dev_dbg(ddata->dev, "%s %s\n", __func__,
1863                 ddata->name ? ddata->name : "");
1864
1865         error = pm_generic_suspend_noirq(dev);
1866         if (error) {
1867                 dev_err(dev, "%s error at %i: %i\n",
1868                         __func__, __LINE__, error);
1869
1870                 return error;
1871         }
1872
1873         if (!pm_runtime_status_suspended(dev)) {
1874                 error = pm_generic_runtime_suspend(dev);
1875                 if (error) {
1876                         dev_dbg(dev, "%s busy at %i: %i\n",
1877                                 __func__, __LINE__, error);
1878
1879                         return 0;
1880                 }
1881
1882                 error = sysc_runtime_suspend(ddata->dev);
1883                 if (error) {
1884                         dev_err(dev, "%s error at %i: %i\n",
1885                                 __func__, __LINE__, error);
1886
1887                         return error;
1888                 }
1889
1890                 ddata->child_needs_resume = true;
1891         }
1892
1893         return 0;
1894 }
1895
1896 static int sysc_child_resume_noirq(struct device *dev)
1897 {
1898         struct sysc *ddata;
1899         int error;
1900
1901         ddata = sysc_child_to_parent(dev);
1902
1903         dev_dbg(ddata->dev, "%s %s\n", __func__,
1904                 ddata->name ? ddata->name : "");
1905
1906         if (ddata->child_needs_resume) {
1907                 ddata->child_needs_resume = false;
1908
1909                 error = sysc_runtime_resume(ddata->dev);
1910                 if (error)
1911                         dev_err(ddata->dev,
1912                                 "%s runtime resume error: %i\n",
1913                                 __func__, error);
1914
1915                 error = pm_generic_runtime_resume(dev);
1916                 if (error)
1917                         dev_err(ddata->dev,
1918                                 "%s generic runtime resume: %i\n",
1919                                 __func__, error);
1920         }
1921
1922         return pm_generic_resume_noirq(dev);
1923 }
1924 #endif
1925
1926 static struct dev_pm_domain sysc_child_pm_domain = {
1927         .ops = {
1928                 SET_RUNTIME_PM_OPS(sysc_child_runtime_suspend,
1929                                    sysc_child_runtime_resume,
1930                                    NULL)
1931                 USE_PLATFORM_PM_SLEEP_OPS
1932                 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sysc_child_suspend_noirq,
1933                                               sysc_child_resume_noirq)
1934         }
1935 };
1936
1937 /**
1938  * sysc_legacy_idle_quirk - handle children in omap_device compatible way
1939  * @ddata: device driver data
1940  * @child: child device driver
1941  *
1942  * Allow idle for child devices as done with _od_runtime_suspend().
1943  * Otherwise many child devices will not idle because of the permanent
1944  * parent usecount set in pm_runtime_irq_safe().
1945  *
1946  * Note that the long term solution is to just modify the child device
1947  * drivers to not set pm_runtime_irq_safe() and then this can be just
1948  * dropped.
1949  */
1950 static void sysc_legacy_idle_quirk(struct sysc *ddata, struct device *child)
1951 {
1952         if (ddata->cfg.quirks & SYSC_QUIRK_LEGACY_IDLE)
1953                 dev_pm_domain_set(child, &sysc_child_pm_domain);
1954 }
1955
1956 static int sysc_notifier_call(struct notifier_block *nb,
1957                               unsigned long event, void *device)
1958 {
1959         struct device *dev = device;
1960         struct sysc *ddata;
1961         int error;
1962
1963         ddata = sysc_child_to_parent(dev);
1964         if (!ddata)
1965                 return NOTIFY_DONE;
1966
1967         switch (event) {
1968         case BUS_NOTIFY_ADD_DEVICE:
1969                 error = sysc_child_add_clocks(ddata, dev);
1970                 if (error)
1971                         return error;
1972                 sysc_legacy_idle_quirk(ddata, dev);
1973                 break;
1974         default:
1975                 break;
1976         }
1977
1978         return NOTIFY_DONE;
1979 }
1980
1981 static struct notifier_block sysc_nb = {
1982         .notifier_call = sysc_notifier_call,
1983 };
1984
1985 /* Device tree configured quirks */
1986 struct sysc_dts_quirk {
1987         const char *name;
1988         u32 mask;
1989 };
1990
1991 static const struct sysc_dts_quirk sysc_dts_quirks[] = {
1992         { .name = "ti,no-idle-on-init",
1993           .mask = SYSC_QUIRK_NO_IDLE_ON_INIT, },
1994         { .name = "ti,no-reset-on-init",
1995           .mask = SYSC_QUIRK_NO_RESET_ON_INIT, },
1996         { .name = "ti,no-idle",
1997           .mask = SYSC_QUIRK_NO_IDLE, },
1998 };
1999
2000 static void sysc_parse_dts_quirks(struct sysc *ddata, struct device_node *np,
2001                                   bool is_child)
2002 {
2003         const struct property *prop;
2004         int i, len;
2005
2006         for (i = 0; i < ARRAY_SIZE(sysc_dts_quirks); i++) {
2007                 const char *name = sysc_dts_quirks[i].name;
2008
2009                 prop = of_get_property(np, name, &len);
2010                 if (!prop)
2011                         continue;
2012
2013                 ddata->cfg.quirks |= sysc_dts_quirks[i].mask;
2014                 if (is_child) {
2015                         dev_warn(ddata->dev,
2016                                  "dts flag should be at module level for %s\n",
2017                                  name);
2018                 }
2019         }
2020 }
2021
2022 static int sysc_init_dts_quirks(struct sysc *ddata)
2023 {
2024         struct device_node *np = ddata->dev->of_node;
2025         int error;
2026         u32 val;
2027
2028         ddata->legacy_mode = of_get_property(np, "ti,hwmods", NULL);
2029
2030         sysc_parse_dts_quirks(ddata, np, false);
2031         error = of_property_read_u32(np, "ti,sysc-delay-us", &val);
2032         if (!error) {
2033                 if (val > 255) {
2034                         dev_warn(ddata->dev, "bad ti,sysc-delay-us: %i\n",
2035                                  val);
2036                 }
2037
2038                 ddata->cfg.srst_udelay = (u8)val;
2039         }
2040
2041         return 0;
2042 }
2043
2044 static void sysc_unprepare(struct sysc *ddata)
2045 {
2046         int i;
2047
2048         if (!ddata->clocks)
2049                 return;
2050
2051         for (i = 0; i < SYSC_MAX_CLOCKS; i++) {
2052                 if (!IS_ERR_OR_NULL(ddata->clocks[i]))
2053                         clk_unprepare(ddata->clocks[i]);
2054         }
2055 }
2056
2057 /*
2058  * Common sysc register bits found on omap2, also known as type1
2059  */
2060 static const struct sysc_regbits sysc_regbits_omap2 = {
2061         .dmadisable_shift = -ENODEV,
2062         .midle_shift = 12,
2063         .sidle_shift = 3,
2064         .clkact_shift = 8,
2065         .emufree_shift = 5,
2066         .enwkup_shift = 2,
2067         .srst_shift = 1,
2068         .autoidle_shift = 0,
2069 };
2070
2071 static const struct sysc_capabilities sysc_omap2 = {
2072         .type = TI_SYSC_OMAP2,
2073         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY | SYSC_OMAP2_EMUFREE |
2074                      SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_SOFTRESET |
2075                      SYSC_OMAP2_AUTOIDLE,
2076         .regbits = &sysc_regbits_omap2,
2077 };
2078
2079 /* All omap2 and 3 timers, and timers 1, 2 & 10 on omap 4 and 5 */
2080 static const struct sysc_capabilities sysc_omap2_timer = {
2081         .type = TI_SYSC_OMAP2_TIMER,
2082         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY | SYSC_OMAP2_EMUFREE |
2083                      SYSC_OMAP2_ENAWAKEUP | SYSC_OMAP2_SOFTRESET |
2084                      SYSC_OMAP2_AUTOIDLE,
2085         .regbits = &sysc_regbits_omap2,
2086         .mod_quirks = SYSC_QUIRK_USE_CLOCKACT,
2087 };
2088
2089 /*
2090  * SHAM2 (SHA1/MD5) sysc found on omap3, a variant of sysc_regbits_omap2
2091  * with different sidle position
2092  */
2093 static const struct sysc_regbits sysc_regbits_omap3_sham = {
2094         .dmadisable_shift = -ENODEV,
2095         .midle_shift = -ENODEV,
2096         .sidle_shift = 4,
2097         .clkact_shift = -ENODEV,
2098         .enwkup_shift = -ENODEV,
2099         .srst_shift = 1,
2100         .autoidle_shift = 0,
2101         .emufree_shift = -ENODEV,
2102 };
2103
2104 static const struct sysc_capabilities sysc_omap3_sham = {
2105         .type = TI_SYSC_OMAP3_SHAM,
2106         .sysc_mask = SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE,
2107         .regbits = &sysc_regbits_omap3_sham,
2108 };
2109
2110 /*
2111  * AES register bits found on omap3 and later, a variant of
2112  * sysc_regbits_omap2 with different sidle position
2113  */
2114 static const struct sysc_regbits sysc_regbits_omap3_aes = {
2115         .dmadisable_shift = -ENODEV,
2116         .midle_shift = -ENODEV,
2117         .sidle_shift = 6,
2118         .clkact_shift = -ENODEV,
2119         .enwkup_shift = -ENODEV,
2120         .srst_shift = 1,
2121         .autoidle_shift = 0,
2122         .emufree_shift = -ENODEV,
2123 };
2124
2125 static const struct sysc_capabilities sysc_omap3_aes = {
2126         .type = TI_SYSC_OMAP3_AES,
2127         .sysc_mask = SYSC_OMAP2_SOFTRESET | SYSC_OMAP2_AUTOIDLE,
2128         .regbits = &sysc_regbits_omap3_aes,
2129 };
2130
2131 /*
2132  * Common sysc register bits found on omap4, also known as type2
2133  */
2134 static const struct sysc_regbits sysc_regbits_omap4 = {
2135         .dmadisable_shift = 16,
2136         .midle_shift = 4,
2137         .sidle_shift = 2,
2138         .clkact_shift = -ENODEV,
2139         .enwkup_shift = -ENODEV,
2140         .emufree_shift = 1,
2141         .srst_shift = 0,
2142         .autoidle_shift = -ENODEV,
2143 };
2144
2145 static const struct sysc_capabilities sysc_omap4 = {
2146         .type = TI_SYSC_OMAP4,
2147         .sysc_mask = SYSC_OMAP4_DMADISABLE | SYSC_OMAP4_FREEEMU |
2148                      SYSC_OMAP4_SOFTRESET,
2149         .regbits = &sysc_regbits_omap4,
2150 };
2151
2152 static const struct sysc_capabilities sysc_omap4_timer = {
2153         .type = TI_SYSC_OMAP4_TIMER,
2154         .sysc_mask = SYSC_OMAP4_DMADISABLE | SYSC_OMAP4_FREEEMU |
2155                      SYSC_OMAP4_SOFTRESET,
2156         .regbits = &sysc_regbits_omap4,
2157 };
2158
2159 /*
2160  * Common sysc register bits found on omap4, also known as type3
2161  */
2162 static const struct sysc_regbits sysc_regbits_omap4_simple = {
2163         .dmadisable_shift = -ENODEV,
2164         .midle_shift = 2,
2165         .sidle_shift = 0,
2166         .clkact_shift = -ENODEV,
2167         .enwkup_shift = -ENODEV,
2168         .srst_shift = -ENODEV,
2169         .emufree_shift = -ENODEV,
2170         .autoidle_shift = -ENODEV,
2171 };
2172
2173 static const struct sysc_capabilities sysc_omap4_simple = {
2174         .type = TI_SYSC_OMAP4_SIMPLE,
2175         .regbits = &sysc_regbits_omap4_simple,
2176 };
2177
2178 /*
2179  * SmartReflex sysc found on omap34xx
2180  */
2181 static const struct sysc_regbits sysc_regbits_omap34xx_sr = {
2182         .dmadisable_shift = -ENODEV,
2183         .midle_shift = -ENODEV,
2184         .sidle_shift = -ENODEV,
2185         .clkact_shift = 20,
2186         .enwkup_shift = -ENODEV,
2187         .srst_shift = -ENODEV,
2188         .emufree_shift = -ENODEV,
2189         .autoidle_shift = -ENODEV,
2190 };
2191
2192 static const struct sysc_capabilities sysc_34xx_sr = {
2193         .type = TI_SYSC_OMAP34XX_SR,
2194         .sysc_mask = SYSC_OMAP2_CLOCKACTIVITY,
2195         .regbits = &sysc_regbits_omap34xx_sr,
2196         .mod_quirks = SYSC_QUIRK_USE_CLOCKACT | SYSC_QUIRK_UNCACHED |
2197                       SYSC_QUIRK_LEGACY_IDLE,
2198 };
2199
2200 /*
2201  * SmartReflex sysc found on omap36xx and later
2202  */
2203 static const struct sysc_regbits sysc_regbits_omap36xx_sr = {
2204         .dmadisable_shift = -ENODEV,
2205         .midle_shift = -ENODEV,
2206         .sidle_shift = 24,
2207         .clkact_shift = -ENODEV,
2208         .enwkup_shift = 26,
2209         .srst_shift = -ENODEV,
2210         .emufree_shift = -ENODEV,
2211         .autoidle_shift = -ENODEV,
2212 };
2213
2214 static const struct sysc_capabilities sysc_36xx_sr = {
2215         .type = TI_SYSC_OMAP36XX_SR,
2216         .sysc_mask = SYSC_OMAP3_SR_ENAWAKEUP,
2217         .regbits = &sysc_regbits_omap36xx_sr,
2218         .mod_quirks = SYSC_QUIRK_UNCACHED | SYSC_QUIRK_LEGACY_IDLE,
2219 };
2220
2221 static const struct sysc_capabilities sysc_omap4_sr = {
2222         .type = TI_SYSC_OMAP4_SR,
2223         .regbits = &sysc_regbits_omap36xx_sr,
2224         .mod_quirks = SYSC_QUIRK_LEGACY_IDLE,
2225 };
2226
2227 /*
2228  * McASP register bits found on omap4 and later
2229  */
2230 static const struct sysc_regbits sysc_regbits_omap4_mcasp = {
2231         .dmadisable_shift = -ENODEV,
2232         .midle_shift = -ENODEV,
2233         .sidle_shift = 0,
2234         .clkact_shift = -ENODEV,
2235         .enwkup_shift = -ENODEV,
2236         .srst_shift = -ENODEV,
2237         .emufree_shift = -ENODEV,
2238         .autoidle_shift = -ENODEV,
2239 };
2240
2241 static const struct sysc_capabilities sysc_omap4_mcasp = {
2242         .type = TI_SYSC_OMAP4_MCASP,
2243         .regbits = &sysc_regbits_omap4_mcasp,
2244         .mod_quirks = SYSC_QUIRK_OPT_CLKS_NEEDED,
2245 };
2246
2247 /*
2248  * McASP found on dra7 and later
2249  */
2250 static const struct sysc_capabilities sysc_dra7_mcasp = {
2251         .type = TI_SYSC_OMAP4_SIMPLE,
2252         .regbits = &sysc_regbits_omap4_simple,
2253         .mod_quirks = SYSC_QUIRK_OPT_CLKS_NEEDED,
2254 };
2255
2256 /*
2257  * FS USB host found on omap4 and later
2258  */
2259 static const struct sysc_regbits sysc_regbits_omap4_usb_host_fs = {
2260         .dmadisable_shift = -ENODEV,
2261         .midle_shift = -ENODEV,
2262         .sidle_shift = 24,
2263         .clkact_shift = -ENODEV,
2264         .enwkup_shift = 26,
2265         .srst_shift = -ENODEV,
2266         .emufree_shift = -ENODEV,
2267         .autoidle_shift = -ENODEV,
2268 };
2269
2270 static const struct sysc_capabilities sysc_omap4_usb_host_fs = {
2271         .type = TI_SYSC_OMAP4_USB_HOST_FS,
2272         .sysc_mask = SYSC_OMAP2_ENAWAKEUP,
2273         .regbits = &sysc_regbits_omap4_usb_host_fs,
2274 };
2275
2276 static const struct sysc_regbits sysc_regbits_dra7_mcan = {
2277         .dmadisable_shift = -ENODEV,
2278         .midle_shift = -ENODEV,
2279         .sidle_shift = -ENODEV,
2280         .clkact_shift = -ENODEV,
2281         .enwkup_shift = 4,
2282         .srst_shift = 0,
2283         .emufree_shift = -ENODEV,
2284         .autoidle_shift = -ENODEV,
2285 };
2286
2287 static const struct sysc_capabilities sysc_dra7_mcan = {
2288         .type = TI_SYSC_DRA7_MCAN,
2289         .sysc_mask = SYSC_DRA7_MCAN_ENAWAKEUP | SYSC_OMAP4_SOFTRESET,
2290         .regbits = &sysc_regbits_dra7_mcan,
2291         .mod_quirks = SYSS_QUIRK_RESETDONE_INVERTED,
2292 };
2293
2294 static int sysc_init_pdata(struct sysc *ddata)
2295 {
2296         struct ti_sysc_platform_data *pdata = dev_get_platdata(ddata->dev);
2297         struct ti_sysc_module_data *mdata;
2298
2299         if (!pdata)
2300                 return 0;
2301
2302         mdata = devm_kzalloc(ddata->dev, sizeof(*mdata), GFP_KERNEL);
2303         if (!mdata)
2304                 return -ENOMEM;
2305
2306         if (ddata->legacy_mode) {
2307                 mdata->name = ddata->legacy_mode;
2308                 mdata->module_pa = ddata->module_pa;
2309                 mdata->module_size = ddata->module_size;
2310                 mdata->offsets = ddata->offsets;
2311                 mdata->nr_offsets = SYSC_MAX_REGS;
2312                 mdata->cap = ddata->cap;
2313                 mdata->cfg = &ddata->cfg;
2314         }
2315
2316         ddata->mdata = mdata;
2317
2318         return 0;
2319 }
2320
2321 static int sysc_init_match(struct sysc *ddata)
2322 {
2323         const struct sysc_capabilities *cap;
2324
2325         cap = of_device_get_match_data(ddata->dev);
2326         if (!cap)
2327                 return -EINVAL;
2328
2329         ddata->cap = cap;
2330         if (ddata->cap)
2331                 ddata->cfg.quirks |= ddata->cap->mod_quirks;
2332
2333         return 0;
2334 }
2335
2336 static void ti_sysc_idle(struct work_struct *work)
2337 {
2338         struct sysc *ddata;
2339
2340         ddata = container_of(work, struct sysc, idle_work.work);
2341
2342         /*
2343          * One time decrement of clock usage counts if left on from init.
2344          * Note that we disable opt clocks unconditionally in this case
2345          * as they are enabled unconditionally during init without
2346          * considering sysc_opt_clks_needed() at that point.
2347          */
2348         if (ddata->cfg.quirks & (SYSC_QUIRK_NO_IDLE |
2349                                  SYSC_QUIRK_NO_IDLE_ON_INIT)) {
2350                 sysc_disable_main_clocks(ddata);
2351                 sysc_disable_opt_clocks(ddata);
2352                 sysc_clkdm_allow_idle(ddata);
2353         }
2354
2355         /* Keep permanent PM runtime usage count for SYSC_QUIRK_NO_IDLE */
2356         if (ddata->cfg.quirks & SYSC_QUIRK_NO_IDLE)
2357                 return;
2358
2359         /*
2360          * Decrement PM runtime usage count for SYSC_QUIRK_NO_IDLE_ON_INIT
2361          * and SYSC_QUIRK_NO_RESET_ON_INIT
2362          */
2363         if (pm_runtime_active(ddata->dev))
2364                 pm_runtime_put_sync(ddata->dev);
2365 }
2366
2367 static const struct of_device_id sysc_match_table[] = {
2368         { .compatible = "simple-bus", },
2369         { /* sentinel */ },
2370 };
2371
2372 static int sysc_probe(struct platform_device *pdev)
2373 {
2374         struct ti_sysc_platform_data *pdata = dev_get_platdata(&pdev->dev);
2375         struct sysc *ddata;
2376         int error;
2377
2378         ddata = devm_kzalloc(&pdev->dev, sizeof(*ddata), GFP_KERNEL);
2379         if (!ddata)
2380                 return -ENOMEM;
2381
2382         ddata->dev = &pdev->dev;
2383         platform_set_drvdata(pdev, ddata);
2384
2385         error = sysc_init_match(ddata);
2386         if (error)
2387                 return error;
2388
2389         error = sysc_init_dts_quirks(ddata);
2390         if (error)
2391                 return error;
2392
2393         error = sysc_map_and_check_registers(ddata);
2394         if (error)
2395                 return error;
2396
2397         error = sysc_init_sysc_mask(ddata);
2398         if (error)
2399                 return error;
2400
2401         error = sysc_init_idlemodes(ddata);
2402         if (error)
2403                 return error;
2404
2405         error = sysc_init_syss_mask(ddata);
2406         if (error)
2407                 return error;
2408
2409         error = sysc_init_pdata(ddata);
2410         if (error)
2411                 return error;
2412
2413         sysc_init_early_quirks(ddata);
2414
2415         error = sysc_get_clocks(ddata);
2416         if (error)
2417                 return error;
2418
2419         error = sysc_init_resets(ddata);
2420         if (error)
2421                 goto unprepare;
2422
2423         error = sysc_init_module(ddata);
2424         if (error)
2425                 goto unprepare;
2426
2427         pm_runtime_enable(ddata->dev);
2428         error = pm_runtime_get_sync(ddata->dev);
2429         if (error < 0) {
2430                 pm_runtime_put_noidle(ddata->dev);
2431                 pm_runtime_disable(ddata->dev);
2432                 goto unprepare;
2433         }
2434
2435         /* Balance use counts as PM runtime should have enabled these all */
2436         if (!(ddata->cfg.quirks & SYSC_QUIRK_NO_RESET_ON_INIT))
2437                 reset_control_assert(ddata->rsts);
2438
2439         if (!(ddata->cfg.quirks &
2440               (SYSC_QUIRK_NO_IDLE | SYSC_QUIRK_NO_IDLE_ON_INIT))) {
2441                 sysc_disable_main_clocks(ddata);
2442                 sysc_disable_opt_clocks(ddata);
2443                 sysc_clkdm_allow_idle(ddata);
2444         }
2445
2446         sysc_show_registers(ddata);
2447
2448         ddata->dev->type = &sysc_device_type;
2449         error = of_platform_populate(ddata->dev->of_node, sysc_match_table,
2450                                      pdata ? pdata->auxdata : NULL,
2451                                      ddata->dev);
2452         if (error)
2453                 goto err;
2454
2455         INIT_DELAYED_WORK(&ddata->idle_work, ti_sysc_idle);
2456
2457         /* At least earlycon won't survive without deferred idle */
2458         if (ddata->cfg.quirks & (SYSC_QUIRK_NO_IDLE |
2459                                  SYSC_QUIRK_NO_IDLE_ON_INIT |
2460                                  SYSC_QUIRK_NO_RESET_ON_INIT)) {
2461                 schedule_delayed_work(&ddata->idle_work, 3000);
2462         } else {
2463                 pm_runtime_put(&pdev->dev);
2464         }
2465
2466         return 0;
2467
2468 err:
2469         pm_runtime_put_sync(&pdev->dev);
2470         pm_runtime_disable(&pdev->dev);
2471 unprepare:
2472         sysc_unprepare(ddata);
2473
2474         return error;
2475 }
2476
2477 static int sysc_remove(struct platform_device *pdev)
2478 {
2479         struct sysc *ddata = platform_get_drvdata(pdev);
2480         int error;
2481
2482         cancel_delayed_work_sync(&ddata->idle_work);
2483
2484         error = pm_runtime_get_sync(ddata->dev);
2485         if (error < 0) {
2486                 pm_runtime_put_noidle(ddata->dev);
2487                 pm_runtime_disable(ddata->dev);
2488                 goto unprepare;
2489         }
2490
2491         of_platform_depopulate(&pdev->dev);
2492
2493         pm_runtime_put_sync(&pdev->dev);
2494         pm_runtime_disable(&pdev->dev);
2495         reset_control_assert(ddata->rsts);
2496
2497 unprepare:
2498         sysc_unprepare(ddata);
2499
2500         return 0;
2501 }
2502
2503 static const struct of_device_id sysc_match[] = {
2504         { .compatible = "ti,sysc-omap2", .data = &sysc_omap2, },
2505         { .compatible = "ti,sysc-omap2-timer", .data = &sysc_omap2_timer, },
2506         { .compatible = "ti,sysc-omap4", .data = &sysc_omap4, },
2507         { .compatible = "ti,sysc-omap4-timer", .data = &sysc_omap4_timer, },
2508         { .compatible = "ti,sysc-omap4-simple", .data = &sysc_omap4_simple, },
2509         { .compatible = "ti,sysc-omap3430-sr", .data = &sysc_34xx_sr, },
2510         { .compatible = "ti,sysc-omap3630-sr", .data = &sysc_36xx_sr, },
2511         { .compatible = "ti,sysc-omap4-sr", .data = &sysc_omap4_sr, },
2512         { .compatible = "ti,sysc-omap3-sham", .data = &sysc_omap3_sham, },
2513         { .compatible = "ti,sysc-omap-aes", .data = &sysc_omap3_aes, },
2514         { .compatible = "ti,sysc-mcasp", .data = &sysc_omap4_mcasp, },
2515         { .compatible = "ti,sysc-dra7-mcasp", .data = &sysc_dra7_mcasp, },
2516         { .compatible = "ti,sysc-usb-host-fs",
2517           .data = &sysc_omap4_usb_host_fs, },
2518         { .compatible = "ti,sysc-dra7-mcan", .data = &sysc_dra7_mcan, },
2519         {  },
2520 };
2521 MODULE_DEVICE_TABLE(of, sysc_match);
2522
2523 static struct platform_driver sysc_driver = {
2524         .probe          = sysc_probe,
2525         .remove         = sysc_remove,
2526         .driver         = {
2527                 .name   = "ti-sysc",
2528                 .of_match_table = sysc_match,
2529                 .pm = &sysc_pm_ops,
2530         },
2531 };
2532
2533 static int __init sysc_init(void)
2534 {
2535         bus_register_notifier(&platform_bus_type, &sysc_nb);
2536
2537         return platform_driver_register(&sysc_driver);
2538 }
2539 module_init(sysc_init);
2540
2541 static void __exit sysc_exit(void)
2542 {
2543         bus_unregister_notifier(&platform_bus_type, &sysc_nb);
2544         platform_driver_unregister(&sysc_driver);
2545 }
2546 module_exit(sysc_exit);
2547
2548 MODULE_DESCRIPTION("TI sysc interconnect target driver");
2549 MODULE_LICENSE("GPL v2");