Skip to main content

zigbee_core/aps/aib/
mod.rs

1use zigbee_macros::construct_ib;
2use zigbee_macros::impl_byte;
3use zigbee_types::ByteArray;
4use zigbee_types::IeeeAddress;
5use zigbee_types::StorageVec;
6
7use super::binding::Binding;
8
9pub(crate) const MAX_APS_BINDING_TABLE: usize = 4;
10const MAX_APS_CHANNEL_MASK_LIST: usize = 2; // TODO
11const MAX_APS_GROUP_TABLE: usize = 2; // TODO
12const MAX_APS_MAX_WINDOW_SIZE: usize = 2; // TODO
13const MAX_APS_DEVICE_KEY_PAIR_SET: usize = 2; // TODO
14
15construct_ib! {
16    /// 2.2.7.2 - AIB (APS Information Base Attributes)
17    #[ids = AibId]
18    #[fields = AibFields]
19    pub struct Aib {
20        #[storage_key = 4]
21        #[setter = update_binding_table]
22        binding_table: StorageVec<Binding, MAX_APS_BINDING_TABLE>,
23        #[ctx = ()]
24        #[ctx_write = ()]
25        #[storage_key = 6]
26        #[setter = update_designated_coordinator]
27        designated_coordinator: bool = false,
28        #[storage_key = 7]
29        #[setter = update_channel_mask_list]
30        channel_mask_list: StorageVec<IeeeAddress, MAX_APS_CHANNEL_MASK_LIST>,
31        #[storage_key = 3]
32        #[setter = update_use_extended_pan_id]
33        use_extended_pan_id: IeeeAddress,
34        #[storage_key = 5]
35        #[setter = update_group_table]
36        group_table: StorageVec<ApsGroup, MAX_APS_GROUP_TABLE>,
37        #[storage_key = 8]
38        #[setter = update_non_member_radius]
39        non_member_radius: u8 = 0x02,
40        #[ctx = ()]
41        #[ctx_write = ()]
42        #[storage_key = 9]
43        #[setter = update_use_insecure_join]
44        use_insecure_join: bool = false,
45        #[storage_key = 10]
46        #[setter = update_interframe_delay]
47        interframe_delay: u8,
48        #[setter = update_last_channel_energy]
49        last_channel_energy: u8 = 0x00,
50        #[setter = update_last_channel_failure_rate]
51        last_channel_failure_rate: u8 = 0x00,
52        #[setter = update_channel_timer]
53        channel_timer: u8 = 0x00,
54        #[storage_key = 11]
55        #[setter = update_max_window_size]
56        max_window_size: StorageVec<ApsWindowSize, MAX_APS_MAX_WINDOW_SIZE>,
57        #[setter = update_parent_announce_timer]
58        parent_announce_timer: u8 = 0x00,
59        // security attributes
60        #[storage_key = 2]
61        #[setter = update_device_key_pair_set]
62        device_key_pair_set: StorageVec<DeviceKeyPairDescriptor, MAX_APS_DEVICE_KEY_PAIR_SET>,
63        #[storage_key = 1]
64        #[setter = update_trust_center_address]
65        trust_center_address: IeeeAddress = IeeeAddress(0xffff_ffff_ffff_ffff),
66        #[storage_key = 12]
67        #[setter = update_security_timeout_period]
68        security_timeout_period: u16 = 0x00,
69        // TODO: trust_center_policies attribute
70    }
71}
72
73// TODO: define group entry fields
74impl_byte! {
75    #[derive(Debug, Clone)]
76    pub struct ApsGroup(u8);
77}
78
79// TODO: define window size fields
80impl_byte! {
81    #[derive(Debug, Clone)]
82    pub struct ApsWindowSize(u8);
83}
84
85impl_byte! {
86    #[derive(Debug, Clone)]
87    pub struct DeviceKeyPairDescriptor {
88        pub device_address: IeeeAddress,
89        pub key_attributes: KeyAttribute,
90        pub link_key: ByteArray<16>,
91        pub outgoing_frame_counter: u32,
92        pub incoming_frame_counter: u32,
93        pub link_key_type: LinkKeyType,
94    }
95}
96
97impl_byte! {
98    #[tag(u8)]
99    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
100    pub enum KeyAttribute {
101        ProvisionalKey = 0x00,
102        UnverifiedKey = 0x01,
103        VerifiedKey = 0x02,
104        #[fallback = true]
105        Reserved(u8),
106    }
107}
108
109impl_byte! {
110    #[tag(u8)]
111    #[derive(Debug, Clone)]
112    pub enum LinkKeyType {
113        UniqueLinkKey = 0x00,
114        GlobalLinkKey = 0x01,
115        #[fallback = true]
116        Reserved(u8),
117    }
118}
119
120// flash persistence of the AIB
121#[cfg(feature = "storage")]
122pub(crate) mod storage;