blob: 079482f8158916fd0c47b5018a4bb8edb521c0df (
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
225
226
227
228
|
/** @file
SMM KSC library implementation.
These functions need to be SMM safe.
These functions require the SMM IO library (SmmIoLib) to be present.
Caller must link those libraries and have the proper include path.
@copyright
Copyright (c) 1999 - 2013 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains a 'Sample Driver' and is licensed as such
under the terms of your license agreement with Intel or your
vendor. This file may be modified by the user, subject to
the additional terms of the license agreement
**/
#include "KscLib.h"
#include "SmmIoLib.h"
#include "PchAccess.h"
#include "PchPlatformLib.h"
BOOLEAN mSmmKscLibInitialized = FALSE;
///
/// Function implemenations
///
/**
Initialize the library.
The SMM library only requires SMM IO library and has no initialization.
However, this must be called prior to use of any other KSC library functions
for future compatibility.
@param[in] None.
@retval EFI_SUCCESS - KscLib is successfully initialized.
**/
EFI_STATUS
InitializeKscLib (
VOID
)
{
EFI_STATUS Status;
///
/// Fail if EC doesn't exist.
///
if (SmmIoRead8 (KSC_C_PORT) == 0xff) {
mSmmKscLibInitialized = FALSE;
Status = EFI_DEVICE_ERROR;
} else {
mSmmKscLibInitialized = TRUE;
Status = EFI_SUCCESS;
}
return Status;
}
/**
Sends command to Keyboard System Controller.
@param[in] Command - Command byte to send
@retval EFI_SUCCESS - Command success
@retval EFI_DEVICE_ERROR - Command error
**/
EFI_STATUS
SendKscCommand (
UINT8 Command
)
{
UINTN Index;
UINT8 KscStatus;
KscStatus = 0;
///
/// Verify if KscLib has been initialized, NOT if EC dose not exist.
///
if (mSmmKscLibInitialized == FALSE) {
return EFI_DEVICE_ERROR;
}
Index = 0;
///
/// Wait for KSC to be ready (with a timeout)
///
ReceiveKscStatus (&KscStatus);
while (((KscStatus & KSC_S_IBF) != 0) && (Index < KSC_TIME_OUT)) {
PchPmTimerStall(15);
ReceiveKscStatus (&KscStatus);
Index++;
}
if (Index >= KSC_TIME_OUT) {
return EFI_DEVICE_ERROR;
}
///
/// Send the KSC command
///
SmmIoWrite8 (KSC_C_PORT, Command);
return EFI_SUCCESS;
}
/**
Receives status from Keyboard System Controller.
@param[in] KscStatus - Status byte to receive
@retval EFI_DEVICE_ERROR - Ksc library has not initialized yet or KSC not present
@retval EFI_SUCCESS - Get KSC status successfully
**/
EFI_STATUS
ReceiveKscStatus (
UINT8 *KscStatus
)
{
///
/// Verify if KscLib has been initialized, NOT if EC dose not exist.
///
if (mSmmKscLibInitialized == FALSE) {
return EFI_DEVICE_ERROR;
}
///
/// Read and return the status
///
*KscStatus = SmmIoRead8 (KSC_C_PORT);
return EFI_SUCCESS;
}
/**
Sends data to Keyboard System Controller.
@param[in] Data - Data byte to send
@retval EFI_SUCCESS - Success
@retval EFI_DEVICE_ERROR - Error
**/
EFI_STATUS
SendKscData (
UINT8 Data
)
{
UINTN Index;
UINT8 KscStatus;
///
/// Verify if KscLib has been initialized, NOT if EC dose not exist.
///
if (mSmmKscLibInitialized == FALSE) {
return EFI_DEVICE_ERROR;
}
Index = 0;
///
/// Wait for KSC to be ready (with a timeout)
///
ReceiveKscStatus (&KscStatus);
while (((KscStatus & KSC_S_IBF) != 0) && (Index < KSC_TIME_OUT)) {
PchPmTimerStall(15);
ReceiveKscStatus (&KscStatus);
Index++;
}
if (Index >= KSC_TIME_OUT) {
return EFI_DEVICE_ERROR;
}
///
/// Send the data and return
///
SmmIoWrite8 (KSC_D_PORT, Data);
return EFI_SUCCESS;
}
/**
Receives data from Keyboard System Controller.
@param[in] Data - Data byte received
@retval EFI_SUCCESS - Read success
@retval EFI_DEVICE_ERROR - Read error
**/
EFI_STATUS
ReceiveKscData (
UINT8 *Data
)
{
UINTN Index;
UINT8 KscStatus;
///
/// Verify if KscLib has been initialized, NOT if EC dose not exist.
///
if (mSmmKscLibInitialized == FALSE) {
return EFI_DEVICE_ERROR;
}
Index = 0;
///
/// Wait for KSC to be ready (with a timeout)
///
ReceiveKscStatus (&KscStatus);
while (((KscStatus & KSC_S_OBF) == 0) && (Index < KSC_TIME_OUT)) {
PchPmTimerStall(15);
ReceiveKscStatus (&KscStatus);
Index++;
}
if (Index >= KSC_TIME_OUT) {
return EFI_DEVICE_ERROR;
}
///
/// Read KSC data and return
///
*Data = SmmIoRead8 (KSC_D_PORT);
return EFI_SUCCESS;
}
|
