EmbeddedPkg/Drivers: add virtual keyboard driver

[mirror_edk2.git] / EmbeddedPkg / Include / Protocol / PlatformVirtualKeyboard.h

diff --git a/EmbeddedPkg/Include/Protocol/PlatformVirtualKeyboard.h b/EmbeddedPkg/Include/Protocol/PlatformVirtualKeyboard.h
new file mode 100644 (file)
index 0000000..c64d21e
--- /dev/null
+++ b/EmbeddedPkg/Include/Protocol/PlatformVirtualKeyboard.h
@@ -0,0 +1,65 @@
+/** @file\r
+\r
+  Copyright (c) 2018, Linaro. All rights reserved.\r
+\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 __PLATFORM_VIRTUAL_KEYBOARD_H__\r
+#define __PLATFORM_VIRTUAL_KEYBOARD_H__\r
+\r
+//\r
+// Protocol interface structure\r
+//\r
+typedef struct _PLATFORM_VIRTUAL_KBD_PROTOCOL  PLATFORM_VIRTUAL_KBD_PROTOCOL;\r
+\r
+typedef struct _VIRTUAL_KBD_KEY                VIRTUAL_KBD_KEY;\r
+\r
+#define VIRTUAL_KEYBOARD_KEY_SIGNATURE         SIGNATURE_32 ('v', 'k', 'b', 'd')\r
+\r
+struct _VIRTUAL_KBD_KEY {\r
+  UINTN                    Signature;\r
+  EFI_INPUT_KEY            Key;\r
+};\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *PLATFORM_VIRTUAL_KBD_REGISTER) (\r
+  IN VOID\r
+  );\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *PLATFORM_VIRTUAL_KBD_RESET) (\r
+  IN VOID\r
+  );\r
+\r
+typedef\r
+BOOLEAN\r
+(EFIAPI *PLATFORM_VIRTUAL_KBD_QUERY) (\r
+  IN VIRTUAL_KBD_KEY                           *VirtualKey\r
+  );\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *PLATFORM_VIRTUAL_KBD_CLEAR) (\r
+  IN VIRTUAL_KBD_KEY                           *VirtualKey\r
+  );\r
+\r
+struct _PLATFORM_VIRTUAL_KBD_PROTOCOL {\r
+  PLATFORM_VIRTUAL_KBD_REGISTER                Register;\r
+  PLATFORM_VIRTUAL_KBD_RESET                   Reset;\r
+  PLATFORM_VIRTUAL_KBD_QUERY                   Query;\r
+  PLATFORM_VIRTUAL_KBD_CLEAR                   Clear;\r
+};\r
+\r
+extern EFI_GUID gPlatformVirtualKeyboardProtocolGuid;\r
+\r
+#endif /* __PLATFORM_VIRTUAL_KEYBOARD_H__ */\r