blob: b11be126012974ebf4877220c8949310d649ddea [file] [log] [blame]
Liam Girdwood4c1184e2008-04-30 15:46:09 +01001/*
2 * machine.h -- SoC Regulator support, machine/board driver API.
3 *
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
5 *
Liam Girdwood1dd68f02009-02-02 21:43:31 +00006 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
Liam Girdwood4c1184e2008-04-30 15:46:09 +01007 *
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
21struct 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 Brownf59c8f92012-08-31 10:36:37 -070035 * BYPASS: Regulator can be put into bypass mode
Liam Girdwood4c1184e2008-04-30 15:46:09 +010036 */
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 Brownf59c8f92012-08-31 10:36:37 -070043#define REGULATOR_CHANGE_BYPASS 0x20
Liam Girdwood4c1184e2008-04-30 15:46:09 +010044
45/**
Wolfram Sang2e7e65c2009-09-18 22:44:43 +020046 * struct regulator_state - regulator state during low power system states
Liam Girdwood4c1184e2008-04-30 15:46:09 +010047 *
Mark Brown638f85c2009-10-22 16:31:33 +010048 * 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 Brownc8e7e462008-12-31 12:52:42 +000051 *
52 * @uV: Operating voltage during suspend.
53 * @mode: Operating mode during suspend.
54 * @enabled: Enabled during suspend.
Mark Brown638f85c2009-10-22 16:31:33 +010055 * @disabled: Disabled during suspend.
Liam Girdwood4c1184e2008-04-30 15:46:09 +010056 */
57struct 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 Brown638f85c2009-10-22 16:31:33 +010061 int disabled; /* is the regulator disbled in this suspend state */
Liam Girdwood4c1184e2008-04-30 15:46:09 +010062};
63
64/**
65 * struct regulation_constraints - regulator operating constraints.
66 *
67 * This struct describes regulator and board/machine specific constraints.
Mark Brownc8e7e462008-12-31 12:52:42 +000068 *
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 Brownbf5892a2011-05-08 22:13:37 +010073 * @uV_offset: Offset applied to voltages from consumer to compensate for
74 * voltage drops.
Mark Brownc8e7e462008-12-31 12:52:42 +000075 *
Axel Lin15c08f62012-03-29 12:21:17 +080076 * @min_uA: Smallest current consumers may set.
Mark Brownc8e7e462008-12-31 12:52:42 +000077 * @max_uA: Largest current consumers may set.
Stephen Boyd36e4f832015-06-11 17:37:06 -070078 * @ilim_uA: Maximum input current.
Stephen Boyd22a10bc2015-06-11 17:37:03 -070079 * @system_load: Load that isn't captured by any consumer requests.
Mark Brownc8e7e462008-12-31 12:52:42 +000080 *
81 * @valid_modes_mask: Mask of modes which may be configured by consumers.
82 * @valid_ops_mask: Operations which may be performed by consumers.
83 *
84 * @always_on: Set if the regulator should never be disabled.
85 * @boot_on: Set if the regulator is enabled when the system is initially
Mark Browncacf90f2009-03-02 16:32:46 +000086 * started. If the regulator is not enabled by the hardware or
87 * bootloader then it will be enabled when the constraints are
88 * applied.
Mark Brownc8e7e462008-12-31 12:52:42 +000089 * @apply_uV: Apply the voltage constraint when initialising.
Randy Dunlapa8dbfee2014-08-27 14:31:24 -070090 * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
Stephen Boydc751ad02015-06-12 15:48:06 -070091 * @soft_start: Enable soft start so that voltage ramps slowly.
Stephen Boyd23c779b2015-06-11 17:37:04 -070092 * @pull_down: Enable pull down when regulator is disabled.
Mark Brownc8e7e462008-12-31 12:52:42 +000093 *
94 * @input_uV: Input voltage for regulator when supplied by another regulator.
95 *
96 * @state_disk: State for regulator when system is suspended in disk mode.
97 * @state_mem: State for regulator when system is suspended in mem mode.
98 * @state_standby: State for regulator when system is suspended in standby
99 * mode.
100 * @initial_state: Suspend state to set by default.
Mark Browna3084662009-02-26 19:24:19 +0000101 * @initial_mode: Mode to set at startup.
Axel Linea38d132012-06-18 14:03:16 +0800102 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
Laxman Dewangan00c877c2013-09-18 18:18:02 +0530103 * @enable_time: Turn-on time of the rails (unit: microseconds)
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100104 */
105struct regulation_constraints {
106
Mark Brown01515462011-10-14 13:36:04 +0100107 const char *name;
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100108
109 /* voltage output range (inclusive) - for voltage control */
110 int min_uV;
111 int max_uV;
112
Mark Brownbf5892a2011-05-08 22:13:37 +0100113 int uV_offset;
114
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100115 /* current output range (inclusive) - for current control */
116 int min_uA;
117 int max_uA;
Stephen Boyd36e4f832015-06-11 17:37:06 -0700118 int ilim_uA;
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100119
Stephen Boyd22a10bc2015-06-11 17:37:03 -0700120 int system_load;
121
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100122 /* valid regulator operating modes for this machine */
123 unsigned int valid_modes_mask;
124
125 /* valid operations for regulator on this machine */
126 unsigned int valid_ops_mask;
127
128 /* regulator input voltage - only if supply is another regulator */
129 int input_uV;
130
131 /* regulator suspend states for global PMIC STANDBY/HIBERNATE */
132 struct regulator_state state_disk;
133 struct regulator_state state_mem;
134 struct regulator_state state_standby;
135 suspend_state_t initial_state; /* suspend state to set at init */
136
Mark Browna3084662009-02-26 19:24:19 +0000137 /* mode to set on startup */
138 unsigned int initial_mode;
139
Yadwinder Singh Brar6f0b2c62012-06-11 17:41:08 +0530140 unsigned int ramp_delay;
Laxman Dewangan00c877c2013-09-18 18:18:02 +0530141 unsigned int enable_time;
Yadwinder Singh Brar6f0b2c62012-06-11 17:41:08 +0530142
Wolfram Sang2e7e65c2009-09-18 22:44:43 +0200143 /* constraint flags */
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100144 unsigned always_on:1; /* regulator never off when system is on */
145 unsigned boot_on:1; /* bootloader/firmware enabled regulator */
Wolfram Sang2e7e65c2009-09-18 22:44:43 +0200146 unsigned apply_uV:1; /* apply uV constraint if min == max */
Yadwinder Singh Brar1653ccf2013-06-29 18:21:15 +0530147 unsigned ramp_disable:1; /* disable ramp delay */
Stephen Boyd57f66b72015-06-11 17:37:05 -0700148 unsigned soft_start:1; /* ramp voltage slowly */
Stephen Boyd23c779b2015-06-11 17:37:04 -0700149 unsigned pull_down:1; /* pull down resistor when regulator off */
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100150};
151
Liam Girdwooda5766f12008-10-10 13:22:20 +0100152/**
153 * struct regulator_consumer_supply - supply -> device mapping
154 *
Axel Lin15c08f62012-03-29 12:21:17 +0800155 * This maps a supply name to a device. Use of dev_name allows support for
156 * buses which make struct device available late such as I2C.
Mark Brownc8e7e462008-12-31 12:52:42 +0000157 *
Mark Brown40f92442009-06-17 17:56:39 +0100158 * @dev_name: Result of dev_name() for the consumer.
Mark Brownc8e7e462008-12-31 12:52:42 +0000159 * @supply: Name for the supply.
Liam Girdwooda5766f12008-10-10 13:22:20 +0100160 */
161struct regulator_consumer_supply {
Mark Brown40f92442009-06-17 17:56:39 +0100162 const char *dev_name; /* dev_name() for consumer */
Liam Girdwooda5766f12008-10-10 13:22:20 +0100163 const char *supply; /* consumer supply - e.g. "vcc" */
164};
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100165
roalded654322009-07-13 17:25:21 +0800166/* Initialize struct regulator_consumer_supply */
167#define REGULATOR_SUPPLY(_name, _dev_name) \
168{ \
169 .supply = _name, \
170 .dev_name = _dev_name, \
171}
172
Liam Girdwooda5766f12008-10-10 13:22:20 +0100173/**
174 * struct regulator_init_data - regulator platform initialisation data.
175 *
176 * Initialisation constraints, our supply and consumers supplies.
Mark Brownc8e7e462008-12-31 12:52:42 +0000177 *
Mark Brown0178f3e2010-04-26 15:18:14 +0100178 * @supply_regulator: Parent regulator. Specified using the regulator name
179 * as it appears in the name field in sysfs, which can
180 * be explicitly set using the constraints field 'name'.
Mark Brownc8e7e462008-12-31 12:52:42 +0000181 *
182 * @constraints: Constraints. These must be specified for the regulator to
183 * be usable.
184 * @num_consumer_supplies: Number of consumer device supplies.
185 * @consumer_supplies: Consumer device supply configuration.
186 *
187 * @regulator_init: Callback invoked when the regulator has been registered.
188 * @driver_data: Data passed to regulator_init.
Liam Girdwooda5766f12008-10-10 13:22:20 +0100189 */
190struct regulator_init_data {
Mark Brown0178f3e2010-04-26 15:18:14 +0100191 const char *supply_regulator; /* or NULL for system supply */
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100192
Liam Girdwooda5766f12008-10-10 13:22:20 +0100193 struct regulation_constraints constraints;
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100194
Liam Girdwooda5766f12008-10-10 13:22:20 +0100195 int num_consumer_supplies;
196 struct regulator_consumer_supply *consumer_supplies;
197
198 /* optional regulator machine specific init */
199 int (*regulator_init)(void *driver_data);
200 void *driver_data; /* core does not touch this */
201};
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100202
Mark Brown9c19bc02009-07-09 15:44:31 +0100203#ifdef CONFIG_REGULATOR
Mark Brownca725562009-03-16 19:36:34 +0000204void regulator_has_full_constraints(void);
Krzysztof Kozlowski50910272015-02-04 11:45:28 +0100205int regulator_suspend_prepare(suspend_state_t state);
206int regulator_suspend_finish(void);
Mark Brown9c19bc02009-07-09 15:44:31 +0100207#else
208static inline void regulator_has_full_constraints(void)
209{
210}
Krzysztof Kozlowski50910272015-02-04 11:45:28 +0100211static inline int regulator_suspend_prepare(suspend_state_t state)
212{
213 return 0;
214}
215static inline int regulator_suspend_finish(void)
216{
217 return 0;
218}
Mark Brown9c19bc02009-07-09 15:44:31 +0100219#endif
Mark Brownca725562009-03-16 19:36:34 +0000220
Liam Girdwood4c1184e2008-04-30 15:46:09 +0100221#endif