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