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