Compare commits
27 Commits
cb0ddb1338
...
v0.14.0
Author | SHA1 | Date | |
---|---|---|---|
de99bb926a | |||
167f53cac7
|
|||
172227b843 | |||
1bbca6866b
|
|||
b569208d45 | |||
d9709ffd6c
|
|||
243dc64a78 | |||
a6dc173f7f | |||
86dddbeef5
|
|||
17d112e838 | |||
9c8467ccfe
|
|||
217a8c2cc7 | |||
349e34bed6
|
|||
d6a76ca360 | |||
8f4351771b | |||
b08c3329f4 | |||
08e0d39154
|
|||
ab97607024 | |||
60d1f77844 | |||
5a112b7f39 | |||
e774dd69d4 | |||
a03d26a49c | |||
026173514f | |||
2d7ccc0909 | |||
05d3bac927
|
|||
d58df5fee2 | |||
9d23ac5b9b |
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@ -29,7 +29,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: dtolnay/rust-toolchain@1.81.0
|
- uses: dtolnay/rust-toolchain@1.70.0
|
||||||
- run: cargo check --release
|
- run: cargo check --release
|
||||||
|
|
||||||
cross-check:
|
cross-check:
|
||||||
|
36
CHANGELOG.md
36
CHANGELOG.md
@ -8,10 +8,40 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
|
|
||||||
# [unreleased]
|
# [unreleased]
|
||||||
|
|
||||||
|
# [v0.14.0] 2025-05-10
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- Moved CRC constants/implementations to dedicated `crc` module.
|
||||||
|
- `crc::CRC_CCITT_FALSE_NO_TABLE` and `crc::CRC_CCITT_FALSE_BIG_TABLE` variants.
|
||||||
|
- Renamed `PusPacket::crc16` to `PusPacket::opt_crc16`.
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- `WritablePusPacket::write_to_bytes_crc_no_table` and `WritablePusPacket::write_to_bytes_no_crc`
|
||||||
|
variants.
|
||||||
|
- `PusTmReader::new_crc_no_table` and `PusTcReader::new_crc_no_table` variants.
|
||||||
|
- `crc16` methods for PUS TM and PUS TC reader.
|
||||||
|
- PUS TM and PUS TC reader now return the reader instance directly instead of a tuple of the reader
|
||||||
|
and the read size. The instance `total_len` method can be used to retrieve the read lenght.
|
||||||
|
|
||||||
|
# [v0.13.1] 2025-03-21
|
||||||
|
|
||||||
|
- Bugfix due to operator precendence for `PusTcSecondaryHeader::pus_version`,
|
||||||
|
`PusTcSecondaryHeaderWithoutTimestamp::pus_version`, `CdsTime::from_bytes_with_u16_days` and
|
||||||
|
`CdsTime::from_bytes_with_u24_days`
|
||||||
|
|
||||||
|
# [v0.13.0] 2024-11-08
|
||||||
|
|
||||||
- Bumped MSRV to 1.81.0
|
- Bumped MSRV to 1.81.0
|
||||||
- Bump `zerocopy` to v0.8.0
|
- Bump `zerocopy` to v0.8.0
|
||||||
- Bump `thiserror` to v2.0.0
|
- Bump `thiserror` to v2.0.0
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- Migrated all Error implementations to thiserror, improved some naming and error handling in
|
||||||
|
general
|
||||||
|
|
||||||
# [v0.12.0] 2024-09-10
|
# [v0.12.0] 2024-09-10
|
||||||
|
|
||||||
- Bumped MSRV to 1.70.0
|
- Bumped MSRV to 1.70.0
|
||||||
@ -554,3 +584,9 @@ The timestamp of `PusTm` is now optional. See Added and Changed section for deta
|
|||||||
|
|
||||||
Initial release with CCSDS Space Packet Primary Header implementation and basic PUS TC and TM
|
Initial release with CCSDS Space Packet Primary Header implementation and basic PUS TC and TM
|
||||||
implementations.
|
implementations.
|
||||||
|
|
||||||
|
[unreleased]: https://egit.irs.uni-stuttgart.de/rust/spacepackets/compare/v0.14.0...HEAD
|
||||||
|
[v0.14.0]: https://egit.irs.uni-stuttgart.de/rust/spacepackets/compare/v0.13.1...v0.14.0
|
||||||
|
[v0.13.1]: https://egit.irs.uni-stuttgart.de/rust/spacepackets/compare/v0.13.0...v0.13.1
|
||||||
|
[v0.13.0]: https://egit.irs.uni-stuttgart.de/rust/spacepackets/compare/v0.12.0...v0.13.0
|
||||||
|
[v0.12.0]: https://egit.irs.uni-stuttgart.de/rust/spacepackets/compare/v0.11.2...v0.12.0
|
||||||
|
49
Cargo.toml
49
Cargo.toml
@ -1,8 +1,8 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "spacepackets"
|
name = "spacepackets"
|
||||||
version = "0.12.0"
|
version = "0.14.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.81.0"
|
rust-version = "1.70.0"
|
||||||
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
|
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
|
||||||
description = "Generic implementations for various CCSDS and ECSS packet standards"
|
description = "Generic implementations for various CCSDS and ECSS packet standards"
|
||||||
homepage = "https://egit.irs.uni-stuttgart.de/rust/spacepackets"
|
homepage = "https://egit.irs.uni-stuttgart.de/rust/spacepackets"
|
||||||
@ -13,45 +13,18 @@ categories = ["aerospace", "aerospace::space-protocols", "no-std", "hardware-sup
|
|||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
crc = "3"
|
crc = "3.3"
|
||||||
delegate = ">=0.8, <=0.13"
|
delegate = ">=0.8, <=0.13"
|
||||||
paste = "1"
|
paste = "1"
|
||||||
|
zerocopy = { version = "0.8", features = ["derive"] }
|
||||||
|
thiserror = { version = "2", default-features = false }
|
||||||
|
num_enum = { version = ">0.5, <=0.7", default-features = false }
|
||||||
|
num-traits = { version = "0.2", default-features = false }
|
||||||
|
serde = { version = "1", optional = true, default-features = false, features = ["derive"] }
|
||||||
|
|
||||||
[dependencies.zerocopy]
|
time = { version = "0.3", default-features = false, optional = true }
|
||||||
version = "0.8"
|
chrono = { version = "0.4", default-features = false, optional = true }
|
||||||
features = ["derive"]
|
defmt = { version = "1", default-features = false, optional = true }
|
||||||
|
|
||||||
[dependencies.thiserror]
|
|
||||||
version = "2"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[dependencies.num_enum]
|
|
||||||
version = ">0.5, <=0.7"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[dependencies.serde]
|
|
||||||
version = "1"
|
|
||||||
optional = true
|
|
||||||
default-features = false
|
|
||||||
features = ["derive"]
|
|
||||||
|
|
||||||
[dependencies.time]
|
|
||||||
version = "0.3"
|
|
||||||
default-features = false
|
|
||||||
optional = true
|
|
||||||
|
|
||||||
[dependencies.chrono]
|
|
||||||
version = "0.4"
|
|
||||||
default-features = false
|
|
||||||
optional = true
|
|
||||||
|
|
||||||
[dependencies.num-traits]
|
|
||||||
version = "0.2"
|
|
||||||
default-features = false
|
|
||||||
|
|
||||||
[dependencies.defmt]
|
|
||||||
version = "0.3"
|
|
||||||
optional = true
|
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = ["std"]
|
default = ["std"]
|
||||||
|
1
FUNDING.yml
Normal file
1
FUNDING.yml
Normal file
@ -0,0 +1 @@
|
|||||||
|
github: robamu
|
@ -1,7 +1,6 @@
|
|||||||
[](https://crates.io/crates/spacepackets)
|
[](https://crates.io/crates/spacepackets)
|
||||||
[](https://docs.rs/spacepackets)
|
[](https://docs.rs/spacepackets)
|
||||||
[](https://github.com/us-irs/spacepackets-rs/actions/workflows/ci.yml)
|
[](https://github.com/us-irs/spacepackets-rs/actions/workflows/ci.yml)
|
||||||
[](https://absatsw.irs.uni-stuttgart.de/projects/spacepackets/coverage-rs/latest/index.html)
|
|
||||||
|
|
||||||
ECSS and CCSDS Spacepackets
|
ECSS and CCSDS Spacepackets
|
||||||
======
|
======
|
||||||
|
@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
|
|||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
use std::string::String;
|
use std::string::String;
|
||||||
|
|
||||||
use super::TlvLvDataTooLarge;
|
use super::TlvLvDataTooLargeError;
|
||||||
|
|
||||||
pub const MIN_LV_LEN: usize = 1;
|
pub const MIN_LV_LEN: usize = 1;
|
||||||
|
|
||||||
@ -64,9 +64,9 @@ pub(crate) fn generic_len_check_deserialization(
|
|||||||
|
|
||||||
impl<'data> Lv<'data> {
|
impl<'data> Lv<'data> {
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn new(data: &[u8]) -> Result<Lv, TlvLvDataTooLarge> {
|
pub fn new(data: &[u8]) -> Result<Lv, TlvLvDataTooLargeError> {
|
||||||
if data.len() > u8::MAX as usize {
|
if data.len() > u8::MAX as usize {
|
||||||
return Err(TlvLvDataTooLarge(data.len()));
|
return Err(TlvLvDataTooLargeError(data.len()));
|
||||||
}
|
}
|
||||||
Ok(Lv {
|
Ok(Lv {
|
||||||
data,
|
data,
|
||||||
@ -86,7 +86,7 @@ impl<'data> Lv<'data> {
|
|||||||
/// Helper function to build a string LV. This is especially useful for the file or directory
|
/// Helper function to build a string LV. This is especially useful for the file or directory
|
||||||
/// path LVs
|
/// path LVs
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvDataTooLarge> {
|
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvDataTooLargeError> {
|
||||||
Self::new(str_slice.as_bytes())
|
Self::new(str_slice.as_bytes())
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -94,7 +94,7 @@ impl<'data> Lv<'data> {
|
|||||||
/// path LVs
|
/// path LVs
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvDataTooLarge> {
|
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvDataTooLargeError> {
|
||||||
Self::new(string.as_bytes())
|
Self::new(string.as_bytes())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,11 +1,8 @@
|
|||||||
//! Low-level CCSDS File Delivery Protocol (CFDP) support according to [CCSDS 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf).
|
//! Low-level CCSDS File Delivery Protocol (CFDP) support according to [CCSDS 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf).
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use core::fmt::{Display, Formatter};
|
|
||||||
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
#[cfg(feature = "std")]
|
|
||||||
use std::error::Error;
|
|
||||||
|
|
||||||
pub mod lv;
|
pub mod lv;
|
||||||
pub mod pdu;
|
pub mod pdu;
|
||||||
@ -176,97 +173,43 @@ impl Default for ChecksumType {
|
|||||||
|
|
||||||
pub const NULL_CHECKSUM_U32: [u8; 4] = [0; 4];
|
pub const NULL_CHECKSUM_U32: [u8; 4] = [0; 4];
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct TlvLvDataTooLarge(pub usize);
|
#[error("data with size {0} larger than allowed {max} bytes", max = u8::MAX)]
|
||||||
|
pub struct TlvLvDataTooLargeError(pub usize);
|
||||||
|
|
||||||
impl Display for TlvLvDataTooLarge {
|
/// First value: Found value. Second value: Expected value if there is one.
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
||||||
write!(
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
f,
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
"data with size {} larger than allowed {} bytes",
|
#[error("invalid TLV type field, found {found}, expected {expected:?}")]
|
||||||
self.0,
|
pub struct InvalidTlvTypeFieldError {
|
||||||
u8::MAX
|
found: u8,
|
||||||
)
|
expected: Option<u8>,
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
||||||
impl Error for TlvLvDataTooLarge {}
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum TlvLvError {
|
pub enum TlvLvError {
|
||||||
DataTooLarge(TlvLvDataTooLarge),
|
#[error("{0}")]
|
||||||
ByteConversion(ByteConversionError),
|
DataTooLarge(#[from] TlvLvDataTooLargeError),
|
||||||
/// First value: Found value. Second value: Expected value if there is one.
|
#[error("byte conversion error: {0}")]
|
||||||
InvalidTlvTypeField {
|
ByteConversion(#[from] ByteConversionError),
|
||||||
found: u8,
|
#[error("{0}")]
|
||||||
expected: Option<u8>,
|
InvalidTlvTypeField(#[from] InvalidTlvTypeFieldError),
|
||||||
},
|
#[error("invalid value length {0}")]
|
||||||
/// Logically invalid value length detected. The value length may not exceed 255 bytes.
|
|
||||||
/// Depending on the concrete TLV type, the value length may also be logically invalid.
|
|
||||||
InvalidValueLength(usize),
|
InvalidValueLength(usize),
|
||||||
/// Only applies to filestore requests and responses. Second name was missing where one is
|
/// Only applies to filestore requests and responses. Second name was missing where one is
|
||||||
/// expected.
|
/// expected.
|
||||||
|
#[error("second name missing for filestore request or response")]
|
||||||
SecondNameMissing,
|
SecondNameMissing,
|
||||||
/// Invalid action code for filestore requests or responses.
|
/// Invalid action code for filestore requests or responses.
|
||||||
|
#[error("invalid action code {0}")]
|
||||||
InvalidFilestoreActionCode(u8),
|
InvalidFilestoreActionCode(u8),
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<TlvLvDataTooLarge> for TlvLvError {
|
|
||||||
fn from(value: TlvLvDataTooLarge) -> Self {
|
|
||||||
Self::DataTooLarge(value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<ByteConversionError> for TlvLvError {
|
|
||||||
fn from(value: ByteConversionError) -> Self {
|
|
||||||
Self::ByteConversion(value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Display for TlvLvError {
|
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
|
||||||
match self {
|
|
||||||
TlvLvError::DataTooLarge(e) => {
|
|
||||||
write!(f, "{}", e)
|
|
||||||
}
|
|
||||||
TlvLvError::ByteConversion(e) => {
|
|
||||||
write!(f, "tlv or lv byte conversion: {}", e)
|
|
||||||
}
|
|
||||||
TlvLvError::InvalidTlvTypeField { found, expected } => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"invalid TLV type field, found {found}, expected {expected:?}"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
TlvLvError::InvalidValueLength(len) => {
|
|
||||||
write!(f, "invalid value length {len}")
|
|
||||||
}
|
|
||||||
TlvLvError::SecondNameMissing => {
|
|
||||||
write!(f, "second name missing for filestore request or response")
|
|
||||||
}
|
|
||||||
TlvLvError::InvalidFilestoreActionCode(raw) => {
|
|
||||||
write!(f, "invalid filestore action code with raw value {raw}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
impl Error for TlvLvError {
|
|
||||||
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
||||||
match self {
|
|
||||||
TlvLvError::DataTooLarge(e) => Some(e),
|
|
||||||
TlvLvError::ByteConversion(e) => Some(e),
|
|
||||||
_ => None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
@ -297,7 +297,7 @@ mod tests {
|
|||||||
buf[written - 1] -= 1;
|
buf[written - 1] -= 1;
|
||||||
let crc: u16 = ((buf[written - 2] as u16) << 8) as u16 | buf[written - 1] as u16;
|
let crc: u16 = ((buf[written - 2] as u16) << 8) as u16 | buf[written - 1] as u16;
|
||||||
let error = EofPdu::from_bytes(&buf).unwrap_err();
|
let error = EofPdu::from_bytes(&buf).unwrap_err();
|
||||||
if let PduError::ChecksumError(e) = error {
|
if let PduError::Checksum(e) = error {
|
||||||
assert_eq!(e, crc);
|
assert_eq!(e, crc);
|
||||||
} else {
|
} else {
|
||||||
panic!("expected crc error");
|
panic!("expected crc error");
|
||||||
|
@ -544,7 +544,7 @@ mod tests {
|
|||||||
buf[written - 1] -= 1;
|
buf[written - 1] -= 1;
|
||||||
let crc: u16 = ((buf[written - 2] as u16) << 8) | buf[written - 1] as u16;
|
let crc: u16 = ((buf[written - 2] as u16) << 8) | buf[written - 1] as u16;
|
||||||
let error = FileDataPdu::from_bytes(&buf).unwrap_err();
|
let error = FileDataPdu::from_bytes(&buf).unwrap_err();
|
||||||
if let PduError::ChecksumError(e) = error {
|
if let PduError::Checksum(e) = error {
|
||||||
assert_eq!(e, crc);
|
assert_eq!(e, crc);
|
||||||
} else {
|
} else {
|
||||||
panic!("expected crc error");
|
panic!("expected crc error");
|
||||||
@ -753,7 +753,7 @@ mod tests {
|
|||||||
assert!(pdu_reader_error.is_err());
|
assert!(pdu_reader_error.is_err());
|
||||||
let error = pdu_reader_error.unwrap_err();
|
let error = pdu_reader_error.unwrap_err();
|
||||||
match error {
|
match error {
|
||||||
PduError::ChecksumError(_) => (),
|
PduError::Checksum(_) => (),
|
||||||
_ => {
|
_ => {
|
||||||
panic!("unexpected PDU error {}", error)
|
panic!("unexpected PDU error {}", error)
|
||||||
}
|
}
|
||||||
|
@ -4,14 +4,14 @@ use crate::cfdp::pdu::{
|
|||||||
use crate::cfdp::tlv::{
|
use crate::cfdp::tlv::{
|
||||||
EntityIdTlv, FilestoreResponseTlv, GenericTlv, Tlv, TlvType, TlvTypeField, WritableTlv,
|
EntityIdTlv, FilestoreResponseTlv, GenericTlv, Tlv, TlvType, TlvTypeField, WritableTlv,
|
||||||
};
|
};
|
||||||
use crate::cfdp::{ConditionCode, CrcFlag, Direction, PduType, TlvLvError};
|
use crate::cfdp::{ConditionCode, CrcFlag, Direction, PduType};
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use super::tlv::ReadableTlv;
|
use super::tlv::ReadableTlv;
|
||||||
use super::{CfdpPdu, WritablePduPacket};
|
use super::{CfdpPdu, InvalidTlvTypeFieldError, WritablePduPacket};
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
@ -332,22 +332,26 @@ impl<'buf> FinishedPduReader<'buf> {
|
|||||||
// last TLV, everything else would break the whole handling of the packet
|
// last TLV, everything else would break the whole handling of the packet
|
||||||
// TLVs.
|
// TLVs.
|
||||||
if current_idx != full_len_without_crc {
|
if current_idx != full_len_without_crc {
|
||||||
return Err(PduError::FormatError);
|
return Err(PduError::Format);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(PduError::TlvLv(
|
||||||
found: tlv_type.into(),
|
InvalidTlvTypeFieldError {
|
||||||
expected: Some(TlvType::FilestoreResponse.into()),
|
found: tlv_type.into(),
|
||||||
}
|
expected: Some(TlvType::FilestoreResponse.into()),
|
||||||
.into());
|
}
|
||||||
|
.into(),
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
TlvTypeField::Custom(raw) => {
|
TlvTypeField::Custom(raw) => {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(PduError::TlvLv(
|
||||||
found: raw,
|
InvalidTlvTypeFieldError {
|
||||||
expected: None,
|
found: raw,
|
||||||
}
|
expected: None,
|
||||||
.into());
|
}
|
||||||
|
.into(),
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -564,7 +568,7 @@ mod tests {
|
|||||||
buf[written - 1] -= 1;
|
buf[written - 1] -= 1;
|
||||||
let crc: u16 = ((buf[written - 2] as u16) << 8) as u16 | buf[written - 1] as u16;
|
let crc: u16 = ((buf[written - 2] as u16) << 8) as u16 | buf[written - 1] as u16;
|
||||||
let error = FinishedPduReader::new(&buf).unwrap_err();
|
let error = FinishedPduReader::new(&buf).unwrap_err();
|
||||||
if let PduError::ChecksumError(e) = error {
|
if let PduError::Checksum(e) = error {
|
||||||
assert_eq!(e, crc);
|
assert_eq!(e, crc);
|
||||||
} else {
|
} else {
|
||||||
panic!("expected crc error");
|
panic!("expected crc error");
|
||||||
|
@ -720,7 +720,7 @@ pub mod tests {
|
|||||||
fn test_with_owned_opts() {
|
fn test_with_owned_opts() {
|
||||||
let tlv1 = TlvOwned::new_empty(TlvType::FlowLabel);
|
let tlv1 = TlvOwned::new_empty(TlvType::FlowLabel);
|
||||||
let msg_to_user: [u8; 4] = [1, 2, 3, 4];
|
let msg_to_user: [u8; 4] = [1, 2, 3, 4];
|
||||||
let tlv2 = TlvOwned::new(TlvType::MsgToUser, &msg_to_user).unwrap();
|
let tlv2 = TlvOwned::new(TlvType::MsgToUser, &msg_to_user);
|
||||||
let mut all_tlvs = tlv1.to_vec();
|
let mut all_tlvs = tlv1.to_vec();
|
||||||
all_tlvs.extend(tlv2.to_vec());
|
all_tlvs.extend(tlv2.to_vec());
|
||||||
let (src_filename, dest_filename, metadata_pdu) = generic_metadata_pdu(
|
let (src_filename, dest_filename, metadata_pdu) = generic_metadata_pdu(
|
||||||
@ -780,7 +780,7 @@ pub mod tests {
|
|||||||
assert_eq!(expected, Some(FileDirectiveType::MetadataPdu));
|
assert_eq!(expected, Some(FileDirectiveType::MetadataPdu));
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"invalid directive type value 255, expected Some(MetadataPdu)"
|
"invalid directive type, found 255, expected Some(MetadataPdu)"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
||||||
@ -806,7 +806,7 @@ pub mod tests {
|
|||||||
assert_eq!(expected, FileDirectiveType::MetadataPdu);
|
assert_eq!(expected, FileDirectiveType::MetadataPdu);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"found directive type EofPdu, expected MetadataPdu"
|
"wrong directive type, found EofPdu, expected MetadataPdu"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
||||||
|
@ -1,13 +1,10 @@
|
|||||||
//! CFDP Packet Data Unit (PDU) support.
|
//! CFDP Packet Data Unit (PDU) support.
|
||||||
use crate::cfdp::*;
|
use crate::cfdp::*;
|
||||||
|
use crate::crc::CRC_CCITT_FALSE;
|
||||||
use crate::util::{UnsignedByteField, UnsignedByteFieldU8, UnsignedEnum};
|
use crate::util::{UnsignedByteField, UnsignedByteFieldU8, UnsignedEnum};
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use crate::CRC_CCITT_FALSE;
|
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use alloc::vec::Vec;
|
use alloc::vec::Vec;
|
||||||
use core::fmt::{Display, Formatter};
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
use std::error::Error;
|
|
||||||
|
|
||||||
pub mod ack;
|
pub mod ack;
|
||||||
pub mod eof;
|
pub mod eof;
|
||||||
@ -30,137 +27,62 @@ pub enum FileDirectiveType {
|
|||||||
KeepAlivePdu = 0x0c,
|
KeepAlivePdu = 0x0c,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum PduError {
|
pub enum PduError {
|
||||||
ByteConversion(ByteConversionError),
|
#[error("byte conversion error: {0}")]
|
||||||
/// Found version ID invalid, not equal to [CFDP_VERSION_2].
|
ByteConversion(#[from] ByteConversionError),
|
||||||
|
/// Found version ID invalid, not equal to [super::CFDP_VERSION_2].
|
||||||
|
#[error("CFDP version missmatch, found {0}, expected {ver}", ver = super::CFDP_VERSION_2)]
|
||||||
CfdpVersionMissmatch(u8),
|
CfdpVersionMissmatch(u8),
|
||||||
/// Invalid length for the entity ID detected. Only the values 1, 2, 4 and 8 are supported.
|
/// Invalid length for the entity ID detected. Only the values 1, 2, 4 and 8 are supported.
|
||||||
|
#[error("invalid PDU entity ID length {0}, only [1, 2, 4, 8] are allowed")]
|
||||||
InvalidEntityLen(u8),
|
InvalidEntityLen(u8),
|
||||||
/// Invalid length for the entity ID detected. Only the values 1, 2, 4 and 8 are supported.
|
/// Invalid length for the entity ID detected. Only the values 1, 2, 4 and 8 are supported.
|
||||||
|
#[error("invalid transaction ID length {0}")]
|
||||||
InvalidTransactionSeqNumLen(u8),
|
InvalidTransactionSeqNumLen(u8),
|
||||||
|
#[error(
|
||||||
|
"missmatch of PDU source ID length {src_id_len} and destination ID length {dest_id_len}"
|
||||||
|
)]
|
||||||
SourceDestIdLenMissmatch {
|
SourceDestIdLenMissmatch {
|
||||||
src_id_len: usize,
|
src_id_len: usize,
|
||||||
dest_id_len: usize,
|
dest_id_len: usize,
|
||||||
},
|
},
|
||||||
/// Wrong directive type, for example when parsing the directive field for a file directive
|
/// Wrong directive type, for example when parsing the directive field for a file directive
|
||||||
/// PDU.
|
/// PDU.
|
||||||
|
#[error("wrong directive type, found {found:?}, expected {expected:?}")]
|
||||||
WrongDirectiveType {
|
WrongDirectiveType {
|
||||||
found: FileDirectiveType,
|
found: FileDirectiveType,
|
||||||
expected: FileDirectiveType,
|
expected: FileDirectiveType,
|
||||||
},
|
},
|
||||||
/// The directive type field contained a value not in the range of permitted values. This can
|
/// The directive type field contained a value not in the range of permitted values. This can
|
||||||
/// also happen if an invalid value is passed to the ACK PDU constructor.
|
/// also happen if an invalid value is passed to the ACK PDU constructor.
|
||||||
|
#[error("invalid directive type, found {found:?}, expected {expected:?}")]
|
||||||
InvalidDirectiveType {
|
InvalidDirectiveType {
|
||||||
found: u8,
|
found: u8,
|
||||||
expected: Option<FileDirectiveType>,
|
expected: Option<FileDirectiveType>,
|
||||||
},
|
},
|
||||||
|
#[error("invalid start or end of scope value for NAK PDU")]
|
||||||
InvalidStartOrEndOfScopeValue,
|
InvalidStartOrEndOfScopeValue,
|
||||||
/// Invalid condition code. Contains the raw detected value.
|
/// Invalid condition code. Contains the raw detected value.
|
||||||
|
#[error("invalid condition code {0}")]
|
||||||
InvalidConditionCode(u8),
|
InvalidConditionCode(u8),
|
||||||
/// Invalid checksum type which is not part of the checksums listed in the
|
/// Invalid checksum type which is not part of the checksums listed in the
|
||||||
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/).
|
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/).
|
||||||
|
#[error("invalid checksum type {0}")]
|
||||||
InvalidChecksumType(u8),
|
InvalidChecksumType(u8),
|
||||||
|
#[error("file size {0} too large")]
|
||||||
FileSizeTooLarge(u64),
|
FileSizeTooLarge(u64),
|
||||||
/// If the CRC flag for a PDU is enabled and the checksum check fails. Contains raw 16-bit CRC.
|
/// If the CRC flag for a PDU is enabled and the checksum check fails. Contains raw 16-bit CRC.
|
||||||
ChecksumError(u16),
|
#[error("checksum error for checksum {0}")]
|
||||||
|
Checksum(u16),
|
||||||
/// Generic error for invalid PDU formats.
|
/// Generic error for invalid PDU formats.
|
||||||
FormatError,
|
#[error("generic PDU format error")]
|
||||||
|
Format,
|
||||||
/// Error handling a TLV field.
|
/// Error handling a TLV field.
|
||||||
TlvLvError(TlvLvError),
|
#[error("PDU error: {0}")]
|
||||||
}
|
TlvLv(#[from] TlvLvError),
|
||||||
|
|
||||||
impl Display for PduError {
|
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
|
||||||
match self {
|
|
||||||
PduError::InvalidEntityLen(raw_id) => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"invalid PDU entity ID length {raw_id}, only [1, 2, 4, 8] are allowed"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
PduError::InvalidStartOrEndOfScopeValue => {
|
|
||||||
write!(f, "invalid start or end of scope for NAK PDU")
|
|
||||||
}
|
|
||||||
PduError::InvalidTransactionSeqNumLen(raw_id) => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"invalid PDUtransaction seq num length {raw_id}, only [1, 2, 4, 8] are allowed"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
PduError::CfdpVersionMissmatch(raw) => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"cfdp version missmatch, found {raw}, expected {CFDP_VERSION_2}"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
PduError::SourceDestIdLenMissmatch {
|
|
||||||
src_id_len,
|
|
||||||
dest_id_len,
|
|
||||||
} => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"missmatch of PDU source length {src_id_len} and destination length {dest_id_len}"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
PduError::ByteConversion(e) => {
|
|
||||||
write!(f, "{}", e)
|
|
||||||
}
|
|
||||||
PduError::FileSizeTooLarge(value) => {
|
|
||||||
write!(f, "file size value {value} exceeds allowed 32 bit width")
|
|
||||||
}
|
|
||||||
PduError::WrongDirectiveType { found, expected } => {
|
|
||||||
write!(f, "found directive type {found:?}, expected {expected:?}")
|
|
||||||
}
|
|
||||||
PduError::InvalidConditionCode(raw_code) => {
|
|
||||||
write!(f, "found invalid condition code with raw value {raw_code}")
|
|
||||||
}
|
|
||||||
PduError::InvalidDirectiveType { found, expected } => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"invalid directive type value {found}, expected {expected:?}"
|
|
||||||
)
|
|
||||||
}
|
|
||||||
PduError::InvalidChecksumType(checksum_type) => {
|
|
||||||
write!(f, "invalid checksum type {checksum_type}")
|
|
||||||
}
|
|
||||||
PduError::ChecksumError(checksum) => {
|
|
||||||
write!(f, "checksum error for CRC {checksum:#04x}")
|
|
||||||
}
|
|
||||||
PduError::TlvLvError(error) => {
|
|
||||||
write!(f, "pdu tlv error: {error}")
|
|
||||||
}
|
|
||||||
PduError::FormatError => {
|
|
||||||
write!(f, "generic PDU format error")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
impl Error for PduError {
|
|
||||||
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
||||||
match self {
|
|
||||||
PduError::ByteConversion(e) => Some(e),
|
|
||||||
PduError::TlvLvError(e) => Some(e),
|
|
||||||
_ => None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<ByteConversionError> for PduError {
|
|
||||||
#[inline]
|
|
||||||
fn from(value: ByteConversionError) -> Self {
|
|
||||||
Self::ByteConversion(value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<TlvLvError> for PduError {
|
|
||||||
#[inline]
|
|
||||||
fn from(e: TlvLvError) -> Self {
|
|
||||||
Self::TlvLvError(e)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait WritablePduPacket {
|
pub trait WritablePduPacket {
|
||||||
@ -532,7 +454,7 @@ impl PduHeader {
|
|||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
digest.update(&buf[..self.pdu_len()]);
|
digest.update(&buf[..self.pdu_len()]);
|
||||||
if digest.finalize() != 0 {
|
if digest.finalize() != 0 {
|
||||||
return Err(PduError::ChecksumError(u16::from_be_bytes(
|
return Err(PduError::Checksum(u16::from_be_bytes(
|
||||||
buf[self.pdu_len() - 2..self.pdu_len()].try_into().unwrap(),
|
buf[self.pdu_len() - 2..self.pdu_len()].try_into().unwrap(),
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
@ -981,7 +903,7 @@ mod tests {
|
|||||||
assert_eq!(raw_version, CFDP_VERSION_2 + 1);
|
assert_eq!(raw_version, CFDP_VERSION_2 + 1);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"cfdp version missmatch, found 2, expected 1"
|
"CFDP version missmatch, found 2, expected 1"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("invalid exception: {}", error);
|
panic!("invalid exception: {}", error);
|
||||||
@ -1029,7 +951,7 @@ mod tests {
|
|||||||
assert_eq!(expected, 7);
|
assert_eq!(expected, 7);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"source slice with size 6 too small, expected at least 7 bytes"
|
"byte conversion error: source slice with size 6 too small, expected at least 7 bytes"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -1084,7 +1006,7 @@ mod tests {
|
|||||||
assert_eq!(dest_id_len, 2);
|
assert_eq!(dest_id_len, 2);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"missmatch of PDU source length 1 and destination length 2"
|
"missmatch of PDU source ID length 1 and destination ID length 2"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -61,7 +61,7 @@ impl<'seg_reqs> NakPduCreator<'seg_reqs> {
|
|||||||
start_of_scope: u32,
|
start_of_scope: u32,
|
||||||
end_of_scope: u32,
|
end_of_scope: u32,
|
||||||
segment_requests: &'seg_reqs [(u32, u32)],
|
segment_requests: &'seg_reqs [(u32, u32)],
|
||||||
) -> Result<NakPduCreator, PduError> {
|
) -> Result<NakPduCreator<'seg_reqs>, PduError> {
|
||||||
let mut passed_segment_requests = None;
|
let mut passed_segment_requests = None;
|
||||||
if !segment_requests.is_empty() {
|
if !segment_requests.is_empty() {
|
||||||
passed_segment_requests = Some(SegmentRequests::U32Pairs(segment_requests));
|
passed_segment_requests = Some(SegmentRequests::U32Pairs(segment_requests));
|
||||||
@ -79,7 +79,7 @@ impl<'seg_reqs> NakPduCreator<'seg_reqs> {
|
|||||||
start_of_scope: u64,
|
start_of_scope: u64,
|
||||||
end_of_scope: u64,
|
end_of_scope: u64,
|
||||||
segment_requests: &'seg_reqs [(u64, u64)],
|
segment_requests: &'seg_reqs [(u64, u64)],
|
||||||
) -> Result<NakPduCreator, PduError> {
|
) -> Result<NakPduCreator<'seg_reqs>, PduError> {
|
||||||
let mut passed_segment_requests = None;
|
let mut passed_segment_requests = None;
|
||||||
if !segment_requests.is_empty() {
|
if !segment_requests.is_empty() {
|
||||||
passed_segment_requests = Some(SegmentRequests::U64Pairs(segment_requests));
|
passed_segment_requests = Some(SegmentRequests::U64Pairs(segment_requests));
|
||||||
@ -97,7 +97,7 @@ impl<'seg_reqs> NakPduCreator<'seg_reqs> {
|
|||||||
start_of_scope: u64,
|
start_of_scope: u64,
|
||||||
end_of_scope: u64,
|
end_of_scope: u64,
|
||||||
segment_requests: Option<SegmentRequests<'seg_reqs>>,
|
segment_requests: Option<SegmentRequests<'seg_reqs>>,
|
||||||
) -> Result<NakPduCreator, PduError> {
|
) -> Result<NakPduCreator<'seg_reqs>, PduError> {
|
||||||
// Force correct direction flag.
|
// Force correct direction flag.
|
||||||
pdu_header.pdu_conf.direction = Direction::TowardsSender;
|
pdu_header.pdu_conf.direction = Direction::TowardsSender;
|
||||||
if let Some(ref segment_requests) = segment_requests {
|
if let Some(ref segment_requests) = segment_requests {
|
||||||
@ -269,7 +269,7 @@ impl SegReqFromBytes for u64 {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, T> Iterator for SegmentRequestIter<'a, T>
|
impl<T> Iterator for SegmentRequestIter<'_, T>
|
||||||
where
|
where
|
||||||
T: SegReqFromBytes,
|
T: SegReqFromBytes,
|
||||||
{
|
{
|
||||||
@ -282,8 +282,8 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, 'b> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'b, u32> {
|
impl<'a> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'_, u32> {
|
||||||
fn eq(&self, other: &SegmentRequests) -> bool {
|
fn eq(&self, other: &SegmentRequests<'a>) -> bool {
|
||||||
match other {
|
match other {
|
||||||
SegmentRequests::U32Pairs(pairs) => self.compare_pairs(pairs),
|
SegmentRequests::U32Pairs(pairs) => self.compare_pairs(pairs),
|
||||||
SegmentRequests::U64Pairs(pairs) => {
|
SegmentRequests::U64Pairs(pairs) => {
|
||||||
@ -296,8 +296,8 @@ impl<'a, 'b> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'b, u32> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, 'b> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'b, u64> {
|
impl<'a> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'_, u64> {
|
||||||
fn eq(&self, other: &SegmentRequests) -> bool {
|
fn eq(&self, other: &SegmentRequests<'a>) -> bool {
|
||||||
match other {
|
match other {
|
||||||
SegmentRequests::U32Pairs(pairs) => {
|
SegmentRequests::U32Pairs(pairs) => {
|
||||||
if pairs.is_empty() && self.seq_req_raw.is_empty() {
|
if pairs.is_empty() && self.seq_req_raw.is_empty() {
|
||||||
@ -310,7 +310,7 @@ impl<'a, 'b> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'b, u64> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, T> SegmentRequestIter<'a, T>
|
impl<T> SegmentRequestIter<'_, T>
|
||||||
where
|
where
|
||||||
T: SegReqFromBytes + PartialEq,
|
T: SegReqFromBytes + PartialEq,
|
||||||
{
|
{
|
||||||
@ -374,11 +374,11 @@ impl CfdpPdu for NakPduReader<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<'seg_reqs> NakPduReader<'seg_reqs> {
|
impl<'seg_reqs> NakPduReader<'seg_reqs> {
|
||||||
pub fn new(buf: &'seg_reqs [u8]) -> Result<NakPduReader, PduError> {
|
pub fn new(buf: &'seg_reqs [u8]) -> Result<NakPduReader<'seg_reqs>, PduError> {
|
||||||
Self::from_bytes(buf)
|
Self::from_bytes(buf)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn from_bytes(buf: &'seg_reqs [u8]) -> Result<NakPduReader, PduError> {
|
pub fn from_bytes(buf: &'seg_reqs [u8]) -> Result<NakPduReader<'seg_reqs>, PduError> {
|
||||||
let (pdu_header, mut current_idx) = PduHeader::from_bytes(buf)?;
|
let (pdu_header, mut current_idx) = PduHeader::from_bytes(buf)?;
|
||||||
let full_len_without_crc = pdu_header.verify_length_and_checksum(buf)?;
|
let full_len_without_crc = pdu_header.verify_length_and_checksum(buf)?;
|
||||||
// Minimum length of 9: 1 byte directive field and start and end of scope for normal file
|
// Minimum length of 9: 1 byte directive field and start and end of scope for normal file
|
||||||
@ -474,7 +474,7 @@ impl<'seg_reqs> NakPduReader<'seg_reqs> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, 'b> PartialEq<NakPduCreator<'a>> for NakPduReader<'b> {
|
impl<'a> PartialEq<NakPduCreator<'a>> for NakPduReader<'_> {
|
||||||
fn eq(&self, other: &NakPduCreator<'a>) -> bool {
|
fn eq(&self, other: &NakPduCreator<'a>) -> bool {
|
||||||
if self.pdu_header() != other.pdu_header()
|
if self.pdu_header() != other.pdu_header()
|
||||||
|| self.end_of_scope() != other.end_of_scope()
|
|| self.end_of_scope() != other.end_of_scope()
|
||||||
@ -751,7 +751,7 @@ mod tests {
|
|||||||
if let PduError::InvalidStartOrEndOfScopeValue = error {
|
if let PduError::InvalidStartOrEndOfScopeValue = error {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"invalid start or end of scope for NAK PDU"
|
"invalid start or end of scope value for NAK PDU"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("unexpected error {error}");
|
panic!("unexpected error {error}");
|
||||||
@ -796,7 +796,7 @@ mod tests {
|
|||||||
nak_vec[nak_pdu.len_written() - 1] -= 1;
|
nak_vec[nak_pdu.len_written() - 1] -= 1;
|
||||||
let nak_pdu_deser = NakPduReader::new(&nak_vec);
|
let nak_pdu_deser = NakPduReader::new(&nak_vec);
|
||||||
assert!(nak_pdu_deser.is_err());
|
assert!(nak_pdu_deser.is_err());
|
||||||
if let Err(PduError::ChecksumError(raw)) = nak_pdu_deser {
|
if let Err(PduError::Checksum(raw)) = nak_pdu_deser {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
raw,
|
raw,
|
||||||
u16::from_be_bytes(nak_vec[nak_pdu.len_written() - 2..].try_into().unwrap())
|
u16::from_be_bytes(nak_vec[nak_pdu.len_written() - 2..].try_into().unwrap())
|
||||||
|
@ -15,7 +15,7 @@ use num_enum::{IntoPrimitive, TryFromPrimitive};
|
|||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use super::TlvLvDataTooLarge;
|
use super::{InvalidTlvTypeFieldError, TlvLvDataTooLargeError};
|
||||||
|
|
||||||
pub mod msg_to_user;
|
pub mod msg_to_user;
|
||||||
|
|
||||||
@ -153,14 +153,14 @@ pub struct Tlv<'data> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<'data> Tlv<'data> {
|
impl<'data> Tlv<'data> {
|
||||||
pub fn new(tlv_type: TlvType, data: &[u8]) -> Result<Tlv, TlvLvDataTooLarge> {
|
pub fn new(tlv_type: TlvType, data: &[u8]) -> Result<Tlv, TlvLvDataTooLargeError> {
|
||||||
Ok(Tlv {
|
Ok(Tlv {
|
||||||
tlv_type_field: TlvTypeField::Standard(tlv_type),
|
tlv_type_field: TlvTypeField::Standard(tlv_type),
|
||||||
lv: Lv::new(data)?,
|
lv: Lv::new(data)?,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new_with_custom_type(tlv_type: u8, data: &[u8]) -> Result<Tlv, TlvLvDataTooLarge> {
|
pub fn new_with_custom_type(tlv_type: u8, data: &[u8]) -> Result<Tlv, TlvLvDataTooLargeError> {
|
||||||
Ok(Tlv {
|
Ok(Tlv {
|
||||||
tlv_type_field: TlvTypeField::Custom(tlv_type),
|
tlv_type_field: TlvTypeField::Custom(tlv_type),
|
||||||
lv: Lv::new(data)?,
|
lv: Lv::new(data)?,
|
||||||
@ -179,7 +179,7 @@ impl<'data> Tlv<'data> {
|
|||||||
/// bytestream with the exact size of the expected TLV. This function will take care
|
/// bytestream with the exact size of the expected TLV. This function will take care
|
||||||
/// of parsing the length byte, and the length of the parsed TLV can be retrieved using
|
/// of parsing the length byte, and the length of the parsed TLV can be retrieved using
|
||||||
/// [Self::len_full].
|
/// [Self::len_full].
|
||||||
pub fn from_bytes(buf: &'data [u8]) -> Result<Tlv<'data>, TlvLvError> {
|
pub fn from_bytes(buf: &'data [u8]) -> Result<Tlv<'data>, ByteConversionError> {
|
||||||
generic_len_check_deserialization(buf, MIN_TLV_LEN)?;
|
generic_len_check_deserialization(buf, MIN_TLV_LEN)?;
|
||||||
let mut tlv = Self {
|
let mut tlv = Self {
|
||||||
tlv_type_field: TlvTypeField::from(buf[0]),
|
tlv_type_field: TlvTypeField::from(buf[0]),
|
||||||
@ -239,8 +239,6 @@ impl GenericTlv for Tlv<'_> {
|
|||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
pub mod alloc_mod {
|
pub mod alloc_mod {
|
||||||
use crate::cfdp::TlvLvDataTooLarge;
|
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
/// Owned variant of [Tlv] which is consequently [Clone]able and does not have a lifetime
|
/// Owned variant of [Tlv] which is consequently [Clone]able and does not have a lifetime
|
||||||
@ -254,24 +252,18 @@ pub mod alloc_mod {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl TlvOwned {
|
impl TlvOwned {
|
||||||
pub fn new(tlv_type: TlvType, data: &[u8]) -> Result<Self, TlvLvDataTooLarge> {
|
pub fn new(tlv_type: TlvType, data: &[u8]) -> Self {
|
||||||
if data.len() > u8::MAX as usize {
|
Self {
|
||||||
return Err(TlvLvDataTooLarge(data.len()));
|
|
||||||
}
|
|
||||||
Ok(Self {
|
|
||||||
tlv_type_field: TlvTypeField::Standard(tlv_type),
|
tlv_type_field: TlvTypeField::Standard(tlv_type),
|
||||||
data: data.to_vec(),
|
data: data.to_vec(),
|
||||||
})
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new_with_custom_type(tlv_type: u8, data: &[u8]) -> Result<Self, TlvLvDataTooLarge> {
|
pub fn new_with_custom_type(tlv_type: u8, data: &[u8]) -> Self {
|
||||||
if data.len() > u8::MAX as usize {
|
Self {
|
||||||
return Err(TlvLvDataTooLarge(data.len()));
|
|
||||||
}
|
|
||||||
Ok(Self {
|
|
||||||
tlv_type_field: TlvTypeField::Custom(tlv_type),
|
tlv_type_field: TlvTypeField::Custom(tlv_type),
|
||||||
data: data.to_vec(),
|
data: data.to_vec(),
|
||||||
})
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Creates a TLV with an empty value field.
|
/// Creates a TLV with an empty value field.
|
||||||
@ -343,7 +335,7 @@ impl EntityIdTlv {
|
|||||||
Self { entity_id }
|
Self { entity_id }
|
||||||
}
|
}
|
||||||
|
|
||||||
fn check_min_len(buf: &[u8]) -> Result<(), ByteConversionError> {
|
fn len_check(buf: &[u8]) -> Result<(), ByteConversionError> {
|
||||||
if buf.len() < 2 {
|
if buf.len() < 2 {
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
return Err(ByteConversionError::ToSliceTooSmall {
|
||||||
found: buf.len(),
|
found: buf.len(),
|
||||||
@ -366,7 +358,7 @@ impl EntityIdTlv {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn from_bytes(buf: &[u8]) -> Result<Self, TlvLvError> {
|
pub fn from_bytes(buf: &[u8]) -> Result<Self, TlvLvError> {
|
||||||
Self::check_min_len(buf)?;
|
Self::len_check(buf)?;
|
||||||
verify_tlv_type(buf[0], TlvType::EntityId)?;
|
verify_tlv_type(buf[0], TlvType::EntityId)?;
|
||||||
let len = buf[1];
|
let len = buf[1];
|
||||||
if len != 1 && len != 2 && len != 4 && len != 8 {
|
if len != 1 && len != 2 && len != 4 && len != 8 {
|
||||||
@ -377,31 +369,19 @@ impl EntityIdTlv {
|
|||||||
Ok(Self { entity_id })
|
Ok(Self { entity_id })
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Convert to a generic [Tlv], which also erases the type information.
|
/// Convert to a generic [Tlv], which also erases the programmatic type information.
|
||||||
pub fn to_tlv(self, buf: &mut [u8]) -> Result<Tlv, ByteConversionError> {
|
pub fn to_tlv(self, buf: &mut [u8]) -> Result<Tlv, ByteConversionError> {
|
||||||
Self::check_min_len(buf)?;
|
Self::len_check(buf)?;
|
||||||
self.entity_id
|
self.entity_id
|
||||||
.write_to_be_bytes(&mut buf[2..2 + self.entity_id.size()])?;
|
.write_to_be_bytes(&mut buf[2..2 + self.entity_id.size()])?;
|
||||||
if buf.len() < self.len_value() {
|
// Can't fail.
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: self.len_value(),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
// We performed all checks necessary to ensure this call never panics.
|
|
||||||
Ok(Tlv::new(TlvType::EntityId, &buf[2..2 + self.entity_id.size()]).unwrap())
|
Ok(Tlv::new(TlvType::EntityId, &buf[2..2 + self.entity_id.size()]).unwrap())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn to_owned(&self) -> TlvOwned {
|
|
||||||
// Unwrap is okay here, entity ID should never be larger than maximum allowed size.
|
|
||||||
TlvOwned::new(TlvType::EntityId, &self.entity_id.to_vec()).unwrap()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritableTlv for EntityIdTlv {
|
impl WritableTlv for EntityIdTlv {
|
||||||
fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
||||||
Self::check_min_len(buf)?;
|
Self::len_check(buf)?;
|
||||||
buf[0] = TlvType::EntityId as u8;
|
buf[0] = TlvType::EntityId as u8;
|
||||||
buf[1] = self.entity_id.size() as u8;
|
buf[1] = self.entity_id.size() as u8;
|
||||||
Ok(2 + self.entity_id.write_to_be_bytes(&mut buf[2..])?)
|
Ok(2 + self.entity_id.write_to_be_bytes(&mut buf[2..])?)
|
||||||
@ -418,24 +398,26 @@ impl GenericTlv for EntityIdTlv {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'data> TryFrom<Tlv<'data>> for EntityIdTlv {
|
impl TryFrom<Tlv<'_>> for EntityIdTlv {
|
||||||
type Error = TlvLvError;
|
type Error = TlvLvError;
|
||||||
|
|
||||||
fn try_from(value: Tlv) -> Result<Self, Self::Error> {
|
fn try_from(value: Tlv) -> Result<Self, TlvLvError> {
|
||||||
match value.tlv_type_field {
|
match value.tlv_type_field {
|
||||||
TlvTypeField::Standard(tlv_type) => {
|
TlvTypeField::Standard(tlv_type) => {
|
||||||
if tlv_type != TlvType::EntityId {
|
if tlv_type != TlvType::EntityId {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(InvalidTlvTypeFieldError {
|
||||||
found: tlv_type as u8,
|
found: tlv_type as u8,
|
||||||
expected: Some(TlvType::EntityId as u8),
|
expected: Some(TlvType::EntityId as u8),
|
||||||
});
|
}
|
||||||
|
.into());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
TlvTypeField::Custom(val) => {
|
TlvTypeField::Custom(val) => {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(InvalidTlvTypeFieldError {
|
||||||
found: val,
|
found: val,
|
||||||
expected: Some(TlvType::EntityId as u8),
|
expected: Some(TlvType::EntityId as u8),
|
||||||
});
|
}
|
||||||
|
.into());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let len_value = value.value().len();
|
let len_value = value.value().len();
|
||||||
@ -640,12 +622,6 @@ impl<'first_name, 'second_name> FilestoreRequestTlv<'first_name, 'second_name> {
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn to_owned(&self) -> TlvOwned {
|
|
||||||
// The API should ensure the data field is never too large, so unwrapping here is okay.
|
|
||||||
TlvOwned::new(TlvType::FilestoreRequest, &self.to_vec()[2..]).unwrap()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritableTlv for FilestoreRequestTlv<'_, '_> {
|
impl WritableTlv for FilestoreRequestTlv<'_, '_> {
|
||||||
@ -831,12 +807,6 @@ impl<'first_name, 'second_name, 'fs_msg> FilestoreResponseTlv<'first_name, 'seco
|
|||||||
filestore_message,
|
filestore_message,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn to_owned(&self) -> TlvOwned {
|
|
||||||
// The API should ensure the data field is never too large, so unwrap is okay here.
|
|
||||||
TlvOwned::new(TlvType::FilestoreResponse, &self.to_vec()[2..]).unwrap()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritableTlv for FilestoreResponseTlv<'_, '_, '_> {
|
impl WritableTlv for FilestoreResponseTlv<'_, '_, '_> {
|
||||||
@ -878,13 +848,16 @@ impl GenericTlv for FilestoreResponseTlv<'_, '_, '_> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn verify_tlv_type(raw_type: u8, expected_tlv_type: TlvType) -> Result<(), TlvLvError> {
|
pub(crate) fn verify_tlv_type(
|
||||||
let tlv_type = TlvType::try_from(raw_type).map_err(|_| TlvLvError::InvalidTlvTypeField {
|
raw_type: u8,
|
||||||
|
expected_tlv_type: TlvType,
|
||||||
|
) -> Result<(), InvalidTlvTypeFieldError> {
|
||||||
|
let tlv_type = TlvType::try_from(raw_type).map_err(|_| InvalidTlvTypeFieldError {
|
||||||
found: raw_type,
|
found: raw_type,
|
||||||
expected: Some(expected_tlv_type.into()),
|
expected: Some(expected_tlv_type.into()),
|
||||||
})?;
|
})?;
|
||||||
if tlv_type != expected_tlv_type {
|
if tlv_type != expected_tlv_type {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(InvalidTlvTypeFieldError {
|
||||||
found: tlv_type as u8,
|
found: tlv_type as u8,
|
||||||
expected: Some(expected_tlv_type as u8),
|
expected: Some(expected_tlv_type as u8),
|
||||||
});
|
});
|
||||||
@ -1079,11 +1052,15 @@ mod tests {
|
|||||||
let tlv_res = Tlv::new(TlvType::MsgToUser, &buf_too_large);
|
let tlv_res = Tlv::new(TlvType::MsgToUser, &buf_too_large);
|
||||||
assert!(tlv_res.is_err());
|
assert!(tlv_res.is_err());
|
||||||
let error = tlv_res.unwrap_err();
|
let error = tlv_res.unwrap_err();
|
||||||
assert_eq!(error.0, u8::MAX as usize + 1);
|
match error {
|
||||||
assert_eq!(
|
TlvLvDataTooLargeError(size) => {
|
||||||
error.to_string(),
|
assert_eq!(size, u8::MAX as usize + 1);
|
||||||
"data with size 256 larger than allowed 255 bytes"
|
assert_eq!(
|
||||||
);
|
error.to_string(),
|
||||||
|
"data with size 256 larger than allowed 255 bytes"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -1392,7 +1369,8 @@ mod tests {
|
|||||||
let error = EntityIdTlv::try_from(msg_to_user_tlv);
|
let error = EntityIdTlv::try_from(msg_to_user_tlv);
|
||||||
assert!(error.is_err());
|
assert!(error.is_err());
|
||||||
let error = error.unwrap_err();
|
let error = error.unwrap_err();
|
||||||
if let TlvLvError::InvalidTlvTypeField { found, expected } = error {
|
if let TlvLvError::InvalidTlvTypeField(InvalidTlvTypeFieldError { found, expected }) = error
|
||||||
|
{
|
||||||
assert_eq!(found, TlvType::MsgToUser as u8);
|
assert_eq!(found, TlvType::MsgToUser as u8);
|
||||||
assert_eq!(expected, Some(TlvType::EntityId as u8));
|
assert_eq!(expected, Some(TlvType::EntityId as u8));
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
@ -1457,7 +1435,7 @@ mod tests {
|
|||||||
let entity_id = UbfU8::new(5);
|
let entity_id = UbfU8::new(5);
|
||||||
let mut buf: [u8; 4] = [0; 4];
|
let mut buf: [u8; 4] = [0; 4];
|
||||||
assert!(entity_id.write_to_be_bytes(&mut buf).is_ok());
|
assert!(entity_id.write_to_be_bytes(&mut buf).is_ok());
|
||||||
let tlv_res = TlvOwned::new(TlvType::EntityId, &buf[0..1]).expect("creating TLV failed");
|
let tlv_res = TlvOwned::new(TlvType::EntityId, &buf[0..1]);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
tlv_res.tlv_type_field(),
|
tlv_res.tlv_type_field(),
|
||||||
TlvTypeField::Standard(TlvType::EntityId)
|
TlvTypeField::Standard(TlvType::EntityId)
|
||||||
@ -1484,7 +1462,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_owned_tlv_custom_type() {
|
fn test_owned_tlv_custom_type() {
|
||||||
let tlv_res = TlvOwned::new_with_custom_type(32, &[]).unwrap();
|
let tlv_res = TlvOwned::new_with_custom_type(32, &[]);
|
||||||
assert_eq!(tlv_res.tlv_type_field(), TlvTypeField::Custom(32));
|
assert_eq!(tlv_res.tlv_type_field(), TlvTypeField::Custom(32));
|
||||||
assert_eq!(tlv_res.len_full(), 2);
|
assert_eq!(tlv_res.len_full(), 2);
|
||||||
assert_eq!(tlv_res.value().len(), 0);
|
assert_eq!(tlv_res.value().len(), 0);
|
||||||
|
@ -2,7 +2,10 @@
|
|||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use super::TlvOwned;
|
use super::TlvOwned;
|
||||||
use super::{GenericTlv, ReadableTlv, Tlv, TlvLvError, TlvType, TlvTypeField, WritableTlv};
|
use super::{GenericTlv, ReadableTlv, Tlv, TlvLvError, TlvType, TlvTypeField, WritableTlv};
|
||||||
use crate::{cfdp::TlvLvDataTooLarge, ByteConversionError};
|
use crate::{
|
||||||
|
cfdp::{InvalidTlvTypeFieldError, TlvLvDataTooLargeError},
|
||||||
|
ByteConversionError,
|
||||||
|
};
|
||||||
use delegate::delegate;
|
use delegate::delegate;
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
@ -12,7 +15,7 @@ pub struct MsgToUserTlv<'data> {
|
|||||||
|
|
||||||
impl<'data> MsgToUserTlv<'data> {
|
impl<'data> MsgToUserTlv<'data> {
|
||||||
/// Create a new message to user TLV where the type field is set correctly.
|
/// Create a new message to user TLV where the type field is set correctly.
|
||||||
pub fn new(value: &'data [u8]) -> Result<MsgToUserTlv<'data>, TlvLvDataTooLarge> {
|
pub fn new(value: &'data [u8]) -> Result<MsgToUserTlv<'data>, TlvLvDataTooLargeError> {
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
tlv: Tlv::new(TlvType::MsgToUser, value)?,
|
tlv: Tlv::new(TlvType::MsgToUser, value)?,
|
||||||
})
|
})
|
||||||
@ -62,17 +65,19 @@ impl<'data> MsgToUserTlv<'data> {
|
|||||||
match msg_to_user.tlv.tlv_type_field() {
|
match msg_to_user.tlv.tlv_type_field() {
|
||||||
TlvTypeField::Standard(tlv_type) => {
|
TlvTypeField::Standard(tlv_type) => {
|
||||||
if tlv_type != TlvType::MsgToUser {
|
if tlv_type != TlvType::MsgToUser {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(InvalidTlvTypeFieldError {
|
||||||
found: tlv_type as u8,
|
found: tlv_type as u8,
|
||||||
expected: Some(TlvType::MsgToUser as u8),
|
expected: Some(TlvType::MsgToUser as u8),
|
||||||
});
|
}
|
||||||
|
.into());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
TlvTypeField::Custom(raw) => {
|
TlvTypeField::Custom(raw) => {
|
||||||
return Err(TlvLvError::InvalidTlvTypeField {
|
return Err(InvalidTlvTypeFieldError {
|
||||||
found: raw,
|
found: raw,
|
||||||
expected: Some(TlvType::MsgToUser as u8),
|
expected: Some(TlvType::MsgToUser as u8),
|
||||||
});
|
}
|
||||||
|
.into());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Ok(msg_to_user)
|
Ok(msg_to_user)
|
||||||
@ -205,9 +210,9 @@ mod tests {
|
|||||||
fn test_reserved_msg_deserialization_invalid_type() {
|
fn test_reserved_msg_deserialization_invalid_type() {
|
||||||
let trash: [u8; 5] = [TlvType::FlowLabel as u8, 3, 1, 2, 3];
|
let trash: [u8; 5] = [TlvType::FlowLabel as u8, 3, 1, 2, 3];
|
||||||
let error = MsgToUserTlv::from_bytes(&trash).unwrap_err();
|
let error = MsgToUserTlv::from_bytes(&trash).unwrap_err();
|
||||||
if let TlvLvError::InvalidTlvTypeField { found, expected } = error {
|
if let TlvLvError::InvalidTlvTypeField(inner) = error {
|
||||||
assert_eq!(found, TlvType::FlowLabel as u8);
|
assert_eq!(inner.found, TlvType::FlowLabel as u8);
|
||||||
assert_eq!(expected, Some(TlvType::MsgToUser as u8));
|
assert_eq!(inner.expected, Some(TlvType::MsgToUser as u8));
|
||||||
} else {
|
} else {
|
||||||
panic!("Wrong error type returned: {:?}", error);
|
panic!("Wrong error type returned: {:?}", error);
|
||||||
}
|
}
|
||||||
|
11
src/crc.rs
Normal file
11
src/crc.rs
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard, using
|
||||||
|
/// a [crc::NoTable] as the CRC implementation.
|
||||||
|
pub const CRC_CCITT_FALSE_NO_TABLE: crc::Crc<u16, crc::NoTable> =
|
||||||
|
crc::Crc::<u16, crc::NoTable>::new(&crc::CRC_16_IBM_3740);
|
||||||
|
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard, using
|
||||||
|
/// [crc::Table<1>] as the CRC implementation.
|
||||||
|
pub const CRC_CCITT_FALSE: crc::Crc<u16> = crc::Crc::<u16>::new(&crc::CRC_16_IBM_3740);
|
||||||
|
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard, using
|
||||||
|
/// a [crc::Table<16>] large table as the CRC implementation.
|
||||||
|
pub const CRC_CCITT_FALSE_BIG_TABLE: crc::Crc<u16, crc::Table<16>> =
|
||||||
|
crc::Crc::<u16, crc::Table<16>>::new(&crc::CRC_16_IBM_3740);
|
105
src/ecss/mod.rs
105
src/ecss/mod.rs
@ -3,16 +3,17 @@
|
|||||||
//!
|
//!
|
||||||
//! You can find the PUS telecommand types in the [tc] module and the the PUS telemetry
|
//! You can find the PUS telecommand types in the [tc] module and the the PUS telemetry
|
||||||
//! types inside the [tm] module.
|
//! types inside the [tm] module.
|
||||||
use crate::{ByteConversionError, CcsdsPacket, CRC_CCITT_FALSE};
|
use crate::{
|
||||||
|
crc::{CRC_CCITT_FALSE, CRC_CCITT_FALSE_NO_TABLE},
|
||||||
|
ByteConversionError, CcsdsPacket,
|
||||||
|
};
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use alloc::vec::Vec;
|
use alloc::vec::Vec;
|
||||||
use core::fmt::{Debug, Display, Formatter};
|
use core::fmt::Debug;
|
||||||
use core::mem::size_of;
|
use core::mem::size_of;
|
||||||
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
#[cfg(feature = "std")]
|
|
||||||
use std::error::Error;
|
|
||||||
|
|
||||||
pub mod event;
|
pub mod event;
|
||||||
pub mod hk;
|
pub mod hk;
|
||||||
@ -148,50 +149,19 @@ pub enum PfcReal {
|
|||||||
DoubleMilStd = 4,
|
DoubleMilStd = 4,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum PusError {
|
pub enum PusError {
|
||||||
|
#[error("PUS version {0:?} not supported")]
|
||||||
VersionNotSupported(PusVersion),
|
VersionNotSupported(PusVersion),
|
||||||
|
#[error("checksum verification for crc16 {0:#06x} failed")]
|
||||||
ChecksumFailure(u16),
|
ChecksumFailure(u16),
|
||||||
/// CRC16 needs to be calculated first
|
/// CRC16 needs to be calculated first
|
||||||
CrcCalculationMissing,
|
//#[error("crc16 was not calculated")]
|
||||||
ByteConversion(ByteConversionError),
|
//CrcCalculationMissing,
|
||||||
}
|
#[error("pus error: {0}")]
|
||||||
|
ByteConversion(#[from] ByteConversionError),
|
||||||
impl Display for PusError {
|
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
|
||||||
match self {
|
|
||||||
PusError::VersionNotSupported(v) => {
|
|
||||||
write!(f, "PUS version {v:?} not supported")
|
|
||||||
}
|
|
||||||
PusError::ChecksumFailure(crc) => {
|
|
||||||
write!(f, "checksum verification for crc16 {crc:#06x} failed")
|
|
||||||
}
|
|
||||||
PusError::CrcCalculationMissing => {
|
|
||||||
write!(f, "crc16 was not calculated")
|
|
||||||
}
|
|
||||||
PusError::ByteConversion(e) => {
|
|
||||||
write!(f, "pus error: {e}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
impl Error for PusError {
|
|
||||||
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
||||||
if let PusError::ByteConversion(e) = self {
|
|
||||||
return Some(e);
|
|
||||||
}
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<ByteConversionError> for PusError {
|
|
||||||
fn from(e: ByteConversionError) -> Self {
|
|
||||||
PusError::ByteConversion(e)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Generic trait to describe common attributes for both PUS Telecommands (TC) and PUS Telemetry
|
/// Generic trait to describe common attributes for both PUS Telecommands (TC) and PUS Telemetry
|
||||||
@ -203,7 +173,7 @@ pub trait PusPacket: CcsdsPacket {
|
|||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
fn user_data(&self) -> &[u8];
|
fn user_data(&self) -> &[u8];
|
||||||
fn crc16(&self) -> Option<u16>;
|
fn opt_crc16(&self) -> Option<u16>;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn crc_from_raw_data(raw_data: &[u8]) -> Result<u16, ByteConversionError> {
|
pub(crate) fn crc_from_raw_data(raw_data: &[u8]) -> Result<u16, ByteConversionError> {
|
||||||
@ -240,7 +210,7 @@ pub(crate) fn user_data_from_raw(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
pub fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
||||||
raw_data: &[u8],
|
raw_data: &[u8],
|
||||||
crc16: u16,
|
crc16: u16,
|
||||||
) -> Result<(), PusError> {
|
) -> Result<(), PusError> {
|
||||||
@ -249,6 +219,15 @@ pub(crate) fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
|||||||
.ok_or(PusError::ChecksumFailure(crc16))
|
.ok_or(PusError::ChecksumFailure(crc16))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn verify_crc16_ccitt_false_from_raw_to_pus_error_no_table(
|
||||||
|
raw_data: &[u8],
|
||||||
|
crc16: u16,
|
||||||
|
) -> Result<(), PusError> {
|
||||||
|
verify_crc16_ccitt_false_from_raw_no_table(raw_data)
|
||||||
|
.then_some(())
|
||||||
|
.ok_or(PusError::ChecksumFailure(crc16))
|
||||||
|
}
|
||||||
|
|
||||||
pub(crate) fn verify_crc16_ccitt_false_from_raw(raw_data: &[u8]) -> bool {
|
pub(crate) fn verify_crc16_ccitt_false_from_raw(raw_data: &[u8]) -> bool {
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
digest.update(raw_data);
|
digest.update(raw_data);
|
||||||
@ -258,6 +237,15 @@ pub(crate) fn verify_crc16_ccitt_false_from_raw(raw_data: &[u8]) -> bool {
|
|||||||
false
|
false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub(crate) fn verify_crc16_ccitt_false_from_raw_no_table(raw_data: &[u8]) -> bool {
|
||||||
|
let mut digest = CRC_CCITT_FALSE_NO_TABLE.digest();
|
||||||
|
digest.update(raw_data);
|
||||||
|
if digest.finalize() == 0 {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
false
|
||||||
|
}
|
||||||
|
|
||||||
macro_rules! ccsds_impl {
|
macro_rules! ccsds_impl {
|
||||||
() => {
|
() => {
|
||||||
delegate!(to self.sp_header {
|
delegate!(to self.sp_header {
|
||||||
@ -382,7 +370,34 @@ generic_ecss_enum_typedefs_and_from_impls! {
|
|||||||
/// on the serialization of those packets.
|
/// on the serialization of those packets.
|
||||||
pub trait WritablePusPacket {
|
pub trait WritablePusPacket {
|
||||||
fn len_written(&self) -> usize;
|
fn len_written(&self) -> usize;
|
||||||
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError>;
|
|
||||||
|
/// Writes the packet to the given slice without writing the CRC.
|
||||||
|
///
|
||||||
|
/// The returned size is the written size WITHOUT the CRC.
|
||||||
|
fn write_to_bytes_no_crc(&self, slice: &mut [u8]) -> Result<usize, PusError>;
|
||||||
|
|
||||||
|
/// First uses [Self::write_to_bytes_no_crc] to write the packet to the given slice and then
|
||||||
|
/// uses the [CRC_CCITT_FALS] to calculate the CRC and write it to the slice.
|
||||||
|
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
||||||
|
let mut curr_idx = self.write_to_bytes_no_crc(slice)?;
|
||||||
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
|
digest.update(&slice[0..curr_idx]);
|
||||||
|
slice[curr_idx..curr_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
|
||||||
|
curr_idx += 2;
|
||||||
|
Ok(curr_idx)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// First uses [Self::write_to_bytes_no_crc] to write the packet to the given slice and then
|
||||||
|
/// uses the [CRC_CCITT_FALSE_NO_TABLE] to calculate the CRC and write it to the slice.
|
||||||
|
fn write_to_bytes_crc_no_table(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
||||||
|
let mut curr_idx = self.write_to_bytes_no_crc(slice)?;
|
||||||
|
let mut digest = CRC_CCITT_FALSE_NO_TABLE.digest();
|
||||||
|
digest.update(&slice[0..curr_idx]);
|
||||||
|
slice[curr_idx..curr_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
|
||||||
|
curr_idx += 2;
|
||||||
|
Ok(curr_idx)
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
fn to_vec(&self) -> Result<Vec<u8>, PusError> {
|
fn to_vec(&self) -> Result<Vec<u8>, PusError> {
|
||||||
// This is the correct way to do this. See
|
// This is the correct way to do this. See
|
||||||
|
135
src/ecss/tc.rs
135
src/ecss/tc.rs
@ -33,13 +33,14 @@
|
|||||||
//! assert_eq!(pus_tc.subservice(), 1);
|
//! assert_eq!(pus_tc.subservice(), 1);
|
||||||
//! assert_eq!(pus_tc.apid(), 0x02);
|
//! assert_eq!(pus_tc.apid(), 0x02);
|
||||||
//! ```
|
//! ```
|
||||||
|
use crate::crc::{CRC_CCITT_FALSE, CRC_CCITT_FALSE_NO_TABLE};
|
||||||
use crate::ecss::{
|
use crate::ecss::{
|
||||||
ccsds_impl, crc_from_raw_data, sp_header_impls, user_data_from_raw,
|
ccsds_impl, crc_from_raw_data, sp_header_impls, user_data_from_raw,
|
||||||
verify_crc16_ccitt_false_from_raw_to_pus_error, CrcType, PusError, PusPacket, PusVersion,
|
verify_crc16_ccitt_false_from_raw_to_pus_error, CrcType, PusError, PusPacket, PusVersion,
|
||||||
WritablePusPacket,
|
WritablePusPacket,
|
||||||
};
|
};
|
||||||
|
use crate::SpHeader;
|
||||||
use crate::{ByteConversionError, CcsdsPacket, PacketType, SequenceFlags, CCSDS_HEADER_LEN};
|
use crate::{ByteConversionError, CcsdsPacket, PacketType, SequenceFlags, CCSDS_HEADER_LEN};
|
||||||
use crate::{SpHeader, CRC_CCITT_FALSE};
|
|
||||||
use core::mem::size_of;
|
use core::mem::size_of;
|
||||||
use delegate::delegate;
|
use delegate::delegate;
|
||||||
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
||||||
@ -50,6 +51,8 @@ use zerocopy::{FromBytes, IntoBytes};
|
|||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use alloc::vec::Vec;
|
use alloc::vec::Vec;
|
||||||
|
|
||||||
|
use super::verify_crc16_ccitt_false_from_raw_to_pus_error_no_table;
|
||||||
|
|
||||||
/// PUS C secondary header length is fixed
|
/// PUS C secondary header length is fixed
|
||||||
pub const PUC_TC_SECONDARY_HEADER_LEN: usize = size_of::<zc::PusTcSecondaryHeader>();
|
pub const PUC_TC_SECONDARY_HEADER_LEN: usize = size_of::<zc::PusTcSecondaryHeader>();
|
||||||
pub const PUS_TC_MIN_LEN_WITHOUT_APP_DATA: usize =
|
pub const PUS_TC_MIN_LEN_WITHOUT_APP_DATA: usize =
|
||||||
@ -115,7 +118,7 @@ pub mod zc {
|
|||||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||||
#[inline]
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion {
|
fn pus_version(&self) -> PusVersion {
|
||||||
PusVersion::try_from(self.version_ack >> 4 & 0b1111).unwrap_or(PusVersion::Invalid)
|
PusVersion::try_from((self.version_ack >> 4) & 0b1111).unwrap_or(PusVersion::Invalid)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
@ -239,13 +242,13 @@ impl<'app_data> PusTcCreator<'app_data> {
|
|||||||
/// # Arguments
|
/// # Arguments
|
||||||
///
|
///
|
||||||
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
||||||
/// header flag are set correctly by the constructor.
|
/// header flag are set correctly by the constructor.
|
||||||
/// * `sec_header` - Information contained in the data field header, including the service
|
/// * `sec_header` - Information contained in the data field header, including the service
|
||||||
/// and subservice type
|
/// and subservice type
|
||||||
/// * `app_data` - Custom application data
|
/// * `app_data` - Custom application data
|
||||||
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
||||||
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
||||||
/// the correct value to this field manually
|
/// the correct value to this field manually
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn new(
|
pub fn new(
|
||||||
mut sp_header: SpHeader,
|
mut sp_header: SpHeader,
|
||||||
@ -342,6 +345,17 @@ impl<'app_data> PusTcCreator<'app_data> {
|
|||||||
digest.finalize()
|
digest.finalize()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// This function calculates and returns the CRC16 for the current packet.
|
||||||
|
pub fn calc_own_crc16_no_table(&self) -> u16 {
|
||||||
|
let mut digest = CRC_CCITT_FALSE_NO_TABLE.digest();
|
||||||
|
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
||||||
|
digest.update(sph_zc.as_bytes());
|
||||||
|
let pus_tc_header = zc::PusTcSecondaryHeader::try_from(self.sec_header).unwrap();
|
||||||
|
digest.update(pus_tc_header.as_bytes());
|
||||||
|
digest.update(self.app_data);
|
||||||
|
digest.finalize()
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> usize {
|
pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> usize {
|
||||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
||||||
@ -366,8 +380,10 @@ impl WritablePusPacket for PusTcCreator<'_> {
|
|||||||
PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len()
|
PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Write the raw PUS byte representation to a provided buffer.
|
/// Writes the packet to the given slice without writing the CRC.
|
||||||
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
///
|
||||||
|
/// The returned size is the written size WITHOUT the CRC.
|
||||||
|
fn write_to_bytes_no_crc(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
||||||
let mut curr_idx = 0;
|
let mut curr_idx = 0;
|
||||||
let tc_header_len = size_of::<zc::PusTcSecondaryHeader>();
|
let tc_header_len = size_of::<zc::PusTcSecondaryHeader>();
|
||||||
let total_size = self.len_written();
|
let total_size = self.len_written();
|
||||||
@ -388,10 +404,6 @@ impl WritablePusPacket for PusTcCreator<'_> {
|
|||||||
curr_idx += tc_header_len;
|
curr_idx += tc_header_len;
|
||||||
slice[curr_idx..curr_idx + self.app_data.len()].copy_from_slice(self.app_data);
|
slice[curr_idx..curr_idx + self.app_data.len()].copy_from_slice(self.app_data);
|
||||||
curr_idx += self.app_data.len();
|
curr_idx += self.app_data.len();
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
|
||||||
digest.update(&slice[0..curr_idx]);
|
|
||||||
slice[curr_idx..curr_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
|
|
||||||
curr_idx += 2;
|
|
||||||
Ok(curr_idx)
|
Ok(curr_idx)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -416,7 +428,7 @@ impl PusPacket for PusTcCreator<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn opt_crc16(&self) -> Option<u16> {
|
||||||
Some(self.calc_own_crc16())
|
Some(self.calc_own_crc16())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -465,7 +477,22 @@ impl<'raw_data> PusTcReader<'raw_data> {
|
|||||||
/// Create a [PusTcReader] instance from a raw slice. On success, it returns a tuple containing
|
/// Create a [PusTcReader] instance from a raw slice. On success, it returns a tuple containing
|
||||||
/// the instance and the found byte length of the packet. This function also performs a CRC
|
/// the instance and the found byte length of the packet. This function also performs a CRC
|
||||||
/// check and will return an appropriate [PusError] if the check fails.
|
/// check and will return an appropriate [PusError] if the check fails.
|
||||||
pub fn new(slice: &'raw_data [u8]) -> Result<(Self, usize), PusError> {
|
pub fn new(slice: &'raw_data [u8]) -> Result<Self, PusError> {
|
||||||
|
let pus_tc = Self::new_no_crc_check(slice)?;
|
||||||
|
verify_crc16_ccitt_false_from_raw_to_pus_error(pus_tc.raw_data(), pus_tc.crc16())?;
|
||||||
|
Ok(pus_tc)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Similar to [PusTcReader::new], but uses a table-less CRC16 algorithm which can reduce
|
||||||
|
/// binary size and memory usage.
|
||||||
|
pub fn new_crc_no_table(slice: &'raw_data [u8]) -> Result<Self, PusError> {
|
||||||
|
let pus_tc = Self::new_no_crc_check(slice)?;
|
||||||
|
verify_crc16_ccitt_false_from_raw_to_pus_error_no_table(pus_tc.raw_data(), pus_tc.crc16())?;
|
||||||
|
Ok(pus_tc)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Creates a new instance without performing a CRC check.
|
||||||
|
pub fn new_no_crc_check(slice: &'raw_data [u8]) -> Result<Self, PusError> {
|
||||||
let raw_data_len = slice.len();
|
let raw_data_len = slice.len();
|
||||||
if raw_data_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
|
if raw_data_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
return Err(ByteConversionError::FromSliceTooSmall {
|
||||||
@ -498,15 +525,13 @@ impl<'raw_data> PusTcReader<'raw_data> {
|
|||||||
.map_err(|_| ByteConversionError::ZeroCopyFromError)?;
|
.map_err(|_| ByteConversionError::ZeroCopyFromError)?;
|
||||||
current_idx += PUC_TC_SECONDARY_HEADER_LEN;
|
current_idx += PUC_TC_SECONDARY_HEADER_LEN;
|
||||||
let raw_data = &slice[0..total_len];
|
let raw_data = &slice[0..total_len];
|
||||||
let pus_tc = Self {
|
Ok(Self {
|
||||||
sp_header,
|
sp_header,
|
||||||
sec_header: PusTcSecondaryHeader::try_from(sec_header).unwrap(),
|
sec_header: PusTcSecondaryHeader::try_from(sec_header).unwrap(),
|
||||||
raw_data,
|
raw_data,
|
||||||
app_data: user_data_from_raw(current_idx, total_len, slice)?,
|
app_data: user_data_from_raw(current_idx, total_len, slice)?,
|
||||||
crc16: crc_from_raw_data(raw_data)?,
|
crc16: crc_from_raw_data(raw_data)?,
|
||||||
};
|
})
|
||||||
verify_crc16_ccitt_false_from_raw_to_pus_error(raw_data, pus_tc.crc16)?;
|
|
||||||
Ok((pus_tc, total_len))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
@ -528,6 +553,11 @@ impl<'raw_data> PusTcReader<'raw_data> {
|
|||||||
pub fn sp_header(&self) -> &SpHeader {
|
pub fn sp_header(&self) -> &SpHeader {
|
||||||
&self.sp_header
|
&self.sp_header
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
pub fn crc16(&self) -> u16 {
|
||||||
|
self.crc16
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for PusTcReader<'_> {
|
impl PartialEq for PusTcReader<'_> {
|
||||||
@ -557,7 +587,7 @@ impl PusPacket for PusTcReader<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn opt_crc16(&self) -> Option<u16> {
|
||||||
Some(self.crc16)
|
Some(self.crc16)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -640,11 +670,37 @@ mod tests {
|
|||||||
.expect("Error writing TC to buffer");
|
.expect("Error writing TC to buffer");
|
||||||
assert_eq!(size, 13);
|
assert_eq!(size, 13);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
pus_tc.crc16().unwrap(),
|
pus_tc.opt_crc16().unwrap(),
|
||||||
u16::from_be_bytes(test_buf[size - 2..size].try_into().unwrap())
|
u16::from_be_bytes(test_buf[size - 2..size].try_into().unwrap())
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_serialization_crc_no_table() {
|
||||||
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
|
let mut test_buf: [u8; 32] = [0; 32];
|
||||||
|
let size = pus_tc
|
||||||
|
.write_to_bytes_crc_no_table(test_buf.as_mut_slice())
|
||||||
|
.expect("error writing tc to buffer");
|
||||||
|
assert_eq!(size, 13);
|
||||||
|
assert_eq!(
|
||||||
|
pus_tc.opt_crc16().unwrap(),
|
||||||
|
u16::from_be_bytes(test_buf[size - 2..size].try_into().unwrap())
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_serialization_no_crc() {
|
||||||
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
|
let mut test_buf: [u8; 32] = [0; 32];
|
||||||
|
let size = pus_tc
|
||||||
|
.write_to_bytes_no_crc(test_buf.as_mut_slice())
|
||||||
|
.expect("error writing tc to buffer");
|
||||||
|
assert_eq!(size, 11);
|
||||||
|
assert_eq!(test_buf[11], 0);
|
||||||
|
assert_eq!(test_buf[12], 0);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_deserialization() {
|
fn test_deserialization() {
|
||||||
let pus_tc = base_ping_tc_simple_ctor();
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
@ -653,9 +709,26 @@ mod tests {
|
|||||||
.write_to_bytes(test_buf.as_mut_slice())
|
.write_to_bytes(test_buf.as_mut_slice())
|
||||||
.expect("Error writing TC to buffer");
|
.expect("Error writing TC to buffer");
|
||||||
assert_eq!(size, 13);
|
assert_eq!(size, 13);
|
||||||
let (tc_from_raw, size) =
|
let tc_from_raw =
|
||||||
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
||||||
|
assert_eq!(tc_from_raw.total_len(), 13);
|
||||||
|
verify_test_tc_with_reader(&tc_from_raw, false, 13);
|
||||||
|
assert!(tc_from_raw.user_data().is_empty());
|
||||||
|
verify_test_tc_raw(&test_buf);
|
||||||
|
verify_crc_no_app_data(&test_buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_deserialization_no_table() {
|
||||||
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
|
let mut test_buf: [u8; 32] = [0; 32];
|
||||||
|
let size = pus_tc
|
||||||
|
.write_to_bytes(test_buf.as_mut_slice())
|
||||||
|
.expect("Error writing TC to buffer");
|
||||||
assert_eq!(size, 13);
|
assert_eq!(size, 13);
|
||||||
|
let tc_from_raw = PusTcReader::new_crc_no_table(&test_buf)
|
||||||
|
.expect("Creating PUS TC struct from raw buffer failed");
|
||||||
|
assert_eq!(tc_from_raw.total_len(), 13);
|
||||||
verify_test_tc_with_reader(&tc_from_raw, false, 13);
|
verify_test_tc_with_reader(&tc_from_raw, false, 13);
|
||||||
assert!(tc_from_raw.user_data().is_empty());
|
assert!(tc_from_raw.user_data().is_empty());
|
||||||
verify_test_tc_raw(&test_buf);
|
verify_test_tc_raw(&test_buf);
|
||||||
@ -667,9 +740,9 @@ mod tests {
|
|||||||
let pus_tc = base_ping_tc_simple_ctor();
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
let tc_vec = pus_tc.to_vec().expect("Error writing TC to buffer");
|
let tc_vec = pus_tc.to_vec().expect("Error writing TC to buffer");
|
||||||
assert_eq!(tc_vec.len(), 13);
|
assert_eq!(tc_vec.len(), 13);
|
||||||
let (tc_from_raw, size) = PusTcReader::new(tc_vec.as_slice())
|
let tc_from_raw = PusTcReader::new(tc_vec.as_slice())
|
||||||
.expect("Creating PUS TC struct from raw buffer failed");
|
.expect("Creating PUS TC struct from raw buffer failed");
|
||||||
assert_eq!(size, 13);
|
assert_eq!(tc_from_raw.total_len(), 13);
|
||||||
verify_test_tc_with_reader(&tc_from_raw, false, 13);
|
verify_test_tc_with_reader(&tc_from_raw, false, 13);
|
||||||
assert!(tc_from_raw.user_data().is_empty());
|
assert!(tc_from_raw.user_data().is_empty());
|
||||||
verify_test_tc_raw(&tc_vec);
|
verify_test_tc_raw(&tc_vec);
|
||||||
@ -692,15 +765,15 @@ mod tests {
|
|||||||
.write_to_bytes(test_buf.as_mut_slice())
|
.write_to_bytes(test_buf.as_mut_slice())
|
||||||
.expect("Error writing TC to buffer");
|
.expect("Error writing TC to buffer");
|
||||||
assert_eq!(size, 16);
|
assert_eq!(size, 16);
|
||||||
let (tc_from_raw, size) =
|
let tc_from_raw =
|
||||||
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
||||||
assert_eq!(size, 16);
|
assert_eq!(tc_from_raw.total_len(), 16);
|
||||||
verify_test_tc_with_reader(&tc_from_raw, true, 16);
|
verify_test_tc_with_reader(&tc_from_raw, true, 16);
|
||||||
let user_data = tc_from_raw.user_data();
|
let user_data = tc_from_raw.user_data();
|
||||||
assert_eq!(tc_from_raw.user_data(), tc_from_raw.app_data());
|
assert_eq!(tc_from_raw.user_data(), tc_from_raw.app_data());
|
||||||
assert_eq!(tc_from_raw.raw_data(), &test_buf[..size]);
|
assert_eq!(tc_from_raw.raw_data(), &test_buf[..size]);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
tc_from_raw.crc16().unwrap(),
|
tc_from_raw.opt_crc16().unwrap(),
|
||||||
u16::from_be_bytes(test_buf[size - 2..size].try_into().unwrap())
|
u16::from_be_bytes(test_buf[size - 2..size].try_into().unwrap())
|
||||||
);
|
);
|
||||||
assert_eq!(user_data[0], 1);
|
assert_eq!(user_data[0], 1);
|
||||||
@ -715,9 +788,9 @@ mod tests {
|
|||||||
pus_tc
|
pus_tc
|
||||||
.write_to_bytes(test_buf.as_mut_slice())
|
.write_to_bytes(test_buf.as_mut_slice())
|
||||||
.expect("Error writing TC to buffer");
|
.expect("Error writing TC to buffer");
|
||||||
let (tc_from_raw_0, _) =
|
let tc_from_raw_0 =
|
||||||
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
||||||
let (tc_from_raw_1, _) =
|
let tc_from_raw_1 =
|
||||||
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
PusTcReader::new(&test_buf).expect("Creating PUS TC struct from raw buffer failed");
|
||||||
assert_eq!(tc_from_raw_0, tc_from_raw_1);
|
assert_eq!(tc_from_raw_0, tc_from_raw_1);
|
||||||
}
|
}
|
||||||
@ -869,7 +942,7 @@ mod tests {
|
|||||||
assert_eq!(*tc.sp_header(), comp_header);
|
assert_eq!(*tc.sp_header(), comp_header);
|
||||||
}
|
}
|
||||||
|
|
||||||
fn verify_test_tc_generic(tc: &(impl CcsdsPacket + PusPacket + GenericPusTcSecondaryHeader)) {
|
fn verify_test_tc_generic(tc: &(impl PusPacket + GenericPusTcSecondaryHeader)) {
|
||||||
assert_eq!(PusPacket::service(tc), 17);
|
assert_eq!(PusPacket::service(tc), 17);
|
||||||
assert_eq!(GenericPusTcSecondaryHeader::service(tc), 17);
|
assert_eq!(GenericPusTcSecondaryHeader::service(tc), 17);
|
||||||
assert_eq!(PusPacket::subservice(tc), 1);
|
assert_eq!(PusPacket::subservice(tc), 1);
|
||||||
@ -933,8 +1006,8 @@ mod tests {
|
|||||||
let pus_tc = base_ping_tc_simple_ctor();
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
let mut buf = [0; 32];
|
let mut buf = [0; 32];
|
||||||
pus_tc.write_to_bytes(&mut buf).unwrap();
|
pus_tc.write_to_bytes(&mut buf).unwrap();
|
||||||
assert_eq!(pus_tc, PusTcReader::new(&buf).unwrap().0);
|
assert_eq!(pus_tc, PusTcReader::new(&buf).unwrap());
|
||||||
assert_eq!(PusTcReader::new(&buf).unwrap().0, pus_tc);
|
assert_eq!(PusTcReader::new(&buf).unwrap(), pus_tc);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
165
src/ecss/tm.rs
165
src/ecss/tm.rs
@ -35,13 +35,14 @@
|
|||||||
//! println!("{:?}", &test_buf[0..written_size]);
|
//! println!("{:?}", &test_buf[0..written_size]);
|
||||||
//!
|
//!
|
||||||
//! // Deserialize from the raw byte representation
|
//! // Deserialize from the raw byte representation
|
||||||
//! let (ping_tm_reader, read_size) = PusTmReader::new(&test_buf, 7).expect("Deserialization failed");
|
//! let ping_tm_reader = PusTmReader::new(&test_buf, 7).expect("Deserialization failed");
|
||||||
//! assert_eq!(written_size, read_size);
|
//! assert_eq!(written_size, ping_tm_reader.total_len());
|
||||||
//! assert_eq!(ping_tm_reader.service(), 17);
|
//! assert_eq!(ping_tm_reader.service(), 17);
|
||||||
//! assert_eq!(ping_tm_reader.subservice(), 2);
|
//! assert_eq!(ping_tm_reader.subservice(), 2);
|
||||||
//! assert_eq!(ping_tm_reader.apid(), 0x02);
|
//! assert_eq!(ping_tm_reader.apid(), 0x02);
|
||||||
//! assert_eq!(ping_tm_reader.timestamp(), &time_buf);
|
//! assert_eq!(ping_tm_reader.timestamp(), &time_buf);
|
||||||
//! ```
|
//! ```
|
||||||
|
use crate::crc::{CRC_CCITT_FALSE, CRC_CCITT_FALSE_NO_TABLE};
|
||||||
use crate::ecss::{
|
use crate::ecss::{
|
||||||
calc_pus_crc16, ccsds_impl, crc_from_raw_data, sp_header_impls, user_data_from_raw,
|
calc_pus_crc16, ccsds_impl, crc_from_raw_data, sp_header_impls, user_data_from_raw,
|
||||||
verify_crc16_ccitt_false_from_raw_to_pus_error, CrcType, PusError, PusPacket, PusVersion,
|
verify_crc16_ccitt_false_from_raw_to_pus_error, CrcType, PusError, PusPacket, PusVersion,
|
||||||
@ -49,7 +50,7 @@ use crate::ecss::{
|
|||||||
};
|
};
|
||||||
use crate::{
|
use crate::{
|
||||||
ByteConversionError, CcsdsPacket, PacketType, SequenceFlags, SpHeader, CCSDS_HEADER_LEN,
|
ByteConversionError, CcsdsPacket, PacketType, SequenceFlags, SpHeader, CCSDS_HEADER_LEN,
|
||||||
CRC_CCITT_FALSE, MAX_APID, MAX_SEQ_COUNT,
|
MAX_APID, MAX_SEQ_COUNT,
|
||||||
};
|
};
|
||||||
use core::mem::size_of;
|
use core::mem::size_of;
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
@ -64,6 +65,8 @@ use crate::time::{TimeWriter, TimestampError};
|
|||||||
|
|
||||||
use self::zc::PusTmSecHeaderWithoutTimestamp;
|
use self::zc::PusTmSecHeaderWithoutTimestamp;
|
||||||
|
|
||||||
|
use super::verify_crc16_ccitt_false_from_raw_to_pus_error_no_table;
|
||||||
|
|
||||||
pub trait IsPusTelemetry {}
|
pub trait IsPusTelemetry {}
|
||||||
|
|
||||||
/// Length without timestamp
|
/// Length without timestamp
|
||||||
@ -120,7 +123,7 @@ pub mod zc {
|
|||||||
impl GenericPusTmSecondaryHeader for PusTmSecHeaderWithoutTimestamp {
|
impl GenericPusTmSecondaryHeader for PusTmSecHeaderWithoutTimestamp {
|
||||||
#[inline]
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion {
|
fn pus_version(&self) -> PusVersion {
|
||||||
PusVersion::try_from(self.pus_version_and_sc_time_ref_status >> 4 & 0b1111)
|
PusVersion::try_from((self.pus_version_and_sc_time_ref_status >> 4) & 0b1111)
|
||||||
.unwrap_or(PusVersion::Invalid)
|
.unwrap_or(PusVersion::Invalid)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -277,13 +280,13 @@ impl<'time, 'src_data> PusTmCreator<'time, 'src_data> {
|
|||||||
/// # Arguments
|
/// # Arguments
|
||||||
///
|
///
|
||||||
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
||||||
/// header flag are set correctly by the constructor.
|
/// header flag are set correctly by the constructor.
|
||||||
/// * `sec_header` - Information contained in the secondary header, including the service
|
/// * `sec_header` - Information contained in the secondary header, including the service
|
||||||
/// and subservice type
|
/// and subservice type
|
||||||
/// * `source_data` - Custom application data
|
/// * `source_data` - Custom application data
|
||||||
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
||||||
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
||||||
/// the correct value to this field manually
|
/// the correct value to this field manually
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn new(
|
pub fn new(
|
||||||
mut sp_header: SpHeader,
|
mut sp_header: SpHeader,
|
||||||
@ -389,6 +392,29 @@ impl<'time, 'src_data> PusTmCreator<'time, 'src_data> {
|
|||||||
|
|
||||||
/// Write the raw PUS byte representation to a provided buffer.
|
/// Write the raw PUS byte representation to a provided buffer.
|
||||||
pub fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, ByteConversionError> {
|
pub fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, ByteConversionError> {
|
||||||
|
let mut curr_idx = self.write_to_bytes_no_crc(slice)?;
|
||||||
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
|
digest.update(&slice[0..curr_idx]);
|
||||||
|
slice[curr_idx..curr_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
|
||||||
|
curr_idx += 2;
|
||||||
|
Ok(curr_idx)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write the raw PUS byte representation to a provided buffer.
|
||||||
|
pub fn write_to_bytes_crc_no_table(
|
||||||
|
&self,
|
||||||
|
slice: &mut [u8],
|
||||||
|
) -> Result<usize, ByteConversionError> {
|
||||||
|
let mut curr_idx = self.write_to_bytes_no_crc(slice)?;
|
||||||
|
let mut digest = CRC_CCITT_FALSE_NO_TABLE.digest();
|
||||||
|
digest.update(&slice[0..curr_idx]);
|
||||||
|
slice[curr_idx..curr_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
|
||||||
|
curr_idx += 2;
|
||||||
|
Ok(curr_idx)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write the raw PUS byte representation to a provided buffer.
|
||||||
|
pub fn write_to_bytes_no_crc(&self, slice: &mut [u8]) -> Result<usize, ByteConversionError> {
|
||||||
let mut curr_idx = 0;
|
let mut curr_idx = 0;
|
||||||
let total_size = self.len_written();
|
let total_size = self.len_written();
|
||||||
if total_size > slice.len() {
|
if total_size > slice.len() {
|
||||||
@ -411,10 +437,6 @@ impl<'time, 'src_data> PusTmCreator<'time, 'src_data> {
|
|||||||
curr_idx += self.sec_header.timestamp.len();
|
curr_idx += self.sec_header.timestamp.len();
|
||||||
slice[curr_idx..curr_idx + self.source_data.len()].copy_from_slice(self.source_data);
|
slice[curr_idx..curr_idx + self.source_data.len()].copy_from_slice(self.source_data);
|
||||||
curr_idx += self.source_data.len();
|
curr_idx += self.source_data.len();
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
|
||||||
digest.update(&slice[0..curr_idx]);
|
|
||||||
slice[curr_idx..curr_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
|
|
||||||
curr_idx += 2;
|
|
||||||
Ok(curr_idx)
|
Ok(curr_idx)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -446,8 +468,8 @@ impl WritablePusPacket for PusTmCreator<'_, '_> {
|
|||||||
+ self.source_data.len()
|
+ self.source_data.len()
|
||||||
}
|
}
|
||||||
/// Write the raw PUS byte representation to a provided buffer.
|
/// Write the raw PUS byte representation to a provided buffer.
|
||||||
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
fn write_to_bytes_no_crc(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
||||||
Ok(Self::write_to_bytes(self, slice)?)
|
Ok(Self::write_to_bytes_no_crc(self, slice)?)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -479,7 +501,7 @@ impl PusPacket for PusTmCreator<'_, '_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn opt_crc16(&self) -> Option<u16> {
|
||||||
Some(self.calc_own_crc16())
|
Some(self.calc_own_crc16())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -534,7 +556,26 @@ impl<'raw_data> PusTmReader<'raw_data> {
|
|||||||
///
|
///
|
||||||
/// This function will check the CRC-16 of the PUS packet and will return an appropriate
|
/// This function will check the CRC-16 of the PUS packet and will return an appropriate
|
||||||
/// [PusError] if the check fails.
|
/// [PusError] if the check fails.
|
||||||
pub fn new(slice: &'raw_data [u8], timestamp_len: usize) -> Result<(Self, usize), PusError> {
|
pub fn new(slice: &'raw_data [u8], timestamp_len: usize) -> Result<Self, PusError> {
|
||||||
|
let tc = Self::new_no_crc_check(slice, timestamp_len)?;
|
||||||
|
verify_crc16_ccitt_false_from_raw_to_pus_error(tc.raw_data(), tc.crc16)?;
|
||||||
|
Ok(tc)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Like [PusTmReader::new] but uses a table-less CRC implementation.
|
||||||
|
pub fn new_crc_no_table(
|
||||||
|
slice: &'raw_data [u8],
|
||||||
|
timestamp_len: usize,
|
||||||
|
) -> Result<Self, PusError> {
|
||||||
|
let tc = Self::new_no_crc_check(slice, timestamp_len)?;
|
||||||
|
verify_crc16_ccitt_false_from_raw_to_pus_error_no_table(tc.raw_data(), tc.crc16)?;
|
||||||
|
Ok(tc)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_no_crc_check(
|
||||||
|
slice: &'raw_data [u8],
|
||||||
|
timestamp_len: usize,
|
||||||
|
) -> Result<Self, PusError> {
|
||||||
let raw_data_len = slice.len();
|
let raw_data_len = slice.len();
|
||||||
if raw_data_len < PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA {
|
if raw_data_len < PUS_TM_MIN_LEN_WITHOUT_SOURCE_DATA {
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
return Err(ByteConversionError::FromSliceTooSmall {
|
||||||
@ -572,15 +613,13 @@ impl<'raw_data> PusTmReader<'raw_data> {
|
|||||||
};
|
};
|
||||||
current_idx += timestamp_len;
|
current_idx += timestamp_len;
|
||||||
let raw_data = &slice[0..total_len];
|
let raw_data = &slice[0..total_len];
|
||||||
let pus_tm = Self {
|
Ok(Self {
|
||||||
sp_header,
|
sp_header,
|
||||||
sec_header: PusTmSecondaryHeader::try_from(zc_sec_header_wrapper).unwrap(),
|
sec_header: PusTmSecondaryHeader::try_from(zc_sec_header_wrapper).unwrap(),
|
||||||
raw_data: &slice[0..total_len],
|
raw_data: &slice[0..total_len],
|
||||||
source_data: user_data_from_raw(current_idx, total_len, slice)?,
|
source_data: user_data_from_raw(current_idx, total_len, slice)?,
|
||||||
crc16: crc_from_raw_data(raw_data)?,
|
crc16: crc_from_raw_data(raw_data)?,
|
||||||
};
|
})
|
||||||
verify_crc16_ccitt_false_from_raw_to_pus_error(raw_data, pus_tm.crc16)?;
|
|
||||||
Ok((pus_tm, total_len))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
@ -598,6 +637,11 @@ impl<'raw_data> PusTmReader<'raw_data> {
|
|||||||
self.sec_header.timestamp
|
self.sec_header.timestamp
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
pub fn crc16(&self) -> u16 {
|
||||||
|
self.crc16
|
||||||
|
}
|
||||||
|
|
||||||
/// This function will return the slice [Self] was constructed from.
|
/// This function will return the slice [Self] was constructed from.
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn raw_data(&self) -> &[u8] {
|
pub fn raw_data(&self) -> &[u8] {
|
||||||
@ -634,8 +678,8 @@ impl PusPacket for PusTmReader<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn opt_crc16(&self) -> Option<u16> {
|
||||||
Some(self.crc16)
|
Some(self.crc16())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -822,7 +866,7 @@ impl PusPacket for PusTmZeroCopyWriter<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn opt_crc16(&self) -> Option<u16> {
|
||||||
Some(u16::from_be_bytes(
|
Some(u16::from_be_bytes(
|
||||||
self.raw_tm[self.sp_header().total_len() - 2..self.sp_header().total_len()]
|
self.raw_tm[self.sp_header().total_len() - 2..self.sp_header().total_len()]
|
||||||
.try_into()
|
.try_into()
|
||||||
@ -918,7 +962,32 @@ mod tests {
|
|||||||
.write_to_bytes(&mut buf)
|
.write_to_bytes(&mut buf)
|
||||||
.expect("Serialization failed");
|
.expect("Serialization failed");
|
||||||
assert_eq!(ser_len, 22);
|
assert_eq!(ser_len, 22);
|
||||||
verify_raw_ping_reply(pus_tm.crc16().unwrap(), &buf);
|
verify_raw_ping_reply(pus_tm.opt_crc16().unwrap(), &buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_serialization_no_source_data_no_table() {
|
||||||
|
let timestamp = dummy_timestamp();
|
||||||
|
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
||||||
|
let mut buf: [u8; 32] = [0; 32];
|
||||||
|
let ser_len = pus_tm
|
||||||
|
.write_to_bytes_crc_no_table(&mut buf)
|
||||||
|
.expect("Serialization failed");
|
||||||
|
assert_eq!(ser_len, 22);
|
||||||
|
verify_raw_ping_reply(pus_tm.opt_crc16().unwrap(), &buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_serialization_no_source_data_no_crc() {
|
||||||
|
let timestamp = dummy_timestamp();
|
||||||
|
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
||||||
|
let mut buf: [u8; 32] = [0; 32];
|
||||||
|
let ser_len = pus_tm
|
||||||
|
.write_to_bytes_no_crc(&mut buf)
|
||||||
|
.expect("Serialization failed");
|
||||||
|
assert_eq!(ser_len, 20);
|
||||||
|
assert_eq!(buf[20], 0);
|
||||||
|
assert_eq!(buf[21], 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -955,9 +1024,9 @@ mod tests {
|
|||||||
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
||||||
let tm_vec = pus_tm.to_vec().expect("Serialization failed");
|
let tm_vec = pus_tm.to_vec().expect("Serialization failed");
|
||||||
assert_eq!(tm_vec.len(), 22);
|
assert_eq!(tm_vec.len(), 22);
|
||||||
let (tm_deserialized, size) =
|
let tm_deserialized =
|
||||||
PusTmReader::new(tm_vec.as_slice(), 7).expect("Deserialization failed");
|
PusTmReader::new(tm_vec.as_slice(), 7).expect("Deserialization failed");
|
||||||
assert_eq!(tm_vec.len(), size);
|
assert_eq!(tm_vec.len(), tm_deserialized.total_len());
|
||||||
verify_ping_reply_with_reader(&tm_deserialized, false, 22, dummy_timestamp());
|
verify_ping_reply_with_reader(&tm_deserialized, false, 22, dummy_timestamp());
|
||||||
}
|
}
|
||||||
#[test]
|
#[test]
|
||||||
@ -969,13 +1038,32 @@ mod tests {
|
|||||||
.write_to_bytes(&mut buf)
|
.write_to_bytes(&mut buf)
|
||||||
.expect("Serialization failed");
|
.expect("Serialization failed");
|
||||||
assert_eq!(ser_len, 22);
|
assert_eq!(ser_len, 22);
|
||||||
let (tm_deserialized, size) = PusTmReader::new(&buf, 7).expect("Deserialization failed");
|
let tm_deserialized = PusTmReader::new(&buf, 7).expect("Deserialization failed");
|
||||||
assert_eq!(ser_len, size);
|
assert_eq!(ser_len, tm_deserialized.total_len());
|
||||||
assert_eq!(tm_deserialized.user_data(), tm_deserialized.source_data());
|
assert_eq!(tm_deserialized.user_data(), tm_deserialized.source_data());
|
||||||
assert_eq!(tm_deserialized.raw_data(), &buf[..ser_len]);
|
assert_eq!(tm_deserialized.raw_data(), &buf[..ser_len]);
|
||||||
assert_eq!(tm_deserialized.crc16().unwrap(), pus_tm.crc16().unwrap());
|
assert_eq!(tm_deserialized.crc16(), pus_tm.opt_crc16().unwrap());
|
||||||
verify_ping_reply_with_reader(&tm_deserialized, false, 22, dummy_timestamp());
|
verify_ping_reply_with_reader(&tm_deserialized, false, 22, dummy_timestamp());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_deserialization_no_table() {
|
||||||
|
let timestamp = dummy_timestamp();
|
||||||
|
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
||||||
|
let mut buf: [u8; 32] = [0; 32];
|
||||||
|
let ser_len = pus_tm
|
||||||
|
.write_to_bytes(&mut buf)
|
||||||
|
.expect("Serialization failed");
|
||||||
|
assert_eq!(ser_len, 22);
|
||||||
|
let tm_deserialized =
|
||||||
|
PusTmReader::new_crc_no_table(&buf, 7).expect("Deserialization failed");
|
||||||
|
assert_eq!(ser_len, tm_deserialized.total_len());
|
||||||
|
assert_eq!(tm_deserialized.user_data(), tm_deserialized.source_data());
|
||||||
|
assert_eq!(tm_deserialized.raw_data(), &buf[..ser_len]);
|
||||||
|
assert_eq!(tm_deserialized.crc16(), pus_tm.opt_crc16().unwrap());
|
||||||
|
verify_ping_reply_with_reader(&tm_deserialized, false, 22, dummy_timestamp());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_deserialization_faulty_crc() {
|
fn test_deserialization_faulty_crc() {
|
||||||
let timestamp = dummy_timestamp();
|
let timestamp = dummy_timestamp();
|
||||||
@ -1042,7 +1130,7 @@ mod tests {
|
|||||||
let res = pus_tm.append_to_vec(&mut vec);
|
let res = pus_tm.append_to_vec(&mut vec);
|
||||||
assert!(res.is_ok());
|
assert!(res.is_ok());
|
||||||
assert_eq!(res.unwrap(), 22);
|
assert_eq!(res.unwrap(), 22);
|
||||||
verify_raw_ping_reply(pus_tm.crc16().unwrap(), vec.as_slice());
|
verify_raw_ping_reply(pus_tm.opt_crc16().unwrap(), vec.as_slice());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -1111,7 +1199,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn verify_ping_reply_generic(
|
fn verify_ping_reply_generic(
|
||||||
tm: &(impl CcsdsPacket + GenericPusTmSecondaryHeader + PusPacket),
|
tm: &(impl GenericPusTmSecondaryHeader + PusPacket),
|
||||||
has_user_data: bool,
|
has_user_data: bool,
|
||||||
exp_full_len: usize,
|
exp_full_len: usize,
|
||||||
) {
|
) {
|
||||||
@ -1152,7 +1240,7 @@ mod tests {
|
|||||||
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
||||||
let mut buf = [0; 32];
|
let mut buf = [0; 32];
|
||||||
pus_tm.write_to_bytes(&mut buf).unwrap();
|
pus_tm.write_to_bytes(&mut buf).unwrap();
|
||||||
assert_eq!(pus_tm, PusTmReader::new(&buf, timestamp.len()).unwrap().0);
|
assert_eq!(pus_tm, PusTmReader::new(&buf, timestamp.len()).unwrap());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -1172,9 +1260,8 @@ mod tests {
|
|||||||
assert!(!writer.set_apid(MAX_SEQ_COUNT + 1));
|
assert!(!writer.set_apid(MAX_SEQ_COUNT + 1));
|
||||||
writer.finish();
|
writer.finish();
|
||||||
// This performs all necessary checks, including the CRC check.
|
// This performs all necessary checks, including the CRC check.
|
||||||
let (tm_read_back, tm_size_read_back) =
|
let tm_read_back = PusTmReader::new(&buf, 7).expect("Re-creating PUS TM failed");
|
||||||
PusTmReader::new(&buf, 7).expect("Re-creating PUS TM failed");
|
assert_eq!(tm_read_back.total_len(), tm_size);
|
||||||
assert_eq!(tm_size_read_back, tm_size);
|
|
||||||
assert_eq!(tm_read_back.msg_counter(), 100);
|
assert_eq!(tm_read_back.msg_counter(), 100);
|
||||||
assert_eq!(tm_read_back.dest_id(), 55);
|
assert_eq!(tm_read_back.dest_id(), 55);
|
||||||
assert_eq!(tm_read_back.seq_count(), MAX_SEQ_COUNT);
|
assert_eq!(tm_read_back.seq_count(), MAX_SEQ_COUNT);
|
||||||
@ -1222,7 +1309,7 @@ mod tests {
|
|||||||
assert_eq!(writer.sec_header_without_timestamp().msg_counter(), 100);
|
assert_eq!(writer.sec_header_without_timestamp().msg_counter(), 100);
|
||||||
assert_eq!(writer.user_data(), DUMMY_DATA);
|
assert_eq!(writer.user_data(), DUMMY_DATA);
|
||||||
// Need to check crc16 before finish, because finish will update the CRC.
|
// Need to check crc16 before finish, because finish will update the CRC.
|
||||||
let crc16 = writer.crc16();
|
let crc16 = writer.opt_crc16();
|
||||||
assert!(crc16.is_some());
|
assert!(crc16.is_some());
|
||||||
assert_eq!(crc16.unwrap(), crc16_raw);
|
assert_eq!(crc16.unwrap(), crc16_raw);
|
||||||
writer.finish();
|
writer.finish();
|
||||||
@ -1240,8 +1327,8 @@ mod tests {
|
|||||||
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
let pus_tm = base_ping_reply_full_ctor(timestamp);
|
||||||
let mut buf = [0; 32];
|
let mut buf = [0; 32];
|
||||||
pus_tm.write_to_bytes(&mut buf).unwrap();
|
pus_tm.write_to_bytes(&mut buf).unwrap();
|
||||||
let (tm_0, _) = PusTmReader::new(&buf, timestamp.len()).unwrap();
|
let tm_0 = PusTmReader::new(&buf, timestamp.len()).unwrap();
|
||||||
let (tm_1, _) = PusTmReader::new(&buf, timestamp.len()).unwrap();
|
let tm_1 = PusTmReader::new(&buf, timestamp.len()).unwrap();
|
||||||
assert_eq!(tm_0, tm_1);
|
assert_eq!(tm_0, tm_1);
|
||||||
}
|
}
|
||||||
#[test]
|
#[test]
|
||||||
@ -1313,7 +1400,7 @@ mod tests {
|
|||||||
PusTmCreator::new_simple(sph, 17, 2, &time_provider, &mut stamp_buf, &[], true)
|
PusTmCreator::new_simple(sph, 17, 2, &time_provider, &mut stamp_buf, &[], true)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
let pus_tm_vec = pus_tm.to_vec().unwrap();
|
let pus_tm_vec = pus_tm.to_vec().unwrap();
|
||||||
let (tm_reader, _) = PusTmReader::new(&pus_tm_vec, time_provider.len_as_bytes()).unwrap();
|
let tm_reader = PusTmReader::new(&pus_tm_vec, time_provider.len_as_bytes()).unwrap();
|
||||||
let output = to_allocvec(&tm_reader).unwrap();
|
let output = to_allocvec(&tm_reader).unwrap();
|
||||||
let output_converted_back: PusTmReader = from_bytes(&output).unwrap();
|
let output_converted_back: PusTmReader = from_bytes(&output).unwrap();
|
||||||
assert_eq!(output_converted_back, tm_reader);
|
assert_eq!(output_converted_back, tm_reader);
|
||||||
|
68
src/lib.rs
68
src/lib.rs
@ -26,8 +26,8 @@
|
|||||||
//!
|
//!
|
||||||
//! - [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
//! - [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
||||||
//! - [`alloc`](https://doc.rust-lang.org/alloc/): Enables features which operate on containers
|
//! - [`alloc`](https://doc.rust-lang.org/alloc/): Enables features which operate on containers
|
||||||
//! like [`alloc::vec::Vec`](https://doc.rust-lang.org/beta/alloc/vec/struct.Vec.html).
|
//! like [`alloc::vec::Vec`](https://doc.rust-lang.org/beta/alloc/vec/struct.Vec.html).
|
||||||
//! Enabled by the `std` feature.
|
//! Enabled by the `std` feature.
|
||||||
//!
|
//!
|
||||||
//! ### Optional features
|
//! ### Optional features
|
||||||
//!
|
//!
|
||||||
@ -61,21 +61,15 @@ extern crate alloc;
|
|||||||
#[cfg(any(feature = "std", test))]
|
#[cfg(any(feature = "std", test))]
|
||||||
extern crate std;
|
extern crate std;
|
||||||
|
|
||||||
use core::{
|
use core::{fmt::Debug, hash::Hash};
|
||||||
fmt::{Debug, Display, Formatter},
|
|
||||||
hash::Hash,
|
|
||||||
};
|
|
||||||
use crc::{Crc, CRC_16_IBM_3740};
|
|
||||||
use delegate::delegate;
|
use delegate::delegate;
|
||||||
use zerocopy::{FromBytes, IntoBytes};
|
use zerocopy::{FromBytes, IntoBytes};
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
use std::error::Error;
|
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
pub mod cfdp;
|
pub mod cfdp;
|
||||||
|
pub mod crc;
|
||||||
pub mod ecss;
|
pub mod ecss;
|
||||||
pub mod seq_count;
|
pub mod seq_count;
|
||||||
pub mod time;
|
pub mod time;
|
||||||
@ -87,62 +81,28 @@ mod private {
|
|||||||
|
|
||||||
pub const CCSDS_HEADER_LEN: usize = core::mem::size_of::<crate::zc::SpHeader>();
|
pub const CCSDS_HEADER_LEN: usize = core::mem::size_of::<crate::zc::SpHeader>();
|
||||||
|
|
||||||
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard.
|
|
||||||
pub const CRC_CCITT_FALSE: Crc<u16> = Crc::<u16>::new(&CRC_16_IBM_3740);
|
|
||||||
|
|
||||||
pub const MAX_APID: u16 = 2u16.pow(11) - 1;
|
pub const MAX_APID: u16 = 2u16.pow(11) - 1;
|
||||||
pub const MAX_SEQ_COUNT: u16 = 2u16.pow(14) - 1;
|
pub const MAX_SEQ_COUNT: u16 = 2u16.pow(14) - 1;
|
||||||
|
|
||||||
/// Generic error type when converting to and from raw byte slices.
|
/// Generic error type when converting to and from raw byte slices.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum ByteConversionError {
|
pub enum ByteConversionError {
|
||||||
/// The passed slice is too small. Returns the passed slice length and expected minimum size
|
/// The passed slice is too small. Returns the passed slice length and expected minimum size
|
||||||
ToSliceTooSmall {
|
#[error("target slice with size {found} is too small, expected size of at least {expected}")]
|
||||||
found: usize,
|
ToSliceTooSmall { found: usize, expected: usize },
|
||||||
expected: usize,
|
|
||||||
},
|
|
||||||
/// The provider buffer is too small. Returns the passed slice length and expected minimum size
|
/// The provider buffer is too small. Returns the passed slice length and expected minimum size
|
||||||
FromSliceTooSmall {
|
#[error("source slice with size {found} too small, expected at least {expected} bytes")]
|
||||||
found: usize,
|
FromSliceTooSmall { found: usize, expected: usize },
|
||||||
expected: usize,
|
|
||||||
},
|
|
||||||
/// The [zerocopy] library failed to write to bytes
|
/// The [zerocopy] library failed to write to bytes
|
||||||
|
#[error("zerocopy serialization error")]
|
||||||
ZeroCopyToError,
|
ZeroCopyToError,
|
||||||
|
/// The [zerocopy] library failed to read from bytes
|
||||||
|
#[error("zerocopy deserialization error")]
|
||||||
ZeroCopyFromError,
|
ZeroCopyFromError,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Display for ByteConversionError {
|
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
|
||||||
match self {
|
|
||||||
ByteConversionError::ToSliceTooSmall { found, expected } => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"target slice with size {} is too small, expected size of at least {}",
|
|
||||||
found, expected
|
|
||||||
)
|
|
||||||
}
|
|
||||||
ByteConversionError::FromSliceTooSmall { found, expected } => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"source slice with size {} too small, expected at least {} bytes",
|
|
||||||
found, expected
|
|
||||||
)
|
|
||||||
}
|
|
||||||
ByteConversionError::ZeroCopyToError => {
|
|
||||||
write!(f, "zerocopy serialization error")
|
|
||||||
}
|
|
||||||
ByteConversionError::ZeroCopyFromError => {
|
|
||||||
write!(f, "zerocopy deserialization error")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
impl Error for ByteConversionError {}
|
|
||||||
|
|
||||||
/// CCSDS packet type enumeration.
|
/// CCSDS packet type enumeration.
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
@ -489,9 +449,9 @@ pub trait CcsdsPrimaryHeader {
|
|||||||
/// # Arguments
|
/// # Arguments
|
||||||
///
|
///
|
||||||
/// * `version` - CCSDS version field, occupies the first 3 bits of the raw header. Will generally
|
/// * `version` - CCSDS version field, occupies the first 3 bits of the raw header. Will generally
|
||||||
/// be set to 0b000 in all constructors provided by this crate.
|
/// be set to 0b000 in all constructors provided by this crate.
|
||||||
/// * `packet_id` - Packet Identifier, which can also be used as a start marker. Occupies the last
|
/// * `packet_id` - Packet Identifier, which can also be used as a start marker. Occupies the last
|
||||||
/// 13 bits of the first two bytes of the raw header
|
/// 13 bits of the first two bytes of the raw header
|
||||||
/// * `psc` - Packet Sequence Control, occupies the third and fourth byte of the raw header
|
/// * `psc` - Packet Sequence Control, occupies the third and fourth byte of the raw header
|
||||||
/// * `data_len` - Data length field occupies the fifth and the sixth byte of the raw header
|
/// * `data_len` - Data length field occupies the fifth and the sixth byte of the raw header
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
|
@ -7,15 +7,13 @@
|
|||||||
use crate::private::Sealed;
|
use crate::private::Sealed;
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use core::cmp::Ordering;
|
use core::cmp::Ordering;
|
||||||
use core::fmt::{Debug, Display, Formatter};
|
use core::fmt::Debug;
|
||||||
use core::ops::{Add, AddAssign};
|
use core::ops::{Add, AddAssign};
|
||||||
use core::time::Duration;
|
use core::time::Duration;
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
use super::StdTimestampError;
|
use super::StdTimestampError;
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
use std::error::Error;
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
use std::time::{SystemTime, SystemTimeError};
|
use std::time::{SystemTime, SystemTimeError};
|
||||||
|
|
||||||
#[cfg(feature = "chrono")]
|
#[cfg(feature = "chrono")]
|
||||||
@ -91,49 +89,19 @@ pub enum SubmillisPrecision {
|
|||||||
Reserved = 0b11,
|
Reserved = 0b11,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone, thiserror::Error)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum CdsError {
|
pub enum CdsError {
|
||||||
/// CCSDS days value exceeds maximum allowed size or is negative
|
/// CCSDS days value exceeds maximum allowed size or is negative
|
||||||
|
#[error("invalid ccsds days {0}")]
|
||||||
InvalidCcsdsDays(i64),
|
InvalidCcsdsDays(i64),
|
||||||
/// There are distinct constructors depending on the days field width detected in the preamble
|
/// There are distinct constructors depending on the days field width detected in the preamble
|
||||||
/// field. This error will be returned if there is a missmatch.
|
/// field. This error will be returned if there is a missmatch.
|
||||||
|
#[error("wrong constructor for length of day {0:?} detected in preamble")]
|
||||||
InvalidCtorForDaysOfLenInPreamble(LengthOfDaySegment),
|
InvalidCtorForDaysOfLenInPreamble(LengthOfDaySegment),
|
||||||
DateBeforeCcsdsEpoch(DateBeforeCcsdsEpochError),
|
#[error("date before CCSDS epoch: {0}")]
|
||||||
}
|
DateBeforeCcsdsEpoch(#[from] DateBeforeCcsdsEpochError),
|
||||||
|
|
||||||
impl Display for CdsError {
|
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
|
||||||
match self {
|
|
||||||
CdsError::InvalidCcsdsDays(days) => {
|
|
||||||
write!(f, "invalid ccsds days {days}")
|
|
||||||
}
|
|
||||||
CdsError::InvalidCtorForDaysOfLenInPreamble(length_of_day) => {
|
|
||||||
write!(
|
|
||||||
f,
|
|
||||||
"wrong constructor for length of day {length_of_day:?} detected in preamble",
|
|
||||||
)
|
|
||||||
}
|
|
||||||
CdsError::DateBeforeCcsdsEpoch(e) => write!(f, "date before CCSDS epoch: {e}"),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
impl Error for CdsError {
|
|
||||||
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
||||||
match self {
|
|
||||||
CdsError::DateBeforeCcsdsEpoch(e) => Some(e),
|
|
||||||
_ => None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<DateBeforeCcsdsEpochError> for CdsError {
|
|
||||||
fn from(value: DateBeforeCcsdsEpochError) -> Self {
|
|
||||||
Self::DateBeforeCcsdsEpoch(value)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn length_of_day_segment_from_pfield(pfield: u8) -> LengthOfDaySegment {
|
pub fn length_of_day_segment_from_pfield(pfield: u8) -> LengthOfDaySegment {
|
||||||
@ -601,7 +569,7 @@ impl<ProvidesDaysLen: ProvidesDaysLength> CdsTime<ProvidesDaysLen> {
|
|||||||
));
|
));
|
||||||
}
|
}
|
||||||
let pfield = buf[0];
|
let pfield = buf[0];
|
||||||
match CcsdsTimeCode::try_from(pfield >> 4 & 0b111) {
|
match CcsdsTimeCode::try_from((pfield >> 4) & 0b111) {
|
||||||
Ok(cds_type) => match cds_type {
|
Ok(cds_type) => match cds_type {
|
||||||
CcsdsTimeCode::Cds => (),
|
CcsdsTimeCode::Cds => (),
|
||||||
_ => {
|
_ => {
|
||||||
@ -614,7 +582,7 @@ impl<ProvidesDaysLen: ProvidesDaysLength> CdsTime<ProvidesDaysLen> {
|
|||||||
_ => {
|
_ => {
|
||||||
return Err(TimestampError::InvalidTimeCode {
|
return Err(TimestampError::InvalidTimeCode {
|
||||||
expected: CcsdsTimeCode::Cds,
|
expected: CcsdsTimeCode::Cds,
|
||||||
found: pfield >> 4 & 0b111,
|
found: (pfield >> 4) & 0b111,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -63,20 +63,12 @@ pub fn ccsds_time_code_from_p_field(pfield: u8) -> Result<CcsdsTimeCode, u8> {
|
|||||||
CcsdsTimeCode::try_from(raw_bits).map_err(|_| raw_bits)
|
CcsdsTimeCode::try_from(raw_bits).map_err(|_| raw_bits)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone, thiserror::Error)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
#[error("date before ccsds epoch: {0:?}")]
|
||||||
pub struct DateBeforeCcsdsEpochError(UnixTime);
|
pub struct DateBeforeCcsdsEpochError(UnixTime);
|
||||||
|
|
||||||
impl Display for DateBeforeCcsdsEpochError {
|
|
||||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
|
||||||
write!(f, "date before ccsds epoch: {:?}", self.0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
impl Error for DateBeforeCcsdsEpochError {}
|
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
Reference in New Issue
Block a user