Commit | Line | Data |
---|---|---|
f59d3ee8 VK |
1 | /* |
2 | * Generic OPP Interface | |
3 | * | |
4 | * Copyright (C) 2009-2010 Texas Instruments Incorporated. | |
5 | * Nishanth Menon | |
6 | * Romit Dasgupta | |
7 | * Kevin Hilman | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License version 2 as | |
11 | * published by the Free Software Foundation. | |
12 | */ | |
13 | ||
14 | #ifndef __DRIVER_OPP_H__ | |
15 | #define __DRIVER_OPP_H__ | |
16 | ||
17 | #include <linux/device.h> | |
18 | #include <linux/kernel.h> | |
7034764a | 19 | #include <linux/kref.h> |
f59d3ee8 | 20 | #include <linux/list.h> |
deaa5146 | 21 | #include <linux/limits.h> |
f59d3ee8 VK |
22 | #include <linux/pm_opp.h> |
23 | #include <linux/rculist.h> | |
24 | #include <linux/rcupdate.h> | |
25 | ||
d54974c2 | 26 | struct clk; |
9f8ea969 VK |
27 | struct regulator; |
28 | ||
87b4115d | 29 | /* Lock to allow exclusive modification to the device and opp lists */ |
2c2709dc | 30 | extern struct mutex opp_table_lock; |
87b4115d | 31 | |
f47b72a1 VK |
32 | extern struct list_head opp_tables; |
33 | ||
f59d3ee8 VK |
34 | /* |
35 | * Internal data structure organization with the OPP layer library is as | |
36 | * follows: | |
2c2709dc | 37 | * opp_tables (root) |
f59d3ee8 VK |
38 | * |- device 1 (represents voltage domain 1) |
39 | * | |- opp 1 (availability, freq, voltage) | |
40 | * | |- opp 2 .. | |
41 | * ... ... | |
42 | * | `- opp n .. | |
43 | * |- device 2 (represents the next voltage domain) | |
44 | * ... | |
45 | * `- device m (represents mth voltage domain) | |
2c2709dc | 46 | * device 1, 2.. are represented by opp_table structure while each opp |
f59d3ee8 VK |
47 | * is represented by the opp structure. |
48 | */ | |
49 | ||
50 | /** | |
51 | * struct dev_pm_opp - Generic OPP description structure | |
2c2709dc | 52 | * @node: opp table node. The nodes are maintained throughout the lifetime |
f59d3ee8 VK |
53 | * of boot. It is expected only an optimal set of OPPs are |
54 | * added to the library by the SoC framework. | |
2c2709dc | 55 | * RCU usage: opp table is traversed with RCU locks. node |
f59d3ee8 | 56 | * modification is possible realtime, hence the modifications |
2c2709dc | 57 | * are protected by the opp_table_lock for integrity. |
f59d3ee8 VK |
58 | * IMPORTANT: the opp nodes should be maintained in increasing |
59 | * order. | |
7034764a | 60 | * @kref: for reference count of the OPP. |
f59d3ee8 | 61 | * @available: true/false - marks if this OPP as available or not |
dc4e7b1f | 62 | * @dynamic: not-created from static DT entries. |
f59d3ee8 | 63 | * @turbo: true if turbo (boost) OPP |
deaa5146 | 64 | * @suspend: true if suspend OPP |
f59d3ee8 | 65 | * @rate: Frequency in hertz |
dfbe4678 | 66 | * @supplies: Power supplies voltage/current values |
f59d3ee8 VK |
67 | * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's |
68 | * frequency from any other OPP's frequency. | |
2c2709dc | 69 | * @opp_table: points back to the opp_table struct this opp belongs to |
f59d3ee8 VK |
70 | * @rcu_head: RCU callback head used for deferred freeing |
71 | * @np: OPP's device node. | |
deaa5146 | 72 | * @dentry: debugfs dentry pointer (per opp) |
f59d3ee8 VK |
73 | * |
74 | * This structure stores the OPP information for a given device. | |
75 | */ | |
76 | struct dev_pm_opp { | |
77 | struct list_head node; | |
7034764a | 78 | struct kref kref; |
f59d3ee8 VK |
79 | |
80 | bool available; | |
81 | bool dynamic; | |
82 | bool turbo; | |
deaa5146 | 83 | bool suspend; |
f59d3ee8 VK |
84 | unsigned long rate; |
85 | ||
dfbe4678 | 86 | struct dev_pm_opp_supply *supplies; |
0f0fe7e0 | 87 | |
f59d3ee8 VK |
88 | unsigned long clock_latency_ns; |
89 | ||
2c2709dc | 90 | struct opp_table *opp_table; |
f59d3ee8 VK |
91 | struct rcu_head rcu_head; |
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 | |
104 | * @rcu_head: RCU callback head used for deferred freeing | |
deaa5146 | 105 | * @dentry: debugfs dentry pointer (per device) |
f59d3ee8 | 106 | * |
2c2709dc VK |
107 | * This is an internal data structure maintaining the devices that are managed |
108 | * by 'struct opp_table'. | |
f59d3ee8 | 109 | */ |
2c2709dc | 110 | struct opp_device { |
f59d3ee8 VK |
111 | struct list_head node; |
112 | const struct device *dev; | |
113 | struct rcu_head rcu_head; | |
deaa5146 VK |
114 | |
115 | #ifdef CONFIG_DEBUG_FS | |
116 | struct dentry *dentry; | |
117 | #endif | |
f59d3ee8 VK |
118 | }; |
119 | ||
79ee2e8f VK |
120 | enum opp_table_access { |
121 | OPP_TABLE_ACCESS_UNKNOWN = 0, | |
122 | OPP_TABLE_ACCESS_EXCLUSIVE = 1, | |
123 | OPP_TABLE_ACCESS_SHARED = 2, | |
124 | }; | |
125 | ||
f59d3ee8 | 126 | /** |
2c2709dc VK |
127 | * struct opp_table - Device opp structure |
128 | * @node: table node - contains the devices with OPPs that | |
f59d3ee8 | 129 | * have been registered. Nodes once added are not modified in this |
2c2709dc VK |
130 | * table. |
131 | * RCU usage: nodes are not modified in the table of opp_table, | |
132 | * however addition is possible and is secured by opp_table_lock | |
f59d3ee8 VK |
133 | * @srcu_head: notifier head to notify the OPP availability changes. |
134 | * @rcu_head: RCU callback head used for deferred freeing | |
135 | * @dev_list: list of devices that share these OPPs | |
2c2709dc | 136 | * @opp_list: table of opps |
f067a982 | 137 | * @kref: for reference count of the table. |
37a73ec0 | 138 | * @lock: mutex protecting the opp_list. |
f59d3ee8 | 139 | * @np: struct device_node pointer for opp's DT node. |
dc4e7b1f | 140 | * @clock_latency_ns_max: Max clock latency in nanoseconds. |
f59d3ee8 | 141 | * @shared_opp: OPP is shared between multiple devices. |
dc4e7b1f | 142 | * @suspend_opp: Pointer to OPP to be used during device suspend. |
7de36b0a VK |
143 | * @supported_hw: Array of version number to support. |
144 | * @supported_hw_count: Number of elements in supported_hw array. | |
01fb4d3c | 145 | * @prop_name: A name to postfix to many DT properties, while parsing them. |
d54974c2 | 146 | * @clk: Device's clock handle |
dfbe4678 VK |
147 | * @regulators: Supply regulators |
148 | * @regulator_count: Number of power supply regulators | |
4dab160e | 149 | * @set_opp: Platform specific set_opp callback |
94735585 | 150 | * @set_opp_data: Data to be passed to set_opp callback |
deaa5146 VK |
151 | * @dentry: debugfs dentry pointer of the real device directory (not links). |
152 | * @dentry_name: Name of the real dentry. | |
f59d3ee8 | 153 | * |
50f8cfbd VK |
154 | * @voltage_tolerance_v1: In percentage, for v1 bindings only. |
155 | * | |
f59d3ee8 VK |
156 | * This is an internal data structure maintaining the link to opps attached to |
157 | * a device. This structure is not meant to be shared to users as it is | |
158 | * meant for book keeping and private to OPP library. | |
159 | * | |
160 | * Because the opp structures can be used from both rcu and srcu readers, we | |
161 | * need to wait for the grace period of both of them before freeing any | |
162 | * resources. And so we have used kfree_rcu() from within call_srcu() handlers. | |
163 | */ | |
2c2709dc | 164 | struct opp_table { |
f59d3ee8 VK |
165 | struct list_head node; |
166 | ||
167 | struct srcu_notifier_head srcu_head; | |
168 | struct rcu_head rcu_head; | |
169 | struct list_head dev_list; | |
170 | struct list_head opp_list; | |
f067a982 | 171 | struct kref kref; |
37a73ec0 | 172 | struct mutex lock; |
f59d3ee8 VK |
173 | |
174 | struct device_node *np; | |
175 | unsigned long clock_latency_ns_max; | |
50f8cfbd VK |
176 | |
177 | /* For backward compatibility with v1 bindings */ | |
178 | unsigned int voltage_tolerance_v1; | |
179 | ||
79ee2e8f | 180 | enum opp_table_access shared_opp; |
f59d3ee8 | 181 | struct dev_pm_opp *suspend_opp; |
deaa5146 | 182 | |
7de36b0a VK |
183 | unsigned int *supported_hw; |
184 | unsigned int supported_hw_count; | |
01fb4d3c | 185 | const char *prop_name; |
d54974c2 | 186 | struct clk *clk; |
dfbe4678 VK |
187 | struct regulator **regulators; |
188 | unsigned int regulator_count; | |
7de36b0a | 189 | |
4dab160e | 190 | int (*set_opp)(struct dev_pm_set_opp_data *data); |
94735585 VK |
191 | struct dev_pm_set_opp_data *set_opp_data; |
192 | ||
deaa5146 VK |
193 | #ifdef CONFIG_DEBUG_FS |
194 | struct dentry *dentry; | |
195 | char dentry_name[NAME_MAX]; | |
196 | #endif | |
f59d3ee8 VK |
197 | }; |
198 | ||
199 | /* Routines internal to opp core */ | |
f067a982 | 200 | void _get_opp_table_kref(struct opp_table *opp_table); |
2c2709dc VK |
201 | struct opp_table *_find_opp_table(struct device *dev); |
202 | struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table); | |
8cd2f6e8 | 203 | void _dev_pm_opp_remove_table(struct opp_table *opp_table, struct device *dev, bool remove_all); |
9274c892 | 204 | void _dev_pm_opp_find_and_remove_table(struct device *dev, bool remove_all); |
8cd2f6e8 VK |
205 | struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table); |
206 | void _opp_free(struct dev_pm_opp *opp); | |
f47b72a1 | 207 | int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table); |
8cd2f6e8 | 208 | int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic); |
f47b72a1 | 209 | void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, bool of); |
8cd2f6e8 | 210 | struct opp_table *_add_opp_table(struct device *dev); |
f47b72a1 VK |
211 | |
212 | #ifdef CONFIG_OF | |
213 | void _of_init_opp_table(struct opp_table *opp_table, struct device *dev); | |
214 | #else | |
215 | static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev) {} | |
216 | #endif | |
f59d3ee8 | 217 | |
deaa5146 VK |
218 | #ifdef CONFIG_DEBUG_FS |
219 | void opp_debug_remove_one(struct dev_pm_opp *opp); | |
2c2709dc VK |
220 | int opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table); |
221 | int opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table); | |
222 | void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table); | |
deaa5146 VK |
223 | #else |
224 | static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {} | |
225 | ||
226 | static inline int opp_debug_create_one(struct dev_pm_opp *opp, | |
2c2709dc | 227 | struct opp_table *opp_table) |
deaa5146 | 228 | { return 0; } |
2c2709dc VK |
229 | static inline int opp_debug_register(struct opp_device *opp_dev, |
230 | struct opp_table *opp_table) | |
deaa5146 VK |
231 | { return 0; } |
232 | ||
2c2709dc VK |
233 | static inline void opp_debug_unregister(struct opp_device *opp_dev, |
234 | struct opp_table *opp_table) | |
deaa5146 VK |
235 | { } |
236 | #endif /* DEBUG_FS */ | |
237 | ||
f59d3ee8 | 238 | #endif /* __DRIVER_OPP_H__ */ |