wip: Deprecate SystemTable/BootServices/RuntimeServices

uefi-test-runner/src/main.rs

@@ -1,5 +1,8 @@
 #![no_std]
 #![no_main]
+// TODO: temporarily allow deprecated code so that we can continue to test
+// SystemTable/BootServices/RuntimeServices.
+#![allow(deprecated)]
 
 #[macro_use]
 extern crate log;

uefi/src/allocator.rs

@@ -14,11 +14,13 @@ use core::sync::atomic::{AtomicU32, Ordering};
 use crate::boot;
 use crate::mem::memory_map::MemoryType;
 use crate::proto::loaded_image::LoadedImage;
+
+#[allow(deprecated)]
 use crate::table::{Boot, SystemTable};
 
 /// Deprecated; this function is now a no-op.
 #[deprecated = "this function is now a no-op"]
-#[allow(unused_unsafe, clippy::missing_safety_doc)]
+#[allow(unused_unsafe, clippy::missing_safety_doc, deprecated)]
 pub unsafe fn init(_: &mut SystemTable<Boot>) {}
 
 /// Deprecated; this function is now a no-op.

uefi/src/helpers/logger.rs

@@ -12,6 +12,7 @@
 //! The last part also means that some Unicode characters might not be
 //! supported by the UEFI console. Don't expect emoji output support.
 
+#[allow(deprecated)]
 use crate::prelude::{Boot, SystemTable};
 use crate::proto::console::text::Output;
 use core::fmt::{self, Write};

uefi/src/helpers/mod.rs

@@ -18,6 +18,7 @@
 //! [print_macro]: uefi::print!
 //! [println_macro]: uefi::println!
 
+#[allow(deprecated)]
 use crate::prelude::{Boot, SystemTable};
 use crate::{table, Result};
 #[doc(hidden)]
@@ -41,6 +42,7 @@ mod println;
 /// The returned pointer is only valid until boot services are exited.
 #[must_use]
 #[deprecated(note = "use uefi::table::system_table_boot instead")]
+#[allow(deprecated)]
 pub fn system_table() -> SystemTable<Boot> {
     table::system_table_boot().expect("boot services are not active")
 }

uefi/src/prelude.rs

@@ -5,6 +5,9 @@
 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;
+#[allow(deprecated)]
 pub use crate::table::{Boot, SystemTable};

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);

uefi/src/table/mod.rs

@@ -8,6 +8,7 @@ mod header;
 mod system;
 
 pub use header::Header;
+#[allow(deprecated)]
 pub use system::{Boot, Runtime, SystemTable};
 pub use uefi_raw::table::Revision;
 
@@ -60,6 +61,8 @@ 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"]
+#[allow(deprecated)]
 pub fn system_table_boot() -> Option<SystemTable<Boot>> {
     let st = SYSTEM_TABLE.load(Ordering::Acquire);
     if st.is_null() {
@@ -77,6 +80,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() {
@@ -88,6 +92,7 @@ pub fn system_table_runtime() -> Option<SystemTable<Runtime>> {
         if (*st).runtime_services.is_null() {
             None
         } else {
+            #[allow(deprecated)]
             Some(SystemTable::<Runtime>::from_ptr(st.cast()).unwrap())
         }
     }

uefi/src/table/runtime.rs

@@ -1,5 +1,7 @@
 //! UEFI services available at runtime, even after the OS boots.
 
+#![allow(deprecated)]
+
 pub use crate::runtime::{
     CapsuleInfo, Time, TimeByteConversionError, TimeError, TimeParams, VariableStorageInfo,
 };
@@ -35,6 +37,7 @@ use {
 /// A reference to `RuntimeServices` can only be accessed by calling [`SystemTable::runtime_services`].
 ///
 /// [`SystemTable::runtime_services`]: crate::table::SystemTable::runtime_services
+#[deprecated = "Use the uefi::runtime module instead. See https://github.com/rust-osdev/uefi-rs/blob/HEAD/docs/funcs_migration.md"]
 #[derive(Debug)]
 #[repr(C)]
 pub struct RuntimeServices(uefi_raw::table::runtime::RuntimeServices);

uefi/src/table/system.rs

@@ -1,3 +1,5 @@
+#![allow(deprecated)]
+
 use super::boot::BootServices;
 use super::runtime::{ResetType, RuntimeServices};
 use super::{cfg, Revision};
@@ -15,11 +17,13 @@ use uefi::mem::memory_map::{
 pub trait SystemTableView {}
 
 /// Marker struct associated with the boot view of the UEFI System Table.
+#[deprecated = "Use the uefi::boot module instead. See https://github.com/rust-osdev/uefi-rs/blob/HEAD/docs/funcs_migration.md"]
 #[derive(Debug)]
 pub struct Boot;
 impl SystemTableView for Boot {}
 
 /// Marker struct associated with the run-time view of the UEFI System Table.
+#[deprecated = "Use the uefi::runtime module instead. See https://github.com/rust-osdev/uefi-rs/blob/HEAD/docs/funcs_migration.md"]
 #[derive(Debug)]
 pub struct Runtime;
 impl SystemTableView for Runtime {}