Merge pull request #1367 from nicholasbishop/bishop-deprecate-bs

uefi: Deprecate BootServices

Author: nicholasbishop

uefi/CHANGELOG.md

@@ -1,5 +1,8 @@
 # uefi - [Unreleased]
 
+See [Deprecating SystemTable/BootServices/RuntimeServices][funcmigrate] for
+details of the deprecation in this release.
+
 We added documentation to `lib.rs` and the [uefi-rs book] about how
 `uefi` compares to "standard Rust binaries" for UEFI (those using `std`), and
 how to integrate the `uefi` crate into them.
@@ -8,6 +11,8 @@ how to integrate the `uefi` crate into them.
 - Added `Handle::new`
 
 ## Changed
+- The `BootServices` and `RuntimeServices` structs have been deprecated. Use
+  the `uefi::runtime` and `uefi::boot` modules instead.
 - **Breaking:** The conversion functions between device paths and text no longer
   take a `BootServices` argument. The global system table is used instead.
 - **Breaking:** `GraphicsOutput::modes` no longer takes a `BootServices`

uefi/src/prelude.rs

@@ -5,6 +5,7 @@
 pub use crate::{cstr16, cstr8, entry, Handle, ResultExt, Status, StatusExt};
 
 // Import the basic table types.
+#[allow(deprecated)]
 pub use crate::table::boot::BootServices;
 #[allow(deprecated)]
 pub use crate::table::runtime::RuntimeServices;

uefi/src/table/boot.rs

@@ -1,5 +1,7 @@
 //! UEFI services available during boot.
 
+#![allow(deprecated)]
+
 pub use crate::boot::{
     AllocateType, EventNotifyFn, LoadImageSource, OpenProtocolAttributes, OpenProtocolParams,
     ProtocolSearchKey, SearchType, TimerTrigger,
@@ -79,6 +81,7 @@ pub const PAGE_SIZE: usize = 4096;
 ///
 /// [`Output`]: crate::proto::console::text::Output
 /// [`open_protocol`]: BootServices::open_protocol
+#[deprecated = "Use the uefi::boot module instead. See https://github.com/rust-osdev/uefi-rs/blob/HEAD/docs/funcs_migration.md"]
 #[derive(Debug)]
 #[repr(transparent)]
 pub struct BootServices(uefi_raw::table::boot::BootServices);