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