2 * Generic OPP Interface
4 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
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.
14 #ifndef __DRIVER_OPP_H__
15 #define __DRIVER_OPP_H__
17 #include <linux/device.h>
18 #include <linux/kernel.h>
19 #include <linux/list.h>
20 #include <linux/limits.h>
21 #include <linux/pm_opp.h>
22 #include <linux/rculist.h>
23 #include <linux/rcupdate.h>
28 /* Lock to allow exclusive modification to the device and opp lists */
29 extern struct mutex opp_table_lock
;
31 extern struct list_head opp_tables
;
34 * Internal data structure organization with the OPP layer library is as
37 * |- device 1 (represents voltage domain 1)
38 * | |- opp 1 (availability, freq, voltage)
42 * |- device 2 (represents the next voltage domain)
44 * `- device m (represents mth voltage domain)
45 * device 1, 2.. are represented by opp_table structure while each opp
46 * is represented by the opp structure.
50 * struct dev_pm_opp - Generic OPP description structure
51 * @node: opp table node. The nodes are maintained throughout the lifetime
52 * of boot. It is expected only an optimal set of OPPs are
53 * added to the library by the SoC framework.
54 * RCU usage: opp table is traversed with RCU locks. node
55 * modification is possible realtime, hence the modifications
56 * are protected by the opp_table_lock for integrity.
57 * IMPORTANT: the opp nodes should be maintained in increasing
59 * @available: true/false - marks if this OPP as available or not
60 * @dynamic: not-created from static DT entries.
61 * @turbo: true if turbo (boost) OPP
62 * @suspend: true if suspend OPP
63 * @rate: Frequency in hertz
64 * @u_volt: Target voltage in microvolts corresponding to this OPP
65 * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
66 * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
67 * @u_amp: Maximum current drawn by the device in microamperes
68 * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
69 * frequency from any other OPP's frequency.
70 * @opp_table: points back to the opp_table struct this opp belongs to
71 * @rcu_head: RCU callback head used for deferred freeing
72 * @np: OPP's device node.
73 * @dentry: debugfs dentry pointer (per opp)
75 * This structure stores the OPP information for a given device.
78 struct list_head node
;
87 unsigned long u_volt_min
;
88 unsigned long u_volt_max
;
90 unsigned long clock_latency_ns
;
92 struct opp_table
*opp_table
;
93 struct rcu_head rcu_head
;
95 struct device_node
*np
;
97 #ifdef CONFIG_DEBUG_FS
98 struct dentry
*dentry
;
103 * struct opp_device - devices managed by 'struct opp_table'
105 * @dev: device to which the struct object belongs
106 * @rcu_head: RCU callback head used for deferred freeing
107 * @dentry: debugfs dentry pointer (per device)
109 * This is an internal data structure maintaining the devices that are managed
110 * by 'struct opp_table'.
113 struct list_head node
;
114 const struct device
*dev
;
115 struct rcu_head rcu_head
;
117 #ifdef CONFIG_DEBUG_FS
118 struct dentry
*dentry
;
123 * struct opp_table - Device opp structure
124 * @node: table node - contains the devices with OPPs that
125 * have been registered. Nodes once added are not modified in this
127 * RCU usage: nodes are not modified in the table of opp_table,
128 * however addition is possible and is secured by opp_table_lock
129 * @srcu_head: notifier head to notify the OPP availability changes.
130 * @rcu_head: RCU callback head used for deferred freeing
131 * @dev_list: list of devices that share these OPPs
132 * @opp_list: table of opps
133 * @np: struct device_node pointer for opp's DT node.
134 * @clock_latency_ns_max: Max clock latency in nanoseconds.
135 * @shared_opp: OPP is shared between multiple devices.
136 * @suspend_opp: Pointer to OPP to be used during device suspend.
137 * @supported_hw: Array of version number to support.
138 * @supported_hw_count: Number of elements in supported_hw array.
139 * @prop_name: A name to postfix to many DT properties, while parsing them.
140 * @clk: Device's clock handle
141 * @regulator: Supply regulator
142 * @dentry: debugfs dentry pointer of the real device directory (not links).
143 * @dentry_name: Name of the real dentry.
145 * @voltage_tolerance_v1: In percentage, for v1 bindings only.
147 * This is an internal data structure maintaining the link to opps attached to
148 * a device. This structure is not meant to be shared to users as it is
149 * meant for book keeping and private to OPP library.
151 * Because the opp structures can be used from both rcu and srcu readers, we
152 * need to wait for the grace period of both of them before freeing any
153 * resources. And so we have used kfree_rcu() from within call_srcu() handlers.
156 struct list_head node
;
158 struct srcu_notifier_head srcu_head
;
159 struct rcu_head rcu_head
;
160 struct list_head dev_list
;
161 struct list_head opp_list
;
163 struct device_node
*np
;
164 unsigned long clock_latency_ns_max
;
166 /* For backward compatibility with v1 bindings */
167 unsigned int voltage_tolerance_v1
;
170 struct dev_pm_opp
*suspend_opp
;
172 unsigned int *supported_hw
;
173 unsigned int supported_hw_count
;
174 const char *prop_name
;
176 struct regulator
*regulator
;
178 #ifdef CONFIG_DEBUG_FS
179 struct dentry
*dentry
;
180 char dentry_name
[NAME_MAX
];
184 /* Routines internal to opp core */
185 struct opp_table
*_find_opp_table(struct device
*dev
);
186 struct opp_device
*_add_opp_dev(const struct device
*dev
, struct opp_table
*opp_table
);
187 struct device_node
*_of_get_opp_desc_node(struct device
*dev
);
188 void _dev_pm_opp_remove_table(struct device
*dev
, bool remove_all
);
189 struct dev_pm_opp
*_allocate_opp(struct device
*dev
, struct opp_table
**opp_table
);
190 int _opp_add(struct device
*dev
, struct dev_pm_opp
*new_opp
, struct opp_table
*opp_table
);
191 void _opp_remove(struct opp_table
*opp_table
, struct dev_pm_opp
*opp
, bool notify
);
192 int _opp_add_v1(struct device
*dev
, unsigned long freq
, long u_volt
, bool dynamic
);
193 void _dev_pm_opp_cpumask_remove_table(const struct cpumask
*cpumask
, bool of
);
196 void _of_init_opp_table(struct opp_table
*opp_table
, struct device
*dev
);
198 static inline void _of_init_opp_table(struct opp_table
*opp_table
, struct device
*dev
) {}
201 #ifdef CONFIG_DEBUG_FS
202 void opp_debug_remove_one(struct dev_pm_opp
*opp
);
203 int opp_debug_create_one(struct dev_pm_opp
*opp
, struct opp_table
*opp_table
);
204 int opp_debug_register(struct opp_device
*opp_dev
, struct opp_table
*opp_table
);
205 void opp_debug_unregister(struct opp_device
*opp_dev
, struct opp_table
*opp_table
);
207 static inline void opp_debug_remove_one(struct dev_pm_opp
*opp
) {}
209 static inline int opp_debug_create_one(struct dev_pm_opp
*opp
,
210 struct opp_table
*opp_table
)
212 static inline int opp_debug_register(struct opp_device
*opp_dev
,
213 struct opp_table
*opp_table
)
216 static inline void opp_debug_unregister(struct opp_device
*opp_dev
,
217 struct opp_table
*opp_table
)
219 #endif /* DEBUG_FS */
221 #endif /* __DRIVER_OPP_H__ */