v2.0.0

What's Changed

This is the first release published to crates.io.

• https://crates.io/crates/mu_rust_helpers

---

• global\_allocator: Fix build failure due to incorrect MemoryType reference @zurcher (#32)
  
  Change Details

    ## Description

  global_allocator.rs had references to MemoryType::BootServicesData instead of MemoryType::BOOT_SERVICES_DATA. This was causing failures when using cargo make.

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

  How This Was Tested

  cargo make build boot_services no longer fails to build.

  Integration Instructions

  N/A
  

  
  

  ---

  
  

• remove Sized from BootServices trait @joschock (#40)
  
  Change Details

    ## Description

  Relax the trait bounds on various consumers of BootServices to allow BootServices to be unsized. This will permit usage of BootServices trait objects.

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

  How This Was Tested

  Verified that unit tests still pass.

  Integration Instructions

  N/A
  

  
  

  ---

  
  

⚠️ Breaking Changes

• Add workspace publishing [Rebase \& FF] @makubacki (#43)
  
  Change Details

    ## Description

  Changes to support publishing crates from this repo.

  ---

  Add crate publishing support

  • Crates are currently being published from Mu repositories. The
    expectation is that the code will be moved to another repo after a
    period of time outside of Project Mu. To differentiate these early
    versions of the crates, the package names are prefixed with
    "mu_uefi".
  • Keep library names consistent with current code.
  • Add additional info to crates common to the workspace.
  • Add GitHub publishing workflow to the repo.
  • Add readme to Cargo.toml.
  • Sort some sections in the workspace Cargo.toml for ease of reading
    information.

  ---

  Update version to 2.0.0

  Version update for the upcoming release.

  ---

  Cargo.toml: Consolidate workspace dependency versions

  Use the workspace.dependencies versions to reduce maintenance
  overhead.

  ---

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

  How This Was Tested

  • Dry run of release to crates.io
  • Publish of crates to a test registry
  • GitHub workflow test on fork

  Integration Instructions

  • Use the published crates after this change is merged and the crates are published. Use the new crate names when updating.
    

  
  

  ---

• Improvement of BootServices @magravel (#38)
  
  Change Details

    ## Description

  • Add new version for install / uninstall / locate protocol (Breaking changes)

  • Increment version of Boot Services because of breaking changes.

  • Add test for Protocol Handler Service

  • Better function not initialized panic message

  • Impacts functionality?
    Yes, some functions working with protocol interface has been changed to have a version with a protocol and a version with a marker protocol (a null interface).

  • Impacts security?

  • Breaking change?

  • Includes tests?

  • Includes documentation?

  How This Was Tested

  this was tested with running the unit tests.

  Integration Instructions

  N/A
  

  
  

  ---

  
  

📖 Documentation Updates

• Improvement of BootServices @magravel (#38)
  
  Change Details

    ## Description

  • Add new version for install / uninstall / locate protocol (Breaking changes)

  • Increment version of Boot Services because of breaking changes.

  • Add test for Protocol Handler Service

  • Better function not initialized panic message

  • Impacts functionality?
    Yes, some functions working with protocol interface has been changed to have a version with a protocol and a version with a marker protocol (a null interface).

  • Impacts security?

  • Breaking change?

  • Includes tests?

  • Includes documentation?

  How This Was Tested

  this was tested with running the unit tests.

  Integration Instructions

  N/A
  

  
  

  ---

  
  

• Add Images Services @magravel (#39)
  
  Change Details

    ## Description

  Add Images Services with their respective documentation and test.

  For details on how to complete these options and their meaning refer to CONTRIBUTING.md.

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

  How This Was Tested

  This was tested with unit tests only.

  Integration Instructions

  N/A
  

  
  

  ---

  
  

• Add Misc Services @magravel (#33)
  
  Change Details

    ## Description

  Add misc services to BootServices.

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

  How This Was Tested

  This was tested by adding unit test to verify the efi functions are callded with the right arguments.

  Integration Instructions

  N/A
  

  
  

  ---

  
  

Full Changelog: v1.2.1...v2.0.0