00001 /* 00002 * SpanDSP - a series of DSP components for telephony 00003 * 00004 * async.h - Asynchronous serial bit stream encoding and decoding 00005 * 00006 * Written by Steve Underwood <steveu@coppice.org> 00007 * 00008 * Copyright (C) 2003 Steve Underwood 00009 * 00010 * All rights reserved. 00011 * 00012 * This program is free software; you can redistribute it and/or modify 00013 * it under the terms of the GNU Lesser General Public License version 2.1, 00014 * as published by the Free Software Foundation. 00015 * 00016 * This program is distributed in the hope that it will be useful, 00017 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00019 * GNU Lesser General Public License for more details. 00020 * 00021 * You should have received a copy of the GNU Lesser General Public 00022 * License along with this program; if not, write to the Free Software 00023 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00024 * 00025 * $Id: async.h,v 1.18 2008/09/07 12:45:17 steveu Exp $ 00026 */ 00027 00028 /*! \file */ 00029 00030 /*! \page async_page Asynchronous bit stream processing 00031 \section async_page_sec_1 What does it do? 00032 The asynchronous serial bit stream processing module provides 00033 generation and decoding facilities for most asynchronous data 00034 formats. It supports: 00035 - 1 or 2 stop bits. 00036 - Odd, even or no parity. 00037 - 5, 6, 7, or 8 bit characters. 00038 - V.14 rate adaption. 00039 The input to this module is a bit stream. This means any symbol synchronisation 00040 and decoding must occur before data is fed to this module. 00041 00042 \section async_page_sec_2 The transmitter 00043 ???. 00044 00045 \section async_page_sec_3 The receiver 00046 ???. 00047 */ 00048 00049 #if !defined(_SPANDSP_ASYNC_H_) 00050 #define _SPANDSP_ASYNC_H_ 00051 00052 /*! Special "bit" values for the bitstream put and get functions, and the signal status functions. */ 00053 enum 00054 { 00055 /*! \brief The carrier signal has dropped. */ 00056 SIG_STATUS_CARRIER_DOWN = -1, 00057 /*! \brief The carrier signal is up. This merely indicates that carrier 00058 energy has been seen. It is not an indication that the carrier is either 00059 valid, or of the expected type. */ 00060 SIG_STATUS_CARRIER_UP = -2, 00061 /*! \brief The modem is training. This is an early indication that the 00062 signal seems to be of the right type. This may be needed in time critical 00063 applications, like T.38, to forward an early indication of what is happening 00064 on the wire. */ 00065 SIG_STATUS_TRAINING_IN_PROGRESS = -3, 00066 /*! \brief The modem has trained, and is ready for data exchange. */ 00067 SIG_STATUS_TRAINING_SUCCEEDED = -4, 00068 /*! \brief The modem has failed to train. */ 00069 SIG_STATUS_TRAINING_FAILED = -5, 00070 /*! \brief Packet framing (e.g. HDLC framing) is OK. */ 00071 SIG_STATUS_FRAMING_OK = -6, 00072 /*! \brief The data stream has ended. */ 00073 SIG_STATUS_END_OF_DATA = -7, 00074 /*! \brief An abort signal (e.g. an HDLC abort) has been received. */ 00075 SIG_STATUS_ABORT = -8, 00076 /*! \brief A break signal (e.g. an async break) has been received. */ 00077 SIG_STATUS_BREAK = -9, 00078 /*! \brief A modem has completed its task, and shut down. */ 00079 SIG_STATUS_SHUTDOWN_COMPLETE = -10, 00080 /*! \brief Regular octet report for things like HDLC to the MTP standards. */ 00081 SIG_STATUS_OCTET_REPORT = -11 00082 }; 00083 00084 /*! Message put function for data pumps */ 00085 typedef void (*put_msg_func_t)(void *user_data, const uint8_t *msg, int len); 00086 00087 /*! Message get function for data pumps */ 00088 typedef int (*get_msg_func_t)(void *user_data, uint8_t *msg, int max_len); 00089 00090 /*! Byte put function for data pumps */ 00091 typedef void (*put_byte_func_t)(void *user_data, int byte); 00092 00093 /*! Byte get function for data pumps */ 00094 typedef int (*get_byte_func_t)(void *user_data); 00095 00096 /*! Bit put function for data pumps */ 00097 typedef void (*put_bit_func_t)(void *user_data, int bit); 00098 00099 /*! Bit get function for data pumps */ 00100 typedef int (*get_bit_func_t)(void *user_data); 00101 00102 /*! Completion callback function for tx data pumps */ 00103 typedef int (*modem_tx_status_func_t)(void *user_data, int status); 00104 00105 /*! Completion callback function for rx data pumps */ 00106 typedef int (*modem_rx_status_func_t)(void *user_data, int status); 00107 00108 enum 00109 { 00110 /*! No parity bit should be used */ 00111 ASYNC_PARITY_NONE = 0, 00112 /*! An even parity bit will exist, after the data bits */ 00113 ASYNC_PARITY_EVEN, 00114 /*! An odd parity bit will exist, after the data bits */ 00115 ASYNC_PARITY_ODD 00116 }; 00117 00118 /*! 00119 Asynchronous data transmit descriptor. This defines the state of a single 00120 working instance of a byte to asynchronous serial converter, for use 00121 in FSK modems. 00122 */ 00123 typedef struct 00124 { 00125 /*! \brief The number of data bits per character. */ 00126 int data_bits; 00127 /*! \brief The type of parity. */ 00128 int parity; 00129 /*! \brief The number of stop bits per character. */ 00130 int stop_bits; 00131 /*! \brief A pointer to the callback routine used to get characters to be transmitted. */ 00132 get_byte_func_t get_byte; 00133 /*! \brief An opaque pointer passed when calling get_byte. */ 00134 void *user_data; 00135 00136 /*! \brief A current, partially transmitted, character. */ 00137 int byte_in_progress; 00138 /*! \brief The current bit position within a partially transmitted character. */ 00139 int bitpos; 00140 /*! \brief Parity bit. */ 00141 int parity_bit; 00142 } async_tx_state_t; 00143 00144 /*! 00145 Asynchronous data receive descriptor. This defines the state of a single 00146 working instance of an asynchronous serial to byte converter, for use 00147 in FSK modems. 00148 */ 00149 typedef struct 00150 { 00151 /*! \brief The number of data bits per character. */ 00152 int data_bits; 00153 /*! \brief The type of parity. */ 00154 int parity; 00155 /*! \brief The number of stop bits per character. */ 00156 int stop_bits; 00157 /*! \brief TRUE if V.14 rate adaption processing should be performed. */ 00158 int use_v14; 00159 /*! \brief A pointer to the callback routine used to handle received characters. */ 00160 put_byte_func_t put_byte; 00161 /*! \brief An opaque pointer passed when calling put_byte. */ 00162 void *user_data; 00163 00164 /*! \brief A current, partially complete, character. */ 00165 int byte_in_progress; 00166 /*! \brief The current bit position within a partially complete character. */ 00167 int bitpos; 00168 /*! \brief Parity bit. */ 00169 int parity_bit; 00170 00171 /*! A count of the number of parity errors seen. */ 00172 int parity_errors; 00173 /*! A count of the number of character framing errors seen. */ 00174 int framing_errors; 00175 } async_rx_state_t; 00176 00177 #if defined(__cplusplus) 00178 extern "C" 00179 { 00180 #endif 00181 00182 /*! Convert a signal status to a short text description. 00183 \brief Convert a signal status to a short text description. 00184 \param status The modem signal status. 00185 \return A pointer to the description. */ 00186 const char *signal_status_to_str(int status); 00187 00188 /*! Initialise an asynchronous data transmit context. 00189 \brief Initialise an asynchronous data transmit context. 00190 \param s The transmitter context. 00191 \param data_bits The number of data bit. 00192 \param parity_bits The type of parity. 00193 \param stop_bits The number of stop bits. 00194 \param use_v14 TRUE if V.14 rate adaption processing should be used. 00195 \param get_byte The callback routine used to get the data to be transmitted. 00196 \param user_data An opaque pointer. 00197 \return A pointer to the initialised context, or NULL if there was a problem. */ 00198 async_tx_state_t *async_tx_init(async_tx_state_t *s, 00199 int data_bits, 00200 int parity_bits, 00201 int stop_bits, 00202 int use_v14, 00203 get_byte_func_t get_byte, 00204 void *user_data); 00205 00206 /*! Get the next bit of a transmitted serial bit stream. 00207 \brief Get the next bit of a transmitted serial bit stream. 00208 \param user_data An opaque point which must point to a transmitter context. 00209 \return the next bit, or PUTBIT_END_OF_DATA to indicate the data stream has ended. */ 00210 int async_tx_get_bit(void *user_data); 00211 00212 /*! Initialise an asynchronous data receiver context. 00213 \brief Initialise an asynchronous data receiver context. 00214 \param s The receiver context. 00215 \param data_bits The number of data bits. 00216 \param parity_bits The type of parity. 00217 \param stop_bits The number of stop bits. 00218 \param use_v14 TRUE if V.14 rate adaption processing should be used. 00219 \param put_byte The callback routine used to put the received data. 00220 \param user_data An opaque pointer. 00221 \return A pointer to the initialised context, or NULL if there was a problem. */ 00222 async_rx_state_t *async_rx_init(async_rx_state_t *s, 00223 int data_bits, 00224 int parity_bits, 00225 int stop_bits, 00226 int use_v14, 00227 put_byte_func_t put_byte, 00228 void *user_data); 00229 00230 /*! Accept a bit from a received serial bit stream 00231 \brief Accept a bit from a received serial bit stream 00232 \param user_data An opaque point which must point to a receiver context. 00233 \param bit The new bit. Some special values are supported for this field. 00234 - SIG_STATUS_CARRIER_UP 00235 - SIG_STATUS_CARRIER_DOWN 00236 - SIG_STATUS_TRAINING_SUCCEEDED 00237 - SIG_STATUS_TRAINING_FAILED 00238 - SIG_STATUS_END_OF_DATA */ 00239 void async_rx_put_bit(void *user_data, int bit); 00240 00241 #if defined(__cplusplus) 00242 } 00243 #endif 00244 00245 #endif 00246 /*- End of file ------------------------------------------------------------*/