2 * Copyright (c) 2014 MundoReader S.L.
3 * Author: Heiko Stuebner <heiko@sntech.de>
5 * Copyright (c) 2015 Rockchip Electronics Co. Ltd.
6 * Author: Xing Zheng <zhengxing@rock-chips.com>
11 * Copyright (c) 2013 Samsung Electronics Co., Ltd.
12 * Copyright (c) 2013 Linaro Ltd.
13 * Author: Thomas Abraham <thomas.ab@samsung.com>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
26 #ifndef CLK_ROCKCHIP_CLK_H
27 #define CLK_ROCKCHIP_CLK_H
30 #include <linux/clk-provider.h>
34 #define HIWORD_UPDATE(val, mask, shift) \
35 ((val) << (shift) | (mask) << ((shift) + 16))
37 /* register positions shared by RK2928, RK3036, RK3066 and RK3188 */
38 #define RK2928_PLL_CON(x) ((x) * 0x4)
39 #define RK2928_MODE_CON 0x40
40 #define RK2928_CLKSEL_CON(x) ((x) * 0x4 + 0x44)
41 #define RK2928_CLKGATE_CON(x) ((x) * 0x4 + 0xd0)
42 #define RK2928_GLB_SRST_FST 0x100
43 #define RK2928_GLB_SRST_SND 0x104
44 #define RK2928_SOFTRST_CON(x) ((x) * 0x4 + 0x110)
45 #define RK2928_MISC_CON 0x134
47 #define RK3036_SDMMC_CON0 0x144
48 #define RK3036_SDMMC_CON1 0x148
49 #define RK3036_SDIO_CON0 0x14c
50 #define RK3036_SDIO_CON1 0x150
51 #define RK3036_EMMC_CON0 0x154
52 #define RK3036_EMMC_CON1 0x158
54 #define RK3288_PLL_CON(x) RK2928_PLL_CON(x)
55 #define RK3288_MODE_CON 0x50
56 #define RK3288_CLKSEL_CON(x) ((x) * 0x4 + 0x60)
57 #define RK3288_CLKGATE_CON(x) ((x) * 0x4 + 0x160)
58 #define RK3288_GLB_SRST_FST 0x1b0
59 #define RK3288_GLB_SRST_SND 0x1b4
60 #define RK3288_SOFTRST_CON(x) ((x) * 0x4 + 0x1b8)
61 #define RK3288_MISC_CON 0x1e8
62 #define RK3288_SDMMC_CON0 0x200
63 #define RK3288_SDMMC_CON1 0x204
64 #define RK3288_SDIO0_CON0 0x208
65 #define RK3288_SDIO0_CON1 0x20c
66 #define RK3288_SDIO1_CON0 0x210
67 #define RK3288_SDIO1_CON1 0x214
68 #define RK3288_EMMC_CON0 0x218
69 #define RK3288_EMMC_CON1 0x21c
71 #define RK3368_PLL_CON(x) RK2928_PLL_CON(x)
72 #define RK3368_CLKSEL_CON(x) ((x) * 0x4 + 0x100)
73 #define RK3368_CLKGATE_CON(x) ((x) * 0x4 + 0x200)
74 #define RK3368_GLB_SRST_FST 0x280
75 #define RK3368_GLB_SRST_SND 0x284
76 #define RK3368_SOFTRST_CON(x) ((x) * 0x4 + 0x300)
77 #define RK3368_MISC_CON 0x380
78 #define RK3368_SDMMC_CON0 0x400
79 #define RK3368_SDMMC_CON1 0x404
80 #define RK3368_SDIO0_CON0 0x408
81 #define RK3368_SDIO0_CON1 0x40c
82 #define RK3368_SDIO1_CON0 0x410
83 #define RK3368_SDIO1_CON1 0x414
84 #define RK3368_EMMC_CON0 0x418
85 #define RK3368_EMMC_CON1 0x41c
87 enum rockchip_pll_type {
93 #define RK3036_PLL_RATE(_rate, _refdiv, _fbdiv, _postdiv1, \
94 _postdiv2, _dsmpd, _frac) \
98 .postdiv1 = _postdiv1, \
100 .postdiv2 = _postdiv2, \
105 #define RK3066_PLL_RATE(_rate, _nr, _nf, _no) \
111 .nb = ((_nf) < 2) ? 1 : (_nf) >> 1, \
114 #define RK3066_PLL_RATE_NB(_rate, _nr, _nf, _no, _nb) \
124 * struct rockchip_clk_provider: information about clock provider
125 * @reg_base: virtual address for the register base.
126 * @clk_data: holds clock related data like clk* and number of clocks.
127 * @cru_node: device-node of the clock-provider
128 * @grf: regmap of the general-register-files syscon
129 * @lock: maintains exclusion between callbacks for a given clock-provider.
131 struct rockchip_clk_provider {
132 void __iomem *reg_base;
133 struct clk_onecell_data clk_data;
134 struct device_node *cru_node;
139 struct rockchip_pll_rate_table {
147 unsigned int postdiv1;
149 unsigned int postdiv2;
155 * struct rockchip_pll_clock: information about pll clock
156 * @id: platform specific id of the clock.
157 * @name: name of this pll clock.
158 * @parent_name: name of the parent clock.
159 * @flags: optional flags for basic clock.
160 * @con_offset: offset of the register for configuring the PLL.
161 * @mode_offset: offset of the register for configuring the PLL-mode.
162 * @mode_shift: offset inside the mode-register for the mode of this pll.
163 * @lock_shift: offset inside the lock register for the lock status.
164 * @type: Type of PLL to be registered.
165 * @pll_flags: hardware-specific flags
166 * @rate_table: Table of usable pll rates
169 * ROCKCHIP_PLL_SYNC_RATE - check rate parameters to match against the
170 * rate_table parameters and ajust them if necessary.
172 struct rockchip_pll_clock {
175 const char *const *parent_names;
182 enum rockchip_pll_type type;
184 struct rockchip_pll_rate_table *rate_table;
187 #define ROCKCHIP_PLL_SYNC_RATE BIT(0)
189 #define PLL(_type, _id, _name, _pnames, _flags, _con, _mode, _mshift, \
190 _lshift, _pflags, _rtable) \
195 .parent_names = _pnames, \
196 .num_parents = ARRAY_SIZE(_pnames), \
197 .flags = CLK_GET_RATE_NOCACHE | _flags, \
198 .con_offset = _con, \
199 .mode_offset = _mode, \
200 .mode_shift = _mshift, \
201 .lock_shift = _lshift, \
202 .pll_flags = _pflags, \
203 .rate_table = _rtable, \
206 struct clk *rockchip_clk_register_pll(struct rockchip_clk_provider *ctx,
207 enum rockchip_pll_type pll_type,
208 const char *name, const char *const *parent_names,
209 u8 num_parents, int con_offset, int grf_lock_offset,
210 int lock_shift, int mode_offset, int mode_shift,
211 struct rockchip_pll_rate_table *rate_table,
214 struct rockchip_cpuclk_clksel {
219 #define ROCKCHIP_CPUCLK_NUM_DIVIDERS 2
220 struct rockchip_cpuclk_rate_table {
222 struct rockchip_cpuclk_clksel divs[ROCKCHIP_CPUCLK_NUM_DIVIDERS];
226 * struct rockchip_cpuclk_reg_data: describes register offsets and masks of the cpuclock
227 * @core_reg: register offset of the core settings register
228 * @div_core_shift: core divider offset used to divide the pll value
229 * @div_core_mask: core divider mask
230 * @mux_core_alt: mux value to select alternate parent
231 * @mux_core_main: mux value to select main parent of core
232 * @mux_core_shift: offset of the core multiplexer
233 * @mux_core_mask: core multiplexer mask
235 struct rockchip_cpuclk_reg_data {
245 struct clk *rockchip_clk_register_cpuclk(const char *name,
246 const char *const *parent_names, u8 num_parents,
247 const struct rockchip_cpuclk_reg_data *reg_data,
248 const struct rockchip_cpuclk_rate_table *rates,
249 int nrates, void __iomem *reg_base, spinlock_t *lock);
251 struct clk *rockchip_clk_register_mmc(const char *name,
252 const char *const *parent_names, u8 num_parents,
253 void __iomem *reg, int shift);
255 #define ROCKCHIP_INVERTER_HIWORD_MASK BIT(0)
257 struct clk *rockchip_clk_register_inverter(const char *name,
258 const char *const *parent_names, u8 num_parents,
259 void __iomem *reg, int shift, int flags,
262 #define PNAME(x) static const char *const x[] __initconst
264 enum rockchip_clk_branch_type {
268 branch_fraction_divider,
275 struct rockchip_clk_branch {
277 enum rockchip_clk_branch_type branch_type;
279 const char *const *parent_names;
289 struct clk_div_table *div_table;
293 struct rockchip_clk_branch *child;
296 #define COMPOSITE(_id, cname, pnames, f, mo, ms, mw, mf, ds, dw,\
300 .branch_type = branch_composite, \
302 .parent_names = pnames, \
303 .num_parents = ARRAY_SIZE(pnames), \
305 .muxdiv_offset = mo, \
317 #define COMPOSITE_NOMUX(_id, cname, pname, f, mo, ds, dw, df, \
321 .branch_type = branch_composite, \
323 .parent_names = (const char *[]){ pname }, \
326 .muxdiv_offset = mo, \
335 #define COMPOSITE_NOMUX_DIVTBL(_id, cname, pname, f, mo, ds, dw,\
336 df, dt, go, gs, gf) \
339 .branch_type = branch_composite, \
341 .parent_names = (const char *[]){ pname }, \
344 .muxdiv_offset = mo, \
354 #define COMPOSITE_NODIV(_id, cname, pnames, f, mo, ms, mw, mf, \
358 .branch_type = branch_composite, \
360 .parent_names = pnames, \
361 .num_parents = ARRAY_SIZE(pnames), \
363 .muxdiv_offset = mo, \
372 #define COMPOSITE_NOGATE(_id, cname, pnames, f, mo, ms, mw, mf, \
376 .branch_type = branch_composite, \
378 .parent_names = pnames, \
379 .num_parents = ARRAY_SIZE(pnames), \
381 .muxdiv_offset = mo, \
391 #define COMPOSITE_NOGATE_DIVTBL(_id, cname, pnames, f, mo, ms, \
392 mw, mf, ds, dw, df, dt) \
395 .branch_type = branch_composite, \
397 .parent_names = pnames, \
398 .num_parents = ARRAY_SIZE(pnames), \
400 .muxdiv_offset = mo, \
411 #define COMPOSITE_FRAC(_id, cname, pname, f, mo, df, go, gs, gf)\
414 .branch_type = branch_fraction_divider, \
416 .parent_names = (const char *[]){ pname }, \
419 .muxdiv_offset = mo, \
428 #define COMPOSITE_FRACMUX(_id, cname, pname, f, mo, df, go, gs, gf, ch) \
431 .branch_type = branch_fraction_divider, \
433 .parent_names = (const char *[]){ pname }, \
436 .muxdiv_offset = mo, \
446 #define COMPOSITE_FRACMUX_NOGATE(_id, cname, pname, f, mo, df, ch) \
449 .branch_type = branch_fraction_divider, \
451 .parent_names = (const char *[]){ pname }, \
454 .muxdiv_offset = mo, \
462 #define MUX(_id, cname, pnames, f, o, s, w, mf) \
465 .branch_type = branch_mux, \
467 .parent_names = pnames, \
468 .num_parents = ARRAY_SIZE(pnames), \
470 .muxdiv_offset = o, \
477 #define DIV(_id, cname, pname, f, o, s, w, df) \
480 .branch_type = branch_divider, \
482 .parent_names = (const char *[]){ pname }, \
485 .muxdiv_offset = o, \
492 #define DIVTBL(_id, cname, pname, f, o, s, w, df, dt) \
495 .branch_type = branch_divider, \
497 .parent_names = (const char *[]){ pname }, \
500 .muxdiv_offset = o, \
507 #define GATE(_id, cname, pname, f, o, b, gf) \
510 .branch_type = branch_gate, \
512 .parent_names = (const char *[]){ pname }, \
520 #define MMC(_id, cname, pname, offset, shift) \
523 .branch_type = branch_mmc, \
525 .parent_names = (const char *[]){ pname }, \
527 .muxdiv_offset = offset, \
528 .div_shift = shift, \
531 #define INVERTER(_id, cname, pname, io, is, if) \
534 .branch_type = branch_inverter, \
536 .parent_names = (const char *[]){ pname }, \
538 .muxdiv_offset = io, \
543 #define FACTOR(_id, cname, pname, f, fm, fd) \
546 .branch_type = branch_factor, \
548 .parent_names = (const char *[]){ pname }, \
555 #define FACTOR_GATE(_id, cname, pname, f, fm, fd, go, gb, gf) \
558 .branch_type = branch_factor, \
560 .parent_names = (const char *[]){ pname }, \
570 struct rockchip_clk_provider *rockchip_clk_init(struct device_node *np,
571 void __iomem *base, unsigned long nr_clks);
572 void rockchip_clk_of_add_provider(struct device_node *np,
573 struct rockchip_clk_provider *ctx);
574 struct regmap *rockchip_clk_get_grf(struct rockchip_clk_provider *ctx);
575 void rockchip_clk_add_lookup(struct rockchip_clk_provider *ctx,
576 struct clk *clk, unsigned int id);
577 void rockchip_clk_register_branches(struct rockchip_clk_provider *ctx,
578 struct rockchip_clk_branch *list,
579 unsigned int nr_clk);
580 void rockchip_clk_register_plls(struct rockchip_clk_provider *ctx,
581 struct rockchip_pll_clock *pll_list,
582 unsigned int nr_pll, int grf_lock_offset);
583 void rockchip_clk_register_armclk(struct rockchip_clk_provider *ctx,
584 unsigned int lookup_id, const char *name,
585 const char *const *parent_names, u8 num_parents,
586 const struct rockchip_cpuclk_reg_data *reg_data,
587 const struct rockchip_cpuclk_rate_table *rates,
589 void rockchip_clk_protect_critical(const char *const clocks[], int nclocks);
590 void rockchip_register_restart_notifier(struct rockchip_clk_provider *ctx,
591 unsigned int reg, void (*cb)(void));
593 #define ROCKCHIP_SOFTRST_HIWORD_MASK BIT(0)
595 #ifdef CONFIG_RESET_CONTROLLER
596 void rockchip_register_softrst(struct device_node *np,
597 unsigned int num_regs,
598 void __iomem *base, u8 flags);
600 static inline void rockchip_register_softrst(struct device_node *np,
601 unsigned int num_regs,
602 void __iomem *base, u8 flags)