Commit | Line | Data |
---|---|---|
172870ef | 1 | /** @file\r |
0a6f4824 | 2 | PS2 Mouse Communication Interface\r |
05fbd06d | 3 | \r |
0a6f4824 | 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
c0a00b14 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
05fbd06d | 6 | \r |
f8cd287b | 7 | **/\r |
05fbd06d | 8 | \r |
9 | #ifndef _COMMPS2_H_\r | |
10 | #define _COMMPS2_H_\r | |
11 | \r | |
05fbd06d | 12 | #define PS2_PACKET_LENGTH 3\r |
13 | #define PS2_SYNC_MASK 0xc\r | |
14 | #define PS2_SYNC_BYTE 0x8\r | |
15 | \r | |
16 | #define IS_PS2_SYNC_BYTE(byte) ((byte & PS2_SYNC_MASK) == PS2_SYNC_BYTE)\r | |
17 | \r | |
18 | #define PS2_READ_BYTE_ONE 0\r | |
19 | #define PS2_READ_DATA_BYTE 1\r | |
20 | #define PS2_PROCESS_PACKET 2\r | |
21 | \r | |
22 | #define TIMEOUT 50000\r | |
23 | #define BAT_TIMEOUT 500000\r | |
24 | \r | |
25 | //\r | |
26 | // 8042 I/O Port\r | |
27 | //\r | |
28 | #define KBC_DATA_PORT 0x60\r | |
29 | #define KBC_CMD_STS_PORT 0x64\r | |
30 | \r | |
31 | //\r | |
32 | // 8042 Command\r | |
33 | //\r | |
34 | #define READ_CMD_BYTE 0x20\r | |
35 | #define WRITE_CMD_BYTE 0x60\r | |
36 | #define DISABLE_AUX 0xa7\r | |
37 | #define ENABLE_AUX 0xa8\r | |
38 | #define SELF_TEST 0xaa\r | |
39 | #define DISABLE_KB 0xad\r | |
40 | #define ENABLE_KB 0xae\r | |
41 | #define WRITE_AUX_DEV 0xd4\r | |
42 | \r | |
43 | #define CMD_SYS_FLAG 0x04\r | |
44 | #define CMD_KB_STS 0x10\r | |
45 | #define CMD_KB_DIS 0x10\r | |
46 | #define CMD_KB_EN 0x0\r | |
47 | \r | |
48 | //\r | |
49 | // 8042 Auxiliary Device Command\r | |
50 | //\r | |
51 | #define SETSF1_CMD 0xe6\r | |
52 | #define SETSF2_CMD 0xe7\r | |
53 | #define SETRE_CMD 0xe8\r | |
54 | #define READ_CMD 0xeb\r | |
55 | #define SETRM_CMD 0xf0\r | |
56 | #define SETSR_CMD 0xf3\r | |
57 | #define ENABLE_CMD 0xf4\r | |
58 | #define DISABLE_CMD 0xf5\r | |
59 | #define RESET_CMD 0xff\r | |
60 | \r | |
61 | //\r | |
62 | // return code\r | |
63 | //\r | |
64 | #define PS2_ACK 0xfa\r | |
65 | #define PS2_RESEND 0xfe\r | |
66 | #define PS2MOUSE_BAT1 0xaa\r | |
67 | #define PS2MOUSE_BAT2 0x0\r | |
68 | \r | |
69 | //\r | |
70 | // Keyboard Controller Status\r | |
71 | //\r | |
24a2dd3d | 72 | ///\r |
73 | /// Parity Error\r | |
74 | ///\r | |
0a6f4824 | 75 | #define KBC_PARE 0x80\r |
24a2dd3d | 76 | ///\r |
77 | /// General Time Out\r | |
78 | ///\r | |
0a6f4824 | 79 | #define KBC_TIM 0x40\r |
24a2dd3d | 80 | ///\r |
81 | /// Output buffer for auxiliary device (PS/2):\r | |
82 | /// 0 - Holds keyboard data\r | |
83 | /// 1 - Holds data for auxiliary device\r | |
84 | ///\r | |
0a6f4824 | 85 | #define KBC_AUXB 0x20\r |
24a2dd3d | 86 | ///\r |
87 | /// Keyboard lock status:\r | |
88 | /// 0 - keyboard locked\r | |
89 | /// 1 - keyboard free\r | |
90 | ///\r | |
0a6f4824 | 91 | #define KBC_KEYL 0x10\r |
24a2dd3d | 92 | ///\r |
93 | /// Command/Data:\r | |
94 | /// 0 - data byte written via port 60h\r | |
95 | /// 1 - command byte written via port 64h\r | |
96 | ///\r | |
97 | #define KBC_CD 0x08\r | |
98 | ///\r | |
99 | /// System Flag:\r | |
100 | /// 0 - power-on reset\r | |
101 | /// 1 - self-test successful\r | |
102 | ///\r | |
0a6f4824 | 103 | #define KBC_SYSF 0x04\r |
24a2dd3d | 104 | ///\r |
105 | /// Input Buffer Status :\r | |
106 | /// 0 - input buffer empty\r | |
107 | /// 1 - CPU data in input buffer\r | |
108 | ///\r | |
0a6f4824 | 109 | #define KBC_INPB 0x02\r |
24a2dd3d | 110 | ///\r |
111 | /// Output Buffer Status :\r | |
112 | /// 0 - output buffer empty\r | |
113 | /// 1 - keyboard controller data in output buffer\r | |
114 | ///\r | |
0a6f4824 | 115 | #define KBC_OUTB 0x01\r |
ff1fcef8 | 116 | \r |
117 | /**\r | |
118 | Issue self test command via IsaIo interface.\r | |
0a6f4824 | 119 | \r |
ff1fcef8 | 120 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 121 | \r |
ff1fcef8 | 122 | @return EFI_SUCCESS Success to do keyboard self testing.\r |
123 | @return others Fail to do keyboard self testing.\r | |
124 | **/\r | |
05fbd06d | 125 | EFI_STATUS\r |
126 | KbcSelfTest (\r | |
127 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 128 | );\r |
05fbd06d | 129 | \r |
ff1fcef8 | 130 | /**\r |
131 | Issue command to enable keyboard AUX functionality.\r | |
0a6f4824 | 132 | \r |
ff1fcef8 | 133 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 134 | \r |
ff1fcef8 | 135 | @return Status of command issuing.\r |
136 | **/\r | |
05fbd06d | 137 | EFI_STATUS\r |
138 | KbcEnableAux (\r | |
139 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 140 | );\r |
05fbd06d | 141 | \r |
ff1fcef8 | 142 | /**\r |
143 | Issue command to disable keyboard AUX functionality.\r | |
0a6f4824 | 144 | \r |
ff1fcef8 | 145 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 146 | \r |
ff1fcef8 | 147 | @return Status of command issuing.\r |
148 | **/\r | |
05fbd06d | 149 | EFI_STATUS\r |
150 | KbcDisableAux (\r | |
151 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 152 | );\r |
05fbd06d | 153 | \r |
ff1fcef8 | 154 | /**\r |
155 | Issue command to enable keyboard.\r | |
0a6f4824 | 156 | \r |
ff1fcef8 | 157 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 158 | \r |
ff1fcef8 | 159 | @return Status of command issuing.\r |
160 | **/\r | |
05fbd06d | 161 | EFI_STATUS\r |
162 | KbcEnableKb (\r | |
163 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 164 | );\r |
05fbd06d | 165 | \r |
ff1fcef8 | 166 | /**\r |
167 | Issue command to disable keyboard.\r | |
0a6f4824 | 168 | \r |
ff1fcef8 | 169 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 170 | \r |
ff1fcef8 | 171 | @return Status of command issuing.\r |
172 | **/\r | |
05fbd06d | 173 | EFI_STATUS\r |
174 | KbcDisableKb (\r | |
175 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 176 | );\r |
05fbd06d | 177 | \r |
ff1fcef8 | 178 | /**\r |
179 | Issue command to check keyboard status.\r | |
0a6f4824 | 180 | \r |
ff1fcef8 | 181 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
182 | @param KeyboardEnable return whether keyboard is enable.\r | |
0a6f4824 | 183 | \r |
ff1fcef8 | 184 | @return Status of command issuing.\r |
185 | **/\r | |
05fbd06d | 186 | EFI_STATUS\r |
187 | CheckKbStatus (\r | |
188 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
189 | OUT BOOLEAN *KeyboardEnable\r | |
ed66e1bc | 190 | );\r |
05fbd06d | 191 | \r |
ff1fcef8 | 192 | /**\r |
193 | Issue command to reset keyboard.\r | |
0a6f4824 | 194 | \r |
ff1fcef8 | 195 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 196 | \r |
ff1fcef8 | 197 | @return Status of command issuing.\r |
198 | **/\r | |
05fbd06d | 199 | EFI_STATUS\r |
200 | PS2MouseReset (\r | |
201 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 202 | );\r |
05fbd06d | 203 | \r |
ff1fcef8 | 204 | /**\r |
205 | Issue command to set mouse's sample rate\r | |
0a6f4824 | 206 | \r |
ff1fcef8 | 207 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 LG |
208 | @param SampleRate value of sample rate\r |
209 | \r | |
ff1fcef8 | 210 | @return Status of command issuing.\r |
211 | **/\r | |
05fbd06d | 212 | EFI_STATUS\r |
213 | PS2MouseSetSampleRate (\r | |
214 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
215 | IN MOUSE_SR SampleRate\r | |
ed66e1bc | 216 | );\r |
05fbd06d | 217 | \r |
ff1fcef8 | 218 | /**\r |
219 | Issue command to set mouse's resolution.\r | |
0a6f4824 | 220 | \r |
ff1fcef8 | 221 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
222 | @param Resolution value of resolution\r | |
0a6f4824 | 223 | \r |
ff1fcef8 | 224 | @return Status of command issuing.\r |
225 | **/\r | |
05fbd06d | 226 | EFI_STATUS\r |
227 | PS2MouseSetResolution (\r | |
228 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
229 | IN MOUSE_RE Resolution\r | |
ed66e1bc | 230 | );\r |
05fbd06d | 231 | \r |
ff1fcef8 | 232 | /**\r |
233 | Issue command to set mouse's scaling.\r | |
0a6f4824 | 234 | \r |
ff1fcef8 | 235 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
236 | @param Scaling value of scaling\r | |
0a6f4824 | 237 | \r |
ff1fcef8 | 238 | @return Status of command issuing.\r |
239 | **/\r | |
05fbd06d | 240 | EFI_STATUS\r |
241 | PS2MouseSetScaling (\r | |
242 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
243 | IN MOUSE_SF Scaling\r | |
ed66e1bc | 244 | );\r |
05fbd06d | 245 | \r |
ff1fcef8 | 246 | /**\r |
247 | Issue command to enable Ps2 mouse.\r | |
0a6f4824 | 248 | \r |
ff1fcef8 | 249 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 250 | \r |
ff1fcef8 | 251 | @return Status of command issuing.\r |
252 | **/\r | |
05fbd06d | 253 | EFI_STATUS\r |
254 | PS2MouseEnable (\r | |
255 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
ed66e1bc | 256 | );\r |
05fbd06d | 257 | \r |
ff1fcef8 | 258 | /**\r |
259 | Get mouse packet . Only care first 3 bytes\r | |
05fbd06d | 260 | \r |
0a6f4824 | 261 | @param MouseDev Pointer of PS2 Mouse Private Data Structure\r |
05fbd06d | 262 | \r |
ff1fcef8 | 263 | @retval EFI_NOT_READY Mouse Device not ready to input data packet, or some error happened during getting the packet\r |
264 | @retval EFI_SUCCESS The data packet is gotten successfully.\r | |
05fbd06d | 265 | \r |
bcd70414 | 266 | **/\r |
05fbd06d | 267 | EFI_STATUS\r |
268 | PS2MouseGetPacket (\r | |
269 | PS2_MOUSE_DEV *MouseDev\r | |
ed66e1bc | 270 | );\r |
05fbd06d | 271 | \r |
ff1fcef8 | 272 | /**\r |
273 | Read data via IsaIo protocol with given number.\r | |
0a6f4824 | 274 | \r |
ff1fcef8 | 275 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
276 | @param Buffer Buffer receive data of mouse\r | |
277 | @param BufSize The size of buffer\r | |
278 | @param State Check input or read data\r | |
0a6f4824 | 279 | \r |
ff1fcef8 | 280 | @return status of reading mouse data.\r |
281 | **/\r | |
05fbd06d | 282 | EFI_STATUS\r |
283 | PS2MouseRead (\r | |
284 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
285 | OUT VOID *Buffer,\r | |
286 | IN OUT UINTN *BufSize,\r | |
287 | IN UINTN State\r | |
288 | );\r | |
289 | \r | |
290 | //\r | |
291 | // 8042 I/O function\r | |
292 | //\r | |
ff1fcef8 | 293 | /**\r |
294 | I/O work flow of outing 8042 command.\r | |
0a6f4824 | 295 | \r |
ff1fcef8 | 296 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
297 | @param Command I/O command.\r | |
0a6f4824 | 298 | \r |
70d3fe9d | 299 | @retval EFI_SUCCESS Success to execute I/O work flow\r |
ff1fcef8 | 300 | @retval EFI_TIMEOUT Keyboard controller time out.\r |
301 | **/\r | |
05fbd06d | 302 | EFI_STATUS\r |
303 | Out8042Command (\r | |
304 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
305 | IN UINT8 Command\r | |
306 | );\r | |
307 | \r | |
ff1fcef8 | 308 | /**\r |
309 | I/O work flow of in 8042 data.\r | |
0a6f4824 | 310 | \r |
ff1fcef8 | 311 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
312 | @param Data Data value\r | |
0a6f4824 | 313 | \r |
70d3fe9d | 314 | @retval EFI_SUCCESS Success to execute I/O work flow\r |
ff1fcef8 | 315 | @retval EFI_TIMEOUT Keyboard controller time out.\r |
316 | **/\r | |
05fbd06d | 317 | EFI_STATUS\r |
318 | In8042Data (\r | |
319 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
320 | IN OUT UINT8 *Data\r | |
321 | );\r | |
322 | \r | |
ff1fcef8 | 323 | /**\r |
324 | I/O work flow of outing 8042 data.\r | |
0a6f4824 | 325 | \r |
ff1fcef8 | 326 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
327 | @param Data Data value\r | |
0a6f4824 | 328 | \r |
70d3fe9d | 329 | @retval EFI_SUCCESS Success to execute I/O work flow\r |
ff1fcef8 | 330 | @retval EFI_TIMEOUT Keyboard controller time out.\r |
331 | **/\r | |
05fbd06d | 332 | EFI_STATUS\r |
333 | Out8042Data (\r | |
334 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
335 | IN UINT8 Data\r | |
336 | );\r | |
337 | \r | |
ff1fcef8 | 338 | /**\r |
339 | I/O work flow of outing 8042 Aux command.\r | |
0a6f4824 | 340 | \r |
ff1fcef8 | 341 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
342 | @param Command Aux I/O command\r | |
343 | @param Resend Whether need resend the Aux command.\r | |
0a6f4824 | 344 | \r |
70d3fe9d | 345 | @retval EFI_SUCCESS Success to execute I/O work flow\r |
ff1fcef8 | 346 | @retval EFI_TIMEOUT Keyboard controller time out.\r |
347 | **/\r | |
05fbd06d | 348 | EFI_STATUS\r |
349 | Out8042AuxCommand (\r | |
350 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
351 | IN UINT8 Command,\r | |
352 | IN BOOLEAN Resend\r | |
353 | );\r | |
354 | \r | |
ff1fcef8 | 355 | /**\r |
356 | I/O work flow of in 8042 Aux data.\r | |
0a6f4824 | 357 | \r |
ff1fcef8 | 358 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
359 | @param Data Buffer holding return value.\r | |
0a6f4824 | 360 | \r |
70d3fe9d | 361 | @retval EFI_SUCCESS Success to execute I/O work flow\r |
ff1fcef8 | 362 | @retval EFI_TIMEOUT Keyboard controller time out.\r |
363 | **/\r | |
05fbd06d | 364 | EFI_STATUS\r |
365 | In8042AuxData (\r | |
366 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
367 | IN OUT UINT8 *Data\r | |
368 | );\r | |
369 | \r | |
ff1fcef8 | 370 | /**\r |
371 | I/O work flow of outing 8042 Aux data.\r | |
0a6f4824 | 372 | \r |
ff1fcef8 | 373 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
172870ef | 374 | @param Data Buffer holding return value\r |
0a6f4824 | 375 | \r |
70d3fe9d | 376 | @retval EFI_SUCCESS Success to execute I/O work flow\r |
ff1fcef8 | 377 | @retval EFI_TIMEOUT Keyboard controller time out.\r |
378 | **/\r | |
05fbd06d | 379 | EFI_STATUS\r |
380 | Out8042AuxData (\r | |
381 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
382 | IN UINT8 Data\r | |
383 | );\r | |
384 | \r | |
ff1fcef8 | 385 | /**\r |
172870ef | 386 | Check keyboard controller status, if it is output buffer full and for auxiliary device.\r |
0a6f4824 | 387 | \r |
ff1fcef8 | 388 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
0a6f4824 | 389 | \r |
ff1fcef8 | 390 | @retval EFI_SUCCESS Keyboard controller is ready\r |
391 | @retval EFI_NOT_READY Keyboard controller is not ready\r | |
392 | **/\r | |
05fbd06d | 393 | EFI_STATUS\r |
394 | CheckForInput (\r | |
395 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
396 | );\r | |
397 | \r | |
ff1fcef8 | 398 | /**\r |
399 | I/O work flow to wait input buffer empty in given time.\r | |
0a6f4824 | 400 | \r |
ff1fcef8 | 401 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
402 | @param Timeout Wating time.\r | |
0a6f4824 | 403 | \r |
ff1fcef8 | 404 | @retval EFI_TIMEOUT if input is still not empty in given time.\r |
405 | @retval EFI_SUCCESS input is empty.\r | |
406 | **/\r | |
05fbd06d | 407 | EFI_STATUS\r |
408 | WaitInputEmpty (\r | |
409 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
410 | IN UINTN Timeout\r | |
411 | );\r | |
412 | \r | |
ff1fcef8 | 413 | /**\r |
414 | I/O work flow to wait output buffer full in given time.\r | |
0a6f4824 | 415 | \r |
ff1fcef8 | 416 | @param IsaIo Pointer to instance of EFI_ISA_IO_PROTOCOL\r |
417 | @param Timeout given time\r | |
0a6f4824 | 418 | \r |
ff1fcef8 | 419 | @retval EFI_TIMEOUT output is not full in given time\r |
420 | @retval EFI_SUCCESS output is full in given time.\r | |
421 | **/\r | |
05fbd06d | 422 | EFI_STATUS\r |
423 | WaitOutputFull (\r | |
424 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
425 | IN UINTN Timeout\r | |
426 | );\r | |
427 | \r | |
24a2dd3d | 428 | #endif\r |
429 | \r |