summaryrefslogtreecommitdiff
path: root/BraswellPlatformPkg/Common/Library/Ksc/Smm/SmmKscLib.c
blob: 65be4d2ce14b93a2f82754426b31953f52469eb9 (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
/** @file
  SMM KSC library implementation.

  Copyright (c) 1999 - 2015, 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
  which 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.

**/

#include "SmmKscLib.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.

  @Return  EFI_SUCCESS          KscLib is successfully initialized.

**/
EFI_STATUS
InitializeKscLib (
  VOID
  )
{
  //
  // Fail if EC doesn't exist.
  //
  if (SmmIoRead8(KSC_C_PORT) == 0xff) {
    mSmmKscLibInitialized = FALSE;
    return EFI_DEVICE_ERROR;
  }

  mSmmKscLibInitialized = TRUE;

  return EFI_SUCCESS;
}

/**
  Sends command to Keyboard System Controller.

  @param     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 = 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)) {
    SmmStall (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  KscStatus           Status byte to receive

  @Return   EFI_SUCCESS      Always success

**/
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   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)) {
    SmmStall (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   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)) {
    SmmStall (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;
}