1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Generic OPP Interface 4 * 5 * Copyright (C) 2009-2010 Texas Instruments Incorporated. 6 * Nishanth Menon 7 * Romit Dasgupta 8 * Kevin Hilman 9 */ 10 11 #ifndef __DRIVER_OPP_H__ 12 #define __DRIVER_OPP_H__ 13 14 #include <linux/device.h> 15 #include <linux/interconnect.h> 16 #include <linux/kernel.h> 17 #include <linux/kref.h> 18 #include <linux/list.h> 19 #include <linux/limits.h> 20 #include <linux/pm_opp.h> 21 #include <linux/notifier.h> 22 23 struct clk; 24 struct regulator; 25 26 /* Lock to allow exclusive modification to the device and opp lists */ 27 extern struct mutex opp_table_lock; 28 29 extern struct list_head opp_tables; 30 31 /* OPP Config flags */ 32 #define OPP_CONFIG_CLK BIT(0) 33 #define OPP_CONFIG_REGULATOR BIT(1) 34 #define OPP_CONFIG_REGULATOR_HELPER BIT(2) 35 #define OPP_CONFIG_PROP_NAME BIT(3) 36 #define OPP_CONFIG_SUPPORTED_HW BIT(4) 37 #define OPP_CONFIG_GENPD BIT(5) 38 #define OPP_CONFIG_REQUIRED_DEVS BIT(6) 39 40 /** 41 * struct opp_config_data - data for set config operations 42 * @opp_table: OPP table 43 * @flags: OPP config flags 44 * 45 * This structure stores the OPP config information for each OPP table 46 * configuration by the callers. 47 */ 48 struct opp_config_data { 49 struct opp_table *opp_table; 50 unsigned int flags; 51 }; 52 53 /* 54 * Internal data structure organization with the OPP layer library is as 55 * follows: 56 * opp_tables (root) 57 * |- device 1 (represents voltage domain 1) 58 * | |- opp 1 (availability, freq, voltage) 59 * | |- opp 2 .. 60 * ... ... 61 * | `- opp n .. 62 * |- device 2 (represents the next voltage domain) 63 * ... 64 * `- device m (represents mth voltage domain) 65 * device 1, 2.. are represented by opp_table structure while each opp 66 * is represented by the opp structure. 67 */ 68 69 /** 70 * struct dev_pm_opp - Generic OPP description structure 71 * @node: opp table node. The nodes are maintained throughout the lifetime 72 * of boot. It is expected only an optimal set of OPPs are 73 * added to the library by the SoC framework. 74 * IMPORTANT: the opp nodes should be maintained in increasing 75 * order. 76 * @kref: for reference count of the OPP. 77 * @available: true/false - marks if this OPP as available or not 78 * @dynamic: not-created from static DT entries. 79 * @turbo: true if turbo (boost) OPP 80 * @suspend: true if suspend OPP 81 * @removed: flag indicating that OPP's reference is dropped by OPP core. 82 * @rates: Frequencies in hertz 83 * @level: Performance level 84 * @supplies: Power supplies voltage/current values 85 * @bandwidth: Interconnect bandwidth values 86 * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's 87 * frequency from any other OPP's frequency. 88 * @required_opps: List of OPPs that are required by this OPP. 89 * @opp_table: points back to the opp_table struct this opp belongs to 90 * @np: OPP's device node. 91 * @dentry: debugfs dentry pointer (per opp) 92 * 93 * This structure stores the OPP information for a given device. 94 */ 95 struct dev_pm_opp { 96 struct list_head node; 97 struct kref kref; 98 99 bool available; 100 bool dynamic; 101 bool turbo; 102 bool suspend; 103 bool removed; 104 unsigned long *rates; 105 unsigned int level; 106 107 struct dev_pm_opp_supply *supplies; 108 struct dev_pm_opp_icc_bw *bandwidth; 109 110 unsigned long clock_latency_ns; 111 112 struct dev_pm_opp **required_opps; 113 struct opp_table *opp_table; 114 115 struct device_node *np; 116 117 #ifdef CONFIG_DEBUG_FS 118 struct dentry *dentry; 119 const char *of_name; 120 #endif 121 }; 122 123 /** 124 * struct opp_device - devices managed by 'struct opp_table' 125 * @node: list node 126 * @dev: device to which the struct object belongs 127 * @dentry: debugfs dentry pointer (per device) 128 * 129 * This is an internal data structure maintaining the devices that are managed 130 * by 'struct opp_table'. 131 */ 132 struct opp_device { 133 struct list_head node; 134 const struct device *dev; 135 136 #ifdef CONFIG_DEBUG_FS 137 struct dentry *dentry; 138 #endif 139 }; 140 141 enum opp_table_access { 142 OPP_TABLE_ACCESS_UNKNOWN = 0, 143 OPP_TABLE_ACCESS_EXCLUSIVE = 1, 144 OPP_TABLE_ACCESS_SHARED = 2, 145 }; 146 147 /** 148 * struct opp_table - Device opp structure 149 * @node: table node - contains the devices with OPPs that 150 * have been registered. Nodes once added are not modified in this 151 * table. 152 * @head: notifier head to notify the OPP availability changes. 153 * @dev_list: list of devices that share these OPPs 154 * @opp_list: table of opps 155 * @kref: for reference count of the table. 156 * @lock: mutex protecting the opp_list and dev_list. 157 * @np: struct device_node pointer for opp's DT node. 158 * @clock_latency_ns_max: Max clock latency in nanoseconds. 159 * @parsed_static_opps: Count of devices for which OPPs are initialized from DT. 160 * @shared_opp: OPP is shared between multiple devices. 161 * @rate_clk_single: Currently configured frequency for single clk. 162 * @current_opp: Currently configured OPP for the table. 163 * @suspend_opp: Pointer to OPP to be used during device suspend. 164 * @required_opp_tables: List of device OPP tables that are required by OPPs in 165 * this table. 166 * @required_devs: List of devices for required OPP tables. 167 * @required_opp_count: Number of required devices. 168 * @supported_hw: Array of version number to support. 169 * @supported_hw_count: Number of elements in supported_hw array. 170 * @prop_name: A name to postfix to many DT properties, while parsing them. 171 * @config_clks: Platform specific config_clks() callback. 172 * @clks: Device's clock handles, for multiple clocks. 173 * @clk: Device's clock handle, for single clock. 174 * @clk_count: Number of clocks. 175 * @config_regulators: Platform specific config_regulators() callback. 176 * @regulators: Supply regulators 177 * @regulator_count: Number of power supply regulators. Its value can be -1 178 * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt 179 * property). 180 * @paths: Interconnect path handles 181 * @path_count: Number of interconnect paths 182 * @enabled: Set to true if the device's resources are enabled/configured. 183 * @is_genpd: Marks if the OPP table belongs to a genpd. 184 * @dentry: debugfs dentry pointer of the real device directory (not links). 185 * @dentry_name: Name of the real dentry. 186 * 187 * @voltage_tolerance_v1: In percentage, for v1 bindings only. 188 * 189 * This is an internal data structure maintaining the link to opps attached to 190 * a device. This structure is not meant to be shared to users as it is 191 * meant for book keeping and private to OPP library. 192 */ 193 struct opp_table { 194 struct list_head node, lazy; 195 196 struct blocking_notifier_head head; 197 struct list_head dev_list; 198 struct list_head opp_list; 199 struct kref kref; 200 struct mutex lock; 201 202 struct device_node *np; 203 unsigned long clock_latency_ns_max; 204 205 /* For backward compatibility with v1 bindings */ 206 unsigned int voltage_tolerance_v1; 207 208 unsigned int parsed_static_opps; 209 enum opp_table_access shared_opp; 210 unsigned long rate_clk_single; 211 struct dev_pm_opp *current_opp; 212 struct dev_pm_opp *suspend_opp; 213 214 struct opp_table **required_opp_tables; 215 struct device **required_devs; 216 unsigned int required_opp_count; 217 218 unsigned int *supported_hw; 219 unsigned int supported_hw_count; 220 const char *prop_name; 221 config_clks_t config_clks; 222 struct clk **clks; 223 struct clk *clk; 224 int clk_count; 225 config_regulators_t config_regulators; 226 struct regulator **regulators; 227 int regulator_count; 228 struct icc_path **paths; 229 unsigned int path_count; 230 bool enabled; 231 bool is_genpd; 232 233 #ifdef CONFIG_DEBUG_FS 234 struct dentry *dentry; 235 char dentry_name[NAME_MAX]; 236 #endif 237 }; 238 239 /* Routines internal to opp core */ 240 void dev_pm_opp_get(struct dev_pm_opp *opp); 241 bool _opp_remove_all_static(struct opp_table *opp_table); 242 void _get_opp_table_kref(struct opp_table *opp_table); 243 int _get_opp_count(struct opp_table *opp_table); 244 struct opp_table *_find_opp_table(struct device *dev); 245 struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table); 246 struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table); 247 void _opp_free(struct dev_pm_opp *opp); 248 int _opp_compare_key(struct opp_table *opp_table, struct dev_pm_opp *opp1, struct dev_pm_opp *opp2); 249 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table); 250 int _opp_add_v1(struct opp_table *opp_table, struct device *dev, struct dev_pm_opp_data *data, bool dynamic); 251 void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu); 252 struct opp_table *_add_opp_table_indexed(struct device *dev, int index, bool getclk); 253 void _put_opp_list_kref(struct opp_table *opp_table); 254 void _required_opps_available(struct dev_pm_opp *opp, int count); 255 void _update_set_required_opps(struct opp_table *opp_table); 256 257 static inline bool lazy_linking_pending(struct opp_table *opp_table) 258 { 259 return unlikely(!list_empty(&opp_table->lazy)); 260 } 261 262 #ifdef CONFIG_OF 263 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index); 264 void _of_clear_opp_table(struct opp_table *opp_table); 265 struct opp_table *_managed_opp(struct device *dev, int index); 266 void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp); 267 #else 268 static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {} 269 static inline void _of_clear_opp_table(struct opp_table *opp_table) {} 270 static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; } 271 static inline void _of_clear_opp(struct opp_table *opp_table, struct dev_pm_opp *opp) {} 272 #endif 273 274 #ifdef CONFIG_DEBUG_FS 275 void opp_debug_remove_one(struct dev_pm_opp *opp); 276 void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table); 277 void opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table); 278 void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table); 279 #else 280 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {} 281 282 static inline void opp_debug_create_one(struct dev_pm_opp *opp, 283 struct opp_table *opp_table) { } 284 285 static inline void opp_debug_register(struct opp_device *opp_dev, 286 struct opp_table *opp_table) { } 287 288 static inline void opp_debug_unregister(struct opp_device *opp_dev, 289 struct opp_table *opp_table) 290 { } 291 #endif /* DEBUG_FS */ 292 293 #endif /* __DRIVER_OPP_H__ */ 294