xref: /openbmc/u-boot/include/tps6586x.h (revision 37544a6d)
1 /*
2  *  (C) Copyright 2010,2011
3  *  NVIDIA Corporation <www.nvidia.com>
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23 
24 #ifndef __H_
25 #define _TPS6586X_H_
26 
27 enum {
28 	/* SM0-2 PWM/PFM Mode Selection */
29 	TPS6586X_PWM_SM0	= 1 << 0,
30 	TPS6586X_PWM_SM1	= 1 << 1,
31 	TPS6586X_PWM_SM2	= 1 << 2,
32 };
33 
34 /**
35  * Enable PWM mode for selected SM0-2
36  *
37  * @param mask	Mask of synchronous converter to enable (TPS6586X_PWM_...)
38  * @return 0 if ok, -1 on error
39  */
40 int tps6586x_set_pwm_mode(int mask);
41 
42 /**
43  * Adjust SM0 and SM1 voltages to the given targets in incremental steps.
44  *
45  * @param sm0_target	Target voltage for SM0 in 25mW units, 0=725mV, 31=1.5V
46  * @param sm1_target	Target voltage for SM1 in 25mW units, 0=725mV, 31=1.5V
47  * @param step		Amount to change voltage in each step, in 25mW units
48  * @param rate		Slew ratein mV/us: 0=instantly, 1=0.11, 2=0.22,
49  *			3=0.44, 4=0.88, 5=1.76, 6=3.52, 7=7.04
50  * @param min_sm0_over_sm1	Minimum amount by which sm0 must exceed sm1.
51  *			If this condition is not met, no adjustment will be
52  *			done and an error will be reported. Use -1 to skip
53  *			this check.
54  * @return 0 if ok, -1 on error
55  */
56 int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate,
57 			    int min_sm0_over_sm1);
58 
59 /**
60  * Set up the TPS6586X I2C bus number. This will be used for all operations
61  * on the device. This function must be called before using other functions.
62  *
63  * @param bus	I2C bus number containing the TPS6586X chip
64  * @return 0 (always succeeds)
65  */
66 int tps6586x_init(int bus);
67 
68 #endif	/* _TPS6586X_H_ */
69