1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Generic OPP Interface
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
11 #ifndef __DRIVER_OPP_H__
12 #define __DRIVER_OPP_H__
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>
26 /* Lock to allow exclusive modification to the device and opp lists */
27 extern struct mutex opp_table_lock;
29 extern struct list_head opp_tables, lazy_opp_tables;
32 * Internal data structure organization with the OPP layer library is as
35 * |- device 1 (represents voltage domain 1)
36 * | |- opp 1 (availability, freq, voltage)
40 * |- device 2 (represents the next voltage domain)
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.
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
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 * @pstate: Device's power domain's performance state.
60 * @rate: Frequency in hertz
61 * @level: Performance level
62 * @supplies: Power supplies voltage/current values
63 * @bandwidth: Interconnect bandwidth values
64 * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
65 * frequency from any other OPP's frequency.
66 * @required_opps: List of OPPs that are required by this OPP.
67 * @opp_table: points back to the opp_table struct this opp belongs to
68 * @np: OPP's device node.
69 * @dentry: debugfs dentry pointer (per opp)
71 * This structure stores the OPP information for a given device.
74 struct list_head node;
85 struct dev_pm_opp_supply *supplies;
86 struct dev_pm_opp_icc_bw *bandwidth;
88 unsigned long clock_latency_ns;
90 struct dev_pm_opp **required_opps;
91 struct opp_table *opp_table;
93 struct device_node *np;
95 #ifdef CONFIG_DEBUG_FS
96 struct dentry *dentry;
101 * struct opp_device - devices managed by 'struct opp_table'
103 * @dev: device to which the struct object belongs
104 * @dentry: debugfs dentry pointer (per device)
106 * This is an internal data structure maintaining the devices that are managed
107 * by 'struct opp_table'.
110 struct list_head node;
111 const struct device *dev;
113 #ifdef CONFIG_DEBUG_FS
114 struct dentry *dentry;
118 enum opp_table_access {
119 OPP_TABLE_ACCESS_UNKNOWN = 0,
120 OPP_TABLE_ACCESS_EXCLUSIVE = 1,
121 OPP_TABLE_ACCESS_SHARED = 2,
125 * struct opp_table - Device opp structure
126 * @node: table node - contains the devices with OPPs that
127 * have been registered. Nodes once added are not modified in this
129 * @head: notifier head to notify the OPP availability changes.
130 * @dev_list: list of devices that share these OPPs
131 * @opp_list: table of opps
132 * @kref: for reference count of the table.
133 * @lock: mutex protecting the opp_list and dev_list.
134 * @np: struct device_node pointer for opp's DT node.
135 * @clock_latency_ns_max: Max clock latency in nanoseconds.
136 * @parsed_static_opps: Count of devices for which OPPs are initialized from DT.
137 * @shared_opp: OPP is shared between multiple devices.
138 * @current_rate: Currently configured frequency.
139 * @current_opp: Currently configured OPP for the table.
140 * @suspend_opp: Pointer to OPP to be used during device suspend.
141 * @genpd_virt_dev_lock: Mutex protecting the genpd virtual device pointers.
142 * @genpd_virt_devs: List of virtual devices for multiple genpd support.
143 * @required_opp_tables: List of device OPP tables that are required by OPPs in
145 * @required_opp_count: Number of required devices.
146 * @supported_hw: Array of version number to support.
147 * @supported_hw_count: Number of elements in supported_hw array.
148 * @prop_name: A name to postfix to many DT properties, while parsing them.
149 * @clk: Device's clock handle
150 * @regulators: Supply regulators
151 * @regulator_count: Number of power supply regulators. Its value can be -1
152 * (uninitialized), 0 (no opp-microvolt property) or > 0 (has opp-microvolt
154 * @paths: Interconnect path handles
155 * @path_count: Number of interconnect paths
156 * @enabled: Set to true if the device's resources are enabled/configured.
157 * @genpd_performance_state: Device's power domain support performance state.
158 * @is_genpd: Marks if the OPP table belongs to a genpd.
159 * @set_opp: Platform specific set_opp callback
160 * @sod_supplies: Set opp data supplies
161 * @set_opp_data: Data to be passed to set_opp callback
162 * @dentry: debugfs dentry pointer of the real device directory (not links).
163 * @dentry_name: Name of the real dentry.
165 * @voltage_tolerance_v1: In percentage, for v1 bindings only.
167 * This is an internal data structure maintaining the link to opps attached to
168 * a device. This structure is not meant to be shared to users as it is
169 * meant for book keeping and private to OPP library.
172 struct list_head node, lazy;
174 struct blocking_notifier_head head;
175 struct list_head dev_list;
176 struct list_head opp_list;
180 struct device_node *np;
181 unsigned long clock_latency_ns_max;
183 /* For backward compatibility with v1 bindings */
184 unsigned int voltage_tolerance_v1;
186 unsigned int parsed_static_opps;
187 enum opp_table_access shared_opp;
188 unsigned long current_rate;
189 struct dev_pm_opp *current_opp;
190 struct dev_pm_opp *suspend_opp;
192 struct mutex genpd_virt_dev_lock;
193 struct device **genpd_virt_devs;
194 struct opp_table **required_opp_tables;
195 unsigned int required_opp_count;
197 unsigned int *supported_hw;
198 unsigned int supported_hw_count;
199 const char *prop_name;
201 struct regulator **regulators;
203 struct icc_path **paths;
204 unsigned int path_count;
206 bool genpd_performance_state;
209 int (*set_opp)(struct dev_pm_set_opp_data *data);
210 struct dev_pm_opp_supply *sod_supplies;
211 struct dev_pm_set_opp_data *set_opp_data;
213 #ifdef CONFIG_DEBUG_FS
214 struct dentry *dentry;
215 char dentry_name[NAME_MAX];
219 /* Routines internal to opp core */
220 void dev_pm_opp_get(struct dev_pm_opp *opp);
221 bool _opp_remove_all_static(struct opp_table *opp_table);
222 void _get_opp_table_kref(struct opp_table *opp_table);
223 int _get_opp_count(struct opp_table *opp_table);
224 struct opp_table *_find_opp_table(struct device *dev);
225 struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table);
226 struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table);
227 void _opp_free(struct dev_pm_opp *opp);
228 int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2);
229 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table, bool rate_not_available);
230 int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic);
231 void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu);
232 struct opp_table *_add_opp_table_indexed(struct device *dev, int index, bool getclk);
233 void _put_opp_list_kref(struct opp_table *opp_table);
234 void _required_opps_available(struct dev_pm_opp *opp, int count);
236 static inline bool lazy_linking_pending(struct opp_table *opp_table)
238 return unlikely(!list_empty(&opp_table->lazy));
242 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index);
243 void _of_clear_opp_table(struct opp_table *opp_table);
244 struct opp_table *_managed_opp(struct device *dev, int index);
245 void _of_opp_free_required_opps(struct opp_table *opp_table,
246 struct dev_pm_opp *opp);
248 static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {}
249 static inline void _of_clear_opp_table(struct opp_table *opp_table) {}
250 static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; }
251 static inline void _of_opp_free_required_opps(struct opp_table *opp_table,
252 struct dev_pm_opp *opp) {}
255 #ifdef CONFIG_DEBUG_FS
256 void opp_debug_remove_one(struct dev_pm_opp *opp);
257 void opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
258 void opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table);
259 void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table);
261 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}
263 static inline void opp_debug_create_one(struct dev_pm_opp *opp,
264 struct opp_table *opp_table) { }
266 static inline void opp_debug_register(struct opp_device *opp_dev,
267 struct opp_table *opp_table) { }
269 static inline void opp_debug_unregister(struct opp_device *opp_dev,
270 struct opp_table *opp_table)
272 #endif /* DEBUG_FS */
274 #endif /* __DRIVER_OPP_H__ */