Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 1 | /* |
| 2 | * machine.h -- SoC Regulator support, machine/board driver API. |
| 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 | 4c1184e | 2008-04-30 15:46:09 +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 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. |
Mark Brown | f59c8f9 | 2012-08-31 10:36:37 -0700 | [diff] [blame] | 35 | * BYPASS: Regulator can be put into bypass mode |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 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 |
Mark Brown | f59c8f9 | 2012-08-31 10:36:37 -0700 | [diff] [blame] | 43 | #define REGULATOR_CHANGE_BYPASS 0x20 |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 44 | |
| 45 | /** |
Wolfram Sang | 2e7e65c | 2009-09-18 22:44:43 +0200 | [diff] [blame] | 46 | * struct regulator_state - regulator state during low power system states |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 47 | * |
Mark Brown | 638f85c | 2009-10-22 16:31:33 +0100 | [diff] [blame] | 48 | * This describes a regulators state during a system wide low power |
| 49 | * state. One of enabled or disabled must be set for the |
| 50 | * configuration to be applied. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 51 | * |
| 52 | * @uV: Operating voltage during suspend. |
| 53 | * @mode: Operating mode during suspend. |
| 54 | * @enabled: Enabled during suspend. |
Mark Brown | 638f85c | 2009-10-22 16:31:33 +0100 | [diff] [blame] | 55 | * @disabled: Disabled during suspend. |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 56 | */ |
| 57 | struct regulator_state { |
| 58 | int uV; /* suspend voltage */ |
| 59 | unsigned int mode; /* suspend regulator operating mode */ |
| 60 | int enabled; /* is regulator enabled in this suspend state */ |
Mark Brown | 638f85c | 2009-10-22 16:31:33 +0100 | [diff] [blame] | 61 | int disabled; /* is the regulator disbled in this suspend state */ |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 62 | }; |
| 63 | |
| 64 | /** |
| 65 | * struct regulation_constraints - regulator operating constraints. |
| 66 | * |
| 67 | * This struct describes regulator and board/machine specific constraints. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 68 | * |
| 69 | * @name: Descriptive name for the constraints, used for display purposes. |
| 70 | * |
| 71 | * @min_uV: Smallest voltage consumers may set. |
| 72 | * @max_uV: Largest voltage consumers may set. |
Mark Brown | bf5892a | 2011-05-08 22:13:37 +0100 | [diff] [blame] | 73 | * @uV_offset: Offset applied to voltages from consumer to compensate for |
| 74 | * voltage drops. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 75 | * |
Axel Lin | 15c08f6 | 2012-03-29 12:21:17 +0800 | [diff] [blame] | 76 | * @min_uA: Smallest current consumers may set. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 77 | * @max_uA: Largest current consumers may set. |
| 78 | * |
| 79 | * @valid_modes_mask: Mask of modes which may be configured by consumers. |
| 80 | * @valid_ops_mask: Operations which may be performed by consumers. |
| 81 | * |
| 82 | * @always_on: Set if the regulator should never be disabled. |
| 83 | * @boot_on: Set if the regulator is enabled when the system is initially |
Mark Brown | cacf90f | 2009-03-02 16:32:46 +0000 | [diff] [blame] | 84 | * started. If the regulator is not enabled by the hardware or |
| 85 | * bootloader then it will be enabled when the constraints are |
| 86 | * applied. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 87 | * @apply_uV: Apply the voltage constraint when initialising. |
| 88 | * |
| 89 | * @input_uV: Input voltage for regulator when supplied by another regulator. |
| 90 | * |
| 91 | * @state_disk: State for regulator when system is suspended in disk mode. |
| 92 | * @state_mem: State for regulator when system is suspended in mem mode. |
| 93 | * @state_standby: State for regulator when system is suspended in standby |
| 94 | * mode. |
| 95 | * @initial_state: Suspend state to set by default. |
Mark Brown | a308466 | 2009-02-26 19:24:19 +0000 | [diff] [blame] | 96 | * @initial_mode: Mode to set at startup. |
Axel Lin | ea38d13 | 2012-06-18 14:03:16 +0800 | [diff] [blame] | 97 | * @ramp_delay: Time to settle down after voltage change (unit: uV/us) |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 98 | */ |
| 99 | struct regulation_constraints { |
| 100 | |
Mark Brown | 0151546 | 2011-10-14 13:36:04 +0100 | [diff] [blame] | 101 | const char *name; |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 102 | |
| 103 | /* voltage output range (inclusive) - for voltage control */ |
| 104 | int min_uV; |
| 105 | int max_uV; |
| 106 | |
Mark Brown | bf5892a | 2011-05-08 22:13:37 +0100 | [diff] [blame] | 107 | int uV_offset; |
| 108 | |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 109 | /* current output range (inclusive) - for current control */ |
| 110 | int min_uA; |
| 111 | int max_uA; |
| 112 | |
| 113 | /* valid regulator operating modes for this machine */ |
| 114 | unsigned int valid_modes_mask; |
| 115 | |
| 116 | /* valid operations for regulator on this machine */ |
| 117 | unsigned int valid_ops_mask; |
| 118 | |
| 119 | /* regulator input voltage - only if supply is another regulator */ |
| 120 | int input_uV; |
| 121 | |
| 122 | /* regulator suspend states for global PMIC STANDBY/HIBERNATE */ |
| 123 | struct regulator_state state_disk; |
| 124 | struct regulator_state state_mem; |
| 125 | struct regulator_state state_standby; |
| 126 | suspend_state_t initial_state; /* suspend state to set at init */ |
| 127 | |
Mark Brown | a308466 | 2009-02-26 19:24:19 +0000 | [diff] [blame] | 128 | /* mode to set on startup */ |
| 129 | unsigned int initial_mode; |
| 130 | |
Yadwinder Singh Brar | 6f0b2c6 | 2012-06-11 17:41:08 +0530 | [diff] [blame] | 131 | unsigned int ramp_delay; |
| 132 | |
Wolfram Sang | 2e7e65c | 2009-09-18 22:44:43 +0200 | [diff] [blame] | 133 | /* constraint flags */ |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 134 | unsigned always_on:1; /* regulator never off when system is on */ |
| 135 | unsigned boot_on:1; /* bootloader/firmware enabled regulator */ |
Wolfram Sang | 2e7e65c | 2009-09-18 22:44:43 +0200 | [diff] [blame] | 136 | unsigned apply_uV:1; /* apply uV constraint if min == max */ |
Yadwinder Singh Brar | 1653ccf | 2013-06-29 18:21:15 +0530 | [diff] [blame] | 137 | unsigned ramp_disable:1; /* disable ramp delay */ |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 138 | }; |
| 139 | |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 140 | /** |
| 141 | * struct regulator_consumer_supply - supply -> device mapping |
| 142 | * |
Axel Lin | 15c08f6 | 2012-03-29 12:21:17 +0800 | [diff] [blame] | 143 | * This maps a supply name to a device. Use of dev_name allows support for |
| 144 | * buses which make struct device available late such as I2C. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 145 | * |
Mark Brown | 40f9244 | 2009-06-17 17:56:39 +0100 | [diff] [blame] | 146 | * @dev_name: Result of dev_name() for the consumer. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 147 | * @supply: Name for the supply. |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 148 | */ |
| 149 | struct regulator_consumer_supply { |
Mark Brown | 40f9244 | 2009-06-17 17:56:39 +0100 | [diff] [blame] | 150 | const char *dev_name; /* dev_name() for consumer */ |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 151 | const char *supply; /* consumer supply - e.g. "vcc" */ |
| 152 | }; |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 153 | |
roald | ed65432 | 2009-07-13 17:25:21 +0800 | [diff] [blame] | 154 | /* Initialize struct regulator_consumer_supply */ |
| 155 | #define REGULATOR_SUPPLY(_name, _dev_name) \ |
| 156 | { \ |
| 157 | .supply = _name, \ |
| 158 | .dev_name = _dev_name, \ |
| 159 | } |
| 160 | |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 161 | /** |
| 162 | * struct regulator_init_data - regulator platform initialisation data. |
| 163 | * |
| 164 | * Initialisation constraints, our supply and consumers supplies. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 165 | * |
Mark Brown | 0178f3e | 2010-04-26 15:18:14 +0100 | [diff] [blame] | 166 | * @supply_regulator: Parent regulator. Specified using the regulator name |
| 167 | * as it appears in the name field in sysfs, which can |
| 168 | * be explicitly set using the constraints field 'name'. |
Mark Brown | c8e7e46 | 2008-12-31 12:52:42 +0000 | [diff] [blame] | 169 | * |
| 170 | * @constraints: Constraints. These must be specified for the regulator to |
| 171 | * be usable. |
| 172 | * @num_consumer_supplies: Number of consumer device supplies. |
| 173 | * @consumer_supplies: Consumer device supply configuration. |
| 174 | * |
| 175 | * @regulator_init: Callback invoked when the regulator has been registered. |
| 176 | * @driver_data: Data passed to regulator_init. |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 177 | */ |
| 178 | struct regulator_init_data { |
Mark Brown | 0178f3e | 2010-04-26 15:18:14 +0100 | [diff] [blame] | 179 | const char *supply_regulator; /* or NULL for system supply */ |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 180 | |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 181 | struct regulation_constraints constraints; |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 182 | |
Liam Girdwood | a5766f1 | 2008-10-10 13:22:20 +0100 | [diff] [blame] | 183 | int num_consumer_supplies; |
| 184 | struct regulator_consumer_supply *consumer_supplies; |
| 185 | |
| 186 | /* optional regulator machine specific init */ |
| 187 | int (*regulator_init)(void *driver_data); |
| 188 | void *driver_data; /* core does not touch this */ |
| 189 | }; |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 190 | |
| 191 | int regulator_suspend_prepare(suspend_state_t state); |
MyungJoo Ham | 7a32b58 | 2011-03-11 10:13:59 +0900 | [diff] [blame] | 192 | int regulator_suspend_finish(void); |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 193 | |
Mark Brown | 9c19bc0 | 2009-07-09 15:44:31 +0100 | [diff] [blame] | 194 | #ifdef CONFIG_REGULATOR |
Mark Brown | ca72556 | 2009-03-16 19:36:34 +0000 | [diff] [blame] | 195 | void regulator_has_full_constraints(void); |
Mark Brown | 688fe99 | 2010-10-05 19:18:32 -0700 | [diff] [blame] | 196 | void regulator_use_dummy_regulator(void); |
Mark Brown | 9c19bc0 | 2009-07-09 15:44:31 +0100 | [diff] [blame] | 197 | #else |
| 198 | static inline void regulator_has_full_constraints(void) |
| 199 | { |
| 200 | } |
Mark Brown | 688fe99 | 2010-10-05 19:18:32 -0700 | [diff] [blame] | 201 | |
| 202 | static inline void regulator_use_dummy_regulator(void) |
| 203 | { |
| 204 | } |
Mark Brown | 9c19bc0 | 2009-07-09 15:44:31 +0100 | [diff] [blame] | 205 | #endif |
Mark Brown | ca72556 | 2009-03-16 19:36:34 +0000 | [diff] [blame] | 206 | |
Liam Girdwood | 4c1184e | 2008-04-30 15:46:09 +0100 | [diff] [blame] | 207 | #endif |