Skip to content

Commit

Permalink
Use gMuEventPreExitBootServicesGuid for SnpDxe to issue PxeShutdown (#…
Browse files Browse the repository at this point in the history
…522)

## Description
Fixes #520

SnpDxe registers for an ExitBootServices callback and runs the
PXE_OPCODE_SHUTDOWN and PXE_OPCODE_STOP commands for any network
controllers that the driver is attached to. If the Bus Master Enable bit
is cleared by PciBusDxe before this point, then completions returned by
the network cards will be unreadable to their drivers during the
shutdown sequence.

Register the SnpDxe callback for gMuEventPreExitBootServicesGuid instead
of gEfiEventExitBootServicesGuid to ensure the correct ordering:

1. ExitBootServices event
2. Network card shutdown sequence is completed
3. BME is disabled on PCI bridges (if configured)

- [X] 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 on ARM platform with two network cards

## Integration Instructions

N/A
  • Loading branch information
JoeLopez333 authored and kenlautner committed Dec 18, 2023
1 parent 2d602b3 commit 810c647
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion NetworkPkg/SnpDxe/Snp.c
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ SimpleNetworkDriverStart (
TPL_CALLBACK,
SnpNotifyExitBootServices,
Snp,
&gEfiEventExitBootServicesGuid,
&gMuEventPreExitBootServicesGuid, // MU_CHANGE
&Snp->ExitBootServicesEvent
);
if (EFI_ERROR (Status)) {
Expand Down
3 changes: 2 additions & 1 deletion NetworkPkg/SnpDxe/SnpDxe.inf
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@
NetLib

[Guids]
gEfiEventExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event
# MU_CHANGE - Use gMuEventPreExitBootServicesGuid for SnpDxe to issue PxeShutdown
gMuEventPreExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event
# MU_CHANGE - Signal gSnpNetworkInitializedEventGuid when Snp->Initialized() called.
gSnpNetworkInitializedEventGuid ## SOMETIMES_PRODUCES

Expand Down

0 comments on commit 810c647

Please sign in to comment.