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 #define MAX_COUPLED 2 19 20 #include <linux/device.h> 21 #include <linux/notifier.h> 22 #include <linux/regulator/consumer.h> 23 #include <linux/ww_mutex.h> 24 25 struct gpio_desc; 26 struct regmap; 27 struct regulator_dev; 28 struct regulator_config; 29 struct regulator_init_data; 30 struct regulator_enable_gpio; 31 32 enum regulator_status { 33 REGULATOR_STATUS_OFF, 34 REGULATOR_STATUS_ON, 35 REGULATOR_STATUS_ERROR, 36 /* fast/normal/idle/standby are flavors of "on" */ 37 REGULATOR_STATUS_FAST, 38 REGULATOR_STATUS_NORMAL, 39 REGULATOR_STATUS_IDLE, 40 REGULATOR_STATUS_STANDBY, 41 /* The regulator is enabled but not regulating */ 42 REGULATOR_STATUS_BYPASS, 43 /* in case that any other status doesn't apply */ 44 REGULATOR_STATUS_UNDEFINED, 45 }; 46 47 /** 48 * struct regulator_linear_range - specify linear voltage ranges 49 * 50 * Specify a range of voltages for regulator_map_linear_range() and 51 * regulator_list_linear_range(). 52 * 53 * @min_uV: Lowest voltage in range 54 * @min_sel: Lowest selector for range 55 * @max_sel: Highest selector for range 56 * @uV_step: Step size 57 */ 58 struct regulator_linear_range { 59 unsigned int min_uV; 60 unsigned int min_sel; 61 unsigned int max_sel; 62 unsigned int uV_step; 63 }; 64 65 /* Initialize struct regulator_linear_range */ 66 #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \ 67 { \ 68 .min_uV = _min_uV, \ 69 .min_sel = _min_sel, \ 70 .max_sel = _max_sel, \ 71 .uV_step = _step_uV, \ 72 } 73 74 /** 75 * struct regulator_ops - regulator operations. 76 * 77 * @enable: Configure the regulator as enabled. 78 * @disable: Configure the regulator as disabled. 79 * @is_enabled: Return 1 if the regulator is enabled, 0 if not. 80 * May also return negative errno. 81 * 82 * @set_voltage: Set the voltage for the regulator within the range specified. 83 * The driver should select the voltage closest to min_uV. 84 * @set_voltage_sel: Set the voltage for the regulator using the specified 85 * selector. 86 * @map_voltage: Convert a voltage into a selector 87 * @get_voltage: Return the currently configured voltage for the regulator; 88 * return -ENOTRECOVERABLE if regulator can't be read at 89 * bootup and hasn't been set yet. 90 * @get_voltage_sel: Return the currently configured voltage selector for the 91 * regulator; return -ENOTRECOVERABLE if regulator can't 92 * be read at bootup and hasn't been set yet. 93 * @list_voltage: Return one of the supported voltages, in microvolts; zero 94 * if the selector indicates a voltage that is unusable on this system; 95 * or negative errno. Selectors range from zero to one less than 96 * regulator_desc.n_voltages. Voltages may be reported in any order. 97 * 98 * @set_current_limit: Configure a limit for a current-limited regulator. 99 * The driver should select the current closest to max_uA. 100 * @get_current_limit: Get the configured limit for a current-limited regulator. 101 * @set_input_current_limit: Configure an input limit. 102 * 103 * @set_over_current_protection: Support capability of automatically shutting 104 * down when detecting an over current event. 105 * 106 * @set_active_discharge: Set active discharge enable/disable of regulators. 107 * 108 * @set_mode: Set the configured operating mode for the regulator. 109 * @get_mode: Get the configured operating mode for the regulator. 110 * @get_error_flags: Get the current error(s) for the regulator. 111 * @get_status: Return actual (not as-configured) status of regulator, as a 112 * REGULATOR_STATUS value (or negative errno) 113 * @get_optimum_mode: Get the most efficient operating mode for the regulator 114 * when running with the specified parameters. 115 * @set_load: Set the load for the regulator. 116 * 117 * @set_bypass: Set the regulator in bypass mode. 118 * @get_bypass: Get the regulator bypass mode state. 119 * 120 * @enable_time: Time taken for the regulator voltage output voltage to 121 * stabilise after being enabled, in microseconds. 122 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should 123 * select ramp delay equal to or less than(closest) ramp_delay. 124 * @set_voltage_time: Time taken for the regulator voltage output voltage 125 * to stabilise after being set to a new value, in microseconds. 126 * The function receives the from and to voltage as input, it 127 * should return the worst case. 128 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage 129 * to stabilise after being set to a new value, in microseconds. 130 * The function receives the from and to voltage selector as 131 * input, it should return the worst case. 132 * @set_soft_start: Enable soft start for the regulator. 133 * 134 * @set_suspend_voltage: Set the voltage for the regulator when the system 135 * is suspended. 136 * @set_suspend_enable: Mark the regulator as enabled when the system is 137 * suspended. 138 * @set_suspend_disable: Mark the regulator as disabled when the system is 139 * suspended. 140 * @set_suspend_mode: Set the operating mode for the regulator when the 141 * system is suspended. 142 * 143 * @set_pull_down: Configure the regulator to pull down when the regulator 144 * is disabled. 145 * 146 * This struct describes regulator operations which can be implemented by 147 * regulator chip drivers. 148 */ 149 struct regulator_ops { 150 151 /* enumerate supported voltages */ 152 int (*list_voltage) (struct regulator_dev *, unsigned selector); 153 154 /* get/set regulator voltage */ 155 int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, 156 unsigned *selector); 157 int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV); 158 int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); 159 int (*get_voltage) (struct regulator_dev *); 160 int (*get_voltage_sel) (struct regulator_dev *); 161 162 /* get/set regulator current */ 163 int (*set_current_limit) (struct regulator_dev *, 164 int min_uA, int max_uA); 165 int (*get_current_limit) (struct regulator_dev *); 166 167 int (*set_input_current_limit) (struct regulator_dev *, int lim_uA); 168 int (*set_over_current_protection) (struct regulator_dev *); 169 int (*set_active_discharge) (struct regulator_dev *, bool enable); 170 171 /* enable/disable regulator */ 172 int (*enable) (struct regulator_dev *); 173 int (*disable) (struct regulator_dev *); 174 int (*is_enabled) (struct regulator_dev *); 175 176 /* get/set regulator operating mode (defined in consumer.h) */ 177 int (*set_mode) (struct regulator_dev *, unsigned int mode); 178 unsigned int (*get_mode) (struct regulator_dev *); 179 180 /* retrieve current error flags on the regulator */ 181 int (*get_error_flags)(struct regulator_dev *, unsigned int *flags); 182 183 /* Time taken to enable or set voltage on the regulator */ 184 int (*enable_time) (struct regulator_dev *); 185 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay); 186 int (*set_voltage_time) (struct regulator_dev *, int old_uV, 187 int new_uV); 188 int (*set_voltage_time_sel) (struct regulator_dev *, 189 unsigned int old_selector, 190 unsigned int new_selector); 191 192 int (*set_soft_start) (struct regulator_dev *); 193 194 /* report regulator status ... most other accessors report 195 * control inputs, this reports results of combining inputs 196 * from Linux (and other sources) with the actual load. 197 * returns REGULATOR_STATUS_* or negative errno. 198 */ 199 int (*get_status)(struct regulator_dev *); 200 201 /* get most efficient regulator operating mode for load */ 202 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, 203 int output_uV, int load_uA); 204 /* set the load on the regulator */ 205 int (*set_load)(struct regulator_dev *, int load_uA); 206 207 /* control and report on bypass mode */ 208 int (*set_bypass)(struct regulator_dev *dev, bool enable); 209 int (*get_bypass)(struct regulator_dev *dev, bool *enable); 210 211 /* the operations below are for configuration of regulator state when 212 * its parent PMIC enters a global STANDBY/HIBERNATE state */ 213 214 /* set regulator suspend voltage */ 215 int (*set_suspend_voltage) (struct regulator_dev *, int uV); 216 217 /* enable/disable regulator in suspend state */ 218 int (*set_suspend_enable) (struct regulator_dev *); 219 int (*set_suspend_disable) (struct regulator_dev *); 220 221 /* set regulator suspend operating mode (defined in consumer.h) */ 222 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); 223 224 int (*resume)(struct regulator_dev *rdev); 225 226 int (*set_pull_down) (struct regulator_dev *); 227 }; 228 229 /* 230 * Regulators can either control voltage or current. 231 */ 232 enum regulator_type { 233 REGULATOR_VOLTAGE, 234 REGULATOR_CURRENT, 235 }; 236 237 /** 238 * struct regulator_desc - Static regulator descriptor 239 * 240 * Each regulator registered with the core is described with a 241 * structure of this type and a struct regulator_config. This 242 * structure contains the non-varying parts of the regulator 243 * description. 244 * 245 * @name: Identifying name for the regulator. 246 * @supply_name: Identifying the regulator supply 247 * @of_match: Name used to identify regulator in DT. 248 * @regulators_node: Name of node containing regulator definitions in DT. 249 * @of_parse_cb: Optional callback called only if of_match is present. 250 * Will be called for each regulator parsed from DT, during 251 * init_data parsing. 252 * The regulator_config passed as argument to the callback will 253 * be a copy of config passed to regulator_register, valid only 254 * for this particular call. Callback may freely change the 255 * config but it cannot store it for later usage. 256 * Callback should return 0 on success or negative ERRNO 257 * indicating failure. 258 * @id: Numerical identifier for the regulator. 259 * @ops: Regulator operations table. 260 * @irq: Interrupt number for the regulator. 261 * @type: Indicates if the regulator is a voltage or current regulator. 262 * @owner: Module providing the regulator, used for refcounting. 263 * 264 * @continuous_voltage_range: Indicates if the regulator can set any 265 * voltage within constrains range. 266 * @n_voltages: Number of selectors available for ops.list_voltage(). 267 * @n_current_limits: Number of selectors available for current limits 268 * 269 * @min_uV: Voltage given by the lowest selector (if linear mapping) 270 * @uV_step: Voltage increase with each selector (if linear mapping) 271 * @linear_min_sel: Minimal selector for starting linear mapping 272 * @fixed_uV: Fixed voltage of rails. 273 * @ramp_delay: Time to settle down after voltage change (unit: uV/us) 274 * @min_dropout_uV: The minimum dropout voltage this regulator can handle 275 * @linear_ranges: A constant table of possible voltage ranges. 276 * @linear_range_selectors: A constant table of voltage range selectors. 277 * If pickable ranges are used each range must 278 * have corresponding selector here. 279 * @n_linear_ranges: Number of entries in the @linear_ranges (and in 280 * linear_range_selectors if used) table(s). 281 * @volt_table: Voltage mapping table (if table based mapping) 282 * @curr_table: Current limit mapping table (if table based mapping) 283 * 284 * @vsel_range_reg: Register for range selector when using pickable ranges 285 * and regulator_regmap_X_voltage_X_pickable functions. 286 * @vsel_range_mask: Mask for register bitfield used for range selector 287 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_ 288 * @vsel_mask: Mask for register bitfield used for selector 289 * @csel_reg: Register for current limit selector using regmap set_current_limit 290 * @csel_mask: Mask for register bitfield used for current limit selector 291 * @apply_reg: Register for initiate voltage change on the output when 292 * using regulator_set_voltage_sel_regmap 293 * @apply_bit: Register bitfield used for initiate voltage change on the 294 * output when using regulator_set_voltage_sel_regmap 295 * @enable_reg: Register for control when using regmap enable/disable ops 296 * @enable_mask: Mask for control when using regmap enable/disable ops 297 * @enable_val: Enabling value for control when using regmap enable/disable ops 298 * @disable_val: Disabling value for control when using regmap enable/disable ops 299 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable 300 * when using regulator_enable_regmap and friends APIs. 301 * @bypass_reg: Register for control when using regmap set_bypass 302 * @bypass_mask: Mask for control when using regmap set_bypass 303 * @bypass_val_on: Enabling value for control when using regmap set_bypass 304 * @bypass_val_off: Disabling value for control when using regmap set_bypass 305 * @active_discharge_off: Enabling value for control when using regmap 306 * set_active_discharge 307 * @active_discharge_on: Disabling value for control when using regmap 308 * set_active_discharge 309 * @active_discharge_mask: Mask for control when using regmap 310 * set_active_discharge 311 * @active_discharge_reg: Register for control when using regmap 312 * set_active_discharge 313 * @soft_start_reg: Register for control when using regmap set_soft_start 314 * @soft_start_mask: Mask for control when using regmap set_soft_start 315 * @soft_start_val_on: Enabling value for control when using regmap 316 * set_soft_start 317 * @pull_down_reg: Register for control when using regmap set_pull_down 318 * @pull_down_mask: Mask for control when using regmap set_pull_down 319 * @pull_down_val_on: Enabling value for control when using regmap 320 * set_pull_down 321 * 322 * @enable_time: Time taken for initial enable of regulator (in uS). 323 * @off_on_delay: guard time (in uS), before re-enabling a regulator 324 * 325 * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode 326 */ 327 struct regulator_desc { 328 const char *name; 329 const char *supply_name; 330 const char *of_match; 331 const char *regulators_node; 332 int (*of_parse_cb)(struct device_node *, 333 const struct regulator_desc *, 334 struct regulator_config *); 335 int id; 336 unsigned int continuous_voltage_range:1; 337 unsigned n_voltages; 338 unsigned int n_current_limits; 339 const struct regulator_ops *ops; 340 int irq; 341 enum regulator_type type; 342 struct module *owner; 343 344 unsigned int min_uV; 345 unsigned int uV_step; 346 unsigned int linear_min_sel; 347 int fixed_uV; 348 unsigned int ramp_delay; 349 int min_dropout_uV; 350 351 const struct regulator_linear_range *linear_ranges; 352 const unsigned int *linear_range_selectors; 353 354 int n_linear_ranges; 355 356 const unsigned int *volt_table; 357 const unsigned int *curr_table; 358 359 unsigned int vsel_range_reg; 360 unsigned int vsel_range_mask; 361 unsigned int vsel_reg; 362 unsigned int vsel_mask; 363 unsigned int csel_reg; 364 unsigned int csel_mask; 365 unsigned int apply_reg; 366 unsigned int apply_bit; 367 unsigned int enable_reg; 368 unsigned int enable_mask; 369 unsigned int enable_val; 370 unsigned int disable_val; 371 bool enable_is_inverted; 372 unsigned int bypass_reg; 373 unsigned int bypass_mask; 374 unsigned int bypass_val_on; 375 unsigned int bypass_val_off; 376 unsigned int active_discharge_on; 377 unsigned int active_discharge_off; 378 unsigned int active_discharge_mask; 379 unsigned int active_discharge_reg; 380 unsigned int soft_start_reg; 381 unsigned int soft_start_mask; 382 unsigned int soft_start_val_on; 383 unsigned int pull_down_reg; 384 unsigned int pull_down_mask; 385 unsigned int pull_down_val_on; 386 387 unsigned int enable_time; 388 389 unsigned int off_on_delay; 390 391 unsigned int (*of_map_mode)(unsigned int mode); 392 }; 393 394 /** 395 * struct regulator_config - Dynamic regulator descriptor 396 * 397 * Each regulator registered with the core is described with a 398 * structure of this type and a struct regulator_desc. This structure 399 * contains the runtime variable parts of the regulator description. 400 * 401 * @dev: struct device for the regulator 402 * @init_data: platform provided init data, passed through by driver 403 * @driver_data: private regulator data 404 * @of_node: OpenFirmware node to parse for device tree bindings (may be 405 * NULL). 406 * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is 407 * insufficient. 408 * @ena_gpiod: GPIO controlling regulator enable. 409 */ 410 struct regulator_config { 411 struct device *dev; 412 const struct regulator_init_data *init_data; 413 void *driver_data; 414 struct device_node *of_node; 415 struct regmap *regmap; 416 417 struct gpio_desc *ena_gpiod; 418 }; 419 420 /* 421 * struct coupling_desc 422 * 423 * Describes coupling of regulators. Each regulator should have 424 * at least a pointer to itself in coupled_rdevs array. 425 * When a new coupled regulator is resolved, n_resolved is 426 * incremented. 427 */ 428 struct coupling_desc { 429 struct regulator_dev *coupled_rdevs[MAX_COUPLED]; 430 int n_resolved; 431 int n_coupled; 432 }; 433 434 /* 435 * struct regulator_dev 436 * 437 * Voltage / Current regulator class device. One for each 438 * regulator. 439 * 440 * This should *not* be used directly by anything except the regulator 441 * core and notification injection (which should take the mutex and do 442 * no other direct access). 443 */ 444 struct regulator_dev { 445 const struct regulator_desc *desc; 446 int exclusive; 447 u32 use_count; 448 u32 open_count; 449 u32 bypass_count; 450 451 /* lists we belong to */ 452 struct list_head list; /* list of all regulators */ 453 454 /* lists we own */ 455 struct list_head consumer_list; /* consumers we supply */ 456 457 struct coupling_desc coupling_desc; 458 459 struct blocking_notifier_head notifier; 460 struct ww_mutex mutex; /* consumer lock */ 461 struct task_struct *mutex_owner; 462 int ref_cnt; 463 struct module *owner; 464 struct device dev; 465 struct regulation_constraints *constraints; 466 struct regulator *supply; /* for tree */ 467 const char *supply_name; 468 struct regmap *regmap; 469 470 struct delayed_work disable_work; 471 472 void *reg_data; /* regulator_dev data */ 473 474 struct dentry *debugfs; 475 476 struct regulator_enable_gpio *ena_pin; 477 unsigned int ena_gpio_state:1; 478 479 unsigned int is_switch:1; 480 481 /* time when this regulator was disabled last time */ 482 unsigned long last_off_jiffy; 483 }; 484 485 struct regulator_dev * 486 regulator_register(const struct regulator_desc *regulator_desc, 487 const struct regulator_config *config); 488 struct regulator_dev * 489 devm_regulator_register(struct device *dev, 490 const struct regulator_desc *regulator_desc, 491 const struct regulator_config *config); 492 void regulator_unregister(struct regulator_dev *rdev); 493 void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev); 494 495 int regulator_notifier_call_chain(struct regulator_dev *rdev, 496 unsigned long event, void *data); 497 498 void *rdev_get_drvdata(struct regulator_dev *rdev); 499 struct device *rdev_get_dev(struct regulator_dev *rdev); 500 struct regmap *rdev_get_regmap(struct regulator_dev *rdev); 501 int rdev_get_id(struct regulator_dev *rdev); 502 503 int regulator_mode_to_status(unsigned int); 504 505 int regulator_list_voltage_linear(struct regulator_dev *rdev, 506 unsigned int selector); 507 int regulator_list_voltage_pickable_linear_range(struct regulator_dev *rdev, 508 unsigned int selector); 509 int regulator_list_voltage_linear_range(struct regulator_dev *rdev, 510 unsigned int selector); 511 int regulator_list_voltage_table(struct regulator_dev *rdev, 512 unsigned int selector); 513 int regulator_map_voltage_linear(struct regulator_dev *rdev, 514 int min_uV, int max_uV); 515 int regulator_map_voltage_pickable_linear_range(struct regulator_dev *rdev, 516 int min_uV, int max_uV); 517 int regulator_map_voltage_linear_range(struct regulator_dev *rdev, 518 int min_uV, int max_uV); 519 int regulator_map_voltage_iterate(struct regulator_dev *rdev, 520 int min_uV, int max_uV); 521 int regulator_map_voltage_ascend(struct regulator_dev *rdev, 522 int min_uV, int max_uV); 523 int regulator_get_voltage_sel_pickable_regmap(struct regulator_dev *rdev); 524 int regulator_set_voltage_sel_pickable_regmap(struct regulator_dev *rdev, 525 unsigned int sel); 526 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); 527 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); 528 int regulator_is_enabled_regmap(struct regulator_dev *rdev); 529 int regulator_enable_regmap(struct regulator_dev *rdev); 530 int regulator_disable_regmap(struct regulator_dev *rdev); 531 int regulator_set_voltage_time_sel(struct regulator_dev *rdev, 532 unsigned int old_selector, 533 unsigned int new_selector); 534 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable); 535 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable); 536 int regulator_set_soft_start_regmap(struct regulator_dev *rdev); 537 int regulator_set_pull_down_regmap(struct regulator_dev *rdev); 538 539 int regulator_set_active_discharge_regmap(struct regulator_dev *rdev, 540 bool enable); 541 int regulator_set_current_limit_regmap(struct regulator_dev *rdev, 542 int min_uA, int max_uA); 543 int regulator_get_current_limit_regmap(struct regulator_dev *rdev); 544 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); 545 546 void regulator_lock(struct regulator_dev *rdev); 547 void regulator_unlock(struct regulator_dev *rdev); 548 549 /* 550 * Helper functions intended to be used by regulator drivers prior registering 551 * their regulators. 552 */ 553 int regulator_desc_list_voltage_linear_range(const struct regulator_desc *desc, 554 unsigned int selector); 555 #endif 556