Merge pull request 'Start adding defmt support' (#76) from start-addi…

…ng-defmt-support into main

Reviewed-on: https://egit.irs.uni-stuttgart.de/rust/spacepackets/pulls/76

CHANGELOG.md

@@ -24,6 +24,7 @@ to check all the API changes in the **Changed** chapter.
 - Added basic support conversions to the `time` library. Introduce new `chrono` and `timelib`
   feature gate.
 - Added `CcsdsTimeProvider::timelib_date_time`.
+- Optional support for `defmt` by adding optional `defmt::Format` derives for common types.
 
 ## Changed
 

Cargo.toml

@@ -48,6 +48,10 @@ optional = true
 version = "0.2"
 default-features = false
 
+[dependencies.defmt]
+version = "0.3"
+optional = true
+
 [dev-dependencies]
 postcard = "1"
 chrono = "0.4"
@@ -59,6 +63,7 @@ serde = ["dep:serde", "chrono/serde"]
 alloc = ["postcard/alloc", "chrono/alloc"]
 chrono = ["dep:chrono"]
 timelib = ["dep:time"]
+defmt = ["dep:defmt"]
 
 [package.metadata.docs.rs]
 all-features = true

README.md

@@ -45,6 +45,8 @@ deserializing them with an appropriate `serde` provider like
  - [`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.
  - [`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` derive on many objects.
 
 # Examples
 

src/cfdp/lv.rs

@@ -20,6 +20,7 @@ pub const MIN_LV_LEN: usize = 1;
 ///    this will be the lifetime of that data reference.
 #[derive(Debug, Copy, Clone, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Lv<'data> {
     data: &'data [u8],
     // If the LV was generated from a raw bytestream, this will contain the start of the

src/cfdp/mod.rs

@@ -18,6 +18,7 @@ pub const CFDP_VERSION_2: u8 = 0b001;
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum PduType {
     FileDirective = 0,
@@ -26,6 +27,7 @@ pub enum PduType {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum Direction {
     TowardsReceiver = 0,
@@ -34,6 +36,7 @@ pub enum Direction {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum TransmissionMode {
     Acknowledged = 0,
@@ -42,6 +45,7 @@ pub enum TransmissionMode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum CrcFlag {
     NoCrc = 0,
@@ -69,6 +73,7 @@ impl From<CrcFlag> for bool {
 /// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum SegmentMetadataFlag {
     NotPresent = 0,
@@ -78,6 +83,7 @@ pub enum SegmentMetadataFlag {
 /// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum SegmentationControl {
     NoRecordBoundaryPreservation = 0,
@@ -86,6 +92,7 @@ pub enum SegmentationControl {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FaultHandlerCode {
     NoticeOfCancellation = 0b0001,
@@ -96,6 +103,7 @@ pub enum FaultHandlerCode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum ConditionCode {
     /// This is not an error condition for which a faulty handler override can be specified
@@ -118,6 +126,7 @@ pub enum ConditionCode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum LargeFileFlag {
     /// 32 bit maximum file size and FSS size
@@ -129,6 +138,7 @@ pub enum LargeFileFlag {
 /// 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)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum TransactionStatus {
     /// Transaction is not currently active and the CFDP implementation does not retain a
@@ -146,6 +156,7 @@ pub enum TransactionStatus {
 /// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/)
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum ChecksumType {
     /// Modular legacy checksum
@@ -167,6 +178,7 @@ pub const NULL_CHECKSUM_U32: [u8; 4] = [0; 4];
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum TlvLvError {
     DataTooLarge(usize),
     ByteConversion(ByteConversionError),

src/cfdp/pdu/ack.rs

@@ -15,6 +15,7 @@ use serde::{Deserialize, Serialize};
 /// For more information, refer to CFDP chapter 5.2.4.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct AckPdu {
     pdu_header: PduHeader,
     directive_code_of_acked_pdu: FileDirectiveType,

src/cfdp/pdu/eof.rs

@@ -15,6 +15,7 @@ use super::{CfdpPdu, WritablePduPacket};
 /// For more information, refer to CFDP chapter 5.2.2.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct EofPdu {
     pdu_header: PduHeader,
     condition_code: ConditionCode,

src/cfdp/pdu/finished.rs

@@ -14,6 +14,7 @@ use super::{CfdpPdu, WritablePduPacket};
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum DeliveryCode {
     Complete = 0,
@@ -22,6 +23,7 @@ pub enum DeliveryCode {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FileStatus {
     DiscardDeliberately = 0b00,
@@ -34,6 +36,7 @@ pub enum FileStatus {
 ///
 /// For more information, refer to CFDP chapter 5.2.3.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct FinishedPduCreator<'fs_responses> {
     pdu_header: PduHeader,
     condition_code: ConditionCode,
@@ -219,6 +222,7 @@ impl<'buf> Iterator for FilestoreResponseIterator<'buf> {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct FinishedPduReader<'buf> {
     pdu_header: PduHeader,
     condition_code: ConditionCode,

src/cfdp/pdu/metadata.rs

@@ -15,6 +15,7 @@ use super::{CfdpPdu, WritablePduPacket};
 
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataGenericParams {
     pub closure_requested: bool,
     pub checksum_type: ChecksumType,
@@ -55,6 +56,7 @@ pub fn build_metadata_opts_from_vec(
 /// This abstraction exposes a specialized API for creating metadata PDUs as specified in
 /// CFDP chapter 5.2.5.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataPduCreator<'src_name, 'dest_name, 'opts> {
     pdu_header: PduHeader,
     metadata_params: MetadataGenericParams,
@@ -241,6 +243,7 @@ impl<'opts> Iterator for OptionsIter<'opts> {
 /// involved.
 #[derive(Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataPduReader<'buf> {
     pdu_header: PduHeader,
     metadata_params: MetadataGenericParams,

src/cfdp/pdu/mod.rs

@@ -18,6 +18,7 @@ pub mod nak;
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FileDirectiveType {
     EofPdu = 0x04,
@@ -220,6 +221,7 @@ pub trait CfdpPdu {
 /// same.
 #[derive(Debug, Copy, Clone, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct CommonPduConfig {
     source_entity_id: UnsignedByteField,
     dest_entity_id: UnsignedByteField,
@@ -358,6 +360,7 @@ pub const FIXED_HEADER_LEN: usize = 4;
 /// For detailed information, refer to chapter 5.1 of the CFDP standard.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PduHeader {
     pdu_type: PduType,
     pdu_conf: CommonPduConfig,

src/cfdp/pdu/nak.rs

@@ -12,6 +12,7 @@ use super::{
 /// Helper type to encapsulate both normal file size segment requests and large file size segment
 /// requests.
 #[derive(Debug, PartialEq, Eq, Clone)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum SegmentRequests<'a> {
     U32Pairs(&'a [(u32, u32)]),
     U64Pairs(&'a [(u64, u64)]),
@@ -31,6 +32,7 @@ impl SegmentRequests<'_> {
 /// It exposes a specialized API which simplifies to generate these NAK PDUs with the
 /// format according to CFDP chapter 5.2.6.
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct NakPduCreator<'seg_reqs> {
     pdu_header: PduHeader,
     start_of_scope: u64,
@@ -353,6 +355,7 @@ impl<T: SegReqFromBytes> SegmentRequestIter<'_, T> {
 ///
 /// The NAK format is expected to be conforming to CFDP chapter 5.2.6.
 #[derive(Debug, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct NakPduReader<'seg_reqs> {
     pdu_header: PduHeader,
     start_of_scope: u64,

src/cfdp/tlv/mod.rs

@@ -52,6 +52,7 @@ pub trait WritableTlv {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum TlvType {
     FilestoreRequest = 0x00,
@@ -64,13 +65,15 @@ pub enum TlvType {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum TlvTypeField {
     Standard(TlvType),
     Custom(u8),
 }
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum FilestoreActionCode {
     CreateFile = 0b0000,
@@ -118,6 +121,7 @@ impl From<TlvTypeField> for u8 {
 ///    this will be the lifetime of that data reference.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct Tlv<'data> {
     tlv_type_field: TlvTypeField,
     #[cfg_attr(feature = "serde", serde(borrow))]
@@ -224,6 +228,7 @@ pub(crate) fn verify_tlv_type(raw_type: u8, expected_tlv_type: TlvType) -> Resul
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct EntityIdTlv {
     entity_id: UnsignedByteField,
 }
@@ -348,6 +353,7 @@ pub fn fs_request_has_second_filename(action_code: FilestoreActionCode) -> bool
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 struct FilestoreTlvBase<'first_name, 'second_name> {
     pub action_code: FilestoreActionCode,
     #[cfg_attr(feature = "serde", serde(borrow))]
@@ -561,6 +567,7 @@ impl GenericTlv for FilestoreRequestTlv<'_, '_> {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct FilestoreResponseTlv<'first_name, 'second_name, 'fs_msg> {
     #[cfg_attr(feature = "serde", serde(borrow))]
     base: FilestoreTlvBase<'first_name, 'second_name>,

src/ecss/hk.rs

@@ -5,6 +5,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 pub enum Subservice {
     // Regular HK

src/ecss/mod.rs

@@ -74,6 +74,7 @@ pub enum PusServiceId {
 /// All PUS versions. Only PUS C is supported by this library.
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[non_exhaustive]
 pub enum PusVersion {
     EsaPus = 0,
@@ -150,6 +151,7 @@ pub enum PfcReal {
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum PusError {
     VersionNotSupported(PusVersion),
     ChecksumFailure(u16),

src/ecss/tc.rs

@@ -61,6 +61,7 @@ pub trait IsPusTelecommand {}
 
 #[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[repr(u8)]
 enum AckOpts {
     Acceptance = 0b1000,
@@ -146,6 +147,7 @@ pub mod zc {
 
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTcSecondaryHeader {
     pub service: u8,
     pub subservice: u8,
@@ -548,6 +550,7 @@ pub mod legacy_tc {
 /// There is no spare bytes support yet.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTcCreator<'raw_data> {
     sp_header: SpHeader,
     pub sec_header: PusTcSecondaryHeader,
@@ -750,6 +753,7 @@ impl IsPusTelecommand for PusTcCreator<'_> {}
 /// * `'raw_data` - Lifetime of the provided raw slice.
 #[derive(Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTcReader<'raw_data> {
     #[cfg_attr(feature = "serde", serde(skip))]
     raw_data: &'raw_data [u8],

src/ecss/tm.rs

@@ -116,6 +116,7 @@ pub mod zc {
 
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTmSecondaryHeader<'stamp> {
     pus_version: PusVersion,
     pub sc_time_ref_status: u8,
@@ -539,6 +540,7 @@ pub mod legacy_tm {
 /// * `'raw_data` - This is the lifetime of the user provided time stamp and source data.
 #[derive(Eq, Debug, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTmCreator<'raw_data> {
     pub sp_header: SpHeader,
     pub sec_header: PusTmSecondaryHeader<'raw_data>,
@@ -777,6 +779,7 @@ impl IsPusTelemetry for PusTmCreator<'_> {}
 /// * `'raw_data` - Lifetime of the raw slice this class is constructed from.
 #[derive(Eq, Debug, Copy, Clone)]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct PusTmReader<'raw_data> {
     pub sp_header: SpHeader,
     pub sec_header: PusTmSecondaryHeader<'raw_data>,