1 /* 2 * consumer.h -- SoC Regulator consumer support. 3 * 4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. 5 * 6 * Author: Liam Girdwood <[email protected]> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License version 2 as 10 * published by the Free Software Foundation. 11 * 12 * Regulator Consumer Interface. 13 * 14 * A Power Management Regulator framework for SoC based devices. 15 * Features:- 16 * o Voltage and current level control. 17 * o Operating mode control. 18 * o Regulator status. 19 * o sysfs entries for showing client devices and status 20 * 21 * EXPERIMENTAL FEATURES: 22 * Dynamic Regulator operating Mode Switching (DRMS) - allows regulators 23 * to use most efficient operating mode depending upon voltage and load and 24 * is transparent to client drivers. 25 * 26 * e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during 27 * IO and 1mA at idle. Device z draws 100mA when under load and 5mA when 28 * idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA 29 * but this drops rapidly to 60% when below 100mA. Regulator r has > 90% 30 * efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate 31 * in normal mode for loads > 10mA and in IDLE mode for load <= 10mA. 32 * 33 */ 34 35 #ifndef __LINUX_REGULATOR_CONSUMER_H_ 36 #define __LINUX_REGULATOR_CONSUMER_H_ 37 38 #include <linux/device.h> 39 40 /* 41 * Regulator operating modes. 42 * 43 * Regulators can run in a variety of different operating modes depending on 44 * output load. This allows further system power savings by selecting the 45 * best (and most efficient) regulator mode for a desired load. 46 * 47 * Most drivers will only care about NORMAL. The modes below are generic and 48 * will probably not match the naming convention of your regulator data sheet 49 * but should match the use cases in the datasheet. 50 * 51 * In order of power efficiency (least efficient at top). 52 * 53 * Mode Description 54 * FAST Regulator can handle fast changes in it's load. 55 * e.g. useful in CPU voltage & frequency scaling where 56 * load can quickly increase with CPU frequency increases. 57 * 58 * NORMAL Normal regulator power supply mode. Most drivers will 59 * use this mode. 60 * 61 * IDLE Regulator runs in a more efficient mode for light 62 * loads. Can be used for devices that have a low power 63 * requirement during periods of inactivity. This mode 64 * may be more noisy than NORMAL and may not be able 65 * to handle fast load switching. 66 * 67 * STANDBY Regulator runs in the most efficient mode for very 68 * light loads. Can be used by devices when they are 69 * in a sleep/standby state. This mode is likely to be 70 * the most noisy and may not be able to handle fast load 71 * switching. 72 * 73 * NOTE: Most regulators will only support a subset of these modes. Some 74 * will only just support NORMAL. 75 * 76 * These modes can be OR'ed together to make up a mask of valid register modes. 77 */ 78 79 #define REGULATOR_MODE_FAST 0x1 80 #define REGULATOR_MODE_NORMAL 0x2 81 #define REGULATOR_MODE_IDLE 0x4 82 #define REGULATOR_MODE_STANDBY 0x8 83 84 /* 85 * Regulator notifier events. 86 * 87 * UNDER_VOLTAGE Regulator output is under voltage. 88 * OVER_CURRENT Regulator output current is too high. 89 * REGULATION_OUT Regulator output is out of regulation. 90 * FAIL Regulator output has failed. 91 * OVER_TEMP Regulator over temp. 92 * FORCE_DISABLE Regulator forcibly shut down by software. 93 * VOLTAGE_CHANGE Regulator voltage changed. 94 * DISABLE Regulator was disabled. 95 * 96 * NOTE: These events can be OR'ed together when passed into handler. 97 */ 98 99 #define REGULATOR_EVENT_UNDER_VOLTAGE 0x01 100 #define REGULATOR_EVENT_OVER_CURRENT 0x02 101 #define REGULATOR_EVENT_REGULATION_OUT 0x04 102 #define REGULATOR_EVENT_FAIL 0x08 103 #define REGULATOR_EVENT_OVER_TEMP 0x10 104 #define REGULATOR_EVENT_FORCE_DISABLE 0x20 105 #define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40 106 #define REGULATOR_EVENT_DISABLE 0x80 107 108 struct regulator; 109 110 /** 111 * struct regulator_bulk_data - Data used for bulk regulator operations. 112 * 113 * @supply: The name of the supply. Initialised by the user before 114 * using the bulk regulator APIs. 115 * @consumer: The regulator consumer for the supply. This will be managed 116 * by the bulk API. 117 * 118 * The regulator APIs provide a series of regulator_bulk_() API calls as 119 * a convenience to consumers which require multiple supplies. This 120 * structure is used to manage data for these calls. 121 */ 122 struct regulator_bulk_data { 123 const char *supply; 124 struct regulator *consumer; 125 126 /* private: Internal use */ 127 int ret; 128 }; 129 130 #if defined(CONFIG_REGULATOR) 131 132 /* regulator get and put */ 133 struct regulator *__must_check regulator_get(struct device *dev, 134 const char *id); 135 struct regulator *__must_check regulator_get_exclusive(struct device *dev, 136 const char *id); 137 void regulator_put(struct regulator *regulator); 138 139 /* regulator output control and status */ 140 int regulator_enable(struct regulator *regulator); 141 int regulator_disable(struct regulator *regulator); 142 int regulator_force_disable(struct regulator *regulator); 143 int regulator_is_enabled(struct regulator *regulator); 144 int regulator_disable_deferred(struct regulator *regulator, int ms); 145 146 int regulator_bulk_get(struct device *dev, int num_consumers, 147 struct regulator_bulk_data *consumers); 148 int regulator_bulk_enable(int num_consumers, 149 struct regulator_bulk_data *consumers); 150 int regulator_bulk_disable(int num_consumers, 151 struct regulator_bulk_data *consumers); 152 int regulator_bulk_force_disable(int num_consumers, 153 struct regulator_bulk_data *consumers); 154 void regulator_bulk_free(int num_consumers, 155 struct regulator_bulk_data *consumers); 156 157 int regulator_count_voltages(struct regulator *regulator); 158 int regulator_list_voltage(struct regulator *regulator, unsigned selector); 159 int regulator_is_supported_voltage(struct regulator *regulator, 160 int min_uV, int max_uV); 161 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV); 162 int regulator_set_voltage_time(struct regulator *regulator, 163 int old_uV, int new_uV); 164 int regulator_get_voltage(struct regulator *regulator); 165 int regulator_sync_voltage(struct regulator *regulator); 166 int regulator_set_current_limit(struct regulator *regulator, 167 int min_uA, int max_uA); 168 int regulator_get_current_limit(struct regulator *regulator); 169 170 int regulator_set_mode(struct regulator *regulator, unsigned int mode); 171 unsigned int regulator_get_mode(struct regulator *regulator); 172 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA); 173 174 /* regulator notifier block */ 175 int regulator_register_notifier(struct regulator *regulator, 176 struct notifier_block *nb); 177 int regulator_unregister_notifier(struct regulator *regulator, 178 struct notifier_block *nb); 179 180 /* driver data - core doesn't touch */ 181 void *regulator_get_drvdata(struct regulator *regulator); 182 void regulator_set_drvdata(struct regulator *regulator, void *data); 183 184 #else 185 186 /* 187 * Make sure client drivers will still build on systems with no software 188 * controllable voltage or current regulators. 189 */ 190 static inline struct regulator *__must_check regulator_get(struct device *dev, 191 const char *id) 192 { 193 /* Nothing except the stubbed out regulator API should be 194 * looking at the value except to check if it is an error 195 * value. Drivers are free to handle NULL specifically by 196 * skipping all regulator API calls, but they don't have to. 197 * Drivers which don't, should make sure they properly handle 198 * corner cases of the API, such as regulator_get_voltage() 199 * returning 0. 200 */ 201 return NULL; 202 } 203 static inline void regulator_put(struct regulator *regulator) 204 { 205 } 206 207 static inline int regulator_enable(struct regulator *regulator) 208 { 209 return 0; 210 } 211 212 static inline int regulator_disable(struct regulator *regulator) 213 { 214 return 0; 215 } 216 217 static inline int regulator_force_disable(struct regulator *regulator) 218 { 219 return 0; 220 } 221 222 static inline int regulator_disable_deferred(struct regulator *regulator, 223 int ms) 224 { 225 return 0; 226 } 227 228 static inline int regulator_is_enabled(struct regulator *regulator) 229 { 230 return 1; 231 } 232 233 static inline int regulator_bulk_get(struct device *dev, 234 int num_consumers, 235 struct regulator_bulk_data *consumers) 236 { 237 return 0; 238 } 239 240 static inline int regulator_bulk_enable(int num_consumers, 241 struct regulator_bulk_data *consumers) 242 { 243 return 0; 244 } 245 246 static inline int regulator_bulk_disable(int num_consumers, 247 struct regulator_bulk_data *consumers) 248 { 249 return 0; 250 } 251 252 static inline int regulator_bulk_force_disable(int num_consumers, 253 struct regulator_bulk_data *consumers) 254 { 255 return 0; 256 } 257 258 static inline void regulator_bulk_free(int num_consumers, 259 struct regulator_bulk_data *consumers) 260 { 261 } 262 263 static inline int regulator_set_voltage(struct regulator *regulator, 264 int min_uV, int max_uV) 265 { 266 return 0; 267 } 268 269 static inline int regulator_get_voltage(struct regulator *regulator) 270 { 271 return 0; 272 } 273 274 static inline int regulator_set_current_limit(struct regulator *regulator, 275 int min_uA, int max_uA) 276 { 277 return 0; 278 } 279 280 static inline int regulator_get_current_limit(struct regulator *regulator) 281 { 282 return 0; 283 } 284 285 static inline int regulator_set_mode(struct regulator *regulator, 286 unsigned int mode) 287 { 288 return 0; 289 } 290 291 static inline unsigned int regulator_get_mode(struct regulator *regulator) 292 { 293 return REGULATOR_MODE_NORMAL; 294 } 295 296 static inline int regulator_set_optimum_mode(struct regulator *regulator, 297 int load_uA) 298 { 299 return REGULATOR_MODE_NORMAL; 300 } 301 302 static inline int regulator_register_notifier(struct regulator *regulator, 303 struct notifier_block *nb) 304 { 305 return 0; 306 } 307 308 static inline int regulator_unregister_notifier(struct regulator *regulator, 309 struct notifier_block *nb) 310 { 311 return 0; 312 } 313 314 static inline void *regulator_get_drvdata(struct regulator *regulator) 315 { 316 return NULL; 317 } 318 319 static inline void regulator_set_drvdata(struct regulator *regulator, 320 void *data) 321 { 322 } 323 324 #endif 325 326 #endif 327