Compare commits
3 Commits
add-basic-
...
3edf13cca2
Author | SHA1 | Date | |
---|---|---|---|
3edf13cca2
|
|||
01168d8ab2
|
|||
1426cb514b
|
113
.github/workflows/ci.yml
vendored
113
.github/workflows/ci.yml
vendored
@ -1,39 +1,42 @@
|
|||||||
|
on: [push]
|
||||||
|
|
||||||
name: ci
|
name: ci
|
||||||
on: [push, pull_request]
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
check:
|
check:
|
||||||
name: Check build
|
name: Check
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: actions-rs/toolchain@v1
|
||||||
- run: cargo check --release
|
with:
|
||||||
|
profile: minimal
|
||||||
test:
|
toolchain: stable
|
||||||
name: Run Tests
|
- uses: actions-rs/cargo@v1
|
||||||
runs-on: ubuntu-latest
|
with:
|
||||||
steps:
|
command: check
|
||||||
- uses: actions/checkout@v4
|
args: --release
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
|
||||||
- name: Install nextest
|
|
||||||
uses: taiki-e/install-action@nextest
|
|
||||||
- run: cargo nextest run --all-features
|
|
||||||
- run: cargo test --doc
|
|
||||||
|
|
||||||
msrv:
|
msrv:
|
||||||
name: Check MSRV
|
name: Check with MSRV
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: dtolnay/rust-toolchain@1.70.0
|
- uses: actions-rs/toolchain@v1
|
||||||
- run: cargo check --release
|
with:
|
||||||
|
toolchain: 1.61.0
|
||||||
|
override: true
|
||||||
|
profile: minimal
|
||||||
|
- uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: check
|
||||||
|
args: --release
|
||||||
|
|
||||||
cross-check:
|
cross-check:
|
||||||
name: Check Cross-Compilation
|
name: Check Cross
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
@ -41,32 +44,70 @@ jobs:
|
|||||||
- armv7-unknown-linux-gnueabihf
|
- armv7-unknown-linux-gnueabihf
|
||||||
- thumbv7em-none-eabihf
|
- thumbv7em-none-eabihf
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: actions-rs/toolchain@v1
|
||||||
with:
|
with:
|
||||||
targets: "armv7-unknown-linux-gnueabihf, thumbv7em-none-eabihf"
|
profile: minimal
|
||||||
- run: cargo check --release --target=${{matrix.target}} --no-default-features
|
toolchain: stable
|
||||||
|
target: ${{ matrix.target }}
|
||||||
|
override: true
|
||||||
|
- uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
use-cross: true
|
||||||
|
command: check
|
||||||
|
args: --release --target=${{ matrix.target }} --no-default-features
|
||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
name: Check formatting
|
name: Rustfmt
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: actions-rs/toolchain@v1
|
||||||
- run: cargo fmt --all -- --check
|
with:
|
||||||
|
profile: minimal
|
||||||
|
toolchain: stable
|
||||||
|
override: true
|
||||||
|
- run: rustup component add rustfmt
|
||||||
|
- uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: fmt
|
||||||
|
args: --all -- --check
|
||||||
|
|
||||||
docs:
|
check-doc:
|
||||||
name: Check Documentation Build
|
name: Check Documentation Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: dtolnay/rust-toolchain@nightly
|
- uses: actions-rs/toolchain@v1
|
||||||
- run: RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features
|
with:
|
||||||
|
toolchain: nightly
|
||||||
|
override: true
|
||||||
|
profile: minimal
|
||||||
|
- uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: doc
|
||||||
|
args: --all-features
|
||||||
|
|
||||||
clippy:
|
clippy:
|
||||||
name: Clippy
|
name: Clippy
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v2
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: actions-rs/toolchain@v1
|
||||||
- run: cargo clippy -- -D warnings
|
with:
|
||||||
|
profile: minimal
|
||||||
|
toolchain: stable
|
||||||
|
- run: rustup component add clippy
|
||||||
|
- uses: actions-rs/cargo@v1
|
||||||
|
with:
|
||||||
|
command: clippy
|
||||||
|
args: -- -D warnings
|
||||||
|
|
||||||
|
ci:
|
||||||
|
if: ${{ success() }}
|
||||||
|
# all new jobs must be added to this list
|
||||||
|
needs: [check, fmt, clippy]
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: CI succeeded
|
||||||
|
run: exit 0
|
||||||
|
136
CHANGELOG.md
136
CHANGELOG.md
@ -8,131 +8,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|||||||
|
|
||||||
# [unreleased]
|
# [unreleased]
|
||||||
|
|
||||||
## Added
|
|
||||||
|
|
||||||
- `PusTcCreatorWithReservedAppData` and `PusTmCreatorWithReservedSourceData` constructor variants
|
|
||||||
which allow writing source/app data into the serialization buffer directly without
|
|
||||||
requiring an extra buffer.
|
|
||||||
|
|
||||||
# [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
|
|
||||||
- Bump `zerocopy` to v0.8.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
|
|
||||||
|
|
||||||
- Bumped MSRV to 1.70.0
|
|
||||||
|
|
||||||
## Added
|
|
||||||
|
|
||||||
- Added new `cfdp::tlv::TlvOwned` type which erases the lifetime and is clonable.
|
|
||||||
- Dedicated `cfdp::tlv::TlvLvDataTooLarge` error struct for APIs where this is the only possible
|
|
||||||
API error.
|
|
||||||
- Added File Data PDU API which expects the expected file data size and then exposes the unwritten
|
|
||||||
file data field as a mutable slice. This allows to read data from the virtual file system
|
|
||||||
API to the file data buffer without an intermediate buffer.
|
|
||||||
- Generic `EofPdu::new` constructor.
|
|
||||||
- Added generic sequence counter module.
|
|
||||||
- Added `MsgToUserTlv::to_tlv` converter which reduced the type and converts
|
|
||||||
it to a generic `Tlv`.
|
|
||||||
- Implemented `From<MsgToUserTlv> for Tlv` converter trait.
|
|
||||||
- Added CFDP maximum file segment length calculator method `calculate_max_file_seg_len_for_max_packet_len_and_pdu_header`
|
|
||||||
|
|
||||||
## Added and Changed
|
|
||||||
|
|
||||||
- Added new `ReadableTlv` to avoid some boilerplate code and have a common abstraction implemented
|
|
||||||
for both `Tlv` and `TlvOwned` to read the raw TLV data field and its length.
|
|
||||||
- Replaced `cfdp::tlv::TlvLvError` by `cfdp::tlv::TlvLvDataTooLarge` where applicable.
|
|
||||||
|
|
||||||
## Fixed
|
|
||||||
|
|
||||||
- Fixed an error in the EOF writer which wrote the fault location to the wrong buffer position.
|
|
||||||
- cfdp `ConditionCode::CheckLimitReached` previous had the wrong numerical value of `0b1001` (9)
|
|
||||||
and now has the correct value of `0b1010` (10).
|
|
||||||
|
|
||||||
## Changed
|
|
||||||
|
|
||||||
- Minor documentation build updates.
|
|
||||||
- Increased delegate version range to v0.13
|
|
||||||
|
|
||||||
# [v0.11.2] 2024-05-19
|
|
||||||
|
|
||||||
- Bumped MSRV to 1.68.2
|
|
||||||
|
|
||||||
## Fixed
|
|
||||||
|
|
||||||
- Removed `defmt::Format` impl for `MetadataPduCreator` which seems to be problematic.
|
|
||||||
|
|
||||||
# [v0.11.1] 2024-04-22
|
|
||||||
|
|
||||||
## Fixed
|
|
||||||
|
|
||||||
- The default data length for for `SpHeader` constructors where the data field length is not
|
|
||||||
specified is now 0.
|
|
||||||
- The `SpHeader::new_from_fields` is public now.
|
|
||||||
|
|
||||||
## Added
|
|
||||||
|
|
||||||
- `SpHeader::to_vec` method.
|
|
||||||
|
|
||||||
# [v0.11.0] 2024-04-16
|
|
||||||
|
|
||||||
## Changed
|
|
||||||
|
|
||||||
- Moved `CCSDS_HEADER_LEN` constant to the crate root.
|
|
||||||
|
|
||||||
## Added
|
|
||||||
|
|
||||||
- Added `SpacePacketHeader` type alias for `SpHeader` type.
|
|
||||||
|
|
||||||
# [v0.11.0-rc.2] 2024-04-04
|
|
||||||
|
|
||||||
## Changed
|
|
||||||
|
|
||||||
- Renamed `PacketId` and `PacketSequenceCtrl` `new` method to `new_checked` and former
|
|
||||||
`new_const` method to `new`.
|
|
||||||
- Renamed `tc`, `tm`, `tc_unseg` and `tm_unseg` variants for `PacketId` and `SpHeader`
|
|
||||||
to `new_for_tc_checked`, `new_for_tm_checked`, `new_for_unseg_tc_checked` and
|
|
||||||
`new_for_unseg_tm_checked`.
|
|
||||||
- `PusTmCreator` and `PusTcCreator` now expect a regular instance of `SpHeader` instead of
|
|
||||||
a mutable reference.
|
|
||||||
|
|
||||||
## Added
|
|
||||||
|
|
||||||
- `SpHeader::new_from_apid` and `SpHeader::new_from_apid_checked` constructor.
|
|
||||||
- `#[inline]` attribute for a lot of small functions.
|
|
||||||
|
|
||||||
# [v0.11.0-rc.1] 2024-04-03
|
|
||||||
|
|
||||||
Major API changes for the time API. If you are using the time API, it is strongly recommended
|
Major API changes for the time API. If you are using the time API, it is strongly recommended
|
||||||
to check all the API changes in the **Changed** chapter.
|
to check all the API changes in the **Changed** chapter.
|
||||||
|
|
||||||
@ -149,14 +24,9 @@ to check all the API changes in the **Changed** chapter.
|
|||||||
- Added basic support conversions to the `time` library. Introduce new `chrono` and `timelib`
|
- Added basic support conversions to the `time` library. Introduce new `chrono` and `timelib`
|
||||||
feature gate.
|
feature gate.
|
||||||
- Added `CcsdsTimeProvider::timelib_date_time`.
|
- Added `CcsdsTimeProvider::timelib_date_time`.
|
||||||
- Optional support for `defmt` by adding optional `defmt::Format` derives for common types.
|
|
||||||
|
|
||||||
## Changed
|
## Changed
|
||||||
|
|
||||||
- `PusTcCreator::new_simple` now expects a valid slice for the source data instead of an optional
|
|
||||||
slice. For telecommands without application data, `&[]` can be passed.
|
|
||||||
- `PusTmSecondaryHeader` constructors now expects a valid slice for the time stamp instead of an
|
|
||||||
optional slice.
|
|
||||||
- Renamed `CcsdsTimeProvider::date_time` to `CcsdsTimeProvider::chrono_date_time`
|
- Renamed `CcsdsTimeProvider::date_time` to `CcsdsTimeProvider::chrono_date_time`
|
||||||
- Renamed `CcsdsTimeCodes` to `CcsdsTimeCode`
|
- Renamed `CcsdsTimeCodes` to `CcsdsTimeCode`
|
||||||
- Renamed `cds::TimeProvider` to `cds::CdsTime`
|
- Renamed `cds::TimeProvider` to `cds::CdsTime`
|
||||||
@ -590,9 +460,3 @@ 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
|
|
||||||
|
65
Cargo.toml
65
Cargo.toml
@ -1,8 +1,8 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "spacepackets"
|
name = "spacepackets"
|
||||||
version = "0.14.0"
|
version = "0.11.0-rc.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.70.0"
|
rust-version = "1.61"
|
||||||
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,30 +13,53 @@ 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.3"
|
crc = "3"
|
||||||
delegate = ">=0.8, <=0.13"
|
delegate = ">=0.8, <0.11"
|
||||||
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"] }
|
|
||||||
|
|
||||||
time = { version = "0.3", default-features = false, optional = true }
|
[dependencies.zerocopy]
|
||||||
chrono = { version = "0.4", default-features = false, optional = true }
|
version = "0.7"
|
||||||
defmt = { version = "1", default-features = false, optional = true }
|
features = ["derive"]
|
||||||
|
|
||||||
|
[dependencies.thiserror]
|
||||||
|
version = "1"
|
||||||
|
optional = true
|
||||||
|
|
||||||
|
[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
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
postcard = "1"
|
||||||
|
chrono = "0.4"
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = ["std"]
|
default = ["std"]
|
||||||
std = ["alloc", "chrono/std", "chrono/clock", "thiserror/std"]
|
std = ["chrono/std", "chrono/clock", "alloc", "thiserror"]
|
||||||
serde = ["dep:serde", "chrono?/serde"]
|
serde = ["dep:serde", "chrono/serde"]
|
||||||
alloc = ["chrono?/alloc", "defmt?/alloc", "serde?/alloc"]
|
alloc = ["postcard/alloc", "chrono/alloc"]
|
||||||
|
chrono = ["dep:chrono"]
|
||||||
timelib = ["dep:time"]
|
timelib = ["dep:time"]
|
||||||
|
|
||||||
[dev-dependencies]
|
|
||||||
postcard = { version = "1", features = ["alloc"] }
|
|
||||||
chrono = "0.4"
|
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
[package.metadata.docs.rs]
|
||||||
all-features = true
|
all-features = true
|
||||||
rustdoc-args = ["--generate-link-to-definition"]
|
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
|
||||||
|
@ -1 +0,0 @@
|
|||||||
github: robamu
|
|
17
README.md
17
README.md
@ -1,6 +1,7 @@
|
|||||||
[](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
|
||||||
======
|
======
|
||||||
@ -28,6 +29,10 @@ Currently, this includes the following components:
|
|||||||
|
|
||||||
`spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
`spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
||||||
|
|
||||||
|
It also offers optional support for [`serde`](https://serde.rs/). This allows serializing and
|
||||||
|
deserializing them with an appropriate `serde` provider like
|
||||||
|
[`postcard`](https://github.com/jamesmunns/postcard).
|
||||||
|
|
||||||
## Default features
|
## Default features
|
||||||
|
|
||||||
- [`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.
|
||||||
@ -40,8 +45,6 @@ Currently, this includes the following components:
|
|||||||
- [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and `Deserialize` `derive`s
|
- [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and `Deserialize` `derive`s
|
||||||
- [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
|
- [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
|
||||||
- [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
|
- [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
|
||||||
- [`defmt`](https://defmt.ferrous-systems.com/): Add support for the `defmt` by adding the
|
|
||||||
[`defmt::Format`](https://defmt.ferrous-systems.com/format) derive on many types.
|
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
@ -60,13 +63,3 @@ cargo install grcov --locked
|
|||||||
|
|
||||||
After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
|
After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
|
||||||
supply the `--open` flag to open the coverage report in your webbrowser.
|
supply the `--open` flag to open the coverage report in your webbrowser.
|
||||||
|
|
||||||
# Miri
|
|
||||||
|
|
||||||
You can run the [`miri`](https://github.com/rust-lang/miri) tool on this library to check for
|
|
||||||
undefined behaviour (UB). This library does not use use any `unsafe` code blocks, but `miri` could
|
|
||||||
still catch UB from used libraries.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
cargo +nightly miri nextest run --all-features
|
|
||||||
```
|
|
||||||
|
@ -15,10 +15,7 @@ RUN rustup install nightly && \
|
|||||||
rustup target add thumbv7em-none-eabihf armv7-unknown-linux-gnueabihf && \
|
rustup target add thumbv7em-none-eabihf armv7-unknown-linux-gnueabihf && \
|
||||||
rustup component add rustfmt clippy llvm-tools-preview
|
rustup component add rustfmt clippy llvm-tools-preview
|
||||||
|
|
||||||
# Get grcov
|
|
||||||
RUN curl -sSL https://github.com/mozilla/grcov/releases/download/v0.8.19/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar -xj --directory /usr/local/bin
|
RUN curl -sSL https://github.com/mozilla/grcov/releases/download/v0.8.19/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar -xj --directory /usr/local/bin
|
||||||
# Get nextest
|
|
||||||
RUN curl -LsSf https://get.nexte.st/latest/linux | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
|
|
||||||
|
|
||||||
# SSH stuff to allow deployment to doc server
|
# SSH stuff to allow deployment to doc server
|
||||||
RUN adduser --uid 114 jenkins
|
RUN adduser --uid 114 jenkins
|
||||||
|
7
automation/Jenkinsfile
vendored
7
automation/Jenkinsfile
vendored
@ -21,9 +21,7 @@ pipeline {
|
|||||||
}
|
}
|
||||||
stage('Docs') {
|
stage('Docs') {
|
||||||
steps {
|
steps {
|
||||||
sh """
|
sh 'cargo +nightly doc --all-features'
|
||||||
RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features
|
|
||||||
"""
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
stage('Rustfmt') {
|
stage('Rustfmt') {
|
||||||
@ -33,8 +31,7 @@ pipeline {
|
|||||||
}
|
}
|
||||||
stage('Test') {
|
stage('Test') {
|
||||||
steps {
|
steps {
|
||||||
sh 'cargo nextest r --all-features'
|
sh 'cargo test --all-features'
|
||||||
sh 'cargo test --doc'
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
stage('Check with all features') {
|
stage('Check with all features') {
|
||||||
|
3
docs.sh
3
docs.sh
@ -1,3 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
export RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options"
|
|
||||||
cargo +nightly doc --all-features --open
|
|
@ -4,14 +4,11 @@ Checklist for new releases
|
|||||||
# Pre-Release
|
# Pre-Release
|
||||||
|
|
||||||
1. Make sure any new modules are documented sufficiently enough and check docs with
|
1. Make sure any new modules are documented sufficiently enough and check docs with
|
||||||
`RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features --open`
|
`cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docsrs"]' --open`.
|
||||||
or `cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docsrs" --generate-link-to-definition"]' --open`
|
|
||||||
(was problematic on more recent nightly versions).
|
|
||||||
2. Bump version specifier in `Cargo.toml`.
|
2. Bump version specifier in `Cargo.toml`.
|
||||||
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
|
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
|
||||||
`unreleased` section.
|
`unreleased` section.
|
||||||
4. Run `cargo test --all-features` or `cargo nextest r --all-features` together with
|
4. Run `cargo test --all-features`.
|
||||||
`cargo test --doc`.
|
|
||||||
5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
|
5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
|
||||||
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
|
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
|
||||||
targets.
|
targets.
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
//! Generic CFDP length-value (LV) abstraction as specified in CFDP 5.1.8.
|
//! Generic CFDP length-value (LV) abstraction as specified in CFDP 5.1.8.
|
||||||
|
use crate::cfdp::TlvLvError;
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use core::str::Utf8Error;
|
use core::str::Utf8Error;
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
@ -6,8 +7,6 @@ use serde::{Deserialize, Serialize};
|
|||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
use std::string::String;
|
use std::string::String;
|
||||||
|
|
||||||
use super::TlvLvDataTooLargeError;
|
|
||||||
|
|
||||||
pub const MIN_LV_LEN: usize = 1;
|
pub const MIN_LV_LEN: usize = 1;
|
||||||
|
|
||||||
/// Generic CFDP length-value (LV) abstraction as specified in CFDP 5.1.8.
|
/// Generic CFDP length-value (LV) abstraction as specified in CFDP 5.1.8.
|
||||||
@ -21,7 +20,6 @@ pub const MIN_LV_LEN: usize = 1;
|
|||||||
/// this will be the lifetime of that data reference.
|
/// this will be the lifetime of that data reference.
|
||||||
#[derive(Debug, Copy, Clone, Eq)]
|
#[derive(Debug, Copy, Clone, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct Lv<'data> {
|
pub struct Lv<'data> {
|
||||||
data: &'data [u8],
|
data: &'data [u8],
|
||||||
// If the LV was generated from a raw bytestream, this will contain the start of the
|
// If the LV was generated from a raw bytestream, this will contain the start of the
|
||||||
@ -63,10 +61,9 @@ pub(crate) fn generic_len_check_deserialization(
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<'data> Lv<'data> {
|
impl<'data> Lv<'data> {
|
||||||
#[inline]
|
pub fn new(data: &[u8]) -> Result<Lv, TlvLvError> {
|
||||||
pub fn new(data: &[u8]) -> Result<Lv, TlvLvDataTooLargeError> {
|
|
||||||
if data.len() > u8::MAX as usize {
|
if data.len() > u8::MAX as usize {
|
||||||
return Err(TlvLvDataTooLargeError(data.len()));
|
return Err(TlvLvError::DataTooLarge(data.len()));
|
||||||
}
|
}
|
||||||
Ok(Lv {
|
Ok(Lv {
|
||||||
data,
|
data,
|
||||||
@ -75,7 +72,6 @@ impl<'data> Lv<'data> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Creates a LV with an empty value field.
|
/// Creates a LV with an empty value field.
|
||||||
#[inline]
|
|
||||||
pub fn new_empty() -> Lv<'data> {
|
pub fn new_empty() -> Lv<'data> {
|
||||||
Lv {
|
Lv {
|
||||||
data: &[],
|
data: &[],
|
||||||
@ -85,52 +81,44 @@ 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]
|
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvError> {
|
||||||
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvDataTooLargeError> {
|
|
||||||
Self::new(str_slice.as_bytes())
|
Self::new(str_slice.as_bytes())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// 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
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
#[inline]
|
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvError> {
|
||||||
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvDataTooLargeError> {
|
|
||||||
Self::new(string.as_bytes())
|
Self::new(string.as_bytes())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the length of the value part, not including the length byte.
|
/// Returns the length of the value part, not including the length byte.
|
||||||
#[inline]
|
|
||||||
pub fn len_value(&self) -> usize {
|
pub fn len_value(&self) -> usize {
|
||||||
self.data.len()
|
self.data.len()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the full raw length, including the length byte.
|
/// Returns the full raw length, including the length byte.
|
||||||
#[inline]
|
|
||||||
pub fn len_full(&self) -> usize {
|
pub fn len_full(&self) -> usize {
|
||||||
self.len_value() + 1
|
self.len_value() + 1
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Checks whether the value field is empty.
|
/// Checks whether the value field is empty.
|
||||||
#[inline]
|
|
||||||
pub fn is_empty(&self) -> bool {
|
pub fn is_empty(&self) -> bool {
|
||||||
self.data.len() == 0
|
self.data.len() == 0
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn value(&self) -> &[u8] {
|
pub fn value(&self) -> &[u8] {
|
||||||
self.data
|
self.data
|
||||||
}
|
}
|
||||||
|
|
||||||
/// If the LV was generated from a raw bytestream using [Self::from_bytes], the raw start
|
/// If the LV was generated from a raw bytestream using [Self::from_bytes], the raw start
|
||||||
/// of the LV can be retrieved with this method.
|
/// of the LV can be retrieved with this method.
|
||||||
#[inline]
|
|
||||||
pub fn raw_data(&self) -> Option<&[u8]> {
|
pub fn raw_data(&self) -> Option<&[u8]> {
|
||||||
self.raw_data
|
self.raw_data
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Convenience function to extract the value as a [str]. This is useful if the LV is
|
/// Convenience function to extract the value as a [str]. This is useful if the LV is
|
||||||
/// known to contain a [str], for example being a file name.
|
/// known to contain a [str], for example being a file name.
|
||||||
#[inline]
|
|
||||||
pub fn value_as_str(&self) -> Option<Result<&'data str, Utf8Error>> {
|
pub fn value_as_str(&self) -> Option<Result<&'data str, Utf8Error>> {
|
||||||
if self.is_empty() {
|
if self.is_empty() {
|
||||||
return None;
|
return None;
|
||||||
@ -146,7 +134,6 @@ impl<'data> Lv<'data> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Reads a LV from a raw buffer.
|
/// Reads a LV from a raw buffer.
|
||||||
#[inline]
|
|
||||||
pub fn from_bytes(buf: &'data [u8]) -> Result<Lv<'data>, ByteConversionError> {
|
pub fn from_bytes(buf: &'data [u8]) -> Result<Lv<'data>, ByteConversionError> {
|
||||||
generic_len_check_deserialization(buf, MIN_LV_LEN)?;
|
generic_len_check_deserialization(buf, MIN_LV_LEN)?;
|
||||||
Self::from_be_bytes_no_len_check(buf)
|
Self::from_be_bytes_no_len_check(buf)
|
||||||
@ -163,7 +150,6 @@ impl<'data> Lv<'data> {
|
|||||||
MIN_LV_LEN + self.data.len()
|
MIN_LV_LEN + self.data.len()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub(crate) fn from_be_bytes_no_len_check(
|
pub(crate) fn from_be_bytes_no_len_check(
|
||||||
buf: &'data [u8],
|
buf: &'data [u8],
|
||||||
) -> Result<Lv<'data>, ByteConversionError> {
|
) -> Result<Lv<'data>, ByteConversionError> {
|
||||||
@ -178,10 +164,10 @@ impl<'data> Lv<'data> {
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
pub mod tests {
|
pub mod tests {
|
||||||
|
use super::*;
|
||||||
use alloc::string::ToString;
|
use alloc::string::ToString;
|
||||||
|
|
||||||
use super::*;
|
use crate::cfdp::TlvLvError;
|
||||||
|
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use std::string::String;
|
use std::string::String;
|
||||||
|
|
||||||
@ -272,11 +258,15 @@ pub mod tests {
|
|||||||
let lv = Lv::new(&data_big);
|
let lv = Lv::new(&data_big);
|
||||||
assert!(lv.is_err());
|
assert!(lv.is_err());
|
||||||
let error = lv.unwrap_err();
|
let error = lv.unwrap_err();
|
||||||
assert_eq!(error.0, u8::MAX as usize + 1);
|
if let TlvLvError::DataTooLarge(size) = error {
|
||||||
assert_eq!(
|
assert_eq!(size, u8::MAX as usize + 1);
|
||||||
error.to_string(),
|
assert_eq!(
|
||||||
"data with size 256 larger than allowed 255 bytes"
|
error.to_string(),
|
||||||
);
|
"data with size 256 larger than allowed 255 bytes"
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
panic!("invalid exception {:?}", error)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
102
src/cfdp/mod.rs
102
src/cfdp/mod.rs
@ -1,8 +1,11 @@
|
|||||||
//! 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;
|
||||||
@ -15,7 +18,6 @@ pub const CFDP_VERSION_2: u8 = 0b001;
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum PduType {
|
pub enum PduType {
|
||||||
FileDirective = 0,
|
FileDirective = 0,
|
||||||
@ -24,7 +26,6 @@ pub enum PduType {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum Direction {
|
pub enum Direction {
|
||||||
TowardsReceiver = 0,
|
TowardsReceiver = 0,
|
||||||
@ -33,7 +34,6 @@ pub enum Direction {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum TransmissionMode {
|
pub enum TransmissionMode {
|
||||||
Acknowledged = 0,
|
Acknowledged = 0,
|
||||||
@ -42,7 +42,6 @@ pub enum TransmissionMode {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum CrcFlag {
|
pub enum CrcFlag {
|
||||||
NoCrc = 0,
|
NoCrc = 0,
|
||||||
@ -70,7 +69,6 @@ impl From<CrcFlag> for bool {
|
|||||||
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum SegmentMetadataFlag {
|
pub enum SegmentMetadataFlag {
|
||||||
NotPresent = 0,
|
NotPresent = 0,
|
||||||
@ -80,7 +78,6 @@ pub enum SegmentMetadataFlag {
|
|||||||
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum SegmentationControl {
|
pub enum SegmentationControl {
|
||||||
NoRecordBoundaryPreservation = 0,
|
NoRecordBoundaryPreservation = 0,
|
||||||
@ -89,7 +86,6 @@ pub enum SegmentationControl {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FaultHandlerCode {
|
pub enum FaultHandlerCode {
|
||||||
NoticeOfCancellation = 0b0001,
|
NoticeOfCancellation = 0b0001,
|
||||||
@ -100,7 +96,6 @@ pub enum FaultHandlerCode {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum ConditionCode {
|
pub enum ConditionCode {
|
||||||
/// This is not an error condition for which a faulty handler override can be specified
|
/// This is not an error condition for which a faulty handler override can be specified
|
||||||
@ -113,7 +108,7 @@ pub enum ConditionCode {
|
|||||||
FileSizeError = 0b0110,
|
FileSizeError = 0b0110,
|
||||||
NakLimitReached = 0b0111,
|
NakLimitReached = 0b0111,
|
||||||
InactivityDetected = 0b1000,
|
InactivityDetected = 0b1000,
|
||||||
CheckLimitReached = 0b1010,
|
CheckLimitReached = 0b1001,
|
||||||
UnsupportedChecksumType = 0b1011,
|
UnsupportedChecksumType = 0b1011,
|
||||||
/// Not an actual fault condition for which fault handler overrides can be specified
|
/// Not an actual fault condition for which fault handler overrides can be specified
|
||||||
SuspendRequestReceived = 0b1110,
|
SuspendRequestReceived = 0b1110,
|
||||||
@ -123,7 +118,6 @@ pub enum ConditionCode {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum LargeFileFlag {
|
pub enum LargeFileFlag {
|
||||||
/// 32 bit maximum file size and FSS size
|
/// 32 bit maximum file size and FSS size
|
||||||
@ -135,7 +129,6 @@ pub enum LargeFileFlag {
|
|||||||
/// Transaction status for the ACK PDU field according to chapter 5.2.4 of the CFDP standard.
|
/// Transaction status for the ACK PDU field according to chapter 5.2.4 of the CFDP standard.
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum TransactionStatus {
|
pub enum TransactionStatus {
|
||||||
/// Transaction is not currently active and the CFDP implementation does not retain a
|
/// Transaction is not currently active and the CFDP implementation does not retain a
|
||||||
@ -153,7 +146,6 @@ pub enum TransactionStatus {
|
|||||||
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/)
|
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/)
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum ChecksumType {
|
pub enum ChecksumType {
|
||||||
/// Modular legacy checksum
|
/// Modular legacy checksum
|
||||||
@ -173,43 +165,75 @@ 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, thiserror::Error)]
|
#[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))]
|
|
||||||
#[error("data with size {0} larger than allowed {max} bytes", max = u8::MAX)]
|
|
||||||
pub struct TlvLvDataTooLargeError(pub usize);
|
|
||||||
|
|
||||||
/// First value: Found value. Second value: Expected value if there is one.
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[error("invalid TLV type field, found {found}, expected {expected:?}")]
|
|
||||||
pub struct InvalidTlvTypeFieldError {
|
|
||||||
found: u8,
|
|
||||||
expected: Option<u8>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub enum TlvLvError {
|
pub enum TlvLvError {
|
||||||
#[error("{0}")]
|
DataTooLarge(usize),
|
||||||
DataTooLarge(#[from] TlvLvDataTooLargeError),
|
ByteConversion(ByteConversionError),
|
||||||
#[error("byte conversion error: {0}")]
|
/// First value: Found value. Second value: Expected value if there is one.
|
||||||
ByteConversion(#[from] ByteConversionError),
|
InvalidTlvTypeField {
|
||||||
#[error("{0}")]
|
found: u8,
|
||||||
InvalidTlvTypeField(#[from] InvalidTlvTypeFieldError),
|
expected: Option<u8>,
|
||||||
#[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<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(data_len) => {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"data with size {} larger than allowed {} bytes",
|
||||||
|
data_len,
|
||||||
|
u8::MAX
|
||||||
|
)
|
||||||
|
}
|
||||||
|
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::ByteConversion(e) => Some(e),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
@ -15,7 +15,6 @@ use serde::{Deserialize, Serialize};
|
|||||||
/// For more information, refer to CFDP chapter 5.2.4.
|
/// For more information, refer to CFDP chapter 5.2.4.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct AckPdu {
|
pub struct AckPdu {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
directive_code_of_acked_pdu: FileDirectiveType,
|
directive_code_of_acked_pdu: FileDirectiveType,
|
||||||
|
@ -15,7 +15,6 @@ use super::{CfdpPdu, WritablePduPacket};
|
|||||||
/// For more information, refer to CFDP chapter 5.2.2.
|
/// For more information, refer to CFDP chapter 5.2.2.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct EofPdu {
|
pub struct EofPdu {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
condition_code: ConditionCode,
|
condition_code: ConditionCode,
|
||||||
@ -25,36 +24,20 @@ pub struct EofPdu {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl EofPdu {
|
impl EofPdu {
|
||||||
pub fn new(
|
pub fn new_no_error(mut pdu_header: PduHeader, file_checksum: u32, file_size: u64) -> Self {
|
||||||
mut pdu_header: PduHeader,
|
|
||||||
condition_code: ConditionCode,
|
|
||||||
file_checksum: u32,
|
|
||||||
file_size: u64,
|
|
||||||
fault_location: Option<EntityIdTlv>,
|
|
||||||
) -> Self {
|
|
||||||
// Force correct direction flag.
|
// Force correct direction flag.
|
||||||
pdu_header.pdu_conf.direction = Direction::TowardsReceiver;
|
pdu_header.pdu_conf.direction = Direction::TowardsReceiver;
|
||||||
let mut eof_pdu = Self {
|
let mut eof_pdu = Self {
|
||||||
pdu_header,
|
pdu_header,
|
||||||
condition_code,
|
condition_code: ConditionCode::NoError,
|
||||||
file_checksum,
|
file_checksum,
|
||||||
file_size,
|
file_size,
|
||||||
fault_location,
|
fault_location: None,
|
||||||
};
|
};
|
||||||
eof_pdu.pdu_header.pdu_datafield_len = eof_pdu.calc_pdu_datafield_len() as u16;
|
eof_pdu.pdu_header.pdu_datafield_len = eof_pdu.calc_pdu_datafield_len() as u16;
|
||||||
eof_pdu
|
eof_pdu
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new_no_error(pdu_header: PduHeader, file_checksum: u32, file_size: u64) -> Self {
|
|
||||||
Self::new(
|
|
||||||
pdu_header,
|
|
||||||
ConditionCode::NoError,
|
|
||||||
file_checksum,
|
|
||||||
file_size,
|
|
||||||
None,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn pdu_header(&self) -> &PduHeader {
|
pub fn pdu_header(&self) -> &PduHeader {
|
||||||
&self.pdu_header
|
&self.pdu_header
|
||||||
}
|
}
|
||||||
@ -164,7 +147,7 @@ impl WritablePduPacket for EofPdu {
|
|||||||
&mut buf[current_idx..],
|
&mut buf[current_idx..],
|
||||||
)?;
|
)?;
|
||||||
if let Some(fault_location) = self.fault_location {
|
if let Some(fault_location) = self.fault_location {
|
||||||
current_idx += fault_location.write_to_bytes(&mut buf[current_idx..])?;
|
current_idx += fault_location.write_to_bytes(buf)?;
|
||||||
}
|
}
|
||||||
if self.crc_flag() == CrcFlag::WithCrc {
|
if self.crc_flag() == CrcFlag::WithCrc {
|
||||||
current_idx = add_pdu_crc(buf, current_idx);
|
current_idx = add_pdu_crc(buf, current_idx);
|
||||||
@ -187,23 +170,13 @@ mod tests {
|
|||||||
use crate::cfdp::{ConditionCode, CrcFlag, LargeFileFlag, PduType, TransmissionMode};
|
use crate::cfdp::{ConditionCode, CrcFlag, LargeFileFlag, PduType, TransmissionMode};
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use crate::tests::generic_serde_test;
|
use crate::tests::generic_serde_test;
|
||||||
use crate::util::{UnsignedByteFieldU16, UnsignedEnum};
|
|
||||||
|
|
||||||
fn verify_state_no_error_no_crc(eof_pdu: &EofPdu, file_flag: LargeFileFlag) {
|
fn verify_state(&eof_pdu: &EofPdu, file_flag: LargeFileFlag) {
|
||||||
verify_state(eof_pdu, CrcFlag::NoCrc, file_flag, ConditionCode::NoError);
|
|
||||||
}
|
|
||||||
|
|
||||||
fn verify_state(
|
|
||||||
eof_pdu: &EofPdu,
|
|
||||||
crc_flag: CrcFlag,
|
|
||||||
file_flag: LargeFileFlag,
|
|
||||||
cond_code: ConditionCode,
|
|
||||||
) {
|
|
||||||
assert_eq!(eof_pdu.file_checksum(), 0x01020304);
|
assert_eq!(eof_pdu.file_checksum(), 0x01020304);
|
||||||
assert_eq!(eof_pdu.file_size(), 12);
|
assert_eq!(eof_pdu.file_size(), 12);
|
||||||
assert_eq!(eof_pdu.condition_code(), cond_code);
|
assert_eq!(eof_pdu.condition_code(), ConditionCode::NoError);
|
||||||
|
|
||||||
assert_eq!(eof_pdu.crc_flag(), crc_flag);
|
assert_eq!(eof_pdu.crc_flag(), CrcFlag::NoCrc);
|
||||||
assert_eq!(eof_pdu.file_flag(), file_flag);
|
assert_eq!(eof_pdu.file_flag(), file_flag);
|
||||||
assert_eq!(eof_pdu.pdu_type(), PduType::FileDirective);
|
assert_eq!(eof_pdu.pdu_type(), PduType::FileDirective);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
@ -223,7 +196,7 @@ mod tests {
|
|||||||
let pdu_header = PduHeader::new_no_file_data(pdu_conf, 0);
|
let pdu_header = PduHeader::new_no_file_data(pdu_conf, 0);
|
||||||
let eof_pdu = EofPdu::new_no_error(pdu_header, 0x01020304, 12);
|
let eof_pdu = EofPdu::new_no_error(pdu_header, 0x01020304, 12);
|
||||||
assert_eq!(eof_pdu.len_written(), pdu_header.header_len() + 2 + 4 + 4);
|
assert_eq!(eof_pdu.len_written(), pdu_header.header_len() + 2 + 4 + 4);
|
||||||
verify_state_no_error_no_crc(&eof_pdu, LargeFileFlag::Normal);
|
verify_state(&eof_pdu, LargeFileFlag::Normal);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -297,7 +270,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::Checksum(e) = error {
|
if let PduError::ChecksumError(e) = error {
|
||||||
assert_eq!(e, crc);
|
assert_eq!(e, crc);
|
||||||
} else {
|
} else {
|
||||||
panic!("expected crc error");
|
panic!("expected crc error");
|
||||||
@ -309,7 +282,7 @@ mod tests {
|
|||||||
let pdu_conf = common_pdu_conf(CrcFlag::NoCrc, LargeFileFlag::Large);
|
let pdu_conf = common_pdu_conf(CrcFlag::NoCrc, LargeFileFlag::Large);
|
||||||
let pdu_header = PduHeader::new_no_file_data(pdu_conf, 0);
|
let pdu_header = PduHeader::new_no_file_data(pdu_conf, 0);
|
||||||
let eof_pdu = EofPdu::new_no_error(pdu_header, 0x01020304, 12);
|
let eof_pdu = EofPdu::new_no_error(pdu_header, 0x01020304, 12);
|
||||||
verify_state_no_error_no_crc(&eof_pdu, LargeFileFlag::Large);
|
verify_state(&eof_pdu, LargeFileFlag::Large);
|
||||||
assert_eq!(eof_pdu.len_written(), pdu_header.header_len() + 2 + 8 + 4);
|
assert_eq!(eof_pdu.len_written(), pdu_header.header_len() + 2 + 8 + 4);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -321,48 +294,4 @@ mod tests {
|
|||||||
let eof_pdu = EofPdu::new_no_error(pdu_header, 0x01020304, 12);
|
let eof_pdu = EofPdu::new_no_error(pdu_header, 0x01020304, 12);
|
||||||
generic_serde_test(eof_pdu);
|
generic_serde_test(eof_pdu);
|
||||||
}
|
}
|
||||||
|
|
||||||
fn generic_test_with_fault_location_and_error(crc: CrcFlag) {
|
|
||||||
let pdu_conf = common_pdu_conf(crc, LargeFileFlag::Normal);
|
|
||||||
let pdu_header = PduHeader::new_no_file_data(pdu_conf, 0);
|
|
||||||
let eof_pdu = EofPdu::new(
|
|
||||||
pdu_header,
|
|
||||||
ConditionCode::FileChecksumFailure,
|
|
||||||
0x01020304,
|
|
||||||
12,
|
|
||||||
Some(EntityIdTlv::new(UnsignedByteFieldU16::new(5).into())),
|
|
||||||
);
|
|
||||||
let mut expected_len = pdu_header.header_len() + 2 + 4 + 4 + 4;
|
|
||||||
if crc == CrcFlag::WithCrc {
|
|
||||||
expected_len += 2;
|
|
||||||
}
|
|
||||||
// Entity ID TLV increaes length by 4.
|
|
||||||
assert_eq!(eof_pdu.len_written(), expected_len);
|
|
||||||
verify_state(
|
|
||||||
&eof_pdu,
|
|
||||||
crc,
|
|
||||||
LargeFileFlag::Normal,
|
|
||||||
ConditionCode::FileChecksumFailure,
|
|
||||||
);
|
|
||||||
let eof_vec = eof_pdu.to_vec().unwrap();
|
|
||||||
let eof_read_back = EofPdu::from_bytes(&eof_vec);
|
|
||||||
if let Err(e) = eof_read_back {
|
|
||||||
panic!("deserialization failed with: {e}")
|
|
||||||
}
|
|
||||||
let eof_read_back = eof_read_back.unwrap();
|
|
||||||
assert_eq!(eof_read_back, eof_pdu);
|
|
||||||
assert!(eof_read_back.fault_location.is_some());
|
|
||||||
assert_eq!(eof_read_back.fault_location.unwrap().entity_id().value(), 5);
|
|
||||||
assert_eq!(eof_read_back.fault_location.unwrap().entity_id().size(), 2);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_with_fault_location_and_error() {
|
|
||||||
generic_test_with_fault_location_and_error(CrcFlag::NoCrc);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_with_fault_location_and_error_and_crc() {
|
|
||||||
generic_test_with_fault_location_and_error(CrcFlag::WithCrc);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -92,67 +92,16 @@ impl<'seg_meta> SegmentMetadata<'seg_meta> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
struct FdPduBase<'seg_meta> {
|
|
||||||
pdu_header: PduHeader,
|
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
|
||||||
segment_metadata: Option<SegmentMetadata<'seg_meta>>,
|
|
||||||
offset: u64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CfdpPdu for FdPduBase<'_> {
|
|
||||||
fn pdu_header(&self) -> &PduHeader {
|
|
||||||
&self.pdu_header
|
|
||||||
}
|
|
||||||
|
|
||||||
fn file_directive_type(&self) -> Option<FileDirectiveType> {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FdPduBase<'_> {
|
|
||||||
fn calc_pdu_datafield_len(&self, file_data_len: u64) -> usize {
|
|
||||||
let mut len = core::mem::size_of::<u32>();
|
|
||||||
if self.pdu_header.pdu_conf.file_flag == LargeFileFlag::Large {
|
|
||||||
len += 4;
|
|
||||||
}
|
|
||||||
if self.segment_metadata.is_some() {
|
|
||||||
len += self.segment_metadata.as_ref().unwrap().written_len()
|
|
||||||
}
|
|
||||||
len += file_data_len as usize;
|
|
||||||
if self.crc_flag() == CrcFlag::WithCrc {
|
|
||||||
len += 2;
|
|
||||||
}
|
|
||||||
len
|
|
||||||
}
|
|
||||||
|
|
||||||
fn write_common_fields_to_bytes(&self, buf: &mut [u8]) -> Result<usize, PduError> {
|
|
||||||
let mut current_idx = self.pdu_header.write_to_bytes(buf)?;
|
|
||||||
if self.segment_metadata.is_some() {
|
|
||||||
current_idx += self
|
|
||||||
.segment_metadata
|
|
||||||
.as_ref()
|
|
||||||
.unwrap()
|
|
||||||
.write_to_bytes(&mut buf[current_idx..])?;
|
|
||||||
}
|
|
||||||
current_idx += write_fss_field(
|
|
||||||
self.pdu_header.common_pdu_conf().file_flag,
|
|
||||||
self.offset,
|
|
||||||
&mut buf[current_idx..],
|
|
||||||
)?;
|
|
||||||
Ok(current_idx)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// File Data PDU abstraction.
|
/// File Data PDU abstraction.
|
||||||
///
|
///
|
||||||
/// For more information, refer to CFDP chapter 5.3.
|
/// For more information, refer to CFDP chapter 5.3.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub struct FileDataPdu<'seg_meta, 'file_data> {
|
pub struct FileDataPdu<'seg_meta, 'file_data> {
|
||||||
|
pdu_header: PduHeader,
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
common: FdPduBase<'seg_meta>,
|
segment_metadata: Option<SegmentMetadata<'seg_meta>>,
|
||||||
|
offset: u64,
|
||||||
file_data: &'file_data [u8],
|
file_data: &'file_data [u8],
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -185,34 +134,42 @@ impl<'seg_meta, 'file_data> FileDataPdu<'seg_meta, 'file_data> {
|
|||||||
pdu_header.seg_metadata_flag = SegmentMetadataFlag::Present;
|
pdu_header.seg_metadata_flag = SegmentMetadataFlag::Present;
|
||||||
}
|
}
|
||||||
let mut pdu = Self {
|
let mut pdu = Self {
|
||||||
common: FdPduBase {
|
pdu_header,
|
||||||
pdu_header,
|
segment_metadata,
|
||||||
segment_metadata,
|
offset,
|
||||||
offset,
|
|
||||||
},
|
|
||||||
file_data,
|
file_data,
|
||||||
};
|
};
|
||||||
pdu.common.pdu_header.pdu_datafield_len = pdu.calc_pdu_datafield_len() as u16;
|
pdu.pdu_header.pdu_datafield_len = pdu.calc_pdu_datafield_len() as u16;
|
||||||
pdu
|
pdu
|
||||||
}
|
}
|
||||||
|
|
||||||
fn calc_pdu_datafield_len(&self) -> usize {
|
fn calc_pdu_datafield_len(&self) -> usize {
|
||||||
self.common
|
let mut len = core::mem::size_of::<u32>();
|
||||||
.calc_pdu_datafield_len(self.file_data.len() as u64)
|
if self.pdu_header.pdu_conf.file_flag == LargeFileFlag::Large {
|
||||||
}
|
len += 4;
|
||||||
|
}
|
||||||
pub fn segment_metadata(&self) -> Option<&SegmentMetadata> {
|
if self.segment_metadata.is_some() {
|
||||||
self.common.segment_metadata.as_ref()
|
len += self.segment_metadata.as_ref().unwrap().written_len()
|
||||||
|
}
|
||||||
|
len += self.file_data.len();
|
||||||
|
if self.crc_flag() == CrcFlag::WithCrc {
|
||||||
|
len += 2;
|
||||||
|
}
|
||||||
|
len
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn offset(&self) -> u64 {
|
pub fn offset(&self) -> u64 {
|
||||||
self.common.offset
|
self.offset
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn file_data(&self) -> &'file_data [u8] {
|
pub fn file_data(&self) -> &'file_data [u8] {
|
||||||
self.file_data
|
self.file_data
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn segment_metadata(&self) -> Option<&SegmentMetadata> {
|
||||||
|
self.segment_metadata.as_ref()
|
||||||
|
}
|
||||||
|
|
||||||
pub fn from_bytes<'buf: 'seg_meta + 'file_data>(buf: &'buf [u8]) -> Result<Self, PduError> {
|
pub fn from_bytes<'buf: 'seg_meta + 'file_data>(buf: &'buf [u8]) -> Result<Self, 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)?;
|
||||||
@ -233,18 +190,16 @@ impl<'seg_meta, 'file_data> FileDataPdu<'seg_meta, 'file_data> {
|
|||||||
.into());
|
.into());
|
||||||
}
|
}
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
common: FdPduBase {
|
pdu_header,
|
||||||
pdu_header,
|
segment_metadata,
|
||||||
segment_metadata,
|
offset,
|
||||||
offset,
|
|
||||||
},
|
|
||||||
file_data: &buf[current_idx..full_len_without_crc],
|
file_data: &buf[current_idx..full_len_without_crc],
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
impl CfdpPdu for FileDataPdu<'_, '_> {
|
impl CfdpPdu for FileDataPdu<'_, '_> {
|
||||||
fn pdu_header(&self) -> &PduHeader {
|
fn pdu_header(&self) -> &PduHeader {
|
||||||
&self.common.pdu_header
|
&self.pdu_header
|
||||||
}
|
}
|
||||||
|
|
||||||
fn file_directive_type(&self) -> Option<FileDirectiveType> {
|
fn file_directive_type(&self) -> Option<FileDirectiveType> {
|
||||||
@ -261,8 +216,19 @@ impl WritablePduPacket for FileDataPdu<'_, '_> {
|
|||||||
}
|
}
|
||||||
.into());
|
.into());
|
||||||
}
|
}
|
||||||
|
let mut current_idx = self.pdu_header.write_to_bytes(buf)?;
|
||||||
let mut current_idx = self.common.write_common_fields_to_bytes(buf)?;
|
if self.segment_metadata.is_some() {
|
||||||
|
current_idx += self
|
||||||
|
.segment_metadata
|
||||||
|
.as_ref()
|
||||||
|
.unwrap()
|
||||||
|
.write_to_bytes(&mut buf[current_idx..])?;
|
||||||
|
}
|
||||||
|
current_idx += write_fss_field(
|
||||||
|
self.pdu_header.common_pdu_conf().file_flag,
|
||||||
|
self.offset,
|
||||||
|
&mut buf[current_idx..],
|
||||||
|
)?;
|
||||||
buf[current_idx..current_idx + self.file_data.len()].copy_from_slice(self.file_data);
|
buf[current_idx..current_idx + self.file_data.len()].copy_from_slice(self.file_data);
|
||||||
current_idx += self.file_data.len();
|
current_idx += self.file_data.len();
|
||||||
if self.crc_flag() == CrcFlag::WithCrc {
|
if self.crc_flag() == CrcFlag::WithCrc {
|
||||||
@ -272,167 +238,10 @@ impl WritablePduPacket for FileDataPdu<'_, '_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn len_written(&self) -> usize {
|
fn len_written(&self) -> usize {
|
||||||
self.common.pdu_header.header_len() + self.calc_pdu_datafield_len()
|
self.pdu_header.header_len() + self.calc_pdu_datafield_len()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// File Data PDU creator abstraction.
|
|
||||||
///
|
|
||||||
/// This special creator object allows to read into the file data buffer directly. This avoids
|
|
||||||
/// the need of an additional buffer to create a file data PDU. This structure therefore
|
|
||||||
/// does not implement the regular [WritablePduPacket] trait.
|
|
||||||
///
|
|
||||||
/// For more information, refer to CFDP chapter 5.3.
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
pub struct FileDataPduCreatorWithReservedDatafield<'seg_meta> {
|
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
|
||||||
common: FdPduBase<'seg_meta>,
|
|
||||||
file_data_len: u64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'seg_meta> FileDataPduCreatorWithReservedDatafield<'seg_meta> {
|
|
||||||
pub fn new_with_seg_metadata(
|
|
||||||
pdu_header: PduHeader,
|
|
||||||
segment_metadata: SegmentMetadata<'seg_meta>,
|
|
||||||
offset: u64,
|
|
||||||
file_data_len: u64,
|
|
||||||
) -> Self {
|
|
||||||
Self::new_generic(pdu_header, Some(segment_metadata), offset, file_data_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn new_no_seg_metadata(pdu_header: PduHeader, offset: u64, file_data_len: u64) -> Self {
|
|
||||||
Self::new_generic(pdu_header, None, offset, file_data_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn new_generic(
|
|
||||||
mut pdu_header: PduHeader,
|
|
||||||
segment_metadata: Option<SegmentMetadata<'seg_meta>>,
|
|
||||||
offset: u64,
|
|
||||||
file_data_len: u64,
|
|
||||||
) -> Self {
|
|
||||||
pdu_header.pdu_type = PduType::FileData;
|
|
||||||
if segment_metadata.is_some() {
|
|
||||||
pdu_header.seg_metadata_flag = SegmentMetadataFlag::Present;
|
|
||||||
}
|
|
||||||
let mut pdu = Self {
|
|
||||||
common: FdPduBase {
|
|
||||||
pdu_header,
|
|
||||||
segment_metadata,
|
|
||||||
offset,
|
|
||||||
},
|
|
||||||
file_data_len,
|
|
||||||
};
|
|
||||||
pdu.common.pdu_header.pdu_datafield_len = pdu.calc_pdu_datafield_len() as u16;
|
|
||||||
pdu
|
|
||||||
}
|
|
||||||
|
|
||||||
fn calc_pdu_datafield_len(&self) -> usize {
|
|
||||||
self.common.calc_pdu_datafield_len(self.file_data_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn len_written(&self) -> usize {
|
|
||||||
self.common.pdu_header.header_len() + self.calc_pdu_datafield_len()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This function performs a partial write by writing all data except the file data
|
|
||||||
/// and the CRC.
|
|
||||||
///
|
|
||||||
/// It returns a [FileDataPduCreatorWithUnwrittenData] which provides a mutable slice to
|
|
||||||
/// the reserved file data field. The user can read file data into this field directly and
|
|
||||||
/// then finish the PDU creation using the [FileDataPduCreatorWithUnwrittenData::finish] call.
|
|
||||||
pub fn write_to_bytes_partially<'buf>(
|
|
||||||
&self,
|
|
||||||
buf: &'buf mut [u8],
|
|
||||||
) -> Result<FileDataPduCreatorWithUnwrittenData<'buf>, PduError> {
|
|
||||||
if buf.len() < self.len_written() {
|
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: self.len_written(),
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let mut current_idx = self.common.write_common_fields_to_bytes(buf)?;
|
|
||||||
let file_data_offset = current_idx as u64;
|
|
||||||
current_idx += self.file_data_len as usize;
|
|
||||||
if self.crc_flag() == CrcFlag::WithCrc {
|
|
||||||
current_idx += 2;
|
|
||||||
}
|
|
||||||
Ok(FileDataPduCreatorWithUnwrittenData {
|
|
||||||
write_buf: &mut buf[0..current_idx],
|
|
||||||
file_data_offset,
|
|
||||||
file_data_len: self.file_data_len,
|
|
||||||
needs_crc: self.crc_flag() == CrcFlag::WithCrc,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CfdpPdu for FileDataPduCreatorWithReservedDatafield<'_> {
|
|
||||||
fn pdu_header(&self) -> &PduHeader {
|
|
||||||
&self.common.pdu_header
|
|
||||||
}
|
|
||||||
|
|
||||||
fn file_directive_type(&self) -> Option<FileDirectiveType> {
|
|
||||||
None
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This structure is created with [FileDataPduCreatorWithReservedDatafield::write_to_bytes_partially]
|
|
||||||
/// and provides an API to read file data from the virtual filesystem into the file data PDU buffer
|
|
||||||
/// directly.
|
|
||||||
///
|
|
||||||
/// This structure provides a mutable slice to the reserved file data field. The user can read
|
|
||||||
/// file data into this field directly and then finish the PDU creation using the
|
|
||||||
/// [FileDataPduCreatorWithUnwrittenData::finish] call.
|
|
||||||
pub struct FileDataPduCreatorWithUnwrittenData<'buf> {
|
|
||||||
write_buf: &'buf mut [u8],
|
|
||||||
file_data_offset: u64,
|
|
||||||
file_data_len: u64,
|
|
||||||
needs_crc: bool,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FileDataPduCreatorWithUnwrittenData<'_> {
|
|
||||||
pub fn file_data_field_mut(&mut self) -> &mut [u8] {
|
|
||||||
&mut self.write_buf[self.file_data_offset as usize
|
|
||||||
..self.file_data_offset as usize + self.file_data_len as usize]
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This functio needs to be called to add a CRC to the file data PDU where applicable.
|
|
||||||
///
|
|
||||||
/// It returns the full written size of the PDU.
|
|
||||||
pub fn finish(self) -> usize {
|
|
||||||
if self.needs_crc {
|
|
||||||
add_pdu_crc(
|
|
||||||
self.write_buf,
|
|
||||||
self.file_data_offset as usize + self.file_data_len as usize,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
self.write_buf.len()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This function can be used to calculate the maximum allowed file segment size for
|
|
||||||
/// a given maximum packet length and the segment metadata if there is any.
|
|
||||||
pub fn calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(
|
|
||||||
pdu_header: &PduHeader,
|
|
||||||
max_packet_len: usize,
|
|
||||||
segment_metadata: Option<&SegmentMetadata>,
|
|
||||||
) -> usize {
|
|
||||||
let mut subtract = pdu_header.header_len();
|
|
||||||
if segment_metadata.is_some() {
|
|
||||||
subtract += 1 + segment_metadata.as_ref().unwrap().metadata().unwrap().len();
|
|
||||||
}
|
|
||||||
if pdu_header.common_pdu_conf().file_flag == LargeFileFlag::Large {
|
|
||||||
subtract += 8;
|
|
||||||
} else {
|
|
||||||
subtract += 4;
|
|
||||||
}
|
|
||||||
if pdu_header.common_pdu_conf().crc_flag == CrcFlag::WithCrc {
|
|
||||||
subtract += 2;
|
|
||||||
}
|
|
||||||
max_packet_len.saturating_sub(subtract)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
@ -454,7 +263,7 @@ mod tests {
|
|||||||
assert!(fd_pdu.segment_metadata().is_none());
|
assert!(fd_pdu.segment_metadata().is_none());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
fd_pdu.len_written(),
|
fd_pdu.len_written(),
|
||||||
fd_pdu.pdu_header().header_len() + core::mem::size_of::<u32>() + 4
|
fd_pdu.pdu_header.header_len() + core::mem::size_of::<u32>() + 4
|
||||||
);
|
);
|
||||||
|
|
||||||
assert_eq!(fd_pdu.crc_flag(), CrcFlag::NoCrc);
|
assert_eq!(fd_pdu.crc_flag(), CrcFlag::NoCrc);
|
||||||
@ -481,11 +290,11 @@ mod tests {
|
|||||||
let written = res.unwrap();
|
let written = res.unwrap();
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
written,
|
written,
|
||||||
fd_pdu.pdu_header().header_len() + core::mem::size_of::<u32>() + 4
|
fd_pdu.pdu_header.header_len() + core::mem::size_of::<u32>() + 4
|
||||||
);
|
);
|
||||||
let mut current_idx = fd_pdu.pdu_header().header_len();
|
let mut current_idx = fd_pdu.pdu_header.header_len();
|
||||||
let file_size = u32::from_be_bytes(
|
let file_size = u32::from_be_bytes(
|
||||||
buf[fd_pdu.pdu_header().header_len()..fd_pdu.pdu_header().header_len() + 4]
|
buf[fd_pdu.pdu_header.header_len()..fd_pdu.pdu_header.header_len() + 4]
|
||||||
.try_into()
|
.try_into()
|
||||||
.unwrap(),
|
.unwrap(),
|
||||||
);
|
);
|
||||||
@ -544,7 +353,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::Checksum(e) = error {
|
if let PduError::ChecksumError(e) = error {
|
||||||
assert_eq!(e, crc);
|
assert_eq!(e, crc);
|
||||||
} else {
|
} else {
|
||||||
panic!("expected crc error");
|
panic!("expected crc error");
|
||||||
@ -571,7 +380,7 @@ mod tests {
|
|||||||
assert_eq!(*fd_pdu.segment_metadata().unwrap(), segment_meta);
|
assert_eq!(*fd_pdu.segment_metadata().unwrap(), segment_meta);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
fd_pdu.len_written(),
|
fd_pdu.len_written(),
|
||||||
fd_pdu.pdu_header().header_len()
|
fd_pdu.pdu_header.header_len()
|
||||||
+ 1
|
+ 1
|
||||||
+ seg_metadata.len()
|
+ seg_metadata.len()
|
||||||
+ core::mem::size_of::<u32>()
|
+ core::mem::size_of::<u32>()
|
||||||
@ -581,7 +390,7 @@ mod tests {
|
|||||||
fd_pdu
|
fd_pdu
|
||||||
.write_to_bytes(&mut buf)
|
.write_to_bytes(&mut buf)
|
||||||
.expect("writing FD PDU failed");
|
.expect("writing FD PDU failed");
|
||||||
let mut current_idx = fd_pdu.pdu_header().header_len();
|
let mut current_idx = fd_pdu.pdu_header.header_len();
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
RecordContinuationState::try_from((buf[current_idx] >> 6) & 0b11).unwrap(),
|
RecordContinuationState::try_from((buf[current_idx] >> 6) & 0b11).unwrap(),
|
||||||
RecordContinuationState::StartAndEnd
|
RecordContinuationState::StartAndEnd
|
||||||
@ -673,142 +482,4 @@ mod tests {
|
|||||||
let output_converted_back: FileDataPdu = from_bytes(&output).unwrap();
|
let output_converted_back: FileDataPdu = from_bytes(&output).unwrap();
|
||||||
assert_eq!(output_converted_back, fd_pdu);
|
assert_eq!(output_converted_back, fd_pdu);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_fd_pdu_creator_with_reserved_field_no_crc() {
|
|
||||||
let common_conf =
|
|
||||||
CommonPduConfig::new_with_byte_fields(TEST_SRC_ID, TEST_DEST_ID, TEST_SEQ_NUM).unwrap();
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
|
|
||||||
let test_str = "hello world!";
|
|
||||||
let fd_pdu = FileDataPduCreatorWithReservedDatafield::new_no_seg_metadata(
|
|
||||||
pdu_header,
|
|
||||||
10,
|
|
||||||
test_str.len() as u64,
|
|
||||||
);
|
|
||||||
let mut write_buf: [u8; 64] = [0; 64];
|
|
||||||
let mut pdu_unwritten = fd_pdu
|
|
||||||
.write_to_bytes_partially(&mut write_buf)
|
|
||||||
.expect("partial write failed");
|
|
||||||
pdu_unwritten
|
|
||||||
.file_data_field_mut()
|
|
||||||
.copy_from_slice(test_str.as_bytes());
|
|
||||||
pdu_unwritten.finish();
|
|
||||||
|
|
||||||
let pdu_reader = FileDataPdu::from_bytes(&write_buf).expect("reading file data PDU failed");
|
|
||||||
assert_eq!(
|
|
||||||
core::str::from_utf8(pdu_reader.file_data()).expect("reading utf8 string failed"),
|
|
||||||
"hello world!"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_fd_pdu_creator_with_reserved_field_with_crc() {
|
|
||||||
let mut common_conf =
|
|
||||||
CommonPduConfig::new_with_byte_fields(TEST_SRC_ID, TEST_DEST_ID, TEST_SEQ_NUM).unwrap();
|
|
||||||
common_conf.crc_flag = true.into();
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
|
|
||||||
let test_str = "hello world!";
|
|
||||||
let fd_pdu = FileDataPduCreatorWithReservedDatafield::new_no_seg_metadata(
|
|
||||||
pdu_header,
|
|
||||||
10,
|
|
||||||
test_str.len() as u64,
|
|
||||||
);
|
|
||||||
let mut write_buf: [u8; 64] = [0; 64];
|
|
||||||
let mut pdu_unwritten = fd_pdu
|
|
||||||
.write_to_bytes_partially(&mut write_buf)
|
|
||||||
.expect("partial write failed");
|
|
||||||
pdu_unwritten
|
|
||||||
.file_data_field_mut()
|
|
||||||
.copy_from_slice(test_str.as_bytes());
|
|
||||||
pdu_unwritten.finish();
|
|
||||||
|
|
||||||
let pdu_reader = FileDataPdu::from_bytes(&write_buf).expect("reading file data PDU failed");
|
|
||||||
assert_eq!(
|
|
||||||
core::str::from_utf8(pdu_reader.file_data()).expect("reading utf8 string failed"),
|
|
||||||
"hello world!"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_fd_pdu_creator_with_reserved_field_with_crc_without_finish_fails() {
|
|
||||||
let mut common_conf =
|
|
||||||
CommonPduConfig::new_with_byte_fields(TEST_SRC_ID, TEST_DEST_ID, TEST_SEQ_NUM).unwrap();
|
|
||||||
common_conf.crc_flag = true.into();
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
|
|
||||||
let test_str = "hello world!";
|
|
||||||
let fd_pdu = FileDataPduCreatorWithReservedDatafield::new_no_seg_metadata(
|
|
||||||
pdu_header,
|
|
||||||
10,
|
|
||||||
test_str.len() as u64,
|
|
||||||
);
|
|
||||||
let mut write_buf: [u8; 64] = [0; 64];
|
|
||||||
let mut pdu_unwritten = fd_pdu
|
|
||||||
.write_to_bytes_partially(&mut write_buf)
|
|
||||||
.expect("partial write failed");
|
|
||||||
pdu_unwritten
|
|
||||||
.file_data_field_mut()
|
|
||||||
.copy_from_slice(test_str.as_bytes());
|
|
||||||
|
|
||||||
let pdu_reader_error = FileDataPdu::from_bytes(&write_buf);
|
|
||||||
assert!(pdu_reader_error.is_err());
|
|
||||||
let error = pdu_reader_error.unwrap_err();
|
|
||||||
match error {
|
|
||||||
PduError::Checksum(_) => (),
|
|
||||||
_ => {
|
|
||||||
panic!("unexpected PDU error {}", error)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_max_file_seg_calculator_0() {
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(CommonPduConfig::default(), 0);
|
|
||||||
assert_eq!(
|
|
||||||
calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 64, None),
|
|
||||||
53
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_max_file_seg_calculator_1() {
|
|
||||||
let common_conf = CommonPduConfig {
|
|
||||||
crc_flag: CrcFlag::WithCrc,
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
|
|
||||||
assert_eq!(
|
|
||||||
calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 64, None),
|
|
||||||
51
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_max_file_seg_calculator_2() {
|
|
||||||
let common_conf = CommonPduConfig {
|
|
||||||
file_flag: LargeFileFlag::Large,
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
|
|
||||||
assert_eq!(
|
|
||||||
calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 64, None),
|
|
||||||
49
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_max_file_seg_calculator_saturating_sub() {
|
|
||||||
let common_conf = CommonPduConfig {
|
|
||||||
file_flag: LargeFileFlag::Large,
|
|
||||||
..Default::default()
|
|
||||||
};
|
|
||||||
let pdu_header = PduHeader::new_for_file_data_default(common_conf, 0);
|
|
||||||
assert_eq!(
|
|
||||||
calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 15, None),
|
|
||||||
0
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(&pdu_header, 14, None),
|
|
||||||
0
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -4,18 +4,16 @@ 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};
|
use crate::cfdp::{ConditionCode, CrcFlag, Direction, PduType, TlvLvError};
|
||||||
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::{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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum DeliveryCode {
|
pub enum DeliveryCode {
|
||||||
Complete = 0,
|
Complete = 0,
|
||||||
@ -24,7 +22,6 @@ pub enum DeliveryCode {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FileStatus {
|
pub enum FileStatus {
|
||||||
DiscardDeliberately = 0b00,
|
DiscardDeliberately = 0b00,
|
||||||
@ -37,7 +34,6 @@ pub enum FileStatus {
|
|||||||
///
|
///
|
||||||
/// For more information, refer to CFDP chapter 5.2.3.
|
/// For more information, refer to CFDP chapter 5.2.3.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct FinishedPduCreator<'fs_responses> {
|
pub struct FinishedPduCreator<'fs_responses> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
condition_code: ConditionCode,
|
condition_code: ConditionCode,
|
||||||
@ -223,7 +219,6 @@ impl<'buf> Iterator for FilestoreResponseIterator<'buf> {
|
|||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct FinishedPduReader<'buf> {
|
pub struct FinishedPduReader<'buf> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
condition_code: ConditionCode,
|
condition_code: ConditionCode,
|
||||||
@ -332,26 +327,22 @@ 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::Format);
|
return Err(PduError::FormatError);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return Err(PduError::TlvLv(
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
InvalidTlvTypeFieldError {
|
found: tlv_type.into(),
|
||||||
found: tlv_type.into(),
|
expected: Some(TlvType::FilestoreResponse.into()),
|
||||||
expected: Some(TlvType::FilestoreResponse.into()),
|
}
|
||||||
}
|
.into());
|
||||||
.into(),
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
TlvTypeField::Custom(raw) => {
|
TlvTypeField::Custom(raw) => {
|
||||||
return Err(PduError::TlvLv(
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
InvalidTlvTypeFieldError {
|
found: raw,
|
||||||
found: raw,
|
expected: None,
|
||||||
expected: None,
|
}
|
||||||
}
|
.into());
|
||||||
.into(),
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -568,7 +559,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::Checksum(e) = error {
|
if let PduError::ChecksumError(e) = error {
|
||||||
assert_eq!(e, crc);
|
assert_eq!(e, crc);
|
||||||
} else {
|
} else {
|
||||||
panic!("expected crc error");
|
panic!("expected crc error");
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
#[cfg(feature = "alloc")]
|
|
||||||
use super::tlv::TlvOwned;
|
|
||||||
use crate::cfdp::lv::Lv;
|
use crate::cfdp::lv::Lv;
|
||||||
use crate::cfdp::pdu::{
|
use crate::cfdp::pdu::{
|
||||||
add_pdu_crc, generic_length_checks_pdu_deserialization, read_fss_field, write_fss_field,
|
add_pdu_crc, generic_length_checks_pdu_deserialization, read_fss_field, write_fss_field,
|
||||||
@ -13,12 +11,10 @@ use alloc::vec::Vec;
|
|||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use super::tlv::ReadableTlv;
|
|
||||||
use super::{CfdpPdu, WritablePduPacket};
|
use super::{CfdpPdu, WritablePduPacket};
|
||||||
|
|
||||||
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Default, 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))]
|
|
||||||
pub struct MetadataGenericParams {
|
pub struct MetadataGenericParams {
|
||||||
pub closure_requested: bool,
|
pub closure_requested: bool,
|
||||||
pub checksum_type: ChecksumType,
|
pub checksum_type: ChecksumType,
|
||||||
@ -54,15 +50,6 @@ pub fn build_metadata_opts_from_vec(
|
|||||||
build_metadata_opts_from_slice(buf, tlvs.as_slice())
|
build_metadata_opts_from_slice(buf, tlvs.as_slice())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn build_metadata_opts_from_owned_slice(tlvs: &[TlvOwned]) -> Vec<u8> {
|
|
||||||
let mut sum_vec = Vec::new();
|
|
||||||
for tlv in tlvs {
|
|
||||||
sum_vec.extend(tlv.to_vec());
|
|
||||||
}
|
|
||||||
sum_vec
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Metadata PDU creator abstraction.
|
/// Metadata PDU creator abstraction.
|
||||||
///
|
///
|
||||||
/// This abstraction exposes a specialized API for creating metadata PDUs as specified in
|
/// This abstraction exposes a specialized API for creating metadata PDUs as specified in
|
||||||
@ -73,7 +60,7 @@ pub struct MetadataPduCreator<'src_name, 'dest_name, 'opts> {
|
|||||||
metadata_params: MetadataGenericParams,
|
metadata_params: MetadataGenericParams,
|
||||||
src_file_name: Lv<'src_name>,
|
src_file_name: Lv<'src_name>,
|
||||||
dest_file_name: Lv<'dest_name>,
|
dest_file_name: Lv<'dest_name>,
|
||||||
options: &'opts [u8],
|
options: &'opts [Tlv<'opts>],
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'src_name, 'dest_name, 'opts> MetadataPduCreator<'src_name, 'dest_name, 'opts> {
|
impl<'src_name, 'dest_name, 'opts> MetadataPduCreator<'src_name, 'dest_name, 'opts> {
|
||||||
@ -97,7 +84,7 @@ impl<'src_name, 'dest_name, 'opts> MetadataPduCreator<'src_name, 'dest_name, 'op
|
|||||||
metadata_params: MetadataGenericParams,
|
metadata_params: MetadataGenericParams,
|
||||||
src_file_name: Lv<'src_name>,
|
src_file_name: Lv<'src_name>,
|
||||||
dest_file_name: Lv<'dest_name>,
|
dest_file_name: Lv<'dest_name>,
|
||||||
options: &'opts [u8],
|
options: &'opts [Tlv<'opts>],
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Self::new(
|
Self::new(
|
||||||
pdu_header,
|
pdu_header,
|
||||||
@ -113,7 +100,7 @@ impl<'src_name, 'dest_name, 'opts> MetadataPduCreator<'src_name, 'dest_name, 'op
|
|||||||
metadata_params: MetadataGenericParams,
|
metadata_params: MetadataGenericParams,
|
||||||
src_file_name: Lv<'src_name>,
|
src_file_name: Lv<'src_name>,
|
||||||
dest_file_name: Lv<'dest_name>,
|
dest_file_name: Lv<'dest_name>,
|
||||||
options: &'opts [u8],
|
options: &'opts [Tlv<'opts>],
|
||||||
) -> Self {
|
) -> Self {
|
||||||
pdu_header.pdu_type = PduType::FileDirective;
|
pdu_header.pdu_type = PduType::FileDirective;
|
||||||
pdu_header.pdu_conf.direction = Direction::TowardsReceiver;
|
pdu_header.pdu_conf.direction = Direction::TowardsReceiver;
|
||||||
@ -140,19 +127,10 @@ impl<'src_name, 'dest_name, 'opts> MetadataPduCreator<'src_name, 'dest_name, 'op
|
|||||||
self.dest_file_name
|
self.dest_file_name
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn options(&self) -> &'opts [u8] {
|
pub fn options(&self) -> &'opts [Tlv<'opts>] {
|
||||||
self.options
|
self.options
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Yield an iterator which can be used to loop through all options. Returns [None] if the
|
|
||||||
/// options field is empty.
|
|
||||||
pub fn options_iter(&self) -> OptionsIter<'_> {
|
|
||||||
OptionsIter {
|
|
||||||
opt_buf: self.options,
|
|
||||||
current_idx: 0,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn calc_pdu_datafield_len(&self) -> usize {
|
fn calc_pdu_datafield_len(&self) -> usize {
|
||||||
// One directve type octet and one byte of the directive parameter field.
|
// One directve type octet and one byte of the directive parameter field.
|
||||||
let mut len = 2;
|
let mut len = 2;
|
||||||
@ -163,7 +141,9 @@ impl<'src_name, 'dest_name, 'opts> MetadataPduCreator<'src_name, 'dest_name, 'op
|
|||||||
}
|
}
|
||||||
len += self.src_file_name.len_full();
|
len += self.src_file_name.len_full();
|
||||||
len += self.dest_file_name.len_full();
|
len += self.dest_file_name.len_full();
|
||||||
len += self.options().len();
|
for tlv in self.options() {
|
||||||
|
len += tlv.len_full()
|
||||||
|
}
|
||||||
if self.crc_flag() == CrcFlag::WithCrc {
|
if self.crc_flag() == CrcFlag::WithCrc {
|
||||||
len += 2;
|
len += 2;
|
||||||
}
|
}
|
||||||
@ -209,8 +189,10 @@ impl WritablePduPacket for MetadataPduCreator<'_, '_, '_> {
|
|||||||
current_idx += self
|
current_idx += self
|
||||||
.dest_file_name
|
.dest_file_name
|
||||||
.write_to_be_bytes(&mut buf[current_idx..])?;
|
.write_to_be_bytes(&mut buf[current_idx..])?;
|
||||||
buf[current_idx..current_idx + self.options.len()].copy_from_slice(self.options);
|
for opt in self.options() {
|
||||||
current_idx += self.options.len();
|
opt.write_to_bytes(&mut buf[current_idx..current_idx + opt.len_full()])?;
|
||||||
|
current_idx += opt.len_full();
|
||||||
|
}
|
||||||
if self.crc_flag() == CrcFlag::WithCrc {
|
if self.crc_flag() == CrcFlag::WithCrc {
|
||||||
current_idx = add_pdu_crc(buf, current_idx);
|
current_idx = add_pdu_crc(buf, current_idx);
|
||||||
}
|
}
|
||||||
@ -259,7 +241,6 @@ impl<'opts> Iterator for OptionsIter<'opts> {
|
|||||||
/// involved.
|
/// involved.
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct MetadataPduReader<'buf> {
|
pub struct MetadataPduReader<'buf> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
metadata_params: MetadataGenericParams,
|
metadata_params: MetadataGenericParams,
|
||||||
@ -371,7 +352,7 @@ pub mod tests {
|
|||||||
};
|
};
|
||||||
use crate::cfdp::pdu::{CfdpPdu, PduError, WritablePduPacket};
|
use crate::cfdp::pdu::{CfdpPdu, PduError, WritablePduPacket};
|
||||||
use crate::cfdp::pdu::{FileDirectiveType, PduHeader};
|
use crate::cfdp::pdu::{FileDirectiveType, PduHeader};
|
||||||
use crate::cfdp::tlv::{ReadableTlv, Tlv, TlvOwned, TlvType, WritableTlv};
|
use crate::cfdp::tlv::{Tlv, TlvType};
|
||||||
use crate::cfdp::{
|
use crate::cfdp::{
|
||||||
ChecksumType, CrcFlag, Direction, LargeFileFlag, PduType, SegmentMetadataFlag,
|
ChecksumType, CrcFlag, Direction, LargeFileFlag, PduType, SegmentMetadataFlag,
|
||||||
SegmentationControl, TransmissionMode,
|
SegmentationControl, TransmissionMode,
|
||||||
@ -381,16 +362,16 @@ pub mod tests {
|
|||||||
const SRC_FILENAME: &str = "hello-world.txt";
|
const SRC_FILENAME: &str = "hello-world.txt";
|
||||||
const DEST_FILENAME: &str = "hello-world2.txt";
|
const DEST_FILENAME: &str = "hello-world2.txt";
|
||||||
|
|
||||||
fn generic_metadata_pdu(
|
fn generic_metadata_pdu<'opts>(
|
||||||
crc_flag: CrcFlag,
|
crc_flag: CrcFlag,
|
||||||
checksum_type: ChecksumType,
|
checksum_type: ChecksumType,
|
||||||
closure_requested: bool,
|
closure_requested: bool,
|
||||||
fss: LargeFileFlag,
|
fss: LargeFileFlag,
|
||||||
opts: &[u8],
|
opts: &'opts [Tlv],
|
||||||
) -> (
|
) -> (
|
||||||
Lv<'static>,
|
Lv<'static>,
|
||||||
Lv<'static>,
|
Lv<'static>,
|
||||||
MetadataPduCreator<'static, 'static, '_>,
|
MetadataPduCreator<'static, 'static, 'opts>,
|
||||||
) {
|
) {
|
||||||
let pdu_header = PduHeader::new_no_file_data(common_pdu_conf(crc_flag, fss), 0);
|
let pdu_header = PduHeader::new_no_file_data(common_pdu_conf(crc_flag, fss), 0);
|
||||||
let metadata_params = MetadataGenericParams::new(closure_requested, checksum_type, 0x1010);
|
let metadata_params = MetadataGenericParams::new(closure_requested, checksum_type, 0x1010);
|
||||||
@ -560,9 +541,9 @@ pub mod tests {
|
|||||||
assert_eq!(written.metadata_params(), read.metadata_params());
|
assert_eq!(written.metadata_params(), read.metadata_params());
|
||||||
assert_eq!(written.src_file_name(), read.src_file_name());
|
assert_eq!(written.src_file_name(), read.src_file_name());
|
||||||
assert_eq!(written.dest_file_name(), read.dest_file_name());
|
assert_eq!(written.dest_file_name(), read.dest_file_name());
|
||||||
let opts = written.options_iter();
|
let opts = written.options();
|
||||||
for (tlv_written, tlv_read) in opts.zip(read.options_iter().unwrap()) {
|
for (tlv_written, tlv_read) in opts.iter().zip(read.options_iter().unwrap()) {
|
||||||
assert_eq!(&tlv_written, &tlv_read);
|
assert_eq!(tlv_written, &tlv_read);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -677,14 +658,14 @@ pub mod tests {
|
|||||||
let tlv1 = Tlv::new_empty(TlvType::FlowLabel);
|
let tlv1 = Tlv::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 = Tlv::new(TlvType::MsgToUser, &msg_to_user).unwrap();
|
let tlv2 = Tlv::new(TlvType::MsgToUser, &msg_to_user).unwrap();
|
||||||
let mut tlv_buf: [u8; 64] = [0; 64];
|
let tlv_vec = vec![tlv1, tlv2];
|
||||||
let opts_len = build_metadata_opts_from_slice(&mut tlv_buf, &[tlv1, tlv2]).unwrap();
|
let opts_len = tlv1.len_full() + tlv2.len_full();
|
||||||
let (src_filename, dest_filename, metadata_pdu) = generic_metadata_pdu(
|
let (src_filename, dest_filename, metadata_pdu) = generic_metadata_pdu(
|
||||||
CrcFlag::NoCrc,
|
CrcFlag::NoCrc,
|
||||||
ChecksumType::Crc32,
|
ChecksumType::Crc32,
|
||||||
false,
|
false,
|
||||||
LargeFileFlag::Normal,
|
LargeFileFlag::Normal,
|
||||||
&tlv_buf[0..opts_len],
|
&tlv_vec,
|
||||||
);
|
);
|
||||||
let mut buf: [u8; 128] = [0; 128];
|
let mut buf: [u8; 128] = [0; 128];
|
||||||
let write_res = metadata_pdu.write_to_bytes(&mut buf);
|
let write_res = metadata_pdu.write_to_bytes(&mut buf);
|
||||||
@ -707,55 +688,7 @@ pub mod tests {
|
|||||||
let opts_iter = opts_iter.unwrap();
|
let opts_iter = opts_iter.unwrap();
|
||||||
let mut accumulated_len = 0;
|
let mut accumulated_len = 0;
|
||||||
for (idx, opt) in opts_iter.enumerate() {
|
for (idx, opt) in opts_iter.enumerate() {
|
||||||
if idx == 0 {
|
assert_eq!(tlv_vec[idx], opt);
|
||||||
assert_eq!(tlv1, opt);
|
|
||||||
} else if idx == 1 {
|
|
||||||
assert_eq!(tlv2, opt);
|
|
||||||
}
|
|
||||||
accumulated_len += opt.len_full();
|
|
||||||
}
|
|
||||||
assert_eq!(accumulated_len, pdu_read_back.options().len());
|
|
||||||
}
|
|
||||||
#[test]
|
|
||||||
fn test_with_owned_opts() {
|
|
||||||
let tlv1 = TlvOwned::new_empty(TlvType::FlowLabel);
|
|
||||||
let msg_to_user: [u8; 4] = [1, 2, 3, 4];
|
|
||||||
let tlv2 = TlvOwned::new(TlvType::MsgToUser, &msg_to_user);
|
|
||||||
let mut all_tlvs = tlv1.to_vec();
|
|
||||||
all_tlvs.extend(tlv2.to_vec());
|
|
||||||
let (src_filename, dest_filename, metadata_pdu) = generic_metadata_pdu(
|
|
||||||
CrcFlag::NoCrc,
|
|
||||||
ChecksumType::Crc32,
|
|
||||||
false,
|
|
||||||
LargeFileFlag::Normal,
|
|
||||||
&all_tlvs,
|
|
||||||
);
|
|
||||||
let mut buf: [u8; 128] = [0; 128];
|
|
||||||
let write_res = metadata_pdu.write_to_bytes(&mut buf);
|
|
||||||
assert!(write_res.is_ok());
|
|
||||||
let written = write_res.unwrap();
|
|
||||||
assert_eq!(
|
|
||||||
written,
|
|
||||||
metadata_pdu.pdu_header.header_len()
|
|
||||||
+ 1
|
|
||||||
+ 1
|
|
||||||
+ 4
|
|
||||||
+ src_filename.len_full()
|
|
||||||
+ dest_filename.len_full()
|
|
||||||
+ all_tlvs.len()
|
|
||||||
);
|
|
||||||
let pdu_read_back = MetadataPduReader::from_bytes(&buf).unwrap();
|
|
||||||
compare_read_pdu_to_written_pdu(&metadata_pdu, &pdu_read_back);
|
|
||||||
let opts_iter = pdu_read_back.options_iter();
|
|
||||||
assert!(opts_iter.is_some());
|
|
||||||
let opts_iter = opts_iter.unwrap();
|
|
||||||
let mut accumulated_len = 0;
|
|
||||||
for (idx, opt) in opts_iter.enumerate() {
|
|
||||||
if idx == 0 {
|
|
||||||
assert_eq!(tlv1, opt);
|
|
||||||
} else if idx == 1 {
|
|
||||||
assert_eq!(tlv2, opt);
|
|
||||||
}
|
|
||||||
accumulated_len += opt.len_full();
|
accumulated_len += opt.len_full();
|
||||||
}
|
}
|
||||||
assert_eq!(accumulated_len, pdu_read_back.options().len());
|
assert_eq!(accumulated_len, pdu_read_back.options().len());
|
||||||
@ -780,7 +713,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, found 255, expected Some(MetadataPdu)"
|
"invalid directive type value 255, expected Some(MetadataPdu)"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
||||||
@ -806,7 +739,7 @@ pub mod tests {
|
|||||||
assert_eq!(expected, FileDirectiveType::MetadataPdu);
|
assert_eq!(expected, FileDirectiveType::MetadataPdu);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"wrong directive type, found EofPdu, expected MetadataPdu"
|
"found directive type EofPdu, expected MetadataPdu"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
panic!("Expected InvalidDirectiveType error, got {:?}", error);
|
||||||
|
@ -1,10 +1,13 @@
|
|||||||
//! 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;
|
||||||
@ -15,7 +18,6 @@ pub mod nak;
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FileDirectiveType {
|
pub enum FileDirectiveType {
|
||||||
EofPdu = 0x04,
|
EofPdu = 0x04,
|
||||||
@ -27,62 +29,135 @@ pub enum FileDirectiveType {
|
|||||||
KeepAlivePdu = 0x0c,
|
KeepAlivePdu = 0x0c,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
#[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))]
|
|
||||||
pub enum PduError {
|
pub enum PduError {
|
||||||
#[error("byte conversion error: {0}")]
|
ByteConversion(ByteConversionError),
|
||||||
ByteConversion(#[from] ByteConversionError),
|
/// Found version ID invalid, not equal to [CFDP_VERSION_2].
|
||||||
/// 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.
|
||||||
#[error("checksum error for checksum {0}")]
|
ChecksumError(u16),
|
||||||
Checksum(u16),
|
|
||||||
/// Generic error for invalid PDU formats.
|
/// Generic error for invalid PDU formats.
|
||||||
#[error("generic PDU format error")]
|
FormatError,
|
||||||
Format,
|
|
||||||
/// Error handling a TLV field.
|
/// Error handling a TLV field.
|
||||||
#[error("PDU error: {0}")]
|
TlvLvError(TlvLvError),
|
||||||
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 {
|
||||||
|
fn from(value: ByteConversionError) -> Self {
|
||||||
|
Self::ByteConversion(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<TlvLvError> for PduError {
|
||||||
|
fn from(e: TlvLvError) -> Self {
|
||||||
|
Self::TlvLvError(e)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait WritablePduPacket {
|
pub trait WritablePduPacket {
|
||||||
@ -103,42 +178,33 @@ pub trait WritablePduPacket {
|
|||||||
pub trait CfdpPdu {
|
pub trait CfdpPdu {
|
||||||
fn pdu_header(&self) -> &PduHeader;
|
fn pdu_header(&self) -> &PduHeader;
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn source_id(&self) -> UnsignedByteField {
|
fn source_id(&self) -> UnsignedByteField {
|
||||||
self.pdu_header().common_pdu_conf().source_entity_id
|
self.pdu_header().common_pdu_conf().source_entity_id
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn dest_id(&self) -> UnsignedByteField {
|
fn dest_id(&self) -> UnsignedByteField {
|
||||||
self.pdu_header().common_pdu_conf().dest_entity_id
|
self.pdu_header().common_pdu_conf().dest_entity_id
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn transaction_seq_num(&self) -> UnsignedByteField {
|
fn transaction_seq_num(&self) -> UnsignedByteField {
|
||||||
self.pdu_header().common_pdu_conf().transaction_seq_num
|
self.pdu_header().common_pdu_conf().transaction_seq_num
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn transmission_mode(&self) -> TransmissionMode {
|
fn transmission_mode(&self) -> TransmissionMode {
|
||||||
self.pdu_header().common_pdu_conf().trans_mode
|
self.pdu_header().common_pdu_conf().trans_mode
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn direction(&self) -> Direction {
|
fn direction(&self) -> Direction {
|
||||||
self.pdu_header().common_pdu_conf().direction
|
self.pdu_header().common_pdu_conf().direction
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn crc_flag(&self) -> CrcFlag {
|
fn crc_flag(&self) -> CrcFlag {
|
||||||
self.pdu_header().common_pdu_conf().crc_flag
|
self.pdu_header().common_pdu_conf().crc_flag
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn file_flag(&self) -> LargeFileFlag {
|
fn file_flag(&self) -> LargeFileFlag {
|
||||||
self.pdu_header().common_pdu_conf().file_flag
|
self.pdu_header().common_pdu_conf().file_flag
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn pdu_type(&self) -> PduType {
|
fn pdu_type(&self) -> PduType {
|
||||||
self.pdu_header().pdu_type()
|
self.pdu_header().pdu_type()
|
||||||
}
|
}
|
||||||
@ -154,7 +220,6 @@ pub trait CfdpPdu {
|
|||||||
/// same.
|
/// same.
|
||||||
#[derive(Debug, Copy, Clone, Eq)]
|
#[derive(Debug, Copy, Clone, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct CommonPduConfig {
|
pub struct CommonPduConfig {
|
||||||
source_entity_id: UnsignedByteField,
|
source_entity_id: UnsignedByteField,
|
||||||
dest_entity_id: UnsignedByteField,
|
dest_entity_id: UnsignedByteField,
|
||||||
@ -167,7 +232,6 @@ pub struct CommonPduConfig {
|
|||||||
|
|
||||||
// TODO: Builder pattern might be applicable here..
|
// TODO: Builder pattern might be applicable here..
|
||||||
impl CommonPduConfig {
|
impl CommonPduConfig {
|
||||||
#[inline]
|
|
||||||
pub fn new(
|
pub fn new(
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
dest_id: impl Into<UnsignedByteField>,
|
dest_id: impl Into<UnsignedByteField>,
|
||||||
@ -199,7 +263,6 @@ impl CommonPduConfig {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_with_byte_fields(
|
pub fn new_with_byte_fields(
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
dest_id: impl Into<UnsignedByteField>,
|
dest_id: impl Into<UnsignedByteField>,
|
||||||
@ -216,12 +279,10 @@ impl CommonPduConfig {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn source_id(&self) -> UnsignedByteField {
|
pub fn source_id(&self) -> UnsignedByteField {
|
||||||
self.source_entity_id
|
self.source_entity_id
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn source_dest_id_check(
|
fn source_dest_id_check(
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
dest_id: impl Into<UnsignedByteField>,
|
dest_id: impl Into<UnsignedByteField>,
|
||||||
@ -244,7 +305,6 @@ impl CommonPduConfig {
|
|||||||
Ok((source_id, dest_id))
|
Ok((source_id, dest_id))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_source_and_dest_id(
|
pub fn set_source_and_dest_id(
|
||||||
&mut self,
|
&mut self,
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
@ -256,7 +316,6 @@ impl CommonPduConfig {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn dest_id(&self) -> UnsignedByteField {
|
pub fn dest_id(&self) -> UnsignedByteField {
|
||||||
self.dest_entity_id
|
self.dest_entity_id
|
||||||
}
|
}
|
||||||
@ -265,7 +324,6 @@ impl CommonPduConfig {
|
|||||||
impl Default for CommonPduConfig {
|
impl Default for CommonPduConfig {
|
||||||
/// The defaults for the source ID, destination ID and the transaction sequence number is the
|
/// The defaults for the source ID, destination ID and the transaction sequence number is the
|
||||||
/// [UnsignedByteFieldU8] with an intitial value of 0
|
/// [UnsignedByteFieldU8] with an intitial value of 0
|
||||||
#[inline]
|
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
// The new function can not fail for these input parameters.
|
// The new function can not fail for these input parameters.
|
||||||
Self::new(
|
Self::new(
|
||||||
@ -282,7 +340,6 @@ impl Default for CommonPduConfig {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for CommonPduConfig {
|
impl PartialEq for CommonPduConfig {
|
||||||
#[inline]
|
|
||||||
fn eq(&self, other: &Self) -> bool {
|
fn eq(&self, other: &Self) -> bool {
|
||||||
self.source_entity_id.value() == other.source_entity_id.value()
|
self.source_entity_id.value() == other.source_entity_id.value()
|
||||||
&& self.dest_entity_id.value() == other.dest_entity_id.value()
|
&& self.dest_entity_id.value() == other.dest_entity_id.value()
|
||||||
@ -301,7 +358,6 @@ pub const FIXED_HEADER_LEN: usize = 4;
|
|||||||
/// For detailed information, refer to chapter 5.1 of the CFDP standard.
|
/// For detailed information, refer to chapter 5.1 of the CFDP standard.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct PduHeader {
|
pub struct PduHeader {
|
||||||
pdu_type: PduType,
|
pdu_type: PduType,
|
||||||
pdu_conf: CommonPduConfig,
|
pdu_conf: CommonPduConfig,
|
||||||
@ -311,7 +367,6 @@ pub struct PduHeader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl PduHeader {
|
impl PduHeader {
|
||||||
#[inline]
|
|
||||||
pub fn new_for_file_data(
|
pub fn new_for_file_data(
|
||||||
pdu_conf: CommonPduConfig,
|
pdu_conf: CommonPduConfig,
|
||||||
pdu_datafield_len: u16,
|
pdu_datafield_len: u16,
|
||||||
@ -327,7 +382,6 @@ impl PduHeader {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_for_file_data_default(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
pub fn new_for_file_data_default(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
PduType::FileData,
|
PduType::FileData,
|
||||||
@ -337,7 +391,6 @@ impl PduHeader {
|
|||||||
SegmentationControl::NoRecordBoundaryPreservation,
|
SegmentationControl::NoRecordBoundaryPreservation,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
#[inline]
|
|
||||||
pub fn new_no_file_data(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
pub fn new_no_file_data(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
PduType::FileDirective,
|
PduType::FileDirective,
|
||||||
@ -348,7 +401,6 @@ impl PduHeader {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_generic(
|
pub fn new_generic(
|
||||||
pdu_type: PduType,
|
pdu_type: PduType,
|
||||||
pdu_conf: CommonPduConfig,
|
pdu_conf: CommonPduConfig,
|
||||||
@ -366,7 +418,6 @@ impl PduHeader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Returns only the length of the PDU header when written to a raw buffer.
|
/// Returns only the length of the PDU header when written to a raw buffer.
|
||||||
#[inline]
|
|
||||||
pub fn header_len(&self) -> usize {
|
pub fn header_len(&self) -> usize {
|
||||||
FIXED_HEADER_LEN
|
FIXED_HEADER_LEN
|
||||||
+ self.pdu_conf.source_entity_id.size()
|
+ self.pdu_conf.source_entity_id.size()
|
||||||
@ -374,14 +425,12 @@ impl PduHeader {
|
|||||||
+ self.pdu_conf.dest_entity_id.size()
|
+ self.pdu_conf.dest_entity_id.size()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn pdu_datafield_len(&self) -> usize {
|
pub fn pdu_datafield_len(&self) -> usize {
|
||||||
self.pdu_datafield_len.into()
|
self.pdu_datafield_len.into()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the full length of the PDU when written to a raw buffer, which is the header length
|
/// Returns the full length of the PDU when written to a raw buffer, which is the header length
|
||||||
/// plus the PDU datafield length.
|
/// plus the PDU datafield length.
|
||||||
#[inline]
|
|
||||||
pub fn pdu_len(&self) -> usize {
|
pub fn pdu_len(&self) -> usize {
|
||||||
self.header_len() + self.pdu_datafield_len as usize
|
self.header_len() + self.pdu_datafield_len as usize
|
||||||
}
|
}
|
||||||
@ -454,7 +503,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::Checksum(u16::from_be_bytes(
|
return Err(PduError::ChecksumError(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(),
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
@ -554,13 +603,10 @@ impl PduHeader {
|
|||||||
current_idx,
|
current_idx,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn pdu_type(&self) -> PduType {
|
pub fn pdu_type(&self) -> PduType {
|
||||||
self.pdu_type
|
self.pdu_type
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn common_pdu_conf(&self) -> &CommonPduConfig {
|
pub fn common_pdu_conf(&self) -> &CommonPduConfig {
|
||||||
&self.pdu_conf
|
&self.pdu_conf
|
||||||
}
|
}
|
||||||
@ -568,8 +614,6 @@ impl PduHeader {
|
|||||||
pub fn seg_metadata_flag(&self) -> SegmentMetadataFlag {
|
pub fn seg_metadata_flag(&self) -> SegmentMetadataFlag {
|
||||||
self.seg_metadata_flag
|
self.seg_metadata_flag
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn seg_ctrl(&self) -> SegmentationControl {
|
pub fn seg_ctrl(&self) -> SegmentationControl {
|
||||||
self.seg_ctrl
|
self.seg_ctrl
|
||||||
}
|
}
|
||||||
@ -903,7 +947,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);
|
||||||
@ -951,7 +995,7 @@ mod tests {
|
|||||||
assert_eq!(expected, 7);
|
assert_eq!(expected, 7);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
error.to_string(),
|
error.to_string(),
|
||||||
"byte conversion error: source slice with size 6 too small, expected at least 7 bytes"
|
"source slice with size 6 too small, expected at least 7 bytes"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -1006,7 +1050,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 ID length 1 and destination ID length 2"
|
"missmatch of PDU source length 1 and destination length 2"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -12,7 +12,6 @@ use super::{
|
|||||||
/// Helper type to encapsulate both normal file size segment requests and large file size segment
|
/// Helper type to encapsulate both normal file size segment requests and large file size segment
|
||||||
/// requests.
|
/// requests.
|
||||||
#[derive(Debug, PartialEq, Eq, Clone)]
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub enum SegmentRequests<'a> {
|
pub enum SegmentRequests<'a> {
|
||||||
U32Pairs(&'a [(u32, u32)]),
|
U32Pairs(&'a [(u32, u32)]),
|
||||||
U64Pairs(&'a [(u64, u64)]),
|
U64Pairs(&'a [(u64, u64)]),
|
||||||
@ -32,7 +31,6 @@ impl SegmentRequests<'_> {
|
|||||||
/// It exposes a specialized API which simplifies to generate these NAK PDUs with the
|
/// It exposes a specialized API which simplifies to generate these NAK PDUs with the
|
||||||
/// format according to CFDP chapter 5.2.6.
|
/// format according to CFDP chapter 5.2.6.
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct NakPduCreator<'seg_reqs> {
|
pub struct NakPduCreator<'seg_reqs> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
start_of_scope: u64,
|
start_of_scope: u64,
|
||||||
@ -61,7 +59,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<'seg_reqs>, PduError> {
|
) -> Result<NakPduCreator, 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 +77,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<'seg_reqs>, PduError> {
|
) -> Result<NakPduCreator, 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 +95,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<'seg_reqs>, PduError> {
|
) -> Result<NakPduCreator, 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 +267,7 @@ impl SegReqFromBytes for u64 {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> Iterator for SegmentRequestIter<'_, T>
|
impl<'a, T> Iterator for SegmentRequestIter<'a, T>
|
||||||
where
|
where
|
||||||
T: SegReqFromBytes,
|
T: SegReqFromBytes,
|
||||||
{
|
{
|
||||||
@ -282,8 +280,8 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'_, u32> {
|
impl<'a, 'b> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'b, u32> {
|
||||||
fn eq(&self, other: &SegmentRequests<'a>) -> bool {
|
fn eq(&self, other: &SegmentRequests) -> 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 +294,8 @@ impl<'a> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'_, u32> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'_, u64> {
|
impl<'a, 'b> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'b, u64> {
|
||||||
fn eq(&self, other: &SegmentRequests<'a>) -> bool {
|
fn eq(&self, other: &SegmentRequests) -> 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 +308,7 @@ impl<'a> PartialEq<SegmentRequests<'a>> for SegmentRequestIter<'_, u64> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> SegmentRequestIter<'_, T>
|
impl<'a, T> SegmentRequestIter<'a, T>
|
||||||
where
|
where
|
||||||
T: SegReqFromBytes + PartialEq,
|
T: SegReqFromBytes + PartialEq,
|
||||||
{
|
{
|
||||||
@ -355,7 +353,6 @@ impl<T: SegReqFromBytes> SegmentRequestIter<'_, T> {
|
|||||||
///
|
///
|
||||||
/// The NAK format is expected to be conforming to CFDP chapter 5.2.6.
|
/// The NAK format is expected to be conforming to CFDP chapter 5.2.6.
|
||||||
#[derive(Debug, PartialEq, Eq)]
|
#[derive(Debug, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct NakPduReader<'seg_reqs> {
|
pub struct NakPduReader<'seg_reqs> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
start_of_scope: u64,
|
start_of_scope: u64,
|
||||||
@ -374,11 +371,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<'seg_reqs>, PduError> {
|
pub fn new(buf: &'seg_reqs [u8]) -> Result<NakPduReader, PduError> {
|
||||||
Self::from_bytes(buf)
|
Self::from_bytes(buf)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn from_bytes(buf: &'seg_reqs [u8]) -> Result<NakPduReader<'seg_reqs>, PduError> {
|
pub fn from_bytes(buf: &'seg_reqs [u8]) -> Result<NakPduReader, 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 +471,7 @@ impl<'seg_reqs> NakPduReader<'seg_reqs> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> PartialEq<NakPduCreator<'a>> for NakPduReader<'_> {
|
impl<'a, 'b> PartialEq<NakPduCreator<'a>> for NakPduReader<'b> {
|
||||||
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 +748,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 value for NAK PDU"
|
"invalid start or end of scope for NAK PDU"
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
panic!("unexpected error {error}");
|
panic!("unexpected error {error}");
|
||||||
@ -796,7 +793,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::Checksum(raw)) = nak_pdu_deser {
|
if let Err(PduError::ChecksumError(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())
|
||||||
|
@ -9,14 +9,10 @@ use crate::ByteConversionError;
|
|||||||
use alloc::vec;
|
use alloc::vec;
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use alloc::vec::Vec;
|
use alloc::vec::Vec;
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub use alloc_mod::*;
|
|
||||||
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::{InvalidTlvTypeFieldError, TlvLvDataTooLargeError};
|
|
||||||
|
|
||||||
pub mod msg_to_user;
|
pub mod msg_to_user;
|
||||||
|
|
||||||
pub const MIN_TLV_LEN: usize = 2;
|
pub const MIN_TLV_LEN: usize = 2;
|
||||||
@ -43,26 +39,6 @@ pub trait GenericTlv {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait ReadableTlv {
|
|
||||||
fn value(&self) -> &[u8];
|
|
||||||
|
|
||||||
/// Checks whether the value field is empty.
|
|
||||||
fn is_empty(&self) -> bool {
|
|
||||||
self.value().is_empty()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Helper method to retrieve the length of the value. Simply calls the [slice::len] method of
|
|
||||||
/// [Self::value]
|
|
||||||
fn len_value(&self) -> usize {
|
|
||||||
self.value().len()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns the full raw length, including the length byte.
|
|
||||||
fn len_full(&self) -> usize {
|
|
||||||
self.len_value() + 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub trait WritableTlv {
|
pub trait WritableTlv {
|
||||||
fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>;
|
fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>;
|
||||||
fn len_written(&self) -> usize;
|
fn len_written(&self) -> usize;
|
||||||
@ -76,7 +52,6 @@ pub trait WritableTlv {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum TlvType {
|
pub enum TlvType {
|
||||||
FilestoreRequest = 0x00,
|
FilestoreRequest = 0x00,
|
||||||
@ -89,7 +64,6 @@ pub enum TlvType {
|
|||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub enum TlvTypeField {
|
pub enum TlvTypeField {
|
||||||
Standard(TlvType),
|
Standard(TlvType),
|
||||||
Custom(u8),
|
Custom(u8),
|
||||||
@ -97,7 +71,6 @@ pub enum TlvTypeField {
|
|||||||
|
|
||||||
#[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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FilestoreActionCode {
|
pub enum FilestoreActionCode {
|
||||||
CreateFile = 0b0000,
|
CreateFile = 0b0000,
|
||||||
@ -145,7 +118,6 @@ impl From<TlvTypeField> for u8 {
|
|||||||
/// this will be the lifetime of that data reference.
|
/// this will be the lifetime of that data reference.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct Tlv<'data> {
|
pub struct Tlv<'data> {
|
||||||
tlv_type_field: TlvTypeField,
|
tlv_type_field: TlvTypeField,
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
@ -153,14 +125,14 @@ pub struct Tlv<'data> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<'data> Tlv<'data> {
|
impl<'data> Tlv<'data> {
|
||||||
pub fn new(tlv_type: TlvType, data: &[u8]) -> Result<Tlv, TlvLvDataTooLargeError> {
|
pub fn new(tlv_type: TlvType, data: &[u8]) -> Result<Tlv, TlvLvError> {
|
||||||
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, TlvLvDataTooLargeError> {
|
pub fn new_with_custom_type(tlv_type: u8, data: &[u8]) -> Result<Tlv, TlvLvError> {
|
||||||
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)?,
|
||||||
@ -175,11 +147,31 @@ impl<'data> Tlv<'data> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn value(&self) -> &[u8] {
|
||||||
|
self.lv.value()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Checks whether the value field is empty.
|
||||||
|
pub fn is_empty(&self) -> bool {
|
||||||
|
self.value().is_empty()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Helper method to retrieve the length of the value. Simply calls the [slice::len] method of
|
||||||
|
/// [Self::value]
|
||||||
|
pub fn len_value(&self) -> usize {
|
||||||
|
self.value().len()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the full raw length, including the length byte.
|
||||||
|
pub fn len_full(&self) -> usize {
|
||||||
|
self.len_value() + 2
|
||||||
|
}
|
||||||
|
|
||||||
/// Creates a TLV give a raw bytestream. Please note that is is not necessary to pass the
|
/// Creates a TLV give a raw bytestream. Please note that is is not necessary to pass the
|
||||||
/// 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>, ByteConversionError> {
|
pub fn from_bytes(buf: &'data [u8]) -> Result<Tlv<'data>, TlvLvError> {
|
||||||
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]),
|
||||||
@ -196,27 +188,6 @@ impl<'data> Tlv<'data> {
|
|||||||
pub fn raw_data(&self) -> Option<&[u8]> {
|
pub fn raw_data(&self) -> Option<&[u8]> {
|
||||||
self.lv.raw_data()
|
self.lv.raw_data()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn to_owned(&self) -> TlvOwned {
|
|
||||||
TlvOwned {
|
|
||||||
tlv_type_field: self.tlv_type_field,
|
|
||||||
data: self.value().to_vec(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
impl PartialEq<TlvOwned> for Tlv<'_> {
|
|
||||||
fn eq(&self, other: &TlvOwned) -> bool {
|
|
||||||
self.tlv_type_field == other.tlv_type_field && self.value() == other.value()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ReadableTlv for Tlv<'_> {
|
|
||||||
fn value(&self) -> &[u8] {
|
|
||||||
self.lv.value()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritableTlv for Tlv<'_> {
|
impl WritableTlv for Tlv<'_> {
|
||||||
@ -237,95 +208,22 @@ impl GenericTlv for Tlv<'_> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
pub(crate) fn verify_tlv_type(raw_type: u8, expected_tlv_type: TlvType) -> Result<(), TlvLvError> {
|
||||||
pub mod alloc_mod {
|
let tlv_type = TlvType::try_from(raw_type).map_err(|_| TlvLvError::InvalidTlvTypeField {
|
||||||
use super::*;
|
found: raw_type,
|
||||||
|
expected: Some(expected_tlv_type.into()),
|
||||||
/// Owned variant of [Tlv] which is consequently [Clone]able and does not have a lifetime
|
})?;
|
||||||
/// associated to a data slice.
|
if tlv_type != expected_tlv_type {
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
found: tlv_type as u8,
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
expected: Some(expected_tlv_type as u8),
|
||||||
pub struct TlvOwned {
|
});
|
||||||
pub(crate) tlv_type_field: TlvTypeField,
|
|
||||||
pub(crate) data: Vec<u8>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TlvOwned {
|
|
||||||
pub fn new(tlv_type: TlvType, data: &[u8]) -> Self {
|
|
||||||
Self {
|
|
||||||
tlv_type_field: TlvTypeField::Standard(tlv_type),
|
|
||||||
data: data.to_vec(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn new_with_custom_type(tlv_type: u8, data: &[u8]) -> Self {
|
|
||||||
Self {
|
|
||||||
tlv_type_field: TlvTypeField::Custom(tlv_type),
|
|
||||||
data: data.to_vec(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Creates a TLV with an empty value field.
|
|
||||||
pub fn new_empty(tlv_type: TlvType) -> Self {
|
|
||||||
Self {
|
|
||||||
tlv_type_field: TlvTypeField::Standard(tlv_type),
|
|
||||||
data: Vec::new(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn as_tlv(&self) -> Tlv<'_> {
|
|
||||||
Tlv {
|
|
||||||
tlv_type_field: self.tlv_type_field,
|
|
||||||
// The API should ensure that the data length is never to large, so the unwrap for the
|
|
||||||
// LV creation should never be an issue.
|
|
||||||
lv: Lv::new(&self.data).expect("lv creation failed unexpectedly"),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ReadableTlv for TlvOwned {
|
|
||||||
fn value(&self) -> &[u8] {
|
|
||||||
&self.data
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WritableTlv for TlvOwned {
|
|
||||||
fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
|
||||||
generic_len_check_data_serialization(buf, self.data.len(), MIN_TLV_LEN)?;
|
|
||||||
buf[0] = self.tlv_type_field.into();
|
|
||||||
buf[1] = self.data.len() as u8;
|
|
||||||
buf[2..2 + self.data.len()].copy_from_slice(&self.data);
|
|
||||||
Ok(self.len_written())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn len_written(&self) -> usize {
|
|
||||||
self.data.len() + 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl GenericTlv for TlvOwned {
|
|
||||||
fn tlv_type_field(&self) -> TlvTypeField {
|
|
||||||
self.tlv_type_field
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<Tlv<'_>> for TlvOwned {
|
|
||||||
fn from(value: Tlv<'_>) -> Self {
|
|
||||||
value.to_owned()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PartialEq<Tlv<'_>> for TlvOwned {
|
|
||||||
fn eq(&self, other: &Tlv) -> bool {
|
|
||||||
self.tlv_type_field == other.tlv_type_field && self.data == other.value()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct EntityIdTlv {
|
pub struct EntityIdTlv {
|
||||||
entity_id: UnsignedByteField,
|
entity_id: UnsignedByteField,
|
||||||
}
|
}
|
||||||
@ -374,8 +272,11 @@ impl EntityIdTlv {
|
|||||||
Self::len_check(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()])?;
|
||||||
// Can't fail.
|
Tlv::new(TlvType::EntityId, &buf[2..2 + self.entity_id.size()]).map_err(|e| match e {
|
||||||
Ok(Tlv::new(TlvType::EntityId, &buf[2..2 + self.entity_id.size()]).unwrap())
|
TlvLvError::ByteConversion(e) => e,
|
||||||
|
// All other errors are impossible.
|
||||||
|
_ => panic!("unexpected TLV error"),
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -398,26 +299,24 @@ impl GenericTlv for EntityIdTlv {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl TryFrom<Tlv<'_>> for EntityIdTlv {
|
impl<'data> TryFrom<Tlv<'data>> for EntityIdTlv {
|
||||||
type Error = TlvLvError;
|
type Error = TlvLvError;
|
||||||
|
|
||||||
fn try_from(value: Tlv) -> Result<Self, TlvLvError> {
|
fn try_from(value: Tlv) -> Result<Self, Self::Error> {
|
||||||
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(InvalidTlvTypeFieldError {
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
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(InvalidTlvTypeFieldError {
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
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();
|
||||||
@ -449,7 +348,6 @@ pub fn fs_request_has_second_filename(action_code: FilestoreActionCode) -> bool
|
|||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
struct FilestoreTlvBase<'first_name, 'second_name> {
|
struct FilestoreTlvBase<'first_name, 'second_name> {
|
||||||
pub action_code: FilestoreActionCode,
|
pub action_code: FilestoreActionCode,
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
@ -663,7 +561,6 @@ impl GenericTlv for FilestoreRequestTlv<'_, '_> {
|
|||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct FilestoreResponseTlv<'first_name, 'second_name, 'fs_msg> {
|
pub struct FilestoreResponseTlv<'first_name, 'second_name, 'fs_msg> {
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
base: FilestoreTlvBase<'first_name, 'second_name>,
|
base: FilestoreTlvBase<'first_name, 'second_name>,
|
||||||
@ -848,23 +745,6 @@ impl GenericTlv for FilestoreResponseTlv<'_, '_, '_> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn verify_tlv_type(
|
|
||||||
raw_type: u8,
|
|
||||||
expected_tlv_type: TlvType,
|
|
||||||
) -> Result<(), InvalidTlvTypeFieldError> {
|
|
||||||
let tlv_type = TlvType::try_from(raw_type).map_err(|_| InvalidTlvTypeFieldError {
|
|
||||||
found: raw_type,
|
|
||||||
expected: Some(expected_tlv_type.into()),
|
|
||||||
})?;
|
|
||||||
if tlv_type != expected_tlv_type {
|
|
||||||
return Err(InvalidTlvTypeFieldError {
|
|
||||||
found: tlv_type as u8,
|
|
||||||
expected: Some(expected_tlv_type as u8),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
@ -1052,14 +932,14 @@ 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();
|
||||||
match error {
|
if let TlvLvError::DataTooLarge(size) = error {
|
||||||
TlvLvDataTooLargeError(size) => {
|
assert_eq!(size, u8::MAX as usize + 1);
|
||||||
assert_eq!(size, u8::MAX as usize + 1);
|
assert_eq!(
|
||||||
assert_eq!(
|
error.to_string(),
|
||||||
error.to_string(),
|
"data with size 256 larger than allowed 255 bytes"
|
||||||
"data with size 256 larger than allowed 255 bytes"
|
);
|
||||||
);
|
} else {
|
||||||
}
|
panic!("unexpected error {:?}", error);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1369,8 +1249,7 @@ 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(InvalidTlvTypeFieldError { found, expected }) = error
|
if let TlvLvError::InvalidTlvTypeField { 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!(
|
||||||
@ -1414,71 +1293,4 @@ mod tests {
|
|||||||
assert_eq!(tlv_as_vec[0], 20);
|
assert_eq!(tlv_as_vec[0], 20);
|
||||||
assert_eq!(tlv_as_vec[1], 0);
|
assert_eq!(tlv_as_vec[1], 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_tlv_to_owned() {
|
|
||||||
let entity_id = UbfU8::new(5);
|
|
||||||
let mut buf: [u8; 4] = [0; 4];
|
|
||||||
assert!(entity_id.write_to_be_bytes(&mut buf).is_ok());
|
|
||||||
let tlv_res = Tlv::new(TlvType::EntityId, &buf[0..1]);
|
|
||||||
assert!(tlv_res.is_ok());
|
|
||||||
let tlv_res = tlv_res.unwrap();
|
|
||||||
let tlv_owned = tlv_res.to_owned();
|
|
||||||
assert_eq!(tlv_res, tlv_owned);
|
|
||||||
let tlv_owned_from_conversion: TlvOwned = tlv_res.into();
|
|
||||||
assert_eq!(tlv_owned_from_conversion, tlv_owned);
|
|
||||||
assert_eq!(tlv_owned_from_conversion, tlv_res);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_owned_tlv() {
|
|
||||||
let entity_id = UbfU8::new(5);
|
|
||||||
let mut buf: [u8; 4] = [0; 4];
|
|
||||||
assert!(entity_id.write_to_be_bytes(&mut buf).is_ok());
|
|
||||||
let tlv_res = TlvOwned::new(TlvType::EntityId, &buf[0..1]);
|
|
||||||
assert_eq!(
|
|
||||||
tlv_res.tlv_type_field(),
|
|
||||||
TlvTypeField::Standard(TlvType::EntityId)
|
|
||||||
);
|
|
||||||
assert_eq!(tlv_res.len_full(), 3);
|
|
||||||
assert_eq!(tlv_res.value().len(), 1);
|
|
||||||
assert_eq!(tlv_res.len_value(), 1);
|
|
||||||
assert!(!tlv_res.is_empty());
|
|
||||||
assert_eq!(tlv_res.value()[0], 5);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_owned_tlv_empty() {
|
|
||||||
let tlv_res = TlvOwned::new_empty(TlvType::FlowLabel);
|
|
||||||
assert_eq!(
|
|
||||||
tlv_res.tlv_type_field(),
|
|
||||||
TlvTypeField::Standard(TlvType::FlowLabel)
|
|
||||||
);
|
|
||||||
assert_eq!(tlv_res.len_full(), 2);
|
|
||||||
assert_eq!(tlv_res.value().len(), 0);
|
|
||||||
assert_eq!(tlv_res.len_value(), 0);
|
|
||||||
assert!(tlv_res.is_empty());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_owned_tlv_custom_type() {
|
|
||||||
let tlv_res = TlvOwned::new_with_custom_type(32, &[]);
|
|
||||||
assert_eq!(tlv_res.tlv_type_field(), TlvTypeField::Custom(32));
|
|
||||||
assert_eq!(tlv_res.len_full(), 2);
|
|
||||||
assert_eq!(tlv_res.value().len(), 0);
|
|
||||||
assert_eq!(tlv_res.len_value(), 0);
|
|
||||||
assert!(tlv_res.is_empty());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_owned_tlv_conversion_to_bytes() {
|
|
||||||
let entity_id = UbfU8::new(5);
|
|
||||||
let mut buf: [u8; 4] = [0; 4];
|
|
||||||
assert!(entity_id.write_to_be_bytes(&mut buf).is_ok());
|
|
||||||
let tlv_res = Tlv::new(TlvType::EntityId, &buf[0..1]);
|
|
||||||
assert!(tlv_res.is_ok());
|
|
||||||
let tlv_res = tlv_res.unwrap();
|
|
||||||
let tlv_owned_from_conversion: TlvOwned = tlv_res.into();
|
|
||||||
assert_eq!(tlv_res.to_vec(), tlv_owned_from_conversion.to_vec());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -1,11 +1,6 @@
|
|||||||
//! Abstractions for the Message to User CFDP TLV subtype.
|
//! Abstractions for the Message to User CFDP TLV subtype.
|
||||||
#[cfg(feature = "alloc")]
|
use super::{GenericTlv, Tlv, TlvLvError, TlvType, TlvTypeField, WritableTlv};
|
||||||
use super::TlvOwned;
|
use crate::ByteConversionError;
|
||||||
use super::{GenericTlv, ReadableTlv, Tlv, TlvLvError, TlvType, TlvTypeField, WritableTlv};
|
|
||||||
use crate::{
|
|
||||||
cfdp::{InvalidTlvTypeFieldError, TlvLvDataTooLargeError},
|
|
||||||
ByteConversionError,
|
|
||||||
};
|
|
||||||
use delegate::delegate;
|
use delegate::delegate;
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
@ -15,7 +10,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>, TlvLvDataTooLargeError> {
|
pub fn new(value: &'data [u8]) -> Result<MsgToUserTlv<'data>, TlvLvError> {
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
tlv: Tlv::new(TlvType::MsgToUser, value)?,
|
tlv: Tlv::new(TlvType::MsgToUser, value)?,
|
||||||
})
|
})
|
||||||
@ -65,38 +60,21 @@ 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(InvalidTlvTypeFieldError {
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
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(InvalidTlvTypeFieldError {
|
return Err(TlvLvError::InvalidTlvTypeField {
|
||||||
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)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn to_tlv(&self) -> Tlv<'data> {
|
|
||||||
self.tlv
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn to_owned(&self) -> TlvOwned {
|
|
||||||
self.tlv.to_owned()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'a> From<MsgToUserTlv<'a>> for Tlv<'a> {
|
|
||||||
fn from(value: MsgToUserTlv<'a>) -> Tlv<'a> {
|
|
||||||
value.to_tlv()
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritableTlv for MsgToUserTlv<'_> {
|
impl WritableTlv for MsgToUserTlv<'_> {
|
||||||
@ -161,40 +139,6 @@ mod tests {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_msg_to_user_type_reduction() {
|
|
||||||
let custom_value: [u8; 4] = [1, 2, 3, 4];
|
|
||||||
let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
|
|
||||||
let tlv = msg_to_user.to_tlv();
|
|
||||||
assert_eq!(
|
|
||||||
tlv.tlv_type_field(),
|
|
||||||
TlvTypeField::Standard(TlvType::MsgToUser)
|
|
||||||
);
|
|
||||||
|
|
||||||
assert_eq!(tlv.value(), custom_value);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_msg_to_user_to_tlv() {
|
|
||||||
let custom_value: [u8; 4] = [1, 2, 3, 4];
|
|
||||||
let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
|
|
||||||
let tlv: Tlv = msg_to_user.into();
|
|
||||||
assert_eq!(msg_to_user.to_tlv(), tlv);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_msg_to_user_owner_converter() {
|
|
||||||
let custom_value: [u8; 4] = [1, 2, 3, 4];
|
|
||||||
let msg_to_user = MsgToUserTlv::new(&custom_value).unwrap();
|
|
||||||
let tlv = msg_to_user.to_owned();
|
|
||||||
assert_eq!(
|
|
||||||
tlv.tlv_type_field(),
|
|
||||||
TlvTypeField::Standard(TlvType::MsgToUser)
|
|
||||||
);
|
|
||||||
|
|
||||||
assert_eq!(tlv.value(), custom_value);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_reserved_msg_deserialization() {
|
fn test_reserved_msg_deserialization() {
|
||||||
let custom_value: [u8; 3] = [1, 2, 3];
|
let custom_value: [u8; 3] = [1, 2, 3];
|
||||||
@ -210,9 +154,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(inner) = error {
|
if let TlvLvError::InvalidTlvTypeField { found, expected } = error {
|
||||||
assert_eq!(inner.found, TlvType::FlowLabel as u8);
|
assert_eq!(found, TlvType::FlowLabel as u8);
|
||||||
assert_eq!(inner.expected, Some(TlvType::MsgToUser as u8));
|
assert_eq!(expected, Some(TlvType::MsgToUser as u8));
|
||||||
} else {
|
} else {
|
||||||
panic!("Wrong error type returned: {:?}", error);
|
panic!("Wrong error type returned: {:?}", error);
|
||||||
}
|
}
|
||||||
|
11
src/crc.rs
11
src/crc.rs
@ -1,11 +0,0 @@
|
|||||||
/// 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);
|
|
@ -5,7 +5,6 @@ use serde::{Deserialize, Serialize};
|
|||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum Subservice {
|
pub enum Subservice {
|
||||||
// Regular HK
|
// Regular HK
|
||||||
|
121
src/ecss/mod.rs
121
src/ecss/mod.rs
@ -1,19 +1,18 @@
|
|||||||
//! Common definitions and helpers required to create PUS TMTC packets according to
|
//! Common definitions and helpers required to create PUS TMTC packets according to
|
||||||
//! [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/)
|
//! [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/)
|
||||||
//!
|
//!
|
||||||
//! You can find the PUS telecommand types in the [tc] module and the the PUS telemetry
|
//! You can find the PUS telecommand definitions in the [tc] module and ithe PUS telemetry definitions
|
||||||
//! types inside the [tm] module.
|
//! inside the [tm] module.
|
||||||
use crate::{
|
use crate::{ByteConversionError, CcsdsPacket, CRC_CCITT_FALSE};
|
||||||
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;
|
use core::fmt::{Debug, Display, Formatter};
|
||||||
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;
|
||||||
@ -23,6 +22,7 @@ pub mod tm;
|
|||||||
pub mod verification;
|
pub mod verification;
|
||||||
|
|
||||||
pub type CrcType = u16;
|
pub type CrcType = u16;
|
||||||
|
pub const CCSDS_HEADER_LEN: usize = size_of::<crate::zc::SpHeader>();
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
|
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
@ -74,7 +74,6 @@ pub enum PusServiceId {
|
|||||||
/// All PUS versions. Only PUS C is supported by this library.
|
/// All PUS versions. Only PUS C is supported by this library.
|
||||||
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
pub enum PusVersion {
|
pub enum PusVersion {
|
||||||
EsaPus = 0,
|
EsaPus = 0,
|
||||||
@ -149,19 +148,49 @@ pub enum PfcReal {
|
|||||||
DoubleMilStd = 4,
|
DoubleMilStd = 4,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
|
#[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))]
|
|
||||||
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
|
||||||
//#[error("crc16 was not calculated")]
|
CrcCalculationMissing,
|
||||||
//CrcCalculationMissing,
|
ByteConversion(ByteConversionError),
|
||||||
#[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
|
||||||
@ -173,7 +202,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 opt_crc16(&self) -> Option<u16>;
|
fn 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> {
|
||||||
@ -210,21 +239,12 @@ pub(crate) fn user_data_from_raw(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
pub(crate) fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
||||||
raw_data: &[u8],
|
raw_data: &[u8],
|
||||||
crc16: u16,
|
crc16: u16,
|
||||||
) -> Result<(), PusError> {
|
) -> Result<(), PusError> {
|
||||||
verify_crc16_ccitt_false_from_raw(raw_data)
|
verify_crc16_ccitt_false_from_raw(raw_data)
|
||||||
.then_some(())
|
.then(|| ())
|
||||||
.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))
|
.ok_or(PusError::ChecksumFailure(crc16))
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -237,25 +257,12 @@ 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 {
|
||||||
#[inline]
|
|
||||||
fn ccsds_version(&self) -> u8;
|
fn ccsds_version(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn packet_id(&self) -> crate::PacketId;
|
fn packet_id(&self) -> crate::PacketId;
|
||||||
#[inline]
|
|
||||||
fn psc(&self) -> crate::PacketSequenceCtrl;
|
fn psc(&self) -> crate::PacketSequenceCtrl;
|
||||||
#[inline]
|
|
||||||
fn data_len(&self) -> u16;
|
fn data_len(&self) -> u16;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -264,11 +271,8 @@ macro_rules! ccsds_impl {
|
|||||||
macro_rules! sp_header_impls {
|
macro_rules! sp_header_impls {
|
||||||
() => {
|
() => {
|
||||||
delegate!(to self.sp_header {
|
delegate!(to self.sp_header {
|
||||||
#[inline]
|
|
||||||
pub fn set_apid(&mut self, apid: u16) -> bool;
|
pub fn set_apid(&mut self, apid: u16) -> bool;
|
||||||
#[inline]
|
|
||||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
||||||
#[inline]
|
|
||||||
pub fn set_seq_flags(&mut self, seq_flag: SequenceFlags);
|
pub fn set_seq_flags(&mut self, seq_flag: SequenceFlags);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -370,34 +374,7 @@ 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_FALSE] 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
|
||||||
|
@ -54,7 +54,6 @@ pub enum SchedStatus {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl From<bool> for SchedStatus {
|
impl From<bool> for SchedStatus {
|
||||||
#[inline]
|
|
||||||
fn from(value: bool) -> Self {
|
fn from(value: bool) -> Self {
|
||||||
if value {
|
if value {
|
||||||
SchedStatus::Enabled
|
SchedStatus::Enabled
|
||||||
|
549
src/ecss/tc.rs
549
src/ecss/tc.rs
@ -9,11 +9,9 @@
|
|||||||
//! use spacepackets::ecss::tc::{PusTcCreator, PusTcReader, PusTcSecondaryHeader};
|
//! use spacepackets::ecss::tc::{PusTcCreator, PusTcReader, PusTcSecondaryHeader};
|
||||||
//!
|
//!
|
||||||
//! // Create a ping telecommand with no user application data
|
//! // Create a ping telecommand with no user application data
|
||||||
//! let pus_tc = PusTcCreator::new_no_app_data(
|
//! let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||||
//! SpHeader::new_from_apid(0x02),
|
//! let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
||||||
//! PusTcSecondaryHeader::new_simple(17, 1),
|
//! let pus_tc = PusTcCreator::new_no_app_data(&mut sph, tc_header, true);
|
||||||
//! true
|
|
||||||
//! );
|
|
||||||
//! println!("{:?}", pus_tc);
|
//! println!("{:?}", pus_tc);
|
||||||
//! assert_eq!(pus_tc.service(), 17);
|
//! assert_eq!(pus_tc.service(), 17);
|
||||||
//! assert_eq!(pus_tc.subservice(), 1);
|
//! assert_eq!(pus_tc.subservice(), 1);
|
||||||
@ -33,26 +31,23 @@
|
|||||||
//! 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};
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use zerocopy::{FromBytes, IntoBytes};
|
use zerocopy::AsBytes;
|
||||||
|
|
||||||
#[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 =
|
||||||
@ -64,7 +59,6 @@ pub trait IsPusTelecommand {}
|
|||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
enum AckOpts {
|
enum AckOpts {
|
||||||
Acceptance = 0b1000,
|
Acceptance = 0b1000,
|
||||||
@ -89,9 +83,9 @@ pub trait GenericPusTcSecondaryHeader {
|
|||||||
pub mod zc {
|
pub mod zc {
|
||||||
use crate::ecss::tc::GenericPusTcSecondaryHeader;
|
use crate::ecss::tc::GenericPusTcSecondaryHeader;
|
||||||
use crate::ecss::{PusError, PusVersion};
|
use crate::ecss::{PusError, PusVersion};
|
||||||
use zerocopy::{FromBytes, Immutable, IntoBytes, NetworkEndian, Unaligned, U16};
|
use zerocopy::{AsBytes, FromBytes, FromZeroes, NetworkEndian, Unaligned, U16};
|
||||||
|
|
||||||
#[derive(FromBytes, IntoBytes, Immutable, Unaligned)]
|
#[derive(FromZeroes, FromBytes, AsBytes, Unaligned)]
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
pub struct PusTcSecondaryHeader {
|
pub struct PusTcSecondaryHeader {
|
||||||
version_ack: u8,
|
version_ack: u8,
|
||||||
@ -116,36 +110,40 @@ pub mod zc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||||
#[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]
|
|
||||||
fn ack_flags(&self) -> u8 {
|
fn ack_flags(&self) -> u8 {
|
||||||
self.version_ack & 0b1111
|
self.version_ack & 0b1111
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn service(&self) -> u8 {
|
fn service(&self) -> u8 {
|
||||||
self.service
|
self.service
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn subservice(&self) -> u8 {
|
fn subservice(&self) -> u8 {
|
||||||
self.subservice
|
self.subservice
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn source_id(&self) -> u16 {
|
fn source_id(&self) -> u16 {
|
||||||
self.source_id.get()
|
self.source_id.get()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl PusTcSecondaryHeader {
|
||||||
|
pub fn write_to_bytes(&self, slice: &mut [u8]) -> Option<()> {
|
||||||
|
self.write_to(slice)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn from_bytes(slice: &[u8]) -> Option<Self> {
|
||||||
|
Self::read_from(slice)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct PusTcSecondaryHeader {
|
pub struct PusTcSecondaryHeader {
|
||||||
pub service: u8,
|
pub service: u8,
|
||||||
pub subservice: u8,
|
pub subservice: u8,
|
||||||
@ -155,27 +153,22 @@ pub struct PusTcSecondaryHeader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||||
#[inline]
|
|
||||||
fn pus_version(&self) -> PusVersion {
|
fn pus_version(&self) -> PusVersion {
|
||||||
self.version
|
self.version
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn ack_flags(&self) -> u8 {
|
fn ack_flags(&self) -> u8 {
|
||||||
self.ack
|
self.ack
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn service(&self) -> u8 {
|
fn service(&self) -> u8 {
|
||||||
self.service
|
self.service
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn subservice(&self) -> u8 {
|
fn subservice(&self) -> u8 {
|
||||||
self.subservice
|
self.subservice
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn source_id(&self) -> u16 {
|
fn source_id(&self) -> u16 {
|
||||||
self.source_id
|
self.source_id
|
||||||
}
|
}
|
||||||
@ -196,7 +189,6 @@ impl TryFrom<zc::PusTcSecondaryHeader> for PusTcSecondaryHeader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl PusTcSecondaryHeader {
|
impl PusTcSecondaryHeader {
|
||||||
#[inline]
|
|
||||||
pub fn new_simple(service: u8, subservice: u8) -> Self {
|
pub fn new_simple(service: u8, subservice: u8) -> Self {
|
||||||
PusTcSecondaryHeader {
|
PusTcSecondaryHeader {
|
||||||
service,
|
service,
|
||||||
@ -207,7 +199,6 @@ impl PusTcSecondaryHeader {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new(service: u8, subservice: u8, ack: u8, source_id: u16) -> Self {
|
pub fn new(service: u8, subservice: u8, ack: u8, source_id: u16) -> Self {
|
||||||
PusTcSecondaryHeader {
|
PusTcSecondaryHeader {
|
||||||
service,
|
service,
|
||||||
@ -229,37 +220,35 @@ impl PusTcSecondaryHeader {
|
|||||||
/// There is no spare bytes support yet.
|
/// There is no spare bytes support yet.
|
||||||
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
|
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
pub struct PusTcCreator<'raw_data> {
|
||||||
pub struct PusTcCreator<'app_data> {
|
|
||||||
sp_header: SpHeader,
|
sp_header: SpHeader,
|
||||||
pub sec_header: PusTcSecondaryHeader,
|
pub sec_header: PusTcSecondaryHeader,
|
||||||
app_data: &'app_data [u8],
|
app_data: &'raw_data [u8],
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'app_data> PusTcCreator<'app_data> {
|
impl<'raw_data> PusTcCreator<'raw_data> {
|
||||||
/// Generates a new struct instance.
|
/// Generates a new struct instance.
|
||||||
///
|
///
|
||||||
/// # 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 will be set
|
||||||
/// header flag are set correctly by the constructor.
|
/// automatically
|
||||||
/// * `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, [PusTc::update_ccsds_data_len] can be called to set
|
||||||
/// the correct value to this field manually
|
/// the correct value to this field manually
|
||||||
#[inline]
|
|
||||||
pub fn new(
|
pub fn new(
|
||||||
mut sp_header: SpHeader,
|
sp_header: &mut SpHeader,
|
||||||
sec_header: PusTcSecondaryHeader,
|
sec_header: PusTcSecondaryHeader,
|
||||||
app_data: &'app_data [u8],
|
app_data: &'raw_data [u8],
|
||||||
set_ccsds_len: bool,
|
set_ccsds_len: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
sp_header.set_packet_type(PacketType::Tc);
|
sp_header.set_packet_type(PacketType::Tc);
|
||||||
sp_header.set_sec_header_flag();
|
sp_header.set_sec_header_flag();
|
||||||
let mut pus_tc = Self {
|
let mut pus_tc = Self {
|
||||||
sp_header,
|
sp_header: *sp_header,
|
||||||
app_data,
|
app_data,
|
||||||
sec_header,
|
sec_header,
|
||||||
};
|
};
|
||||||
@ -269,44 +258,35 @@ impl<'app_data> PusTcCreator<'app_data> {
|
|||||||
pus_tc
|
pus_tc
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Simplified version of the [Self::new] function which allows to only specify service
|
/// Simplified version of the [PusTcCreator::new] function which allows to only specify service
|
||||||
/// and subservice instead of the full PUS TC secondary header.
|
/// and subservice instead of the full PUS TC secondary header.
|
||||||
#[inline]
|
|
||||||
pub fn new_simple(
|
pub fn new_simple(
|
||||||
sph: SpHeader,
|
sph: &mut SpHeader,
|
||||||
service: u8,
|
service: u8,
|
||||||
subservice: u8,
|
subservice: u8,
|
||||||
app_data: &'app_data [u8],
|
app_data: Option<&'raw_data [u8]>,
|
||||||
set_ccsds_len: bool,
|
set_ccsds_len: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Self::new(
|
Self::new(
|
||||||
sph,
|
sph,
|
||||||
PusTcSecondaryHeader::new(service, subservice, ACK_ALL, 0),
|
PusTcSecondaryHeader::new(service, subservice, ACK_ALL, 0),
|
||||||
app_data,
|
app_data.unwrap_or(&[]),
|
||||||
set_ccsds_len,
|
set_ccsds_len,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_no_app_data(
|
pub fn new_no_app_data(
|
||||||
sp_header: SpHeader,
|
sp_header: &mut SpHeader,
|
||||||
sec_header: PusTcSecondaryHeader,
|
sec_header: PusTcSecondaryHeader,
|
||||||
set_ccsds_len: bool,
|
set_ccsds_len: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Self::new(sp_header, sec_header, &[], set_ccsds_len)
|
Self::new(sp_header, sec_header, &[], set_ccsds_len)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn sp_header(&self) -> &SpHeader {
|
pub fn sp_header(&self) -> &SpHeader {
|
||||||
&self.sp_header
|
&self.sp_header
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn sp_header_mut(&mut self) -> &mut SpHeader {
|
|
||||||
&mut self.sp_header
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_ack_field(&mut self, ack: u8) -> bool {
|
pub fn set_ack_field(&mut self, ack: u8) -> bool {
|
||||||
if ack > 0b1111 {
|
if ack > 0b1111 {
|
||||||
return false;
|
return false;
|
||||||
@ -315,7 +295,6 @@ impl<'app_data> PusTcCreator<'app_data> {
|
|||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_source_id(&mut self, source_id: u16) {
|
pub fn set_source_id(&mut self, source_id: u16) {
|
||||||
self.sec_header.source_id = source_id;
|
self.sec_header.source_id = source_id;
|
||||||
}
|
}
|
||||||
@ -323,18 +302,18 @@ impl<'app_data> PusTcCreator<'app_data> {
|
|||||||
sp_header_impls!();
|
sp_header_impls!();
|
||||||
|
|
||||||
/// Calculate the CCSDS space packet data length field and sets it
|
/// Calculate the CCSDS space packet data length field and sets it
|
||||||
/// This is called automatically if the `set_ccsds_len` argument in the [Self::new] call was
|
/// This is called automatically if the `set_ccsds_len` argument in the [PusTc::new] call was
|
||||||
/// used.
|
/// used.
|
||||||
/// If this was not done or the application data is set or changed after construction,
|
/// If this was not done or the application data is set or changed after construction,
|
||||||
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
||||||
/// is set correctly.
|
/// is set correctly.
|
||||||
#[inline]
|
|
||||||
pub fn update_ccsds_data_len(&mut self) {
|
pub fn update_ccsds_data_len(&mut self) {
|
||||||
self.sp_header.data_len =
|
self.sp_header.data_len =
|
||||||
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This function calculates and returns the CRC16 for the current packet.
|
/// This function should be called before the TC packet is serialized if
|
||||||
|
/// [PusTc::calc_crc_on_serialization] is set to False. It will calculate and cache the CRC16.
|
||||||
pub fn calc_own_crc16(&self) -> u16 {
|
pub fn calc_own_crc16(&self) -> u16 {
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
||||||
@ -345,17 +324,6 @@ 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);
|
||||||
@ -372,68 +340,40 @@ impl<'app_data> PusTcCreator<'app_data> {
|
|||||||
vec.extend_from_slice(&digest.finalize().to_be_bytes());
|
vec.extend_from_slice(&digest.finalize().to_be_bytes());
|
||||||
appended_len
|
appended_len
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Write the raw PUS byte representation to a provided buffer.
|
|
||||||
pub fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, ByteConversionError> {
|
|
||||||
let writer_unfinalized = self.common_write(slice)?;
|
|
||||||
Ok(writer_unfinalized.finalize())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// 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 writer_unfinalized = self.common_write(slice)?;
|
|
||||||
Ok(writer_unfinalized.finalize_crc_no_table())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// 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 writer_unfinalized = self.common_write(slice)?;
|
|
||||||
Ok(writer_unfinalized.finalize_no_crc())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn common_write<'a>(
|
|
||||||
&self,
|
|
||||||
slice: &'a mut [u8],
|
|
||||||
) -> Result<PusTcCreatorWithReservedAppData<'a>, ByteConversionError> {
|
|
||||||
if self.len_written() > slice.len() {
|
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: slice.len(),
|
|
||||||
expected: self.len_written(),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
let mut writer_unfinalized = PusTcCreatorWithReservedAppData::write_to_bytes_partially(
|
|
||||||
slice,
|
|
||||||
self.sp_header,
|
|
||||||
self.sec_header,
|
|
||||||
self.app_data.len(),
|
|
||||||
)?;
|
|
||||||
writer_unfinalized
|
|
||||||
.app_data_mut()
|
|
||||||
.copy_from_slice(self.app_data);
|
|
||||||
Ok(writer_unfinalized)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritablePusPacket for PusTcCreator<'_> {
|
impl WritablePusPacket for PusTcCreator<'_> {
|
||||||
#[inline]
|
|
||||||
fn len_written(&self) -> usize {
|
fn len_written(&self) -> usize {
|
||||||
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.
|
/// Write the raw PUS byte representation to a provided buffer.
|
||||||
fn write_to_bytes_no_crc(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
|
||||||
Ok(Self::write_to_bytes_no_crc(self, slice)?)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
||||||
Ok(Self::write_to_bytes(self, slice)?)
|
let mut curr_idx = 0;
|
||||||
}
|
let tc_header_len = size_of::<zc::PusTcSecondaryHeader>();
|
||||||
|
let total_size = self.len_written();
|
||||||
|
if total_size > slice.len() {
|
||||||
|
return Err(ByteConversionError::ToSliceTooSmall {
|
||||||
|
found: slice.len(),
|
||||||
|
expected: total_size,
|
||||||
|
}
|
||||||
|
.into());
|
||||||
|
}
|
||||||
|
self.sp_header.write_to_be_bytes(slice)?;
|
||||||
|
curr_idx += CCSDS_HEADER_LEN;
|
||||||
|
let sec_header = zc::PusTcSecondaryHeader::try_from(self.sec_header).unwrap();
|
||||||
|
sec_header
|
||||||
|
.write_to_bytes(&mut slice[curr_idx..curr_idx + tc_header_len])
|
||||||
|
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
||||||
|
|
||||||
fn write_to_bytes_crc_no_table(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
curr_idx += tc_header_len;
|
||||||
Ok(Self::write_to_bytes_crc_no_table(self, slice)?)
|
slice[curr_idx..curr_idx + self.app_data.len()].copy_from_slice(self.app_data);
|
||||||
|
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)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -443,169 +383,32 @@ impl CcsdsPacket for PusTcCreator<'_> {
|
|||||||
|
|
||||||
impl PusPacket for PusTcCreator<'_> {
|
impl PusPacket for PusTcCreator<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
#[inline]
|
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
#[inline]
|
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
});
|
});
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn user_data(&self) -> &[u8] {
|
fn user_data(&self) -> &[u8] {
|
||||||
self.app_data
|
self.app_data
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
fn crc16(&self) -> Option<u16> {
|
||||||
fn opt_crc16(&self) -> Option<u16> {
|
|
||||||
Some(self.calc_own_crc16())
|
Some(self.calc_own_crc16())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcCreator<'_> {
|
impl GenericPusTcSecondaryHeader for PusTcCreator<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
#[inline]
|
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
#[inline]
|
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn source_id(&self) -> u16;
|
fn source_id(&self) -> u16;
|
||||||
#[inline]
|
|
||||||
fn ack_flags(&self) -> u8;
|
fn ack_flags(&self) -> u8;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
impl IsPusTelecommand for PusTcCreator<'_> {}
|
impl IsPusTelecommand for PusTcCreator<'_> {}
|
||||||
|
|
||||||
/// A specialized variant of [PusTcCreator] designed for efficiency when handling large source
|
|
||||||
/// data.
|
|
||||||
///
|
|
||||||
/// Unlike [PusTcCreator], this type does not require the user to provide the application data
|
|
||||||
/// as a separate slice. Instead, it allows writing the application data directly into the provided
|
|
||||||
/// serialization buffer. This eliminates the need for an intermediate buffer and the associated
|
|
||||||
/// memory copy, improving performance, particularly when working with large payloads.
|
|
||||||
///
|
|
||||||
/// **Important:** The total length of the source data must be known and specified in advance
|
|
||||||
/// to ensure correct serialization behavior.
|
|
||||||
///
|
|
||||||
/// Note that this abstraction intentionally omits certain trait implementations that are available
|
|
||||||
/// on [PusTcCreator], as they are not applicable in this optimized usage pattern.
|
|
||||||
pub struct PusTcCreatorWithReservedAppData<'buf> {
|
|
||||||
buf: &'buf mut [u8],
|
|
||||||
app_data_offset: usize,
|
|
||||||
full_len: usize,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'buf> PusTcCreatorWithReservedAppData<'buf> {
|
|
||||||
/// Generates a new instance with reserved space for the user application data.
|
|
||||||
///
|
|
||||||
/// # Arguments
|
|
||||||
///
|
|
||||||
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
|
||||||
/// header flag are set correctly by the constructor.
|
|
||||||
/// * `sec_header` - Information contained in the secondary header, including the service
|
|
||||||
/// and subservice type
|
|
||||||
/// * `app_data_len` - Custom application data length
|
|
||||||
#[inline]
|
|
||||||
pub fn new(
|
|
||||||
buf: &'buf mut [u8],
|
|
||||||
mut sp_header: SpHeader,
|
|
||||||
sec_header: PusTcSecondaryHeader,
|
|
||||||
app_data_len: usize,
|
|
||||||
) -> Result<Self, ByteConversionError> {
|
|
||||||
sp_header.set_packet_type(PacketType::Tc);
|
|
||||||
sp_header.set_sec_header_flag();
|
|
||||||
let len_written = PUS_TC_MIN_LEN_WITHOUT_APP_DATA + app_data_len;
|
|
||||||
if len_written > buf.len() {
|
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: len_written,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
sp_header.data_len = len_written as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
|
||||||
Self::write_to_bytes_partially(buf, sp_header, sec_header, app_data_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn write_to_bytes_partially(
|
|
||||||
buf: &'buf mut [u8],
|
|
||||||
sp_header: SpHeader,
|
|
||||||
sec_header: PusTcSecondaryHeader,
|
|
||||||
app_data_len: usize,
|
|
||||||
) -> Result<Self, ByteConversionError> {
|
|
||||||
let mut curr_idx = 0;
|
|
||||||
sp_header.write_to_be_bytes(&mut buf[0..CCSDS_HEADER_LEN])?;
|
|
||||||
curr_idx += CCSDS_HEADER_LEN;
|
|
||||||
let sec_header_len = size_of::<zc::PusTcSecondaryHeader>();
|
|
||||||
let sec_header_zc = zc::PusTcSecondaryHeader::try_from(sec_header).unwrap();
|
|
||||||
sec_header_zc
|
|
||||||
.write_to(&mut buf[curr_idx..curr_idx + sec_header_len])
|
|
||||||
.map_err(|_| ByteConversionError::ZeroCopyToError)?;
|
|
||||||
curr_idx += sec_header_len;
|
|
||||||
let app_data_offset = curr_idx;
|
|
||||||
curr_idx += app_data_len;
|
|
||||||
Ok(Self {
|
|
||||||
buf,
|
|
||||||
app_data_offset,
|
|
||||||
full_len: curr_idx + 2,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub const fn len_written(&self) -> usize {
|
|
||||||
self.full_len
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Mutable access to the application data buffer.
|
|
||||||
#[inline]
|
|
||||||
pub fn app_data_mut(&mut self) -> &mut [u8] {
|
|
||||||
&mut self.buf[self.app_data_offset..self.full_len - 2]
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Access to the source data buffer.
|
|
||||||
#[inline]
|
|
||||||
pub fn app_data(&self) -> &[u8] {
|
|
||||||
&self.buf[self.app_data_offset..self.full_len - 2]
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn app_data_len(&self) -> usize {
|
|
||||||
self.full_len - 2 - self.app_data_offset
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Finalize the TC packet by calculating and writing the CRC16.
|
|
||||||
///
|
|
||||||
/// Returns the full packet length.
|
|
||||||
pub fn finalize(self) -> usize {
|
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
|
||||||
digest.update(&self.buf[0..self.full_len - 2]);
|
|
||||||
self.buf[self.full_len - 2..self.full_len]
|
|
||||||
.copy_from_slice(&digest.finalize().to_be_bytes());
|
|
||||||
self.full_len
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Finalize the TC packet by calculating and writing the CRC16 using a table-less
|
|
||||||
/// implementation.
|
|
||||||
///
|
|
||||||
/// Returns the full packet length.
|
|
||||||
pub fn finalize_crc_no_table(self) -> usize {
|
|
||||||
let mut digest = CRC_CCITT_FALSE_NO_TABLE.digest();
|
|
||||||
digest.update(&self.buf[0..self.full_len - 2]);
|
|
||||||
self.buf[self.full_len - 2..self.full_len]
|
|
||||||
.copy_from_slice(&digest.finalize().to_be_bytes());
|
|
||||||
self.full_len
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Finalize the TC packet without writing the CRC16.
|
|
||||||
///
|
|
||||||
/// Returns the length WITHOUT the CRC16.
|
|
||||||
#[inline]
|
|
||||||
pub fn finalize_no_crc(self) -> usize {
|
|
||||||
self.full_len - 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This class can be used to read a PUS TC telecommand from raw memory.
|
/// This class can be used to read a PUS TC telecommand from raw memory.
|
||||||
///
|
///
|
||||||
/// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the
|
/// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the
|
||||||
@ -619,7 +422,6 @@ impl<'buf> PusTcCreatorWithReservedAppData<'buf> {
|
|||||||
/// * `'raw_data` - Lifetime of the provided raw slice.
|
/// * `'raw_data` - Lifetime of the provided raw slice.
|
||||||
#[derive(Eq, Copy, Clone, Debug)]
|
#[derive(Eq, Copy, Clone, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct PusTcReader<'raw_data> {
|
pub struct PusTcReader<'raw_data> {
|
||||||
#[cfg_attr(feature = "serde", serde(skip))]
|
#[cfg_attr(feature = "serde", serde(skip))]
|
||||||
raw_data: &'raw_data [u8],
|
raw_data: &'raw_data [u8],
|
||||||
@ -633,22 +435,7 @@ 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, PusError> {
|
pub fn new(slice: &'raw_data [u8]) -> Result<(Self, usize), 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 {
|
||||||
@ -675,49 +462,41 @@ impl<'raw_data> PusTcReader<'raw_data> {
|
|||||||
}
|
}
|
||||||
.into());
|
.into());
|
||||||
}
|
}
|
||||||
let sec_header = zc::PusTcSecondaryHeader::read_from_bytes(
|
let sec_header = zc::PusTcSecondaryHeader::from_bytes(
|
||||||
&slice[current_idx..current_idx + PUC_TC_SECONDARY_HEADER_LEN],
|
&slice[current_idx..current_idx + PUC_TC_SECONDARY_HEADER_LEN],
|
||||||
)
|
)
|
||||||
.map_err(|_| ByteConversionError::ZeroCopyFromError)?;
|
.ok_or(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];
|
||||||
Ok(Self {
|
let pus_tc = 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]
|
|
||||||
pub fn app_data(&self) -> &[u8] {
|
pub fn app_data(&self) -> &[u8] {
|
||||||
self.user_data()
|
self.user_data()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn raw_data(&self) -> &[u8] {
|
pub fn raw_data(&self) -> &[u8] {
|
||||||
self.raw_data
|
self.raw_data
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn len_packed(&self) -> usize {
|
pub fn len_packed(&self) -> usize {
|
||||||
self.sp_header.total_len()
|
self.sp_header.total_len()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
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<'_> {
|
||||||
#[inline]
|
|
||||||
fn eq(&self, other: &Self) -> bool {
|
fn eq(&self, other: &Self) -> bool {
|
||||||
self.raw_data == other.raw_data
|
self.raw_data == other.raw_data
|
||||||
}
|
}
|
||||||
@ -729,36 +508,26 @@ impl CcsdsPacket for PusTcReader<'_> {
|
|||||||
|
|
||||||
impl PusPacket for PusTcReader<'_> {
|
impl PusPacket for PusTcReader<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
#[inline]
|
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
#[inline]
|
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
});
|
});
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn user_data(&self) -> &[u8] {
|
fn user_data(&self) -> &[u8] {
|
||||||
self.app_data
|
self.app_data
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
fn crc16(&self) -> Option<u16> {
|
||||||
fn opt_crc16(&self) -> Option<u16> {
|
|
||||||
Some(self.crc16)
|
Some(self.crc16)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcReader<'_> {
|
impl GenericPusTcSecondaryHeader for PusTcReader<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
#[inline]
|
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
#[inline]
|
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
#[inline]
|
|
||||||
fn source_id(&self) -> u16;
|
fn source_id(&self) -> u16;
|
||||||
#[inline]
|
|
||||||
fn ack_flags(&self) -> u8;
|
fn ack_flags(&self) -> u8;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -783,6 +552,8 @@ impl PartialEq<PusTcReader<'_>> for PusTcCreator<'_> {
|
|||||||
|
|
||||||
#[cfg(all(test, feature = "std"))]
|
#[cfg(all(test, feature = "std"))]
|
||||||
mod tests {
|
mod tests {
|
||||||
|
use std::error::Error;
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
use crate::ecss::PusVersion::PusC;
|
use crate::ecss::PusVersion::PusC;
|
||||||
use crate::ecss::{PusError, PusPacket, WritablePusPacket};
|
use crate::ecss::{PusError, PusPacket, WritablePusPacket};
|
||||||
@ -794,19 +565,19 @@ mod tests {
|
|||||||
use postcard::{from_bytes, to_allocvec};
|
use postcard::{from_bytes, to_allocvec};
|
||||||
|
|
||||||
fn base_ping_tc_full_ctor() -> PusTcCreator<'static> {
|
fn base_ping_tc_full_ctor() -> PusTcCreator<'static> {
|
||||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||||
let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
||||||
PusTcCreator::new_no_app_data(sph, tc_header, true)
|
PusTcCreator::new_no_app_data(&mut sph, tc_header, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn base_ping_tc_simple_ctor() -> PusTcCreator<'static> {
|
fn base_ping_tc_simple_ctor() -> PusTcCreator<'static> {
|
||||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||||
PusTcCreator::new_simple(sph, 17, 1, &[], true)
|
PusTcCreator::new_simple(&mut sph, 17, 1, None, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn base_ping_tc_simple_ctor_with_app_data(app_data: &'static [u8]) -> PusTcCreator<'static> {
|
fn base_ping_tc_simple_ctor_with_app_data(app_data: &'static [u8]) -> PusTcCreator<'static> {
|
||||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||||
PusTcCreator::new_simple(sph, 17, 1, app_data, true)
|
PusTcCreator::new_simple(&mut sph, 17, 1, Some(app_data), true)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -824,74 +595,11 @@ 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.opt_crc16().unwrap(),
|
pus_tc.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_with_trait_1() {
|
|
||||||
let pus_tc = base_ping_tc_simple_ctor();
|
|
||||||
let mut test_buf: [u8; 32] = [0; 32];
|
|
||||||
let size = WritablePusPacket::write_to_bytes(&pus_tc, 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_with_trait_2() {
|
|
||||||
let pus_tc = base_ping_tc_simple_ctor();
|
|
||||||
let mut test_buf: [u8; 32] = [0; 32];
|
|
||||||
let size = WritablePusPacket::write_to_bytes_crc_no_table(&pus_tc, 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_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]
|
|
||||||
fn test_serialization_no_crc_with_trait() {
|
|
||||||
let pus_tc = base_ping_tc_simple_ctor();
|
|
||||||
let mut test_buf: [u8; 32] = [0; 32];
|
|
||||||
let size = WritablePusPacket::write_to_bytes_no_crc(&pus_tc, 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();
|
||||||
@ -900,48 +608,9 @@ 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 =
|
let (tc_from_raw, size) =
|
||||||
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_alt_ctor() {
|
|
||||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
|
||||||
let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
|
||||||
let mut test_buf: [u8; 32] = [0; 32];
|
|
||||||
let mut pus_tc =
|
|
||||||
PusTcCreatorWithReservedAppData::new(&mut test_buf, sph, tc_header, 0).unwrap();
|
|
||||||
assert_eq!(pus_tc.len_written(), 13);
|
|
||||||
assert_eq!(pus_tc.app_data_len(), 0);
|
|
||||||
assert_eq!(pus_tc.app_data(), &[]);
|
|
||||||
assert_eq!(pus_tc.app_data_mut(), &[]);
|
|
||||||
let size = pus_tc.finalize();
|
|
||||||
assert_eq!(size, 13);
|
assert_eq!(size, 13);
|
||||||
let tc_from_raw =
|
|
||||||
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);
|
|
||||||
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);
|
||||||
@ -953,9 +622,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 = PusTcReader::new(tc_vec.as_slice())
|
let (tc_from_raw, size) = 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!(tc_from_raw.total_len(), 13);
|
assert_eq!(size, 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);
|
||||||
@ -964,13 +633,12 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_update_func() {
|
fn test_update_func() {
|
||||||
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
||||||
let mut tc = PusTcCreator::new_simple(sph, 17, 1, &[], false);
|
let mut tc = PusTcCreator::new_simple(&mut sph, 17, 1, None, false);
|
||||||
assert_eq!(tc.data_len(), 0);
|
assert_eq!(tc.data_len(), 0);
|
||||||
tc.update_ccsds_data_len();
|
tc.update_ccsds_data_len();
|
||||||
assert_eq!(tc.data_len(), 6);
|
assert_eq!(tc.data_len(), 6);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_deserialization_with_app_data() {
|
fn test_deserialization_with_app_data() {
|
||||||
let pus_tc = base_ping_tc_simple_ctor_with_app_data(&[1, 2, 3]);
|
let pus_tc = base_ping_tc_simple_ctor_with_app_data(&[1, 2, 3]);
|
||||||
@ -979,15 +647,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 =
|
let (tc_from_raw, size) =
|
||||||
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(), 16);
|
assert_eq!(size, 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.opt_crc16().unwrap(),
|
tc_from_raw.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);
|
||||||
@ -1002,9 +670,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);
|
||||||
}
|
}
|
||||||
@ -1073,17 +741,22 @@ mod tests {
|
|||||||
let res = pus_tc.write_to_bytes(test_buf.as_mut_slice());
|
let res = pus_tc.write_to_bytes(test_buf.as_mut_slice());
|
||||||
assert!(res.is_err());
|
assert!(res.is_err());
|
||||||
let err = res.unwrap_err();
|
let err = res.unwrap_err();
|
||||||
assert_eq!(
|
if let PusError::ByteConversion(e) = err {
|
||||||
err,
|
assert_eq!(
|
||||||
ByteConversionError::ToSliceTooSmall {
|
e,
|
||||||
found: 12,
|
ByteConversionError::ToSliceTooSmall {
|
||||||
expected: 13
|
found: 12,
|
||||||
}
|
expected: 13
|
||||||
);
|
}
|
||||||
assert_eq!(
|
);
|
||||||
err.to_string(),
|
assert_eq!(
|
||||||
"target slice with size 12 is too small, expected size of at least 13"
|
err.to_string(),
|
||||||
);
|
"pus error: target slice with size 12 is too small, expected size of at least 13"
|
||||||
|
);
|
||||||
|
assert_eq!(err.source().unwrap().to_string(), e.to_string());
|
||||||
|
} else {
|
||||||
|
panic!("unexpected error {err}");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@ -1133,8 +806,7 @@ mod tests {
|
|||||||
if !has_user_data {
|
if !has_user_data {
|
||||||
assert!(tc.user_data().is_empty());
|
assert!(tc.user_data().is_empty());
|
||||||
}
|
}
|
||||||
let mut comp_header =
|
let mut comp_header = SpHeader::tc_unseg(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||||
SpHeader::new_for_unseg_tc_checked(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
|
||||||
comp_header.set_sec_header_flag();
|
comp_header.set_sec_header_flag();
|
||||||
assert_eq!(*tc.sp_header(), comp_header);
|
assert_eq!(*tc.sp_header(), comp_header);
|
||||||
}
|
}
|
||||||
@ -1145,13 +817,12 @@ mod tests {
|
|||||||
assert!(tc.user_data().is_empty());
|
assert!(tc.user_data().is_empty());
|
||||||
}
|
}
|
||||||
assert_eq!(tc.len_packed(), exp_full_len);
|
assert_eq!(tc.len_packed(), exp_full_len);
|
||||||
let mut comp_header =
|
let mut comp_header = SpHeader::tc_unseg(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||||
SpHeader::new_for_unseg_tc_checked(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
|
||||||
comp_header.set_sec_header_flag();
|
comp_header.set_sec_header_flag();
|
||||||
assert_eq!(*tc.sp_header(), comp_header);
|
assert_eq!(*tc.sp_header(), comp_header);
|
||||||
}
|
}
|
||||||
|
|
||||||
fn verify_test_tc_generic(tc: &(impl PusPacket + GenericPusTcSecondaryHeader)) {
|
fn verify_test_tc_generic(tc: &(impl CcsdsPacket + 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);
|
||||||
@ -1215,8 +886,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());
|
assert_eq!(pus_tc, PusTcReader::new(&buf).unwrap().0);
|
||||||
assert_eq!(PusTcReader::new(&buf).unwrap(), pus_tc);
|
assert_eq!(PusTcReader::new(&buf).unwrap().0, pus_tc);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
639
src/ecss/tm.rs
639
src/ecss/tm.rs
File diff suppressed because it is too large
Load Diff
473
src/lib.rs
473
src/lib.rs
@ -22,21 +22,21 @@
|
|||||||
//!
|
//!
|
||||||
//! `spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
//! `spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
||||||
//!
|
//!
|
||||||
|
//! It also offers optional support for [`serde`](https://serde.rs/). This allows serializing and
|
||||||
|
//! deserializing them with an appropriate `serde` provider like
|
||||||
|
//! [`postcard`](https://github.com/jamesmunns/postcard).
|
||||||
|
//!
|
||||||
//! ### Default features
|
//! ### Default features
|
||||||
//!
|
//!
|
||||||
//! - [`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
|
||||||
//!
|
//!
|
||||||
//! - [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and
|
//! - [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and
|
||||||
//! `Deserialize` `derives.
|
//! `Deserialize` `derive`s
|
||||||
//! - [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
|
|
||||||
//! - [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
|
|
||||||
//! - [`defmt`](https://defmt.ferrous-systems.com/): Add support for the `defmt` by adding the
|
|
||||||
//! [`defmt::Format`](https://defmt.ferrous-systems.com/format) derive on many types.
|
|
||||||
//!
|
//!
|
||||||
//! ## Module
|
//! ## Module
|
||||||
//!
|
//!
|
||||||
@ -48,7 +48,7 @@
|
|||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! use spacepackets::SpHeader;
|
//! use spacepackets::SpHeader;
|
||||||
//! let sp_header = SpHeader::new_for_unseg_tc_checked(0x42, 12, 1).expect("error creating CCSDS TC header");
|
//! let sp_header = SpHeader::tc_unseg(0x42, 12, 1).expect("Error creating CCSDS TC header");
|
||||||
//! println!("{:?}", sp_header);
|
//! println!("{:?}", sp_header);
|
||||||
//! let mut ccsds_buf: [u8; 32] = [0; 32];
|
//! let mut ccsds_buf: [u8; 32] = [0; 32];
|
||||||
//! sp_header.write_to_be_bytes(&mut ccsds_buf).expect("Writing CCSDS TC header failed");
|
//! sp_header.write_to_be_bytes(&mut ccsds_buf).expect("Writing CCSDS TC header failed");
|
||||||
@ -61,53 +61,87 @@ extern crate alloc;
|
|||||||
#[cfg(any(feature = "std", test))]
|
#[cfg(any(feature = "std", test))]
|
||||||
extern crate std;
|
extern crate std;
|
||||||
|
|
||||||
use core::{fmt::Debug, hash::Hash};
|
use crate::ecss::CCSDS_HEADER_LEN;
|
||||||
|
use core::{
|
||||||
|
fmt::{Debug, Display, Formatter},
|
||||||
|
hash::Hash,
|
||||||
|
};
|
||||||
|
use crc::{Crc, CRC_16_IBM_3740};
|
||||||
use delegate::delegate;
|
use delegate::delegate;
|
||||||
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 time;
|
pub mod time;
|
||||||
pub mod uslp;
|
|
||||||
pub mod util;
|
pub mod util;
|
||||||
|
|
||||||
mod private {
|
mod private {
|
||||||
pub trait Sealed {}
|
pub trait Sealed {}
|
||||||
}
|
}
|
||||||
|
|
||||||
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, thiserror::Error)]
|
#[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))]
|
|
||||||
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
|
||||||
#[error("target slice with size {found} is too small, expected size of at least {expected}")]
|
ToSliceTooSmall {
|
||||||
ToSliceTooSmall { found: usize, expected: usize },
|
found: 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
|
||||||
#[error("source slice with size {found} too small, expected at least {expected} bytes")]
|
FromSliceTooSmall {
|
||||||
FromSliceTooSmall { found: usize, expected: usize },
|
found: 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))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub enum PacketType {
|
pub enum PacketType {
|
||||||
Tm = 0,
|
Tm = 0,
|
||||||
Tc = 1,
|
Tc = 1,
|
||||||
@ -131,7 +165,6 @@ pub fn packet_type_in_raw_packet_id(packet_id: u16) -> PacketType {
|
|||||||
|
|
||||||
#[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))]
|
|
||||||
pub enum SequenceFlags {
|
pub enum SequenceFlags {
|
||||||
ContinuationSegment = 0b00,
|
ContinuationSegment = 0b00,
|
||||||
FirstSegment = 0b01,
|
FirstSegment = 0b01,
|
||||||
@ -159,7 +192,6 @@ impl TryFrom<u8> for SequenceFlags {
|
|||||||
/// of the first two bytes in the CCSDS primary header.
|
/// of the first two bytes in the CCSDS primary header.
|
||||||
#[derive(Debug, Eq, Copy, Clone)]
|
#[derive(Debug, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct PacketId {
|
pub struct PacketId {
|
||||||
pub ptype: PacketType,
|
pub ptype: PacketType,
|
||||||
pub sec_header_flag: bool,
|
pub sec_header_flag: bool,
|
||||||
@ -167,21 +199,18 @@ pub struct PacketId {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for PacketId {
|
impl PartialEq for PacketId {
|
||||||
#[inline]
|
|
||||||
fn eq(&self, other: &Self) -> bool {
|
fn eq(&self, other: &Self) -> bool {
|
||||||
self.raw().eq(&other.raw())
|
self.raw().eq(&other.raw())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialOrd for PacketId {
|
impl PartialOrd for PacketId {
|
||||||
#[inline]
|
|
||||||
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
|
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
|
||||||
Some(self.cmp(other))
|
Some(self.cmp(other))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Ord for PacketId {
|
impl Ord for PacketId {
|
||||||
#[inline]
|
|
||||||
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
|
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
|
||||||
self.raw().cmp(&other.raw())
|
self.raw().cmp(&other.raw())
|
||||||
}
|
}
|
||||||
@ -195,7 +224,6 @@ impl Hash for PacketId {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Default for PacketId {
|
impl Default for PacketId {
|
||||||
#[inline]
|
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
PacketId {
|
PacketId {
|
||||||
ptype: PacketType::Tm,
|
ptype: PacketType::Tm,
|
||||||
@ -206,34 +234,23 @@ impl Default for PacketId {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl PacketId {
|
impl PacketId {
|
||||||
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
pub const fn const_tc(sec_header: bool, apid: u16) -> Self {
|
||||||
/// Use the checked constructor variants to avoid panics.
|
Self::const_new(PacketType::Tc, sec_header, apid)
|
||||||
#[inline]
|
}
|
||||||
pub const fn new_for_tc(sec_header: bool, apid: u16) -> Self {
|
|
||||||
|
pub const fn const_tm(sec_header: bool, apid: u16) -> Self {
|
||||||
|
Self::const_new(PacketType::Tm, sec_header, apid)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn tc(sec_header: bool, apid: u16) -> Option<Self> {
|
||||||
Self::new(PacketType::Tc, sec_header, apid)
|
Self::new(PacketType::Tc, sec_header, apid)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
pub fn tm(sec_header: bool, apid: u16) -> Option<Self> {
|
||||||
/// Use the checked constructor variants to avoid panics.
|
|
||||||
#[inline]
|
|
||||||
pub const fn new_for_tm(sec_header: bool, apid: u16) -> Self {
|
|
||||||
Self::new(PacketType::Tm, sec_header, apid)
|
Self::new(PacketType::Tm, sec_header, apid)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
pub const fn const_new(ptype: PacketType, sec_header: bool, apid: u16) -> Self {
|
||||||
pub fn new_for_tc_checked(sec_header: bool, apid: u16) -> Option<Self> {
|
|
||||||
Self::new_checked(PacketType::Tc, sec_header, apid)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_for_tm_checked(sec_header: bool, apid: u16) -> Option<Self> {
|
|
||||||
Self::new_checked(PacketType::Tm, sec_header, apid)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
|
||||||
/// Use the checked variants to avoid panics.
|
|
||||||
#[inline]
|
|
||||||
pub const fn new(ptype: PacketType, sec_header: bool, apid: u16) -> Self {
|
|
||||||
if apid > MAX_APID {
|
if apid > MAX_APID {
|
||||||
panic!("APID too large");
|
panic!("APID too large");
|
||||||
}
|
}
|
||||||
@ -244,18 +261,16 @@ impl PacketId {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
pub fn new(ptype: PacketType, sec_header_flag: bool, apid: u16) -> Option<PacketId> {
|
||||||
pub fn new_checked(ptype: PacketType, sec_header_flag: bool, apid: u16) -> Option<PacketId> {
|
|
||||||
if apid > MAX_APID {
|
if apid > MAX_APID {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(PacketId::new(ptype, sec_header_flag, apid))
|
Some(PacketId::const_new(ptype, sec_header_flag, apid))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Set a new Application Process ID (APID). If the passed number is invalid, the APID will
|
/// Set a new Application Process ID (APID). If the passed number is invalid, the APID will
|
||||||
/// not be set and false will be returned. The maximum allowed value for the 11-bit field is
|
/// not be set and false will be returned. The maximum allowed value for the 11-bit field is
|
||||||
/// 2047
|
/// 2047
|
||||||
#[inline]
|
|
||||||
pub fn set_apid(&mut self, apid: u16) -> bool {
|
pub fn set_apid(&mut self, apid: u16) -> bool {
|
||||||
if apid > MAX_APID {
|
if apid > MAX_APID {
|
||||||
return false;
|
return false;
|
||||||
@ -264,7 +279,6 @@ impl PacketId {
|
|||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn apid(&self) -> u16 {
|
pub fn apid(&self) -> u16 {
|
||||||
self.apid
|
self.apid
|
||||||
}
|
}
|
||||||
@ -289,17 +303,15 @@ impl From<u16> for PacketId {
|
|||||||
/// third and the fourth byte in the CCSDS primary header.
|
/// third and the fourth byte in the CCSDS primary header.
|
||||||
#[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))]
|
|
||||||
pub struct PacketSequenceCtrl {
|
pub struct PacketSequenceCtrl {
|
||||||
pub seq_flags: SequenceFlags,
|
pub seq_flags: SequenceFlags,
|
||||||
seq_count: u16,
|
seq_count: u16,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PacketSequenceCtrl {
|
impl PacketSequenceCtrl {
|
||||||
/// This constructor panics if the sequence count exceeds [MAX_SEQ_COUNT].
|
/// const variant of [PacketSequenceCtrl::new], but panics if the sequence count exceeds
|
||||||
/// Use [Self::new_checked] to avoid panics.
|
/// [MAX_SEQ_COUNT].
|
||||||
#[inline]
|
pub const fn const_new(seq_flags: SequenceFlags, seq_count: u16) -> PacketSequenceCtrl {
|
||||||
pub const fn new(seq_flags: SequenceFlags, seq_count: u16) -> PacketSequenceCtrl {
|
|
||||||
if seq_count > MAX_SEQ_COUNT {
|
if seq_count > MAX_SEQ_COUNT {
|
||||||
panic!("Sequence count too large");
|
panic!("Sequence count too large");
|
||||||
}
|
}
|
||||||
@ -310,22 +322,18 @@ impl PacketSequenceCtrl {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Returns [None] if the passed sequence count exceeds [MAX_SEQ_COUNT].
|
/// Returns [None] if the passed sequence count exceeds [MAX_SEQ_COUNT].
|
||||||
#[inline]
|
pub fn new(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
|
||||||
pub fn new_checked(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
|
|
||||||
if seq_count > MAX_SEQ_COUNT {
|
if seq_count > MAX_SEQ_COUNT {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(PacketSequenceCtrl::new(seq_flags, seq_count))
|
Some(PacketSequenceCtrl::const_new(seq_flags, seq_count))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn raw(&self) -> u16 {
|
pub fn raw(&self) -> u16 {
|
||||||
((self.seq_flags as u16) << 14) | self.seq_count
|
((self.seq_flags as u16) << 14) | self.seq_count
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Set a new sequence count. If the passed number is invalid, the sequence count will not be
|
/// Set a new sequence count. If the passed number is invalid, the sequence count will not be
|
||||||
/// set and false will be returned. The maximum allowed value for the 14-bit field is 16383.
|
/// set and false will be returned. The maximum allowed value for the 14-bit field is 16383.
|
||||||
#[inline]
|
|
||||||
pub fn set_seq_count(&mut self, ssc: u16) -> bool {
|
pub fn set_seq_count(&mut self, ssc: u16) -> bool {
|
||||||
if ssc > MAX_SEQ_COUNT {
|
if ssc > MAX_SEQ_COUNT {
|
||||||
return false;
|
return false;
|
||||||
@ -334,7 +342,6 @@ impl PacketSequenceCtrl {
|
|||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn seq_count(&self) -> u16 {
|
pub fn seq_count(&self) -> u16 {
|
||||||
self.seq_count
|
self.seq_count
|
||||||
}
|
}
|
||||||
@ -376,7 +383,6 @@ pub trait CcsdsPacket {
|
|||||||
/// Retrieve data length field
|
/// Retrieve data length field
|
||||||
fn data_len(&self) -> u16;
|
fn data_len(&self) -> u16;
|
||||||
/// Retrieve the total packet size based on the data length field
|
/// Retrieve the total packet size based on the data length field
|
||||||
#[inline]
|
|
||||||
fn total_len(&self) -> usize {
|
fn total_len(&self) -> usize {
|
||||||
usize::from(self.data_len()) + CCSDS_HEADER_LEN + 1
|
usize::from(self.data_len()) + CCSDS_HEADER_LEN + 1
|
||||||
}
|
}
|
||||||
@ -450,14 +456,13 @@ 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)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct SpHeader {
|
pub struct SpHeader {
|
||||||
pub version: u8,
|
pub version: u8,
|
||||||
pub packet_id: PacketId,
|
pub packet_id: PacketId,
|
||||||
@ -465,12 +470,9 @@ pub struct SpHeader {
|
|||||||
pub data_len: u16,
|
pub data_len: u16,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub type SpacePacketHeader = SpHeader;
|
|
||||||
|
|
||||||
impl Default for SpHeader {
|
impl Default for SpHeader {
|
||||||
/// The default function sets the sequence flag field to [SequenceFlags::Unsegmented] and the
|
/// The default function sets the sequence flag field to [SequenceFlags::Unsegmented]. The data
|
||||||
/// data length to 0.
|
/// length field is set to 1, which denotes an empty space packets.
|
||||||
#[inline]
|
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
SpHeader {
|
SpHeader {
|
||||||
version: 0,
|
version: 0,
|
||||||
@ -479,13 +481,12 @@ impl Default for SpHeader {
|
|||||||
seq_flags: SequenceFlags::Unsegmented,
|
seq_flags: SequenceFlags::Unsegmented,
|
||||||
seq_count: 0,
|
seq_count: 0,
|
||||||
},
|
},
|
||||||
data_len: 0,
|
data_len: 1,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl SpHeader {
|
impl SpHeader {
|
||||||
#[inline]
|
|
||||||
pub const fn new(packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16) -> Self {
|
pub const fn new(packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16) -> Self {
|
||||||
Self {
|
Self {
|
||||||
version: 0,
|
version: 0,
|
||||||
@ -495,43 +496,9 @@ impl SpHeader {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This constructor sets the sequence flag field to [SequenceFlags::Unsegmented] and the data
|
/// const variant of the [SpHeader::new_fron_single_fields] function. Panics if the passed
|
||||||
/// length to 0.
|
/// APID exceeds [MAX_APID] or the passed packet sequence count exceeds [MAX_SEQ_COUNT].
|
||||||
///
|
const fn const_new_from_single_fields(
|
||||||
/// This constructor will panic if the APID exceeds [MAX_APID].
|
|
||||||
#[inline]
|
|
||||||
pub const fn new_from_apid(apid: u16) -> Self {
|
|
||||||
SpHeader {
|
|
||||||
version: 0,
|
|
||||||
packet_id: PacketId::new(PacketType::Tm, false, apid),
|
|
||||||
psc: PacketSequenceCtrl {
|
|
||||||
seq_flags: SequenceFlags::Unsegmented,
|
|
||||||
seq_count: 0,
|
|
||||||
},
|
|
||||||
data_len: 0,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Checked variant of [Self::new_from_apid].
|
|
||||||
#[inline]
|
|
||||||
pub fn new_from_apid_checked(apid: u16) -> Option<Self> {
|
|
||||||
Some(SpHeader {
|
|
||||||
version: 0,
|
|
||||||
packet_id: PacketId::new_checked(PacketType::Tm, false, apid)?,
|
|
||||||
psc: PacketSequenceCtrl {
|
|
||||||
seq_flags: SequenceFlags::Unsegmented,
|
|
||||||
seq_count: 0,
|
|
||||||
},
|
|
||||||
data_len: 0,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This constructor panics if the passed APID exceeds [MAX_APID] or the passed packet sequence
|
|
||||||
/// count exceeds [MAX_SEQ_COUNT].
|
|
||||||
///
|
|
||||||
/// The checked constructor variants can be used to avoid panics.
|
|
||||||
#[inline]
|
|
||||||
pub const fn new_from_fields(
|
|
||||||
ptype: PacketType,
|
ptype: PacketType,
|
||||||
sec_header: bool,
|
sec_header: bool,
|
||||||
apid: u16,
|
apid: u16,
|
||||||
@ -546,20 +513,17 @@ impl SpHeader {
|
|||||||
panic!("APID is too large");
|
panic!("APID is too large");
|
||||||
}
|
}
|
||||||
Self {
|
Self {
|
||||||
psc: PacketSequenceCtrl::new(seq_flags, seq_count),
|
psc: PacketSequenceCtrl::const_new(seq_flags, seq_count),
|
||||||
packet_id: PacketId::new(ptype, sec_header, apid),
|
packet_id: PacketId::const_new(ptype, sec_header, apid),
|
||||||
data_len,
|
data_len,
|
||||||
version: 0,
|
version: 0,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Create a new Space Packet Header instance which can be used to create generic
|
/// Create a new Space Packet Header instance which can be used to create generic
|
||||||
/// Space Packets.
|
/// Space Packets. This will return [None] if the APID or sequence count argument
|
||||||
///
|
|
||||||
/// This will return [None] if the APID or sequence count argument
|
|
||||||
/// exceed [MAX_APID] or [MAX_SEQ_COUNT] respectively. The version field is set to 0b000.
|
/// exceed [MAX_APID] or [MAX_SEQ_COUNT] respectively. The version field is set to 0b000.
|
||||||
#[inline]
|
pub fn new_from_single_fields(
|
||||||
pub fn new_from_fields_checked(
|
|
||||||
ptype: PacketType,
|
ptype: PacketType,
|
||||||
sec_header: bool,
|
sec_header: bool,
|
||||||
apid: u16,
|
apid: u16,
|
||||||
@ -570,117 +534,56 @@ impl SpHeader {
|
|||||||
if seq_count > MAX_SEQ_COUNT || apid > MAX_APID {
|
if seq_count > MAX_SEQ_COUNT || apid > MAX_APID {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(SpHeader::new_from_fields(
|
Some(SpHeader::const_new_from_single_fields(
|
||||||
ptype, sec_header, apid, seq_flags, seq_count, data_len,
|
ptype, sec_header, apid, seq_flags, seq_count, data_len,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper function for telemetry space packet headers. The packet type field will be
|
/// Helper function for telemetry space packet headers. The packet type field will be
|
||||||
/// set accordingly. The secondary header flag field is set to false.
|
/// set accordingly. The secondary header flag field is set to false.
|
||||||
#[inline]
|
pub fn tm(apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||||
pub fn new_for_tm_checked(
|
Self::new_from_single_fields(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
||||||
apid: u16,
|
|
||||||
seq_flags: SequenceFlags,
|
|
||||||
seq_count: u16,
|
|
||||||
data_len: u16,
|
|
||||||
) -> Option<Self> {
|
|
||||||
Self::new_from_fields_checked(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper function for telemetry space packet headers. The packet type field will be
|
/// Helper function for telemetry space packet headers. The packet type field will be
|
||||||
/// set accordingly. The secondary header flag field is set to false.
|
/// set accordingly. The secondary header flag field is set to false.
|
||||||
#[inline]
|
pub fn tc(apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||||
pub fn new_for_tc_checked(
|
Self::new_from_single_fields(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
||||||
apid: u16,
|
|
||||||
seq_flags: SequenceFlags,
|
|
||||||
seq_count: u16,
|
|
||||||
data_len: u16,
|
|
||||||
) -> Option<Self> {
|
|
||||||
Self::new_from_fields_checked(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This is an unchecked constructor which can panic on invalid input.
|
/// Variant of [SpHeader::tm] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||||
#[inline]
|
pub fn tm_unseg(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||||
pub const fn new_for_tm(
|
Self::tm(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||||
apid: u16,
|
|
||||||
seq_flags: SequenceFlags,
|
|
||||||
seq_count: u16,
|
|
||||||
data_len: u16,
|
|
||||||
) -> Self {
|
|
||||||
Self::new_from_fields(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This is an unchecked constructor which can panic on invalid input.
|
/// Variant of [SpHeader::tc] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||||
#[inline]
|
pub fn tc_unseg(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||||
pub const fn new_for_tc(
|
Self::tc(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||||
apid: u16,
|
|
||||||
seq_flags: SequenceFlags,
|
|
||||||
seq_count: u16,
|
|
||||||
data_len: u16,
|
|
||||||
) -> Self {
|
|
||||||
Self::new_from_fields(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Variant of [SpHeader::new_for_tm_checked] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
//noinspection RsTraitImplementation
|
||||||
#[inline]
|
delegate!(to self.packet_id {
|
||||||
pub fn new_for_unseg_tm_checked(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
/// Returns [false] and fails if the APID exceeds [MAX_APID]
|
||||||
Self::new_for_tm_checked(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
pub fn set_apid(&mut self, apid: u16) -> bool;
|
||||||
}
|
});
|
||||||
|
|
||||||
/// Variant of [SpHeader::new_for_tc_checked] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
delegate!(to self.psc {
|
||||||
#[inline]
|
/// Returns [false] and fails if the sequence count exceeds [MAX_SEQ_COUNT]
|
||||||
pub fn new_for_unseg_tc_checked(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
||||||
Self::new_for_tc_checked(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
});
|
||||||
}
|
|
||||||
|
|
||||||
/// Variant of [SpHeader::new_for_tc] which sets the sequence flag field to [SequenceFlags::Unsegmented].
|
|
||||||
///
|
|
||||||
/// This is an unchecked constructor which can panic on invalid input.
|
|
||||||
#[inline]
|
|
||||||
pub const fn new_for_unseg_tc(apid: u16, seq_count: u16, data_len: u16) -> Self {
|
|
||||||
Self::new_for_tc(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Variant of [SpHeader::new_for_tm] which sets the sequence flag field to [SequenceFlags::Unsegmented].
|
|
||||||
///
|
|
||||||
/// This is an unchecked constructor which can panic on invalid input.
|
|
||||||
#[inline]
|
|
||||||
pub const fn new_for_unseg_tm(apid: u16, seq_count: u16, data_len: u16) -> Self {
|
|
||||||
Self::new_for_tm(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
delegate! {
|
|
||||||
to self.packet_id {
|
|
||||||
/// Returns [false] and fails if the APID exceeds [MAX_APID]
|
|
||||||
#[inline]
|
|
||||||
pub fn set_apid(&mut self, apid: u16) -> bool;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
delegate! {
|
|
||||||
to self.psc {
|
|
||||||
/// Returns [false] and fails if the sequence count exceeds [MAX_SEQ_COUNT]
|
|
||||||
#[inline]
|
|
||||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_seq_flags(&mut self, seq_flags: SequenceFlags) {
|
pub fn set_seq_flags(&mut self, seq_flags: SequenceFlags) {
|
||||||
self.psc.seq_flags = seq_flags;
|
self.psc.seq_flags = seq_flags;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_sec_header_flag(&mut self) {
|
pub fn set_sec_header_flag(&mut self) {
|
||||||
self.packet_id.sec_header_flag = true;
|
self.packet_id.sec_header_flag = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn clear_sec_header_flag(&mut self) {
|
pub fn clear_sec_header_flag(&mut self) {
|
||||||
self.packet_id.sec_header_flag = false;
|
self.packet_id.sec_header_flag = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_packet_type(&mut self, packet_type: PacketType) {
|
pub fn set_packet_type(&mut self, packet_type: PacketType) {
|
||||||
self.packet_id.ptype = packet_type;
|
self.packet_id.ptype = packet_type;
|
||||||
}
|
}
|
||||||
@ -695,8 +598,8 @@ impl SpHeader {
|
|||||||
expected: CCSDS_HEADER_LEN,
|
expected: CCSDS_HEADER_LEN,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
let zc_header = zc::SpHeader::read_from_bytes(&buf[0..CCSDS_HEADER_LEN])
|
let zc_header = zc::SpHeader::from_bytes(&buf[0..CCSDS_HEADER_LEN])
|
||||||
.map_err(|_| ByteConversionError::ZeroCopyFromError)?;
|
.ok_or(ByteConversionError::ZeroCopyFromError)?;
|
||||||
Ok((Self::from(zc_header), &buf[CCSDS_HEADER_LEN..]))
|
Ok((Self::from(zc_header), &buf[CCSDS_HEADER_LEN..]))
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -714,19 +617,10 @@ impl SpHeader {
|
|||||||
}
|
}
|
||||||
let zc_header: zc::SpHeader = zc::SpHeader::from(*self);
|
let zc_header: zc::SpHeader = zc::SpHeader::from(*self);
|
||||||
zc_header
|
zc_header
|
||||||
.write_to(&mut buf[0..CCSDS_HEADER_LEN])
|
.to_bytes(&mut buf[0..CCSDS_HEADER_LEN])
|
||||||
.map_err(|_| ByteConversionError::ZeroCopyToError)?;
|
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
||||||
Ok(&mut buf[CCSDS_HEADER_LEN..])
|
Ok(&mut buf[CCSDS_HEADER_LEN..])
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Create a vector containing the CCSDS header.
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
pub fn to_vec(&self) -> alloc::vec::Vec<u8> {
|
|
||||||
let mut vec = alloc::vec![0; CCSDS_HEADER_LEN];
|
|
||||||
// This can not fail.
|
|
||||||
self.write_to_be_bytes(&mut vec[..]).unwrap();
|
|
||||||
vec
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CcsdsPacket for SpHeader {
|
impl CcsdsPacket for SpHeader {
|
||||||
@ -752,7 +646,6 @@ impl CcsdsPacket for SpHeader {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl CcsdsPrimaryHeader for SpHeader {
|
impl CcsdsPrimaryHeader for SpHeader {
|
||||||
#[inline]
|
|
||||||
fn from_composite_fields(
|
fn from_composite_fields(
|
||||||
packet_id: PacketId,
|
packet_id: PacketId,
|
||||||
psc: PacketSequenceCtrl,
|
psc: PacketSequenceCtrl,
|
||||||
@ -777,9 +670,9 @@ sph_from_other!(SpHeader, crate::zc::SpHeader);
|
|||||||
pub mod zc {
|
pub mod zc {
|
||||||
use crate::{CcsdsPacket, CcsdsPrimaryHeader, PacketId, PacketSequenceCtrl, VERSION_MASK};
|
use crate::{CcsdsPacket, CcsdsPrimaryHeader, PacketId, PacketSequenceCtrl, VERSION_MASK};
|
||||||
use zerocopy::byteorder::NetworkEndian;
|
use zerocopy::byteorder::NetworkEndian;
|
||||||
use zerocopy::{FromBytes, Immutable, IntoBytes, Unaligned, U16};
|
use zerocopy::{AsBytes, FromBytes, FromZeroes, Unaligned, U16};
|
||||||
|
|
||||||
#[derive(FromBytes, IntoBytes, Immutable, Unaligned, Debug)]
|
#[derive(FromBytes, FromZeroes, AsBytes, Unaligned, Debug)]
|
||||||
#[repr(C)]
|
#[repr(C)]
|
||||||
pub struct SpHeader {
|
pub struct SpHeader {
|
||||||
version_packet_id: U16<NetworkEndian>,
|
version_packet_id: U16<NetworkEndian>,
|
||||||
@ -804,6 +697,14 @@ pub mod zc {
|
|||||||
data_len: U16::from(data_len),
|
data_len: U16::from(data_len),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn from_bytes(slice: &[u8]) -> Option<Self> {
|
||||||
|
SpHeader::read_from(slice)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn to_bytes(&self, slice: &mut [u8]) -> Option<()> {
|
||||||
|
self.write_to(slice)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CcsdsPacket for SpHeader {
|
impl CcsdsPacket for SpHeader {
|
||||||
@ -812,12 +713,9 @@ pub mod zc {
|
|||||||
((self.version_packet_id.get() >> 13) as u8) & 0b111
|
((self.version_packet_id.get() >> 13) as u8) & 0b111
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn packet_id(&self) -> PacketId {
|
fn packet_id(&self) -> PacketId {
|
||||||
PacketId::from(self.packet_id_raw())
|
PacketId::from(self.packet_id_raw())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn psc(&self) -> PacketSequenceCtrl {
|
fn psc(&self) -> PacketSequenceCtrl {
|
||||||
PacketSequenceCtrl::from(self.psc_raw())
|
PacketSequenceCtrl::from(self.psc_raw())
|
||||||
}
|
}
|
||||||
@ -827,12 +725,10 @@ pub mod zc {
|
|||||||
self.data_len.get()
|
self.data_len.get()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn packet_id_raw(&self) -> u16 {
|
fn packet_id_raw(&self) -> u16 {
|
||||||
self.version_packet_id.get() & (!VERSION_MASK)
|
self.version_packet_id.get() & (!VERSION_MASK)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn psc_raw(&self) -> u16 {
|
fn psc_raw(&self) -> u16 {
|
||||||
self.psc.get()
|
self.psc.get()
|
||||||
}
|
}
|
||||||
@ -856,8 +752,6 @@ pub mod zc {
|
|||||||
pub(crate) mod tests {
|
pub(crate) mod tests {
|
||||||
use std::collections::HashSet;
|
use std::collections::HashSet;
|
||||||
|
|
||||||
#[allow(unused_imports)]
|
|
||||||
use crate::ByteConversionError;
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use crate::CcsdsPrimaryHeader;
|
use crate::CcsdsPrimaryHeader;
|
||||||
use crate::{
|
use crate::{
|
||||||
@ -872,15 +766,14 @@ pub(crate) mod tests {
|
|||||||
use postcard::{from_bytes, to_allocvec};
|
use postcard::{from_bytes, to_allocvec};
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{de::DeserializeOwned, Serialize};
|
use serde::{de::DeserializeOwned, Serialize};
|
||||||
use zerocopy::FromBytes;
|
|
||||||
|
|
||||||
const CONST_SP: SpHeader = SpHeader::new(
|
const CONST_SP: SpHeader = SpHeader::new(
|
||||||
PacketId::new_for_tc(true, 0x36),
|
PacketId::const_tc(true, 0x36),
|
||||||
PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 0x88),
|
PacketSequenceCtrl::const_new(SequenceFlags::ContinuationSegment, 0x88),
|
||||||
0x90,
|
0x90,
|
||||||
);
|
);
|
||||||
|
|
||||||
const PACKET_ID_TM: PacketId = PacketId::new_for_tm(true, 0x22);
|
const PACKET_ID_TM: PacketId = PacketId::const_tm(true, 0x22);
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
pub(crate) fn generic_serde_test<T: Serialize + DeserializeOwned + PartialEq + Debug>(
|
pub(crate) fn generic_serde_test<T: Serialize + DeserializeOwned + PartialEq + Debug>(
|
||||||
@ -892,12 +785,11 @@ pub(crate) mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[allow(clippy::assertions_on_constants)]
|
|
||||||
fn verify_const_packet_id() {
|
fn verify_const_packet_id() {
|
||||||
assert_eq!(PACKET_ID_TM.apid(), 0x22);
|
assert_eq!(PACKET_ID_TM.apid(), 0x22);
|
||||||
assert!(PACKET_ID_TM.sec_header_flag);
|
assert!(PACKET_ID_TM.sec_header_flag);
|
||||||
assert_eq!(PACKET_ID_TM.ptype, PacketType::Tm);
|
assert_eq!(PACKET_ID_TM.ptype, PacketType::Tm);
|
||||||
let const_tc_id = PacketId::new_for_tc(true, 0x23);
|
let const_tc_id = PacketId::const_tc(true, 0x23);
|
||||||
assert_eq!(const_tc_id.ptype, PacketType::Tc);
|
assert_eq!(const_tc_id.ptype, PacketType::Tc);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -906,32 +798,32 @@ pub(crate) mod tests {
|
|||||||
let id_default = PacketId::default();
|
let id_default = PacketId::default();
|
||||||
assert_eq!(id_default.ptype, PacketType::Tm);
|
assert_eq!(id_default.ptype, PacketType::Tm);
|
||||||
assert_eq!(id_default.apid, 0x000);
|
assert_eq!(id_default.apid, 0x000);
|
||||||
assert!(!id_default.sec_header_flag);
|
assert_eq!(id_default.sec_header_flag, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_packet_id_ctors() {
|
fn test_packet_id_ctors() {
|
||||||
let packet_id = PacketId::new_checked(PacketType::Tc, true, 0x1ff);
|
let packet_id = PacketId::new(PacketType::Tc, true, 0x1ff);
|
||||||
assert!(packet_id.is_some());
|
assert!(packet_id.is_some());
|
||||||
let packet_id = packet_id.unwrap();
|
let packet_id = packet_id.unwrap();
|
||||||
assert_eq!(packet_id.apid(), 0x1ff);
|
assert_eq!(packet_id.apid(), 0x1ff);
|
||||||
assert_eq!(packet_id.ptype, PacketType::Tc);
|
assert_eq!(packet_id.ptype, PacketType::Tc);
|
||||||
assert!(packet_id.sec_header_flag);
|
assert_eq!(packet_id.sec_header_flag, true);
|
||||||
let packet_id_tc = PacketId::new_for_tc_checked(true, 0x1ff);
|
let packet_id_tc = PacketId::tc(true, 0x1ff);
|
||||||
assert!(packet_id_tc.is_some());
|
assert!(packet_id_tc.is_some());
|
||||||
let packet_id_tc = packet_id_tc.unwrap();
|
let packet_id_tc = packet_id_tc.unwrap();
|
||||||
assert_eq!(packet_id_tc, packet_id);
|
assert_eq!(packet_id_tc, packet_id);
|
||||||
let packet_id_tm = PacketId::new_for_tm_checked(true, 0x2ff);
|
let packet_id_tm = PacketId::tm(true, 0x2ff);
|
||||||
assert!(packet_id_tm.is_some());
|
assert!(packet_id_tm.is_some());
|
||||||
let packet_id_tm = packet_id_tm.unwrap();
|
let packet_id_tm = packet_id_tm.unwrap();
|
||||||
assert!(packet_id_tm.sec_header_flag);
|
assert_eq!(packet_id_tm.sec_header_flag, true);
|
||||||
assert_eq!(packet_id_tm.ptype, PacketType::Tm);
|
assert_eq!(packet_id_tm.ptype, PacketType::Tm);
|
||||||
assert_eq!(packet_id_tm.apid, 0x2ff);
|
assert_eq!(packet_id_tm.apid, 0x2ff);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn verify_const_sp_header() {
|
fn verify_const_sp_header() {
|
||||||
assert!(CONST_SP.sec_header_flag());
|
assert_eq!(CONST_SP.sec_header_flag(), true);
|
||||||
assert_eq!(CONST_SP.apid(), 0x36);
|
assert_eq!(CONST_SP.apid(), 0x36);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
CONST_SP.sequence_flags(),
|
CONST_SP.sequence_flags(),
|
||||||
@ -972,7 +864,7 @@ pub(crate) mod tests {
|
|||||||
#[test]
|
#[test]
|
||||||
fn test_packet_id() {
|
fn test_packet_id() {
|
||||||
let packet_id =
|
let packet_id =
|
||||||
PacketId::new_checked(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
PacketId::new(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||||
assert_eq!(packet_id.raw(), 0x0042);
|
assert_eq!(packet_id.raw(), 0x0042);
|
||||||
let packet_id_from_raw = PacketId::from(packet_id.raw());
|
let packet_id_from_raw = PacketId::from(packet_id.raw());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
@ -980,26 +872,26 @@ pub(crate) mod tests {
|
|||||||
PacketType::Tm
|
PacketType::Tm
|
||||||
);
|
);
|
||||||
assert_eq!(packet_id_from_raw, packet_id);
|
assert_eq!(packet_id_from_raw, packet_id);
|
||||||
let packet_id_from_new = PacketId::new_checked(PacketType::Tm, false, 0x42).unwrap();
|
let packet_id_from_new = PacketId::new(PacketType::Tm, false, 0x42).unwrap();
|
||||||
assert_eq!(packet_id_from_new, packet_id);
|
assert_eq!(packet_id_from_new, packet_id);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_invalid_packet_id() {
|
fn test_invalid_packet_id() {
|
||||||
let packet_id_invalid = PacketId::new_checked(PacketType::Tc, true, 0xFFFF);
|
let packet_id_invalid = PacketId::new(PacketType::Tc, true, 0xFFFF);
|
||||||
assert!(packet_id_invalid.is_none());
|
assert!(packet_id_invalid.is_none());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_invalid_apid_setter() {
|
fn test_invalid_apid_setter() {
|
||||||
let mut packet_id =
|
let mut packet_id =
|
||||||
PacketId::new_checked(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
PacketId::new(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||||
assert!(!packet_id.set_apid(0xffff));
|
assert!(!packet_id.set_apid(0xffff));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_invalid_seq_count() {
|
fn test_invalid_seq_count() {
|
||||||
let mut psc = PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77)
|
let mut psc = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77)
|
||||||
.expect("PSC creation failed");
|
.expect("PSC creation failed");
|
||||||
assert_eq!(psc.seq_count(), 77);
|
assert_eq!(psc.seq_count(), 77);
|
||||||
assert!(!psc.set_seq_count(0xffff));
|
assert!(!psc.set_seq_count(0xffff));
|
||||||
@ -1007,7 +899,7 @@ pub(crate) mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_packet_seq_ctrl() {
|
fn test_packet_seq_ctrl() {
|
||||||
let mut psc = PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77)
|
let mut psc = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77)
|
||||||
.expect("PSC creation failed");
|
.expect("PSC creation failed");
|
||||||
assert_eq!(psc.raw(), 77);
|
assert_eq!(psc.raw(), 77);
|
||||||
let psc_from_raw = PacketSequenceCtrl::from(psc.raw());
|
let psc_from_raw = PacketSequenceCtrl::from(psc.raw());
|
||||||
@ -1016,18 +908,16 @@ pub(crate) mod tests {
|
|||||||
assert!(!psc.set_seq_count(2u16.pow(15)));
|
assert!(!psc.set_seq_count(2u16.pow(15)));
|
||||||
assert_eq!(psc.raw(), 77);
|
assert_eq!(psc.raw(), 77);
|
||||||
|
|
||||||
let psc_invalid = PacketSequenceCtrl::new_checked(SequenceFlags::FirstSegment, 0xFFFF);
|
let psc_invalid = PacketSequenceCtrl::new(SequenceFlags::FirstSegment, 0xFFFF);
|
||||||
assert!(psc_invalid.is_none());
|
assert!(psc_invalid.is_none());
|
||||||
let psc_from_new =
|
let psc_from_new = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77).unwrap();
|
||||||
PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77).unwrap();
|
|
||||||
assert_eq!(psc_from_new, psc);
|
assert_eq!(psc_from_new, psc);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
fn test_serde_sph() {
|
fn test_serde_sph() {
|
||||||
let sp_header =
|
let sp_header = SpHeader::tc_unseg(0x42, 12, 0).expect("Error creating SP header");
|
||||||
SpHeader::new_for_unseg_tc_checked(0x42, 12, 0).expect("Error creating SP header");
|
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert!(sp_header.is_tc());
|
assert!(sp_header.is_tc());
|
||||||
assert!(!sp_header.sec_header_flag());
|
assert!(!sp_header.sec_header_flag());
|
||||||
@ -1049,8 +939,7 @@ pub(crate) mod tests {
|
|||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert_eq!(sp_header.data_len, 0);
|
assert_eq!(sp_header.data_len, 0);
|
||||||
|
|
||||||
let sp_header =
|
let sp_header = SpHeader::tm_unseg(0x7, 22, 36).expect("Error creating SP header");
|
||||||
SpHeader::new_for_unseg_tm_checked(0x7, 22, 36).expect("Error creating SP header");
|
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert!(sp_header.is_tm());
|
assert!(sp_header.is_tm());
|
||||||
assert!(!sp_header.sec_header_flag());
|
assert!(!sp_header.sec_header_flag());
|
||||||
@ -1064,8 +953,8 @@ pub(crate) mod tests {
|
|||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
|
|
||||||
let from_comp_fields = SpHeader::from_composite_fields(
|
let from_comp_fields = SpHeader::from_composite_fields(
|
||||||
PacketId::new(PacketType::Tc, true, 0x42),
|
PacketId::new(PacketType::Tc, true, 0x42).unwrap(),
|
||||||
PacketSequenceCtrl::new(SequenceFlags::Unsegmented, 0x7),
|
PacketSequenceCtrl::new(SequenceFlags::Unsegmented, 0x7).unwrap(),
|
||||||
0,
|
0,
|
||||||
None,
|
None,
|
||||||
);
|
);
|
||||||
@ -1082,7 +971,7 @@ pub(crate) mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_setters() {
|
fn test_setters() {
|
||||||
let sp_header = SpHeader::new_for_tc_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
let sp_header = SpHeader::tc(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let mut sp_header = sp_header.unwrap();
|
let mut sp_header = sp_header.unwrap();
|
||||||
sp_header.set_apid(0x12);
|
sp_header.set_apid(0x12);
|
||||||
@ -1100,7 +989,7 @@ pub(crate) mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tc_ctor() {
|
fn test_tc_ctor() {
|
||||||
let sp_header = SpHeader::new_for_tc_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
let sp_header = SpHeader::tc(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||||
@ -1108,35 +997,23 @@ pub(crate) mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tc_ctor_unseg() {
|
fn test_tc_ctor_unseg() {
|
||||||
let sp_header = SpHeader::new_for_unseg_tc_checked(0x42, 25, 0);
|
let sp_header = SpHeader::tc_unseg(0x42, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_tc_ctor_unseg_const() {
|
|
||||||
let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 0);
|
|
||||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tm_ctor() {
|
fn test_tm_ctor() {
|
||||||
let sp_header = SpHeader::new_for_tm_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
let sp_header = SpHeader::tm(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_tm_ctor_const() {
|
|
||||||
let sp_header = SpHeader::new_for_tm(0x42, SequenceFlags::Unsegmented, 25, 0);
|
|
||||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tm_ctor_unseg() {
|
fn test_tm_ctor_unseg() {
|
||||||
let sp_header = SpHeader::new_for_unseg_tm_checked(0x42, 25, 0);
|
let sp_header = SpHeader::tm_unseg(0x42, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||||
@ -1152,10 +1029,10 @@ pub(crate) mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_zc_sph() {
|
fn test_zc_sph() {
|
||||||
use zerocopy::IntoBytes;
|
use zerocopy::AsBytes;
|
||||||
|
|
||||||
let sp_header = SpHeader::new_for_unseg_tc_checked(0x7FF, pow(2, 14) - 1, 0)
|
let sp_header =
|
||||||
.expect("Error creating SP header");
|
SpHeader::tc_unseg(0x7FF, pow(2, 14) - 1, 0).expect("Error creating SP header");
|
||||||
assert_eq!(sp_header.ptype(), PacketType::Tc);
|
assert_eq!(sp_header.ptype(), PacketType::Tc);
|
||||||
assert_eq!(sp_header.apid(), 0x7FF);
|
assert_eq!(sp_header.apid(), 0x7FF);
|
||||||
assert_eq!(sp_header.data_len(), 0);
|
assert_eq!(sp_header.data_len(), 0);
|
||||||
@ -1172,7 +1049,7 @@ pub(crate) mod tests {
|
|||||||
assert_eq!(slice[5], 0x00);
|
assert_eq!(slice[5], 0x00);
|
||||||
|
|
||||||
let mut slice = [0; 6];
|
let mut slice = [0; 6];
|
||||||
sp_header_zc.write_to(slice.as_mut_slice()).unwrap();
|
sp_header_zc.write_to(slice.as_mut_slice());
|
||||||
assert_eq!(slice.len(), 6);
|
assert_eq!(slice.len(), 6);
|
||||||
assert_eq!(slice[0], 0x17);
|
assert_eq!(slice[0], 0x17);
|
||||||
assert_eq!(slice[1], 0xFF);
|
assert_eq!(slice[1], 0xFF);
|
||||||
@ -1183,7 +1060,7 @@ pub(crate) mod tests {
|
|||||||
|
|
||||||
let mut test_vec = vec![0_u8; 6];
|
let mut test_vec = vec![0_u8; 6];
|
||||||
let slice = test_vec.as_mut_slice();
|
let slice = test_vec.as_mut_slice();
|
||||||
sp_header_zc.write_to(slice).unwrap();
|
sp_header_zc.write_to(slice);
|
||||||
let slice = test_vec.as_slice();
|
let slice = test_vec.as_slice();
|
||||||
assert_eq!(slice.len(), 6);
|
assert_eq!(slice.len(), 6);
|
||||||
assert_eq!(slice[0], 0x17);
|
assert_eq!(slice[0], 0x17);
|
||||||
@ -1193,8 +1070,8 @@ pub(crate) mod tests {
|
|||||||
assert_eq!(slice[4], 0x00);
|
assert_eq!(slice[4], 0x00);
|
||||||
assert_eq!(slice[5], 0x00);
|
assert_eq!(slice[5], 0x00);
|
||||||
|
|
||||||
let sp_header = zc::SpHeader::read_from_bytes(slice);
|
let sp_header = zc::SpHeader::from_bytes(slice);
|
||||||
assert!(sp_header.is_ok());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert_eq!(sp_header.packet_id_raw(), 0x17FF);
|
assert_eq!(sp_header.packet_id_raw(), 0x17FF);
|
||||||
@ -1220,40 +1097,4 @@ pub(crate) mod tests {
|
|||||||
let mut id_set = HashSet::new();
|
let mut id_set = HashSet::new();
|
||||||
id_set.insert(PacketId::from(1_u16));
|
id_set.insert(PacketId::from(1_u16));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn sp_header_from_apid() {
|
|
||||||
let sp_header = SpHeader::new_from_apid(0x03);
|
|
||||||
assert_eq!(sp_header.apid(), 0x03);
|
|
||||||
assert_eq!(sp_header.data_len(), 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn sp_header_from_apid_checked() {
|
|
||||||
let sp_header = SpHeader::new_from_apid_checked(0x03).unwrap();
|
|
||||||
assert_eq!(sp_header.apid(), 0x03);
|
|
||||||
assert_eq!(sp_header.data_len(), 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "defmt")]
|
|
||||||
fn is_defmt_format<T: defmt::Format>(_t: T) {}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[cfg(feature = "defmt")]
|
|
||||||
fn test_defmt_format() {
|
|
||||||
is_defmt_format(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: 1,
|
|
||||||
expected: 2,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_sp_header_as_vec() {
|
|
||||||
let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 1);
|
|
||||||
let sp_header_as_vec = sp_header.to_vec();
|
|
||||||
let sp_header_read_back = SpHeader::from_be_bytes(&sp_header_as_vec)
|
|
||||||
.expect("Error reading back SP header")
|
|
||||||
.0;
|
|
||||||
assert_eq!(sp_header, sp_header_read_back);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
250
src/seq_count.rs
250
src/seq_count.rs
@ -1,250 +0,0 @@
|
|||||||
use crate::MAX_SEQ_COUNT;
|
|
||||||
use core::cell::Cell;
|
|
||||||
use paste::paste;
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
pub use stdmod::*;
|
|
||||||
|
|
||||||
/// Core trait for objects which can provide a sequence count.
|
|
||||||
///
|
|
||||||
/// The core functions are not mutable on purpose to allow easier usage with
|
|
||||||
/// static structs when using the interior mutability pattern. This can be achieved by using
|
|
||||||
/// [Cell], [core::cell::RefCell] or atomic types.
|
|
||||||
pub trait SequenceCountProvider {
|
|
||||||
type Raw: Into<u64>;
|
|
||||||
const MAX_BIT_WIDTH: usize;
|
|
||||||
|
|
||||||
fn get(&self) -> Self::Raw;
|
|
||||||
|
|
||||||
fn increment(&self);
|
|
||||||
|
|
||||||
fn get_and_increment(&self) -> Self::Raw {
|
|
||||||
let val = self.get();
|
|
||||||
self.increment();
|
|
||||||
val
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct SeqCountProviderSimple<T: Copy> {
|
|
||||||
seq_count: Cell<T>,
|
|
||||||
max_val: T,
|
|
||||||
}
|
|
||||||
|
|
||||||
macro_rules! impl_for_primitives {
|
|
||||||
($($ty: ident,)+) => {
|
|
||||||
$(
|
|
||||||
paste! {
|
|
||||||
impl SeqCountProviderSimple<$ty> {
|
|
||||||
pub fn [<new_custom_max_val_ $ty>](max_val: $ty) -> Self {
|
|
||||||
Self {
|
|
||||||
seq_count: Cell::new(0),
|
|
||||||
max_val,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
pub fn [<new_ $ty>]() -> Self {
|
|
||||||
Self {
|
|
||||||
seq_count: Cell::new(0),
|
|
||||||
max_val: $ty::MAX
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for SeqCountProviderSimple<$ty> {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self::[<new_ $ty>]()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl SequenceCountProvider for SeqCountProviderSimple<$ty> {
|
|
||||||
type Raw = $ty;
|
|
||||||
const MAX_BIT_WIDTH: usize = core::mem::size_of::<Self::Raw>() * 8;
|
|
||||||
|
|
||||||
fn get(&self) -> Self::Raw {
|
|
||||||
self.seq_count.get()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn increment(&self) {
|
|
||||||
self.get_and_increment();
|
|
||||||
}
|
|
||||||
|
|
||||||
fn get_and_increment(&self) -> Self::Raw {
|
|
||||||
let curr_count = self.seq_count.get();
|
|
||||||
|
|
||||||
if curr_count == self.max_val {
|
|
||||||
self.seq_count.set(0);
|
|
||||||
} else {
|
|
||||||
self.seq_count.set(curr_count + 1);
|
|
||||||
}
|
|
||||||
curr_count
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
)+
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl_for_primitives!(u8, u16, u32, u64,);
|
|
||||||
|
|
||||||
/// This is a sequence count provider which wraps around at [MAX_SEQ_COUNT].
|
|
||||||
#[derive(Clone)]
|
|
||||||
pub struct CcsdsSimpleSeqCountProvider {
|
|
||||||
provider: SeqCountProviderSimple<u16>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for CcsdsSimpleSeqCountProvider {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
provider: SeqCountProviderSimple::new_custom_max_val_u16(MAX_SEQ_COUNT),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl SequenceCountProvider for CcsdsSimpleSeqCountProvider {
|
|
||||||
type Raw = u16;
|
|
||||||
const MAX_BIT_WIDTH: usize = core::mem::size_of::<Self::Raw>() * 8;
|
|
||||||
delegate::delegate! {
|
|
||||||
to self.provider {
|
|
||||||
fn get(&self) -> u16;
|
|
||||||
fn increment(&self);
|
|
||||||
fn get_and_increment(&self) -> u16;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
|
||||||
pub mod stdmod {
|
|
||||||
use super::*;
|
|
||||||
use std::sync::{Arc, Mutex};
|
|
||||||
|
|
||||||
macro_rules! sync_clonable_seq_counter_impl {
|
|
||||||
($($ty: ident,)+) => {
|
|
||||||
$(paste! {
|
|
||||||
/// These sequence counters can be shared between threads and can also be
|
|
||||||
/// configured to wrap around at specified maximum values. Please note that
|
|
||||||
/// that the API provided by this class will not panic und [Mutex] lock errors,
|
|
||||||
/// but it will yield 0 for the getter functions.
|
|
||||||
#[derive(Clone, Default)]
|
|
||||||
pub struct [<SeqCountProviderSync $ty:upper>] {
|
|
||||||
seq_count: Arc<Mutex<$ty>>,
|
|
||||||
max_val: $ty
|
|
||||||
}
|
|
||||||
|
|
||||||
impl [<SeqCountProviderSync $ty:upper>] {
|
|
||||||
pub fn new() -> Self {
|
|
||||||
Self::new_with_max_val($ty::MAX)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn new_with_max_val(max_val: $ty) -> Self {
|
|
||||||
Self {
|
|
||||||
seq_count: Arc::default(),
|
|
||||||
max_val
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
impl SequenceCountProvider for [<SeqCountProviderSync $ty:upper>] {
|
|
||||||
type Raw = $ty;
|
|
||||||
const MAX_BIT_WIDTH: usize = core::mem::size_of::<Self::Raw>() * 8;
|
|
||||||
|
|
||||||
fn get(&self) -> $ty {
|
|
||||||
match self.seq_count.lock() {
|
|
||||||
Ok(counter) => *counter,
|
|
||||||
Err(_) => 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn increment(&self) {
|
|
||||||
self.get_and_increment();
|
|
||||||
}
|
|
||||||
|
|
||||||
fn get_and_increment(&self) -> $ty {
|
|
||||||
match self.seq_count.lock() {
|
|
||||||
Ok(mut counter) => {
|
|
||||||
let val = *counter;
|
|
||||||
if val == self.max_val {
|
|
||||||
*counter = 0;
|
|
||||||
} else {
|
|
||||||
*counter += 1;
|
|
||||||
}
|
|
||||||
val
|
|
||||||
}
|
|
||||||
Err(_) => 0,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})+
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sync_clonable_seq_counter_impl!(u8, u16, u32, u64,);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use crate::seq_count::{
|
|
||||||
CcsdsSimpleSeqCountProvider, SeqCountProviderSimple, SeqCountProviderSyncU8,
|
|
||||||
SequenceCountProvider,
|
|
||||||
};
|
|
||||||
use crate::MAX_SEQ_COUNT;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_u8_counter() {
|
|
||||||
let u8_counter = SeqCountProviderSimple::<u8>::default();
|
|
||||||
assert_eq!(u8_counter.get(), 0);
|
|
||||||
assert_eq!(u8_counter.get_and_increment(), 0);
|
|
||||||
assert_eq!(u8_counter.get_and_increment(), 1);
|
|
||||||
assert_eq!(u8_counter.get(), 2);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_u8_counter_overflow() {
|
|
||||||
let u8_counter = SeqCountProviderSimple::new_u8();
|
|
||||||
for _ in 0..256 {
|
|
||||||
u8_counter.increment();
|
|
||||||
}
|
|
||||||
assert_eq!(u8_counter.get(), 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_ccsds_counter() {
|
|
||||||
let ccsds_counter = CcsdsSimpleSeqCountProvider::default();
|
|
||||||
assert_eq!(ccsds_counter.get(), 0);
|
|
||||||
assert_eq!(ccsds_counter.get_and_increment(), 0);
|
|
||||||
assert_eq!(ccsds_counter.get_and_increment(), 1);
|
|
||||||
assert_eq!(ccsds_counter.get(), 2);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_ccsds_counter_overflow() {
|
|
||||||
let ccsds_counter = CcsdsSimpleSeqCountProvider::default();
|
|
||||||
for _ in 0..MAX_SEQ_COUNT + 1 {
|
|
||||||
ccsds_counter.increment();
|
|
||||||
}
|
|
||||||
assert_eq!(ccsds_counter.get(), 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_atomic_ref_counters() {
|
|
||||||
let sync_u8_counter = SeqCountProviderSyncU8::new();
|
|
||||||
assert_eq!(sync_u8_counter.get(), 0);
|
|
||||||
assert_eq!(sync_u8_counter.get_and_increment(), 0);
|
|
||||||
assert_eq!(sync_u8_counter.get_and_increment(), 1);
|
|
||||||
assert_eq!(sync_u8_counter.get(), 2);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_atomic_ref_counters_overflow() {
|
|
||||||
let sync_u8_counter = SeqCountProviderSyncU8::new();
|
|
||||||
for _ in 0..u8::MAX as u16 + 1 {
|
|
||||||
sync_u8_counter.increment();
|
|
||||||
}
|
|
||||||
assert_eq!(sync_u8_counter.get(), 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_atomic_ref_counters_overflow_custom_max_val() {
|
|
||||||
let sync_u8_counter = SeqCountProviderSyncU8::new_with_max_val(128);
|
|
||||||
for _ in 0..129 {
|
|
||||||
sync_u8_counter.increment();
|
|
||||||
}
|
|
||||||
assert_eq!(sync_u8_counter.get(), 0);
|
|
||||||
}
|
|
||||||
}
|
|
@ -71,19 +71,7 @@ mod tests {
|
|||||||
use std::format;
|
use std::format;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_a_unterminated_epoch() {
|
fn test_ascii_timestamp_a_unterminated() {
|
||||||
let date = chrono::DateTime::UNIX_EPOCH;
|
|
||||||
let stamp_formatter = generate_time_code_a(&date);
|
|
||||||
let stamp = format!("{}", stamp_formatter);
|
|
||||||
let t_sep = stamp.find('T');
|
|
||||||
assert!(t_sep.is_some());
|
|
||||||
assert_eq!(t_sep.unwrap(), 10);
|
|
||||||
assert_eq!(stamp.len(), FMT_STR_CODE_A_WITH_SIZE.1);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_ascii_timestamp_a_unterminated_now() {
|
|
||||||
let date = Utc::now();
|
let date = Utc::now();
|
||||||
let stamp_formatter = generate_time_code_a(&date);
|
let stamp_formatter = generate_time_code_a(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
@ -94,24 +82,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_a_terminated_epoch() {
|
fn test_ascii_timestamp_a_terminated() {
|
||||||
let date = chrono::DateTime::UNIX_EPOCH;
|
|
||||||
let stamp_formatter = generate_time_code_a_terminated(&date);
|
|
||||||
let stamp = format!("{}", stamp_formatter);
|
|
||||||
let t_sep = stamp.find('T');
|
|
||||||
assert!(t_sep.is_some());
|
|
||||||
assert_eq!(t_sep.unwrap(), 10);
|
|
||||||
let z_terminator = stamp.find('Z');
|
|
||||||
assert!(z_terminator.is_some());
|
|
||||||
assert_eq!(
|
|
||||||
z_terminator.unwrap(),
|
|
||||||
FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1 - 1
|
|
||||||
);
|
|
||||||
assert_eq!(stamp.len(), FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1);
|
|
||||||
}
|
|
||||||
#[test]
|
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_ascii_timestamp_a_terminated_now() {
|
|
||||||
let date = Utc::now();
|
let date = Utc::now();
|
||||||
let stamp_formatter = generate_time_code_a_terminated(&date);
|
let stamp_formatter = generate_time_code_a_terminated(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
@ -128,19 +99,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_b_unterminated_epoch() {
|
fn test_ascii_timestamp_b_unterminated() {
|
||||||
let date = chrono::DateTime::UNIX_EPOCH;
|
|
||||||
let stamp_formatter = generate_time_code_b(&date);
|
|
||||||
let stamp = format!("{}", stamp_formatter);
|
|
||||||
let t_sep = stamp.find('T');
|
|
||||||
assert!(t_sep.is_some());
|
|
||||||
assert_eq!(t_sep.unwrap(), 8);
|
|
||||||
assert_eq!(stamp.len(), FMT_STR_CODE_B_WITH_SIZE.1);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_ascii_timestamp_b_unterminated_now() {
|
|
||||||
let date = Utc::now();
|
let date = Utc::now();
|
||||||
let stamp_formatter = generate_time_code_b(&date);
|
let stamp_formatter = generate_time_code_b(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
@ -151,25 +110,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_b_terminated_epoch() {
|
fn test_ascii_timestamp_b_terminated() {
|
||||||
let date = chrono::DateTime::UNIX_EPOCH;
|
|
||||||
let stamp_formatter = generate_time_code_b_terminated(&date);
|
|
||||||
let stamp = format!("{}", stamp_formatter);
|
|
||||||
let t_sep = stamp.find('T');
|
|
||||||
assert!(t_sep.is_some());
|
|
||||||
assert_eq!(t_sep.unwrap(), 8);
|
|
||||||
let z_terminator = stamp.find('Z');
|
|
||||||
assert!(z_terminator.is_some());
|
|
||||||
assert_eq!(
|
|
||||||
z_terminator.unwrap(),
|
|
||||||
FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1 - 1
|
|
||||||
);
|
|
||||||
assert_eq!(stamp.len(), FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_ascii_timestamp_b_terminated_now() {
|
|
||||||
let date = Utc::now();
|
let date = Utc::now();
|
||||||
let stamp_formatter = generate_time_code_b_terminated(&date);
|
let stamp_formatter = generate_time_code_b_terminated(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
|
@ -7,13 +7,17 @@
|
|||||||
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;
|
use core::fmt::{Debug, Display, Formatter};
|
||||||
use core::ops::{Add, AddAssign};
|
use core::ops::{Add, AddAssign};
|
||||||
use core::time::Duration;
|
use core::time::Duration;
|
||||||
|
|
||||||
|
use delegate::delegate;
|
||||||
|
|
||||||
#[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")]
|
||||||
@ -74,7 +78,6 @@ impl ProvidesDaysLength for DaysLen24Bits {
|
|||||||
|
|
||||||
#[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))]
|
|
||||||
pub enum LengthOfDaySegment {
|
pub enum LengthOfDaySegment {
|
||||||
Short16Bits = 0,
|
Short16Bits = 0,
|
||||||
Long24Bits = 1,
|
Long24Bits = 1,
|
||||||
@ -89,19 +92,48 @@ pub enum SubmillisPrecision {
|
|||||||
Reserved = 0b11,
|
Reserved = 0b11,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone, thiserror::Error)]
|
#[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))]
|
|
||||||
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),
|
||||||
#[error("date before CCSDS epoch: {0}")]
|
DateBeforeCcsdsEpoch(DateBeforeCcsdsEpochError),
|
||||||
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 {
|
||||||
@ -111,7 +143,6 @@ pub fn length_of_day_segment_from_pfield(pfield: u8) -> LengthOfDaySegment {
|
|||||||
LengthOfDaySegment::Short16Bits
|
LengthOfDaySegment::Short16Bits
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn precision_from_pfield(pfield: u8) -> SubmillisPrecision {
|
pub fn precision_from_pfield(pfield: u8) -> SubmillisPrecision {
|
||||||
match pfield & 0b11 {
|
match pfield & 0b11 {
|
||||||
0b01 => SubmillisPrecision::Microseconds,
|
0b01 => SubmillisPrecision::Microseconds,
|
||||||
@ -239,70 +270,54 @@ impl ConversionFromUnix {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl CdsCommon for ConversionFromUnix {
|
impl CdsCommon for ConversionFromUnix {
|
||||||
#[inline]
|
|
||||||
fn submillis_precision(&self) -> SubmillisPrecision {
|
fn submillis_precision(&self) -> SubmillisPrecision {
|
||||||
self.submilis_prec
|
self.submilis_prec
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn ms_of_day(&self) -> u32 {
|
fn ms_of_day(&self) -> u32 {
|
||||||
self.ms_of_day
|
self.ms_of_day
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn ccsds_days_as_u32(&self) -> u32 {
|
fn ccsds_days_as_u32(&self) -> u32 {
|
||||||
self.ccsds_days
|
self.ccsds_days
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn submillis(&self) -> u32 {
|
fn submillis(&self) -> u32 {
|
||||||
self.submillis
|
self.submillis
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CdsConverter for ConversionFromUnix {
|
impl CdsConverter for ConversionFromUnix {
|
||||||
#[inline]
|
|
||||||
fn unix_days_seconds(&self) -> i64 {
|
fn unix_days_seconds(&self) -> i64 {
|
||||||
self.unix_days_seconds
|
self.unix_days_seconds
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper struct which generates fields for the CDS time provider from a datetime.
|
/// Helper struct which generates fields for the CDS time provider from a datetime.
|
||||||
#[cfg(feature = "chrono")]
|
|
||||||
struct ConversionFromChronoDatetime {
|
struct ConversionFromChronoDatetime {
|
||||||
unix_conversion: ConversionFromUnix,
|
unix_conversion: ConversionFromUnix,
|
||||||
submillis_prec: SubmillisPrecision,
|
submillis_prec: SubmillisPrecision,
|
||||||
submillis: u32,
|
submillis: u32,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "chrono")]
|
|
||||||
impl CdsCommon for ConversionFromChronoDatetime {
|
impl CdsCommon for ConversionFromChronoDatetime {
|
||||||
#[inline]
|
|
||||||
fn submillis_precision(&self) -> SubmillisPrecision {
|
fn submillis_precision(&self) -> SubmillisPrecision {
|
||||||
self.submillis_prec
|
self.submillis_prec
|
||||||
}
|
}
|
||||||
|
|
||||||
delegate::delegate! {
|
delegate! {
|
||||||
to self.unix_conversion {
|
to self.unix_conversion {
|
||||||
#[inline]
|
|
||||||
fn ms_of_day(&self) -> u32;
|
fn ms_of_day(&self) -> u32;
|
||||||
#[inline]
|
|
||||||
fn ccsds_days_as_u32(&self) -> u32;
|
fn ccsds_days_as_u32(&self) -> u32;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn submillis(&self) -> u32 {
|
fn submillis(&self) -> u32 {
|
||||||
self.submillis
|
self.submillis
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "chrono")]
|
|
||||||
impl CdsConverter for ConversionFromChronoDatetime {
|
impl CdsConverter for ConversionFromChronoDatetime {
|
||||||
delegate::delegate! {to self.unix_conversion {
|
delegate! {to self.unix_conversion { fn unix_days_seconds(&self) -> i64; }}
|
||||||
#[inline]
|
|
||||||
fn unix_days_seconds(&self) -> i64;
|
|
||||||
}}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
@ -336,6 +351,7 @@ impl ConversionFromChronoDatetime {
|
|||||||
Self::new_generic(dt, SubmillisPrecision::Picoseconds)
|
Self::new_generic(dt, SubmillisPrecision::Picoseconds)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "chrono")]
|
||||||
fn new_generic(
|
fn new_generic(
|
||||||
dt: &chrono::DateTime<chrono::Utc>,
|
dt: &chrono::DateTime<chrono::Utc>,
|
||||||
prec: SubmillisPrecision,
|
prec: SubmillisPrecision,
|
||||||
@ -417,7 +433,7 @@ impl CdsCommon for ConversionFromNow {
|
|||||||
fn submillis_precision(&self) -> SubmillisPrecision {
|
fn submillis_precision(&self) -> SubmillisPrecision {
|
||||||
self.submillis_prec
|
self.submillis_prec
|
||||||
}
|
}
|
||||||
delegate::delegate! {
|
delegate! {
|
||||||
to self.unix_conversion {
|
to self.unix_conversion {
|
||||||
fn ms_of_day(&self) -> u32;
|
fn ms_of_day(&self) -> u32;
|
||||||
fn ccsds_days_as_u32(&self) -> u32;
|
fn ccsds_days_as_u32(&self) -> u32;
|
||||||
@ -431,7 +447,7 @@ impl CdsCommon for ConversionFromNow {
|
|||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
impl CdsConverter for ConversionFromNow {
|
impl CdsConverter for ConversionFromNow {
|
||||||
delegate::delegate! {to self.unix_conversion { fn unix_days_seconds(&self) -> i64; }}
|
delegate! {to self.unix_conversion { fn unix_days_seconds(&self) -> i64; }}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
@ -569,7 +585,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 => (),
|
||||||
_ => {
|
_ => {
|
||||||
@ -582,7 +598,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,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@ -1591,7 +1607,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_time_now() {
|
fn test_time_now() {
|
||||||
let timestamp_now = CdsTime::now_with_u16_days().unwrap();
|
let timestamp_now = CdsTime::now_with_u16_days().unwrap();
|
||||||
let compare_stamp = chrono::Utc::now();
|
let compare_stamp = chrono::Utc::now();
|
||||||
@ -1599,7 +1614,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_time_now_us_prec() {
|
fn test_time_now_us_prec() {
|
||||||
let timestamp_now = CdsTime::now_with_u16_days_us_precision().unwrap();
|
let timestamp_now = CdsTime::now_with_u16_days_us_precision().unwrap();
|
||||||
let compare_stamp = chrono::Utc::now();
|
let compare_stamp = chrono::Utc::now();
|
||||||
@ -1607,7 +1621,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_time_now_ps_prec() {
|
fn test_time_now_ps_prec() {
|
||||||
let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
|
let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
|
||||||
let compare_stamp = chrono::Utc::now();
|
let compare_stamp = chrono::Utc::now();
|
||||||
@ -1615,7 +1628,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_time_now_ps_prec_u16_days() {
|
fn test_time_now_ps_prec_u16_days() {
|
||||||
let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
|
let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
|
||||||
let compare_stamp = chrono::Utc::now();
|
let compare_stamp = chrono::Utc::now();
|
||||||
@ -1623,7 +1635,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_time_now_ps_prec_u24_days() {
|
fn test_time_now_ps_prec_u24_days() {
|
||||||
let timestamp_now = CdsTime::now_with_u24_days_ps_precision().unwrap();
|
let timestamp_now = CdsTime::now_with_u24_days_ps_precision().unwrap();
|
||||||
let compare_stamp = chrono::Utc::now();
|
let compare_stamp = chrono::Utc::now();
|
||||||
@ -2280,7 +2291,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_update_from_now() {
|
fn test_update_from_now() {
|
||||||
let mut stamp = CdsTime::new_with_u16_days(0, 0);
|
let mut stamp = CdsTime::new_with_u16_days(0, 0);
|
||||||
let _ = stamp.update_from_now();
|
let _ = stamp.update_from_now();
|
||||||
@ -2296,7 +2306,6 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_serialization() {
|
fn test_serialization() {
|
||||||
let stamp_now = CdsTime::now_with_u16_days().expect("Error retrieving time");
|
let stamp_now = CdsTime::now_with_u16_days().expect("Error retrieving time");
|
||||||
let val = to_allocvec(&stamp_now).expect("Serializing timestamp failed");
|
let val = to_allocvec(&stamp_now).expect("Serializing timestamp failed");
|
||||||
|
@ -9,6 +9,7 @@ use serde::{Deserialize, Serialize};
|
|||||||
use core::fmt::{Debug, Display, Formatter};
|
use core::fmt::{Debug, Display, Formatter};
|
||||||
use core::ops::{Add, AddAssign};
|
use core::ops::{Add, AddAssign};
|
||||||
use core::time::Duration;
|
use core::time::Duration;
|
||||||
|
use core::u64;
|
||||||
|
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
|
|
||||||
@ -36,7 +37,6 @@ pub const MAX_CUC_LEN_SMALL_PREAMBLE: usize = 8;
|
|||||||
|
|
||||||
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub enum FractionalResolution {
|
pub enum FractionalResolution {
|
||||||
/// No fractional part, only second resolution
|
/// No fractional part, only second resolution
|
||||||
Seconds = 0,
|
Seconds = 0,
|
||||||
@ -105,7 +105,6 @@ pub fn fractional_part_from_subsec_ns(res: FractionalResolution, ns: u64) -> Fra
|
|||||||
|
|
||||||
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub enum CucError {
|
pub enum CucError {
|
||||||
InvalidCounterWidth(u8),
|
InvalidCounterWidth(u8),
|
||||||
/// Invalid counter supplied.
|
/// Invalid counter supplied.
|
||||||
@ -176,7 +175,6 @@ pub struct FractionalPart {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl FractionalPart {
|
impl FractionalPart {
|
||||||
#[inline]
|
|
||||||
pub const fn new(resolution: FractionalResolution, counter: u32) -> Self {
|
pub const fn new(resolution: FractionalResolution, counter: u32) -> Self {
|
||||||
let div = fractional_res_to_div(resolution);
|
let div = fractional_res_to_div(resolution);
|
||||||
assert!(counter <= div, "invalid counter for resolution");
|
assert!(counter <= div, "invalid counter for resolution");
|
||||||
@ -187,18 +185,15 @@ impl FractionalPart {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// An empty fractional part for second resolution only.
|
/// An empty fractional part for second resolution only.
|
||||||
#[inline]
|
|
||||||
pub const fn new_with_seconds_resolution() -> Self {
|
pub const fn new_with_seconds_resolution() -> Self {
|
||||||
Self::new(FractionalResolution::Seconds, 0)
|
Self::new(FractionalResolution::Seconds, 0)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper method which simply calls [Self::new_with_seconds_resolution].
|
/// Helper method which simply calls [Self::new_with_seconds_resolution].
|
||||||
#[inline]
|
|
||||||
pub const fn new_empty() -> Self {
|
pub const fn new_empty() -> Self {
|
||||||
Self::new_with_seconds_resolution()
|
Self::new_with_seconds_resolution()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_checked(resolution: FractionalResolution, counter: u32) -> Option<Self> {
|
pub fn new_checked(resolution: FractionalResolution, counter: u32) -> Option<Self> {
|
||||||
let div = fractional_res_to_div(resolution);
|
let div = fractional_res_to_div(resolution);
|
||||||
if counter > div {
|
if counter > div {
|
||||||
@ -210,17 +205,14 @@ impl FractionalPart {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn resolution(&self) -> FractionalResolution {
|
pub fn resolution(&self) -> FractionalResolution {
|
||||||
self.resolution
|
self.resolution
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn counter(&self) -> u32 {
|
pub fn counter(&self) -> u32 {
|
||||||
self.counter
|
self.counter
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn no_fractional_part(&self) -> bool {
|
pub fn no_fractional_part(&self) -> bool {
|
||||||
self.resolution == FractionalResolution::Seconds
|
self.resolution == FractionalResolution::Seconds
|
||||||
}
|
}
|
||||||
@ -291,7 +283,6 @@ pub struct CucTimeWithLeapSecs {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl CucTimeWithLeapSecs {
|
impl CucTimeWithLeapSecs {
|
||||||
#[inline]
|
|
||||||
pub fn new(time: CucTime, leap_seconds: u32) -> Self {
|
pub fn new(time: CucTime, leap_seconds: u32) -> Self {
|
||||||
Self { time, leap_seconds }
|
Self { time, leap_seconds }
|
||||||
}
|
}
|
||||||
@ -307,7 +298,6 @@ pub fn pfield_len(pfield: u8) -> usize {
|
|||||||
|
|
||||||
impl CucTime {
|
impl CucTime {
|
||||||
/// Create a time provider with a four byte counter and no fractional part.
|
/// Create a time provider with a four byte counter and no fractional part.
|
||||||
#[inline]
|
|
||||||
pub fn new(counter: u32) -> Self {
|
pub fn new(counter: u32) -> Self {
|
||||||
// These values are definitely valid, so it is okay to unwrap here.
|
// These values are definitely valid, so it is okay to unwrap here.
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
@ -318,13 +308,11 @@ impl CucTime {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Like [CucTime::new] but allow to supply a fractional part as well.
|
/// Like [CucTime::new] but allow to supply a fractional part as well.
|
||||||
#[inline]
|
|
||||||
pub fn new_with_fractions(counter: u32, fractions: FractionalPart) -> Result<Self, CucError> {
|
pub fn new_with_fractions(counter: u32, fractions: FractionalPart) -> Result<Self, CucError> {
|
||||||
Self::new_generic(WidthCounterPair(4, counter), fractions)
|
Self::new_generic(WidthCounterPair(4, counter), fractions)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Fractions with a resolution of ~ 4 ms
|
/// Fractions with a resolution of ~ 4 ms
|
||||||
#[inline]
|
|
||||||
pub fn new_with_coarse_fractions(counter: u32, subsec_fractions: u8) -> Self {
|
pub fn new_with_coarse_fractions(counter: u32, subsec_fractions: u8) -> Self {
|
||||||
// These values are definitely valid, so it is okay to unwrap here.
|
// These values are definitely valid, so it is okay to unwrap here.
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
@ -338,7 +326,6 @@ impl CucTime {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Fractions with a resolution of ~ 16 us
|
/// Fractions with a resolution of ~ 16 us
|
||||||
#[inline]
|
|
||||||
pub fn new_with_medium_fractions(counter: u32, subsec_fractions: u16) -> Self {
|
pub fn new_with_medium_fractions(counter: u32, subsec_fractions: u16) -> Self {
|
||||||
// These values are definitely valid, so it is okay to unwrap here.
|
// These values are definitely valid, so it is okay to unwrap here.
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
@ -354,7 +341,6 @@ impl CucTime {
|
|||||||
/// Fractions with a resolution of ~ 60 ns. The fractional part value is limited by the
|
/// Fractions with a resolution of ~ 60 ns. The fractional part value is limited by the
|
||||||
/// 24 bits of the fractional field, so this function will fail with
|
/// 24 bits of the fractional field, so this function will fail with
|
||||||
/// [CucError::InvalidFractions] if the fractional value exceeds the value.
|
/// [CucError::InvalidFractions] if the fractional value exceeds the value.
|
||||||
#[inline]
|
|
||||||
pub fn new_with_fine_fractions(counter: u32, subsec_fractions: u32) -> Result<Self, CucError> {
|
pub fn new_with_fine_fractions(counter: u32, subsec_fractions: u32) -> Result<Self, CucError> {
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
WidthCounterPair(4, counter),
|
WidthCounterPair(4, counter),
|
||||||
@ -469,7 +455,6 @@ impl CucTime {
|
|||||||
|
|
||||||
/// Most generic constructor which allows full configurability for the counter and for the
|
/// Most generic constructor which allows full configurability for the counter and for the
|
||||||
/// fractions.
|
/// fractions.
|
||||||
#[inline]
|
|
||||||
pub fn new_generic(
|
pub fn new_generic(
|
||||||
width_and_counter: WidthCounterPair,
|
width_and_counter: WidthCounterPair,
|
||||||
fractions: FractionalPart,
|
fractions: FractionalPart,
|
||||||
@ -489,38 +474,31 @@ impl CucTime {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn ccsds_time_code(&self) -> CcsdsTimeCode {
|
pub fn ccsds_time_code(&self) -> CcsdsTimeCode {
|
||||||
CcsdsTimeCode::CucCcsdsEpoch
|
CcsdsTimeCode::CucCcsdsEpoch
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn width_counter_pair(&self) -> WidthCounterPair {
|
pub fn width_counter_pair(&self) -> WidthCounterPair {
|
||||||
self.counter
|
self.counter
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn counter_width(&self) -> u8 {
|
pub fn counter_width(&self) -> u8 {
|
||||||
self.counter.0
|
self.counter.0
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn counter(&self) -> u32 {
|
pub fn counter(&self) -> u32 {
|
||||||
self.counter.1
|
self.counter.1
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Subsecond fractional part of the CUC time.
|
/// Subsecond fractional part of the CUC time.
|
||||||
#[inline]
|
|
||||||
pub fn fractions(&self) -> FractionalPart {
|
pub fn fractions(&self) -> FractionalPart {
|
||||||
self.fractions
|
self.fractions
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn to_leap_sec_helper(&self, leap_seconds: u32) -> CucTimeWithLeapSecs {
|
pub fn to_leap_sec_helper(&self, leap_seconds: u32) -> CucTimeWithLeapSecs {
|
||||||
CucTimeWithLeapSecs::new(*self, leap_seconds)
|
CucTimeWithLeapSecs::new(*self, leap_seconds)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn set_fractions(&mut self, fractions: FractionalPart) -> Result<(), CucError> {
|
pub fn set_fractions(&mut self, fractions: FractionalPart) -> Result<(), CucError> {
|
||||||
Self::verify_fractions_value(fractions)?;
|
Self::verify_fractions_value(fractions)?;
|
||||||
self.fractions = fractions;
|
self.fractions = fractions;
|
||||||
@ -530,7 +508,6 @@ impl CucTime {
|
|||||||
|
|
||||||
/// Set a fractional resolution. Please note that this function will reset the fractional value
|
/// Set a fractional resolution. Please note that this function will reset the fractional value
|
||||||
/// to 0 if the resolution changes.
|
/// to 0 if the resolution changes.
|
||||||
#[inline]
|
|
||||||
pub fn set_fractional_resolution(&mut self, res: FractionalResolution) {
|
pub fn set_fractional_resolution(&mut self, res: FractionalResolution) {
|
||||||
if res == FractionalResolution::Seconds {
|
if res == FractionalResolution::Seconds {
|
||||||
self.fractions = FractionalPart::new_with_seconds_resolution();
|
self.fractions = FractionalPart::new_with_seconds_resolution();
|
||||||
@ -540,7 +517,6 @@ impl CucTime {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn build_p_field(counter_width: u8, resolution: FractionalResolution) -> u8 {
|
fn build_p_field(counter_width: u8, resolution: FractionalResolution) -> u8 {
|
||||||
let mut pfield = P_FIELD_BASE;
|
let mut pfield = P_FIELD_BASE;
|
||||||
if !(1..=4).contains(&counter_width) {
|
if !(1..=4).contains(&counter_width) {
|
||||||
@ -560,7 +536,6 @@ impl CucTime {
|
|||||||
pfield
|
pfield
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn update_p_field_fractions(&mut self) {
|
fn update_p_field_fractions(&mut self) {
|
||||||
self.pfield &= !(0b11);
|
self.pfield &= !(0b11);
|
||||||
self.pfield |= self.fractions.resolution() as u8;
|
self.pfield |= self.fractions.resolution() as u8;
|
||||||
@ -605,7 +580,6 @@ impl CucTime {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn len_packed_from_pfield(pfield: u8) -> usize {
|
pub fn len_packed_from_pfield(pfield: u8) -> usize {
|
||||||
let mut base_len: usize = 1;
|
let mut base_len: usize = 1;
|
||||||
base_len += Self::len_cntr_from_pfield(pfield) as usize;
|
base_len += Self::len_cntr_from_pfield(pfield) as usize;
|
||||||
@ -614,7 +588,6 @@ impl CucTime {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Verifies the raw width parameter.
|
/// Verifies the raw width parameter.
|
||||||
#[inline]
|
|
||||||
fn verify_counter_width(width: u8) -> Result<(), CucError> {
|
fn verify_counter_width(width: u8) -> Result<(), CucError> {
|
||||||
if width == 0 || width > 4 {
|
if width == 0 || width > 4 {
|
||||||
return Err(CucError::InvalidCounterWidth(width));
|
return Err(CucError::InvalidCounterWidth(width));
|
||||||
@ -622,7 +595,6 @@ impl CucTime {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn verify_fractions_value(val: FractionalPart) -> Result<(), CucError> {
|
fn verify_fractions_value(val: FractionalPart) -> Result<(), CucError> {
|
||||||
if val.counter > 2u32.pow((val.resolution as u32) * 8) - 1 {
|
if val.counter > 2u32.pow((val.resolution as u32) * 8) - 1 {
|
||||||
return Err(CucError::InvalidFractions {
|
return Err(CucError::InvalidFractions {
|
||||||
@ -633,12 +605,10 @@ impl CucTime {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn len_as_bytes(&self) -> usize {
|
fn len_as_bytes(&self) -> usize {
|
||||||
Self::len_packed_from_pfield(self.pfield)
|
Self::len_packed_from_pfield(self.pfield)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn subsec_nanos(&self) -> u32 {
|
fn subsec_nanos(&self) -> u32 {
|
||||||
if self.fractions.resolution() == FractionalResolution::Seconds {
|
if self.fractions.resolution() == FractionalResolution::Seconds {
|
||||||
return 0;
|
return 0;
|
||||||
@ -779,27 +749,22 @@ impl TimeWriter for CucTime {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl CcsdsTimeProvider for CucTimeWithLeapSecs {
|
impl CcsdsTimeProvider for CucTimeWithLeapSecs {
|
||||||
#[inline]
|
|
||||||
fn len_as_bytes(&self) -> usize {
|
fn len_as_bytes(&self) -> usize {
|
||||||
self.time.len_as_bytes()
|
self.time.len_as_bytes()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn p_field(&self) -> (usize, [u8; 2]) {
|
fn p_field(&self) -> (usize, [u8; 2]) {
|
||||||
(1, [self.time.pfield, 0])
|
(1, [self.time.pfield, 0])
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn ccdsd_time_code(&self) -> CcsdsTimeCode {
|
fn ccdsd_time_code(&self) -> CcsdsTimeCode {
|
||||||
self.time.ccsds_time_code()
|
self.time.ccsds_time_code()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn unix_secs(&self) -> i64 {
|
fn unix_secs(&self) -> i64 {
|
||||||
self.time.unix_secs(self.leap_seconds)
|
self.time.unix_secs(self.leap_seconds)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn subsec_nanos(&self) -> u32 {
|
fn subsec_nanos(&self) -> u32 {
|
||||||
self.time.subsec_nanos()
|
self.time.subsec_nanos()
|
||||||
}
|
}
|
||||||
@ -946,7 +911,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_datetime_now() {
|
fn test_datetime_now() {
|
||||||
let now = chrono::Utc::now();
|
let now = chrono::Utc::now();
|
||||||
let cuc_now = CucTime::now(FractionalResolution::SixtyNs, LEAP_SECONDS);
|
let cuc_now = CucTime::now(FractionalResolution::SixtyNs, LEAP_SECONDS);
|
||||||
@ -1278,7 +1242,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn set_fract_resolution() {
|
fn set_fract_resolution() {
|
||||||
let mut stamp = CucTime::new(2000);
|
let mut stamp = CucTime::new(2000);
|
||||||
stamp.set_fractional_resolution(FractionalResolution::SixtyNs);
|
stamp.set_fractional_resolution(FractionalResolution::SixtyNs);
|
||||||
|
@ -6,6 +6,7 @@ use core::cmp::Ordering;
|
|||||||
use core::fmt::{Display, Formatter};
|
use core::fmt::{Display, Formatter};
|
||||||
use core::ops::{Add, AddAssign, Sub};
|
use core::ops::{Add, AddAssign, Sub};
|
||||||
use core::time::Duration;
|
use core::time::Duration;
|
||||||
|
use core::u8;
|
||||||
|
|
||||||
#[allow(unused_imports)]
|
#[allow(unused_imports)]
|
||||||
#[cfg(not(feature = "std"))]
|
#[cfg(not(feature = "std"))]
|
||||||
@ -32,7 +33,6 @@ pub const NANOS_PER_SECOND: u32 = 1_000_000_000;
|
|||||||
|
|
||||||
#[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))]
|
|
||||||
pub enum CcsdsTimeCode {
|
pub enum CcsdsTimeCode {
|
||||||
CucCcsdsEpoch = 0b001,
|
CucCcsdsEpoch = 0b001,
|
||||||
CucAgencyEpoch = 0b010,
|
CucAgencyEpoch = 0b010,
|
||||||
@ -63,15 +63,21 @@ 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, thiserror::Error)]
|
#[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))]
|
|
||||||
#[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))]
|
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
pub enum TimestampError {
|
pub enum TimestampError {
|
||||||
InvalidTimeCode { expected: CcsdsTimeCode, found: u8 },
|
InvalidTimeCode { expected: CcsdsTimeCode, found: u8 },
|
||||||
@ -157,7 +163,6 @@ pub fn seconds_since_epoch() -> f64 {
|
|||||||
///
|
///
|
||||||
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
||||||
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
||||||
#[inline]
|
|
||||||
pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
||||||
unix_days - DAYS_CCSDS_TO_UNIX as i64
|
unix_days - DAYS_CCSDS_TO_UNIX as i64
|
||||||
}
|
}
|
||||||
@ -166,19 +171,16 @@ pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
|||||||
///
|
///
|
||||||
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
||||||
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
||||||
#[inline]
|
|
||||||
pub const fn ccsds_to_unix_days(ccsds_days: i64) -> i64 {
|
pub const fn ccsds_to_unix_days(ccsds_days: i64) -> i64 {
|
||||||
ccsds_days + DAYS_CCSDS_TO_UNIX as i64
|
ccsds_days + DAYS_CCSDS_TO_UNIX as i64
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Similar to [unix_to_ccsds_days] but converts the epoch instead, which is the number of elpased
|
/// Similar to [unix_to_ccsds_days] but converts the epoch instead, which is the number of elpased
|
||||||
/// seconds since the CCSDS and UNIX epoch times.
|
/// seconds since the CCSDS and UNIX epoch times.
|
||||||
#[inline]
|
|
||||||
pub const fn unix_epoch_to_ccsds_epoch(unix_epoch: i64) -> i64 {
|
pub const fn unix_epoch_to_ccsds_epoch(unix_epoch: i64) -> i64 {
|
||||||
unix_epoch - (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
unix_epoch - (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub const fn ccsds_epoch_to_unix_epoch(ccsds_epoch: i64) -> i64 {
|
pub const fn ccsds_epoch_to_unix_epoch(ccsds_epoch: i64) -> i64 {
|
||||||
ccsds_epoch + (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
ccsds_epoch + (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
||||||
}
|
}
|
||||||
@ -260,7 +262,6 @@ pub trait CcsdsTimeProvider {
|
|||||||
/// similarly to other common time formats and libraries.
|
/// similarly to other common time formats and libraries.
|
||||||
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Default, 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))]
|
|
||||||
pub struct UnixTime {
|
pub struct UnixTime {
|
||||||
secs: i64,
|
secs: i64,
|
||||||
subsec_nanos: u32,
|
subsec_nanos: u32,
|
||||||
@ -542,7 +543,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_get_current_time() {
|
fn test_get_current_time() {
|
||||||
let sec_floats = seconds_since_epoch();
|
let sec_floats = seconds_since_epoch();
|
||||||
assert!(sec_floats > 0.0);
|
assert!(sec_floats > 0.0);
|
||||||
@ -557,7 +557,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_ccsds_epoch() {
|
fn test_ccsds_epoch() {
|
||||||
let now = SystemTime::now()
|
let now = SystemTime::now()
|
||||||
.duration_since(SystemTime::UNIX_EPOCH)
|
.duration_since(SystemTime::UNIX_EPOCH)
|
||||||
@ -678,7 +677,6 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg_attr(miri, ignore)]
|
|
||||||
fn test_from_now() {
|
fn test_from_now() {
|
||||||
let stamp_now = UnixTime::now().unwrap();
|
let stamp_now = UnixTime::now().unwrap();
|
||||||
let dt_now = stamp_now.chrono_date_time().unwrap();
|
let dt_now = stamp_now.chrono_date_time().unwrap();
|
||||||
|
685
src/uslp/mod.rs
685
src/uslp/mod.rs
@ -1,685 +0,0 @@
|
|||||||
/// # Support of the CCSDS Unified Space Data Link Protocol (USLP)
|
|
||||||
use crate::{ByteConversionError, crc::CRC_CCITT_FALSE};
|
|
||||||
|
|
||||||
/// Only this version is supported by the library
|
|
||||||
pub const USLP_VERSION_NUMBER: u8 = 0b1100;
|
|
||||||
|
|
||||||
/// Identifies the association of the data contained in the transfer frame.
|
|
||||||
#[derive(
|
|
||||||
Debug, Copy, Clone, PartialEq, Eq, num_enum::TryFromPrimitive, num_enum::IntoPrimitive,
|
|
||||||
)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
|
||||||
pub enum SourceOrDestField {
|
|
||||||
/// SCID refers to the source of the transfer frame.
|
|
||||||
Source = 0,
|
|
||||||
/// SCID refers to the destination of the transfer frame.
|
|
||||||
Dest = 1,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(
|
|
||||||
Debug, Copy, Clone, PartialEq, Eq, num_enum::TryFromPrimitive, num_enum::IntoPrimitive,
|
|
||||||
)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
|
||||||
pub enum BypassSequenceControlFlag {
|
|
||||||
/// Acceptance of this frame on the receiving end is subject to normal frame acceptance
|
|
||||||
/// checks of FARM.
|
|
||||||
SequenceControlledQoS = 0,
|
|
||||||
/// Frame Acceptance Checks of FARM by the receiving end shall be bypassed.
|
|
||||||
ExpeditedQoS = 1,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(
|
|
||||||
Debug, Copy, Clone, PartialEq, Eq, num_enum::TryFromPrimitive, num_enum::IntoPrimitive,
|
|
||||||
)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
|
||||||
pub enum ProtocolControlCommandFlag {
|
|
||||||
TfdfContainsUserData = 0,
|
|
||||||
TfdfContainsProtocolInfo = 1,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
||||||
pub enum UslpError {
|
|
||||||
ByteConversion(ByteConversionError),
|
|
||||||
HeaderIsTruncated,
|
|
||||||
InvalidProtocolId(u8),
|
|
||||||
InvalidConstructionRule(u8),
|
|
||||||
InvalidVersionNumber(u8),
|
|
||||||
InvalidVcid(u8),
|
|
||||||
InvalidMapId(u8),
|
|
||||||
ChecksumFailure(u16),
|
|
||||||
}
|
|
||||||
|
|
||||||
impl From<ByteConversionError> for UslpError {
|
|
||||||
fn from(value: ByteConversionError) -> Self {
|
|
||||||
Self::ByteConversion(value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct InvalidValueForLen {
|
|
||||||
value: u64,
|
|
||||||
len: u8,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, Eq)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct PrimaryHeader {
|
|
||||||
pub spacecraft_id: u16,
|
|
||||||
pub source_or_dest_field: SourceOrDestField,
|
|
||||||
pub vc_id: u8,
|
|
||||||
pub map_id: u8,
|
|
||||||
frame_len_field: u16,
|
|
||||||
pub sequence_control_flag: BypassSequenceControlFlag,
|
|
||||||
pub protocol_control_command_flag: ProtocolControlCommandFlag,
|
|
||||||
pub ocf_flag: bool,
|
|
||||||
vc_frame_count_len: u8,
|
|
||||||
vc_frame_count: u64,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PrimaryHeader {
|
|
||||||
pub fn new(
|
|
||||||
spacecraft_id: u16,
|
|
||||||
source_or_dest_field: SourceOrDestField,
|
|
||||||
vc_id: u8,
|
|
||||||
map_id: u8,
|
|
||||||
frame_len: u16,
|
|
||||||
) -> Result<Self, UslpError> {
|
|
||||||
if vc_id > 0b111111 {
|
|
||||||
return Err(UslpError::InvalidVcid(vc_id));
|
|
||||||
}
|
|
||||||
if map_id > 0b1111 {
|
|
||||||
return Err(UslpError::InvalidMapId(map_id));
|
|
||||||
}
|
|
||||||
Ok(Self {
|
|
||||||
spacecraft_id,
|
|
||||||
source_or_dest_field,
|
|
||||||
vc_id,
|
|
||||||
map_id,
|
|
||||||
frame_len_field: frame_len.saturating_sub(1),
|
|
||||||
sequence_control_flag: BypassSequenceControlFlag::SequenceControlledQoS,
|
|
||||||
protocol_control_command_flag: ProtocolControlCommandFlag::TfdfContainsUserData,
|
|
||||||
ocf_flag: false,
|
|
||||||
vc_frame_count_len: 0,
|
|
||||||
vc_frame_count: 0,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_vc_frame_count(
|
|
||||||
&mut self,
|
|
||||||
count_len: u8,
|
|
||||||
count: u64,
|
|
||||||
) -> Result<(), InvalidValueForLen> {
|
|
||||||
if count > 2_u64.pow(count_len as u32 * 8) - 1 {
|
|
||||||
return Err(InvalidValueForLen {
|
|
||||||
value: count,
|
|
||||||
len: count_len,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
self.vc_frame_count_len = count_len;
|
|
||||||
self.vc_frame_count = count;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline(always)]
|
|
||||||
pub fn vc_frame_count(&self) -> u64 {
|
|
||||||
self.vc_frame_count
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline(always)]
|
|
||||||
pub fn vc_frame_count_len(&self) -> u8 {
|
|
||||||
self.vc_frame_count_len
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn from_bytes(buf: &[u8]) -> Result<Self, UslpError> {
|
|
||||||
if buf.len() < 4 {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: 4,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
// Can only deal with regular frames for now.
|
|
||||||
if (buf[3] & 0b1) == 1 {
|
|
||||||
return Err(UslpError::HeaderIsTruncated);
|
|
||||||
}
|
|
||||||
// We could check this above, but this is a better error for the case where the user
|
|
||||||
// tries to read a truncated frame.
|
|
||||||
if buf.len() < 7 {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: 7,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let version_number = (buf[0] >> 4) & 0b1111;
|
|
||||||
if version_number != USLP_VERSION_NUMBER {
|
|
||||||
return Err(UslpError::InvalidVersionNumber(version_number));
|
|
||||||
}
|
|
||||||
let source_or_dest_field = match (buf[2] >> 3) & 1 {
|
|
||||||
0 => SourceOrDestField::Source,
|
|
||||||
1 => SourceOrDestField::Dest,
|
|
||||||
_ => unreachable!(),
|
|
||||||
};
|
|
||||||
let vc_frame_count_len = buf[6] & 0b111;
|
|
||||||
if buf.len() < 7 + vc_frame_count_len as usize {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: 7 + vc_frame_count_len as usize,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let vc_frame_count = match vc_frame_count_len {
|
|
||||||
1 => buf[7] as u64,
|
|
||||||
2 => u16::from_be_bytes(buf[7..9].try_into().unwrap()) as u64,
|
|
||||||
4 => u32::from_be_bytes(buf[7..11].try_into().unwrap()) as u64,
|
|
||||||
len => {
|
|
||||||
let mut vcf_count = 0u64;
|
|
||||||
let mut end = len;
|
|
||||||
for byte in buf[7..7 + len as usize].iter() {
|
|
||||||
vcf_count |= (*byte as u64) << ((end - 1) * 8);
|
|
||||||
end -= 1;
|
|
||||||
}
|
|
||||||
vcf_count
|
|
||||||
}
|
|
||||||
};
|
|
||||||
Ok(Self {
|
|
||||||
spacecraft_id: (((buf[0] as u16) & 0b1111) << 12)
|
|
||||||
| ((buf[1] as u16) << 4)
|
|
||||||
| ((buf[2] as u16) >> 4) & 0b1111,
|
|
||||||
source_or_dest_field,
|
|
||||||
vc_id: ((buf[2] & 0b111) << 3) | (buf[3] >> 5) & 0b111,
|
|
||||||
map_id: (buf[3] >> 1) & 0b1111,
|
|
||||||
frame_len_field: ((buf[4] as u16) << 8) | buf[5] as u16,
|
|
||||||
sequence_control_flag: ((buf[6] >> 7) & 0b1).try_into().unwrap(),
|
|
||||||
protocol_control_command_flag: ((buf[6] >> 6) & 0b1).try_into().unwrap(),
|
|
||||||
ocf_flag: ((buf[6] >> 3) & 0b1) != 0,
|
|
||||||
vc_frame_count_len,
|
|
||||||
vc_frame_count,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
|
||||||
if buf.len() < self.len_header() {
|
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: self.len_header(),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
buf[0] = (USLP_VERSION_NUMBER << 4) | ((self.spacecraft_id >> 12) as u8) & 0b1111;
|
|
||||||
buf[1] = (self.spacecraft_id >> 4) as u8;
|
|
||||||
buf[2] = (((self.spacecraft_id & 0b1111) as u8) << 4)
|
|
||||||
| ((self.source_or_dest_field as u8) << 3)
|
|
||||||
| (self.vc_id >> 3) & 0b111;
|
|
||||||
buf[3] = ((self.vc_id & 0b111) << 5) | (self.map_id << 1);
|
|
||||||
buf[4..6].copy_from_slice(&self.frame_len_field.to_be_bytes());
|
|
||||||
buf[6] = ((self.sequence_control_flag as u8) << 7)
|
|
||||||
| ((self.protocol_control_command_flag as u8) << 6)
|
|
||||||
| ((self.ocf_flag as u8) << 3)
|
|
||||||
| self.vc_frame_count_len;
|
|
||||||
let mut packet_idx = 7;
|
|
||||||
for idx in (0..self.vc_frame_count_len).rev() {
|
|
||||||
buf[packet_idx] = ((self.vc_frame_count >> (idx * 8)) & 0xff) as u8;
|
|
||||||
packet_idx += 1;
|
|
||||||
}
|
|
||||||
Ok(self.len_header())
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline(always)]
|
|
||||||
pub fn set_frame_len(&mut self, frame_len: usize) {
|
|
||||||
// 4.1.2.7.2
|
|
||||||
// The field contains a length count C that equals one fewer than the total octets
|
|
||||||
// in the transfer frame.
|
|
||||||
self.frame_len_field = frame_len.saturating_sub(1) as u16;
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline(always)]
|
|
||||||
pub fn len_header(&self) -> usize {
|
|
||||||
7 + self.vc_frame_count_len as usize
|
|
||||||
}
|
|
||||||
|
|
||||||
#[inline(always)]
|
|
||||||
pub fn len_frame(&self) -> usize {
|
|
||||||
// 4.1.2.7.2
|
|
||||||
// The field contains a length count C that equals one fewer than the total octets
|
|
||||||
// in the transfer frame.
|
|
||||||
self.frame_len_field as usize + 1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Custom implementation which skips the check whether the VC frame count length field is equal.
|
|
||||||
/// Only the actual VC count value is compared.
|
|
||||||
impl PartialEq for PrimaryHeader {
|
|
||||||
fn eq(&self, other: &Self) -> bool {
|
|
||||||
self.spacecraft_id == other.spacecraft_id
|
|
||||||
&& self.source_or_dest_field == other.source_or_dest_field
|
|
||||||
&& self.vc_id == other.vc_id
|
|
||||||
&& self.map_id == other.map_id
|
|
||||||
&& self.frame_len_field == other.frame_len_field
|
|
||||||
&& self.sequence_control_flag == other.sequence_control_flag
|
|
||||||
&& self.protocol_control_command_flag == other.protocol_control_command_flag
|
|
||||||
&& self.ocf_flag == other.ocf_flag
|
|
||||||
&& self.vc_frame_count == other.vc_frame_count
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(
|
|
||||||
Debug, Copy, Clone, PartialEq, Eq, num_enum::TryFromPrimitive, num_enum::IntoPrimitive,
|
|
||||||
)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
|
||||||
#[non_exhaustive]
|
|
||||||
pub enum UslpProtocolId {
|
|
||||||
SpacePacketsOrEncapsulation = 0b00000,
|
|
||||||
/// COP-1 control commands within the TFDZ.
|
|
||||||
Cop1ControlCommands = 0b00001,
|
|
||||||
/// COP-P control commands within the TFDZ.
|
|
||||||
CopPControlCommands = 0b00010,
|
|
||||||
/// SDLS control commands within the TFDZ.
|
|
||||||
Sdls = 0b00011,
|
|
||||||
UserDefinedOctetStream = 0b00100,
|
|
||||||
/// Proximity-1 Supervisory Protocol Data Units (SPDUs) within the TFDZ.
|
|
||||||
Spdu = 0b00111,
|
|
||||||
/// Entire fixed-length TFDZ contains idle data.
|
|
||||||
Idle = 0b11111,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(
|
|
||||||
Debug, Copy, Clone, PartialEq, Eq, num_enum::TryFromPrimitive, num_enum::IntoPrimitive,
|
|
||||||
)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
#[repr(u8)]
|
|
||||||
pub enum ConstructionRule {
|
|
||||||
/// Indicated fixed-length TFDZ whose contents are CCSDS packets concatenated together, which
|
|
||||||
/// span transfer frame boundaries. The First Header Pointer (FHP) is required for packet
|
|
||||||
/// extraction.
|
|
||||||
PacketSpanningMultipleFrames = 0b000,
|
|
||||||
StartOfMapaSduOrVcaSdu = 0b001,
|
|
||||||
ContinuingPortionOfMapaSdu = 0b010,
|
|
||||||
OctetStream = 0b011,
|
|
||||||
StartingSegment = 0b100,
|
|
||||||
ContinuingSegment = 0b101,
|
|
||||||
LastSegment = 0b110,
|
|
||||||
NoSegmentation = 0b111,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ConstructionRule {
|
|
||||||
pub const fn applicable_to_fixed_len_tfdz(&self) -> bool {
|
|
||||||
match self {
|
|
||||||
ConstructionRule::PacketSpanningMultipleFrames => true,
|
|
||||||
ConstructionRule::StartOfMapaSduOrVcaSdu => true,
|
|
||||||
ConstructionRule::ContinuingPortionOfMapaSdu => true,
|
|
||||||
ConstructionRule::OctetStream => false,
|
|
||||||
ConstructionRule::StartingSegment => false,
|
|
||||||
ConstructionRule::ContinuingSegment => false,
|
|
||||||
ConstructionRule::LastSegment => false,
|
|
||||||
ConstructionRule::NoSegmentation => false,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct TransferFrameDataFieldHeader {
|
|
||||||
/// Construction rule for the TFDZ.
|
|
||||||
construction_rule: ConstructionRule,
|
|
||||||
uslp_protocol_id: UslpProtocolId,
|
|
||||||
/// First header or last valid octet pointer. Only present if the constuction rule indicated
|
|
||||||
/// a fixed-length TFDZ.
|
|
||||||
fhp_or_lvo: Option<u16>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TransferFrameDataFieldHeader {
|
|
||||||
pub fn len_header(&self) -> usize {
|
|
||||||
if self.construction_rule.applicable_to_fixed_len_tfdz() {
|
|
||||||
3
|
|
||||||
} else {
|
|
||||||
1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn construction_rule(&self) -> ConstructionRule {
|
|
||||||
self.construction_rule
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn uslp_protocol_id(&self) -> UslpProtocolId {
|
|
||||||
self.uslp_protocol_id
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn fhp_or_lvo(&self) -> Option<u16> {
|
|
||||||
self.fhp_or_lvo
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn from_bytes(buf: &[u8]) -> Result<Self, UslpError> {
|
|
||||||
if buf.is_empty() {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: 0,
|
|
||||||
expected: 1,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let construction_rule = ConstructionRule::try_from((buf[0] >> 5) & 0b111)
|
|
||||||
.map_err(|e| UslpError::InvalidConstructionRule(e.number))?;
|
|
||||||
let mut fhp_or_lvo = None;
|
|
||||||
if construction_rule.applicable_to_fixed_len_tfdz() {
|
|
||||||
if buf.len() < 3 {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: buf.len(),
|
|
||||||
expected: 3,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
fhp_or_lvo = Some(u16::from_be_bytes(buf[1..3].try_into().unwrap()));
|
|
||||||
}
|
|
||||||
Ok(Self {
|
|
||||||
construction_rule,
|
|
||||||
uslp_protocol_id: UslpProtocolId::try_from(buf[0] & 0b11111)
|
|
||||||
.map_err(|e| UslpError::InvalidProtocolId(e.number))?,
|
|
||||||
fhp_or_lvo,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Simple USLP transfer frame reader.
|
|
||||||
///
|
|
||||||
/// Currently, only insert zone lengths of 0 are supported.
|
|
||||||
pub struct TransferFrameReader<'buf> {
|
|
||||||
primary_header: PrimaryHeader,
|
|
||||||
data_field_header: TransferFrameDataFieldHeader,
|
|
||||||
data: &'buf [u8],
|
|
||||||
operational_control_field: Option<u32>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'buf> TransferFrameReader<'buf> {
|
|
||||||
/// This function assumes an insert zone length of 0.
|
|
||||||
pub fn from_bytes(
|
|
||||||
buf: &'buf [u8],
|
|
||||||
has_fecf: bool,
|
|
||||||
) -> Result<TransferFrameReader<'buf>, UslpError> {
|
|
||||||
let primary_header = PrimaryHeader::from_bytes(buf)?;
|
|
||||||
if primary_header.len_frame() > buf.len() {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
expected: primary_header.len_frame(),
|
|
||||||
found: buf.len(),
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let data_field_header =
|
|
||||||
TransferFrameDataFieldHeader::from_bytes(&buf[primary_header.len_header()..])?;
|
|
||||||
let data_idx = primary_header.len_header() + data_field_header.len_header();
|
|
||||||
let frame_len = primary_header.len_frame();
|
|
||||||
let mut operational_control_field = None;
|
|
||||||
let mut data_len = frame_len - data_idx;
|
|
||||||
if has_fecf {
|
|
||||||
data_len -= 2;
|
|
||||||
}
|
|
||||||
if primary_header.ocf_flag {
|
|
||||||
data_len -= 4;
|
|
||||||
operational_control_field = Some(u32::from_be_bytes(
|
|
||||||
buf[data_idx + data_len..data_idx + data_len + 4]
|
|
||||||
.try_into()
|
|
||||||
.unwrap(),
|
|
||||||
));
|
|
||||||
}
|
|
||||||
let data_end = data_idx + data_len;
|
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
|
||||||
digest.update(&buf[0..frame_len]);
|
|
||||||
if digest.finalize() != 0 {
|
|
||||||
return Err(UslpError::ChecksumFailure(u16::from_be_bytes(
|
|
||||||
buf[frame_len - 2..frame_len].try_into().unwrap(),
|
|
||||||
)));
|
|
||||||
}
|
|
||||||
Ok(Self {
|
|
||||||
primary_header,
|
|
||||||
data_field_header,
|
|
||||||
data: buf[data_idx..data_end].try_into().unwrap(),
|
|
||||||
operational_control_field,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn len_frame(&self) -> usize {
|
|
||||||
self.primary_header.len_frame()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn primary_header(&self) -> &PrimaryHeader {
|
|
||||||
&self.primary_header
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn data_field_header(&self) -> &TransferFrameDataFieldHeader {
|
|
||||||
&self.data_field_header
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn data(&self) -> &'buf [u8] {
|
|
||||||
self.data
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn operational_control_field(&self) -> &Option<u32> {
|
|
||||||
&self.operational_control_field
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use std::println;
|
|
||||||
|
|
||||||
use super::*;
|
|
||||||
|
|
||||||
fn common_basic_check(buf: &[u8]) {
|
|
||||||
assert_eq!(buf[0] >> 4, USLP_VERSION_NUMBER);
|
|
||||||
// First four bits SCID.
|
|
||||||
assert_eq!(buf[0] & 0b1111, 0b1010);
|
|
||||||
// Next eight bits SCID.
|
|
||||||
assert_eq!(buf[1], 0b01011100);
|
|
||||||
// Last four bits SCID.
|
|
||||||
assert_eq!(buf[2] >> 4, 0b0011);
|
|
||||||
assert_eq!((buf[2] >> 3) & 0b1, SourceOrDestField::Dest as u8);
|
|
||||||
// First three bits VCID.
|
|
||||||
assert_eq!(buf[2] & 0b111, 0b110);
|
|
||||||
// Last three bits VCID.
|
|
||||||
assert_eq!(buf[3] >> 5, 0b101);
|
|
||||||
// MAP ID
|
|
||||||
assert_eq!((buf[3] >> 1) & 0b1111, 0b1010);
|
|
||||||
// End of primary header flag
|
|
||||||
assert_eq!(buf[3] & 0b1, 0);
|
|
||||||
assert_eq!(u16::from_be_bytes(buf[4..6].try_into().unwrap()), 0x2345);
|
|
||||||
}
|
|
||||||
#[test]
|
|
||||||
fn test_basic_0() {
|
|
||||||
let mut buf: [u8; 8] = [0; 8];
|
|
||||||
// Should be all zeros after writing.
|
|
||||||
buf[6] = 0xff;
|
|
||||||
let primary_header = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b110101,
|
|
||||||
0b1010,
|
|
||||||
0x2345,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
// Virtual channel count 0.
|
|
||||||
assert_eq!(primary_header.write_to_be_bytes(&mut buf).unwrap(), 7);
|
|
||||||
common_basic_check(&buf);
|
|
||||||
// Bypass / Sequence Control Flag.
|
|
||||||
assert_eq!(
|
|
||||||
(buf[6] >> 7) & 0b1,
|
|
||||||
BypassSequenceControlFlag::SequenceControlledQoS as u8
|
|
||||||
);
|
|
||||||
// Protocol Control Command Flag.
|
|
||||||
assert_eq!(
|
|
||||||
(buf[6] >> 6) & 0b1,
|
|
||||||
ProtocolControlCommandFlag::TfdfContainsUserData as u8
|
|
||||||
);
|
|
||||||
// OCF flag.
|
|
||||||
assert_eq!((buf[6] >> 3) & 0b1, false as u8);
|
|
||||||
// VCF count length.
|
|
||||||
assert_eq!(buf[6] & 0b111, 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_basic_1() {
|
|
||||||
let mut buf: [u8; 16] = [0; 16];
|
|
||||||
// Should be all zeros after writing.
|
|
||||||
buf[6] = 0xff;
|
|
||||||
let mut primary_header = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b110101,
|
|
||||||
0b1010,
|
|
||||||
0x2345,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
primary_header.sequence_control_flag = BypassSequenceControlFlag::ExpeditedQoS;
|
|
||||||
primary_header.protocol_control_command_flag =
|
|
||||||
ProtocolControlCommandFlag::TfdfContainsProtocolInfo;
|
|
||||||
primary_header.ocf_flag = true;
|
|
||||||
primary_header.set_vc_frame_count(4, 0x12345678).unwrap();
|
|
||||||
// Virtual channel count 4.
|
|
||||||
assert_eq!(primary_header.write_to_be_bytes(&mut buf).unwrap(), 11);
|
|
||||||
common_basic_check(&buf);
|
|
||||||
// Bypass / Sequence Control Flag.
|
|
||||||
assert_eq!(
|
|
||||||
(buf[6] >> 7) & 0b1,
|
|
||||||
BypassSequenceControlFlag::ExpeditedQoS as u8
|
|
||||||
);
|
|
||||||
// Protocol Control Command Flag.
|
|
||||||
assert_eq!(
|
|
||||||
(buf[6] >> 6) & 0b1,
|
|
||||||
ProtocolControlCommandFlag::TfdfContainsProtocolInfo as u8
|
|
||||||
);
|
|
||||||
// OCF flag.
|
|
||||||
assert_eq!((buf[6] >> 3) & 0b1, true as u8);
|
|
||||||
// VCF count length.
|
|
||||||
assert_eq!(buf[6] & 0b111, 4);
|
|
||||||
assert_eq!(
|
|
||||||
u32::from_be_bytes(buf[7..11].try_into().unwrap()),
|
|
||||||
0x12345678
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_reading_0() {
|
|
||||||
let mut buf: [u8; 8] = [0; 8];
|
|
||||||
let primary_header = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b110101,
|
|
||||||
0b1010,
|
|
||||||
0x2345,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(primary_header.write_to_be_bytes(&mut buf).unwrap(), 7);
|
|
||||||
let parsed_header = PrimaryHeader::from_bytes(&buf).unwrap();
|
|
||||||
assert_eq!(parsed_header, primary_header);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_reading_1() {
|
|
||||||
let mut buf: [u8; 16] = [0; 16];
|
|
||||||
let mut primary_header = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b110101,
|
|
||||||
0b1010,
|
|
||||||
0x2345,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
primary_header.sequence_control_flag = BypassSequenceControlFlag::ExpeditedQoS;
|
|
||||||
primary_header.protocol_control_command_flag =
|
|
||||||
ProtocolControlCommandFlag::TfdfContainsProtocolInfo;
|
|
||||||
primary_header.ocf_flag = true;
|
|
||||||
primary_header.set_vc_frame_count(4, 0x12345678).unwrap();
|
|
||||||
assert_eq!(primary_header.write_to_be_bytes(&mut buf).unwrap(), 11);
|
|
||||||
let parsed_header = PrimaryHeader::from_bytes(&buf).unwrap();
|
|
||||||
assert_eq!(parsed_header, primary_header);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_invalid_vcid() {
|
|
||||||
let error = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b1101011,
|
|
||||||
0b1010,
|
|
||||||
0x2345,
|
|
||||||
);
|
|
||||||
assert!(error.is_err());
|
|
||||||
let error = error.unwrap_err();
|
|
||||||
matches!(error, UslpError::InvalidVcid(0b1101011));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_invalid_mapid() {
|
|
||||||
let error = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b110101,
|
|
||||||
0b10101,
|
|
||||||
0x2345,
|
|
||||||
);
|
|
||||||
assert!(error.is_err());
|
|
||||||
let error = error.unwrap_err();
|
|
||||||
matches!(error, UslpError::InvalidMapId(0b10101));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_invalid_vc_count() {
|
|
||||||
let mut primary_header = PrimaryHeader::new(
|
|
||||||
0b10100101_11000011,
|
|
||||||
SourceOrDestField::Dest,
|
|
||||||
0b110101,
|
|
||||||
0b1010,
|
|
||||||
0x2345,
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
matches!(
|
|
||||||
primary_header.set_vc_frame_count(0, 1).unwrap_err(),
|
|
||||||
InvalidValueForLen { value: 1, len: 0 }
|
|
||||||
);
|
|
||||||
matches!(
|
|
||||||
primary_header.set_vc_frame_count(1, 256).unwrap_err(),
|
|
||||||
InvalidValueForLen { value: 256, len: 1 }
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn test_frame_parser() {
|
|
||||||
let mut buf: [u8; 32] = [0; 32];
|
|
||||||
// Build a variable frame manually.
|
|
||||||
let mut primary_header =
|
|
||||||
PrimaryHeader::new(0x01, SourceOrDestField::Dest, 0b110101, 0b1010, 0).unwrap();
|
|
||||||
let header_len = primary_header.len_header();
|
|
||||||
buf[header_len] = ((ConstructionRule::NoSegmentation as u8) << 5)
|
|
||||||
| (UslpProtocolId::UserDefinedOctetStream as u8) & 0b11111;
|
|
||||||
buf[header_len + 1] = 0x42;
|
|
||||||
// 1 byte TFDH, 1 byte data, 2 bytes CRC.
|
|
||||||
primary_header.set_frame_len(header_len + 4);
|
|
||||||
primary_header.write_to_be_bytes(&mut buf).unwrap();
|
|
||||||
// Calculate and write CRC16.
|
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
|
||||||
digest.update(&buf[0..header_len + 2]);
|
|
||||||
buf[header_len + 2..header_len + 4].copy_from_slice(&digest.finalize().to_be_bytes());
|
|
||||||
println!("Buffer: {:x?}", buf);
|
|
||||||
// Now parse the frame.
|
|
||||||
let frame = TransferFrameReader::from_bytes(&buf, true).unwrap();
|
|
||||||
assert_eq!(frame.data().len(), 1);
|
|
||||||
assert_eq!(frame.data()[0], 0x42);
|
|
||||||
assert_eq!(
|
|
||||||
frame.data_field_header().uslp_protocol_id,
|
|
||||||
UslpProtocolId::UserDefinedOctetStream
|
|
||||||
);
|
|
||||||
assert_eq!(
|
|
||||||
frame.data_field_header().construction_rule,
|
|
||||||
ConstructionRule::NoSegmentation
|
|
||||||
);
|
|
||||||
assert!(frame.data_field_header().fhp_or_lvo().is_none());
|
|
||||||
assert_eq!(frame.len_frame(), 11);
|
|
||||||
}
|
|
||||||
}
|
|
31
src/util.rs
31
src/util.rs
@ -15,12 +15,10 @@ pub trait ToBeBytes {
|
|||||||
impl ToBeBytes for () {
|
impl ToBeBytes for () {
|
||||||
type ByteArray = [u8; 0];
|
type ByteArray = [u8; 0];
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
0
|
0
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
[]
|
[]
|
||||||
}
|
}
|
||||||
@ -29,12 +27,9 @@ impl ToBeBytes for () {
|
|||||||
impl ToBeBytes for u8 {
|
impl ToBeBytes for u8 {
|
||||||
type ByteArray = [u8; 1];
|
type ByteArray = [u8; 1];
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
1
|
1
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u8::to_be_bytes(*self)
|
u8::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
@ -43,12 +38,9 @@ impl ToBeBytes for u8 {
|
|||||||
impl ToBeBytes for u16 {
|
impl ToBeBytes for u16 {
|
||||||
type ByteArray = [u8; 2];
|
type ByteArray = [u8; 2];
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
2
|
2
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u16::to_be_bytes(*self)
|
u16::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
@ -57,12 +49,9 @@ impl ToBeBytes for u16 {
|
|||||||
impl ToBeBytes for u32 {
|
impl ToBeBytes for u32 {
|
||||||
type ByteArray = [u8; 4];
|
type ByteArray = [u8; 4];
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
4
|
4
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u32::to_be_bytes(*self)
|
u32::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
@ -71,12 +60,9 @@ impl ToBeBytes for u32 {
|
|||||||
impl ToBeBytes for u64 {
|
impl ToBeBytes for u64 {
|
||||||
type ByteArray = [u8; 8];
|
type ByteArray = [u8; 8];
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
8
|
8
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u64::to_be_bytes(*self)
|
u64::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
@ -118,7 +104,6 @@ pub enum UnsignedByteFieldError {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl From<ByteConversionError> for UnsignedByteFieldError {
|
impl From<ByteConversionError> for UnsignedByteFieldError {
|
||||||
#[inline]
|
|
||||||
fn from(value: ByteConversionError) -> Self {
|
fn from(value: ByteConversionError) -> Self {
|
||||||
Self::ByteConversionError(value)
|
Self::ByteConversionError(value)
|
||||||
}
|
}
|
||||||
@ -146,24 +131,20 @@ impl Error for UnsignedByteFieldError {}
|
|||||||
/// Type erased variant.
|
/// Type erased variant.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[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))]
|
|
||||||
pub struct UnsignedByteField {
|
pub struct UnsignedByteField {
|
||||||
width: usize,
|
width: usize,
|
||||||
value: u64,
|
value: u64,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl UnsignedByteField {
|
impl UnsignedByteField {
|
||||||
#[inline]
|
|
||||||
pub const fn new(width: usize, value: u64) -> Self {
|
pub const fn new(width: usize, value: u64) -> Self {
|
||||||
Self { width, value }
|
Self { width, value }
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub const fn value_const(&self) -> u64 {
|
pub const fn value_const(&self) -> u64 {
|
||||||
self.value
|
self.value
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
pub fn new_from_be_bytes(width: usize, buf: &[u8]) -> Result<Self, UnsignedByteFieldError> {
|
pub fn new_from_be_bytes(width: usize, buf: &[u8]) -> Result<Self, UnsignedByteFieldError> {
|
||||||
if width > buf.len() {
|
if width > buf.len() {
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
return Err(ByteConversionError::FromSliceTooSmall {
|
||||||
@ -196,12 +177,10 @@ impl UnsignedByteField {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl UnsignedEnum for UnsignedByteField {
|
impl UnsignedEnum for UnsignedByteField {
|
||||||
#[inline]
|
|
||||||
fn size(&self) -> usize {
|
fn size(&self) -> usize {
|
||||||
self.width
|
self.width
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn value(&self) -> u64 {
|
fn value(&self) -> u64 {
|
||||||
self.value_const()
|
self.value_const()
|
||||||
}
|
}
|
||||||
@ -241,7 +220,6 @@ impl UnsignedEnum for UnsignedByteField {
|
|||||||
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
||||||
pub struct GenericUnsignedByteField<TYPE: Copy + Into<u64>> {
|
pub struct GenericUnsignedByteField<TYPE: Copy + Into<u64>> {
|
||||||
value: TYPE,
|
value: TYPE,
|
||||||
}
|
}
|
||||||
@ -257,7 +235,6 @@ impl<TYPE: Copy + Into<u64>> GenericUnsignedByteField<TYPE> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteField<TYPE> {
|
impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteField<TYPE> {
|
||||||
#[inline]
|
|
||||||
fn size(&self) -> usize {
|
fn size(&self) -> usize {
|
||||||
self.value.written_len()
|
self.value.written_len()
|
||||||
}
|
}
|
||||||
@ -273,7 +250,6 @@ impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteFie
|
|||||||
Ok(self.value.written_len())
|
Ok(self.value.written_len())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn value(&self) -> u64 {
|
fn value(&self) -> u64 {
|
||||||
self.value_typed().into()
|
self.value_typed().into()
|
||||||
}
|
}
|
||||||
@ -299,7 +275,6 @@ impl From<UnsignedByteFieldU8> for UnsignedByteField {
|
|||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 1 {
|
if value.width != 1 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
@ -312,7 +287,6 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
||||||
#[inline]
|
|
||||||
fn from(value: UnsignedByteFieldU16) -> Self {
|
fn from(value: UnsignedByteFieldU16) -> Self {
|
||||||
Self::new(2, value.value as u64)
|
Self::new(2, value.value as u64)
|
||||||
}
|
}
|
||||||
@ -321,7 +295,6 @@ impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
|||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 2 {
|
if value.width != 2 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
@ -334,7 +307,6 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
||||||
#[inline]
|
|
||||||
fn from(value: UnsignedByteFieldU32) -> Self {
|
fn from(value: UnsignedByteFieldU32) -> Self {
|
||||||
Self::new(4, value.value as u64)
|
Self::new(4, value.value as u64)
|
||||||
}
|
}
|
||||||
@ -343,7 +315,6 @@ impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
|||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 4 {
|
if value.width != 4 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
@ -356,7 +327,6 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
||||||
#[inline]
|
|
||||||
fn from(value: UnsignedByteFieldU64) -> Self {
|
fn from(value: UnsignedByteFieldU64) -> Self {
|
||||||
Self::new(8, value.value)
|
Self::new(8, value.value)
|
||||||
}
|
}
|
||||||
@ -365,7 +335,6 @@ impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
|||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU64 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU64 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
#[inline]
|
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 8 {
|
if value.width != 8 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
|
Reference in New Issue
Block a user