vita49 0.0.5

vita49 is a crate for parsing and creating packets compatible with the ANSI/VITA-49.2-2017 standard.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

// SPDX-FileCopyrightText: 2025 The vita49-rs Authors
//
// SPDX-License-Identifier: MIT OR Apache-2.0
/*!
Defines fields and methods related to CIF2 (ANSI/VITA-49.2-2017 9.1).
Fields here are compatible with VITA 49.2 and later.
*/

use crate::command_prelude::*;
use crate::{ack_response::AckResponse, cif0::Cif0, cif7::Cif7Opts, Cif0AckFields};
use deku::prelude::*;
use vita49_macros::{ack_field, cif_basic, cif_field, cif_fields};

/// Base data structure for the CIF2 single-bit indicators
#[derive(
    Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, DekuRead, DekuWrite,
)]
#[deku(endian = "endian", ctx = "endian: deku::ctx::Endian")]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Cif2(u32);

impl Cif2 {
    cif_field!(bind, 31);
    cif_field!(cited_sid, 30);
    cif_field!(sibling_sid, 29);
    cif_field!(parent_sid, 28);
    cif_field!(child_sid, 27);
    cif_field!(cited_message_id, 26);
    cif_field!(controllee_id, 25);
    cif_field!(controllee_uuid, 24);
    cif_field!(controller_id, 23);
    cif_field!(controller_uuid, 22);
    cif_field!(info_source_id, 21);
    cif_field!(track_id, 20);
    cif_field!(country_code, 19);
    cif_field!(operator, 18);
    cif_field!(platform_class, 17);
    cif_field!(platform_instance, 16);
    cif_field!(platform_display, 15);
    cif_field!(ems_device_class, 14);
    cif_field!(ems_device_type, 13);
    cif_field!(ems_device_instance, 12);
    cif_field!(modulation_class, 11);
    cif_field!(modulation_type, 10);
    cif_field!(function_id, 9);
    cif_field!(mode_id, 8);
    cif_field!(event_id, 7);
    cif_field!(function_priority_id, 6);
    cif_field!(comms_priority_id, 5);
    cif_field!(rf_footprint, 4);
    cif_field!(rf_footprint_range, 3);
    // Bits 0-2 are reserved

    fn empty(&self) -> bool {
        self.0 == 0
    }
}

#[cif_fields(cif2)]
pub struct Cif2Fields {
    bind: u32,
    cited_sid: u32,
    sibling_sid: u32,
    parent_sid: u32,
    child_sid: u32,
    cited_message_id: u32,
    controllee_id: u32,
    controllee_uuid: u128,
    controller_id: u32,
    controller_uuid: u128,
    info_source_id: u32,
    track_id: u32,
    // TODO: add full support
    country_code: u32,
    operator: u32,
    platform_class: u32,
    platform_instance: u32,
    platform_display: u32,
    ems_device_class: u32,
    ems_device_type: u32,
    ems_device_instance: u32,
    modulation_class: u32,
    modulation_type: u32,
    function_id: u32,
    mode_id: u32,
    event_id: u32,
    function_priority_id: u32,
    comms_priority_id: u32,
    rf_footprint: u32,
    rf_footprint_range: u32,
}

#[cif_fields(cif2)]
pub struct Cif2AckFields {
    bind: AckResponse,
    cited_sid: AckResponse,
    sibling_sid: AckResponse,
    parent_sid: AckResponse,
    child_sid: AckResponse,
    cited_message_id: AckResponse,
    controllee_id: AckResponse,
    controllee_uuid: AckResponse,
    controller_id: AckResponse,
    controller_uuid: AckResponse,
    info_source_id: AckResponse,
    track_id: AckResponse,
    country_code: AckResponse,
    operator: AckResponse,
    platform_class: AckResponse,
    platform_instance: AckResponse,
    platform_display: AckResponse,
    ems_device_class: AckResponse,
    ems_device_type: AckResponse,
    ems_device_instance: AckResponse,
    modulation_class: AckResponse,
    modulation_type: AckResponse,
    function_id: AckResponse,
    mode_id: AckResponse,
    event_id: AckResponse,
    function_priority_id: AckResponse,
    comms_priority_id: AckResponse,
    rf_footprint: AckResponse,
    rf_footprint_range: AckResponse,
}

/// Trait for common CIF2 manipulation methods. Used by Context and
/// Command packets.
#[rustfmt::skip]
pub trait Cif2Manipulators {
    /// Get a reference to the packet's CIF0 (indicators)
    fn cif0(&self) -> &Cif0;
    /// Get a mutable reference to the packet's CIF0 (indicators)
    fn cif0_mut(&mut self) -> &mut Cif0;
    /// Get a reference to the packet's CIF2 (indicators)
    fn cif2(&self) -> Option<&Cif2>;
    /// Get a mutable reference to the packet's CIF2 (indicators)
    fn cif2_mut(&mut self) -> &mut Option<Cif2>;
    /// Get a reference to the packet's CIF2 data fields
    fn cif2_fields(&self) -> Option<&Cif2Fields>;
    /// Get a mutable reference to the packet's CIF2 data fields
    fn cif2_fields_mut(&mut self) -> &mut Option<Cif2Fields>;

    cif_basic!(cif2, bind, bind, u32);
    cif_basic!(cif2, cited_sid, cited_sid, u32);
    cif_basic!(cif2, sibling_sid, sibling_sid, u32);
    cif_basic!(cif2, parent_sid, parent_sid, u32);
    cif_basic!(cif2, child_sid, child_sid, u32);
    cif_basic!(cif2, cited_message_id, cited_message_id, u32);
    cif_basic!(cif2, controllee_id, controllee_id, u32);
    cif_basic!(cif2, controllee_uuid, controllee_uuid, u128);
    cif_basic!(cif2, controller_id, controller_id, u32);
    cif_basic!(cif2, controller_uuid, controller_uuid, u128);
    cif_basic!(cif2, info_source_id, info_source_id, u32);
    cif_basic!(cif2, track_id, track_id, u32);
    // TODO: add full support
    cif_basic!(cif2, country_code, country_code, u32);
    cif_basic!(cif2, operator, operator, u32);
    cif_basic!(cif2, platform_class, platform_class, u32);
    cif_basic!(cif2, platform_instance, platform_instance, u32);
    cif_basic!(cif2, platform_display, platform_display, u32);
    cif_basic!(cif2, ems_device_class, ems_device_class, u32);
    cif_basic!(cif2, ems_device_type, ems_device_type, u32);
    cif_basic!(cif2, ems_device_instance, ems_device_instance, u32);
    cif_basic!(cif2, modulation_class, modulation_class, u32);
    cif_basic!(cif2, modulation_type, modulation_type, u32);
    cif_basic!(cif2, function_id, function_id, u32);
    cif_basic!(cif2, mode_id, mode_id, u32);
    cif_basic!(cif2, event_id, event_id, u32);
    cif_basic!(cif2, function_priority_id, function_priority_id, u32);
    cif_basic!(cif2, comms_priority_id, comms_priority_id, u32);
    cif_basic!(cif2, rf_footprint, rf_footprint, u32);
    cif_basic!(cif2, rf_footprint_range, rf_footprint_range, u32);
}

/// Shared trait for manipulating CIF2 ACK fields.
pub trait Cif2AckManipulators {
    /// Get a reference to the packet's WIF0 (indicators)
    fn wif0(&self) -> Option<&Cif0>;
    /// Get a mutable reference to the packet's WIF0 (indicators)
    fn wif0_mut(&mut self) -> &mut Option<Cif0>;
    /// Get a reference to the packet's WIF0 data fields
    fn wif0_fields(&self) -> Option<&Cif0AckFields>;
    /// Get a mutable reference to the packet's WIF0 data fields
    fn wif0_fields_mut(&mut self) -> &mut Option<Cif0AckFields>;

    /// Get a reference to the packet's EIF0 (indicators)
    fn eif0(&self) -> Option<&Cif0>;
    /// Get a mutable reference to the packet's EIF0 (indicators)
    fn eif0_mut(&mut self) -> &mut Option<Cif0>;
    /// Get a reference to the packet's EIF0 data fields
    fn eif0_fields(&self) -> Option<&Cif0AckFields>;
    /// Get a mutable reference to the packet's EIF0 data fields
    fn eif0_fields_mut(&mut self) -> &mut Option<Cif0AckFields>;

    /// Get a reference to the packet's WIF2 (indicators)
    fn wif2(&self) -> Option<&Cif2>;
    /// Get a mutable reference to the packet's WIF2 (indicators)
    fn wif2_mut(&mut self) -> &mut Option<Cif2>;
    /// Get a reference to the packet's WIF2 data fields
    fn wif2_fields(&self) -> Option<&Cif2AckFields>;
    /// Get a mutable reference to the packet's WIF2 data fields
    fn wif2_fields_mut(&mut self) -> &mut Option<Cif2AckFields>;

    /// Get a reference to the packet's EIF2 (indicators)
    fn eif2(&self) -> Option<&Cif2>;
    /// Get a mutable reference to the packet's EIF2 (indicators)
    fn eif2_mut(&mut self) -> &mut Option<Cif2>;
    /// Get a reference to the packet's EIF2 data fields
    fn eif2_fields(&self) -> Option<&Cif2AckFields>;
    /// Get a mutable reference to the packet's EIF2 data fields
    fn eif2_fields_mut(&mut self) -> &mut Option<Cif2AckFields>;

    ack_field!(2, bind);
    ack_field!(2, cited_sid);
    ack_field!(2, sibling_sid);
    ack_field!(2, parent_sid);
    ack_field!(2, child_sid);
    ack_field!(2, cited_message_id);
    ack_field!(2, controllee_id);
    ack_field!(2, controllee_uuid);
    ack_field!(2, controller_id);
    ack_field!(2, controller_uuid);
    ack_field!(2, info_source_id);
    ack_field!(2, track_id);
    ack_field!(2, country_code);
    ack_field!(2, operator);
    ack_field!(2, platform_class);
    ack_field!(2, platform_instance);
    ack_field!(2, platform_display);
    ack_field!(2, ems_device_class);
    ack_field!(2, ems_device_type);
    ack_field!(2, ems_device_instance);
    ack_field!(2, modulation_class);
    ack_field!(2, modulation_type);
    ack_field!(2, function_id);
    ack_field!(2, mode_id);
    ack_field!(2, event_id);
    ack_field!(2, function_priority_id);
    ack_field!(2, comms_priority_id);
    ack_field!(2, rf_footprint);
    ack_field!(2, rf_footprint_range);
}

/// Enum to describe the various EMS device relationships.
/// See ANSI/VITA-49.2-2017 section 9.8.9 for details.
pub enum EmsOrganizationRelationship {
    /// Coalition device type.
    Coalition,
    /// Known device type.
    Known,
    /// Unknown device type.
    Unknown,
    /// Reserved field.
    Reserved,
}

impl Cif2Fields {
    /// Get the EMS device organization relationship.
    pub fn ems_device_class_org(&self) -> Option<EmsOrganizationRelationship> {
        self.ems_device_class
            .map(|ems_class| match (ems_class >> 14) & 0b11 {
                0b00 => EmsOrganizationRelationship::Coalition,
                0b01 => EmsOrganizationRelationship::Known,
                0b10 => EmsOrganizationRelationship::Unknown,
                0b11 => EmsOrganizationRelationship::Reserved,
                _ => unreachable!(),
            })
    }
    /// Returns true if the device is an exciter, false if not.
    pub fn ems_device_is_exciter(&self) -> Option<bool> {
        self.ems_device_class
            .map(|ems_class| (ems_class & (1 << 13)) > 0)
    }
    /// Returns true if the device is a receiver, false if not.
    pub fn ems_device_is_receiver(&self) -> Option<bool> {
        self.ems_device_class
            .map(|ems_class| (ems_class & (1 << 12)) > 0)
    }
}