private/hdlc.h
/*
* SpanDSP - a series of DSP components for telephony
*
* private/hdlc.h
*
* Written by Steve Underwood <steveu@coppice.org>
*
* Copyright (C) 2003 Steve Underwood
*
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 2.1,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#if !defined(_SPANDSP_PRIVATE_HDLC_H_)
#define _SPANDSP_PRIVATE_HDLC_H_
/*!
HDLC receive descriptor. This contains all the state information for an HDLC receiver.
*/
struct hdlc_rx_state_s
{
/*! 2 for CRC-16, 4 for CRC-32 */
int crc_bytes;
/*! \brief Maximum permitted frame length. */
size_t max_frame_len;
/*! \brief The callback routine called to process each good received frame. */
hdlc_frame_handler_t frame_handler;
/*! \brief An opaque parameter passed to the frame callback routine. */
void *frame_user_data;
/*! \brief The callback routine called to report status changes. */
modem_rx_status_func_t status_handler;
/*! \brief An opaque parameter passed to the status callback routine. */
void *status_user_data;
/*! \brief TRUE if bad frames are to be reported. */
int report_bad_frames;
/*! \brief The number of consecutive flags which must be seen before framing is
declared OK. */
int framing_ok_threshold;
/*! \brief TRUE if framing OK has been announced. */
int framing_ok_announced;
/*! \brief Number of consecutive flags seen so far. */
int flags_seen;
/*! \brief The raw (stuffed) bit stream buffer. */
unsigned int raw_bit_stream;
/*! \brief The destuffed bit stream buffer. */
unsigned int byte_in_progress;
/*! \brief The current number of bits in byte_in_progress. */
int num_bits;
/*! \brief TRUE if in octet counting mode (e.g. for MTP). */
int octet_counting_mode;
/*! \brief Octet count, to achieve the functionality needed for things
like MTP. */
int octet_count;
/*! \brief The number of octets to be allowed between octet count reports. */
int octet_count_report_interval;
/*! \brief Buffer for a frame in progress. */
uint8_t buffer[HDLC_MAXFRAME_LEN + 4];
/*! \brief Length of a frame in progress. */
size_t len;
/*! \brief The number of bytes of good frames received (CRC not included). */
unsigned long int rx_bytes;
/*! \brief The number of good frames received. */
unsigned long int rx_frames;
/*! \brief The number of frames with CRC errors received. */
unsigned long int rx_crc_errors;
/*! \brief The number of too short and too long frames received. */
unsigned long int rx_length_errors;
/*! \brief The number of HDLC aborts received. */
unsigned long int rx_aborts;
};
/*!
HDLC transmit descriptor. This contains all the state information for an
HDLC transmitter.
*/
struct hdlc_tx_state_s
{
/*! 2 for CRC-16, 4 for CRC-32 */
int crc_bytes;
/*! \brief The callback routine called to indicate transmit underflow. */
hdlc_underflow_handler_t underflow_handler;
/*! \brief An opaque parameter passed to the callback routine. */
void *user_data;
/*! \brief The minimum flag octets to insert between frames. */
int inter_frame_flags;
/*! \brief TRUE if frame creation works in progressive mode. */
int progressive;
/*! \brief Maximum permitted frame length. */
size_t max_frame_len;
/*! \brief The stuffed bit stream being created. */
uint32_t octets_in_progress;
/*! \brief The number of bits currently in octets_in_progress. */
int num_bits;
/*! \brief The currently rotated state of the flag octet. */
int idle_octet;
/*! \brief The number of flag octets to send for a timed burst of flags. */
int flag_octets;
/*! \brief The number of abort octets to send for a timed burst of aborts. */
int abort_octets;
/*! \brief TRUE if the next underflow of timed flag octets should be reported */
int report_flag_underflow;
/*! \brief The current message being transmitted, with its CRC attached. */
uint8_t buffer[HDLC_MAXFRAME_LEN + 4];
/*! \brief The length of the message in the buffer. */
size_t len;
/*! \brief The current send position within the buffer. */
size_t pos;
/*! \brief The running CRC, as data fills the frame buffer. */
uint32_t crc;
/*! \brief The current byte being broken into bits for transmission. */
int byte;
/*! \brief The number of bits remaining in byte. */
int bits;
/*! \brief TRUE if transmission should end on buffer underflow .*/
int tx_end;
};
#endif
/*- End of file ------------------------------------------------------------*/
HDLC_MAXFRAME_LEN
#define HDLC_MAXFRAME_LEN
Definition hdlc.h:46
hdlc_rx_state_s
Definition private/hdlc.h:33
hdlc_rx_state_s::len
size_t len
Length of a frame in progress.
Definition private/hdlc.h:73
hdlc_rx_state_s::framing_ok_threshold
int framing_ok_threshold
The number of consecutive flags which must be seen before framing is declared OK.
Definition private/hdlc.h:50
hdlc_rx_state_s::buffer
uint8_t buffer[HDLC_MAXFRAME_LEN+4]
Buffer for a frame in progress.
Definition private/hdlc.h:71
hdlc_rx_state_s::framing_ok_announced
int framing_ok_announced
TRUE if framing OK has been announced.
Definition private/hdlc.h:52
hdlc_rx_state_s::rx_crc_errors
unsigned long int rx_crc_errors
The number of frames with CRC errors received.
Definition private/hdlc.h:80
hdlc_rx_state_s::raw_bit_stream
unsigned int raw_bit_stream
The raw (stuffed) bit stream buffer.
Definition private/hdlc.h:57
hdlc_rx_state_s::byte_in_progress
unsigned int byte_in_progress
The destuffed bit stream buffer.
Definition private/hdlc.h:59
hdlc_rx_state_s::report_bad_frames
int report_bad_frames
TRUE if bad frames are to be reported.
Definition private/hdlc.h:47
hdlc_rx_state_s::rx_aborts
unsigned long int rx_aborts
The number of HDLC aborts received.
Definition private/hdlc.h:84
hdlc_rx_state_s::octet_counting_mode
int octet_counting_mode
TRUE if in octet counting mode (e.g. for MTP).
Definition private/hdlc.h:63
hdlc_rx_state_s::status_user_data
void * status_user_data
An opaque parameter passed to the status callback routine.
Definition private/hdlc.h:45
hdlc_rx_state_s::frame_handler
hdlc_frame_handler_t frame_handler
The callback routine called to process each good received frame.
Definition private/hdlc.h:39
hdlc_rx_state_s::rx_bytes
unsigned long int rx_bytes
The number of bytes of good frames received (CRC not included).
Definition private/hdlc.h:76
hdlc_rx_state_s::frame_user_data
void * frame_user_data
An opaque parameter passed to the frame callback routine.
Definition private/hdlc.h:41
hdlc_rx_state_s::flags_seen
int flags_seen
Number of consecutive flags seen so far.
Definition private/hdlc.h:54
hdlc_rx_state_s::max_frame_len
size_t max_frame_len
Maximum permitted frame length.
Definition private/hdlc.h:37
hdlc_rx_state_s::crc_bytes
int crc_bytes
Definition private/hdlc.h:35
hdlc_rx_state_s::rx_length_errors
unsigned long int rx_length_errors
The number of too short and too long frames received.
Definition private/hdlc.h:82
hdlc_rx_state_s::num_bits
int num_bits
The current number of bits in byte_in_progress.
Definition private/hdlc.h:61
hdlc_rx_state_s::octet_count_report_interval
int octet_count_report_interval
The number of octets to be allowed between octet count reports.
Definition private/hdlc.h:68
hdlc_rx_state_s::octet_count
int octet_count
Octet count, to achieve the functionality needed for things like MTP.
Definition private/hdlc.h:66
hdlc_rx_state_s::rx_frames
unsigned long int rx_frames
The number of good frames received.
Definition private/hdlc.h:78
hdlc_rx_state_s::status_handler
modem_rx_status_func_t status_handler
The callback routine called to report status changes.
Definition private/hdlc.h:43
hdlc_tx_state_s
Definition private/hdlc.h:92
hdlc_tx_state_s::bits
int bits
The number of bits remaining in byte.
Definition private/hdlc.h:131
hdlc_tx_state_s::flag_octets
int flag_octets
The number of flag octets to send for a timed burst of flags.
Definition private/hdlc.h:113
hdlc_tx_state_s::octets_in_progress
uint32_t octets_in_progress
The stuffed bit stream being created.
Definition private/hdlc.h:107
hdlc_tx_state_s::buffer
uint8_t buffer[HDLC_MAXFRAME_LEN+4]
The current message being transmitted, with its CRC attached.
Definition private/hdlc.h:120
hdlc_tx_state_s::pos
size_t pos
The current send position within the buffer.
Definition private/hdlc.h:124
hdlc_tx_state_s::len
size_t len
The length of the message in the buffer.
Definition private/hdlc.h:122
hdlc_tx_state_s::idle_octet
int idle_octet
The currently rotated state of the flag octet.
Definition private/hdlc.h:111
hdlc_tx_state_s::num_bits
int num_bits
The number of bits currently in octets_in_progress.
Definition private/hdlc.h:109
hdlc_tx_state_s::tx_end
int tx_end
TRUE if transmission should end on buffer underflow .
Definition private/hdlc.h:134
hdlc_tx_state_s::inter_frame_flags
int inter_frame_flags
The minimum flag octets to insert between frames.
Definition private/hdlc.h:100
hdlc_tx_state_s::crc
uint32_t crc
The running CRC, as data fills the frame buffer.
Definition private/hdlc.h:126
hdlc_tx_state_s::report_flag_underflow
int report_flag_underflow
TRUE if the next underflow of timed flag octets should be reported.
Definition private/hdlc.h:117
hdlc_tx_state_s::byte
int byte
The current byte being broken into bits for transmission.
Definition private/hdlc.h:129
hdlc_tx_state_s::progressive
int progressive
TRUE if frame creation works in progressive mode.
Definition private/hdlc.h:102
hdlc_tx_state_s::crc_bytes
int crc_bytes
Definition private/hdlc.h:94
hdlc_tx_state_s::abort_octets
int abort_octets
The number of abort octets to send for a timed burst of aborts.
Definition private/hdlc.h:115
hdlc_tx_state_s::underflow_handler
hdlc_underflow_handler_t underflow_handler
The callback routine called to indicate transmit underflow.
Definition private/hdlc.h:96
hdlc_tx_state_s::user_data
void * user_data
An opaque parameter passed to the callback routine.
Definition private/hdlc.h:98
hdlc_tx_state_s::max_frame_len
size_t max_frame_len
Maximum permitted frame length.
Definition private/hdlc.h:104