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> 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> 24 25 struct clk; 26 struct regulator; 27 28 /* Lock to allow exclusive modification to the device and opp lists */ 29 extern struct mutex opp_table_lock; 30 31 extern struct list_head opp_tables; 32 33 /* 34 * Internal data structure organization with the OPP layer library is as 35 * follows: 36 * opp_tables (root) 37 * |- device 1 (represents voltage domain 1) 38 * | |- opp 1 (availability, freq, voltage) 39 * | |- opp 2 .. 40 * ... ... 41 * | `- opp n .. 42 * |- device 2 (represents the next voltage domain) 43 * ... 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. 47 */ 48 49 /** 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 55 * order. 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) 69 * 70 * This structure stores the OPP information for a given device. 71 */ 72 struct dev_pm_opp { 73 struct list_head node; 74 struct kref kref; 75 76 bool available; 77 bool dynamic; 78 bool turbo; 79 bool suspend; 80 unsigned int pstate; 81 unsigned long rate; 82 83 struct dev_pm_opp_supply *supplies; 84 85 unsigned long clock_latency_ns; 86 87 struct opp_table *opp_table; 88 89 struct device_node *np; 90 91 #ifdef CONFIG_DEBUG_FS 92 struct dentry *dentry; 93 #endif 94 }; 95 96 /** 97 * struct opp_device - devices managed by 'struct opp_table' 98 * @node: list node 99 * @dev: device to which the struct object belongs 100 * @dentry: debugfs dentry pointer (per device) 101 * 102 * This is an internal data structure maintaining the devices that are managed 103 * by 'struct opp_table'. 104 */ 105 struct opp_device { 106 struct list_head node; 107 const struct device *dev; 108 109 #ifdef CONFIG_DEBUG_FS 110 struct dentry *dentry; 111 #endif 112 }; 113 114 enum opp_table_access { 115 OPP_TABLE_ACCESS_UNKNOWN = 0, 116 OPP_TABLE_ACCESS_EXCLUSIVE = 1, 117 OPP_TABLE_ACCESS_SHARED = 2, 118 }; 119 120 /** 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 124 * table. 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 * @supported_hw: Array of version number to support. 137 * @supported_hw_count: Number of elements in supported_hw array. 138 * @prop_name: A name to postfix to many DT properties, while parsing them. 139 * @clk: Device's clock handle 140 * @regulators: Supply regulators 141 * @regulator_count: Number of power supply regulators 142 * @genpd_performance_state: Device's power domain support performance state. 143 * @set_opp: Platform specific set_opp callback 144 * @set_opp_data: Data to be passed to set_opp callback 145 * @dentry: debugfs dentry pointer of the real device directory (not links). 146 * @dentry_name: Name of the real dentry. 147 * 148 * @voltage_tolerance_v1: In percentage, for v1 bindings only. 149 * 150 * This is an internal data structure maintaining the link to opps attached to 151 * a device. This structure is not meant to be shared to users as it is 152 * meant for book keeping and private to OPP library. 153 */ 154 struct opp_table { 155 struct list_head node; 156 157 struct blocking_notifier_head head; 158 struct list_head dev_list; 159 struct list_head opp_list; 160 struct kref kref; 161 struct kref list_kref; 162 struct mutex lock; 163 164 struct device_node *np; 165 unsigned long clock_latency_ns_max; 166 167 /* For backward compatibility with v1 bindings */ 168 unsigned int voltage_tolerance_v1; 169 170 bool parsed_static_opps; 171 enum opp_table_access shared_opp; 172 struct dev_pm_opp *suspend_opp; 173 174 unsigned int *supported_hw; 175 unsigned int supported_hw_count; 176 const char *prop_name; 177 struct clk *clk; 178 struct regulator **regulators; 179 unsigned int regulator_count; 180 bool genpd_performance_state; 181 182 int (*set_opp)(struct dev_pm_set_opp_data *data); 183 struct dev_pm_set_opp_data *set_opp_data; 184 185 #ifdef CONFIG_DEBUG_FS 186 struct dentry *dentry; 187 char dentry_name[NAME_MAX]; 188 #endif 189 }; 190 191 /* Routines internal to opp core */ 192 void dev_pm_opp_get(struct dev_pm_opp *opp); 193 void _opp_remove_all_static(struct opp_table *opp_table); 194 void _get_opp_table_kref(struct opp_table *opp_table); 195 int _get_opp_count(struct opp_table *opp_table); 196 struct opp_table *_find_opp_table(struct device *dev); 197 struct opp_device *_add_opp_dev(const struct device *dev, struct opp_table *opp_table); 198 void _dev_pm_opp_find_and_remove_table(struct device *dev); 199 struct dev_pm_opp *_opp_allocate(struct opp_table *opp_table); 200 void _opp_free(struct dev_pm_opp *opp); 201 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp, struct opp_table *opp_table, bool rate_not_available); 202 int _opp_add_v1(struct opp_table *opp_table, struct device *dev, unsigned long freq, long u_volt, bool dynamic); 203 void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, int last_cpu); 204 struct opp_table *_add_opp_table(struct device *dev); 205 void _put_opp_list_kref(struct opp_table *opp_table); 206 207 #ifdef CONFIG_OF 208 void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index); 209 struct opp_table *_managed_opp(struct device *dev, int index); 210 #else 211 static inline void _of_init_opp_table(struct opp_table *opp_table, struct device *dev, int index) {} 212 static inline struct opp_table *_managed_opp(struct device *dev, int index) { return NULL; } 213 #endif 214 215 #ifdef CONFIG_DEBUG_FS 216 void opp_debug_remove_one(struct dev_pm_opp *opp); 217 int opp_debug_create_one(struct dev_pm_opp *opp, struct opp_table *opp_table); 218 int opp_debug_register(struct opp_device *opp_dev, struct opp_table *opp_table); 219 void opp_debug_unregister(struct opp_device *opp_dev, struct opp_table *opp_table); 220 #else 221 static inline void opp_debug_remove_one(struct dev_pm_opp *opp) {} 222 223 static inline int opp_debug_create_one(struct dev_pm_opp *opp, 224 struct opp_table *opp_table) 225 { return 0; } 226 static inline int opp_debug_register(struct opp_device *opp_dev, 227 struct opp_table *opp_table) 228 { return 0; } 229 230 static inline void opp_debug_unregister(struct opp_device *opp_dev, 231 struct opp_table *opp_table) 232 { } 233 #endif /* DEBUG_FS */ 234 235 #endif /* __DRIVER_OPP_H__ */ 236