Solaris Packet Protocol (SPP) packet structure definitions. More...

#include "spp/core/types.h"

Include dependency graph for packet.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	K_SPP_PKT_VERSION (1U)
	Current SPP protocol version embedded in each packet.
#define	K_SPP_PKT_PAYLOAD_MAX (50U)
	Maximum payload size in bytes per packet.
#define	K_SPP_TOTAL_PACKET_SIZE (64U)
#define	K_SPP_APID_LOG (0x0001U)
	APID reserved for SPP log message packets.

Functions
struct	__attribute__ ((packed))
	Primary header — routing and framing information.

Variables
	SPP_PacketPrimary_t
	SPP_PacketSecondary_t
	SPP_Packet_t

Detailed Description

Solaris Packet Protocol (SPP) packet structure definitions.

Defines the on-wire layout of an SPP packet, inspired by the ECSS Space Packet Protocol standard. Every sensor reading or telemetry message in the system is transported as an SPP_Packet_t.

Naming conventions used in this file:

Constants/macros: K_SPP_PKT_*
Types: SPP_Packet*_t

Definition in file packet.h.

Macro Definition Documentation

◆ K_SPP_PKT_VERSION

#define K_SPP_PKT_VERSION (1U)

Current SPP protocol version embedded in each packet.

Definition at line 24 of file packet.h.

Referenced by SPP_SERVICES_DATABANK_packetData().

◆ K_SPP_PKT_PAYLOAD_MAX

#define K_SPP_PKT_PAYLOAD_MAX (50U)

Maximum payload size in bytes per packet.

Definition at line 27 of file packet.h.

Referenced by SPP_SERVICES_DATABANK_packetData().

◆ K_SPP_TOTAL_PACKET_SIZE

#define K_SPP_TOTAL_PACKET_SIZE (64U)

Total packet size in bytes. Multiple of 8 bytes.

Definition at line 29 of file packet.h.

Referenced by SPP_SERVICES_DATALOGGER_consumeData().

◆ K_SPP_APID_LOG

#define K_SPP_APID_LOG (0x0001U)

APID reserved for SPP log message packets.

Definition at line 36 of file packet.h.

Function Documentation

◆ attribute()

struct __attribute__ ( (packed) )

Primary header — routing and framing information.

Complete SPP packet.

Secondary header — timing and reliability metadata.

Producers fill primaryHeader, secondaryHeader, and payload, then push the packet into the db_flow FIFO. Consumers pop it, process it, and return it to the databank.

< Protocol version (= K_SPP_PKT_VERSION).

< Application Process Identifier.

< Packet sequence counter (wraps at UINT16_MAX).

< Length of the payload field in bytes.

< System timestamp at packet creation (ms).

< Number of packets dropped since last reset.

< Routing / framing header.

< Timing / metadata header.

< Raw payload bytes.

< CRC-16 over the full packet (0 = not computed).

Definition at line 1 of file packet.h.

Variable Documentation

◆ SPP_PacketPrimary_t

SPP_PacketPrimary_t

Definition at line 51 of file packet.h.

◆ SPP_PacketSecondary_t

SPP_PacketSecondary_t

Definition at line 60 of file packet.h.

◆ SPP_Packet_t

SPP_Packet_t

Definition at line 79 of file packet.h.

Referenced by action_emitTelemetry(), packetCrc(), s_buildNonce(), SPP_EXTERNAL_ENCRYPTION_CYPHER_encryptPacket(), SPP_SERVICES_BMP390_acquireData(), SPP_SERVICES_BMP390_DUMMY_acquireData(), SPP_SERVICES_DATABANK_getPacket(), SPP_SERVICES_DATABANK_packetData(), SPP_SERVICES_DATABANK_returnPacket(), SPP_SERVICES_DATALOGGER_deliverToMailbox(), SPP_SERVICES_ICM20948_acquireData(), SPP_SERVICES_PUBSUB_publish(), SPP_SERVICES_PUBSUB_sendToMailbox(), SPP_SERVICES_SX1262_bmpPacket_to_text(), SPP_SERVICES_SX1262_consumeData(), SPP_SERVICES_SX1262_deliverToMailbox(), and SPP_SERVICES_SX1262_icmPacket_to_text().

Macros

Functions

Variables