PdcommSecs1EventInfo

Struct

Description of an event, filled by pdcomm_secs1_event_info().

typedef struct PdcommSecs1EventInfo { ... } PdcommSecs1EventInfo

Declared in: #include <pdcomm_secs1.h>

Fields that do not apply to the event kind are zero.

Members

body_length

Field

Inbound only: message body length in bytes.

size_t body_length

Declared in: #include <pdcomm_secs1.h>

device_id

Field

Inbound only: device ID from the block header.

uint16_t device_id

Declared in: #include <pdcomm_secs1.h>

direction

Field

Inbound only: #PDCOMM_SECS1_TO_HOST or #PDCOMM_SECS1_TO_EQUIPMENT, from the R-bit.

uint8_t direction

Declared in: #include <pdcomm_secs1.h>

discarded_partial

Field

Fault only: 1 when a partially received block or message was discarded.

uint8_t discarded_partial

Declared in: #include <pdcomm_secs1.h>

fault_detail

Field

Fault only: detail for fault_kind.

uint32_t fault_detail

Declared in: #include <pdcomm_secs1.h>

A PDCOMM_SECS1_IO_* value for #PDCOMM_SECS1_FAULT_IO; 0 otherwise.

fault_kind

Field

Fault only: one of the PDCOMM_SECS1_FAULT_* values.

uint32_t fault_kind

Declared in: #include <pdcomm_secs1.h>

function

Field

Inbound only: SECS-II function number.

uint8_t function

Declared in: #include <pdcomm_secs1.h>

kind

Field

Event kind, one of the PDCOMM_SECS1_EVENT_* values.

uint32_t kind

Declared in: #include <pdcomm_secs1.h>

reply_expected

Field

Inbound only: 1 when the W-bit is set, otherwise 0.

uint8_t reply_expected

Declared in: #include <pdcomm_secs1.h>

reserved

Field

Reserved; written as zero.

uint8_t reserved

Declared in: #include <pdcomm_secs1.h>

stream

Field

Inbound only: SECS-II stream number.

uint8_t stream

Declared in: #include <pdcomm_secs1.h>

struct_size

Field

Structure size in bytes.

size_t struct_size

Declared in: #include <pdcomm_secs1.h>

Set it to sizeof(PdcommSecs1EventInfo) or larger before the call. On success the library stores the size of the layout it wrote.

system_bytes

Field

Inbound only: system bytes from the block header, in host byte order.

uint32_t system_bytes

Declared in: #include <pdcomm_secs1.h>

token

Field

Submission the event refers to.

PdcommSecs1Token token

Declared in: #include <pdcomm_secs1.h>

Set for outbound events and for a fault that aborted a submission; zero otherwise.