1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * driver.h -- SoC Regulator driver support. 4 * 5 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. 6 * 7 * Author: Liam Girdwood <lrg@slimlogic.co.uk> 8 * 9 * Regulator Driver Interface. 10 */ 11 12 #ifndef __LINUX_REGULATOR_DRIVER_H_ 13 #define __LINUX_REGULATOR_DRIVER_H_ 14 15 #include <linux/device.h> 16 #include <linux/linear_range.h> 17 #include <linux/notifier.h> 18 #include <linux/regulator/consumer.h> 19 #include <linux/ww_mutex.h> 20 21 struct gpio_desc; 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 /* Initialize struct linear_range for regulators */ 44 #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \ 45 { \ 46 .min = _min_uV, \ 47 .min_sel = _min_sel, \ 48 .max_sel = _max_sel, \ 49 .step = _step_uV, \ 50 } 51 52 /** 53 * struct regulator_ops - regulator operations. 54 * 55 * @enable: Configure the regulator as enabled. 56 * @disable: Configure the regulator as disabled. 57 * @is_enabled: Return 1 if the regulator is enabled, 0 if not. 58 * May also return negative errno. 59 * 60 * @set_voltage: Set the voltage for the regulator within the range specified. 61 * The driver should select the voltage closest to min_uV. 62 * @set_voltage_sel: Set the voltage for the regulator using the specified 63 * selector. 64 * @map_voltage: Convert a voltage into a selector 65 * @get_voltage: Return the currently configured voltage for the regulator; 66 * return -ENOTRECOVERABLE if regulator can't be read at 67 * bootup and hasn't been set yet. 68 * @get_voltage_sel: Return the currently configured voltage selector for the 69 * regulator; return -ENOTRECOVERABLE if regulator can't 70 * be read at bootup and hasn't been set yet. 71 * @list_voltage: Return one of the supported voltages, in microvolts; zero 72 * if the selector indicates a voltage that is unusable on this system; 73 * or negative errno. Selectors range from zero to one less than 74 * regulator_desc.n_voltages. Voltages may be reported in any order. 75 * 76 * @set_current_limit: Configure a limit for a current-limited regulator. 77 * The driver should select the current closest to max_uA. 78 * @get_current_limit: Get the configured limit for a current-limited regulator. 79 * @set_input_current_limit: Configure an input limit. 80 * 81 * @set_over_current_protection: Support capability of automatically shutting 82 * down when detecting an over current event. 83 * 84 * @set_active_discharge: Set active discharge enable/disable of regulators. 85 * 86 * @set_mode: Set the configured operating mode for the regulator. 87 * @get_mode: Get the configured operating mode for the regulator. 88 * @get_error_flags: Get the current error(s) for the regulator. 89 * @get_status: Return actual (not as-configured) status of regulator, as a 90 * REGULATOR_STATUS value (or negative errno) 91 * @get_optimum_mode: Get the most efficient operating mode for the regulator 92 * when running with the specified parameters. 93 * @set_load: Set the load for the regulator. 94 * 95 * @set_bypass: Set the regulator in bypass mode. 96 * @get_bypass: Get the regulator bypass mode state. 97 * 98 * @enable_time: Time taken for the regulator voltage output voltage to 99 * stabilise after being enabled, in microseconds. 100 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should 101 * select ramp delay equal to or less than(closest) ramp_delay. 102 * @set_voltage_time: Time taken for the regulator voltage output voltage 103 * to stabilise after being set to a new value, in microseconds. 104 * The function receives the from and to voltage as input, it 105 * should return the worst case. 106 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage 107 * to stabilise after being set to a new value, in microseconds. 108 * The function receives the from and to voltage selector as 109 * input, it should return the worst case. 110 * @set_soft_start: Enable soft start for the regulator. 111 * 112 * @set_suspend_voltage: Set the voltage for the regulator when the system 113 * is suspended. 114 * @set_suspend_enable: Mark the regulator as enabled when the system is 115 * suspended. 116 * @set_suspend_disable: Mark the regulator as disabled when the system is 117 * suspended. 118 * @set_suspend_mode: Set the operating mode for the regulator when the 119 * system is suspended. 120 * @resume: Resume operation of suspended regulator. 121 * @set_pull_down: Configure the regulator to pull down when the regulator 122 * is disabled. 123 * 124 * This struct describes regulator operations which can be implemented by 125 * regulator chip drivers. 126 */ 127 struct 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 int (*set_input_current_limit) (struct regulator_dev *, int lim_uA); 146 int (*set_over_current_protection) (struct regulator_dev *); 147 int (*set_active_discharge) (struct regulator_dev *, bool enable); 148 149 /* enable/disable regulator */ 150 int (*enable) (struct regulator_dev *); 151 int (*disable) (struct regulator_dev *); 152 int (*is_enabled) (struct regulator_dev *); 153 154 /* get/set regulator operating mode (defined in consumer.h) */ 155 int (*set_mode) (struct regulator_dev *, unsigned int mode); 156 unsigned int (*get_mode) (struct regulator_dev *); 157 158 /* retrieve current error flags on the regulator */ 159 int (*get_error_flags)(struct regulator_dev *, unsigned int *flags); 160 161 /* Time taken to enable or set voltage on the regulator */ 162 int (*enable_time) (struct regulator_dev *); 163 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay); 164 int (*set_voltage_time) (struct regulator_dev *, int old_uV, 165 int new_uV); 166 int (*set_voltage_time_sel) (struct regulator_dev *, 167 unsigned int old_selector, 168 unsigned int new_selector); 169 170 int (*set_soft_start) (struct regulator_dev *); 171 172 /* report regulator status ... most other accessors report 173 * control inputs, this reports results of combining inputs 174 * from Linux (and other sources) with the actual load. 175 * returns REGULATOR_STATUS_* or negative errno. 176 */ 177 int (*get_status)(struct regulator_dev *); 178 179 /* get most efficient regulator operating mode for load */ 180 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, 181 int output_uV, int load_uA); 182 /* set the load on the regulator */ 183 int (*set_load)(struct regulator_dev *, int load_uA); 184 185 /* control and report on bypass mode */ 186 int (*set_bypass)(struct regulator_dev *dev, bool enable); 187 int (*get_bypass)(struct regulator_dev *dev, bool *enable); 188 189 /* the operations below are for configuration of regulator state when 190 * its parent PMIC enters a global STANDBY/HIBERNATE state */ 191 192 /* set regulator suspend voltage */ 193 int (*set_suspend_voltage) (struct regulator_dev *, int uV); 194 195 /* enable/disable regulator in suspend state */ 196 int (*set_suspend_enable) (struct regulator_dev *); 197 int (*set_suspend_disable) (struct regulator_dev *); 198 199 /* set regulator suspend operating mode (defined in consumer.h) */ 200 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); 201 202 int (*resume)(struct regulator_dev *rdev); 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 * @n_current_limits: Number of selectors available for current limits 246 * 247 * @min_uV: Voltage given by the lowest selector (if linear mapping) 248 * @uV_step: Voltage increase with each selector (if linear mapping) 249 * @linear_min_sel: Minimal selector for starting linear mapping 250 * @fixed_uV: Fixed voltage of rails. 251 * @ramp_delay: Time to settle down after voltage change (unit: uV/us) 252 * @min_dropout_uV: The minimum dropout voltage this regulator can handle 253 * @linear_ranges: A constant table of possible voltage ranges. 254 * @linear_range_selectors: A constant table of voltage range selectors. 255 * If pickable ranges are used each range must 256 * have corresponding selector here. 257 * @n_linear_ranges: Number of entries in the @linear_ranges (and in 258 * linear_range_selectors if used) table(s). 259 * @volt_table: Voltage mapping table (if table based mapping) 260 * @curr_table: Current limit mapping table (if table based mapping) 261 * 262 * @vsel_range_reg: Register for range selector when using pickable ranges 263 * and ``regulator_map_*_voltage_*_pickable`` functions. 264 * @vsel_range_mask: Mask for register bitfield used for range selector 265 * @vsel_reg: Register for selector when using ``regulator_map_*_voltage_*`` 266 * @vsel_mask: Mask for register bitfield used for selector 267 * @vsel_step: Specify the resolution of selector stepping when setting 268 * voltage. If 0, then no stepping is done (requested selector is 269 * set directly), if >0 then the regulator API will ramp the 270 * voltage up/down gradually each time increasing/decreasing the 271 * selector by the specified step value. 272 * @csel_reg: Register for current limit selector using regmap set_current_limit 273 * @csel_mask: Mask for register bitfield used for current limit selector 274 * @apply_reg: Register for initiate voltage change on the output when 275 * using regulator_set_voltage_sel_regmap 276 * @apply_bit: Register bitfield used for initiate voltage change on the 277 * output when using regulator_set_voltage_sel_regmap 278 * @enable_reg: Register for control when using regmap enable/disable ops 279 * @enable_mask: Mask for control when using regmap enable/disable ops 280 * @enable_val: Enabling value for control when using regmap enable/disable ops 281 * @disable_val: Disabling value for control when using regmap enable/disable ops 282 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable 283 * when using regulator_enable_regmap and friends APIs. 284 * @bypass_reg: Register for control when using regmap set_bypass 285 * @bypass_mask: Mask for control when using regmap set_bypass 286 * @bypass_val_on: Enabling value for control when using regmap set_bypass 287 * @bypass_val_off: Disabling value for control when using regmap set_bypass 288 * @active_discharge_off: Enabling value for control when using regmap 289 * set_active_discharge 290 * @active_discharge_on: Disabling value for control when using regmap 291 * set_active_discharge 292 * @active_discharge_mask: Mask for control when using regmap 293 * set_active_discharge 294 * @active_discharge_reg: Register for control when using regmap 295 * set_active_discharge 296 * @soft_start_reg: Register for control when using regmap set_soft_start 297 * @soft_start_mask: Mask for control when using regmap set_soft_start 298 * @soft_start_val_on: Enabling value for control when using regmap 299 * set_soft_start 300 * @pull_down_reg: Register for control when using regmap set_pull_down 301 * @pull_down_mask: Mask for control when using regmap set_pull_down 302 * @pull_down_val_on: Enabling value for control when using regmap 303 * set_pull_down 304 * 305 * @enable_time: Time taken for initial enable of regulator (in uS). 306 * @off_on_delay: guard time (in uS), before re-enabling a regulator 307 * 308 * @poll_enabled_time: The polling interval (in uS) to use while checking that 309 * the regulator was actually enabled. Max upto enable_time. 310 * 311 * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode 312 */ 313 struct regulator_desc { 314 const char *name; 315 const char *supply_name; 316 const char *of_match; 317 const char *regulators_node; 318 int (*of_parse_cb)(struct device_node *, 319 const struct regulator_desc *, 320 struct regulator_config *); 321 int id; 322 unsigned int continuous_voltage_range:1; 323 unsigned n_voltages; 324 unsigned int n_current_limits; 325 const struct regulator_ops *ops; 326 int irq; 327 enum regulator_type type; 328 struct module *owner; 329 330 unsigned int min_uV; 331 unsigned int uV_step; 332 unsigned int linear_min_sel; 333 int fixed_uV; 334 unsigned int ramp_delay; 335 int min_dropout_uV; 336 337 const struct linear_range *linear_ranges; 338 const unsigned int *linear_range_selectors; 339 340 int n_linear_ranges; 341 342 const unsigned int *volt_table; 343 const unsigned int *curr_table; 344 345 unsigned int vsel_range_reg; 346 unsigned int vsel_range_mask; 347 unsigned int vsel_reg; 348 unsigned int vsel_mask; 349 unsigned int vsel_step; 350 unsigned int csel_reg; 351 unsigned int csel_mask; 352 unsigned int apply_reg; 353 unsigned int apply_bit; 354 unsigned int enable_reg; 355 unsigned int enable_mask; 356 unsigned int enable_val; 357 unsigned int disable_val; 358 bool enable_is_inverted; 359 unsigned int bypass_reg; 360 unsigned int bypass_mask; 361 unsigned int bypass_val_on; 362 unsigned int bypass_val_off; 363 unsigned int active_discharge_on; 364 unsigned int active_discharge_off; 365 unsigned int active_discharge_mask; 366 unsigned int active_discharge_reg; 367 unsigned int soft_start_reg; 368 unsigned int soft_start_mask; 369 unsigned int soft_start_val_on; 370 unsigned int pull_down_reg; 371 unsigned int pull_down_mask; 372 unsigned int pull_down_val_on; 373 374 unsigned int enable_time; 375 376 unsigned int off_on_delay; 377 378 unsigned int poll_enabled_time; 379 380 unsigned int (*of_map_mode)(unsigned int mode); 381 }; 382 383 /** 384 * struct regulator_config - Dynamic regulator descriptor 385 * 386 * Each regulator registered with the core is described with a 387 * structure of this type and a struct regulator_desc. This structure 388 * contains the runtime variable parts of the regulator description. 389 * 390 * @dev: struct device for the regulator 391 * @init_data: platform provided init data, passed through by driver 392 * @driver_data: private regulator data 393 * @of_node: OpenFirmware node to parse for device tree bindings (may be 394 * NULL). 395 * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is 396 * insufficient. 397 * @ena_gpiod: GPIO controlling regulator enable. 398 */ 399 struct regulator_config { 400 struct device *dev; 401 const struct regulator_init_data *init_data; 402 void *driver_data; 403 struct device_node *of_node; 404 struct regmap *regmap; 405 406 struct gpio_desc *ena_gpiod; 407 }; 408 409 /* 410 * struct coupling_desc 411 * 412 * Describes coupling of regulators. Each regulator should have 413 * at least a pointer to itself in coupled_rdevs array. 414 * When a new coupled regulator is resolved, n_resolved is 415 * incremented. 416 */ 417 struct coupling_desc { 418 struct regulator_dev **coupled_rdevs; 419 struct regulator_coupler *coupler; 420 int n_resolved; 421 int n_coupled; 422 }; 423 424 /* 425 * struct regulator_dev 426 * 427 * Voltage / Current regulator class device. One for each 428 * regulator. 429 * 430 * This should *not* be used directly by anything except the regulator 431 * core and notification injection (which should take the mutex and do 432 * no other direct access). 433 */ 434 struct regulator_dev { 435 const struct regulator_desc *desc; 436 int exclusive; 437 u32 use_count; 438 u32 open_count; 439 u32 bypass_count; 440 441 /* lists we belong to */ 442 struct list_head list; /* list of all regulators */ 443 444 /* lists we own */ 445 struct list_head consumer_list; /* consumers we supply */ 446 447 struct coupling_desc coupling_desc; 448 449 struct blocking_notifier_head notifier; 450 struct ww_mutex mutex; /* consumer lock */ 451 struct task_struct *mutex_owner; 452 int ref_cnt; 453 struct module *owner; 454 struct device dev; 455 struct regulation_constraints *constraints; 456 struct regulator *supply; /* for tree */ 457 const char *supply_name; 458 struct regmap *regmap; 459 460 struct delayed_work disable_work; 461 462 void *reg_data; /* regulator_dev data */ 463 464 struct dentry *debugfs; 465 466 struct regulator_enable_gpio *ena_pin; 467 unsigned int ena_gpio_state:1; 468 469 unsigned int is_switch:1; 470 471 /* time when this regulator was disabled last time */ 472 unsigned long last_off_jiffy; 473 }; 474 475 struct regulator_dev * 476 regulator_register(const struct regulator_desc *regulator_desc, 477 const struct regulator_config *config); 478 struct regulator_dev * 479 devm_regulator_register(struct device *dev, 480 const struct regulator_desc *regulator_desc, 481 const struct regulator_config *config); 482 void regulator_unregister(struct regulator_dev *rdev); 483 void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev); 484 485 int regulator_notifier_call_chain(struct regulator_dev *rdev, 486 unsigned long event, void *data); 487 488 void *rdev_get_drvdata(struct regulator_dev *rdev); 489 struct device *rdev_get_dev(struct regulator_dev *rdev); 490 struct regmap *rdev_get_regmap(struct regulator_dev *rdev); 491 int rdev_get_id(struct regulator_dev *rdev); 492 493 int regulator_mode_to_status(unsigned int); 494 495 int regulator_list_voltage_linear(struct regulator_dev *rdev, 496 unsigned int selector); 497 int regulator_list_voltage_pickable_linear_range(struct regulator_dev *rdev, 498 unsigned int selector); 499 int regulator_list_voltage_linear_range(struct regulator_dev *rdev, 500 unsigned int selector); 501 int regulator_list_voltage_table(struct regulator_dev *rdev, 502 unsigned int selector); 503 int regulator_map_voltage_linear(struct regulator_dev *rdev, 504 int min_uV, int max_uV); 505 int regulator_map_voltage_pickable_linear_range(struct regulator_dev *rdev, 506 int min_uV, int max_uV); 507 int regulator_map_voltage_linear_range(struct regulator_dev *rdev, 508 int min_uV, int max_uV); 509 int regulator_map_voltage_iterate(struct regulator_dev *rdev, 510 int min_uV, int max_uV); 511 int regulator_map_voltage_ascend(struct regulator_dev *rdev, 512 int min_uV, int max_uV); 513 int regulator_get_voltage_sel_pickable_regmap(struct regulator_dev *rdev); 514 int regulator_set_voltage_sel_pickable_regmap(struct regulator_dev *rdev, 515 unsigned int sel); 516 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); 517 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); 518 int regulator_is_enabled_regmap(struct regulator_dev *rdev); 519 int regulator_enable_regmap(struct regulator_dev *rdev); 520 int regulator_disable_regmap(struct regulator_dev *rdev); 521 int regulator_set_voltage_time_sel(struct regulator_dev *rdev, 522 unsigned int old_selector, 523 unsigned int new_selector); 524 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable); 525 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable); 526 int regulator_set_soft_start_regmap(struct regulator_dev *rdev); 527 int regulator_set_pull_down_regmap(struct regulator_dev *rdev); 528 529 int regulator_set_active_discharge_regmap(struct regulator_dev *rdev, 530 bool enable); 531 int regulator_set_current_limit_regmap(struct regulator_dev *rdev, 532 int min_uA, int max_uA); 533 int regulator_get_current_limit_regmap(struct regulator_dev *rdev); 534 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); 535 536 /* 537 * Helper functions intended to be used by regulator drivers prior registering 538 * their regulators. 539 */ 540 int regulator_desc_list_voltage_linear_range(const struct regulator_desc *desc, 541 unsigned int selector); 542 543 #endif 544