Skip to content

Commit

Permalink
uefi: Add and use prelude module
Browse files Browse the repository at this point in the history
Add a prelude module for the core crate, exposing frequently used UEFI
types, such as `Status`, `Handle`, and `Event`.

Signed-off-by: Tim Crawford <[email protected]>
  • Loading branch information
crawfxrd committed Jun 10, 2024
1 parent e2ab29c commit 2580d69
Show file tree
Hide file tree
Showing 17 changed files with 29 additions and 25 deletions.
2 changes: 1 addition & 1 deletion crates/uefi/src/block_io.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::status::Status;
use crate::prelude::*;

#[repr(C)]
pub struct BlockIoMedia {
Expand Down
5 changes: 2 additions & 3 deletions crates/uefi/src/boot.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
use crate::guid::Guid;
use crate::memory::{MemoryDescriptor, MemoryType};
use crate::status::Status;
use crate::{Event, Handle, TableHeader, Tpl};
use crate::prelude::*;
use crate::TableHeader;

#[repr(C)]
pub enum InterfaceType {
Expand Down
2 changes: 1 addition & 1 deletion crates/uefi/src/capsule.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use crate::guid::Guid;
use crate::memory::PhysicalAddress;
use crate::prelude::*;

pub const CAPSULE_FLAGS_PERSIST_ACROSS_RESET: u32 = 0x00010000;
pub const CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE: u32 = 0x00020000;
Expand Down
3 changes: 1 addition & 2 deletions crates/uefi/src/component_name.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use crate::status::Status;
use crate::Handle;
use crate::prelude::*;

#[repr(C)]
pub struct ComponentName {
Expand Down
2 changes: 1 addition & 1 deletion crates/uefi/src/config.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::guid::Guid;
use crate::prelude::*;

#[repr(C)]
pub struct ConfigurationTable {
Expand Down
2 changes: 1 addition & 1 deletion crates/uefi/src/device.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::guid::Guid;
use crate::prelude::*;

enum_try_from_int! {
#[repr(u8)]
Expand Down
3 changes: 1 addition & 2 deletions crates/uefi/src/fs.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use crate::guid::Guid;
use crate::status::Status;
use crate::prelude::*;
use crate::time::Time;

// Open modes
Expand Down
2 changes: 1 addition & 1 deletion crates/uefi/src/graphics.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::status::Status;
use crate::prelude::*;

#[derive(Copy, Clone, Debug)]
#[repr(C)]
Expand Down
1 change: 1 addition & 0 deletions crates/uefi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ pub mod hii;
pub mod loaded_image;
pub mod memory;
pub mod pointer;
pub mod prelude;
pub mod reset;
pub mod runtime;
pub mod shell;
Expand Down
4 changes: 1 addition & 3 deletions crates/uefi/src/loaded_image.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
use crate::memory::MemoryType;
use crate::status::Status;
use crate::system::SystemTable;
use crate::Handle;
use crate::prelude::*;

#[repr(C)]
pub struct LoadedImage {
Expand Down
2 changes: 1 addition & 1 deletion crates/uefi/src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ macro_rules! enum_try_from_int {
impl core::convert::TryFrom<$T> for $Name {
type Error = ();

fn try_from(value: $T) -> Result<$Name, ()> {
fn try_from(value: $T) -> core::result::Result<$Name, ()> {
match value {
$(
$value => Ok($Name::$Variant),
Expand Down
3 changes: 1 addition & 2 deletions crates/uefi/src/pointer.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use crate::status::Status;
use crate::Event;
use crate::prelude::*;

#[derive(Clone, Copy, Debug)]
#[repr(C)]
Expand Down
11 changes: 11 additions & 0 deletions crates/uefi/src/prelude.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// SPDX-License-Identifier: MIT

//! Access to commonly used data types and macros.
pub use crate::guid::Guid;
pub use crate::status::Result;
pub use crate::status::Status;
pub use crate::system::SystemTable;
pub use crate::Event;
pub use crate::Handle;
pub use crate::Tpl;
3 changes: 1 addition & 2 deletions crates/uefi/src/runtime.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
use crate::capsule::CapsuleHeader;
use crate::guid::Guid;
use crate::memory::{MemoryDescriptor, PhysicalAddress};
use crate::prelude::*;
use crate::reset::ResetType;
use crate::status::Status;
use crate::time::{Time, TimeCapabilities};
use crate::TableHeader;

Expand Down
3 changes: 1 addition & 2 deletions crates/uefi/src/shell.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use crate::status::Status;
use crate::Handle;
use crate::prelude::*;

#[repr(C)]
pub struct Shell {
Expand Down
3 changes: 2 additions & 1 deletion crates/uefi/src/system.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ use core::slice;

use crate::boot::BootServices;
use crate::config::ConfigurationTable;
use crate::prelude::*;
use crate::runtime::RuntimeServices;
use crate::text::{TextInput, TextOutput};
use crate::{Handle, TableHeader};
use crate::TableHeader;

#[repr(C)]
pub struct SystemTable {
Expand Down
3 changes: 1 addition & 2 deletions crates/uefi/src/text.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
use crate::status::Status;
use crate::Event;
use crate::prelude::*;

#[derive(Clone, Copy, Debug, Default)]
#[repr(C)]
Expand Down

0 comments on commit 2580d69

Please sign in to comment.