]>
Commit | Line | Data |
---|---|---|
05fbd06d | 1 | /*++\r |
2 | \r | |
92a428e1 | 3 | Copyright (c) 2006 - 2007, Intel Corporation\r |
4 | All rights reserved. This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
05fbd06d | 11 | \r |
12 | \r | |
13 | Module Name:\r | |
14 | \r | |
15 | CommPs2.h\r | |
16 | \r | |
17 | Abstract: \r | |
18 | \r | |
19 | PS2 Mouse Communication Interface \r | |
20 | \r | |
21 | \r | |
22 | Revision History\r | |
23 | \r | |
24 | --*/\r | |
25 | \r | |
26 | #ifndef _COMMPS2_H_\r | |
27 | #define _COMMPS2_H_\r | |
28 | \r | |
05fbd06d | 29 | #define PS2_PACKET_LENGTH 3\r |
30 | #define PS2_SYNC_MASK 0xc\r | |
31 | #define PS2_SYNC_BYTE 0x8\r | |
32 | \r | |
33 | #define IS_PS2_SYNC_BYTE(byte) ((byte & PS2_SYNC_MASK) == PS2_SYNC_BYTE)\r | |
34 | \r | |
35 | #define PS2_READ_BYTE_ONE 0\r | |
36 | #define PS2_READ_DATA_BYTE 1\r | |
37 | #define PS2_PROCESS_PACKET 2\r | |
38 | \r | |
39 | #define TIMEOUT 50000\r | |
40 | #define BAT_TIMEOUT 500000\r | |
41 | \r | |
42 | //\r | |
43 | // 8042 I/O Port\r | |
44 | //\r | |
45 | #define KBC_DATA_PORT 0x60\r | |
46 | #define KBC_CMD_STS_PORT 0x64\r | |
47 | \r | |
48 | //\r | |
49 | // 8042 Command\r | |
50 | //\r | |
51 | #define READ_CMD_BYTE 0x20\r | |
52 | #define WRITE_CMD_BYTE 0x60\r | |
53 | #define DISABLE_AUX 0xa7\r | |
54 | #define ENABLE_AUX 0xa8\r | |
55 | #define SELF_TEST 0xaa\r | |
56 | #define DISABLE_KB 0xad\r | |
57 | #define ENABLE_KB 0xae\r | |
58 | #define WRITE_AUX_DEV 0xd4\r | |
59 | \r | |
60 | #define CMD_SYS_FLAG 0x04\r | |
61 | #define CMD_KB_STS 0x10\r | |
62 | #define CMD_KB_DIS 0x10\r | |
63 | #define CMD_KB_EN 0x0\r | |
64 | \r | |
65 | //\r | |
66 | // 8042 Auxiliary Device Command\r | |
67 | //\r | |
68 | #define SETSF1_CMD 0xe6\r | |
69 | #define SETSF2_CMD 0xe7\r | |
70 | #define SETRE_CMD 0xe8\r | |
71 | #define READ_CMD 0xeb\r | |
72 | #define SETRM_CMD 0xf0\r | |
73 | #define SETSR_CMD 0xf3\r | |
74 | #define ENABLE_CMD 0xf4\r | |
75 | #define DISABLE_CMD 0xf5\r | |
76 | #define RESET_CMD 0xff\r | |
77 | \r | |
78 | //\r | |
79 | // return code\r | |
80 | //\r | |
81 | #define PS2_ACK 0xfa\r | |
82 | #define PS2_RESEND 0xfe\r | |
83 | #define PS2MOUSE_BAT1 0xaa\r | |
84 | #define PS2MOUSE_BAT2 0x0\r | |
85 | \r | |
86 | //\r | |
87 | // Keyboard Controller Status\r | |
88 | //\r | |
89 | #define KBC_PARE 0x80 // Parity Error\r | |
90 | #define KBC_TIM 0x40 // General Time Out\r | |
91 | #define KBC_AUXB 0x20 // Output buffer for auxiliary device (PS/2):\r | |
92 | // 0 - Holds keyboard data\r | |
93 | // 1 - Holds data for auxiliary device\r | |
94 | //\r | |
95 | #define KBC_KEYL 0x10 // Keyboard lock status:\r | |
96 | // 0 - keyboard locked\r | |
97 | // 1 - keyboard free\r | |
98 | //\r | |
99 | #define KBC_CD 0x08 // Command/Data:\r | |
100 | // 0 - data byte written via port 60h\r | |
101 | // 1 - command byte written via port 64h\r | |
102 | //\r | |
103 | #define KBC_SYSF 0x04 // System Flag:\r | |
104 | // 0 - power-on reset\r | |
105 | // 1 - self-test successful\r | |
106 | //\r | |
107 | #define KBC_INPB 0x02 // Input Buffer Status :\r | |
108 | // 0 - input buffer empty\r | |
109 | // 1 - CPU data in input buffer\r | |
110 | //\r | |
111 | #define KBC_OUTB 0x01 // Output Buffer Status :\r | |
112 | // 0 - output buffer empty\r | |
113 | // 1 - keyboard controller data in output buffer\r | |
114 | //\r | |
115 | EFI_STATUS\r | |
116 | KbcSelfTest (\r | |
117 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
118 | )\r | |
119 | /*++\r | |
120 | \r | |
121 | Routine Description:\r | |
122 | \r | |
123 | GC_TODO: Add function description\r | |
124 | \r | |
125 | Arguments:\r | |
126 | \r | |
127 | IsaIo - GC_TODO: add argument description\r | |
128 | \r | |
129 | Returns:\r | |
130 | \r | |
131 | GC_TODO: add return values\r | |
132 | \r | |
133 | --*/\r | |
134 | ;\r | |
135 | \r | |
136 | EFI_STATUS\r | |
137 | KbcEnableAux (\r | |
138 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
139 | )\r | |
140 | /*++\r | |
141 | \r | |
142 | Routine Description:\r | |
143 | \r | |
144 | GC_TODO: Add function description\r | |
145 | \r | |
146 | Arguments:\r | |
147 | \r | |
148 | IsaIo - GC_TODO: add argument description\r | |
149 | \r | |
150 | Returns:\r | |
151 | \r | |
152 | GC_TODO: add return values\r | |
153 | \r | |
154 | --*/\r | |
155 | ;\r | |
156 | \r | |
157 | EFI_STATUS\r | |
158 | KbcDisableAux (\r | |
159 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
160 | )\r | |
161 | /*++\r | |
162 | \r | |
163 | Routine Description:\r | |
164 | \r | |
165 | GC_TODO: Add function description\r | |
166 | \r | |
167 | Arguments:\r | |
168 | \r | |
169 | IsaIo - GC_TODO: add argument description\r | |
170 | \r | |
171 | Returns:\r | |
172 | \r | |
173 | GC_TODO: add return values\r | |
174 | \r | |
175 | --*/\r | |
176 | ;\r | |
177 | \r | |
178 | EFI_STATUS\r | |
179 | KbcEnableKb (\r | |
180 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
181 | )\r | |
182 | /*++\r | |
183 | \r | |
184 | Routine Description:\r | |
185 | \r | |
186 | GC_TODO: Add function description\r | |
187 | \r | |
188 | Arguments:\r | |
189 | \r | |
190 | IsaIo - GC_TODO: add argument description\r | |
191 | \r | |
192 | Returns:\r | |
193 | \r | |
194 | GC_TODO: add return values\r | |
195 | \r | |
196 | --*/\r | |
197 | ;\r | |
198 | \r | |
199 | EFI_STATUS\r | |
200 | KbcDisableKb (\r | |
201 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
202 | )\r | |
203 | /*++\r | |
204 | \r | |
205 | Routine Description:\r | |
206 | \r | |
207 | GC_TODO: Add function description\r | |
208 | \r | |
209 | Arguments:\r | |
210 | \r | |
211 | IsaIo - GC_TODO: add argument description\r | |
212 | \r | |
213 | Returns:\r | |
214 | \r | |
215 | GC_TODO: add return values\r | |
216 | \r | |
217 | --*/\r | |
218 | ;\r | |
219 | \r | |
220 | EFI_STATUS\r | |
221 | CheckKbStatus (\r | |
222 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
223 | OUT BOOLEAN *KeyboardEnable\r | |
224 | )\r | |
225 | /*++\r | |
226 | \r | |
227 | Routine Description:\r | |
228 | \r | |
229 | GC_TODO: Add function description\r | |
230 | \r | |
231 | Arguments:\r | |
232 | \r | |
233 | IsaIo - GC_TODO: add argument description\r | |
234 | KeyboardEnable - GC_TODO: add argument description\r | |
235 | \r | |
236 | Returns:\r | |
237 | \r | |
238 | GC_TODO: add return values\r | |
239 | \r | |
240 | --*/\r | |
241 | ;\r | |
242 | \r | |
243 | EFI_STATUS\r | |
244 | PS2MouseReset (\r | |
245 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
246 | )\r | |
247 | /*++\r | |
248 | \r | |
249 | Routine Description:\r | |
250 | \r | |
251 | GC_TODO: Add function description\r | |
252 | \r | |
253 | Arguments:\r | |
254 | \r | |
255 | IsaIo - GC_TODO: add argument description\r | |
256 | \r | |
257 | Returns:\r | |
258 | \r | |
259 | GC_TODO: add return values\r | |
260 | \r | |
261 | --*/\r | |
262 | ;\r | |
263 | \r | |
264 | EFI_STATUS\r | |
265 | PS2MouseSetSampleRate (\r | |
266 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
267 | IN MOUSE_SR SampleRate\r | |
268 | )\r | |
269 | /*++\r | |
270 | \r | |
271 | Routine Description:\r | |
272 | \r | |
273 | GC_TODO: Add function description\r | |
274 | \r | |
275 | Arguments:\r | |
276 | \r | |
277 | IsaIo - GC_TODO: add argument description\r | |
278 | SampleRate - GC_TODO: add argument description\r | |
279 | \r | |
280 | Returns:\r | |
281 | \r | |
282 | GC_TODO: add return values\r | |
283 | \r | |
284 | --*/\r | |
285 | ;\r | |
286 | \r | |
287 | EFI_STATUS\r | |
288 | PS2MouseSetResolution (\r | |
289 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
290 | IN MOUSE_RE Resolution\r | |
291 | )\r | |
292 | /*++\r | |
293 | \r | |
294 | Routine Description:\r | |
295 | \r | |
296 | GC_TODO: Add function description\r | |
297 | \r | |
298 | Arguments:\r | |
299 | \r | |
300 | IsaIo - GC_TODO: add argument description\r | |
301 | Resolution - GC_TODO: add argument description\r | |
302 | \r | |
303 | Returns:\r | |
304 | \r | |
305 | GC_TODO: add return values\r | |
306 | \r | |
307 | --*/\r | |
308 | ;\r | |
309 | \r | |
310 | EFI_STATUS\r | |
311 | PS2MouseSetScaling (\r | |
312 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
313 | IN MOUSE_SF Scaling\r | |
314 | )\r | |
315 | /*++\r | |
316 | \r | |
317 | Routine Description:\r | |
318 | \r | |
319 | GC_TODO: Add function description\r | |
320 | \r | |
321 | Arguments:\r | |
322 | \r | |
323 | IsaIo - GC_TODO: add argument description\r | |
324 | Scaling - GC_TODO: add argument description\r | |
325 | \r | |
326 | Returns:\r | |
327 | \r | |
328 | GC_TODO: add return values\r | |
329 | \r | |
330 | --*/\r | |
331 | ;\r | |
332 | \r | |
333 | EFI_STATUS\r | |
334 | PS2MouseEnable (\r | |
335 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
336 | )\r | |
337 | /*++\r | |
338 | \r | |
339 | Routine Description:\r | |
340 | \r | |
341 | GC_TODO: Add function description\r | |
342 | \r | |
343 | Arguments:\r | |
344 | \r | |
345 | IsaIo - GC_TODO: add argument description\r | |
346 | \r | |
347 | Returns:\r | |
348 | \r | |
349 | GC_TODO: add return values\r | |
350 | \r | |
351 | --*/\r | |
352 | ;\r | |
353 | \r | |
354 | EFI_STATUS\r | |
355 | PS2MouseGetPacket (\r | |
356 | PS2_MOUSE_DEV *MouseDev\r | |
357 | )\r | |
358 | /*++\r | |
359 | \r | |
360 | Routine Description:\r | |
361 | \r | |
362 | GC_TODO: Add function description\r | |
363 | \r | |
364 | Arguments:\r | |
365 | \r | |
366 | MouseDev - GC_TODO: add argument description\r | |
367 | \r | |
368 | Returns:\r | |
369 | \r | |
370 | GC_TODO: add return values\r | |
371 | \r | |
372 | --*/\r | |
373 | ;\r | |
374 | \r | |
375 | EFI_STATUS\r | |
376 | PS2MouseRead (\r | |
377 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
378 | OUT VOID *Buffer,\r | |
379 | IN OUT UINTN *BufSize,\r | |
380 | IN UINTN State\r | |
381 | );\r | |
382 | \r | |
383 | //\r | |
384 | // 8042 I/O function\r | |
385 | //\r | |
386 | EFI_STATUS\r | |
387 | Out8042Command (\r | |
388 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
389 | IN UINT8 Command\r | |
390 | );\r | |
391 | \r | |
392 | EFI_STATUS\r | |
393 | In8042Data (\r | |
394 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
395 | IN OUT UINT8 *Data\r | |
396 | );\r | |
397 | \r | |
398 | EFI_STATUS\r | |
399 | Out8042Data (\r | |
400 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
401 | IN UINT8 Data\r | |
402 | );\r | |
403 | \r | |
404 | EFI_STATUS\r | |
405 | Out8042AuxCommand (\r | |
406 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
407 | IN UINT8 Command,\r | |
408 | IN BOOLEAN Resend\r | |
409 | );\r | |
410 | \r | |
411 | EFI_STATUS\r | |
412 | In8042AuxData (\r | |
413 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
414 | IN OUT UINT8 *Data\r | |
415 | );\r | |
416 | \r | |
417 | EFI_STATUS\r | |
418 | Out8042AuxData (\r | |
419 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
420 | IN UINT8 Data\r | |
421 | );\r | |
422 | \r | |
423 | EFI_STATUS\r | |
424 | CheckForInput (\r | |
425 | IN EFI_ISA_IO_PROTOCOL *IsaIo\r | |
426 | );\r | |
427 | \r | |
428 | EFI_STATUS\r | |
429 | WaitInputEmpty (\r | |
430 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
431 | IN UINTN Timeout\r | |
432 | );\r | |
433 | \r | |
434 | EFI_STATUS\r | |
435 | WaitOutputFull (\r | |
436 | IN EFI_ISA_IO_PROTOCOL *IsaIo,\r | |
437 | IN UINTN Timeout\r | |
438 | );\r | |
439 | \r | |
440 | #endif // _COMMPS2_H_\r |