add sequence flags type

Author: Michal-Pogorzelec

README.md

@@ -19,7 +19,7 @@ Build & run (host):
 
 3. Run tests:
 
-	./tests/test_packet
+	./tests/ctest
 
 Notes
 - This is a minimal, small-footprint implementation designed for embedded use.

examples/main.c

@@ -7,7 +7,7 @@ int main(void) {
   const uint8_t payload[] = {'H', 'e', 'l', 'l', 'o', ' ', 'S', 'P'};
   sp_packet_t pkt;
   sp_packet_init(&pkt);
-  sp_set_primary_header(&pkt, 0 /*version*/, 0 /*type*/, 1 /*sec hdr*/, 0x100, 0 /*seq flags*/, 1);
+  sp_set_primary_header(&pkt, 0 /*version*/, 0 /*type*/, 1 /*sec hdr*/, 0x100, SP_SEQ_FLAG_UNSEGMENTED /*seq flags*/, 1);
   /* Example with a minimal secondary header containing flags and zero extra
    * bytes. flags byte LSB=1 requests CRC; byte1=0 indicates zero remaining sec
    * header bytes.
@@ -35,7 +35,7 @@ int main(void) {
     return 2;
   }
 
-  printf("Parsed APID=0x%03X seq=%u payload_len=%u\n", parsed.ph.apid,
+  printf("Parsed APID=0x%03X seq count=%u payload_len=%u\n", parsed.ph.apid,
          parsed.ph.seq_count, parsed.payload_len);
   printf("Payload as ASCII: ");
   fwrite(parsed.payload, 1, parsed.payload_len, stdout);

include/space_packet.h

@@ -7,6 +7,13 @@
 #include <stddef.h>
 #include <stdint.h>
 
+typedef enum {
+  SP_SEQ_FLAG_UNSEGMENTED = 0,
+  SP_SEQ_FLAG_FIRST_SEGMENT = 1,
+  SP_SEQ_FLAG_CONTINUING_SEGMENT = 2,
+  SP_SEQ_FLAG_LAST_SEGMENT = 3
+} sp_seq_flag_t;
+
 /* Primary header is 6 bytes (CCSDS-like):
  * - bytes 0-1: version(3), type(1), sec_hdr(1), apid(11)
  * - bytes 2-3: seq_flags(2), seq_count(14)
@@ -28,11 +35,11 @@ typedef struct {
 #endif
   /* sequence control */
 #if defined(__BYTE_ORDER__) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
-  unsigned seq_flags : 2;
+  sp_seq_flag_t seq_flags : 2;
   unsigned seq_count : 14;
 #else
   unsigned seq_count : 14;
-  unsigned seq_flags : 2;
+  sp_seq_flag_t seq_flags : 2;
 #endif
   uint16_t packet_length;
 } sp_primary_header_t;
@@ -81,7 +88,7 @@ void sp_set_primary_header(sp_packet_t *pkt,
                           uint8_t type,
                           uint8_t sec_hdr_flag,
                           uint16_t apid,
-                          uint8_t seq_flags,
+                          sp_seq_flag_t seq_flags,
                           uint16_t seq_count);
 
 /* Set secondary header pointer and length (application-owned memory). */

src/space_packet.c

@@ -190,7 +190,7 @@ void sp_set_primary_header(sp_packet_t *pkt,
                uint8_t type,
                uint8_t sec_hdr_flag,
                uint16_t apid,
-               uint8_t seq_flags,
+               sp_seq_flag_t seq_flags,
                uint16_t seq_count) {
   if (!pkt) return;
   pkt->ph.version = (unsigned)(version & 0x7);

tests/unit_tests.c

@@ -45,6 +45,7 @@ static int test_roundtrip_with_secheader_crc(void) {
 
   sp_packet_t pkt = {0};
   pkt.ph.apid = 0x123;
+  pkt.ph.seq_flags = SP_SEQ_FLAG_UNSEGMENTED;
   pkt.ph.seq_count = 0x3;
   pkt.ph.sec_hdr_flag = 1;
   pkt.sec_hdr = sec_hdr;
@@ -70,6 +71,11 @@ static int test_roundtrip_with_secheader_crc(void) {
   }
 
   ASSERT_EQ_INT(parsed.ph.apid, pkt.ph.apid);
+  ASSERT_EQ_INT(parsed.ph.seq_count, pkt.ph.seq_count);
+  ASSERT_EQ_INT(parsed.ph.seq_flags, pkt.ph.seq_flags);
+  ASSERT_EQ_INT(parsed.ph.sec_hdr_flag, pkt.ph.sec_hdr_flag);
+  ASSERT_EQ_INT(parsed.sec_hdr_len, pkt.sec_hdr_len);
+  ASSERT_EQ_MEM(parsed.sec_hdr, pkt.sec_hdr, pkt.sec_hdr_len);
   ASSERT_EQ_INT(parsed.payload_len, pkt.payload_len);
   ASSERT_EQ_MEM(parsed.payload, pkt.payload, pkt.payload_len);