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