wip: added MAC indications

This commit is contained in:
goueslati 2023-07-11 17:19:32 +01:00
parent 67b14e6e7a
commit fbddfcbfb7
4 changed files with 221 additions and 0 deletions

View File

@ -1,3 +1,4 @@
pub const MAX_ED_SCAN_RESULTS_SUPPORTED: usize = 16;
pub const MAX_PAN_DESC_SUPPORTED: usize = 6;
pub const MAX_SOUNDING_LIST_SUPPORTED: usize = 6;
pub const MAX_PENDING_ADDRESS: usize = 7;

View File

@ -0,0 +1,205 @@
use super::consts::MAX_PENDING_ADDRESS;
use super::typedefs::{AddressMode, MacAddress, PanDescriptor};
/// MLME ASSOCIATE Indication which will be used by the MAC
/// to indicate the reception of an association request command
#[repr(C)]
pub struct AssociateIndication {
/// Extended address of the device requesting association
pub device_address: [u8; 8],
/// Operational capabilities of the device requesting association
pub capability_information: u8,
/// Security level purportedly used by the received MAC command frame
pub security_level: u8,
/// The mode used to identify the key used by the originator of frame
pub key_id_mode: u8,
/// Index of the key used by the originator of the received frame
pub key_index: u8,
/// The originator of the key used by the originator of the received frame
pub key_source: [u8; 8],
}
/// MLME DISASSOCIATE indication which will be used to send
/// disassociation indication to the application.
#[repr(C)]
pub struct DisassociateIndication {
/// Extended address of the device requesting association
pub device_address: [u8; 8],
/// The reason for the disassociation
pub disassociate_reason: u8,
/// The security level to be used
pub security_level: u8,
/// The mode used to identify the key to be used
pub key_id_mode: u8,
/// The index of the key to be used
pub key_index: u8,
/// The originator of the key to be used
pub key_source: [u8; 8],
}
/// MLME BEACON NOTIIFY Indication which is used to send parameters contained
/// within a beacon frame received by the MAC to the application
#[repr(C)]
pub struct BeaconNotifyIndication {
/// he set of octets comprising the beacon payload to be transferred
/// from the MAC sublayer entity to the next higher layer
pub sdu_ptr: *const u8,
/// The PAN Descriptor for the received beacon
pub pan_descriptor: PanDescriptor,
/// The list of addresses of the devices
pub addr_list: [MacAddress; MAX_PENDING_ADDRESS],
/// Beacon Sequence Number
pub bsn: u8,
/// The beacon pending address specification
pub pend_addr_spec: u8,
/// Number of octets contained in the beacon payload of the beacon frame
pub sdu_length: u8,
}
/// MLME COMM STATUS Indication which is used by the MAC to indicate a communications status
#[repr(C)]
pub struct CommStatusIndication {
/// The 16-bit PAN identifier of the device from which the frame
/// was received or to which the frame was being sent
pub pan_id: [u8; 2],
/// Source addressing mode
pub src_addr_mode: AddressMode,
/// Destination addressing mode
pub dst_addr_mode: AddressMode,
/// Source address
pub src_address: MacAddress,
/// Destination address
pub dst_address: MacAddress,
/// The communications status
pub status: u8,
/// Security level to be used
pub security_level: u8,
/// Mode used to identify the key to be used
pub key_id_mode: u8,
/// Index of the key to be used
pub key_index: u8,
/// Originator of the key to be used
pub key_source: [u8; 8],
}
/// MLME GTS Indication indicates that a GTS has been allocated or that a
/// previously allocated GTS has been deallocated
#[repr(C)]
pub struct GtsIndication {
/// The short address of the device that has been allocated or deallocated a GTS
pub device_address: [u8; 2],
/// The characteristics of the GTS
pub gts_characteristics: u8,
/// Security level to be used
pub security_level: u8,
/// Mode used to identify the key to be used
pub key_id_mode: u8,
/// Index of the key to be used
pub key_index: u8,
/// Originator of the key to be used
pub key_source: [u8; 8],
}
/// MLME ORPHAN Indication which is used by the coordinator to notify the
/// application of the presence of an orphaned device
#[repr(C)]
pub struct OrphanIndication {
/// Extended address of the orphaned device
pub orphan_address: [u8; 8],
/// Originator of the key used by the originator of the received frame
pub key_source: [u8; 8],
/// Security level purportedly used by the received MAC command frame
pub security_level: u8,
/// Mode used to identify the key used by originator of received frame
pub key_id_mode: u8,
/// Index of the key used by the originator of the received frame
pub key_index: u8,
}
/// MLME SYNC LOSS Indication which is used by the MAC to indicate the loss
/// of synchronization with the coordinator
#[repr(C)]
pub struct SyncLossIndication {
/// The PAN identifier with which the device lost synchronization or to which it was realigned
pub pan_id: [u8; 2],
/// The reason that synchronization was lost
pub loss_reason: u8,
/// The logical channel on which the device lost synchronization or to whi
pub channel_number: u8,
/// The channel page on which the device lost synchronization or to which
pub channel_page: u8,
/// The security level used by the received MAC frame
pub security_level: u8,
/// Mode used to identify the key used by originator of received frame
pub key_id_mode: u8,
/// Index of the key used by the originator of the received frame
pub key_index: u8,
/// Originator of the key used by the originator of the received frame
pub key_source: [u8; 8],
}
/// MLME DPS Indication which indicates the expiration of the DPSIndexDuration
/// and the resetting of the DPS values in the PHY
pub struct DpsIndication;
#[repr(C)]
pub struct DataIndication {
/// Pointer to the set of octets forming the MSDU being indicated
pub msdu_ptr: *const u8,
/// Source addressing mode used
pub src_addr_mode: u8,
/// Source PAN ID
pub src_pan_id: [u8; 2],
/// Source address
pub src_address: MacAddress,
/// Destination addressing mode used
pub dst_addr_mode: AddressMode,
/// Destination PAN ID
pub dst_pan_id: [u8; 2],
/// Destination address
pub dst_address: MacAddress,
/// The number of octets contained in the MSDU being indicated
pub msdu_length: u8,
/// QI value measured during reception of the MPDU
pub mpdu_link_quality: u8,
/// The data sequence number of the received data frame
pub dsn: u8,
/// The time, in symbols, at which the data were received
pub time_stamp: [u8; 4],
/// The security level purportedly used by the received data frame
pub security_level: u8,
/// Mode used to identify the key used by originator of received frame
pub key_id_mode: u8,
/// The originator of the key
pub key_source: [u8; 8],
/// The index of the key
pub key_index: u8,
/// he pulse repetition value of the received PPDU
pub uwbprf: u8,
/// The preamble symbol repetitions of the UWB PHY frame
pub uwn_preamble_symbol_repetitions: u8,
/// Indicates the data rate
pub datrate: u8,
/// time units corresponding to an RMARKER at the antenna at the end of a ranging exchange,
pub ranging_received: u8,
pub ranging_counter_start: u32,
pub ranging_counter_stop: u32,
/// ime units in a message exchange over which the tracking offset was measured
pub ranging_tracking_interval: u32,
/// time units slipped or advanced by the radio tracking system
pub ranging_offset: u32,
/// The FoM characterizing the ranging measurement
pub ranging_fom: u8,
/// The Received Signal Strength Indicator measured
pub rssi: u8,
}
/// MLME POLL Indication which will be used for indicating the Data Request
/// reception to upper layer as defined in Zigbee r22 - D.8.2
#[repr(C)]
pub struct PollIndication {
/// addressing mode used
pub addr_mode: u8,
/// Poll requester address
pub request_address: MacAddress,
}

View File

@ -18,6 +18,7 @@ use crate::{channels, evt};
pub mod commands;
mod consts;
pub mod indications;
mod opcodes;
pub mod responses;
pub mod typedefs;

View File

@ -9,6 +9,7 @@ pub trait MacResponse {
/// MLME ASSOCIATE Confirm used to inform of the initiating device whether
/// its request to associate was successful or unsuccessful
#[repr(C)]
pub struct AssociateConfirm {
/// short address allocated by the coordinator on successful association
pub assoc_short_address: [u8; 2],
@ -25,6 +26,7 @@ pub struct AssociateConfirm {
}
/// MLME DISASSOCIATE Confirm used to send disassociation Confirmation to the application.
#[repr(C)]
pub struct DisassociateConfirm {
/// status of the disassociation attempt
pub status: u8,
@ -37,6 +39,7 @@ pub struct DisassociateConfirm {
}
/// MLME GET Confirm which requests information about a given PIB attribute
#[repr(C)]
pub struct GetConfirm {
/// The pointer to the value of the PIB attribute attempted to read
pub pib_attribute_value_ptr: *const u8,
@ -50,6 +53,7 @@ pub struct GetConfirm {
/// MLME GTS Confirm which eports the results of a request to allocate a new GTS
/// or to deallocate an existing GTS
#[repr(C)]
pub struct GtsConfirm {
/// The characteristics of the GTS
pub gts_characteristics: u8,
@ -58,6 +62,7 @@ pub struct GtsConfirm {
}
/// MLME RESET Confirm which is used to report the results of the reset operation
#[repr(C)]
pub struct ResetConfirm {
/// The result of the reset operation
status: u8,
@ -65,12 +70,14 @@ pub struct ResetConfirm {
/// MLME RX ENABLE Confirm which is used to report the results of the attempt
/// to enable or disable the receiver
#[repr(C)]
pub struct RxEnableConfirm {
/// Result of the request to enable or disable the receiver
status: u8,
}
/// MLME SCAN Confirm which is used to report the result of the channel scan request
#[repr(C)]
pub struct ScanConfirm {
/// Status of the scan request
pub status: u8,
@ -93,6 +100,7 @@ pub struct ScanConfirm {
}
/// MLME SET Confirm which reports the result of an attempt to write a value to a PIB attribute
#[repr(C)]
pub struct SetConfirm {
/// The result of the set operation
pub status: u8,
@ -102,12 +110,14 @@ pub struct SetConfirm {
/// MLME START Confirm which is used to report the results of the attempt to
/// start using a new superframe configuration
#[repr(C)]
pub struct StartConfirm {
/// Result of the attempt to start using an updated superframe configuration
pub status: u8,
}
/// MLME POLL Confirm which is used to report the result of a request to poll the coordinator for data
#[repr(C)]
pub struct PollConfirm {
/// The status of the data request
pub status: u8,
@ -115,6 +125,7 @@ pub struct PollConfirm {
/// MLME SOUNDING Confirm which reports the result of a request to the PHY to provide
/// channel sounding information
#[repr(C)]
pub struct SoundingConfirm {
/// Results of the sounding measurement
sounding_list: [u8; MAX_SOUNDING_LIST_SUPPORTED],
@ -122,6 +133,7 @@ pub struct SoundingConfirm {
/// MLME CALIBRATE Confirm which reports the result of a request to the PHY
/// to provide internal propagation path information
#[repr(C)]
pub struct CalibrateConfirm {
/// The status of the attempt to return sounding data
pub status: u8,
@ -135,6 +147,7 @@ pub struct CalibrateConfirm {
/// MCPS DATA Confirm which will be used for reporting the results of
/// MAC data related requests from the application
#[repr(C)]
pub struct DataConfirm {
/// The handle associated with the MSDU being confirmed
pub msdu_handle: u8,
@ -160,6 +173,7 @@ pub struct DataConfirm {
/// MCPS PURGE Confirm which will be used by the MAC to notify the application of
/// the status of its request to purge an MSDU from the transaction queue
#[repr(C)]
pub struct PurgeConfirm {
/// Handle associated with the MSDU requested to be purged from the transaction queue
pub msdu_handle: u8,