summaryrefslogtreecommitdiff
path: root/Board/EM/Platform/Library/Dxe/DxeKscLib/DxeKscLib.c
blob: f48c57699672d5c54ddc64ec5a70dc013a743b02 (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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
#include <Protocol\CpuIo.h>
#include <AmiDxeLib.h>
#include "KscLib.h"

EFI_CPU_IO_PROTOCOL   *mDxeKscLibCpuIo;

BOOLEAN mDxeKscLibInitialized = FALSE;
extern EFI_BOOT_SERVICES         *pBS;

//
// Function implemenations
//
EFI_STATUS
InitializeKscLib (
  VOID
  )
/*++

Routine Description:

  Initialize the library.
  The DXE library only requires CPU IO protocol, so this will locate CPU IO protocol
  and save it for future use.

Arguments:

  None.

Returns: 

  EFI_SUCCESS       - KscLib is successfully initialized.

--*/ 
{
  EFI_STATUS                  Status;
  UINT8                       Data;

  //
  // Locate CpuIo protocol
  //

  Status = pBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &mDxeKscLibCpuIo);
  ASSERT_EFI_ERROR (Status);

  //
  // Fail if EC doesn't exist.
  //
  mDxeKscLibCpuIo->Io.Read (mDxeKscLibCpuIo, EfiCpuIoWidthUint8, KSC_C_PORT, 1, &Data);
  if(Data == 0xff){
    mDxeKscLibInitialized = FALSE;
    Status = EFI_DEVICE_ERROR;
  } else {
    mDxeKscLibInitialized = TRUE;
    Status = EFI_SUCCESS;
  }
  return Status;
}

EFI_STATUS
SendKscCommand (
  UINT8                 Command
  )
/*++

Routine Description:

  Sends command to Keyboard System Controller.

Arguments:

  Command  - Command byte to send

Returns: 

  EFI_SUCCESS       - Command success
  EFI_DEVICE_ERROR  - Command error

--*/ 
{
  UINTN         Index;
  UINT8         KscStatus;
  EFI_STATUS    Status;

  KscStatus = 0;
  Index = 0;

  //
  // Locate CpuIo protocol
  //

  Status = pBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &mDxeKscLibCpuIo);
  ASSERT_EFI_ERROR (Status);

  //
  // Wait for KSC to be ready (with a timeout)
  //
  ReceiveKscStatus (&KscStatus); 
  while (((KscStatus & KSC_S_IBF) != 0) && (Index < KSC_TIME_OUT)) {
    pBS->Stall (15);
    ReceiveKscStatus (&KscStatus);
    Index++;
  }
  if (Index >= KSC_TIME_OUT) {
    return EFI_DEVICE_ERROR;
  }

  //
  // Send the KSC command
  //
  Status = mDxeKscLibCpuIo->Io.Write (
                             mDxeKscLibCpuIo,
                             EfiCpuIoWidthUint8,
                             KSC_C_PORT,
                             1,
                             &Command
                             );
  ASSERT_EFI_ERROR (Status);

  return EFI_SUCCESS;
}

EFI_STATUS
ReceiveKscStatus (
  UINT8                 *KscStatus
  )
/*++

Routine Description:

  Receives status from Keyboard System Controller.

Arguments:

  Status  - Status byte to receive
  
Returns: 

  EFI_SUCCESS       - Always success

--*/
{ 
  EFI_STATUS Status = EFI_SUCCESS;

  //
  // Locate CpuIo protocol
  //

  Status = pBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &mDxeKscLibCpuIo);
  ASSERT_EFI_ERROR (Status);

  //
  // Read and return the status 
  //
  Status = mDxeKscLibCpuIo->Io.Read (
                             mDxeKscLibCpuIo,
                             EfiCpuIoWidthUint8,
                             KSC_C_PORT,
                             1,
                             KscStatus
                             );
  ASSERT_EFI_ERROR (Status);

  return EFI_SUCCESS;
}

EFI_STATUS
SendKscData (
  UINT8                 Data
  )
/*++

Routine Description:

  Sends data to Keyboard System Controller.

Arguments:

  Data  - Data byte to send

Returns: 

  EFI_SUCCESS       - Success
  EFI_TIMEOUT       - Timeout
  Other             - Failed

--*/ 
{
  UINTN         Index;
  UINT8         KscStatus;
  EFI_STATUS    Status = EFI_SUCCESS;

  Index = 0;

  //
  // Locate CpuIo protocol
  //
  Status = pBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &mDxeKscLibCpuIo);
  ASSERT_EFI_ERROR (Status);

  //
  // Wait for KSC to be ready (with a timeout)
  //
  ReceiveKscStatus (&KscStatus);
  while (((KscStatus & KSC_S_IBF) != 0) && (Index < KSC_TIME_OUT)) {
    pBS->Stall (15);
    ReceiveKscStatus (&KscStatus);
    Index++;
  }
  if (Index >= KSC_TIME_OUT) {
    return EFI_DEVICE_ERROR;
  }

  //
  // Send the data and return
  //
  Status = mDxeKscLibCpuIo->Io.Write (
                             mDxeKscLibCpuIo,
                             EfiCpuIoWidthUint8,
                             KSC_D_PORT,
                             1,
                             &Data
                             );
  ASSERT_EFI_ERROR (Status);

  return EFI_SUCCESS;
}

EFI_STATUS
ReceiveKscData (
  UINT8   *Data
 )
/*++

Routine Description:

  Receives data from Keyboard System Controller.

Arguments:

  Data  - Data byte received

Returns: 

  EFI_SUCCESS       - Read success
  EFI_DEVICE_ERROR  - Read error

--*/ 
{
  UINTN         Index;
  UINT8         KscStatus;  
  EFI_STATUS    Status = EFI_SUCCESS;

  Index = 0;

  //
  // Locate CpuIo protocol
  //

  Status = pBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &mDxeKscLibCpuIo);
  ASSERT_EFI_ERROR (Status);
  //
  // Wait for KSC to be ready (with a timeout)
  //
  ReceiveKscStatus (&KscStatus);
  while (((KscStatus & KSC_S_OBF) == 0) && (Index < KSC_TIME_OUT)) {
    pBS->Stall (15);
    ReceiveKscStatus (&KscStatus);
    Index++;
  }
  if (Index >= KSC_TIME_OUT) {
    return EFI_DEVICE_ERROR;
  }

  //
  // Read KSC data and return
  //
  Status = mDxeKscLibCpuIo->Io.Read (
                             mDxeKscLibCpuIo,
                             EfiCpuIoWidthUint8,
                             KSC_D_PORT,
                             1,
                             Data
                             );
  ASSERT_EFI_ERROR (Status);

  return EFI_SUCCESS;
}