hdlc_tx_state_s Struct Reference

#include <hdlc.h>

Public Attributes
int	crc_bytes
hdlc_underflow_handler_t	underflow_handler
	The callback routine called to indicate transmit underflow.
void *	user_data
	An opaque parameter passed to the callback routine.
int	inter_frame_flags
	The minimum flag octets to insert between frames.
bool	progressive
	True if frame creation works in progressive mode.
size_t	max_frame_len
	Maximum permitted frame length.
uint32_t	octets_in_progress
	The stuffed bit stream being created.
int	num_bits
	The number of bits currently in octets_in_progress.
int	idle_octet
	The currently rotated state of the flag octet.
int	flag_octets
	The number of flag octets to send for a timed burst of flags.
int	abort_octets
	The number of abort octets to send for a timed burst of aborts.
bool	report_flag_underflow
	True if the next underflow of timed flag octets should be reported.
uint8_t	buffer [HDLC_MAXFRAME_LEN+4]
	The current message being transmitted, with its CRC attached.
size_t	len
	The length of the message in the buffer.
size_t	pos
	The current send position within the buffer.
uint32_t	crc
	The running CRC, as data fills the frame buffer.
int	byte
	The current byte being broken into bits for transmission.
int	bits
	The number of bits remaining in byte.
bool	tx_end
	True if transmission should end on buffer underflow .

Detailed Description

HDLC transmit descriptor. This contains all the state information for an HDLC transmitter.

Member Data Documentation

abort_octets

int hdlc_tx_state_s::abort_octets

The number of abort octets to send for a timed burst of aborts.

Referenced by hdlc_tx_abort(), hdlc_tx_get_byte(), and hdlc_tx_restart().

bits

int hdlc_tx_state_s::bits

The number of bits remaining in byte.

Referenced by hdlc_tx_get_bit(), and hdlc_tx_restart().

buffer

uint8_t hdlc_tx_state_s::buffer[HDLC_MAXFRAME_LEN+4]

The current message being transmitted, with its CRC attached.

Referenced by hdlc_tx_corrupt_frame(), hdlc_tx_frame(), and hdlc_tx_get_byte().

byte

int hdlc_tx_state_s::byte

The current byte being broken into bits for transmission.

Referenced by hdlc_tx_get_bit(), and hdlc_tx_restart().

crc

uint32_t hdlc_tx_state_s::crc

The running CRC, as data fills the frame buffer.

Referenced by hdlc_tx_corrupt_frame(), hdlc_tx_frame(), hdlc_tx_get_byte(), hdlc_tx_init(), and hdlc_tx_restart().

crc_bytes

int hdlc_tx_state_s::crc_bytes

2 for CRC-16, 4 for CRC-32

Referenced by hdlc_tx_frame(), hdlc_tx_get_byte(), hdlc_tx_init(), and hdlc_tx_restart().

flag_octets

int hdlc_tx_state_s::flag_octets

The number of flag octets to send for a timed burst of flags.

Referenced by hdlc_tx_abort(), hdlc_tx_flags(), hdlc_tx_get_byte(), and hdlc_tx_restart().

idle_octet

int hdlc_tx_state_s::idle_octet

The currently rotated state of the flag octet.

Referenced by hdlc_tx_get_byte(), hdlc_tx_init(), and hdlc_tx_restart().

inter_frame_flags

int hdlc_tx_state_s::inter_frame_flags

The minimum flag octets to insert between frames.

Referenced by hdlc_tx_get_byte(), and hdlc_tx_init().

len

size_t hdlc_tx_state_s::len

The length of the message in the buffer.

Referenced by hdlc_tx_corrupt_frame(), hdlc_tx_frame(), hdlc_tx_get_byte(), and hdlc_tx_restart().

max_frame_len

size_t hdlc_tx_state_s::max_frame_len

Maximum permitted frame length.

Referenced by hdlc_tx_frame(), hdlc_tx_init(), and hdlc_tx_set_max_frame_len().

num_bits

int hdlc_tx_state_s::num_bits

The number of bits currently in octets_in_progress.

Referenced by hdlc_tx_get_byte(), and hdlc_tx_restart().

octets_in_progress

uint32_t hdlc_tx_state_s::octets_in_progress

The stuffed bit stream being created.

Referenced by hdlc_tx_get_byte(), and hdlc_tx_restart().

pos

size_t hdlc_tx_state_s::pos

The current send position within the buffer.

Referenced by hdlc_tx_flags(), hdlc_tx_frame(), hdlc_tx_get_byte(), and hdlc_tx_restart().

progressive

bool hdlc_tx_state_s::progressive

True if frame creation works in progressive mode.

Referenced by hdlc_tx_frame(), and hdlc_tx_init().

report_flag_underflow

bool hdlc_tx_state_s::report_flag_underflow

True if the next underflow of timed flag octets should be reported.

Referenced by hdlc_tx_flags(), hdlc_tx_get_byte(), and hdlc_tx_restart().

tx_end

bool hdlc_tx_state_s::tx_end

True if transmission should end on buffer underflow .

Referenced by hdlc_tx_flags(), hdlc_tx_frame(), hdlc_tx_get_byte(), and hdlc_tx_restart().

underflow_handler

hdlc_underflow_handler_t hdlc_tx_state_s::underflow_handler

The callback routine called to indicate transmit underflow.

Referenced by hdlc_tx_get_byte(), and hdlc_tx_init().

user_data

void* hdlc_tx_state_s::user_data

An opaque parameter passed to the callback routine.

Referenced by hdlc_tx_get_byte(), and hdlc_tx_init().

---

The documentation for this struct was generated from the following file:

• private/hdlc.h