1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * Renesas RCar Gen3 CPG MSSR driver 4 * 5 * Copyright (C) 2017-2018 Marek Vasut <marek.vasut@gmail.com> 6 * 7 * Based on the following driver from Linux kernel: 8 * r8a7796 Clock Pulse Generator / Module Standby and Software Reset 9 * 10 * Copyright (C) 2016 Glider bvba 11 */ 12 13 #ifndef __DRIVERS_CLK_RENESAS_CPG_MSSR__ 14 #define __DRIVERS_CLK_RENESAS_CPG_MSSR__ 15 16 struct cpg_mssr_info { 17 const struct cpg_core_clk *core_clk; 18 unsigned int core_clk_size; 19 const struct mssr_mod_clk *mod_clk; 20 unsigned int mod_clk_size; 21 const struct mstp_stop_table *mstp_table; 22 unsigned int mstp_table_size; 23 const char *reset_node; 24 const char *extalr_node; 25 const char *extal_usb_node; 26 unsigned int mod_clk_base; 27 unsigned int clk_extal_id; 28 unsigned int clk_extalr_id; 29 unsigned int clk_extal_usb_id; 30 unsigned int pll0_div; 31 const void *(*get_pll_config)(const u32 cpg_mode); 32 }; 33 34 /* 35 * Definitions of CPG Core Clocks 36 * 37 * These include: 38 * - Clock outputs exported to DT 39 * - External input clocks 40 * - Internal CPG clocks 41 */ 42 struct cpg_core_clk { 43 /* Common */ 44 const char *name; 45 unsigned int id; 46 unsigned int type; 47 /* Depending on type */ 48 unsigned int parent; /* Core Clocks only */ 49 unsigned int div; 50 unsigned int mult; 51 unsigned int offset; 52 }; 53 54 enum clk_types { 55 /* Generic */ 56 CLK_TYPE_IN, /* External Clock Input */ 57 CLK_TYPE_FF, /* Fixed Factor Clock */ 58 CLK_TYPE_DIV6P1, /* DIV6 Clock with 1 parent clock */ 59 CLK_TYPE_DIV6_RO, /* DIV6 Clock read only with extra divisor */ 60 CLK_TYPE_FR, /* Fixed Rate Clock */ 61 62 /* Custom definitions start here */ 63 CLK_TYPE_CUSTOM, 64 }; 65 66 #define DEF_TYPE(_name, _id, _type...) \ 67 { .name = _name, .id = _id, .type = _type } 68 #define DEF_BASE(_name, _id, _type, _parent...) \ 69 DEF_TYPE(_name, _id, _type, .parent = _parent) 70 71 #define DEF_INPUT(_name, _id) \ 72 DEF_TYPE(_name, _id, CLK_TYPE_IN) 73 #define DEF_FIXED(_name, _id, _parent, _div, _mult) \ 74 DEF_BASE(_name, _id, CLK_TYPE_FF, _parent, .div = _div, .mult = _mult) 75 #define DEF_DIV6P1(_name, _id, _parent, _offset) \ 76 DEF_BASE(_name, _id, CLK_TYPE_DIV6P1, _parent, .offset = _offset) 77 #define DEF_DIV6_RO(_name, _id, _parent, _offset, _div) \ 78 DEF_BASE(_name, _id, CLK_TYPE_DIV6_RO, _parent, .offset = _offset, .div = _div, .mult = 1) 79 #define DEF_RATE(_name, _id, _rate) \ 80 DEF_TYPE(_name, _id, CLK_TYPE_FR, .mult = _rate) 81 82 /* 83 * Definitions of Module Clocks 84 */ 85 struct mssr_mod_clk { 86 const char *name; 87 unsigned int id; 88 unsigned int parent; /* Add MOD_CLK_BASE for Module Clocks */ 89 }; 90 91 /* Convert from sparse base-100 to packed index space */ 92 #define MOD_CLK_PACK(x) ((x) - ((x) / 100) * (100 - 32)) 93 94 #define MOD_CLK_ID(x) (MOD_CLK_BASE + MOD_CLK_PACK(x)) 95 96 #define DEF_MOD(_name, _mod, _parent...) \ 97 { .name = _name, .id = MOD_CLK_ID(_mod), .parent = _parent } 98 99 struct mstp_stop_table { 100 u32 sdis; 101 u32 sen; 102 u32 rdis; 103 u32 ren; 104 }; 105 106 #define TSTR0 0x04 107 #define TSTR0_STR0 BIT(0) 108 109 bool renesas_clk_is_mod(struct clk *clk); 110 int renesas_clk_get_mod(struct clk *clk, struct cpg_mssr_info *info, 111 const struct mssr_mod_clk **mssr); 112 int renesas_clk_get_core(struct clk *clk, struct cpg_mssr_info *info, 113 const struct cpg_core_clk **core); 114 int renesas_clk_get_parent(struct clk *clk, struct cpg_mssr_info *info, 115 struct clk *parent); 116 int renesas_clk_endisable(struct clk *clk, void __iomem *base, bool enable); 117 int renesas_clk_remove(void __iomem *base, struct cpg_mssr_info *info); 118 119 #endif /* __DRIVERS_CLK_RENESAS_CPG_MSSR__ */ 120