Skip to content

Commit

Permalink
HidPkg/UsbHidDxe: Continue on failure to get descriptor (#334)
Browse files Browse the repository at this point in the history
## Description

In case a HID device fails to return a valid HID descriptor, this change
will return the error status from UsbHidDriverBindingStart() rather
than assert to match previous behavior from HID drivers that required
the boot protocol. The HID IO protocol will not be installed on these
devices.

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [ ] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

- Verified functionality is unchanged on physical platform with
UsbHidDxe integrated.
- Verified boot previously encountering an assert on the QEMU virtual
platform is
  not blocking boot.

## Integration Instructions

Update to a Mu Plus release with this change.

Signed-off-by: Michael Kubacki <[email protected]>
  • Loading branch information
makubacki authored Oct 17, 2023
1 parent 1824154 commit 2cc586d
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions HidPkg/UsbHidDxe/UsbHidDxe.c
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,6 @@ ReadDescriptors (

Status = UsbGetFullHidDescriptor (UsbHidDevice->UsbIo, UsbHidDevice->InterfaceDescriptor.InterfaceNumber, &UsbHidDevice->HidDescriptor);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto ErrorExit;
}

Expand Down Expand Up @@ -895,7 +894,6 @@ UsbHidDriverBindingStart (

Status = ReadDescriptors (UsbHidDevice);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto ErrorExit;
}

Expand Down

0 comments on commit 2cc586d

Please sign in to comment.