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
|
/** @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_LIBRARY_H_
#define _GPIO_LIBRARY_H_
#include <Base.h>
#include <Uefi/UefiBaseType.h>
#include <Library/IoLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <PchAccess.h>
#include <Library/PchPcrLib.h>
#include <GpioPinsSklH.h>
#include <Library/GpioLib.h>
#include <Library/GpioNativeLib.h>
#include <Library/MmPciBaseLib.h>
#include <Library/PchInfoLib.h>
#include <Library/PchCycleDecodingLib.h>
#include <Library/PchSbiAccessLib.h>
typedef struct {
GPIO_PAD Pad;
GPIO_PAD_MODE Mode;
} GPIO_PAD_NATIVE_FUNCTION;
// BIT15-0 - pad number
// BIT31-16 - group info
// BIT23- 16 - group index
// BIT31- 24 - chipset ID
#define PAD_INFO_MASK 0x0000FFFF
#define GROUP_INFO_POSITION 16
#define GROUP_INFO_MASK 0xFFFF0000
#define GROUP_INDEX_MASK 0x00FF0000
#define UNIQUE_ID_MASK 0xFF000000
#define UNIQUE_ID_POSITION 24
#define GPIO_PAD_DEF(Group,Pad) (UINT32)((Group << 16) + Pad)
#define GPIO_GROUP_DEF(Index,ChipsetId) (Index | (ChipsetId << 8))
#define GPIO_GET_GROUP_INDEX(Group) (Group & 0xFF)
#define GPIO_GET_GROUP_FROM_PAD(Pad) (Pad >> 16)
#define GPIO_GET_GROUP_INDEX_FROM_PAD(Pad) GPIO_GET_GROUP_INDEX ((Pad >> 16))
#define GPIO_GET_PAD_NUMBER(Pad) (Pad & 0xFFFF)
#define GPIO_GET_CHIPSET_ID(Pad) (Pad >> 24)
//
// Unique ID used in GpioPad defines
//
#define GPIO_SKL_H_CHIPSET_ID 0x1
#define GPIO_SKL_LP_CHIPSET_ID 0x2
//
// Below defines are based on GPIO_CONFIG structure fields
//
#define GPIO_CONF_PAD_MODE_MASK 0xF
#define GPIO_CONF_PAD_MODE_BIT_POS 0
#define GPIO_CONF_HOST_OWN_MASK 0x3
#define GPIO_CONF_HOST_OWN_BIT_POS 0
#define GPIO_CONF_DIR_MASK 0x7
#define GPIO_CONF_DIR_BIT_POS 0
#define GPIO_CONF_INV_MASK 0x18
#define GPIO_CONF_INV_BIT_POS 3
#define GPIO_CONF_OUTPUT_MASK 0x3
#define GPIO_CONF_OUTPUT_BIT_POS 0
#define GPIO_CONF_INT_ROUTE_MASK 0x1F
#define GPIO_CONF_INT_ROUTE_BIT_POS 0
#define GPIO_CONF_INT_TRIG_MASK 0xE0
#define GPIO_CONF_INT_TRIG_BIT_POS 5
#define GPIO_CONF_RESET_MASK 0x7
#define GPIO_CONF_RESET_BIT_POS 0
#define GPIO_CONF_TERM_MASK 0x1F
#define GPIO_CONF_TERM_BIT_POS 0
#define GPIO_CONF_PADTOL_MASK 0x60
#define GPIO_CONF_PADTOL_BIT_POS 5
#define GPIO_CONF_LOCK_MASK 0x7
#define GPIO_CONF_LOCK_BIT_POS 0
#define GPIO_CONF_RXRAW_MASK 0x3
#define GPIO_CONF_RXRAW_BIT_POS 0
//
// Structure for storing information about registers offset, community,
// maximal pad number for available groups
//
typedef struct {
UINT32 Community;
UINT32 PadOwnOffset;
UINT32 HostOwnOffset;
UINT32 GpiIsOffset;
UINT32 GpiIeOffset;
UINT32 GpiGpeStsOffset;
UINT32 GpiGpeEnOffset;
UINT32 SmiStsOffset;
UINT32 SmiEnOffset;
UINT32 NmiStsOffset;
UINT32 NmiEnOffset;
UINT32 PadCfgLockOffset;
UINT32 PadCfgLockTxOffset;
UINT32 PadCfgOffset;
UINT32 PadPerGroup;
} GPIO_GROUP_INFO;
//
// If in GPIO_GROUP_INFO structure certain register doesn't exist
// it will have value equal to NO_REGISTER_FOR_PROPERTY
//
#define NO_REGISTER_FOR_PROPERTY (~0u)
/**
This procedure is used to check if GpioPad is valid for certain chipset
@param[in] GpioPad GPIO pad
@retval TRUE This pin is valid on this chipset
FALSE Incorrect pin
**/
BOOLEAN
GpioIsCorrectPadForThisChipset (
IN GPIO_PAD GpioPad
);
/**
This procedure will retrieve address and length of GPIO info table
@param[out] GpioGroupInfoTableLength Length of GPIO group table
@retval Pointer to GPIO group table
**/
GPIO_GROUP_INFO*
GpioGetGroupInfoTable (
OUT UINTN *GpioGroupInfoTableLength
);
/**
This procedure will set GPIO mode
@param[in] GpioPad GPIO pad
@param[out] PadModeValue GPIO pad mode value
@retval EFI_SUCCESS The function completed successfully
@retval EFI_INVALID_PARAMETER Invalid group or pad number
**/
EFI_STATUS
SetGpioPadMode (
IN GPIO_PAD GpioPad,
IN GPIO_PAD_MODE PadModeValue
);
/**
This procedure will get GPIO mode
@param[in] GpioPad GPIO pad
@param[out] PadModeValue GPIO pad mode value
@retval EFI_SUCCESS The function completed successfully
@retval EFI_INVALID_PARAMETER Invalid group or pad number
**/
EFI_STATUS
GetGpioPadMode (
IN GPIO_PAD GpioPad,
OUT GPIO_PAD_MODE *PadModeValue
);
/**
This function checks if GPIO pin is a GSPI chip select pin
@param[in] GpioPad GPIO pad
@param[in] PadMode GPIO pad mode
@retval TRUE Pin is in GPIO mode
FALSE Pin is in native mode
**/
BOOLEAN
GpioIsGpioPadAGSpiCsbPin (
IN GPIO_PAD GpioPad,
IN GPIO_PAD_MODE PadMode
);
/**
This function checks if GPIO pin is a SataDevSlp pin
@param[in] GpioPad GPIO pad
@param[in] PadMode GPIO pad mode
@retval TRUE Pin is in GPIO mode
FALSE Pin is in native mode
**/
BOOLEAN
GpioIsPadASataDevSlpPin (
IN GPIO_PAD GpioPad,
IN GPIO_PAD_MODE PadMode
);
/**
Check if given GPIO Pad is locked
@param[in] GroupIndex GPIO group index
@param[in] PadNumber GPIO pad number
@retval TRUE Pad is locked
@retval FALSE Pad is not locked
**/
BOOLEAN
GpioIsPadLocked (
IN UINT32 GroupIndex,
IN GPIO_PAD PadNumber
);
#endif // _GPIO_LIBRARY_H_
|
