blob: ddeeee6490dcb0bb5bd968b954781abc02267ae4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/** @file
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _GPIO_NATIVE_LIB_H_
#define _GPIO_NATIVE_LIB_H_
#include <GpioConfig.h>
/**
This procedure will get number of pads for certain GPIO group
@param[in] Group GPIO group number
@retval Value Pad number for group
If illegal group number then return 0
**/
UINT32
GpioGetPadPerGroup (
IN GPIO_GROUP Group
);
/**
This procedure will get number of groups
@param[in] none
@retval Value Group number
**/
UINT8
GpioGetNumberOfGroups (
VOID
);
/**
This procedure will get lowest group
@param[in] none
@retval Value Lowest Group
**/
GPIO_GROUP
GpioGetLowestGroup (
VOID
);
/**
This procedure will get highest group
@param[in] none
@retval Value Highest Group
**/
GPIO_GROUP
GpioGetHighestGroup (
VOID
);
/**
This procedure will get group
@param[in] GpioPad Gpio Pad
@retval Value Group
**/
GPIO_GROUP
GpioGetGroupFromGpioPad (
IN GPIO_PAD GpioPad
);
/**
This procedure will get group index (0 based) from GpioPad
@param[in] GpioPad Gpio Pad
@retval Value Group Index
**/
UINT32
GpioGetGroupIndexFromGpioPad (
IN GPIO_PAD GpioPad
);
/**
This procedure will get group index (0 based) from group
@param[in] GpioGroup Gpio Group
@retval Value Group Index
**/
UINT32
GpioGetGroupIndexFromGroup (
IN GPIO_GROUP GpioGroup
);
/**
This procedure will get pad number (0 based) from Gpio Pad
@param[in] GpioPad Gpio Pad
@retval Value Pad Number
**/
UINT32
GpioGetPadNumberFromGpioPad (
IN GPIO_PAD GpioPad
);
/**
This procedure will return GpioPad from Group and PadNumber
@param[in] Group GPIO group
@param[in] PadNumber GPIO PadNumber
@retval GpioPad GpioPad
**/
GPIO_PAD
GpioGetGpioPadFromGroupAndPadNumber (
IN GPIO_GROUP Group,
IN UINT32 PadNumber
);
/**
This procedure will return GpioPad from GroupIndex and PadNumber
@param[in] GroupIndex GPIO GroupIndex
@param[in] PadNumber GPIO PadNumber
@retval GpioPad GpioPad
**/
GPIO_PAD
GpioGetGpioPadFromGroupIndexAndPadNumber (
IN UINT32 GroupIndex,
IN UINT32 PadNumber
);
/**
This function sets SerialIo I2C controller pins into native mode
@param[in] SerialIoI2cControllerNumber I2C controller
@retval Status
**/
EFI_STATUS
GpioSetSerialIoI2cPinsIntoNativeMode (
IN UINT32 SerialIoI2cControllerNumber
);
/**
This function sets SerialIo I2C controller pins tolerance
@param[in] SerialIoI2CControllerNumber I2C controller
@param[in] Pad1v8Tolerance TRUE: Enable 1v8 Pad tolerance
FALSE: Disable 1v8 Pad tolerance
@retval Status
**/
EFI_STATUS
GpioSetSerialIoI2CPinsTolerance (
IN UINT32 SerialIoI2CControllerNumber,
IN BOOLEAN Pad1v8Tolerance
);
/**
This function sets SerialIo UART controller pins into native mode
@param[in] SerialIoI2CControllerNumber UART controller
@param[in] HardwareFlowControl Hardware Flow control
@retval Status
**/
EFI_STATUS
GpioSetSerialIoUartPinsIntoNativeMode (
IN UINT32 SerialIoUartControllerNumber,
IN BOOLEAN HardwareFlowControl
);
/**
This function sets SerialIo SPI controller pins into native mode
@param[in] SerialIoI2CControllerNumber SPI controller
@retval Status
**/
EFI_STATUS
GpioSetSerialIoSpiPinsIntoNativeMode (
IN UINT32 SerialIoUartControllerNumber
);
/**
This function checks if GPIO pin for SATA reset port is in GPIO MODE
@param[in] SataPort SATA port number
@retval TRUE Pin is in GPIO mode
FALSE Pin is in native mode
**/
BOOLEAN
GpioIsSataResetPortInGpioMode (
IN UINTN SataPort
);
/**
This function checks if SataDevSlp pin is in native mode
@param[in] SataPort SATA port
@param[out] DevSlpPad DevSlpPad
@retval TRUE DevSlp is in native mode
FALSE DevSlp is not in native mode
**/
BOOLEAN
GpioIsSataDevSlpPinEnabled (
IN UINTN SataPort,
OUT GPIO_PAD *DevSlpPad
);
#endif // _GPIO_NATIVE_LIB_H_
|