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