1 /* 2 * machine.h -- SoC Regulator support, machine/board driver API. 3 * 4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. 5 * 6 * Author: Liam Girdwood <[email protected]> 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 Machine/Board Interface. 13 */ 14 15 #ifndef __LINUX_REGULATOR_MACHINE_H_ 16 #define __LINUX_REGULATOR_MACHINE_H_ 17 18 #include <linux/regulator/consumer.h> 19 #include <linux/suspend.h> 20 21 struct regulator; 22 23 /* 24 * Regulator operation constraint flags. These flags are used to enable 25 * certain regulator operations and can be OR'ed together. 26 * 27 * VOLTAGE: Regulator output voltage can be changed by software on this 28 * board/machine. 29 * CURRENT: Regulator output current can be changed by software on this 30 * board/machine. 31 * MODE: Regulator operating mode can be changed by software on this 32 * board/machine. 33 * STATUS: Regulator can be enabled and disabled. 34 * DRMS: Dynamic Regulator Mode Switching is enabled for this regulator. 35 * BYPASS: Regulator can be put into bypass mode 36 */ 37 38 #define REGULATOR_CHANGE_VOLTAGE 0x1 39 #define REGULATOR_CHANGE_CURRENT 0x2 40 #define REGULATOR_CHANGE_MODE 0x4 41 #define REGULATOR_CHANGE_STATUS 0x8 42 #define REGULATOR_CHANGE_DRMS 0x10 43 #define REGULATOR_CHANGE_BYPASS 0x20 44 45 /* 46 * operations in suspend mode 47 * DO_NOTHING_IN_SUSPEND - the default value 48 * DISABLE_IN_SUSPEND - turn off regulator in suspend states 49 * ENABLE_IN_SUSPEND - keep regulator on in suspend states 50 */ 51 #define DO_NOTHING_IN_SUSPEND (-1) 52 #define DISABLE_IN_SUSPEND 0 53 #define ENABLE_IN_SUSPEND 1 54 55 /* Regulator active discharge flags */ 56 enum regulator_active_discharge { 57 REGULATOR_ACTIVE_DISCHARGE_DEFAULT, 58 REGULATOR_ACTIVE_DISCHARGE_DISABLE, 59 REGULATOR_ACTIVE_DISCHARGE_ENABLE, 60 }; 61 62 /** 63 * struct regulator_state - regulator state during low power system states 64 * 65 * This describes a regulators state during a system wide low power 66 * state. One of enabled or disabled must be set for the 67 * configuration to be applied. 68 * 69 * @uV: Operating voltage during suspend. 70 * @mode: Operating mode during suspend. 71 * @enabled: operations during suspend. 72 * - DO_NOTHING_IN_SUSPEND 73 * - DISABLE_IN_SUSPEND 74 * - ENABLE_IN_SUSPEND 75 */ 76 struct regulator_state { 77 int uV; /* suspend voltage */ 78 unsigned int mode; /* suspend regulator operating mode */ 79 int enabled; 80 }; 81 82 /** 83 * struct regulation_constraints - regulator operating constraints. 84 * 85 * This struct describes regulator and board/machine specific constraints. 86 * 87 * @name: Descriptive name for the constraints, used for display purposes. 88 * 89 * @min_uV: Smallest voltage consumers may set. 90 * @max_uV: Largest voltage consumers may set. 91 * @uV_offset: Offset applied to voltages from consumer to compensate for 92 * voltage drops. 93 * 94 * @min_uA: Smallest current consumers may set. 95 * @max_uA: Largest current consumers may set. 96 * @ilim_uA: Maximum input current. 97 * @system_load: Load that isn't captured by any consumer requests. 98 * 99 * @valid_modes_mask: Mask of modes which may be configured by consumers. 100 * @valid_ops_mask: Operations which may be performed by consumers. 101 * 102 * @always_on: Set if the regulator should never be disabled. 103 * @boot_on: Set if the regulator is enabled when the system is initially 104 * started. If the regulator is not enabled by the hardware or 105 * bootloader then it will be enabled when the constraints are 106 * applied. 107 * @apply_uV: Apply the voltage constraint when initialising. 108 * @ramp_disable: Disable ramp delay when initialising or when setting voltage. 109 * @soft_start: Enable soft start so that voltage ramps slowly. 110 * @pull_down: Enable pull down when regulator is disabled. 111 * @over_current_protection: Auto disable on over current event. 112 * 113 * @input_uV: Input voltage for regulator when supplied by another regulator. 114 * 115 * @state_disk: State for regulator when system is suspended in disk mode. 116 * @state_mem: State for regulator when system is suspended in mem mode. 117 * @state_standby: State for regulator when system is suspended in standby 118 * mode. 119 * @initial_state: Suspend state to set by default. 120 * @initial_mode: Mode to set at startup. 121 * @ramp_delay: Time to settle down after voltage change (unit: uV/us) 122 * @settling_time: Time to settle down after voltage change when voltage 123 * change is non-linear (unit: microseconds). 124 * @settling_time_up: Time to settle down after voltage increase when voltage 125 * change is non-linear (unit: microseconds). 126 * @settling_time_down : Time to settle down after voltage decrease when 127 * voltage change is non-linear (unit: microseconds). 128 * @active_discharge: Enable/disable active discharge. The enum 129 * regulator_active_discharge values are used for 130 * initialisation. 131 * @enable_time: Turn-on time of the rails (unit: microseconds) 132 */ 133 struct regulation_constraints { 134 135 const char *name; 136 137 /* voltage output range (inclusive) - for voltage control */ 138 int min_uV; 139 int max_uV; 140 141 int uV_offset; 142 143 /* current output range (inclusive) - for current control */ 144 int min_uA; 145 int max_uA; 146 int ilim_uA; 147 148 int system_load; 149 150 /* valid regulator operating modes for this machine */ 151 unsigned int valid_modes_mask; 152 153 /* valid operations for regulator on this machine */ 154 unsigned int valid_ops_mask; 155 156 /* regulator input voltage - only if supply is another regulator */ 157 int input_uV; 158 159 /* regulator suspend states for global PMIC STANDBY/HIBERNATE */ 160 struct regulator_state state_disk; 161 struct regulator_state state_mem; 162 struct regulator_state state_standby; 163 suspend_state_t initial_state; /* suspend state to set at init */ 164 165 /* mode to set on startup */ 166 unsigned int initial_mode; 167 168 unsigned int ramp_delay; 169 unsigned int settling_time; 170 unsigned int settling_time_up; 171 unsigned int settling_time_down; 172 unsigned int enable_time; 173 174 unsigned int active_discharge; 175 176 /* constraint flags */ 177 unsigned always_on:1; /* regulator never off when system is on */ 178 unsigned boot_on:1; /* bootloader/firmware enabled regulator */ 179 unsigned apply_uV:1; /* apply uV constraint if min == max */ 180 unsigned ramp_disable:1; /* disable ramp delay */ 181 unsigned soft_start:1; /* ramp voltage slowly */ 182 unsigned pull_down:1; /* pull down resistor when regulator off */ 183 unsigned over_current_protection:1; /* auto disable on over current */ 184 }; 185 186 /** 187 * struct regulator_consumer_supply - supply -> device mapping 188 * 189 * This maps a supply name to a device. Use of dev_name allows support for 190 * buses which make struct device available late such as I2C. 191 * 192 * @dev_name: Result of dev_name() for the consumer. 193 * @supply: Name for the supply. 194 */ 195 struct regulator_consumer_supply { 196 const char *dev_name; /* dev_name() for consumer */ 197 const char *supply; /* consumer supply - e.g. "vcc" */ 198 }; 199 200 /* Initialize struct regulator_consumer_supply */ 201 #define REGULATOR_SUPPLY(_name, _dev_name) \ 202 { \ 203 .supply = _name, \ 204 .dev_name = _dev_name, \ 205 } 206 207 /** 208 * struct regulator_init_data - regulator platform initialisation data. 209 * 210 * Initialisation constraints, our supply and consumers supplies. 211 * 212 * @supply_regulator: Parent regulator. Specified using the regulator name 213 * as it appears in the name field in sysfs, which can 214 * be explicitly set using the constraints field 'name'. 215 * 216 * @constraints: Constraints. These must be specified for the regulator to 217 * be usable. 218 * @num_consumer_supplies: Number of consumer device supplies. 219 * @consumer_supplies: Consumer device supply configuration. 220 * 221 * @regulator_init: Callback invoked when the regulator has been registered. 222 * @driver_data: Data passed to regulator_init. 223 */ 224 struct regulator_init_data { 225 const char *supply_regulator; /* or NULL for system supply */ 226 227 struct regulation_constraints constraints; 228 229 int num_consumer_supplies; 230 struct regulator_consumer_supply *consumer_supplies; 231 232 /* optional regulator machine specific init */ 233 int (*regulator_init)(void *driver_data); 234 void *driver_data; /* core does not touch this */ 235 }; 236 237 #ifdef CONFIG_REGULATOR 238 void regulator_has_full_constraints(void); 239 #else 240 static inline void regulator_has_full_constraints(void) 241 { 242 } 243 #endif 244 245 static inline int regulator_suspend_prepare(suspend_state_t state) 246 { 247 return 0; 248 } 249 static inline int regulator_suspend_finish(void) 250 { 251 return 0; 252 } 253 254 #endif 255