add defmt support

Author: ryankurte

Cargo.toml

@@ -12,6 +12,8 @@ readme        = "README.md"
 categories    = ["embedded", "network-programming", "no-std"]
 keywords      = ["WPAN"]
 
+[features]
+
 
 [badges]
 travis-ci   = { repository = "braun-robotics/ieee802154" }
@@ -21,3 +23,4 @@ travis-ci   = { repository = "braun-robotics/ieee802154" }
 byteorder     = { version = "1", default-features = false }
 hash32        = "0.1"
 hash32-derive = "0.1"
+defmt = { version = "0.2.1", optional = true }

src/mac/beacon.rs

@@ -9,6 +9,7 @@ use crate::mac::{DecodeError, ExtendedAddress, ShortAddress};
 
 /// Beacon order is used to calculate the beacon interval
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum BeaconOrder {
     /// Used to calculate at which interval beacons are sent
     ///
@@ -40,6 +41,7 @@ impl From<BeaconOrder> for u8 {
 
 /// Superframe order, amount of time during wich this superframe is active
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum SuperframeOrder {
     /// Ammount of time that the superframe is active
     ///
@@ -74,6 +76,7 @@ impl From<SuperframeOrder> for u8 {
 /// The superframe specification describes the organisation of frames in the
 /// air when using superframes and/or periodical beacons.
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct SuperframeSpecification {
     /// Beacon order, 0-15, where 15 is on demand.
     ///
@@ -170,6 +173,7 @@ impl SuperframeSpecification {
 
 /// Direction of data
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 enum Direction {
     /// Receive data
     Receive,
@@ -179,6 +183,7 @@ enum Direction {
 
 /// Descriptor of the guaranteed time slots (GTSs)
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct GuaranteedTimeSlotDescriptor {
     /// Device short address used by this slot
     short_address: ShortAddress,
@@ -266,6 +271,7 @@ const PERMIT: u8 = 0b1000_0000;
 
 /// Information of the guaranteed time slots (GTSs)
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct GuaranteedTimeSlotInformation {
     /// Permit GTS
     pub permit: bool,
@@ -395,6 +401,7 @@ const EXTENDED_MASK: u8 = 0b0111_0000;
 /// ```
 ///
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PendingAddress {
     short_address_count: usize,
     short_addresses: [ShortAddress; 7],
@@ -504,6 +511,7 @@ impl PendingAddress {
 }
  /// Beacon frame
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Beacon {
     /// Superframe specification
     pub superframe_spec: SuperframeSpecification,

src/mac/command.rs

@@ -38,6 +38,7 @@ const CAP_ALLOCATE_ADDRESS: u8 = 0x80;
 ///
 /// Sent with association request to report the capabilities of the device.
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct CapabilityInformation {
     /// Full-function device (FFD) or a reduced-function device (RFD)
     /// RFD and FFD have different function sets.
@@ -119,6 +120,7 @@ extended_enum!(
 ///
 /// Changes to the PAN sent by the coordinator.
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct CoordinatorRealignmentData {
     /// PAN id that the coordinator will use
     pub pan_id: PanId,
@@ -211,6 +213,7 @@ const GTSC_ALLOCATION: u8 = 0x20;
 ///
 /// GTS configuration requested with the guaranteed time slot request command.
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct GuaranteedTimeSlotCharacteristics {
     /// Number of slots requested
     pub count: u8,
@@ -247,6 +250,7 @@ impl From<GuaranteedTimeSlotCharacteristics> for u8 {
 
 /// MAC commands
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum Command {
     /// Association request, request association to a PAN
     AssociationRequest(CapabilityInformation),

src/mac/frame.rs

@@ -25,6 +25,7 @@ use crate::mac::command::Command;
 /// [decode]: #method.decode
 /// [encode]: #method.encode
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Frame<'p> {
     /// Header
     pub header: Header,
@@ -225,6 +226,7 @@ pub enum WriteFooter {
 
 /// MAC frame header
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Header {
     /// Frame Type
     pub frame_type: FrameType,
@@ -485,6 +487,7 @@ impl Header {
 ///
 /// Part of [`Header`].
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum FrameType {
     /// Beacon
     Beacon = 0b000,
@@ -538,6 +541,7 @@ impl FrameType {
 /// Part of [`Header`]. Auxiliary security headers are currently unsupported by
 /// this implementation.
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum Security {
     /// No auxiliary security header is present
     None = 0b0,
@@ -567,6 +571,7 @@ impl Security {
 
 /// Defines version information for a frame
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum FrameVersion {
     /// A frame conforming to the 802.15.4-2003 standard
     Ieee802154_2003 = 0b00,
@@ -602,6 +607,7 @@ impl FrameVersion {
 
 /// Defines the type of Address
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum AddressMode {
     /// PAN identifier and address field are not present
     None = 0b00,
@@ -647,6 +653,7 @@ impl AddressMode {
 /// let pan_id = PanId(0x0123);
 /// ```
 #[derive(Clone, Copy, Debug, Eq, Hash, Hash32, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PanId(pub u16);
 
 impl PanId {
@@ -732,6 +739,7 @@ impl PanId {
 /// let short_address = ShortAddress(0x0123);
 /// ```
 #[derive(Clone, Copy, Debug, Eq, Hash, Hash32, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct ShortAddress(pub u16);
 
 impl ShortAddress {
@@ -822,6 +830,7 @@ impl ShortAddress {
 /// let ext_address = ExtendedAddress(0x0123456789abcdef);
 /// ```
 #[derive(Clone, Copy, Debug, Eq, Hash, Hash32, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct ExtendedAddress(pub u64);
 
 impl ExtendedAddress {
@@ -851,6 +860,7 @@ impl ExtendedAddress {
 
 /// An address that might contain an PAN ID and address
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum Address {
     /// No address
     None,
@@ -964,6 +974,7 @@ impl Address {
 
 /// Content of a frame
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum FrameContent
 {
     /// Beacon frame content
@@ -1017,6 +1028,7 @@ impl FrameContent {
 
 /// Signals an error that occured while decoding bytes
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum DecodeError {
     /// Buffer does not contain enough bytes
     NotEnoughBytes,

src/utils.rs

@@ -15,6 +15,7 @@ macro_rules! extended_enum {
 
         $(#[$outer])*
         #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+        #[cfg_attr(feature = "defmt", derive(defmt::Format))]
         pub enum $name {
             $(
                 $(#[$inner])*