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