PDK API Guide for J721E
pmic_gpio_tps6594x.h
Go to the documentation of this file.
1 /******************************************************************************
2  * Copyright (c) 2020 Texas Instruments Incorporated - https://www.ti.com
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  *****************************************************************************/
46 #ifndef PMIC_GPIO_TPS6594X_H_
47 #define PMIC_GPIO_TPS6594X_H_
48 
49 /* ========================================================================== */
50 /* Include Files */
51 /* ========================================================================== */
52 #include <pmic_core.h>
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 /* ========================================================================== */
59 /* Macros & Typedefs */
60 /* ========================================================================== */
61 
68 #define PMIC_TPS6594X_GPIO1_PIN (1U)
69 #define PMIC_TPS6594X_GPIO2_PIN (2U)
70 #define PMIC_TPS6594X_GPIO3_PIN (3U)
71 #define PMIC_TPS6594X_GPIO4_PIN (4U)
72 #define PMIC_TPS6594X_GPIO5_PIN (5U)
73 #define PMIC_TPS6594X_GPIO6_PIN (6U)
74 #define PMIC_TPS6594X_GPIO7_PIN (7U)
75 #define PMIC_TPS6594X_GPIO8_PIN (8U)
76 #define PMIC_TPS6594X_GPIO9_PIN (9U)
77 #define PMIC_TPS6594X_GPIO10_PIN (10U)
78 #define PMIC_TPS6594X_GPIO11_PIN (11U)
79 /* @} */
80 
89 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO (0U)
90 
92 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO1_SCL_I2C2_CS_SPI (1U)
93 
95 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO2_GPIO11_TRIG_WDOG (1U)
96 
98 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO3_GPIO4_GPIO8_CLK32KOUT (1U)
99 
101 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO5_SCLK_SPMI (1U)
102 
104 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO6_SDATA_SPMI (1U)
105 
107 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO7_NERR_MCU (1U)
108 
110 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO9_PGOOD (1U)
111 
113 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO10_SYNCCLKIN (1U)
114 
116 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO1_GPIO11_NRSTOUT_SOC (2U)
117 
119 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO2_SDA_I2C2_SDO_SPI (2U)
120 
122 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO3_NERR_SOC (2U)
123 
125 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO8_GPIO10_SYNCCLKOUT (2U)
126 
128 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO9_DISABLE_WDOG (2U)
129 
131 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO8_DISABLE_WDOG (3U)
132 
134 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO9_SYNCCLKOUT (3U)
135 
137 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO10_CLK32KOUT (3U)
138 
140 #define PMIC_TPS6594X_GPIO_PINFUNC_NSLEEP1 (4U)
141 
143 #define PMIC_TPS6594X_GPIO_PINFUNC_NSLEEP2 (5U)
144 
146 #define PMIC_TPS6594X_GPIO_PINFUNC_WKUP1 (6U)
147 
149 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO3_GPIO4_LP_WKUP1 (6U)
150 
152 #define PMIC_TPS6594X_GPIO_PINFUNC_WKUP2 (7U)
153 
155 #define PMIC_TPS6594X_GPIO_PINFUNC_GPIO3_GPIO4_LP_WKUP2 (7U)
156 /* @} */
157 
165 #define PMIC_TPS6594X_NPWRON_PINFUNC_ENABLE (0U)
166 
167 #define PMIC_TPS6594X_NPWRON_PINFUNC_NPWRON (1U)
168 
169 #define PMIC_TPS6594X_NPWRON_PINFUNC_NONE (2U)
170 /* @} */
171 
172 /*==========================================================================*/
173 /* Structures and Enums */
174 /*==========================================================================*/
175 
176 /*==========================================================================*/
177 /* Function Declarations */
178 /*==========================================================================*/
179 
198  uint8_t *pPinValue);
199 
200 #ifdef __cplusplus
201 }
202 #endif /* __cplusplus */
203 
204 #endif /* PMIC_GPIO_TPS6594X_H_ */
205 
206 /* @} */
PMIC Interface Handle. Contains various PMIC driver instance specific information....
Definition: pmic_types.h:148
PMIC Driver Common API/interface file.
int32_t Pmic_gpioTps6594xNPwronPinGetValue(Pmic_CoreHandle_t *pPmicCoreHandle, uint8_t *pPinValue)
API to get PMIC GPIO NPWRON/Enable pin value.