1 /* 2 * driver.h -- SoC Regulator driver support. 3 * 4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. 5 * 6 * Author: Liam Girdwood <lrg@slimlogic.co.uk> 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 Driver Interface. 13 */ 14 15 #ifndef __LINUX_REGULATOR_DRIVER_H_ 16 #define __LINUX_REGULATOR_DRIVER_H_ 17 18 #include <linux/device.h> 19 #include <linux/notifier.h> 20 #include <linux/regulator/consumer.h> 21 22 struct regmap; 23 struct regulator_dev; 24 struct regulator_init_data; 25 26 enum regulator_status { 27 REGULATOR_STATUS_OFF, 28 REGULATOR_STATUS_ON, 29 REGULATOR_STATUS_ERROR, 30 /* fast/normal/idle/standby are flavors of "on" */ 31 REGULATOR_STATUS_FAST, 32 REGULATOR_STATUS_NORMAL, 33 REGULATOR_STATUS_IDLE, 34 REGULATOR_STATUS_STANDBY, 35 /* The regulator is enabled but not regulating */ 36 REGULATOR_STATUS_BYPASS, 37 /* in case that any other status doesn't apply */ 38 REGULATOR_STATUS_UNDEFINED, 39 }; 40 41 /** 42 * struct regulator_ops - regulator operations. 43 * 44 * @enable: Configure the regulator as enabled. 45 * @disable: Configure the regulator as disabled. 46 * @is_enabled: Return 1 if the regulator is enabled, 0 if not. 47 * May also return negative errno. 48 * 49 * @set_voltage: Set the voltage for the regulator within the range specified. 50 * The driver should select the voltage closest to min_uV. 51 * @set_voltage_sel: Set the voltage for the regulator using the specified 52 * selector. 53 * @map_voltage: Convert a voltage into a selector 54 * @get_voltage: Return the currently configured voltage for the regulator. 55 * @get_voltage_sel: Return the currently configured voltage selector for the 56 * regulator. 57 * @list_voltage: Return one of the supported voltages, in microvolts; zero 58 * if the selector indicates a voltage that is unusable on this system; 59 * or negative errno. Selectors range from zero to one less than 60 * regulator_desc.n_voltages. Voltages may be reported in any order. 61 * 62 * @set_current_limit: Configure a limit for a current-limited regulator. 63 * The driver should select the current closest to max_uA. 64 * @get_current_limit: Get the configured limit for a current-limited regulator. 65 * 66 * @set_mode: Set the configured operating mode for the regulator. 67 * @get_mode: Get the configured operating mode for the regulator. 68 * @get_status: Return actual (not as-configured) status of regulator, as a 69 * REGULATOR_STATUS value (or negative errno) 70 * @get_optimum_mode: Get the most efficient operating mode for the regulator 71 * when running with the specified parameters. 72 * 73 * @set_bypass: Set the regulator in bypass mode. 74 * @get_bypass: Get the regulator bypass mode state. 75 * 76 * @enable_time: Time taken for the regulator voltage output voltage to 77 * stabilise after being enabled, in microseconds. 78 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should 79 * select ramp delay equal to or less than(closest) ramp_delay. 80 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage 81 * to stabilise after being set to a new value, in microseconds. 82 * The function provides the from and to voltage selector, the 83 * function should return the worst case. 84 * 85 * @set_suspend_voltage: Set the voltage for the regulator when the system 86 * is suspended. 87 * @set_suspend_enable: Mark the regulator as enabled when the system is 88 * suspended. 89 * @set_suspend_disable: Mark the regulator as disabled when the system is 90 * suspended. 91 * @set_suspend_mode: Set the operating mode for the regulator when the 92 * system is suspended. 93 * 94 * This struct describes regulator operations which can be implemented by 95 * regulator chip drivers. 96 */ 97 struct regulator_ops { 98 99 /* enumerate supported voltages */ 100 int (*list_voltage) (struct regulator_dev *, unsigned selector); 101 102 /* get/set regulator voltage */ 103 int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, 104 unsigned *selector); 105 int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV); 106 int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); 107 int (*get_voltage) (struct regulator_dev *); 108 int (*get_voltage_sel) (struct regulator_dev *); 109 110 /* get/set regulator current */ 111 int (*set_current_limit) (struct regulator_dev *, 112 int min_uA, int max_uA); 113 int (*get_current_limit) (struct regulator_dev *); 114 115 /* enable/disable regulator */ 116 int (*enable) (struct regulator_dev *); 117 int (*disable) (struct regulator_dev *); 118 int (*is_enabled) (struct regulator_dev *); 119 120 /* get/set regulator operating mode (defined in consumer.h) */ 121 int (*set_mode) (struct regulator_dev *, unsigned int mode); 122 unsigned int (*get_mode) (struct regulator_dev *); 123 124 /* Time taken to enable or set voltage on the regulator */ 125 int (*enable_time) (struct regulator_dev *); 126 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay); 127 int (*set_voltage_time_sel) (struct regulator_dev *, 128 unsigned int old_selector, 129 unsigned int new_selector); 130 131 /* report regulator status ... most other accessors report 132 * control inputs, this reports results of combining inputs 133 * from Linux (and other sources) with the actual load. 134 * returns REGULATOR_STATUS_* or negative errno. 135 */ 136 int (*get_status)(struct regulator_dev *); 137 138 /* get most efficient regulator operating mode for load */ 139 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, 140 int output_uV, int load_uA); 141 142 /* control and report on bypass mode */ 143 int (*set_bypass)(struct regulator_dev *dev, bool enable); 144 int (*get_bypass)(struct regulator_dev *dev, bool *enable); 145 146 /* the operations below are for configuration of regulator state when 147 * its parent PMIC enters a global STANDBY/HIBERNATE state */ 148 149 /* set regulator suspend voltage */ 150 int (*set_suspend_voltage) (struct regulator_dev *, int uV); 151 152 /* enable/disable regulator in suspend state */ 153 int (*set_suspend_enable) (struct regulator_dev *); 154 int (*set_suspend_disable) (struct regulator_dev *); 155 156 /* set regulator suspend operating mode (defined in consumer.h) */ 157 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); 158 }; 159 160 /* 161 * Regulators can either control voltage or current. 162 */ 163 enum regulator_type { 164 REGULATOR_VOLTAGE, 165 REGULATOR_CURRENT, 166 }; 167 168 /** 169 * struct regulator_desc - Static regulator descriptor 170 * 171 * Each regulator registered with the core is described with a 172 * structure of this type and a struct regulator_config. This 173 * structure contains the non-varying parts of the regulator 174 * description. 175 * 176 * @name: Identifying name for the regulator. 177 * @supply_name: Identifying the regulator supply 178 * @id: Numerical identifier for the regulator. 179 * @ops: Regulator operations table. 180 * @irq: Interrupt number for the regulator. 181 * @type: Indicates if the regulator is a voltage or current regulator. 182 * @owner: Module providing the regulator, used for refcounting. 183 * 184 * @n_voltages: Number of selectors available for ops.list_voltage(). 185 * 186 * @min_uV: Voltage given by the lowest selector (if linear mapping) 187 * @uV_step: Voltage increase with each selector (if linear mapping) 188 * @ramp_delay: Time to settle down after voltage change (unit: uV/us) 189 * @volt_table: Voltage mapping table (if table based mapping) 190 * 191 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_ 192 * @vsel_mask: Mask for register bitfield used for selector 193 * @enable_reg: Register for control when using regmap enable/disable ops 194 * @enable_mask: Mask for control when using regmap enable/disable ops 195 * 196 * @enable_time: Time taken for initial enable of regulator (in uS). 197 */ 198 struct regulator_desc { 199 const char *name; 200 const char *supply_name; 201 int id; 202 unsigned n_voltages; 203 struct regulator_ops *ops; 204 int irq; 205 enum regulator_type type; 206 struct module *owner; 207 208 unsigned int min_uV; 209 unsigned int uV_step; 210 unsigned int ramp_delay; 211 212 const unsigned int *volt_table; 213 214 unsigned int vsel_reg; 215 unsigned int vsel_mask; 216 unsigned int enable_reg; 217 unsigned int enable_mask; 218 unsigned int bypass_reg; 219 unsigned int bypass_mask; 220 221 unsigned int enable_time; 222 }; 223 224 /** 225 * struct regulator_config - Dynamic regulator descriptor 226 * 227 * Each regulator registered with the core is described with a 228 * structure of this type and a struct regulator_desc. This structure 229 * contains the runtime variable parts of the regulator description. 230 * 231 * @dev: struct device for the regulator 232 * @init_data: platform provided init data, passed through by driver 233 * @driver_data: private regulator data 234 * @of_node: OpenFirmware node to parse for device tree bindings (may be 235 * NULL). 236 * @regmap: regmap to use for core regmap helpers if dev_get_regulator() is 237 * insufficient. 238 * @ena_gpio: GPIO controlling regulator enable. 239 * @ena_gpio_invert: Sense for GPIO enable control. 240 * @ena_gpio_flags: Flags to use when calling gpio_request_one() 241 */ 242 struct regulator_config { 243 struct device *dev; 244 const struct regulator_init_data *init_data; 245 void *driver_data; 246 struct device_node *of_node; 247 struct regmap *regmap; 248 249 int ena_gpio; 250 unsigned int ena_gpio_invert:1; 251 unsigned int ena_gpio_flags; 252 }; 253 254 /* 255 * struct regulator_dev 256 * 257 * Voltage / Current regulator class device. One for each 258 * regulator. 259 * 260 * This should *not* be used directly by anything except the regulator 261 * core and notification injection (which should take the mutex and do 262 * no other direct access). 263 */ 264 struct regulator_dev { 265 const struct regulator_desc *desc; 266 int exclusive; 267 u32 use_count; 268 u32 open_count; 269 u32 bypass_count; 270 271 /* lists we belong to */ 272 struct list_head list; /* list of all regulators */ 273 274 /* lists we own */ 275 struct list_head consumer_list; /* consumers we supply */ 276 277 struct blocking_notifier_head notifier; 278 struct mutex mutex; /* consumer lock */ 279 struct module *owner; 280 struct device dev; 281 struct regulation_constraints *constraints; 282 struct regulator *supply; /* for tree */ 283 struct regmap *regmap; 284 285 struct delayed_work disable_work; 286 int deferred_disables; 287 288 void *reg_data; /* regulator_dev data */ 289 290 struct dentry *debugfs; 291 292 int ena_gpio; 293 unsigned int ena_gpio_invert:1; 294 unsigned int ena_gpio_state:1; 295 }; 296 297 struct regulator_dev * 298 regulator_register(const struct regulator_desc *regulator_desc, 299 const struct regulator_config *config); 300 void regulator_unregister(struct regulator_dev *rdev); 301 302 int regulator_notifier_call_chain(struct regulator_dev *rdev, 303 unsigned long event, void *data); 304 305 void *rdev_get_drvdata(struct regulator_dev *rdev); 306 struct device *rdev_get_dev(struct regulator_dev *rdev); 307 int rdev_get_id(struct regulator_dev *rdev); 308 309 int regulator_mode_to_status(unsigned int); 310 311 int regulator_list_voltage_linear(struct regulator_dev *rdev, 312 unsigned int selector); 313 int regulator_list_voltage_table(struct regulator_dev *rdev, 314 unsigned int selector); 315 int regulator_map_voltage_linear(struct regulator_dev *rdev, 316 int min_uV, int max_uV); 317 int regulator_map_voltage_iterate(struct regulator_dev *rdev, 318 int min_uV, int max_uV); 319 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); 320 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); 321 int regulator_is_enabled_regmap(struct regulator_dev *rdev); 322 int regulator_enable_regmap(struct regulator_dev *rdev); 323 int regulator_disable_regmap(struct regulator_dev *rdev); 324 int regulator_set_voltage_time_sel(struct regulator_dev *rdev, 325 unsigned int old_selector, 326 unsigned int new_selector); 327 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable); 328 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable); 329 330 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); 331 332 #endif 333