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 22struct regmap; 23struct regulator_dev; 24struct regulator_config; 25struct regulator_init_data; 26struct regulator_enable_gpio; 27 28enum regulator_status { 29 REGULATOR_STATUS_OFF, 30 REGULATOR_STATUS_ON, 31 REGULATOR_STATUS_ERROR, 32 /* fast/normal/idle/standby are flavors of "on" */ 33 REGULATOR_STATUS_FAST, 34 REGULATOR_STATUS_NORMAL, 35 REGULATOR_STATUS_IDLE, 36 REGULATOR_STATUS_STANDBY, 37 /* The regulator is enabled but not regulating */ 38 REGULATOR_STATUS_BYPASS, 39 /* in case that any other status doesn't apply */ 40 REGULATOR_STATUS_UNDEFINED, 41}; 42 43/** 44 * struct regulator_linear_range - specify linear voltage ranges 45 * 46 * Specify a range of voltages for regulator_map_linar_range() and 47 * regulator_list_linear_range(). 48 * 49 * @min_uV: Lowest voltage in range 50 * @min_sel: Lowest selector for range 51 * @max_sel: Highest selector for range 52 * @uV_step: Step size 53 */ 54struct regulator_linear_range { 55 unsigned int min_uV; 56 unsigned int min_sel; 57 unsigned int max_sel; 58 unsigned int uV_step; 59}; 60 61/* Initialize struct regulator_linear_range */ 62#define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \ 63{ \ 64 .min_uV = _min_uV, \ 65 .min_sel = _min_sel, \ 66 .max_sel = _max_sel, \ 67 .uV_step = _step_uV, \ 68} 69 70/** 71 * struct regulator_ops - regulator operations. 72 * 73 * @enable: Configure the regulator as enabled. 74 * @disable: Configure the regulator as disabled. 75 * @is_enabled: Return 1 if the regulator is enabled, 0 if not. 76 * May also return negative errno. 77 * 78 * @set_voltage: Set the voltage for the regulator within the range specified. 79 * The driver should select the voltage closest to min_uV. 80 * @set_voltage_sel: Set the voltage for the regulator using the specified 81 * selector. 82 * @map_voltage: Convert a voltage into a selector 83 * @get_voltage: Return the currently configured voltage for the regulator. 84 * @get_voltage_sel: Return the currently configured voltage selector for the 85 * regulator. 86 * @list_voltage: Return one of the supported voltages, in microvolts; zero 87 * if the selector indicates a voltage that is unusable on this system; 88 * or negative errno. Selectors range from zero to one less than 89 * regulator_desc.n_voltages. Voltages may be reported in any order. 90 * 91 * @set_current_limit: Configure a limit for a current-limited regulator. 92 * The driver should select the current closest to max_uA. 93 * @get_current_limit: Get the configured limit for a current-limited regulator. 94 * 95 * @set_mode: Set the configured operating mode for the regulator. 96 * @get_mode: Get the configured operating mode for the regulator. 97 * @get_status: Return actual (not as-configured) status of regulator, as a 98 * REGULATOR_STATUS value (or negative errno) 99 * @get_optimum_mode: Get the most efficient operating mode for the regulator 100 * when running with the specified parameters. 101 * @set_load: Set the load for the regulator. 102 * 103 * @set_bypass: Set the regulator in bypass mode. 104 * @get_bypass: Get the regulator bypass mode state. 105 * 106 * @enable_time: Time taken for the regulator voltage output voltage to 107 * stabilise after being enabled, in microseconds. 108 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should 109 * select ramp delay equal to or less than(closest) ramp_delay. 110 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage 111 * to stabilise after being set to a new value, in microseconds. 112 * The function provides the from and to voltage selector, the 113 * function should return the worst case. 114 * 115 * @set_suspend_voltage: Set the voltage for the regulator when the system 116 * is suspended. 117 * @set_suspend_enable: Mark the regulator as enabled when the system is 118 * suspended. 119 * @set_suspend_disable: Mark the regulator as disabled when the system is 120 * suspended. 121 * @set_suspend_mode: Set the operating mode for the regulator when the 122 * system is suspended. 123 * 124 * This struct describes regulator operations which can be implemented by 125 * regulator chip drivers. 126 */ 127struct regulator_ops { 128 129 /* enumerate supported voltages */ 130 int (*list_voltage) (struct regulator_dev *, unsigned selector); 131 132 /* get/set regulator voltage */ 133 int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, 134 unsigned *selector); 135 int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV); 136 int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); 137 int (*get_voltage) (struct regulator_dev *); 138 int (*get_voltage_sel) (struct regulator_dev *); 139 140 /* get/set regulator current */ 141 int (*set_current_limit) (struct regulator_dev *, 142 int min_uA, int max_uA); 143 int (*get_current_limit) (struct regulator_dev *); 144 145 /* enable/disable regulator */ 146 int (*enable) (struct regulator_dev *); 147 int (*disable) (struct regulator_dev *); 148 int (*is_enabled) (struct regulator_dev *); 149 150 /* get/set regulator operating mode (defined in consumer.h) */ 151 int (*set_mode) (struct regulator_dev *, unsigned int mode); 152 unsigned int (*get_mode) (struct regulator_dev *); 153 154 /* Time taken to enable or set voltage on the regulator */ 155 int (*enable_time) (struct regulator_dev *); 156 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay); 157 int (*set_voltage_time_sel) (struct regulator_dev *, 158 unsigned int old_selector, 159 unsigned int new_selector); 160 161 /* report regulator status ... most other accessors report 162 * control inputs, this reports results of combining inputs 163 * from Linux (and other sources) with the actual load. 164 * returns REGULATOR_STATUS_* or negative errno. 165 */ 166 int (*get_status)(struct regulator_dev *); 167 168 /* get most efficient regulator operating mode for load */ 169 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, 170 int output_uV, int load_uA); 171 /* set the load on the regulator */ 172 int (*set_load)(struct regulator_dev *, int load_uA); 173 174 /* control and report on bypass mode */ 175 int (*set_bypass)(struct regulator_dev *dev, bool enable); 176 int (*get_bypass)(struct regulator_dev *dev, bool *enable); 177 178 /* the operations below are for configuration of regulator state when 179 * its parent PMIC enters a global STANDBY/HIBERNATE state */ 180 181 /* set regulator suspend voltage */ 182 int (*set_suspend_voltage) (struct regulator_dev *, int uV); 183 184 /* enable/disable regulator in suspend state */ 185 int (*set_suspend_enable) (struct regulator_dev *); 186 int (*set_suspend_disable) (struct regulator_dev *); 187 188 /* set regulator suspend operating mode (defined in consumer.h) */ 189 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); 190}; 191 192/* 193 * Regulators can either control voltage or current. 194 */ 195enum regulator_type { 196 REGULATOR_VOLTAGE, 197 REGULATOR_CURRENT, 198}; 199 200/** 201 * struct regulator_desc - Static regulator descriptor 202 * 203 * Each regulator registered with the core is described with a 204 * structure of this type and a struct regulator_config. This 205 * structure contains the non-varying parts of the regulator 206 * description. 207 * 208 * @name: Identifying name for the regulator. 209 * @supply_name: Identifying the regulator supply 210 * @of_match: Name used to identify regulator in DT. 211 * @regulators_node: Name of node containing regulator definitions in DT. 212 * @of_parse_cb: Optional callback called only if of_match is present. 213 * Will be called for each regulator parsed from DT, during 214 * init_data parsing. 215 * The regulator_config passed as argument to the callback will 216 * be a copy of config passed to regulator_register, valid only 217 * for this particular call. Callback may freely change the 218 * config but it cannot store it for later usage. 219 * Callback should return 0 on success or negative ERRNO 220 * indicating failure. 221 * @id: Numerical identifier for the regulator. 222 * @ops: Regulator operations table. 223 * @irq: Interrupt number for the regulator. 224 * @type: Indicates if the regulator is a voltage or current regulator. 225 * @owner: Module providing the regulator, used for refcounting. 226 * 227 * @continuous_voltage_range: Indicates if the regulator can set any 228 * voltage within constrains range. 229 * @n_voltages: Number of selectors available for ops.list_voltage(). 230 * 231 * @min_uV: Voltage given by the lowest selector (if linear mapping) 232 * @uV_step: Voltage increase with each selector (if linear mapping) 233 * @linear_min_sel: Minimal selector for starting linear mapping 234 * @fixed_uV: Fixed voltage of rails. 235 * @ramp_delay: Time to settle down after voltage change (unit: uV/us) 236 * @linear_ranges: A constant table of possible voltage ranges. 237 * @n_linear_ranges: Number of entries in the @linear_ranges table. 238 * @volt_table: Voltage mapping table (if table based mapping) 239 * 240 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_ 241 * @vsel_mask: Mask for register bitfield used for selector 242 * @apply_reg: Register for initiate voltage change on the output when 243 * using regulator_set_voltage_sel_regmap 244 * @apply_bit: Register bitfield used for initiate voltage change on the 245 * output when using regulator_set_voltage_sel_regmap 246 * @enable_reg: Register for control when using regmap enable/disable ops 247 * @enable_mask: Mask for control when using regmap enable/disable ops 248 * @enable_val: Enabling value for control when using regmap enable/disable ops 249 * @disable_val: Disabling value for control when using regmap enable/disable ops 250 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable 251 * when using regulator_enable_regmap and friends APIs. 252 * @bypass_reg: Register for control when using regmap set_bypass 253 * @bypass_mask: Mask for control when using regmap set_bypass 254 * @bypass_val_on: Enabling value for control when using regmap set_bypass 255 * @bypass_val_off: Disabling value for control when using regmap set_bypass 256 * 257 * @enable_time: Time taken for initial enable of regulator (in uS). 258 * @off_on_delay: guard time (in uS), before re-enabling a regulator 259 * 260 * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode 261 */ 262struct regulator_desc { 263 const char *name; 264 const char *supply_name; 265 const char *of_match; 266 const char *regulators_node; 267 int (*of_parse_cb)(struct device_node *, 268 const struct regulator_desc *, 269 struct regulator_config *); 270 int id; 271 bool continuous_voltage_range; 272 unsigned n_voltages; 273 const struct regulator_ops *ops; 274 int irq; 275 enum regulator_type type; 276 struct module *owner; 277 278 unsigned int min_uV; 279 unsigned int uV_step; 280 unsigned int linear_min_sel; 281 int fixed_uV; 282 unsigned int ramp_delay; 283 284 const struct regulator_linear_range *linear_ranges; 285 int n_linear_ranges; 286 287 const unsigned int *volt_table; 288 289 unsigned int vsel_reg; 290 unsigned int vsel_mask; 291 unsigned int apply_reg; 292 unsigned int apply_bit; 293 unsigned int enable_reg; 294 unsigned int enable_mask; 295 unsigned int enable_val; 296 unsigned int disable_val; 297 bool enable_is_inverted; 298 unsigned int bypass_reg; 299 unsigned int bypass_mask; 300 unsigned int bypass_val_on; 301 unsigned int bypass_val_off; 302 303 unsigned int enable_time; 304 305 unsigned int off_on_delay; 306 307 unsigned int (*of_map_mode)(unsigned int mode); 308}; 309 310/** 311 * struct regulator_config - Dynamic regulator descriptor 312 * 313 * Each regulator registered with the core is described with a 314 * structure of this type and a struct regulator_desc. This structure 315 * contains the runtime variable parts of the regulator description. 316 * 317 * @dev: struct device for the regulator 318 * @init_data: platform provided init data, passed through by driver 319 * @driver_data: private regulator data 320 * @of_node: OpenFirmware node to parse for device tree bindings (may be 321 * NULL). 322 * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is 323 * insufficient. 324 * @ena_gpio_initialized: GPIO controlling regulator enable was properly 325 * initialized, meaning that >= 0 is a valid gpio 326 * identifier and < 0 is a non existent gpio. 327 * @ena_gpio: GPIO controlling regulator enable. 328 * @ena_gpio_invert: Sense for GPIO enable control. 329 * @ena_gpio_flags: Flags to use when calling gpio_request_one() 330 */ 331struct regulator_config { 332 struct device *dev; 333 const struct regulator_init_data *init_data; 334 void *driver_data; 335 struct device_node *of_node; 336 struct regmap *regmap; 337 338 bool ena_gpio_initialized; 339 int ena_gpio; 340 unsigned int ena_gpio_invert:1; 341 unsigned int ena_gpio_flags; 342}; 343 344/* 345 * struct regulator_dev 346 * 347 * Voltage / Current regulator class device. One for each 348 * regulator. 349 * 350 * This should *not* be used directly by anything except the regulator 351 * core and notification injection (which should take the mutex and do 352 * no other direct access). 353 */ 354struct regulator_dev { 355 const struct regulator_desc *desc; 356 int exclusive; 357 u32 use_count; 358 u32 open_count; 359 u32 bypass_count; 360 361 /* lists we belong to */ 362 struct list_head list; /* list of all regulators */ 363 364 /* lists we own */ 365 struct list_head consumer_list; /* consumers we supply */ 366 367 struct blocking_notifier_head notifier; 368 struct mutex mutex; /* consumer lock */ 369 struct module *owner; 370 struct device dev; 371 struct regulation_constraints *constraints; 372 struct regulator *supply; /* for tree */ 373 const char *supply_name; 374 struct regmap *regmap; 375 376 struct delayed_work disable_work; 377 int deferred_disables; 378 379 void *reg_data; /* regulator_dev data */ 380 381 struct dentry *debugfs; 382 383 struct regulator_enable_gpio *ena_pin; 384 unsigned int ena_gpio_state:1; 385 386 /* time when this regulator was disabled last time */ 387 unsigned long last_off_jiffy; 388}; 389 390struct regulator_dev * 391regulator_register(const struct regulator_desc *regulator_desc, 392 const struct regulator_config *config); 393struct regulator_dev * 394devm_regulator_register(struct device *dev, 395 const struct regulator_desc *regulator_desc, 396 const struct regulator_config *config); 397void regulator_unregister(struct regulator_dev *rdev); 398void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev); 399 400int regulator_notifier_call_chain(struct regulator_dev *rdev, 401 unsigned long event, void *data); 402 403void *rdev_get_drvdata(struct regulator_dev *rdev); 404struct device *rdev_get_dev(struct regulator_dev *rdev); 405int rdev_get_id(struct regulator_dev *rdev); 406 407int regulator_mode_to_status(unsigned int); 408 409int regulator_list_voltage_linear(struct regulator_dev *rdev, 410 unsigned int selector); 411int regulator_list_voltage_linear_range(struct regulator_dev *rdev, 412 unsigned int selector); 413int regulator_list_voltage_table(struct regulator_dev *rdev, 414 unsigned int selector); 415int regulator_map_voltage_linear(struct regulator_dev *rdev, 416 int min_uV, int max_uV); 417int regulator_map_voltage_linear_range(struct regulator_dev *rdev, 418 int min_uV, int max_uV); 419int regulator_map_voltage_iterate(struct regulator_dev *rdev, 420 int min_uV, int max_uV); 421int regulator_map_voltage_ascend(struct regulator_dev *rdev, 422 int min_uV, int max_uV); 423int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); 424int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); 425int regulator_is_enabled_regmap(struct regulator_dev *rdev); 426int regulator_enable_regmap(struct regulator_dev *rdev); 427int regulator_disable_regmap(struct regulator_dev *rdev); 428int regulator_set_voltage_time_sel(struct regulator_dev *rdev, 429 unsigned int old_selector, 430 unsigned int new_selector); 431int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable); 432int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable); 433 434void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); 435 436#endif 437