1*5928f538SLaxman Dewangan /*
2*5928f538SLaxman Dewangan  * max8973-regulator.h -- MAXIM 8973 regulator
3*5928f538SLaxman Dewangan  *
4*5928f538SLaxman Dewangan  * Interface for regulator driver for MAXIM 8973 DC-DC step-down
5*5928f538SLaxman Dewangan  * switching regulator.
6*5928f538SLaxman Dewangan  *
7*5928f538SLaxman Dewangan  * Copyright (C) 2012 NVIDIA Corporation
8*5928f538SLaxman Dewangan 
9*5928f538SLaxman Dewangan  * Author: Laxman Dewangan <ldewangan@nvidia.com>
10*5928f538SLaxman Dewangan  *
11*5928f538SLaxman Dewangan  * This program is free software; you can redistribute it and/or modify
12*5928f538SLaxman Dewangan  * it under the terms of the GNU General Public License as published by
13*5928f538SLaxman Dewangan  * the Free Software Foundation; either version 2 of the License, or
14*5928f538SLaxman Dewangan  * (at your option) any later version.
15*5928f538SLaxman Dewangan  *
16*5928f538SLaxman Dewangan  * This program is distributed in the hope that it will be useful, but WITHOUT
17*5928f538SLaxman Dewangan  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18*5928f538SLaxman Dewangan  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
19*5928f538SLaxman Dewangan  * more details.
20*5928f538SLaxman Dewangan  *
21*5928f538SLaxman Dewangan  * You should have received a copy of the GNU General Public License along
22*5928f538SLaxman Dewangan  * with this program; if not, write to the Free Software Foundation, Inc.,
23*5928f538SLaxman Dewangan  * 51 Franklin Street, Fifth Floor, Boston, MA	02110-1301, USA.
24*5928f538SLaxman Dewangan  *
25*5928f538SLaxman Dewangan  */
26*5928f538SLaxman Dewangan 
27*5928f538SLaxman Dewangan #ifndef __LINUX_REGULATOR_MAX8973_H
28*5928f538SLaxman Dewangan #define __LINUX_REGULATOR_MAX8973_H
29*5928f538SLaxman Dewangan 
30*5928f538SLaxman Dewangan /*
31*5928f538SLaxman Dewangan  * Control flags for configuration of the device.
32*5928f538SLaxman Dewangan  * Client need to pass this information with ORed
33*5928f538SLaxman Dewangan  */
34*5928f538SLaxman Dewangan #define MAX8973_CONTROL_REMOTE_SENSE_ENABLE			0x00000001
35*5928f538SLaxman Dewangan #define MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE		0x00000002
36*5928f538SLaxman Dewangan #define MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE		0x00000004
37*5928f538SLaxman Dewangan #define MAX8973_CONTROL_BIAS_ENABLE				0x00000008
38*5928f538SLaxman Dewangan #define MAX8973_CONTROL_PULL_DOWN_ENABLE			0x00000010
39*5928f538SLaxman Dewangan #define MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE			0x00000020
40*5928f538SLaxman Dewangan 
41*5928f538SLaxman Dewangan #define MAX8973_CONTROL_CLKADV_TRIP_DISABLED			0x00000000
42*5928f538SLaxman Dewangan #define MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US			0x00010000
43*5928f538SLaxman Dewangan #define MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US		0x00020000
44*5928f538SLaxman Dewangan #define MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US_HIST_DIS	0x00030000
45*5928f538SLaxman Dewangan 
46*5928f538SLaxman Dewangan #define MAX8973_CONTROL_INDUCTOR_VALUE_NOMINAL			0x00000000
47*5928f538SLaxman Dewangan #define MAX8973_CONTROL_INDUCTOR_VALUE_MINUS_30_PER		0x00100000
48*5928f538SLaxman Dewangan #define MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_30_PER		0x00200000
49*5928f538SLaxman Dewangan #define MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_60_PER		0x00300000
50*5928f538SLaxman Dewangan 
51*5928f538SLaxman Dewangan /*
52*5928f538SLaxman Dewangan  * struct max8973_regulator_platform_data - max8973 regulator platform data.
53*5928f538SLaxman Dewangan  *
54*5928f538SLaxman Dewangan  * @reg_init_data: The regulator init data.
55*5928f538SLaxman Dewangan  * @control_flags: Control flags which are ORed value of above flags to
56*5928f538SLaxman Dewangan  *		configure device.
57*5928f538SLaxman Dewangan  * @enable_ext_control: Enable the voltage enable/disable through external
58*5928f538SLaxman Dewangan  *		control signal from EN input pin. If it is false then
59*5928f538SLaxman Dewangan  *		voltage output will be enabled/disabled through EN bit of
60*5928f538SLaxman Dewangan  *		device register.
61*5928f538SLaxman Dewangan  * @dvs_gpio: GPIO for dvs. It should be -1 if this is tied with fixed logic.
62*5928f538SLaxman Dewangan  * @dvs_def_state: Default state of dvs. 1 if it is high else 0.
63*5928f538SLaxman Dewangan  */
64*5928f538SLaxman Dewangan struct max8973_regulator_platform_data {
65*5928f538SLaxman Dewangan 	struct regulator_init_data *reg_init_data;
66*5928f538SLaxman Dewangan 	unsigned long control_flags;
67*5928f538SLaxman Dewangan 	bool enable_ext_control;
68*5928f538SLaxman Dewangan 	int dvs_gpio;
69*5928f538SLaxman Dewangan 	unsigned dvs_def_state:1;
70*5928f538SLaxman Dewangan };
71*5928f538SLaxman Dewangan 
72*5928f538SLaxman Dewangan #endif /* __LINUX_REGULATOR_MAX8973_H */
73