ChibiOS/RT Architecture - Reference Manual - Guides |
00001 /* 00002 ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio. 00003 00004 This file is part of ChibiOS/RT. 00005 00006 ChibiOS/RT is free software; you can redistribute it and/or modify 00007 it under the terms of the GNU General Public License as published by 00008 the Free Software Foundation; either version 3 of the License, or 00009 (at your option) any later version. 00010 00011 ChibiOS/RT is distributed in the hope that it will be useful, 00012 but WITHOUT ANY WARRANTY; without even the implied warranty of 00013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00014 GNU General Public License for more details. 00015 00016 You should have received a copy of the GNU General Public License 00017 along with this program. If not, see <http://www.gnu.org/licenses/>. 00018 00019 --- 00020 00021 A special exception to the GPL can be applied should you wish to distribute 00022 a combined work that includes ChibiOS/RT, without being obliged to provide 00023 the source code for any proprietary components. See the file exception.txt 00024 for full details of how and when the exception can be applied. 00025 */ 00026 00027 /** 00028 * @file templates/serial_lld.h 00029 * @brief Serial Driver subsystem low level driver header template. 00030 * 00031 * @addtogroup SERIAL_LLD 00032 * @{ 00033 */ 00034 00035 #ifndef _SERIAL_LLD_H_ 00036 #define _SERIAL_LLD_H_ 00037 00038 #if CH_HAL_USE_SERIAL || defined(__DOXYGEN__) 00039 00040 /*===========================================================================*/ 00041 /* Driver constants. */ 00042 /*===========================================================================*/ 00043 00044 /*===========================================================================*/ 00045 /* Driver pre-compile time settings. */ 00046 /*===========================================================================*/ 00047 00048 /*===========================================================================*/ 00049 /* Derived constants and error checks. */ 00050 /*===========================================================================*/ 00051 00052 /*===========================================================================*/ 00053 /* Driver data structures and types. */ 00054 /*===========================================================================*/ 00055 00056 /** 00057 * @brief Serial Driver condition flags type. 00058 */ 00059 typedef uint8_t sdflags_t; 00060 00061 /** 00062 * @brief Generic Serial Driver configuration structure. 00063 * @details An instance of this structure must be passed to @p sdStart() 00064 * in order to configure and start a serial driver operations. 00065 * @note This structure content is architecture dependent, each driver 00066 * implementation defines its own version and the custom static 00067 * initializers. 00068 */ 00069 typedef struct { 00070 00071 } SerialConfig; 00072 00073 /** 00074 * @brief @p SerialDriver specific data. 00075 */ 00076 #define _serial_driver_data \ 00077 _base_asynchronous_channel_data \ 00078 /* Driver state.*/ \ 00079 sdstate_t state; \ 00080 /* Input queue.*/ \ 00081 InputQueue iqueue; \ 00082 /* Output queue.*/ \ 00083 OutputQueue oqueue; \ 00084 /* Status Change @p EventSource.*/ \ 00085 EventSource sevent; \ 00086 /* I/O driver status flags.*/ \ 00087 sdflags_t flags; \ 00088 /* Input circular buffer.*/ \ 00089 uint8_t ib[SERIAL_BUFFERS_SIZE]; \ 00090 /* Output circular buffer.*/ \ 00091 uint8_t ob[SERIAL_BUFFERS_SIZE]; \ 00092 /* End of the mandatory fields.*/ 00093 00094 /*===========================================================================*/ 00095 /* Driver macros. */ 00096 /*===========================================================================*/ 00097 00098 /*===========================================================================*/ 00099 /* External declarations. */ 00100 /*===========================================================================*/ 00101 00102 #ifdef __cplusplus 00103 extern "C" { 00104 #endif 00105 void sd_lld_init(void); 00106 void sd_lld_start(SerialDriver *sdp, const SerialConfig *config); 00107 void sd_lld_stop(SerialDriver *sdp); 00108 #ifdef __cplusplus 00109 } 00110 #endif 00111 00112 #endif /* CH_HAL_USE_SERIAL */ 00113 00114 #endif /* _SERIAL_LLD_H_ */ 00115 00116 /** @} */