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