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
//! Implementations of SpacePacket specific to PUS TM[1,2], TM[1,4], TM[1,8], TM[1,10].
//! These are the situations where return indicates fail without step_id field.
//! These builder functions returns error if it is not a valid CCSDS 133. 0-B-1 packet for TTM[1,2], TM[1,4], TM[1,8], TM[1,10].
//! See page 483 of ECSS-E-ST-70-41C.
use super::*;

impl SpacePacket<TmPacket<ServiceFail>> {
    /// Wrapper for "new" function specific to TM[1,2].
    pub fn new_service_1_2<T: Request>(
        request: &T,
        destination_id: u16,
        packet_name: u16,
        err_code: u8,
        err_data: Vec<u8>,
    ) -> Result<Self, Error> {
        SpacePacket::<TmPacket<ServiceFail>>::new(
            request,
            2,
            destination_id,
            packet_name,
            err_code,
            err_data,
        )
    }
    /// Wrapper for "new" function specific to TM[1,4].
    pub fn new_service_1_4<T: Request>(
        request: &T,
        destination_id: u16,
        packet_name: u16,
        err_code: u8,
        err_data: Vec<u8>,
    ) -> Result<Self, Error> {
        SpacePacket::<TmPacket<ServiceFail>>::new(
            request,
            4,
            destination_id,
            packet_name,
            err_code,
            err_data,
        )
    }
    /// Wrapper for "new" function specific to TM[1,8].
    /// TM[1,8] failed completion of execution verification report

    pub fn new_service_1_8<T: Request>(
        request: &T,
        destination_id: u16,
        packet_name: u16,
        err_code: u8,
        err_data: Vec<u8>,
    ) -> Result<Self, Error> {
        SpacePacket::<TmPacket<ServiceFail>>::new(
            request,
            8,
            destination_id,
            packet_name,
            err_code,
            err_data,
        )
    }
    /// Wrapper for "new" function specific to TM[1,10].
    pub fn new_service_1_10<T: Request>(
        request: &T,
        destination_id: u16,
        packet_name: u16,
        err_code: u8,
        err_data: Vec<u8>,
    ) -> Result<Self, Error> {
        SpacePacket::<TmPacket<ServiceFail>>::new(
            request,
            10,
            destination_id,
            packet_name,
            err_code,
            err_data,
        )
    }

    /// Creates a the packet data structures with the given parameters
    ///
    /// # Errors
    ///
    /// Returns error if Primary or Secondary Headers are invalid
    pub fn new<T: Request>(
        request: &T,
        message_subtype: u8,
        destination_id: u16,
        packet_name: u16,
        err_code: u8,
        err_data: Vec<u8>,
    ) -> Result<Self, Error> {
        let req_id = request.to_request();
        let data_len =
            TmPacketHeader::TM_HEADER_LEN + REQ_ID_LEN + err_data.len() + crate::sp::PEC_LEN;
        let data_len = data_len as u16;
        if message_subtype != 2
            && message_subtype != 4
            && message_subtype != 8
            && message_subtype != 10
        {
            return Err(Error::InvalidPacket);
        }
        // TODO: Implement this feature
        let packet_error_control = 0;
        let primary_header = PrimaryHeader::new(
            PrimaryHeader::VER_NO,
            false,
            true,
            req_id.apid,
            (true, true),
            packet_name,
            data_len,
        )?;
        let header = TmPacketHeader::new(SERVICE_TYPE, message_subtype, destination_id)?;
        Ok(SpacePacket::<TmPacket<ServiceFail>> {
            primary_header,
            data: TmPacket {
                header,
                user_data: TxUserData::<ServiceFail> {
                    packet_error_control,
                    data: ServiceFail {
                        request_id: req_id,
                        failure_notice: FailureNotice::new(err_code, err_data)?,
                    },
                },
            },
        })
    }
    /// Creates the struct from a byte array slice
    ///
    /// Errors
    ///
    /// if buffer.len() <  PH_LEN (6) +  TM_HEADER_LEN (9) + REQUEST_ID_LEN (4) + PEC_LEN(2)
    /// or if the byte array is not compliant to TM[1,2], TM[1,4], TM[1,8], TM[1,10].
    pub fn from_bytes(buffer: &[u8]) -> Result<Self, Error> {
        if buffer.len()
            < PrimaryHeader::PH_LEN
                + TmPacketHeader::TM_HEADER_LEN
                + REQ_ID_LEN
                + FAILURE_NOTICE_MIN_LEN
                + PEC_LEN
        {
            return Err(Error::InvalidPacket);
        }
        let primary_header = PrimaryHeader::from_bytes(&buffer[..PrimaryHeader::PH_LEN])?;
        // If the primary header is not defined properly, give an error accordingly.
        // It has to be have sec_header_flag set, version no to 0, and for TM type_flag should be clear.
        if !primary_header.sec_header_flag || primary_header.ver_no != 0 || primary_header.type_flag
        {
            return Err(Error::InvalidPacket);
        };
        let sec_header = TmPacketHeader::from_bytes(
            &buffer[PrimaryHeader::PH_LEN..PrimaryHeader::PH_LEN + TmPacketHeader::TM_HEADER_LEN],
        )?;
        // If service type or message subtype doesn't match
        if sec_header.service_type != SERVICE_TYPE
            || !(sec_header.message_subtype == 2
                || sec_header.message_subtype == 4
                || sec_header.message_subtype == 8
                || sec_header.message_subtype == 10)
        {
            return Err(Error::InvalidPacket);
        };
        let req_id_start = PrimaryHeader::PH_LEN + TmPacketHeader::TM_HEADER_LEN;
        let request_id = RequestId::from_bytes(&buffer[req_id_start..req_id_start + REQ_ID_LEN])?;
        let failure_notice_start = req_id_start + REQ_ID_LEN;
        if buffer[failure_notice_start] as usize > error::ERR_CODE_COUNT {
            return Err(Error::InvalidPacket);
        }
        let failure_notice_len = buffer.len() - PEC_LEN - failure_notice_start;
        let failure_notice = FailureNotice::from_bytes(
            &buffer[failure_notice_start..failure_notice_start + failure_notice_len],
        )?;
        let packet_error_control = BigEndian::read_u16(&buffer[(buffer.len() - PEC_LEN)..]);

        Ok(SpacePacket::<TmPacket<ServiceFail>> {
            primary_header,
            data: TmPacket {
                header: sec_header,
                user_data: TxUserData::<ServiceFail> {
                    packet_error_control,
                    data: ServiceFail {
                        request_id,
                        failure_notice,
                    },
                },
            },
        })
    }

    /// Encodes the object to a byte vector
    pub fn to_bytes(&self) -> Vec<u8> {
        let arr_len = PrimaryHeader::PH_LEN + 1 + self.primary_header.data_len as usize;
        let mut bytes = Vec::with_capacity(arr_len);
        bytes.extend(self.primary_header.to_bytes().to_vec());
        bytes.extend(self.data.header.to_bytes().to_vec());
        bytes.extend(self.data.user_data.data.request_id.to_bytes().to_vec());
        bytes.extend(self.data.user_data.data.failure_notice.to_byte().to_vec());
        // add the two bytes then modify them to the true value.
        bytes.push(0);
        bytes.push(0);
        let pec_start = arr_len - crate::sp::PEC_LEN;
        BigEndian::write_u16(
            &mut bytes[pec_start..],
            self.data.user_data.packet_error_control,
        );
        bytes
    }

    pub fn get_err(&self) -> (u8, Vec<u8>) {
        (
            self.data.user_data.data.failure_notice.err_code,
            self.data.user_data.data.failure_notice.err_data.to_vec(),
        )
    }
}