patina 21.1.1

Common types and functionality used in UEFI development.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! A module containing UEFI protocol definitions and their implementations of [ProtocolInterface].
//!
//! ## License
//!
//! Copyright (c) Microsoft Corporation.
//!
//! SPDX-License-Identifier: Apache-2.0
//!

pub mod decompress;
pub mod performance_measurement;
pub mod status_code;

use crate::BinaryGuid;

/// Define a binding between an Interface and the corresponding Guid
///
/// # Safety
///
/// Make sure that the Protocol Guid interface had the same layout that the implementer of this struct.
pub unsafe trait ProtocolInterface {
    /// The GUID of the UEFI protocol being implemented.
    const PROTOCOL_GUID: BinaryGuid;
}

macro_rules! impl_r_efi_protocol {
    ($protocol:ident) => {
        // SAFETY: This macro implements ProtocolInterface for r_efi protocol types. The PROTOCOL_GUID constant
        // from r_efi matches the protocol interface layout by design - r_efi provides the canonical UEFI
        // protocol definitions and GUIDs from the UEFI specification. The Protocol struct layout matches
        // the UEFI protocol interface requirements.
        unsafe impl ProtocolInterface for r_efi::efi::protocols::$protocol::Protocol {
            const PROTOCOL_GUID: BinaryGuid = BinaryGuid(r_efi::efi::protocols::$protocol::PROTOCOL_GUID);
        }
    };
}

impl_r_efi_protocol!(absolute_pointer);
impl_r_efi_protocol!(block_io);
impl_r_efi_protocol!(bus_specific_driver_override);
impl_r_efi_protocol!(debug_support);
impl_r_efi_protocol!(debugport);
// impl_r_efi_protocol!(decompress);
impl_r_efi_protocol!(device_path);
impl_r_efi_protocol!(device_path_from_text);
impl_r_efi_protocol!(device_path_utilities);
impl_r_efi_protocol!(disk_io);
impl_r_efi_protocol!(disk_io2);
impl_r_efi_protocol!(driver_binding);
impl_r_efi_protocol!(driver_diagnostics2);
impl_r_efi_protocol!(driver_family_override);
// protocol file ???;
impl_r_efi_protocol!(graphics_output);
impl_r_efi_protocol!(hii_database);
impl_r_efi_protocol!(hii_font);
impl_r_efi_protocol!(hii_font_ex);
// protocol hii_package_list ???;
impl_r_efi_protocol!(hii_string);
impl_r_efi_protocol!(ip4);
impl_r_efi_protocol!(ip6);
impl_r_efi_protocol!(load_file);

// Clashing implementation
// impl_r_efi_protocol!(load_file2);
impl_r_efi_protocol!(loaded_image);

// Clashing implementation
// efi::protocols::loaded_image::Protocol,
// efi::protocols::loaded_image_device_path::PROTOCOL_GUID

impl_r_efi_protocol!(managed_network);
impl_r_efi_protocol!(mp_services);
impl_r_efi_protocol!(pci_io);
impl_r_efi_protocol!(platform_driver_override);
impl_r_efi_protocol!(rng);
// protocol service_binding ???
impl_r_efi_protocol!(shell);
impl_r_efi_protocol!(shell_dynamic_command);
impl_r_efi_protocol!(shell_parameters);
impl_r_efi_protocol!(simple_file_system);
impl_r_efi_protocol!(simple_network);
impl_r_efi_protocol!(simple_text_input);
impl_r_efi_protocol!(simple_text_input_ex);
impl_r_efi_protocol!(simple_text_output);
impl_r_efi_protocol!(tcp4);
impl_r_efi_protocol!(tcp6);
impl_r_efi_protocol!(timestamp);
impl_r_efi_protocol!(udp4);
impl_r_efi_protocol!(udp6);