//\r
STATIC UINTN mWaitForValueTimeOut = KEYBOARD_WAITFORVALUE_TIMEOUT;\r
\r
+/**\r
+ Read data register \r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+\r
+ @return return the value \r
+\r
+**/\r
STATIC\r
UINT8\r
KeyReadDataRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
UINT8 Data;\r
return Data;\r
}\r
\r
+/**\r
+ Write data register\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data value wanted to be written\r
+\r
+**/\r
STATIC\r
VOID\r
KeyWriteDataRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
\r
---*/\r
{\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
\r
//\r
}\r
\r
+/**\r
+ Read status register\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+\r
+ @return value in status register\r
+\r
+**/\r
UINT8\r
KeyReadStatusRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
UINT8 Data;\r
\r
}\r
\r
+/**\r
+ Write command register \r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data The value wanted to be written\r
+\r
+**/\r
+\r
STATIC\r
VOID\r
KeyWriteCommandRegister (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
-\r
---*/\r
{\r
EFI_ISA_IO_PROTOCOL *IsaIo;\r
\r
\r
}\r
\r
+/**\r
+ Display error message\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param ErrMsg Unicode string of error message\r
+ \r
+**/\r
STATIC\r
VOID\r
KeyboardError (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN CHAR16 *ErrMsg\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Display error message\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
-// GC_TODO: ErrMsg - add argument and description to function comment\r
{\r
ConsoleIn->KeyboardErr = TRUE;\r
\r
//\r
}\r
\r
-VOID\r
-EFIAPI\r
-KeyboardTimerHandler (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Timer event handler: read a series of scancodes from 8042\r
and put them into memory scancode buffer.\r
it read as much scancodes to either fill\r
the memory buffer or empty the keyboard buffer.\r
It is registered as running under TPL_NOTIFY\r
\r
-Arguments:\r
-\r
- Event - The timer event\r
- Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
+ @param Event - The timer event\r
+ @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r
\r
-Returns:\r
+**/\r
+VOID\r
+EFIAPI\r
+KeyboardTimerHandler (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
\r
---*/\r
{\r
UINT8 Data;\r
EFI_TPL OldTpl;\r
return ;\r
}\r
\r
+/**\r
+ Read several bytes from the scancode buffer without removing them.\r
+ This function is called to see if there are enough bytes of scancode\r
+ representing a single key.\r
+\r
+ @param Count - Number of bytes to be read\r
+ @param Buf - Store the results\r
+\r
+ @retval EFI_SUCCESS success to scan the keyboard code\r
+ @retval EFI_NOT_READY invalid parameter\r
+**/\r
STATIC\r
EFI_STATUS\r
GetScancodeBufHead (\r
IN UINT32 Count,\r
OUT UINT8 *Buf\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Read several bytes from the scancode buffer without removing them.\r
- This function is called to see if there are enough bytes of scancode\r
- representing a single key.\r
-\r
-Arguments:\r
-\r
- Count - Number of bytes to be read\r
- Buf - Store the results\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
-// GC_TODO: EFI_NOT_READY - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
UINT32 Index;\r
UINT32 Pos;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Read & remove several bytes from the scancode buffer.\r
+ This function is usually called after GetScancodeBufHead()\r
+\r
+ @param Count - Number of bytes to be read\r
+ @param Buf - Store the results\r
+\r
+ @retval EFI_SUCCESS success to scan the keyboard code\r
+ @retval EFI_NOT_READY invalid parameter\r
+**/\r
STATIC\r
EFI_STATUS\r
PopScancodeBufHead (\r
IN UINT32 Count,\r
OUT UINT8 *Buf\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Read & remove several bytes from the scancode buffer.\r
- This function is usually called after GetScancodeBufHead()\r
-\r
-Arguments:\r
-\r
- Count - Number of bytes to be read\r
- Buf - Store the results\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
-// GC_TODO: EFI_NOT_READY - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
{\r
UINT32 Index;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Read key value \r
+\r
+ @param ConsoleIn - Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data - Pointer to outof buffer for keeping key value\r
+\r
+ @retval EFI_TIMEOUT Status resigter time out\r
+ @retval EFI_SUCCESS Success to read keyboard\r
+\r
+**/\r
EFI_STATUS\r
KeyboardRead (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
OUT UINT8 *Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT32 TimeOut;\r
UINT32 RegFilled;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ write key to keyboard\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data value wanted to be written\r
+\r
+ @retval EFI_TIMEOUT - GC_TODO: Add description for return value\r
+ @retval EFI_SUCCESS - GC_TODO: Add description for return value\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardWrite (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT32 TimeOut;\r
UINT32 RegEmptied;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Issue keyboard command\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Data The buff holding the command \r
+\r
+ @retval EFI_TIMEOUT Keyboard is not ready to issuing \r
+ @retval EFI_SUCCESS Success to issue keyboard command\r
+\r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardCommand (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Data\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- ConsoleIn - GC_TODO: add argument description\r
- Data - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_TIMEOUT - GC_TODO: Add description for return value\r
- EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
{\r
UINT32 TimeOut;\r
UINT32 RegEmptied;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ wait for a specific value to be presented on\r
+ 8042 Data register by keyboard and then read it,\r
+ used in keyboard commands ack\r
+\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ @param Value the value wanted to be waited.\r
+\r
+ @retval EFI_TIMEOUT Fail to get specific value in given time\r
+ @retval EFI_SUCCESS Success to get specific value in given time.\r
+ \r
+**/\r
STATIC\r
EFI_STATUS\r
KeyboardWaitForValue (\r
IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
IN UINT8 Value\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- wait for a specific value to be presented on\r
- 8042 Data register by keyboard and then read it,\r
- used in keyboard commands ack\r
-\r
-Arguments:\r
-\r
- ConsoleIn - The KEYBOARD_CONSOLE_IN_DEV instance pointer\r
- Value - The value to be waited for\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
-// GC_TODO: EFI_TIMEOUT - add return value to function comment\r
{\r
UINT8 Data;\r
UINT32 TimeOut;\r
\r
}\r
\r
-EFI_STATUS\r
-UpdateStatusLights (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Show keyboard status lights according to\r
indicators in ConsoleIn.\r
\r
-Arguments:\r
+ @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r
+ \r
+ @return status\r
\r
-Returns:\r
-\r
---*/\r
-// GC_TODO: ConsoleIn - add argument and description to function comment\r
+**/\r
+EFI_STATUS\r
+UpdateStatusLights (\r
+ IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
+ )\r
{\r
EFI_STATUS Status;\r
UINT8 Command;\r
return Status;\r
}\r
\r
-EFI_STATUS\r
-KeyGetchar (\r
- IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Get scancode from scancode buffer\r
and translate into EFI-scancode and unicode defined by EFI spec\r
The function is always called in TPL_NOTIFY\r
\r
-Arguments:\r
-\r
- ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
+ @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r
\r
-Returns:\r
+ @retval EFI_NOT_READY - Input from console not ready yet.\r
+ @retval EFI_SUCCESS - Function executed successfully.\r
\r
- EFI_NOT_READY - Input from console not ready yet.\r
- EFI_SUCCESS - Function executed successfully.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+KeyGetchar (\r
+ IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
+ )\r
{\r
EFI_STATUS Status;\r
UINT8 ScanCode;\r
return EFI_SUCCESS;\r
}\r
\r
-EFI_STATUS\r
-InitKeyboard (\r
- IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
- IN BOOLEAN ExtendedVerification\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Perform 8042 controller and keyboard Initialization\r
If ExtendedVerification is TRUE, do additional test for\r
the keyboard interface\r
\r
-Arguments:\r
-\r
- ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
- ExtendedVerification - indicates a thorough initialization\r
+ @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r
+ @param ExtendedVerification - indicates a thorough initialization\r
\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
-// GC_TODO: EFI_SUCCESS - add return value to function comment\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
+ @retval EFI_DEVICE_ERROR Fail to init keyboard\r
+ @retval EFI_SUCCESS Success to init keyboard\r
+**/\r
+EFI_STATUS\r
+InitKeyboard (\r
+ IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
+ IN BOOLEAN ExtendedVerification\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_STATUS Status1;\r
\r
}\r
\r
-EFI_STATUS\r
-DisableKeyboard (\r
- IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
Disable the keyboard interface of the 8042 controller\r
\r
-Arguments:\r
-\r
- ConsoleIn - the device instance\r
-\r
-Returns:\r
+ @param ConsoleIn - the device instance\r
\r
- EFI_STATUS\r
+ @return status of issuing disable command\r
\r
---*/\r
-// GC_TODO: EFI_DEVICE_ERROR - add return value to function comment\r
+**/\r
+EFI_STATUS\r
+DisableKeyboard (\r
+ IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
+ )\r
{\r
EFI_STATUS Status;\r
\r
\r
return TRUE;\r
}\r
+\r
projects / mirror_edk2.git / blobdiff