patina 21.1.0

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
90
91
92
93
94
95
96

//! This module defined every struct related to event in boot services.
//!
//! ## License
//!
//! Copyright (c) Microsoft Corporation.
//!
//! SPDX-License-Identifier: Apache-2.0
//!

use core::ops;

use r_efi::efi;

/// Function signature for event notify function.
pub type EventNotifyCallback<T> = extern "efiapi" fn(efi::Event, T);

/// The type of time that is specified in TriggerTime. See the timer delay types in “Related Definitions.”
#[derive(Debug, Clone, Copy)]
#[repr(u32)]
pub enum EventTimerType {
    /// The event’s timer setting is to be cancelled and no timer trigger is to be set.
    /// TriggerTime is ignored when canceling a timer.
    Cancel = efi::TIMER_CANCEL,

    /// The event is to be signaled periodically at TriggerTime intervals from the current time.
    /// This is the only timer trigger Type for which the event timer does not need to be reset for each notification.
    /// All other timer trigger types are “one shot.”
    Periodic = efi::TIMER_PERIODIC,

    /// The event is to be signaled in TriggerTime 100ns units.
    Relative = efi::TIMER_RELATIVE,
}

impl From<EventTimerType> for u32 {
    fn from(val: EventTimerType) -> Self {
        val as u32
    }
}

/// Type of event to create and its mode and attributes.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
#[repr(transparent)]
pub struct EventType(u32);

impl EventType {
    /// The event is a timer event and may be passed to [`BootServices::set_timer`](super::BootServices::set_timer).
    /// Note that timers only function during boot services time.
    pub const TIMER: EventType = EventType(efi::EVT_TIMER);

    /// The event is allocated from runtime memory.
    /// If an event is to be signaled after the call to [`BootServices::exit_boot_services`](super::BootServices::exit_boot_services)
    /// the event’s data structure and notification function need to be allocated from runtime memory.
    /// For more information, see
    /// <a href="https://uefi.org/specs/UEFI/2.10/08_Services_Runtime_Services.html#setvirtualaddressmap" target="_blank">
    ///   SetVirtualAddressMap()
    /// </a> .
    pub const RUNTIME: EventType = EventType(efi::EVT_RUNTIME);

    /// If an event of this type is not already in the signaled state,
    /// then the event’s NotificationFunction will be queued at the event’s NotifyTpl whenever the event is being waited
    /// on via [`BootServices::wait_for_event`](super::BootServices::wait_for_event) or [`BootServices::check_event`](super::BootServices::check_event).
    pub const NOTIFY_WAIT: EventType = EventType(efi::EVT_NOTIFY_WAIT);

    /// The event’s NotifyFunction is queued whenever the event is signaled.
    pub const NOTIFY_SIGNAL: EventType = EventType(efi::EVT_NOTIFY_SIGNAL);

    /// This event is of type [Self::NOTIFY_SIGNAL].
    /// It should not be combined with any other event types.
    /// This event type is functionally equivalent to the `EFI_EVENT_GROUP_EXIT_BOOT_SERVICES` event group.
    /// Refer to `EFI_EVENT_GROUP_EXIT_BOOT_SERVICES` event group description in [`BootServices::create_event_ex`](super::BootServices::create_event_ex) section below for additional details.
    pub const SIGNAL_EXIT_BOOT_SERVICES: EventType = EventType(efi::EVT_SIGNAL_EXIT_BOOT_SERVICES);

    /// The event is to be notified by the system when `SetVirtualAddressMap()` is performed.
    /// This event type is a composite of [`Self::NOTIFY_SIGNAL`], [`Self::RUNTIME`], and [`Self::RUNTIME`] and should not be combined with any other event types.
    pub const SIGNAL_VIRTUAL_ADDRESS_CHANGE: EventType = EventType(efi::EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE);
}

impl ops::BitOr for EventType {
    type Output = EventType;

    fn bitor(self, rhs: Self) -> Self::Output {
        EventType(self.0 | rhs.0)
    }
}

impl ops::BitOrAssign for EventType {
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0;
    }
}

impl From<EventType> for u32 {
    fn from(val: EventType) -> Self {
        val.0
    }
}