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/kref.h>
20 #include <linux/list.h>
21 #include <linux/limits.h>
22 #include <linux/pm_opp.h>
23 #include <linux/notifier.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 * IMPORTANT: the opp nodes should be maintained in increasing
56 * @kref: for reference count of the OPP.
57 * @available: true/false - marks if this OPP as available or not
58 * @dynamic: not-created from static DT entries.
59 * @turbo: true if turbo (boost) OPP
60 * @suspend: true if suspend OPP
61 * @pstate: Device's power domain's performance state.
62 * @rate: Frequency in hertz
63 * @supplies: Power supplies voltage/current values
64 * @clock_latency_ns: Latency (in nanoseconds) of switching to this OPP's
65 * frequency from any other OPP's frequency.
66 * @opp_table: points back to the opp_table struct this opp belongs to
67 * @np: OPP's device node.
68 * @dentry: debugfs dentry pointer (per opp)
70 * This structure stores the OPP information for a given device.
73 struct list_head node;
83 struct dev_pm_opp_supply *supplies;
85 unsigned long clock_latency_ns;
87 struct opp_table *opp_table;
89 struct device_node *np;
91 #ifdef CONFIG_DEBUG_FS
92 struct dentry *dentry;
97 * struct opp_device - devices managed by 'struct opp_table'
99 * @dev: device to which the struct object belongs
100 * @dentry: debugfs dentry pointer (per device)
102 * This is an internal data structure maintaining the devices that are managed
103 * by 'struct opp_table'.
106 struct list_head node;
107 const struct device *dev;
109 #ifdef CONFIG_DEBUG_FS
110 struct dentry *dentry;
114 enum opp_table_access {
115 OPP_TABLE_ACCESS_UNKNOWN = 0,
116 OPP_TABLE_ACCESS_EXCLUSIVE = 1,
117 OPP_TABLE_ACCESS_SHARED = 2,
121 * struct opp_table - Device opp structure
122 * @node: table node - contains the devices with OPPs that
123 * have been registered. Nodes once added are not modified in this
125 * @head: notifier head to notify the OPP availability changes.
126 * @dev_list: list of devices that share these OPPs
127 * @opp_list: table of opps
128 * @kref: for reference count of the table.
129 * @list_kref: for reference count of the OPP list.
130 * @lock: mutex protecting the opp_list and dev_list.
131 * @np: struct device_node pointer for opp's DT node.
132 * @clock_latency_ns_max: Max clock latency in nanoseconds.
133 * @parsed_static_opps: True if OPPs are initialized from DT.
134 * @shared_opp: OPP is shared between multiple devices.
135 * @suspend_opp: Pointer to OPP to be used during device suspend.
136 * @required_opp_tables: List of device OPP tables that are required by OPPs in
138 * @required_opp_count: Number of required devices.
139 * @supported_hw: Array of version number to support.
140 * @supported_hw_count: Number of elements in supported_hw array.
141 * @prop_name: A name to postfix to many DT properties, while parsing them.
142 * @clk: Device's clock handle
143 * @regulators: Supply regulators
144 * @regulator_count: Number of power supply regulators
145 * @genpd_performance_state: Device's power domain support performance state.
146 * @is_genpd: Marks if the OPP table belongs to a genpd.
147 * @set_opp: Platform specific set_opp callback
148 * @set_opp_data: Data to be passed to set_opp callback
149 * @dentry: debugfs dentry pointer of the real device directory (not links).
150 * @dentry_name: Name of the real dentry.
152 * @voltage_tolerance_v1: In percentage, for v1 bindings only.
154 * This is an internal data structure maintaining the link to opps attached to
155 * a device. This structure is not meant to be shared to users as it is
156 * meant for book keeping and private to OPP library.
159 struct list_head node;
161 struct blocking_notifier_head head;
162 struct list_head dev_list;
163 struct list_head opp_list;
165 struct kref list_kref;
168 struct device_node *np;
169 unsigned long clock_latency_ns_max;
171 /* For backward compatibility with v1 bindings */
172 unsigned int voltage_tolerance_v1;
174 bool parsed_static_opps;
175 enum opp_table_access shared_opp;
176 struct dev_pm_opp *suspend_opp;
178 struct opp_table **required_opp_tables;
179 unsigned int required_opp_count;
181 unsigned int *supported_hw;
182 unsigned int supported_hw_count;
183 const char *prop_name;
185 struct regulator **regulators;
186 unsigned int regulator_count;
187 bool genpd_performance_state;
190 int (*set_opp)(struct dev_pm_set_opp_data *data);
191 struct dev_pm_set_opp_data *set_opp_data;
193 #ifdef CONFIG_DEBUG_FS
194 struct dentry *dentry;
195 char dentry_name[NAME_MAX];
199 /* Routines internal to opp core */
200 void dev_pm_opp_get(struct dev_pm_opp *opp);
201 void _opp_remove_all_static(struct opp_table *opp_table);
202 void _get_opp_table_kref(struct opp_table *opp_table);
203 int _get_opp_count(struct opp_table *opp_table);
204 struct opp_table *_find_opp_table(struct device *dev);
205 struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table);
206 void _dev_pm_opp_find_and_remove_table(struct device *dev);
207 struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table);
208 void _opp_free(struct dev_pm_opp *opp);
209 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table, bool rate_not_available);
210 int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic);
211 void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu);
212 struct opp_table *_add_opp_table(struct device *dev);
213 void _put_opp_list_kref(struct opp_table *opp_table);
216 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index);
217 void _of_clear_opp_table(struct opp_table *opp_table);
218 struct opp_table *_managed_opp(struct device *dev, int index);
220 static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {}
221 static inline void _of_clear_opp_table(struct opp_table *opp_table) {}
222 static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; }
225 #ifdef CONFIG_DEBUG_FS
226 void opp_debug_remove_one(struct dev_pm_opp *opp);
227 int opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table);
228 int opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table);
229 void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table);
231 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {}
233 static inline int opp_debug_create_one(struct dev_pm_opp *opp,
234 struct opp_table *opp_table)
236 static inline int opp_debug_register(struct opp_device *opp_dev,
237 struct opp_table *opp_table)
240 static inline void opp_debug_unregister(struct opp_device *opp_dev,
241 struct opp_table *opp_table)
243 #endif /* DEBUG_FS */
245 #endif /* __DRIVER_OPP_H__ */