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