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