summary |
shortlog |
log |
commit | commitdiff |
tree
raw |
patch |
inline | side by side (from parent 1:
513edce)
Fix few typos in the documentation.
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <
20200207010831.9046-4-philmd@redhat.com>
pressed.\r
\r
@retval TRUE Key be pressed matches a registered key.\r
pressed.\r
\r
@retval TRUE Key be pressed matches a registered key.\r
- @retval FLASE Match failed.\r
+ @retval FALSE Match failed.\r
Signal the event if there is key available\r
\r
@param Event the event object\r
Signal the event if there is key available\r
\r
@param Event the event object\r
- @param Context waitting context\r
+ @param Context waiting context\r
- Reset the input device and optionaly run diagnostics\r
+ Reset the input device and optionally run diagnostics\r
\r
@param This Protocol instance pointer.\r
@param ExtendedVerification Driver may perform diagnostics on reset.\r
\r
@param This Protocol instance pointer.\r
@param ExtendedVerification Driver may perform diagnostics on reset.\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
+ be used to test for existence of a keystroke via WaitForEvent () call.\r
\r
@param VirtualKeyboardPrivate Virtualkeyboard driver private structure.\r
@param KeyData A pointer to a buffer that is filled in\r
\r
@param VirtualKeyboardPrivate Virtualkeyboard driver private structure.\r
@param KeyData A pointer to a buffer that is filled in\r
that was pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
that was pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
- @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_NOT_READY There was no keystroke data available.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned\r
due to hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned\r
due to hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
+ be used to test for existence of a keystroke via WaitForEvent () call.\r
\r
@param This Protocol instance pointer.\r
@param KeyData A pointer to a buffer that is filled in with the\r
keystroke state data for the key that was pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
\r
@param This Protocol instance pointer.\r
@param KeyData A pointer to a buffer that is filled in with the\r
keystroke state data for the key that was pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
- @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_NOT_READY There was no keystroke data available.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned\r
due to hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned\r
due to hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
\r
@retval EFI_SUCCESS The notification function was registered\r
successfully.\r
\r
@retval EFI_SUCCESS The notification function was registered\r
successfully.\r
- @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necessary\r
data structures.\r
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
\r
data structures.\r
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
\r
- Reset the input device and optionaly run diagnostics\r
+ Reset the input device and optionally run diagnostics\r
\r
@param This Protocol instance pointer.\r
@param ExtendedVerification Driver may perform diagnostics on reset.\r
\r
@param This Protocol instance pointer.\r
@param ExtendedVerification Driver may perform diagnostics on reset.\r
\r
\r
@retval EFI_SUCCESS The notification function was registered successfully.\r
\r
\r
@retval EFI_SUCCESS The notification function was registered successfully.\r
- @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data structures.\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necessary data structures.\r
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
\r
**/\r
@retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
\r
**/\r
state data for the key that was pressed.\r
\r
@retval TRUE Key be pressed matches a registered key.\r
state data for the key that was pressed.\r
\r
@retval TRUE Key be pressed matches a registered key.\r
- @retval FLASE Match failed.\r
+ @retval FALSE Match failed.\r
/**\r
Waiting on the keyboard event, if there's any key pressed by the user, signal the event\r
\r
/**\r
Waiting on the keyboard event, if there's any key pressed by the user, signal the event\r
\r
- @param Event The event that be siganlled when any key has been stroked.\r
+ @param Event The event that be signalled when any key has been struck.\r
@param Context Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_PROTOCOL.\r
\r
**/\r
@param Context Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_PROTOCOL.\r
\r
**/\r
/**\r
Waiting on the keyboard event, if there's any key pressed by the user, signal the event\r
\r
/**\r
Waiting on the keyboard event, if there's any key pressed by the user, signal the event\r
\r
- @param Event The event that be siganlled when any key has been stroked.\r
+ @param Event The event that be signalled when any key has been struck.\r
@param Context Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.\r
\r
**/\r
@param Context Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.\r
\r
**/\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
+ be used to test for existence of a keystroke via WaitForEvent () call.\r
\r
@param This Protocol instance pointer.\r
@param KeyData A pointer to a buffer that is filled in with the keystroke\r
state data for the key that was pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
\r
@param This Protocol instance pointer.\r
@param KeyData A pointer to a buffer that is filled in with the keystroke\r
state data for the key that was pressed.\r
\r
@retval EFI_SUCCESS The keystroke information was returned.\r
- @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_NOT_READY There was no keystroke data available.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to\r
hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to\r
hardware errors.\r
@retval EFI_INVALID_PARAMETER KeyData is NULL.\r