18bb67d87SWolfram Sang // SPDX-License-Identifier: GPL-2.0
28bb67d87SWolfram Sang /*
38bb67d87SWolfram Sang * R-Car Gen3 Clock Pulse Generator Library
48bb67d87SWolfram Sang *
58bb67d87SWolfram Sang * Copyright (C) 2015-2018 Glider bvba
68bb67d87SWolfram Sang * Copyright (C) 2019 Renesas Electronics Corp.
78bb67d87SWolfram Sang *
88bb67d87SWolfram Sang * Based on clk-rcar-gen3.c
98bb67d87SWolfram Sang *
108bb67d87SWolfram Sang * Copyright (C) 2015 Renesas Electronics Corp.
118bb67d87SWolfram Sang */
128bb67d87SWolfram Sang
138bb67d87SWolfram Sang #include <linux/clk.h>
148bb67d87SWolfram Sang #include <linux/clk-provider.h>
158bb67d87SWolfram Sang #include <linux/device.h>
168bb67d87SWolfram Sang #include <linux/err.h>
178bb67d87SWolfram Sang #include <linux/init.h>
188bb67d87SWolfram Sang #include <linux/io.h>
198bb67d87SWolfram Sang #include <linux/pm.h>
208bb67d87SWolfram Sang #include <linux/slab.h>
218bb67d87SWolfram Sang #include <linux/sys_soc.h>
228bb67d87SWolfram Sang
238bb67d87SWolfram Sang #include "rcar-cpg-lib.h"
248bb67d87SWolfram Sang
25*3b2f834dSGeert Uytterhoeven DEFINE_SPINLOCK(cpg_lock);
268bb67d87SWolfram Sang
cpg_reg_modify(void __iomem * reg,u32 clear,u32 set)278bb67d87SWolfram Sang void cpg_reg_modify(void __iomem *reg, u32 clear, u32 set)
288bb67d87SWolfram Sang {
298bb67d87SWolfram Sang unsigned long flags;
308bb67d87SWolfram Sang u32 val;
318bb67d87SWolfram Sang
328bb67d87SWolfram Sang spin_lock_irqsave(&cpg_lock, flags);
338bb67d87SWolfram Sang val = readl(reg);
348bb67d87SWolfram Sang val &= ~clear;
358bb67d87SWolfram Sang val |= set;
368bb67d87SWolfram Sang writel(val, reg);
378bb67d87SWolfram Sang spin_unlock_irqrestore(&cpg_lock, flags);
388bb67d87SWolfram Sang };
398bb67d87SWolfram Sang
cpg_simple_notifier_call(struct notifier_block * nb,unsigned long action,void * data)408bb67d87SWolfram Sang static int cpg_simple_notifier_call(struct notifier_block *nb,
418bb67d87SWolfram Sang unsigned long action, void *data)
428bb67d87SWolfram Sang {
438bb67d87SWolfram Sang struct cpg_simple_notifier *csn =
448bb67d87SWolfram Sang container_of(nb, struct cpg_simple_notifier, nb);
458bb67d87SWolfram Sang
468bb67d87SWolfram Sang switch (action) {
478bb67d87SWolfram Sang case PM_EVENT_SUSPEND:
488bb67d87SWolfram Sang csn->saved = readl(csn->reg);
498bb67d87SWolfram Sang return NOTIFY_OK;
508bb67d87SWolfram Sang
518bb67d87SWolfram Sang case PM_EVENT_RESUME:
528bb67d87SWolfram Sang writel(csn->saved, csn->reg);
538bb67d87SWolfram Sang return NOTIFY_OK;
548bb67d87SWolfram Sang }
558bb67d87SWolfram Sang return NOTIFY_DONE;
568bb67d87SWolfram Sang }
578bb67d87SWolfram Sang
cpg_simple_notifier_register(struct raw_notifier_head * notifiers,struct cpg_simple_notifier * csn)588bb67d87SWolfram Sang void cpg_simple_notifier_register(struct raw_notifier_head *notifiers,
598bb67d87SWolfram Sang struct cpg_simple_notifier *csn)
608bb67d87SWolfram Sang {
618bb67d87SWolfram Sang csn->nb.notifier_call = cpg_simple_notifier_call;
628bb67d87SWolfram Sang raw_notifier_chain_register(notifiers, &csn->nb);
638bb67d87SWolfram Sang }
648bb67d87SWolfram Sang
658bb67d87SWolfram Sang /*
668bb67d87SWolfram Sang * SDn Clock
678bb67d87SWolfram Sang */
68a31cf51bSWolfram Sang
69bb6d3fa9SWolfram Sang #define SDnSRCFC_SHIFT 2
70bb6d3fa9SWolfram Sang #define STPnHCK BIT(9 - SDnSRCFC_SHIFT)
71bb6d3fa9SWolfram Sang
72bb6d3fa9SWolfram Sang static const struct clk_div_table cpg_sdh_div_table[] = {
73d5252d96SDirk Behme /*
74d5252d96SDirk Behme * These values are recommended by the datasheet. Because they come
75d5252d96SDirk Behme * first, Linux will only use these.
76d5252d96SDirk Behme */
77bb6d3fa9SWolfram Sang { 0, 1 }, { 1, 2 }, { STPnHCK | 2, 4 }, { STPnHCK | 3, 8 },
78d5252d96SDirk Behme { STPnHCK | 4, 16 },
79d5252d96SDirk Behme /*
80d5252d96SDirk Behme * These values are not recommended because STPnHCK is wrong. But they
81d5252d96SDirk Behme * have been seen because of broken firmware. So, we support reading
82d5252d96SDirk Behme * them but Linux will sanitize them when initializing through
83d5252d96SDirk Behme * recalc_rate.
84d5252d96SDirk Behme */
85d5252d96SDirk Behme { STPnHCK | 0, 1 }, { STPnHCK | 1, 2 }, { 2, 4 }, { 3, 8 }, { 4, 16 },
86d5252d96SDirk Behme /* Sentinel */
87d5252d96SDirk Behme { 0, 0 }
88bb6d3fa9SWolfram Sang };
89bb6d3fa9SWolfram Sang
cpg_sdh_clk_register(const char * name,void __iomem * sdnckcr,const char * parent_name,struct raw_notifier_head * notifiers)90a31cf51bSWolfram Sang struct clk * __init cpg_sdh_clk_register(const char *name,
91a31cf51bSWolfram Sang void __iomem *sdnckcr, const char *parent_name,
92a31cf51bSWolfram Sang struct raw_notifier_head *notifiers)
93a31cf51bSWolfram Sang {
94bb6d3fa9SWolfram Sang struct cpg_simple_notifier *csn;
95bb6d3fa9SWolfram Sang struct clk *clk;
96bb6d3fa9SWolfram Sang
97bb6d3fa9SWolfram Sang csn = kzalloc(sizeof(*csn), GFP_KERNEL);
98bb6d3fa9SWolfram Sang if (!csn)
99bb6d3fa9SWolfram Sang return ERR_PTR(-ENOMEM);
100bb6d3fa9SWolfram Sang
101bb6d3fa9SWolfram Sang csn->reg = sdnckcr;
102bb6d3fa9SWolfram Sang
103bb6d3fa9SWolfram Sang clk = clk_register_divider_table(NULL, name, parent_name, 0, sdnckcr,
104bb6d3fa9SWolfram Sang SDnSRCFC_SHIFT, 8, 0, cpg_sdh_div_table,
105bb6d3fa9SWolfram Sang &cpg_lock);
106bb6d3fa9SWolfram Sang if (IS_ERR(clk)) {
107bb6d3fa9SWolfram Sang kfree(csn);
108bb6d3fa9SWolfram Sang return clk;
109a31cf51bSWolfram Sang }
110a31cf51bSWolfram Sang
111bb6d3fa9SWolfram Sang cpg_simple_notifier_register(notifiers, csn);
112bb6d3fa9SWolfram Sang return clk;
1138bb67d87SWolfram Sang }
1148bb67d87SWolfram Sang
115bb6d3fa9SWolfram Sang static const struct clk_div_table cpg_sd_div_table[] = {
116bb6d3fa9SWolfram Sang { 0, 2 }, { 1, 4 }, { 0, 0 },
1178bb67d87SWolfram Sang };
1188bb67d87SWolfram Sang
cpg_sd_clk_register(const char * name,void __iomem * sdnckcr,const char * parent_name)1198bb67d87SWolfram Sang struct clk * __init cpg_sd_clk_register(const char *name,
120bb6d3fa9SWolfram Sang void __iomem *sdnckcr, const char *parent_name)
1218bb67d87SWolfram Sang {
122bb6d3fa9SWolfram Sang return clk_register_divider_table(NULL, name, parent_name, 0, sdnckcr,
123bb6d3fa9SWolfram Sang 0, 2, 0, cpg_sd_div_table, &cpg_lock);
1248bb67d87SWolfram Sang }
1258bb67d87SWolfram Sang
1266f21d145SWolfram Sang struct rpc_clock {
1276f21d145SWolfram Sang struct clk_divider div;
1286f21d145SWolfram Sang struct clk_gate gate;
1296f21d145SWolfram Sang /*
1306f21d145SWolfram Sang * One notifier covers both RPC and RPCD2 clocks as they are both
1316f21d145SWolfram Sang * controlled by the same RPCCKCR register...
1326f21d145SWolfram Sang */
1336f21d145SWolfram Sang struct cpg_simple_notifier csn;
1346f21d145SWolfram Sang };
1356f21d145SWolfram Sang
1366f21d145SWolfram Sang static const struct clk_div_table cpg_rpc_div_table[] = {
1376f21d145SWolfram Sang { 1, 2 }, { 3, 4 }, { 5, 6 }, { 7, 8 }, { 0, 0 },
1386f21d145SWolfram Sang };
1396f21d145SWolfram Sang
cpg_rpc_clk_register(const char * name,void __iomem * rpcckcr,const char * parent_name,struct raw_notifier_head * notifiers)1406f21d145SWolfram Sang struct clk * __init cpg_rpc_clk_register(const char *name,
1416f21d145SWolfram Sang void __iomem *rpcckcr, const char *parent_name,
1426f21d145SWolfram Sang struct raw_notifier_head *notifiers)
1436f21d145SWolfram Sang {
1446f21d145SWolfram Sang struct rpc_clock *rpc;
1456f21d145SWolfram Sang struct clk *clk;
1466f21d145SWolfram Sang
1476f21d145SWolfram Sang rpc = kzalloc(sizeof(*rpc), GFP_KERNEL);
1486f21d145SWolfram Sang if (!rpc)
1496f21d145SWolfram Sang return ERR_PTR(-ENOMEM);
1506f21d145SWolfram Sang
1516f21d145SWolfram Sang rpc->div.reg = rpcckcr;
1526f21d145SWolfram Sang rpc->div.width = 3;
1536f21d145SWolfram Sang rpc->div.table = cpg_rpc_div_table;
1546f21d145SWolfram Sang rpc->div.lock = &cpg_lock;
1556f21d145SWolfram Sang
1566f21d145SWolfram Sang rpc->gate.reg = rpcckcr;
1576f21d145SWolfram Sang rpc->gate.bit_idx = 8;
1586f21d145SWolfram Sang rpc->gate.flags = CLK_GATE_SET_TO_DISABLE;
1596f21d145SWolfram Sang rpc->gate.lock = &cpg_lock;
1606f21d145SWolfram Sang
1616f21d145SWolfram Sang rpc->csn.reg = rpcckcr;
1626f21d145SWolfram Sang
1636f21d145SWolfram Sang clk = clk_register_composite(NULL, name, &parent_name, 1, NULL, NULL,
1646f21d145SWolfram Sang &rpc->div.hw, &clk_divider_ops,
1656f21d145SWolfram Sang &rpc->gate.hw, &clk_gate_ops,
1666f21d145SWolfram Sang CLK_SET_RATE_PARENT);
1676f21d145SWolfram Sang if (IS_ERR(clk)) {
1686f21d145SWolfram Sang kfree(rpc);
1696f21d145SWolfram Sang return clk;
1706f21d145SWolfram Sang }
1716f21d145SWolfram Sang
1726f21d145SWolfram Sang cpg_simple_notifier_register(notifiers, &rpc->csn);
1736f21d145SWolfram Sang return clk;
1746f21d145SWolfram Sang }
1756f21d145SWolfram Sang
1766f21d145SWolfram Sang struct rpcd2_clock {
1776f21d145SWolfram Sang struct clk_fixed_factor fixed;
1786f21d145SWolfram Sang struct clk_gate gate;
1796f21d145SWolfram Sang };
1806f21d145SWolfram Sang
cpg_rpcd2_clk_register(const char * name,void __iomem * rpcckcr,const char * parent_name)1816f21d145SWolfram Sang struct clk * __init cpg_rpcd2_clk_register(const char *name,
1826f21d145SWolfram Sang void __iomem *rpcckcr,
1836f21d145SWolfram Sang const char *parent_name)
1846f21d145SWolfram Sang {
1856f21d145SWolfram Sang struct rpcd2_clock *rpcd2;
1866f21d145SWolfram Sang struct clk *clk;
1876f21d145SWolfram Sang
1886f21d145SWolfram Sang rpcd2 = kzalloc(sizeof(*rpcd2), GFP_KERNEL);
1896f21d145SWolfram Sang if (!rpcd2)
1906f21d145SWolfram Sang return ERR_PTR(-ENOMEM);
1916f21d145SWolfram Sang
1926f21d145SWolfram Sang rpcd2->fixed.mult = 1;
1936f21d145SWolfram Sang rpcd2->fixed.div = 2;
1946f21d145SWolfram Sang
1956f21d145SWolfram Sang rpcd2->gate.reg = rpcckcr;
1966f21d145SWolfram Sang rpcd2->gate.bit_idx = 9;
1976f21d145SWolfram Sang rpcd2->gate.flags = CLK_GATE_SET_TO_DISABLE;
1986f21d145SWolfram Sang rpcd2->gate.lock = &cpg_lock;
1996f21d145SWolfram Sang
2006f21d145SWolfram Sang clk = clk_register_composite(NULL, name, &parent_name, 1, NULL, NULL,
2016f21d145SWolfram Sang &rpcd2->fixed.hw, &clk_fixed_factor_ops,
2026f21d145SWolfram Sang &rpcd2->gate.hw, &clk_gate_ops,
2036f21d145SWolfram Sang CLK_SET_RATE_PARENT);
2046f21d145SWolfram Sang if (IS_ERR(clk))
2056f21d145SWolfram Sang kfree(rpcd2);
2066f21d145SWolfram Sang
2076f21d145SWolfram Sang return clk;
2086f21d145SWolfram Sang }
2098bb67d87SWolfram Sang
210