Merge pull request #15 from Frostie314159/defmt

Implement rudimentary defmt support.

Cargo.toml

@@ -10,15 +10,16 @@ authors = ["Frostie314159"]
 rust-version = "1.65.0"
 
 [dependencies]
-bitfield-struct = "0.6.0"
+bitfield-struct = "0.8.0"
 const_soft_float = { version = "0.1.4", features = ["no_std"] }
 crc32fast = { version = "1.3.2", default-features = false }
+defmt = { version = "0.3.8", optional = true }
 hmac = { version = "0.12.1", optional = true }
-mac-parser = "0.1.5"
+mac-parser = { version = "0.1.6", features = ["defmt"] }
 macro-bits = "0.1.4"
 num = { version = "0.4.3", default-features = false }
 pbkdf2 = { version = "0.12.2", optional = true }
-scroll = { version = "0.12.0", default-features = false }
+scroll = { version = "0.12.0", default-features = false, features = ["derive"] }
 sha1 = { version = "0.10.6", default-features = false, optional = true }
 tlv-rs = "0.2.3"
 
@@ -35,3 +36,4 @@ alloc = []
 crypto = ["dep:pbkdf2", "dep:hmac", "dep:sha1"]
 default = ["crypto"]
 std = ["alloc", "scroll/std"]
+defmt = ["dep:defmt"]

src/common/aid.rs

@@ -50,6 +50,12 @@ impl Debug for AssociationID {
         f.write_fmt(format_args!("{}", self.aid()))
     }
 }
+#[cfg(feature = "defmt")]
+impl defmt::Format for AssociationID {
+    fn format(&self, fmt: defmt::Formatter) {
+        defmt::write!(fmt, "{}", self.aid())
+    }
+}
 #[macro_export]
 /// Generate a new [AssociationID], while performing all checks at compile-time.
 ///

src/common/auth_algo_num.rs

@@ -2,6 +2,7 @@ use macro_bits::serializable_enum;
 
 serializable_enum! {
     #[non_exhaustive]
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     pub enum IEEE80211AuthenticationAlgorithmNumber: u16 {
         #[default]

src/common/capabilities.rs

@@ -1,6 +1,6 @@
 use bitfield_struct::bitfield;
 
-#[bitfield(u16)]
+#[bitfield(u16, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// This bitfield contains the capabilities of the sender.
 pub struct CapabilitiesInformation {

src/common/mod.rs

@@ -30,6 +30,7 @@ pub const TU: Duration = Duration::from_micros(1024);
 pub const IEEE_OUI: [u8; 3] = [0x00, 0x0f, 0xac];
 pub const WIFI_ALLIANCE_OUI: [u8; 3] = [0x50, 0x6f, 0x9a];
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 /// The frame type of an IEEE 802.11 frame.
 pub enum FrameType {
@@ -75,7 +76,7 @@ impl From<FrameType> for u16 {
 }
 
 /// These are the flags included in the frame control field.
-#[bitfield(u8)]
+#[bitfield(u8, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 pub struct FCFFlags {
     /// This frame is going to the distribution system.
@@ -95,7 +96,7 @@ pub struct FCFFlags {
     // TODO: Docs
     pub order: bool,
 }
-#[bitfield(u16)]
+#[bitfield(u16, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// This is the frame control field, which is at the beginning of every frame.
 pub struct FrameControlField {
@@ -106,7 +107,7 @@ pub struct FrameControlField {
     #[bits(8)]
     pub flags: FCFFlags,
 }
-#[bitfield(u16)]
+#[bitfield(u16, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// This is information about the sequence number and the potential fragment number.
 pub struct SequenceControl {
@@ -116,8 +117,9 @@ pub struct SequenceControl {
     pub sequence_number: u16,
 }
 
-/// An empty type, used for filling empty generics.
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Default, Debug, PartialEq, Eq, Hash)]
+/// An empty type, used for filling empty generics.
 pub struct Empty;
 impl<'a> TryFromCtx<'a> for Empty {
     type Error = scroll::Error;

src/common/read_iterator.rs

@@ -23,6 +23,28 @@ impl<'a, Ctx: Default + Copy, Type: TryFromCtx<'a, Ctx, Error = scroll::Error> +
         f.debug_list().entries(*self).finish()
     }
 }
+#[cfg(feature = "defmt")]
+impl<
+        'a,
+        Ctx: Default + Copy,
+        Type: TryFromCtx<'a, Ctx, Error = scroll::Error> + defmt::Format + Copy,
+    > defmt::Format for ReadIterator<'a, Ctx, Type>
+{
+    fn format(&self, fmt: defmt::Formatter) {
+        let mut iter = self.clone();
+        defmt::write!(fmt, "[");
+
+        if let Some(first) = iter.next() {
+            // We treat the first element differently, since the loop below prepends the comma to every element.
+            defmt::write!(fmt, "{}", first);
+            for next in iter {
+                defmt::write!(fmt, ", {}", next);
+            }
+        }
+
+        defmt::write!(fmt, "]");
+    }
+}
 impl<'a, Ctx: Default + Copy, Type: TryFromCtx<'a, Ctx, Error = scroll::Error>> Iterator
     for ReadIterator<'a, Ctx, Type>
 {

src/common/reason.rs

@@ -2,6 +2,7 @@ use macro_bits::serializable_enum;
 
 serializable_enum! {
     #[non_exhaustive]
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// An IEEE 802.11 reason code used in certain management frames.
     pub enum IEEE80211Reason: u16 {

src/common/status_code.rs

@@ -2,6 +2,7 @@ use macro_bits::serializable_enum;
 
 serializable_enum! {
     #[non_exhaustive]
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// An IEEE 802.11 status code used in certain management frames.
     pub enum IEEE80211StatusCode: u16 {

src/common/subtypes/control.rs

@@ -1,6 +1,7 @@
 use macro_bits::serializable_enum;
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
     /// This is the subtype of a control frame.
     ///

src/common/subtypes/data.rs

@@ -1,6 +1,7 @@
 use macro_bits::serializable_enum;
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The piggy-backed control frame of the data frame.
     pub enum DataFrameCF: u8 {
@@ -13,6 +14,7 @@ serializable_enum! {
 }
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The subtype of the data frame.
     pub enum DataFrameSubtype: u8 {

src/common/subtypes/mgmt.rs

@@ -1,6 +1,7 @@
 use macro_bits::serializable_enum;
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
     pub enum ManagementFrameSubtype: u8 {
         AssociationRequest => 0b0000,

src/elements/bss_load.rs

@@ -5,6 +5,7 @@ use scroll::{
 
 use super::{Element, ElementID};
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 /// The BSS Load element contains information on the current STA population and traffic levels in the BSS.
 pub struct BSSLoadElement {

src/elements/dsss_parameter_set.rs

@@ -5,6 +5,7 @@ use scroll::{
 
 use super::{Element, ElementID};
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
 /// The DSSS Parameter Set element contains information to allow channel number identification for STAs.
 pub struct DSSSParameterSetElement {

src/elements/element_chain.rs

@@ -31,10 +31,11 @@ pub trait ChainElement {
     fn append<T>(self, value: T) -> Self::Appended<T>;
 }
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[derive(Clone, Copy, Default, Debug, PartialEq, Eq, Hash)]
 /// This is the end of a chain.
 ///
 /// Counterintuitively it's the point where you create a new chain.
-#[derive(Clone, Copy, Default, Debug, PartialEq, Eq, Hash)]
 pub struct ElementChainEnd<Inner> {
     /// The last element of the chain.
     pub inner: Inner,
@@ -89,8 +90,9 @@ impl TryIntoCtx for ElementChainEnd<RawIEEE80211Element<'_>> {
     }
 }
 
-/// A link in the element chain.
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Default, Debug, PartialEq, Eq, Hash)]
+/// A link in the element chain.
 pub struct ElementChainLink<Inner, Child: ChainElement> {
     /// The current element.
     pub inner: Inner,

src/elements/ht/capabilities.rs

@@ -10,6 +10,7 @@ use crate::elements::{Element, ElementID};
 use super::SupportedMCSSet;
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// Spatial multiplexing power save mode.
     pub enum SmPwSave: u8 {
@@ -20,7 +21,7 @@ serializable_enum! {
         Disabled => 3
     }
 }
-#[bitfield(u16)]
+#[bitfield(u16, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// HT related capabilities info.
 pub struct HTCapabilitiesInfo {
@@ -65,6 +66,7 @@ pub struct HTCapabilitiesInfo {
 }
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The maximum length of an A-MPDU.
     pub enum MAXAMpduLength: u8 {
@@ -81,6 +83,7 @@ serializable_enum! {
 }
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// Minimum time between the start of adjacent MPDUs in A-MPDU, measured in µs.
     pub enum MpduDensity: u8 {
@@ -95,7 +98,7 @@ serializable_enum! {
         Sixteen => 7
     }
 }
-#[bitfield(u8)]
+#[bitfield(u8, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// Parameters for A-MPDU operation.
 pub struct AMpduParameters {
@@ -110,7 +113,7 @@ pub struct AMpduParameters {
     #[bits(3)]
     __: u8,
 }
-#[bitfield(u16)]
+#[bitfield(u16, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// Extended HT capabilities
 pub struct HTExtendedCapabilities {
@@ -127,6 +130,7 @@ pub struct HTExtendedCapabilities {
     __: u8,
 }
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The level of support for beamforming calibration.
     pub enum BeamformingCalibration: u8 {
@@ -138,6 +142,7 @@ serializable_enum! {
     }
 }
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The level of support for beamforming feedback.
     pub enum BeamformingFeedback: u8 {
@@ -149,6 +154,7 @@ serializable_enum! {
     }
 }
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The level of support for grouping.
     pub enum GroupingCapability: u8 {
@@ -159,7 +165,7 @@ serializable_enum! {
         GroupsOfTwoAndFour => 3
     }
 }
-#[bitfield(u32)]
+#[bitfield(u32, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// Capabilities related to transmit beamforming.
 pub struct TransmitBeamformingCapabilities {
@@ -223,7 +229,7 @@ pub struct TransmitBeamformingCapabilities {
     #[bits(3)]
     __: u8,
 }
-#[bitfield(u8)]
+#[bitfield(u8, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// The Antenna Selection capability of the STA.
 pub struct ASELCapability {
@@ -243,6 +249,7 @@ pub struct ASELCapability {
     pub transmit_sounding_ppdus_capable: bool,
     pub reserved: bool,
 }
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
 /// The [HTCapabilitiesElement] contains information about the HT capbilities of the STA.
 pub struct HTCapabilitiesElement {

src/elements/ht/mcs_set.rs

@@ -14,7 +14,7 @@ use scroll::{
 /// No Tx MCS set is defined | true | true | 0 | false
 /// The Tx MCS set is defined to be equal to the Rx MCS set | true | false | 0 | false
 /// The Tx MCS set may differ from the Rx MCS set | true | true | * | *
-#[bitfield(u32)]
+#[bitfield(u32, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 pub struct SupportedMCSSetFlags {
     /// The highest supported data rate.
@@ -50,6 +50,7 @@ impl SupportedMCSSetFlags {
         self.is_tx_mcs_undefined() && self.tx_rx_mcs_set_not_equal()
     }
 }
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
 /// The MCS Set supported by the transmitter.
 ///

src/elements/ht/operation.rs

@@ -10,6 +10,7 @@ use crate::elements::{Element, ElementID};
 use super::SupportedMCSSet;
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     /// The offset of the secondary channel from the primary.
     ///
@@ -33,6 +34,7 @@ serializable_enum! {
 }
 
 serializable_enum! {
+    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
     pub enum HTProtectionMode: u8 {
         #[default]
@@ -47,7 +49,7 @@ serializable_enum! {
     }
 }
 
-#[bitfield(u64)]
+#[bitfield(u64, defmt = cfg(feature = "defmt"))]
 #[derive(PartialEq, Eq, Hash)]
 /// Information about the operation of an HT-STA.
 pub struct HTOperationInformation {
@@ -84,6 +86,7 @@ pub struct HTOperationInformation {
     __: u64,
 }
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
 /// The operation of HT STAs in the BSS is controlled by the HT Operation element.
 pub struct HTOperationElement {

src/elements/ibss_parameter_set.rs

@@ -9,6 +9,7 @@ use crate::common::TU;
 
 use super::{Element, ElementID};
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash, PartialOrd, Ord)]
 /// The IBSS Parameter Set element contains the set of parameters necessary to support an IBSS.
 pub struct IBSSParameterSetElement {