spandsp
3.0.0
|
Go to the source code of this file.
Typedefs | |
typedef void(* | put_msg_func_t) (void *user_data, const uint8_t *msg, int len) |
typedef int(* | get_msg_func_t) (void *user_data, uint8_t *msg, int max_len) |
typedef void(* | put_byte_func_t) (void *user_data, int byte) |
typedef int(* | get_byte_func_t) (void *user_data) |
typedef void(* | put_bit_func_t) (void *user_data, int bit) |
typedef int(* | get_bit_func_t) (void *user_data) |
typedef void(* | modem_status_func_t) (void *user_data, int status) |
typedef struct async_tx_state_s | async_tx_state_t |
typedef struct async_rx_state_s | async_rx_state_t |
Enumerations | |
enum | { SIG_STATUS_CARRIER_DOWN = -1 , SIG_STATUS_CARRIER_UP = -2 , SIG_STATUS_TRAINING_IN_PROGRESS = -3 , SIG_STATUS_TRAINING_SUCCEEDED = -4 , SIG_STATUS_TRAINING_FAILED = -5 , SIG_STATUS_FRAMING_OK = -6 , SIG_STATUS_END_OF_DATA = -7 , SIG_STATUS_ABORT = -8 , SIG_STATUS_BREAK = -9 , SIG_STATUS_SHUTDOWN_COMPLETE = -10 , SIG_STATUS_OCTET_REPORT = -11 , SIG_STATUS_POOR_SIGNAL_QUALITY = -12 , SIG_STATUS_MODEM_RETRAIN_OCCURRED = -13 , SIG_STATUS_LINK_CONNECTED = -14 , SIG_STATUS_LINK_DISCONNECTED = -15 , SIG_STATUS_LINK_ERROR = -16 , SIG_STATUS_LINK_IDLE = -17 } |
enum | { ASYNC_PARITY_NONE = 0 , ASYNC_PARITY_EVEN , ASYNC_PARITY_ODD } |
Functions | |
const char * | signal_status_to_str (int status) |
Convert a signal status to a short text description. More... | |
void | async_rx_put_bit (void *user_data, int bit) |
Accept a bit from a received serial bit stream. More... | |
async_rx_state_t * | async_rx_init (async_rx_state_t *s, int data_bits, int parity_bits, int stop_bits, bool use_v14, put_byte_func_t put_byte, void *user_data) |
Initialise an asynchronous data receiver context. More... | |
int | async_rx_release (async_rx_state_t *s) |
int | async_rx_free (async_rx_state_t *s) |
void | async_tx_presend_bits (async_tx_state_t *s, int bits) |
Set a minimum number of bit times of stop bit state before character transmission commences. More... | |
int | async_tx_get_bit (void *user_data) |
Get the next bit of a transmitted serial bit stream. More... | |
async_tx_state_t * | async_tx_init (async_tx_state_t *s, int data_bits, int parity_bits, int stop_bits, bool use_v14, get_byte_func_t get_byte, void *user_data) |
Initialise an asynchronous data transmit context. More... | |
int | async_tx_release (async_tx_state_t *s) |
int | async_tx_free (async_tx_state_t *s) |
typedef struct async_rx_state_s async_rx_state_t |
Asynchronous data receive descriptor. This defines the state of a single working instance of an asynchronous serial to byte converter, for use in FSK modems.
typedef struct async_tx_state_s async_tx_state_t |
Asynchronous data transmit descriptor. This defines the state of a single working instance of a byte to asynchronous serial converter, for use in FSK modems.
typedef int(* get_bit_func_t) (void *user_data) |
Bit get function for data pumps
typedef int(* get_byte_func_t) (void *user_data) |
Byte get function for data pumps
typedef int(* get_msg_func_t) (void *user_data, uint8_t *msg, int max_len) |
Message get function for data pumps
typedef void(* modem_status_func_t) (void *user_data, int status) |
Status change callback function for data pumps
typedef void(* put_bit_func_t) (void *user_data, int bit) |
Bit put function for data pumps
typedef void(* put_byte_func_t) (void *user_data, int byte) |
Byte put function for data pumps
typedef void(* put_msg_func_t) (void *user_data, const uint8_t *msg, int len) |
Message put function for data pumps
anonymous enum |
Special "bit" values for the bitstream put and get functions, and the signal status functions.
anonymous enum |
async_rx_state_t* async_rx_init | ( | async_rx_state_t * | s, |
int | data_bits, | ||
int | parity_bits, | ||
int | stop_bits, | ||
bool | use_v14, | ||
put_byte_func_t | put_byte, | ||
void * | user_data | ||
) |
Initialise an asynchronous data receiver context.
Initialise an asynchronous data receiver context.
s | The receiver context. |
data_bits | The number of data bits. |
parity_bits | The type of parity. |
stop_bits | The number of stop bits. |
use_v14 | True if V.14 rate adaption processing should be used. |
put_byte | The callback routine used to put the received data. |
user_data | An opaque pointer. |
void async_rx_put_bit | ( | void * | user_data, |
int | bit | ||
) |
Accept a bit from a received serial bit stream.
Accept a bit from a received serial bit stream
user_data | An opaque point which must point to a receiver context. |
bit | The new bit. Some special values are supported for this field.
|
References ASYNC_PARITY_ODD, async_rx_state_s::bitpos, async_rx_state_s::byte_in_progress, async_rx_state_s::data_bits, async_rx_state_s::framing_errors, async_rx_state_s::parity, async_rx_state_s::parity_bit, async_rx_state_s::parity_errors, async_rx_state_s::put_byte, SIG_STATUS_CARRIER_DOWN, SIG_STATUS_CARRIER_UP, SIG_STATUS_END_OF_DATA, SIG_STATUS_TRAINING_FAILED, SIG_STATUS_TRAINING_IN_PROGRESS, SIG_STATUS_TRAINING_SUCCEEDED, async_rx_state_s::use_v14, and async_rx_state_s::user_data.
int async_tx_get_bit | ( | void * | user_data | ) |
Get the next bit of a transmitted serial bit stream.
Get the next bit of a transmitted serial bit stream.
user_data | An opaque point which must point to a transmitter context. |
References ASYNC_PARITY_NONE, async_tx_state_s::bitpos, async_tx_state_s::byte_in_progress, async_tx_state_s::data_bits, async_tx_state_s::get_byte, async_tx_state_s::parity, async_tx_state_s::presend_bits, SIG_STATUS_LINK_IDLE, and async_tx_state_s::user_data.
async_tx_state_t* async_tx_init | ( | async_tx_state_t * | s, |
int | data_bits, | ||
int | parity_bits, | ||
int | stop_bits, | ||
bool | use_v14, | ||
get_byte_func_t | get_byte, | ||
void * | user_data | ||
) |
Initialise an asynchronous data transmit context.
Initialise an asynchronous data transmit context.
s | The transmitter context. |
data_bits | The number of data bit. |
parity_bits | The type of parity. |
stop_bits | The number of stop bits. |
use_v14 | True if V.14 rate adaption processing should be used. |
get_byte | The callback routine used to get the data to be transmitted. |
user_data | An opaque pointer. |
void async_tx_presend_bits | ( | async_tx_state_t * | s, |
int | bits | ||
) |
Set a minimum number of bit times of stop bit state before character transmission commences.
Set a minimum number of bit times of stop bit state before character transmission commences.
user_data | An opaque point which must point to a transmitter context. |
the | number of bits. |
const char* signal_status_to_str | ( | int | status | ) |
Convert a signal status to a short text description.
Convert a signal status to a short text description.
status | The modem signal status. |
References SIG_STATUS_ABORT, SIG_STATUS_BREAK, SIG_STATUS_CARRIER_DOWN, SIG_STATUS_CARRIER_UP, SIG_STATUS_END_OF_DATA, SIG_STATUS_FRAMING_OK, SIG_STATUS_LINK_CONNECTED, SIG_STATUS_LINK_DISCONNECTED, SIG_STATUS_LINK_ERROR, SIG_STATUS_LINK_IDLE, SIG_STATUS_MODEM_RETRAIN_OCCURRED, SIG_STATUS_OCTET_REPORT, SIG_STATUS_POOR_SIGNAL_QUALITY, SIG_STATUS_SHUTDOWN_COMPLETE, SIG_STATUS_TRAINING_FAILED, SIG_STATUS_TRAINING_IN_PROGRESS, and SIG_STATUS_TRAINING_SUCCEEDED.