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