Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 1 | /* |
| 2 | * driver.h -- SoC Regulator driver support. |
| 3 | * |
| 4 | * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. |
| 5 | * |
Liam Girdwood | 1dd68f0 | 2009-02-02 21:43:31 +0000 | [diff] [blame] | 6 | * Author: Liam Girdwood <lrg@slimlogic.co.uk> |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 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/regulator/consumer.h> |
| 20 | |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 21 | struct regulator_dev; |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 22 | struct regulator_init_data; |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 23 | |
David Brownell | 853116a | 2009-01-14 23:03:17 -0800 | [diff] [blame] | 24 | enum regulator_status { |
| 25 | REGULATOR_STATUS_OFF, |
| 26 | REGULATOR_STATUS_ON, |
| 27 | REGULATOR_STATUS_ERROR, |
| 28 | /* fast/normal/idle/standby are flavors of "on" */ |
| 29 | REGULATOR_STATUS_FAST, |
| 30 | REGULATOR_STATUS_NORMAL, |
| 31 | REGULATOR_STATUS_IDLE, |
| 32 | REGULATOR_STATUS_STANDBY, |
| 33 | }; |
| 34 | |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 35 | /** |
| 36 | * struct regulator_ops - regulator operations. |
| 37 | * |
David Brownell | 3b2a606 | 2009-02-26 13:28:41 -0800 | [diff] [blame] | 38 | * @enable: Configure the regulator as enabled. |
| 39 | * @disable: Configure the regulator as disabled. |
Wolfram Sang | d87b969 | 2009-09-18 22:44:46 +0200 | [diff] [blame] | 40 | * @is_enabled: Return 1 if the regulator is enabled, 0 if not. |
| 41 | * May also return negative errno. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 42 | * |
| 43 | * @set_voltage: Set the voltage for the regulator within the range specified. |
| 44 | * The driver should select the voltage closest to min_uV. |
Mark Brown | e8eef82 | 2010-12-12 14:36:17 +0000 | [diff] [blame] | 45 | * @set_voltage_sel: Set the voltage for the regulator using the specified |
| 46 | * selector. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 47 | * @get_voltage: Return the currently configured voltage for the regulator. |
Mark Brown | 476c2d8 | 2010-12-10 17:28:07 +0000 | [diff] [blame] | 48 | * @get_voltage_sel: Return the currently configured voltage selector for the |
| 49 | * regulator. |
David Brownell | 4367cfd | 2009-02-26 11:48:36 -0800 | [diff] [blame] | 50 | * @list_voltage: Return one of the supported voltages, in microvolts; zero |
| 51 | * if the selector indicates a voltage that is unusable on this system; |
| 52 | * or negative errno. Selectors range from zero to one less than |
| 53 | * regulator_desc.n_voltages. Voltages may be reported in any order. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 54 | * |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 55 | * @set_current_limit: Configure a limit for a current-limited regulator. |
David Brownell | 3b2a606 | 2009-02-26 13:28:41 -0800 | [diff] [blame] | 56 | * @get_current_limit: Get the configured limit for a current-limited regulator. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 57 | * |
Randy Dunlap | 9f653251 | 2009-04-03 21:31:30 -0700 | [diff] [blame] | 58 | * @set_mode: Set the configured operating mode for the regulator. |
David Brownell | 3b2a606 | 2009-02-26 13:28:41 -0800 | [diff] [blame] | 59 | * @get_mode: Get the configured operating mode for the regulator. |
| 60 | * @get_status: Return actual (not as-configured) status of regulator, as a |
| 61 | * REGULATOR_STATUS value (or negative errno) |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 62 | * @get_optimum_mode: Get the most efficient operating mode for the regulator |
| 63 | * when running with the specified parameters. |
| 64 | * |
Mark Brown | 31aae2b | 2009-12-21 12:21:52 +0000 | [diff] [blame] | 65 | * @enable_time: Time taken for the regulator voltage output voltage to |
Linus Walleij | 77af1b264 | 2011-03-17 13:24:36 +0100 | [diff] [blame] | 66 | * stabilise after being enabled, in microseconds. |
| 67 | * @set_voltage_time_sel: Time taken for the regulator voltage output voltage |
| 68 | * to stabilise after being set to a new value, in microseconds. |
| 69 | * The function provides the from and to voltage selector, the |
| 70 | * function should return the worst case. |
Mark Brown | 31aae2b | 2009-12-21 12:21:52 +0000 | [diff] [blame] | 71 | * |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 72 | * @set_suspend_voltage: Set the voltage for the regulator when the system |
| 73 | * is suspended. |
| 74 | * @set_suspend_enable: Mark the regulator as enabled when the system is |
| 75 | * suspended. |
| 76 | * @set_suspend_disable: Mark the regulator as disabled when the system is |
| 77 | * suspended. |
| 78 | * @set_suspend_mode: Set the operating mode for the regulator when the |
| 79 | * system is suspended. |
David Brownell | 3b2a606 | 2009-02-26 13:28:41 -0800 | [diff] [blame] | 80 | * |
| 81 | * This struct describes regulator operations which can be implemented by |
| 82 | * regulator chip drivers. |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 83 | */ |
| 84 | struct regulator_ops { |
| 85 | |
David Brownell | 4367cfd | 2009-02-26 11:48:36 -0800 | [diff] [blame] | 86 | /* enumerate supported voltages */ |
| 87 | int (*list_voltage) (struct regulator_dev *, unsigned selector); |
| 88 | |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 89 | /* get/set regulator voltage */ |
Mark Brown | 3a93f2a | 2010-11-10 14:38:29 +0000 | [diff] [blame] | 90 | int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, |
| 91 | unsigned *selector); |
Mark Brown | e8eef82 | 2010-12-12 14:36:17 +0000 | [diff] [blame] | 92 | int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 93 | int (*get_voltage) (struct regulator_dev *); |
Mark Brown | 476c2d8 | 2010-12-10 17:28:07 +0000 | [diff] [blame] | 94 | int (*get_voltage_sel) (struct regulator_dev *); |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 95 | |
| 96 | /* get/set regulator current */ |
| 97 | int (*set_current_limit) (struct regulator_dev *, |
| 98 | int min_uA, int max_uA); |
| 99 | int (*get_current_limit) (struct regulator_dev *); |
| 100 | |
| 101 | /* enable/disable regulator */ |
| 102 | int (*enable) (struct regulator_dev *); |
| 103 | int (*disable) (struct regulator_dev *); |
| 104 | int (*is_enabled) (struct regulator_dev *); |
| 105 | |
| 106 | /* get/set regulator operating mode (defined in regulator.h) */ |
| 107 | int (*set_mode) (struct regulator_dev *, unsigned int mode); |
| 108 | unsigned int (*get_mode) (struct regulator_dev *); |
| 109 | |
Linus Walleij | 77af1b264 | 2011-03-17 13:24:36 +0100 | [diff] [blame] | 110 | /* Time taken to enable or set voltage on the regulator */ |
Mark Brown | 31aae2b | 2009-12-21 12:21:52 +0000 | [diff] [blame] | 111 | int (*enable_time) (struct regulator_dev *); |
Linus Walleij | 77af1b264 | 2011-03-17 13:24:36 +0100 | [diff] [blame] | 112 | int (*set_voltage_time_sel) (struct regulator_dev *, |
| 113 | unsigned int old_selector, |
| 114 | unsigned int new_selector); |
Mark Brown | 31aae2b | 2009-12-21 12:21:52 +0000 | [diff] [blame] | 115 | |
David Brownell | 853116a | 2009-01-14 23:03:17 -0800 | [diff] [blame] | 116 | /* report regulator status ... most other accessors report |
| 117 | * control inputs, this reports results of combining inputs |
| 118 | * from Linux (and other sources) with the actual load. |
David Brownell | 3b2a606 | 2009-02-26 13:28:41 -0800 | [diff] [blame] | 119 | * returns REGULATOR_STATUS_* or negative errno. |
David Brownell | 853116a | 2009-01-14 23:03:17 -0800 | [diff] [blame] | 120 | */ |
| 121 | int (*get_status)(struct regulator_dev *); |
| 122 | |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 123 | /* get most efficient regulator operating mode for load */ |
| 124 | unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, |
| 125 | int output_uV, int load_uA); |
| 126 | |
| 127 | /* the operations below are for configuration of regulator state when |
Mark Brown | 3de8960 | 2008-09-09 16:21:17 +0100 | [diff] [blame] | 128 | * its parent PMIC enters a global STANDBY/HIBERNATE state */ |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 129 | |
| 130 | /* set regulator suspend voltage */ |
| 131 | int (*set_suspend_voltage) (struct regulator_dev *, int uV); |
| 132 | |
| 133 | /* enable/disable regulator in suspend state */ |
| 134 | int (*set_suspend_enable) (struct regulator_dev *); |
| 135 | int (*set_suspend_disable) (struct regulator_dev *); |
| 136 | |
| 137 | /* set regulator suspend operating mode (defined in regulator.h) */ |
| 138 | int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); |
| 139 | }; |
| 140 | |
| 141 | /* |
| 142 | * Regulators can either control voltage or current. |
| 143 | */ |
| 144 | enum regulator_type { |
| 145 | REGULATOR_VOLTAGE, |
| 146 | REGULATOR_CURRENT, |
| 147 | }; |
| 148 | |
| 149 | /** |
| 150 | * struct regulator_desc - Regulator descriptor |
| 151 | * |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 152 | * Each regulator registered with the core is described with a structure of |
| 153 | * this type. |
| 154 | * |
| 155 | * @name: Identifying name for the regulator. |
| 156 | * @id: Numerical identifier for the regulator. |
David Brownell | 4367cfd | 2009-02-26 11:48:36 -0800 | [diff] [blame] | 157 | * @n_voltages: Number of selectors available for ops.list_voltage(). |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 158 | * @ops: Regulator operations table. |
Randy Dunlap | 0ba4887 | 2009-01-08 11:50:23 -0800 | [diff] [blame] | 159 | * @irq: Interrupt number for the regulator. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 160 | * @type: Indicates if the regulator is a voltage or current regulator. |
| 161 | * @owner: Module providing the regulator, used for refcounting. |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 162 | */ |
| 163 | struct regulator_desc { |
| 164 | const char *name; |
| 165 | int id; |
David Brownell | 4367cfd | 2009-02-26 11:48:36 -0800 | [diff] [blame] | 166 | unsigned n_voltages; |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 167 | struct regulator_ops *ops; |
| 168 | int irq; |
| 169 | enum regulator_type type; |
| 170 | struct module *owner; |
| 171 | }; |
| 172 | |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 173 | /* |
| 174 | * struct regulator_dev |
| 175 | * |
| 176 | * Voltage / Current regulator class device. One for each |
| 177 | * regulator. |
| 178 | * |
| 179 | * This should *not* be used directly by anything except the regulator |
| 180 | * core and notification injection (which should take the mutex and do |
| 181 | * no other direct access). |
| 182 | */ |
| 183 | struct regulator_dev { |
| 184 | struct regulator_desc *desc; |
Mark Brown | 5ffbd13 | 2009-07-21 16:00:23 +0100 | [diff] [blame] | 185 | int exclusive; |
Mark Brown | 1130e5b | 2010-12-21 23:49:31 +0000 | [diff] [blame] | 186 | u32 use_count; |
| 187 | u32 open_count; |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 188 | |
| 189 | /* lists we belong to */ |
| 190 | struct list_head list; /* list of all regulators */ |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 191 | |
| 192 | /* lists we own */ |
| 193 | struct list_head consumer_list; /* consumers we supply */ |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 194 | |
| 195 | struct blocking_notifier_head notifier; |
| 196 | struct mutex mutex; /* consumer lock */ |
| 197 | struct module *owner; |
| 198 | struct device dev; |
| 199 | struct regulation_constraints *constraints; |
Mark Brown | 3801b86 | 2011-06-09 16:22:22 +0100 | [diff] [blame] | 200 | struct regulator *supply; /* for tree */ |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 201 | |
Mark Brown | da07ecd | 2011-09-11 09:53:50 +0100 | [diff] [blame] | 202 | struct delayed_work disable_work; |
| 203 | int deferred_disables; |
| 204 | |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 205 | void *reg_data; /* regulator_dev data */ |
Mark Brown | 1130e5b | 2010-12-21 23:49:31 +0000 | [diff] [blame] | 206 | |
| 207 | #ifdef CONFIG_DEBUG_FS |
| 208 | struct dentry *debugfs; |
| 209 | #endif |
Mark Brown | 1fa9ad5 | 2009-01-21 14:08:40 +0000 | [diff] [blame] | 210 | }; |
| 211 | |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 212 | struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc, |
Mark Brown | f8c12fe | 2010-11-29 15:55:17 +0000 | [diff] [blame] | 213 | struct device *dev, const struct regulator_init_data *init_data, |
Mark Brown | 0527100 | 2009-01-19 13:37:02 +0000 | [diff] [blame] | 214 | void *driver_data); |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 215 | void regulator_unregister(struct regulator_dev *rdev); |
| 216 | |
| 217 | int regulator_notifier_call_chain(struct regulator_dev *rdev, |
| 218 | unsigned long event, void *data); |
| 219 | |
| 220 | void *rdev_get_drvdata(struct regulator_dev *rdev); |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 221 | struct device *rdev_get_dev(struct regulator_dev *rdev); |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 222 | int rdev_get_id(struct regulator_dev *rdev); |
| 223 | |
Mark Brown | be72197 | 2009-08-04 20:09:52 +0200 | [diff] [blame] | 224 | int regulator_mode_to_status(unsigned int); |
| 225 | |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 226 | void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); |
| 227 | |
Liam Girdwood | 571a354 | 2008-04-30 15:42:28 +0100 | [diff] [blame] | 228 | #endif |