deps: update bitflags to 2.1.0

We skipped 2.0.0 as due to a bug "cargo doc" didn't include generated documentation.

Author: phip1611

CHANGELOG.md

@@ -30,6 +30,9 @@
 - `Image::get_image_file_system` now returns a `fs::FileSystem` instead of the
   protocol.
 - `CString16::default` now always contains a null character.
+- `bitflags` bumped from `1.3` to `2.1`
+  - `GptPartitionAttributes::RESERVED_FOR_PARTITION_TYPE` replaced by 16
+    `TYPE_SPECIFIC_BIT_<N>` constants.
 
 ## uefi-macros - [Unreleased]
 

Cargo.lock

@@ -24,7 +24,7 @@ panic-on-logger-errors = []
 unstable = []
 
 [dependencies]
-bitflags = "1.3.1"
+bitflags = "2.1.0"
 derive_more = { version = "0.99.17", features = ["display"] }
 log = { version = "0.4.5", default-features = false }
 ptr_meta = { version = "0.2.0", default-features = false }

uefi/Cargo.toml

@@ -157,6 +157,7 @@ bitflags! {
     ///
     /// [RS-232]: https://en.wikipedia.org/wiki/RS-232
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct ControlBits: u32 {
         /// Clear to send
         const CLEAR_TO_SEND = 0x10;
@@ -186,11 +187,11 @@ bitflags! {
         ///
         /// Up to date as of UEFI 2.7 / Serial protocol v1
         const SETTABLE =
-            ControlBits::DATA_TERMINAL_READY.bits
-            | ControlBits::REQUEST_TO_SEND.bits
-            | ControlBits::HARDWARE_LOOPBACK_ENABLE.bits
-            | ControlBits::SOFTWARE_LOOPBACK_ENABLE.bits
-            | ControlBits::HARDWARE_FLOW_CONTROL_ENABLE.bits;
+            ControlBits::DATA_TERMINAL_READY.bits()
+            | ControlBits::REQUEST_TO_SEND.bits()
+            | ControlBits::HARDWARE_LOOPBACK_ENABLE.bits()
+            | ControlBits::SOFTWARE_LOOPBACK_ENABLE.bits()
+            | ControlBits::HARDWARE_FLOW_CONTROL_ENABLE.bits();
     }
 }
 

uefi/src/proto/console/serial.rs

@@ -2401,7 +2401,7 @@ pub mod messaging {
 
     }
 
-    bitflags! { # [doc = " Flags to identify/manage InfiniBand elements."] # [repr (transparent)] pub struct InfinibandResourceFlags : u32 { # [doc = " Set = service, unset = IOC."] const SERVICE = 0x0000_0001 ; # [doc = " Extended boot environment."] const EXTENDED_BOOT_ENVIRONMENT = 0x0000_0002 ; # [doc = " Console protocol."] const CONSOLE_PROTOCOL = 0x0000_0004 ; # [doc = " Storage protocol."] const STORAGE_PROTOCOL = 0x0000_0008 ; # [doc = " Network protocol."] const NETWORK_PROTOCOL = 0x0000_0010 ; }
+    bitflags! { # [doc = " Flags to identify/manage InfiniBand elements."] # [derive (Clone , Copy , Debug , Default , PartialEq , Eq , PartialOrd , Ord)] # [repr (transparent)] pub struct InfinibandResourceFlags : u32 { # [doc = " Set = service, unset = IOC."] const SERVICE = 0x0000_0001 ; # [doc = " Extended boot environment."] const EXTENDED_BOOT_ENVIRONMENT = 0x0000_0002 ; # [doc = " Console protocol."] const CONSOLE_PROTOCOL = 0x0000_0004 ; # [doc = " Storage protocol."] const STORAGE_PROTOCOL = 0x0000_0008 ; # [doc = " Network protocol."] const NETWORK_PROTOCOL = 0x0000_0010 ; }
 
     }
 
@@ -2417,7 +2417,7 @@ pub mod messaging {
 
     }
 
-    bitflags! { # [doc = " iSCSI login options."] # [repr (transparent)] pub struct IscsiLoginOptions : u16 { # [doc = " Header digest using CRC32. If not set, no header digest."] const HEADER_DIGEST_USING_CRC32 = 0x0002 ; # [doc = " Data digest using CRC32. If not set, no data digest."] const DATA_DIGEST_USING_CRC32 = 0x0008 ; # [doc = " Auth method none. If not set, auth method CHAP."] const AUTH_METHOD_NONE = 0x0800 ; # [doc = " CHAP UNI. If not set, CHAP BI."] const CHAP_UNI = 0x1000 ; }
+    bitflags! { # [doc = " iSCSI login options."] # [derive (Clone , Copy , Debug , Default , PartialEq , Eq , PartialOrd , Ord)] # [repr (transparent)] pub struct IscsiLoginOptions : u16 { # [doc = " Header digest using CRC32. If not set, no header digest."] const HEADER_DIGEST_USING_CRC32 = 0x0002 ; # [doc = " Data digest using CRC32. If not set, no data digest."] const DATA_DIGEST_USING_CRC32 = 0x0008 ; # [doc = " Auth method none. If not set, auth method CHAP."] const AUTH_METHOD_NONE = 0x0800 ; # [doc = " CHAP UNI. If not set, CHAP BI."] const CHAP_UNI = 0x1000 ; }
 
     }
 

uefi/src/proto/device_path/device_path_gen.rs

@@ -394,6 +394,7 @@ pub enum FileMode {
 
 bitflags! {
     /// Attributes describing the properties of a file on the file system.
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct FileAttribute: u64 {
         /// File can only be opened in [`FileMode::READ`] mode.

uefi/src/proto/media/file/mod.rs

@@ -2,7 +2,6 @@
 
 use crate::proto::unsafe_protocol;
 use crate::{guid, Char16, Guid};
-use bitflags::bitflags;
 
 newtype_enum! {
     /// MBR OS type.
@@ -66,7 +65,8 @@ newtype_enum! {
     }
 }
 
-bitflags! {
+bitflags::bitflags! {
+
     /// Attributes describing a GPT partition.
     ///
     /// * Bit 0: [`REQUIRED_PARTITION`][Self::REQUIRED_PARTITION]
@@ -75,35 +75,83 @@ bitflags! {
     /// * Bits `3..=47`: reserved for future use and must be zero.
     /// * Bits `48..=63`: See
     /// [`type_specific_bits`][Self::type_specific_bits] and
-    /// [`RESERVED_FOR_PARTITION_TYPE`][Self::RESERVED_FOR_PARTITION_TYPE].
-    #[derive(Default)]
+    /// [`PARTITION_TYPE_MASK`][Self::PARTITION_TYPE_MASK].
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct GptPartitionAttributes: u64 {
-        /// Partition is required for the platform to function.
-        const REQUIRED_PARTITION = 1 << 0;
-
-        /// No [`BlockIO`] protocol will be created for this partition.
+             /// Bit: Partition is required for the platform to function.
+        const REQUIRED_PARTITION = 1;
+        /// Bit: No [`BlockIO`] protocol will be created for this partition.
         ///
         /// [`BlockIO`]: uefi::proto::media::block::BlockIO
         const NO_BLOCK_IO_PROTOCOL = 1 << 1;
 
-        /// Indicates that special software on a legacy BIOS system may
+        /// Bit: Indicates that special software on a legacy BIOS system may
         /// treat this partition as bootable. UEFI boot managers must
         /// ignore the partition.
-        const LEGACY_BIOS_BOOTABLE = 1 << 2;
+        const LEGACY_BIOS_BOOTABLE = 2 << 1;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_1 = 1 << 48;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_2 = 1 << 49;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_3 = 1 << 50;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_4 = 1 << 51;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_5 = 1 << 52;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_6 = 1 << 53;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_7 = 1 << 54;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_8 = 1 << 55;
 
-        /// Mask for bits `48..=63`. The meaning of these bits depends
-        /// on the partition type.
-        const RESERVED_FOR_PARTITION_TYPE = 0xffff_0000_0000_0000;
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_9 = 1 << 56;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_10 = 1 << 57;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_11 = 1 << 58;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_12 = 1 << 59;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_13 = 1 << 60;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_14 = 1 << 61;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_15 = 1 << 62;
+
+        /// The meaning of this bit depends on the partition type.
+        const TYPE_SPECIFIC_BIT_16 = 1 << 63;
     }
 }
 
 impl GptPartitionAttributes {
+
+    /// Mask for bits `48..=63`. The meaning of these bits depends on the
+    /// partition type.
+    pub const PARTITION_TYPE_MASK: u64 = 0xffff_0000_0000_0000;
+
     /// Get bits `48..=63` as a [`u16`]. The meaning of these bits depends
     /// on the partition's type (see [`GptPartitionEntry::partition_type_guid`]).
     #[must_use]
     pub const fn type_specific_bits(&self) -> u16 {
-        (self.bits >> 48) as u16
+        (self.0.bits() >> 48) as u16
     }
 }
 
@@ -232,7 +280,7 @@ mod tests {
 
     #[test]
     fn test_partition_attributes() {
-        let attr = GptPartitionAttributes::from_bits(0xabcd_0000_0000_0007).unwrap();
+        let attr = GptPartitionAttributes::from(0xabcd_0000_0000_0007);
         assert_eq!(attr.type_specific_bits(), 0xabcd);
     }
 }

uefi/src/proto/media/partition.rs

@@ -839,6 +839,7 @@ pub struct MtftpInfo {
 // No corresponding type in the UEFI spec, it just uses UINT16.
 bitflags! {
     /// Flags for UDP read and write operations.
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct UdpOpFlags: u16 {
         /// Receive a packet sent from any IP address in UDP read operations.
@@ -903,6 +904,7 @@ impl IpFilter {
 
 bitflags! {
     /// IP receive filters.
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct IpFilters: u8 {
         /// Enable the Station IP address.
@@ -1019,6 +1021,7 @@ impl DhcpV4Packet {
 bitflags! {
     /// Represents the 'flags' field for a [`DhcpV4Packet`].
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct DhcpV4Flags: u16 {
         /// Should be set when the client cannot receive unicast IP datagrams
         /// until its protocol software has been configured with an IP address.

uefi/src/proto/network/pxe.rs

@@ -124,16 +124,23 @@ impl SimpleNetwork {
         if let Some(mcast_filter) = mcast_filter {
             (self.receive_filters)(
                 self,
-                enable.bits,
-                disable.bits,
+                enable.bits(),
+                disable.bits(),
                 reset_mcast_filter,
                 mcast_filter.len(),
                 NonNull::new(mcast_filter.as_ptr() as *mut _),
             )
             .into()
         } else {
-            (self.receive_filters)(self, enable.bits, disable.bits, reset_mcast_filter, 0, None)
-                .into()
+            (self.receive_filters)(
+                self,
+                enable.bits(),
+                disable.bits(),
+                reset_mcast_filter,
+                0,
+                None,
+            )
+            .into()
         }
     }
 
@@ -272,6 +279,7 @@ impl SimpleNetwork {
 bitflags! {
     /// Flags to pass to receive_filters to enable/disable reception of some kinds of packets.
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct ReceiveFlags : u32 {
         /// Receive unicast packets.
         const UNICAST = 0x01;
@@ -290,6 +298,7 @@ bitflags! {
     /// Flags returned by get_interrupt_status to indicate which interrupts have fired on the
     /// interface since the last call.
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct InterruptStatus : u32 {
         /// Packet received.
         const RECEIVE = 0x01;

uefi/src/proto/network/snp.rs

@@ -25,8 +25,8 @@ bitflags! {
     /// Flags indicating if the processor is BSP or AP,
     /// if the processor is enabled or disabled, and if
     /// the processor is healthy.
-    #[derive(Default)]
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     struct StatusFlag: u32 {
         /// Processor is playing the role of BSP.
         const PROCESSOR_AS_BSP_BIT = 1;

uefi/src/proto/pi/mp.rs

@@ -28,7 +28,7 @@ bitflags! {
     /// Hash algorithms the protocol can provide.
     ///
     /// The [`v1`] protocol only supports SHA1.
-    #[derive(Default)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct HashAlgorithm: u32 {
         /// SHA-1 hash.

uefi/src/proto/tcg/mod.rs

@@ -60,7 +60,7 @@ impl BootServiceCapability {
     pub fn hash_algorithm(&self) -> HashAlgorithm {
         // Safety: the value should always be 0x1 (indicating SHA-1), but
         // we don't care if it's some unexpected value.
-        unsafe { HashAlgorithm::from_bits_unchecked(u32::from(self.hash_algorithm_bitmap)) }
+        HashAlgorithm::from_bits_retain(u32::from(self.hash_algorithm_bitmap))
     }
 
     /// Whether the TPM device is present.

uefi/src/proto/tcg/v1.rs

@@ -38,7 +38,7 @@ bitflags! {
     /// Event log formats supported by the firmware.
     ///
     /// Corresponds to the C typedef `EFI_TCG2_EVENT_ALGORITHM_BITMAP`.
-    #[derive(Default)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct EventLogFormat: u32 {
         /// Firmware supports the SHA-1 log format.
@@ -125,7 +125,7 @@ impl BootServiceCapability {
 
 bitflags! {
     /// Flags for the [`Tcg::hash_log_extend_event`] function.
-    #[derive(Default)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     #[repr(transparent)]
     pub struct HashLogExtendEventFlags: u64 {
         /// Extend an event but don't log it.

uefi/src/proto/tcg/v2.rs

@@ -1932,6 +1932,7 @@ impl Align for MemoryDescriptor {
 bitflags! {
     /// Flags describing the capabilities of a memory range.
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct MemoryAttribute: u64 {
         /// Supports marking as uncacheable.
         const UNCACHEABLE = 0x1;
@@ -2169,6 +2170,7 @@ impl<'guid> SearchType<'guid> {
 bitflags! {
     /// Flags describing the type of an UEFI event and its attributes.
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct EventType: u32 {
         /// The event is a timer event and may be passed to `BootServices::set_timer()`
         /// Note that timers only function during boot services time.

uefi/src/table/boot.rs

@@ -64,6 +64,7 @@ pub struct PropertiesTable {
 bitflags! {
     /// Flags describing memory protection.
     #[repr(transparent)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
     pub struct MemoryProtectionAttribute: usize {
         /// If this bit is set, then the UEFI implementation will mark pages
         /// containing data as non-executable.