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 <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 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.
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 * struct regulator_state - regulator state during low power system states
47 *
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.
51 *
52 * @uV: Operating voltage during suspend.
53 * @mode: Operating mode during suspend.
54 * @enabled: Enabled during suspend.
55 * @disabled: Disabled during suspend.
56 */
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 */
61	int disabled; /* is the regulator disbled in this suspend state */
62};
63
64/**
65 * struct regulation_constraints - regulator operating constraints.
66 *
67 * This struct describes regulator and board/machine specific constraints.
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.
73 * @uV_offset: Offset applied to voltages from consumer to compensate for
74 *             voltage drops.
75 *
76 * @min_uA: Smallest current consumers may set.
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
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.
87 * @apply_uV: Apply the voltage constraint when initialising.
88 * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
89 *
90 * @input_uV: Input voltage for regulator when supplied by another regulator.
91 *
92 * @state_disk: State for regulator when system is suspended in disk mode.
93 * @state_mem: State for regulator when system is suspended in mem mode.
94 * @state_standby: State for regulator when system is suspended in standby
95 *                 mode.
96 * @initial_state: Suspend state to set by default.
97 * @initial_mode: Mode to set at startup.
98 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
99 * @enable_time: Turn-on time of the rails (unit: microseconds)
100 */
101struct regulation_constraints {
102
103	const char *name;
104
105	/* voltage output range (inclusive) - for voltage control */
106	int min_uV;
107	int max_uV;
108
109	int uV_offset;
110
111	/* current output range (inclusive) - for current control */
112	int min_uA;
113	int max_uA;
114
115	/* valid regulator operating modes for this machine */
116	unsigned int valid_modes_mask;
117
118	/* valid operations for regulator on this machine */
119	unsigned int valid_ops_mask;
120
121	/* regulator input voltage - only if supply is another regulator */
122	int input_uV;
123
124	/* regulator suspend states for global PMIC STANDBY/HIBERNATE */
125	struct regulator_state state_disk;
126	struct regulator_state state_mem;
127	struct regulator_state state_standby;
128	suspend_state_t initial_state; /* suspend state to set at init */
129
130	/* mode to set on startup */
131	unsigned int initial_mode;
132
133	unsigned int ramp_delay;
134	unsigned int enable_time;
135
136	/* constraint flags */
137	unsigned always_on:1;	/* regulator never off when system is on */
138	unsigned boot_on:1;	/* bootloader/firmware enabled regulator */
139	unsigned apply_uV:1;	/* apply uV constraint if min == max */
140	unsigned ramp_disable:1; /* disable ramp delay */
141};
142
143/**
144 * struct regulator_consumer_supply - supply -> device mapping
145 *
146 * This maps a supply name to a device. Use of dev_name allows support for
147 * buses which make struct device available late such as I2C.
148 *
149 * @dev_name: Result of dev_name() for the consumer.
150 * @supply: Name for the supply.
151 */
152struct regulator_consumer_supply {
153	const char *dev_name;   /* dev_name() for consumer */
154	const char *supply;	/* consumer supply - e.g. "vcc" */
155};
156
157/* Initialize struct regulator_consumer_supply */
158#define REGULATOR_SUPPLY(_name, _dev_name)			\
159{								\
160	.supply		= _name,				\
161	.dev_name	= _dev_name,				\
162}
163
164/**
165 * struct regulator_init_data - regulator platform initialisation data.
166 *
167 * Initialisation constraints, our supply and consumers supplies.
168 *
169 * @supply_regulator: Parent regulator.  Specified using the regulator name
170 *                    as it appears in the name field in sysfs, which can
171 *                    be explicitly set using the constraints field 'name'.
172 *
173 * @constraints: Constraints.  These must be specified for the regulator to
174 *               be usable.
175 * @num_consumer_supplies: Number of consumer device supplies.
176 * @consumer_supplies: Consumer device supply configuration.
177 *
178 * @regulator_init: Callback invoked when the regulator has been registered.
179 * @driver_data: Data passed to regulator_init.
180 */
181struct regulator_init_data {
182	const char *supply_regulator;        /* or NULL for system supply */
183
184	struct regulation_constraints constraints;
185
186	int num_consumer_supplies;
187	struct regulator_consumer_supply *consumer_supplies;
188
189	/* optional regulator machine specific init */
190	int (*regulator_init)(void *driver_data);
191	void *driver_data;	/* core does not touch this */
192};
193
194#ifdef CONFIG_REGULATOR
195void regulator_has_full_constraints(void);
196int regulator_suspend_prepare(suspend_state_t state);
197int regulator_suspend_finish(void);
198#else
199static inline void regulator_has_full_constraints(void)
200{
201}
202static inline int regulator_suspend_prepare(suspend_state_t state)
203{
204	return 0;
205}
206static inline int regulator_suspend_finish(void)
207{
208	return 0;
209}
210#endif
211
212#endif
213