Prepare v2023.10
[platform/kernel/u-boot.git] / include / tps6586x.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  *  (C) Copyright 2010,2011
4  *  NVIDIA Corporation <www.nvidia.com>
5  */
6
7 #ifndef _TPS6586X_H_
8 #define _TPS6586X_H_
9
10 struct udevice;
11
12 enum {
13         /* SM0-2 PWM/PFM Mode Selection */
14         TPS6586X_PWM_SM0        = 1 << 0,
15         TPS6586X_PWM_SM1        = 1 << 1,
16         TPS6586X_PWM_SM2        = 1 << 2,
17 };
18
19 /**
20  * Enable PWM mode for selected SM0-2
21  *
22  * @param mask  Mask of synchronous converter to enable (TPS6586X_PWM_...)
23  * Return: 0 if ok, -1 on error
24  */
25 int tps6586x_set_pwm_mode(int mask);
26
27 /**
28  * Adjust SM0 and SM1 voltages to the given targets in incremental steps.
29  *
30  * @param sm0_target    Target voltage for SM0 in 25mW units, 0=725mV, 31=1.5V
31  * @param sm1_target    Target voltage for SM1 in 25mW units, 0=725mV, 31=1.5V
32  * @param step          Amount to change voltage in each step, in 25mW units
33  * @param rate          Slew ratein mV/us: 0=instantly, 1=0.11, 2=0.22,
34  *                      3=0.44, 4=0.88, 5=1.76, 6=3.52, 7=7.04
35  * @param min_sm0_over_sm1      Minimum amount by which sm0 must exceed sm1.
36  *                      If this condition is not met, no adjustment will be
37  *                      done and an error will be reported. Use -1 to skip
38  *                      this check.
39  * Return: 0 if ok, -1 on error
40  */
41 int tps6586x_adjust_sm0_sm1(int sm0_target, int sm1_target, int step, int rate,
42                             int min_sm0_over_sm1);
43
44 /**
45  * Set up the TPS6586X I2C bus number. This will be used for all operations
46  * on the device. This function must be called before using other functions.
47  *
48  * @param bus   I2C bus containing the TPS6586X chip
49  * Return: 0 (always succeeds)
50  */
51 int tps6586x_init(struct udevice *bus);
52
53 #endif  /* _TPS6586X_H_ */