Add HID Keyboard support to UefiHidDxe (#347)

## Description

Adds HID keyboard support to UefiHidDxe input driver.

- [x] Impacts functionality?
  - Adds keyboard support.
- [ ] Impacts security?
- [ ] Breaking change?
- [ ] Includes tests?
- [x] Includes documentation?
  - standard rustdocs
## How This Was Tested

Tested with USB keyboard support in QEMU. Early iterations also tested
in hardware.

## Integration Instructions
Platforms will need to add `HiiKeyboardLayout = {path =
"HidPkg/Crates/HiiKeyboardLayout"}` to the `[workspace.dependencies]` in
their cargo.toml if not already present.

Cargo.toml

@@ -13,8 +13,8 @@ members = [
 RustAdvancedLoggerDxe = {path = "AdvLoggerPkg/Crates/RustAdvancedLoggerDxe"}
 RustBootServicesAllocatorDxe = {path = "MsCorePkg/Crates/RustBootServicesAllocatorDxe"}
 HidIo = {path = "HidPkg/Crates/HidIo"}
-
 hidparser = {git = "https://github.com/microsoft/mu_rust_hid.git", branch = "main"}
+HiiKeyboardLayout = {path = "HidPkg/Crates/HiiKeyboardLayout"}
 
 r-efi = "4.3.0"
 rustversion = "1.0.14"

HidPkg/Crates/HiiKeyboardLayout/src/lib.rs

@@ -42,6 +42,10 @@ use r_efi::{
 };
 use scroll::{ctx, Pread, Pwrite};
 
+/// GUID for default keyboard layout.
+pub const DEFAULT_KEYBOARD_LAYOUT_GUID: efi::Guid =
+  efi::Guid::from_fields(0x3a4d7a7c, 0x18a, 0x4b42, 0x81, 0xb3, &[0xdc, 0x10, 0xe3, 0xb5, 0x91, 0xbd]);
+
 /// HII Keyboard Package List
 /// Refer to UEFI spec version 2.10 section 33.3.1.2 which defines the generic header structure. This implementation
 /// only supports HII Keyboard Packages; other HII package types (or mixes) are not supported.
@@ -465,7 +469,7 @@ macro_rules! key_descriptor {
 #[rustfmt::skip]
 pub fn get_default_keyboard_layout() -> HiiKeyboardLayout {
   HiiKeyboardLayout {
-    guid: efi::Guid::from_fields(0x3a4d7a7c, 0x18a, 0x4b42, 0x81, 0xb3, &[0xdc, 0x10, 0xe3, 0xb5, 0x91, 0xbd]),
+    guid: DEFAULT_KEYBOARD_LAYOUT_GUID,
     keys: vec![
       key!(EfiKey::C1,          'a',    'A',    '\0',   '\0',   NULL_MODIFIER,                AFFECTED_BY_STANDARD_SHIFT | AFFECTED_BY_CAPS_LOCK),
       key!(EfiKey::B5,          'b',    'B',    '\0',   '\0',   NULL_MODIFIER,                AFFECTED_BY_STANDARD_SHIFT | AFFECTED_BY_CAPS_LOCK),

HidPkg/UefiHidDxe/Cargo.toml

@@ -16,6 +16,7 @@ test = false
 [dependencies]
 HidIo = {workspace=true}
 hidparser = {workspace=true}
+HiiKeyboardLayout = {workspace=true}
 memoffset = {workspace=true}
 r-efi = {workspace=true}
 rustversion = {workspace=true}

HidPkg/UefiHidDxe/src/driver_binding.rs

@@ -32,7 +32,7 @@ pub fn initialize_driver_binding(image_handle: efi::Handle) -> Result<(), efi::S
     stop: uefi_hid_driver_binding_stop,
     version: 1,
     image_handle: driver_binding_handle,
-    driver_binding_handle: driver_binding_handle,
+    driver_binding_handle,
   }));
 
   let status = (boot_services.install_protocol_interface)(
@@ -43,6 +43,7 @@ pub fn initialize_driver_binding(image_handle: efi::Handle) -> Result<(), efi::S
   );
 
   if status.is_error() {
+    drop(unsafe { Box::from_raw(driver_binding_ptr) });
     return Err(status);
   }
 

HidPkg/UefiHidDxe/src/hid.rs

@@ -17,7 +17,7 @@ use rust_advanced_logger_dxe::{debugln, DEBUG_ERROR, DEBUG_WARN};
 use crate::{keyboard, keyboard::KeyboardContext, pointer, pointer::PointerContext, BOOT_SERVICES};
 
 pub struct HidContext {
-  hid_io: *mut hid_io::protocol::Protocol,
+  pub hid_io: *mut hid_io::protocol::Protocol,
   pub keyboard_context: *mut KeyboardContext,
   pub pointer_context: *mut PointerContext,
 }