[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2MouseDxe / CommPs2.h

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