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