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