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
|
/** @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 _PCH_SBI_ACCESS_LIB_H_
#define _PCH_SBI_ACCESS_LIB_H_
/**
PCH SBI Register structure
**/
typedef struct {
UINT32 SbiAddr;
UINT32 SbiExtAddr;
UINT32 SbiData;
UINT16 SbiStat;
UINT16 SbiRid;
} PCH_SBI_REGISTER_STRUCT;
/**
PCH SBI opcode definitions
**/
typedef enum {
MemoryRead = 0x0,
MemoryWrite = 0x1,
PciConfigRead = 0x4,
PciConfigWrite = 0x5,
PrivateControlRead = 0x6,
PrivateControlWrite = 0x7,
GpioLockUnlock = 0x13
} PCH_SBI_OPCODE;
/**
PCH SBI response status definitions
**/
typedef enum {
SBI_SUCCESSFUL = 0,
SBI_UNSUCCESSFUL = 1,
SBI_POWERDOWN = 2,
SBI_MIXED = 3,
SBI_INVALID_RESPONSE
} PCH_SBI_RESPONSE;
/**
Execute PCH SBI message
Take care of that there is no lock protection when using SBI programming in both POST time and SMI.
It will clash with POST time SBI programming when SMI happen.
Programmer MUST do the save and restore opration while using the PchSbiExecution inside SMI
to prevent from racing condition.
This function will reveal P2SB and hide P2SB if it's originally hidden. If more than one SBI access
needed, it's better to unhide the P2SB before calling and hide it back after done.
When the return value is "EFI_SUCCESS", the "Response" do not need to be checked as it would have been
SBI_SUCCESS. If the return value is "EFI_DEVICE_ERROR", then this would provide additional information
when needed.
@param[in] Pid Port ID of the SBI message
@param[in] Offset Offset of the SBI message
@param[in] Opcode Opcode
@param[in] Posted Posted message
@param[in, out] Data32 Read/Write data
@param[out] Response Response
@retval EFI_SUCCESS Successfully completed.
@retval EFI_DEVICE_ERROR Transaction fail
@retval EFI_INVALID_PARAMETER Invalid parameter
**/
EFI_STATUS
EFIAPI
PchSbiExecution (
IN PCH_SBI_PID Pid,
IN UINT64 Offset,
IN PCH_SBI_OPCODE Opcode,
IN BOOLEAN Posted,
IN OUT UINT32 *Data32,
OUT UINT8 *Response
);
/**
Full function for executing PCH SBI message
Take care of that there is no lock protection when using SBI programming in both POST time and SMI.
It will clash with POST time SBI programming when SMI happen.
Programmer MUST do the save and restore opration while using the PchSbiExecution inside SMI
to prevent from racing condition.
This function will reveal P2SB and hide P2SB if it's originally hidden. If more than one SBI access
needed, it's better to unhide the P2SB before calling and hide it back after done.
When the return value is "EFI_SUCCESS", the "Response" do not need to be checked as it would have been
SBI_SUCCESS. If the return value is "EFI_DEVICE_ERROR", then this would provide additional information
when needed.
@param[in] Pid Port ID of the SBI message
@param[in] Offset Offset of the SBI message
@param[in] Opcode Opcode
@param[in] Posted Posted message
@param[in] Fbe First byte enable
@param[in] Bar Bar
@param[in] Fid Function ID
@param[in, out] Data32 Read/Write data
@param[out] Response Response
@retval EFI_SUCCESS Successfully completed.
@retval EFI_DEVICE_ERROR Transaction fail
@retval EFI_INVALID_PARAMETER Invalid parameter
**/
EFI_STATUS
EFIAPI
PchSbiExecutionEx (
IN PCH_SBI_PID Pid,
IN UINT64 Offset,
IN PCH_SBI_OPCODE Opcode,
IN BOOLEAN Posted,
IN UINT16 Fbe,
IN UINT16 Bar,
IN UINT16 Fid,
IN OUT UINT32 *Data32,
OUT UINT8 *Response
);
/**
This function saves all PCH SBI registers.
The save and restore operations must be done while using the PchSbiExecution inside SMM.
It prevents the racing condition of PchSbiExecution re-entry between POST and SMI.
Before using this function, make sure the P2SB is not hidden.
@param[in, out] PchSbiRegister Structure for saving the registers
@retval EFI_SUCCESS Successfully completed.
@retval EFI_DEVICE_ERROR Device is hidden.
**/
EFI_STATUS
EFIAPI
PchSbiRegisterSave (
IN OUT PCH_SBI_REGISTER_STRUCT *PchSbiRegister
);
/**
This function restores all PCH SBI registers
The save and restore operations must be done while using the PchSbiExecution inside SMM.
It prevents the racing condition of PchSbiExecution re-entry between POST and SMI.
Before using this function, make sure the P2SB is not hidden.
@param[in] PchSbiRegister Structure for restoring the registers
@retval EFI_SUCCESS Successfully completed.
@retval EFI_DEVICE_ERROR Device is hidden.
**/
EFI_STATUS
EFIAPI
PchSbiRegisterRestore (
IN PCH_SBI_REGISTER_STRUCT *PchSbiRegister
);
#endif // _PCH_SBI_ACCESS_LIB_H_
|
