Linux-libre 5.7.6-gnu
[librecmc/linux-libre.git] / include / linux / regulator / max8973-regulator.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * max8973-regulator.h -- MAXIM 8973 regulator
4  *
5  * Interface for regulator driver for MAXIM 8973 DC-DC step-down
6  * switching regulator.
7  *
8  * Copyright (C) 2012 NVIDIA Corporation
9
10  * Author: Laxman Dewangan <ldewangan@nvidia.com>
11  */
12
13 #ifndef __LINUX_REGULATOR_MAX8973_H
14 #define __LINUX_REGULATOR_MAX8973_H
15
16 /*
17  * Control flags for configuration of the device.
18  * Client need to pass this information with ORed
19  */
20 #define MAX8973_CONTROL_REMOTE_SENSE_ENABLE                     0x00000001
21 #define MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE                0x00000002
22 #define MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE              0x00000004
23 #define MAX8973_CONTROL_BIAS_ENABLE                             0x00000008
24 #define MAX8973_CONTROL_PULL_DOWN_ENABLE                        0x00000010
25 #define MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE                  0x00000020
26
27 #define MAX8973_CONTROL_CLKADV_TRIP_DISABLED                    0x00000000
28 #define MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US                 0x00010000
29 #define MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US                0x00020000
30 #define MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US_HIST_DIS        0x00030000
31
32 #define MAX8973_CONTROL_INDUCTOR_VALUE_NOMINAL                  0x00000000
33 #define MAX8973_CONTROL_INDUCTOR_VALUE_MINUS_30_PER             0x00100000
34 #define MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_30_PER              0x00200000
35 #define MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_60_PER              0x00300000
36
37 /*
38  * struct max8973_regulator_platform_data - max8973 regulator platform data.
39  *
40  * @reg_init_data: The regulator init data.
41  * @control_flags: Control flags which are ORed value of above flags to
42  *              configure device.
43  * @junction_temp_warning: Junction temp in millicelcius on which warning need
44  *                         to be set. Thermal functionality is only supported on
45  *                         MAX77621. The threshold warning supported by MAX77621
46  *                         are 120C and 140C.
47  * @enable_ext_control: Enable the voltage enable/disable through external
48  *              control signal from EN input pin. If it is false then
49  *              voltage output will be enabled/disabled through EN bit of
50  *              device register.
51  * @enable_gpio: Enable GPIO. If EN pin is controlled through GPIO from host
52  *              then GPIO number can be provided. If no GPIO controlled then
53  *              it should be -1.
54  * @dvs_gpio: GPIO for dvs. It should be -1 if this is tied with fixed logic.
55  * @dvs_def_state: Default state of dvs. 1 if it is high else 0.
56  */
57 struct max8973_regulator_platform_data {
58         struct regulator_init_data *reg_init_data;
59         unsigned long control_flags;
60         unsigned long junction_temp_warning;
61         bool enable_ext_control;
62         int enable_gpio;
63         int dvs_gpio;
64         unsigned dvs_def_state:1;
65 };
66
67 #endif /* __LINUX_REGULATOR_MAX8973_H */