GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> CCSDS / V3-5-3 > ccsds_pkt_boot / rhel6-64


Interface   Data Structures   File List   Data Fields   Globals  

CCSDS_pkt_private.h File Reference

Definitions of CCSDS packet header format. More...

#include <MSG/MSG_pubdefs.h>

Classes

struct  _CCSDS_Pkt_Hdr_Pri
struct  _CCSDS_Pkt_Hdr_Telem
struct  _CCSDS_Pkt_Hdr_Cmd

Defines

#define NULL   (void*) 0
#define CCSDS_PKT_MSG(_status, _param)   _msg_report((_status), 0, 1, (_param))
#define CCSDS_ID_VERSION_MASK   0xe000
#define CCSDS_ID_TYPE_MASK   0x1000
#define CCSDS_ID_SEC_HDR_MASK   0x0800
#define CCSDS_ID_APID_MASK   0x07ff
#define CCSDS_SEQ_FLAGS_MASK   0xc000
#define CCSDS_SEQ_COUNT_MASK   0x3fff
#define CCSDS_SEC_TYPE_MASK   0x8000
#define CCSDS_SEC_FUNC_CODE_MASK   0x7fff
#define CCSDS_SEC_SSEC_MAX   999999
#define CCSDS_PKT_PRI_SIZE   6
#define CCSDS_PKT_TELEM_SEC_SIZE   8
#define CCSDS_PKT_CMD_SEC_SIZE   2
#define CCSDS_PKT_TELEM_HDR_SIZE   (CCSDS_PKT_PRI_SIZE + CCSDS_PKT_TELEM_SEC_SIZE)
#define CCSDS_PKT_CMD_HDR_SIZE   (CCSDS_PKT_PRI_SIZE + CCSDS_PKT_CMD_SEC_SIZE)
#define CCSDS_PKT_CHKSUM_SIZE   2
#define CCSDS_PKT_MAX_TOTAL_SIZE   0x10000
#define CCSDS_PKT_MAX_CMD_SIZE   (CCSDS_PKT_MAX_TOTAL_SIZE - CCSDS_PKT_CMD_SEC_SIZE)
#define CCSDS_PKT_MAX_TELEM_SIZE   (CCSDS_PKT_MAX_TOTAL_SIZE - CCSDS_PKT_TELEM_SEC_SIZE)

Typedefs

typedef struct _CCSDS_Pkt_Hdr_Pri CCSDS_Pkt_Hdr_Pri
typedef struct _CCSDS_Pkt_Hdr_Telem CCSDS_Pkt_Hdr_Telem
typedef struct _CCSDS_Pkt_Hdr_Cmd CCSDS_Pkt_Hdr_Cmd


Detailed Description

Definitions of CCSDS packet header format.

Author:
D.L. Wood
The following definitions are provided.


Define Documentation

#define CCSDS_ID_APID_MASK   0x07ff

CCSDS packet header ID mask: Application ID bits.

Referenced by CCSDS_pktHdrCreate(), CCSDS_pktHdrGetApid(), and CCSDS_pktHdrSetApid().

#define CCSDS_ID_SEC_HDR_MASK   0x0800

CCSDS packet header ID mask: secondary header flag bits.

Referenced by CCSDS_pktHdrVerify().

#define CCSDS_ID_TYPE_MASK   0x1000

#define CCSDS_ID_VERSION_MASK   0xe000

CCSDS packet header ID mask: version number bits.

Referenced by CCSDS_pktHdrVerify().

#define CCSDS_PKT_CHKSUM_SIZE   2

The size in bytes of a CCSDS telecommand packet checksum.

Referenced by CCSDS_pktChksumSizeof().

#define CCSDS_PKT_CMD_HDR_SIZE   (CCSDS_PKT_PRI_SIZE + CCSDS_PKT_CMD_SEC_SIZE)

The size in bytes of a combined CCSDS command packet header.

Referenced by CCSDS_pktHdrSizeof().

#define CCSDS_PKT_CMD_SEC_SIZE   2

The size in bytes of a CCSDS command packet secondary header.

Referenced by CCSDS_pktHdrCreate(), CCSDS_pktHdrGetLength(), and CCSDS_pktHdrSetLength().

#define CCSDS_PKT_MAX_CMD_SIZE   (CCSDS_PKT_MAX_TOTAL_SIZE - CCSDS_PKT_CMD_SEC_SIZE)

The maximum number of application data bytes for a command packet.

Referenced by CCSDS_pktHdrCreate(), and CCSDS_pktHdrSetLength().

#define CCSDS_PKT_MAX_TELEM_SIZE   (CCSDS_PKT_MAX_TOTAL_SIZE - CCSDS_PKT_TELEM_SEC_SIZE)

The maximum number of application data bytes for a telemetry packet.

Referenced by CCSDS_pktHdrCreate(), and CCSDS_pktHdrSetLength().

#define CCSDS_PKT_MAX_TOTAL_SIZE   0x10000

The maximum number of bytes for an entire packet, including both header and application data.

#define CCSDS_PKT_MSG ( _status,
_param   )     _msg_report((_status), 0, 1, (_param))

Configuration-dependent message signaller. For boot configuration, a no-op. For application configuration, calls MSG_signal().

Parameters:
_status The variable holding the status code.
_param The message specific parameter value.

Referenced by CCSDS_pktChksumInsert(), CCSDS_pktChksumVerify(), CCSDS_pktHdrCreate(), CCSDS_pktHdrGetApid(), CCSDS_pktHdrGetFuncCode(), CCSDS_pktHdrGetLength(), CCSDS_pktHdrGetSeqCount(), CCSDS_pktHdrGetSeqFlags(), CCSDS_pktHdrGetTime(), CCSDS_pktHdrGetType(), CCSDS_pktHdrSetApid(), CCSDS_pktHdrSetFuncCode(), CCSDS_pktHdrSetLength(), CCSDS_pktHdrSetSeqCount(), CCSDS_pktHdrSetSeqFlags(), CCSDS_pktHdrSetTime(), and CCSDS_pktHdrVerify().

#define CCSDS_PKT_PRI_SIZE   6

The size in bytes of a CCSDS packet primary header.

#define CCSDS_PKT_TELEM_HDR_SIZE   (CCSDS_PKT_PRI_SIZE + CCSDS_PKT_TELEM_SEC_SIZE)

The size in bytes of a combined CCSDS telemetry packet header.

Referenced by CCSDS_pktHdrSizeof().

#define CCSDS_PKT_TELEM_SEC_SIZE   8

The size in bytes of a CCSDS telemery packet secondary header.

Referenced by CCSDS_pktHdrCreate(), CCSDS_pktHdrGetLength(), and CCSDS_pktHdrSetLength().

#define CCSDS_SEC_FUNC_CODE_MASK   0x7fff

CCSDS packet secondary header mask: command function code.

Referenced by CCSDS_pktHdrCreate(), CCSDS_pktHdrGetFuncCode(), and CCSDS_pktHdrSetFuncCode().

#define CCSDS_SEC_SSEC_MAX   999999

The maximum value allowed for secondary header telemetry sub-seconds timestamp.

Referenced by CCSDS_pktHdrCreate(), and CCSDS_pktHdrSetTime().

#define CCSDS_SEC_TYPE_MASK   0x8000

CCSDS packet secondary header mask: secondary header type.

Referenced by CCSDS_pktHdrVerify().

#define CCSDS_SEQ_COUNT_MASK   0x3fff

CCSDS packet sequence mask: sequence count bits.

Referenced by CCSDS_pktHdrCreate(), CCSDS_pktHdrGetSeqCount(), and CCSDS_pktHdrSetSeqCount().

#define CCSDS_SEQ_FLAGS_MASK   0xc000

CCSDS packet sequence mask: sequence flag bits.

Referenced by CCSDS_pktHdrCreate(), CCSDS_pktHdrGetSeqFlags(), and CCSDS_pktHdrSetSeqFlags().

#define NULL   (void*) 0


Typedef Documentation

The typedef for _CCSDS_Pkt_Hdr_Cmd.

The typedef for _CCSDS_Pkt_Hdr_Pri.

The typedef for _CCSDS_Pkt_Hdr_Telem.


Generated on Tue Nov 29 16:31:49 2011 by  doxygen 1.5.8