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