Merge pull request #1378 from nicholasbishop/bishop-deprecate-table-helpers

uefi: Deprecate table::{system_table_boot,system_table_runtime}

Author: phip1611

uefi/CHANGELOG.md

@@ -16,6 +16,8 @@ how to integrate the `uefi` crate into them.
 - In `uefi::table::boot`, `ScopedProtocol`, `TplGuard`, `ProtocolsPerHandle`,
   and `HandleBuffer` have been deprecated. Use the structs of the same name in
   `uefi::boot` instead.
+- `uefi::table::system_table_boot` and `uefi::table::system_table_runtime` 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/helpers/mod.rs

@@ -42,6 +42,7 @@ mod println;
 #[must_use]
 #[deprecated(note = "use uefi::table::system_table_boot instead")]
 pub fn system_table() -> SystemTable<Boot> {
+    #[allow(deprecated)]
     table::system_table_boot().expect("boot services are not active")
 }
 

uefi/src/table/mod.rs

@@ -60,6 +60,7 @@ pub unsafe fn set_system_table(ptr: *const uefi_raw::table::system::SystemTable)
 }
 
 /// Get the system table while boot services are active.
+#[deprecated = "Use the uefi::boot module instead. See https://github.com/rust-osdev/uefi-rs/blob/HEAD/docs/funcs_migration.md"]
 pub fn system_table_boot() -> Option<SystemTable<Boot>> {
     let st = SYSTEM_TABLE.load(Ordering::Acquire);
     if st.is_null() {
@@ -77,6 +78,7 @@ pub fn system_table_boot() -> Option<SystemTable<Boot>> {
 }
 
 /// Get the system table while runtime services are active.
+#[deprecated = "Use the uefi::runtime module instead. See https://github.com/rust-osdev/uefi-rs/blob/HEAD/docs/funcs_migration.md"]
 pub fn system_table_runtime() -> Option<SystemTable<Runtime>> {
     let st = SYSTEM_TABLE.load(Ordering::Acquire);
     if st.is_null() {