2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: serial.h Source File< / title >
< link href = "custom.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< table style = "text-align: center; width: 100%;" border = "0"
cellpadding="2" cellspacing="2">
< tbody >
< tr >
< td style = "width: 80px;" > < img alt = "ChibiOS/RT Logo" src = "logo_small.png" > < / td >
< td > < big > < big > ChibiOS/RT< / big > < / big > < br > < br > Architecture - Reference Manual - Guides< / td >
< td style = "width: 80px;" > < / td >
< / tr >
< / tbody >
< / table >
< hr size = "1" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data Structures< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "headertitle" >
< h1 > serial.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "serial_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < pre class = "fragment" > < a name = "l00001" > < / a > 00001 < span class = "comment" > /*< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00002" > < / a > 00002 < span class = "comment" > ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.< / span >
< a name = "l00003" > < / a > 00003 < span class = "comment" > < / span >
< a name = "l00004" > < / a > 00004 < span class = "comment" > This file is part of ChibiOS/RT.< / span >
< a name = "l00005" > < / a > 00005 < span class = "comment" > < / span >
< a name = "l00006" > < / a > 00006 < span class = "comment" > ChibiOS/RT is free software; you can redistribute it and/or modify< / span >
< a name = "l00007" > < / a > 00007 < span class = "comment" > it under the terms of the GNU General Public License as published by< / span >
< a name = "l00008" > < / a > 00008 < span class = "comment" > the Free Software Foundation; either version 3 of the License, or< / span >
< a name = "l00009" > < / a > 00009 < span class = "comment" > (at your option) any later version.< / span >
< a name = "l00010" > < / a > 00010 < span class = "comment" > < / span >
< a name = "l00011" > < / a > 00011 < span class = "comment" > ChibiOS/RT is distributed in the hope that it will be useful,< / span >
< a name = "l00012" > < / a > 00012 < span class = "comment" > but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< a name = "l00013" > < / a > 00013 < span class = "comment" > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< a name = "l00014" > < / a > 00014 < span class = "comment" > GNU General Public License for more details.< / span >
< a name = "l00015" > < / a > 00015 < span class = "comment" > < / span >
< a name = "l00016" > < / a > 00016 < span class = "comment" > You should have received a copy of the GNU General Public License< / span >
< a name = "l00017" > < / a > 00017 < span class = "comment" > along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< a name = "l00018" > < / a > 00018 < span class = "comment" > < / span >
< a name = "l00019" > < / a > 00019 < span class = "comment" > ---< / span >
< a name = "l00020" > < / a > 00020 < span class = "comment" > < / span >
< a name = "l00021" > < / a > 00021 < span class = "comment" > A special exception to the GPL can be applied should you wish to distribute< / span >
< a name = "l00022" > < / a > 00022 < span class = "comment" > a combined work that includes ChibiOS/RT, without being obliged to provide< / span >
< a name = "l00023" > < / a > 00023 < span class = "comment" > the source code for any proprietary components. See the file exception.txt< / span >
< a name = "l00024" > < / a > 00024 < span class = "comment" > for full details of how and when the exception can be applied.< / span >
< a name = "l00025" > < / a > 00025 < span class = "comment" > */< / span >
< a name = "l00026" > < / a > 00026 < span class = "comment" > < / span >
< a name = "l00027" > < / a > 00027 < span class = "comment" > /**< / span >
< a name = "l00028" > < / a > 00028 < span class = "comment" > * @file serial.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief Serial Driver macros and structures.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > *< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @addtogroup SERIAL< / span >
< a name = "l00032" > < / a > 00032 < span class = "comment" > * @{< / span >
< a name = "l00033" > < / a > 00033 < span class = "comment" > */< / span >
< a name = "l00034" > < / a > 00034
< a name = "l00035" > < / a > 00035 < span class = "preprocessor" > #ifndef _SERIAL_H_< / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _SERIAL_H_< / span >
< a name = "l00037" > < / a > 00037 < span class = "preprocessor" > < / span >
< a name = "l00038" > < / a > 00038 < span class = "preprocessor" > #if CH_HAL_USE_SERIAL || defined(__DOXYGEN__)< / span >
< a name = "l00039" > < / a > 00039 < span class = "preprocessor" > < / span >
< a name = "l00040" > < / a > 00040 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00041" > < / a > 00041 < span class = "comment" > /* Driver constants. */< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00043" > < / a > 00043 < span class = "comment" > < / span >
< a name = "l00044" > < / a > 00044 < span class = "comment" > /** @brief No pending conditions.*/< / span >
< a name = "l00045" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga56fc0a34c0ee335a69d11fe30ed8a2e0" > 00045< / a > < span class = "preprocessor" > #define SD_NO_ERROR 0< / span >
< a name = "l00046" > < / a > 00046 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Connection happened.*/< / span >
< a name = "l00047" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaa716ccba8eb87a3127b708663e1d438f" > 00047< / a > < span class = "preprocessor" > #define SD_CONNECTED 1< / span >
< a name = "l00048" > < / a > 00048 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Disconnection happened.*/< / span >
< a name = "l00049" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga1a90a24e696d87b88a4f77eef548613f" > 00049< / a > < span class = "preprocessor" > #define SD_DISCONNECTED 2< / span >
< a name = "l00050" > < / a > 00050 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Parity error happened.*/< / span >
< a name = "l00051" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaea2ed33849e81938625ab89472b4e9ae" > 00051< / a > < span class = "preprocessor" > #define SD_PARITY_ERROR 4< / span >
< a name = "l00052" > < / a > 00052 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Framing error happened.*/< / span >
< a name = "l00053" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga37ff96a3330ec22499379d20a6b5f2dd" > 00053< / a > < span class = "preprocessor" > #define SD_FRAMING_ERROR 8< / span >
< a name = "l00054" > < / a > 00054 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Overflow happened.*/< / span >
< a name = "l00055" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga81b11923717a67da5a0b8177821fcad2" > 00055< / a > < span class = "preprocessor" > #define SD_OVERRUN_ERROR 16< / span >
< a name = "l00056" > < / a > 00056 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Noise on the line.*/< / span >
< a name = "l00057" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaa6ff7a9422b9d43ab5c2ea19c56b0a63" > 00057< / a > < span class = "preprocessor" > #define SD_NOISE_ERROR 32< / span >
< a name = "l00058" > < / a > 00058 < span class = "preprocessor" > < / span > < span class = "comment" > /** @brief Break detected.*/< / span >
< a name = "l00059" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga3afb64a86fe9075b117b995e4ba8ce31" > 00059< / a > < span class = "preprocessor" > #define SD_BREAK_DETECTED 64< / span >
< a name = "l00060" > < / a > 00060 < span class = "preprocessor" > < / span >
< a name = "l00061" > < / a > 00061 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00062" > < / a > 00062 < span class = "comment" > /* Driver pre-compile time settings. */< / span >
< a name = "l00063" > < / a > 00063 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > < / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > /**< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > * @brief Default bit rate.< / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > * @details Configuration parameter, this is the baud rate selected for the< / span >
< a name = "l00068" > < / a > 00068 < span class = "comment" > * default configuration.< / span >
< a name = "l00069" > < / a > 00069 < span class = "comment" > */< / span >
< a name = "l00070" > < / a > 00070 < span class = "preprocessor" > #if !defined(SERIAL_DEFAULT_BITRATE) || defined(__DOXYGEN__)< / span >
< a name = "l00071" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gacb4c08ac23f83ac9d58c50ff840de516" > 00071< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define SERIAL_DEFAULT_BITRATE 38400< / span >
< a name = "l00072" > < / a > 00072 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00073" > < / a > 00073 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00074" > < / a > 00074 < span class = "comment" > /**< / span >
< a name = "l00075" > < / a > 00075 < span class = "comment" > * @brief Serial buffers size.< / span >
< a name = "l00076" > < / a > 00076 < span class = "comment" > * @details Configuration parameter, you can change the depth of the queue< / span >
< a name = "l00077" > < / a > 00077 < span class = "comment" > * buffers depending on the requirements of your application.< / span >
< a name = "l00078" > < / a > 00078 < span class = "comment" > * @note The default is 64 bytes for both the transmission and receive< / span >
< a name = "l00079" > < / a > 00079 < span class = "comment" > * buffers.< / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > */< / span >
< a name = "l00081" > < / a > 00081 < span class = "preprocessor" > #if !defined(SERIAL_BUFFERS_SIZE) || defined(__DOXYGEN__)< / span >
< a name = "l00082" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga81a9fb00c7a1ce0fe70f263d8fd820e8" > 00082< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define SERIAL_BUFFERS_SIZE 64< / span >
< a name = "l00083" > < / a > 00083 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00084" > < / a > 00084 < span class = "preprocessor" > < / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > /* Derived constants and error checks. */< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00088" > < / a > 00088
< a name = "l00089" > < / a > 00089 < span class = "preprocessor" > #if !CH_USE_QUEUES & & !CH_USE_EVENTS< / span >
< a name = "l00090" > < / a > 00090 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #error " Serial Driver requires CH_USE_QUEUES and CH_USE_EVENTS" < / span >
< a name = "l00091" > < / a > 00091 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00092" > < / a > 00092 < span class = "preprocessor" > < / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > /* Driver data structures and types. */< / span >
< a name = "l00095" > < / a > 00095 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > < / span >
< a name = "l00097" > < / a > 00097 < span class = "comment" > /**< / span >
< a name = "l00098" > < / a > 00098 < span class = "comment" > * @brief Driver state machine possible states.< / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > */< / span >
< a name = "l00100" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gad8e84bab9ea5bf7950609d7eef6dfb30" > 00100< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > enum< / span > {
< a name = "l00101" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30acf0d735afaadcde539d808f624f6c0ba" > 00101< / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30acf0d735afaadcde539d808f624f6c0ba" title = "Not initialized." > SD_UNINIT< / a > = 0, < span class = "comment" > /**< @brief Not initialized. */< / span >
< a name = "l00102" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a24eb3687f039e6d59fae930b4ae5ae3b" > 00102< / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a24eb3687f039e6d59fae930b4ae5ae3b" title = "Stopped." > SD_STOP< / a > = 1, < span class = "comment" > /**< @brief Stopped. */< / span >
< a name = "l00103" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a5fa247b8f9749cc93f07a385b6ab580d" > 00103< / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ggad8e84bab9ea5bf7950609d7eef6dfb30a5fa247b8f9749cc93f07a385b6ab580d" title = "Ready." > SD_READY< / a > = 2 < span class = "comment" > /**< @brief Ready. */< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00104" > < / a > 00104 } sdstate_t;
2010-08-10 03:11:02 +00:00
< a name = "l00105" > < / a > 00105 < span class = "comment" > < / span >
< a name = "l00106" > < / a > 00106 < span class = "comment" > /**< / span >
< a name = "l00107" > < / a > 00107 < span class = "comment" > * @brief Structure representing a serial driver.< / span >
< a name = "l00108" > < / a > 00108 < span class = "comment" > */< / span >
< a name = "l00109" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gac607f80e688d206727a6787e393be557" > 00109< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > < a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > _SerialDriver< / a > < a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > ;
< a name = "l00110" > < / a > 00110
< a name = "l00111" > < / a > 00111 < span class = "preprocessor" > #include " < a class = "code" href = "platforms_2_s_t_m8_2serial__lld_8h.html" title = "STM8 low level serial driver header." > serial_lld.h< / a > " < / span >
< a name = "l00112" > < / a > 00112 < span class = "comment" > < / span >
< a name = "l00113" > < / a > 00113 < span class = "comment" > /**< / span >
< a name = "l00114" > < / a > 00114 < span class = "comment" > * @brief @p SerialDriver specific methods.< / span >
< a name = "l00115" > < / a > 00115 < span class = "comment" > */< / span >
< a name = "l00116" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga78e2c1babc764f78a25f8a6a6622060b" > 00116< / a > < span class = "preprocessor" > #define _serial_driver_methods \< / span >
< a name = "l00117" > < / a > 00117 < span class = "preprocessor" > _base_asynchronous_channel_methods< / span >
< a name = "l00118" > < / a > 00118 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00119" > < / a > 00119 < span class = "comment" > /**< / span >
< a name = "l00120" > < / a > 00120 < span class = "comment" > * @brief @p SerialDriver virtual methods table.< / span >
< a name = "l00121" > < / a > 00121 < span class = "comment" > */< / span >
< a name = "l00122" > < / a > < a class = "code" href = "struct_serial_driver_v_m_t.html" > 00122< / a > < span class = "keyword" > struct < / span > < a class = "code" href = "struct_serial_driver_v_m_t.html" title = "SerialDriver virtual methods table." > SerialDriverVMT< / a > {
< a name = "l00123" > < / a > 00123 < a class = "code" href = "group___s_e_r_i_a_l.html#ga78e2c1babc764f78a25f8a6a6622060b" title = "SerialDriver specific methods." > _serial_driver_methods< / a >
< a name = "l00124" > < / a > 00124 };
< a name = "l00125" > < / a > 00125 < span class = "comment" > < / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > /**< / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > * @extends BaseAsynchronousChannel< / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > *< / span >
< a name = "l00129" > < / a > 00129 < span class = "comment" > * @brief Full duplex serial driver class.< / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > * @details This class extends @p BaseAsynchronousChannel by adding physical< / span >
< a name = "l00131" > < / a > 00131 < span class = "comment" > * I/O queues.< / span >
< a name = "l00132" > < / a > 00132 < span class = "comment" > */< / span >
< a name = "l00133" > < / a > < a class = "code" href = "struct___serial_driver.html" > 00133< / a > < span class = "keyword" > struct < / span > < a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > _SerialDriver< / a > {< span class = "comment" > < / span >
< a name = "l00134" > < / a > 00134 < span class = "comment" > /** @brief Virtual Methods Table.*/< / span >
< a name = "l00135" > < / a > < a class = "code" href = "struct___serial_driver.html#ae654d641d6bfa9caeac49628d6df7c13" > 00135< / a > < span class = "keyword" > const< / span > < span class = "keyword" > struct < / span > < a class = "code" href = "struct_serial_driver_v_m_t.html" title = "SerialDriver virtual methods table." > SerialDriverVMT< / a > *< a class = "code" href = "struct___serial_driver.html#ae654d641d6bfa9caeac49628d6df7c13" title = "Virtual Methods Table." > vmt< / a > ;
< a name = "l00136" > < / a > 00136 < a class = "code" href = "group___s_e_r_i_a_l___l_l_d.html#ga67646cd26778a2b775d9875f95fa5a8e" title = "SerialDriver specific data." > _serial_driver_data< / a >
< a name = "l00137" > < / a > 00137 };
< a name = "l00138" > < / a > 00138
< a name = "l00139" > < / a > 00139 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > /* Driver macros. */< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > < / span >
< a name = "l00143" > < / a > 00143 < span class = "comment" > /**< / span >
< a name = "l00144" > < / a > 00144 < span class = "comment" > * @brief Direct output check on a @p SerialDriver.< / span >
< a name = "l00145" > < / a > 00145 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00146" > < / a > 00146 < span class = "comment" > * checks directly the output queue. This is faster but cannot< / span >
< a name = "l00147" > < / a > 00147 < span class = "comment" > * be used to check different channels implementations.< / span >
< a name = "l00148" > < / a > 00148 < span class = "comment" > *< / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > * @see chIOPutWouldBlock()< / span >
< a name = "l00150" > < / a > 00150 < span class = "comment" > */< / span >
< a name = "l00151" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga0cf7aa943b9c41f08fb802387a11c2e1" > 00151< / a > < span class = "preprocessor" > #define sdPutWouldBlock(sdp) chOQIsFull(& (sdp)-> oqueue)< / span >
< a name = "l00152" > < / a > 00152 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00153" > < / a > 00153 < span class = "comment" > /**< / span >
< a name = "l00154" > < / a > 00154 < span class = "comment" > * @brief Direct input check on a @p SerialDriver.< / span >
< a name = "l00155" > < / a > 00155 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00156" > < / a > 00156 < span class = "comment" > * checks directly the input queue. This is faster but cannot< / span >
< a name = "l00157" > < / a > 00157 < span class = "comment" > * be used to check different channels implementations.< / span >
< a name = "l00158" > < / a > 00158 < span class = "comment" > *< / span >
< a name = "l00159" > < / a > 00159 < span class = "comment" > * @see chIOGetWouldBlock()< / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > */< / span >
< a name = "l00161" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga0cdc641d4d919c566b7683f8d39e927b" > 00161< / a > < span class = "preprocessor" > #define sdGetWouldBlock(sdp) chIQIsEmpty(& (sdp)-> iqueue)< / span >
< a name = "l00162" > < / a > 00162 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > /**< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > * @brief Direct write to a @p SerialDriver.< / span >
< a name = "l00165" > < / a > 00165 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00166" > < / a > 00166 < span class = "comment" > * writes directly on the output queue. This is faster but cannot< / span >
< a name = "l00167" > < / a > 00167 < span class = "comment" > * be used to write to different channels implementations.< / span >
< a name = "l00168" > < / a > 00168 < span class = "comment" > *< / span >
< a name = "l00169" > < / a > 00169 < span class = "comment" > * @see chIOPut()< / span >
< a name = "l00170" > < / a > 00170 < span class = "comment" > */< / span >
< a name = "l00171" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga9057c55c66a6ea7cf04da7a2fcc8157a" > 00171< / a > < span class = "preprocessor" > #define sdPut(sdp, b) chOQPut(& (sdp)-> oqueue, b)< / span >
< a name = "l00172" > < / a > 00172 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00173" > < / a > 00173 < span class = "comment" > /**< / span >
< a name = "l00174" > < / a > 00174 < span class = "comment" > * @brief Direct write to a @p SerialDriver with timeout specification.< / span >
< a name = "l00175" > < / a > 00175 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00176" > < / a > 00176 < span class = "comment" > * writes directly on the output queue. This is faster but cannot< / span >
< a name = "l00177" > < / a > 00177 < span class = "comment" > * be used to write to different channels implementations.< / span >
< a name = "l00178" > < / a > 00178 < span class = "comment" > *< / span >
< a name = "l00179" > < / a > 00179 < span class = "comment" > * @see chIOPutTimeout()< / span >
< a name = "l00180" > < / a > 00180 < span class = "comment" > */< / span >
< a name = "l00181" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga6aef1a3192eeb3d997dc427beedcdf8d" > 00181< / a > < span class = "preprocessor" > #define sdPutTimeout(sdp, b, t) chOQPutTimeout(& (sdp)-> iqueue, b, t)< / span >
< a name = "l00182" > < / a > 00182 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > /**< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > * @brief Direct read from a @p SerialDriver.< / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > * reads directly from the input queue. This is faster but cannot< / span >
< a name = "l00187" > < / a > 00187 < span class = "comment" > * be used to read from different channels implementations.< / span >
< a name = "l00188" > < / a > 00188 < span class = "comment" > *< / span >
< a name = "l00189" > < / a > 00189 < span class = "comment" > * @see chIOGet()< / span >
< a name = "l00190" > < / a > 00190 < span class = "comment" > */< / span >
< a name = "l00191" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gac488fbd6cbf34b6f4a67ca72ff523d16" > 00191< / a > < span class = "preprocessor" > #define sdGet(sdp) chIQGet(& (sdp)-> iqueue)< / span >
< a name = "l00192" > < / a > 00192 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00193" > < / a > 00193 < span class = "comment" > /**< / span >
< a name = "l00194" > < / a > 00194 < span class = "comment" > * @brief Direct read from a @p SerialDriver with timeout specification.< / span >
< a name = "l00195" > < / a > 00195 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00196" > < / a > 00196 < span class = "comment" > * reads directly from the input queue. This is faster but cannot< / span >
< a name = "l00197" > < / a > 00197 < span class = "comment" > * be used to read from different channels implementations.< / span >
< a name = "l00198" > < / a > 00198 < span class = "comment" > *< / span >
< a name = "l00199" > < / a > 00199 < span class = "comment" > * @see chIOGetTimeout()< / span >
< a name = "l00200" > < / a > 00200 < span class = "comment" > */< / span >
< a name = "l00201" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaf8dd6aa956079ada124f0994d1ac481d" > 00201< / a > < span class = "preprocessor" > #define sdGetTimeout(sdp, t) chIQGetTimeout(& (sdp)-> iqueue, t)< / span >
< a name = "l00202" > < / a > 00202 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00203" > < / a > 00203 < span class = "comment" > /**< / span >
< a name = "l00204" > < / a > 00204 < span class = "comment" > * @brief Direct blocking write to a @p SerialDriver.< / span >
< a name = "l00205" > < / a > 00205 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00206" > < / a > 00206 < span class = "comment" > * writes directly to the output queue. This is faster but cannot< / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > * be used to write from different channels implementations.< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > *< / span >
< a name = "l00209" > < / a > 00209 < span class = "comment" > * @see chIOWriteTimeout()< / span >
< a name = "l00210" > < / a > 00210 < span class = "comment" > */< / span >
< a name = "l00211" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga9b3aa2898a88d18fc148a60b9a5c3bc5" > 00211< / a > < span class = "preprocessor" > #define sdWrite(sdp, b, n) \< / span >
< a name = "l00212" > < / a > 00212 < span class = "preprocessor" > chOQWriteTimeout(& (sdp)-> oqueue, b, n, TIME_INFINITE)< / span >
< a name = "l00213" > < / a > 00213 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00214" > < / a > 00214 < span class = "comment" > /**< / span >
< a name = "l00215" > < / a > 00215 < span class = "comment" > * @brief Direct blocking write to a @p SerialDriver with timeout< / span >
< a name = "l00216" > < / a > 00216 < span class = "comment" > * specification.< / span >
< a name = "l00217" > < / a > 00217 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * writes directly to the output queue. This is faster but cannot< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > * be used to write from different channels implementations.< / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > *< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > * @see chIOWriteTimeout()< / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > */< / span >
< a name = "l00223" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaae6b1eb7a9ec11976b6751e68243cfc7" > 00223< / a > < span class = "preprocessor" > #define sdWriteTimeout(sdp, b, n, t) \< / span >
< a name = "l00224" > < / a > 00224 < span class = "preprocessor" > chOQWriteTimeout(& (sdp)-> oqueue, b, n, t)< / span >
< a name = "l00225" > < / a > 00225 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00226" > < / a > 00226 < span class = "comment" > /**< / span >
< a name = "l00227" > < / a > 00227 < span class = "comment" > * @brief Direct non-blocking write to a @p SerialDriver.< / span >
< a name = "l00228" > < / a > 00228 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00229" > < / a > 00229 < span class = "comment" > * writes directly to the output queue. This is faster but cannot< / span >
< a name = "l00230" > < / a > 00230 < span class = "comment" > * be used to write from different channels implementations.< / span >
< a name = "l00231" > < / a > 00231 < span class = "comment" > *< / span >
< a name = "l00232" > < / a > 00232 < span class = "comment" > * @see chIOWriteTimeout()< / span >
< a name = "l00233" > < / a > 00233 < span class = "comment" > */< / span >
< a name = "l00234" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga2b622febdd6b728eac6bad4a080d0d5d" > 00234< / a > < span class = "preprocessor" > #define sdAsynchronousWrite(sdp, b, n) \< / span >
< a name = "l00235" > < / a > 00235 < span class = "preprocessor" > chOQWriteTimeout(& (sdp)-> oqueue, b, n, TIME_IMMEDIATE)< / span >
< a name = "l00236" > < / a > 00236 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00237" > < / a > 00237 < span class = "comment" > /**< / span >
< a name = "l00238" > < / a > 00238 < span class = "comment" > * @brief Direct blocking read from a @p SerialDriver.< / span >
< a name = "l00239" > < / a > 00239 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00240" > < / a > 00240 < span class = "comment" > * reads directly from the input queue. This is faster but cannot< / span >
< a name = "l00241" > < / a > 00241 < span class = "comment" > * be used to read from different channels implementations.< / span >
< a name = "l00242" > < / a > 00242 < span class = "comment" > *< / span >
< a name = "l00243" > < / a > 00243 < span class = "comment" > * @see chIOReadTimeout()< / span >
< a name = "l00244" > < / a > 00244 < span class = "comment" > */< / span >
< a name = "l00245" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaea89c5fcd751ae186568961846dcb906" > 00245< / a > < span class = "preprocessor" > #define sdRead(sdp, b, n) \< / span >
< a name = "l00246" > < / a > 00246 < span class = "preprocessor" > chIQReadTimeout(& (sdp)-> iqueue, b, n, TIME_INFINITE)< / span >
< a name = "l00247" > < / a > 00247 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00248" > < / a > 00248 < span class = "comment" > /**< / span >
< a name = "l00249" > < / a > 00249 < span class = "comment" > * @brief Direct blocking read from a @p SerialDriver with timeout< / span >
< a name = "l00250" > < / a > 00250 < span class = "comment" > * specification.< / span >
< a name = "l00251" > < / a > 00251 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00252" > < / a > 00252 < span class = "comment" > * reads directly from the input queue. This is faster but cannot< / span >
< a name = "l00253" > < / a > 00253 < span class = "comment" > * be used to read from different channels implementations.< / span >
< a name = "l00254" > < / a > 00254 < span class = "comment" > *< / span >
< a name = "l00255" > < / a > 00255 < span class = "comment" > * @see chIOReadTimeout()< / span >
< a name = "l00256" > < / a > 00256 < span class = "comment" > */< / span >
< a name = "l00257" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gadf41849da5311ab1ef38ea77c896256a" > 00257< / a > < span class = "preprocessor" > #define sdReadTimeout(sdp, b, n, t) \< / span >
< a name = "l00258" > < / a > 00258 < span class = "preprocessor" > chIQReadTimeout(& (sdp)-> iqueue, b, n, t)< / span >
< a name = "l00259" > < / a > 00259 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00260" > < / a > 00260 < span class = "comment" > /**< / span >
< a name = "l00261" > < / a > 00261 < span class = "comment" > * @brief Direct non-blocking read from a @p SerialDriver.< / span >
< a name = "l00262" > < / a > 00262 < span class = "comment" > * @details This function bypasses the indirect access to the channel and< / span >
< a name = "l00263" > < / a > 00263 < span class = "comment" > * reads directly from the input queue. This is faster but cannot< / span >
< a name = "l00264" > < / a > 00264 < span class = "comment" > * be used to read from different channels implementations.< / span >
< a name = "l00265" > < / a > 00265 < span class = "comment" > *< / span >
< a name = "l00266" > < / a > 00266 < span class = "comment" > * @see chIOReadTimeout()< / span >
< a name = "l00267" > < / a > 00267 < span class = "comment" > */< / span >
< a name = "l00268" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga5819c5a2aff7cf43ec3caec38cf1dfa3" > 00268< / a > < span class = "preprocessor" > #define sdAsynchronousRead(sdp, b, n) \< / span >
< a name = "l00269" > < / a > 00269 < span class = "preprocessor" > chIQReadTimeout(& (sdp)-> iqueue, b, n, TIME_IMMEDIATE)< / span >
< a name = "l00270" > < / a > 00270 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00271" > < / a > 00271 < span class = "comment" > /**< / span >
< a name = "l00272" > < / a > 00272 < span class = "comment" > * @brief Returns the status change event source.< / span >
< a name = "l00273" > < / a > 00273 < span class = "comment" > * @details The status change event source is broadcasted when the channel< / span >
< a name = "l00274" > < / a > 00274 < span class = "comment" > * status is updated, the status flags can then be fetched and< / span >
< a name = "l00275" > < / a > 00275 < span class = "comment" > * cheared by using @p sdGetAndClearFlags().< / span >
< a name = "l00276" > < / a > 00276 < span class = "comment" > *< / span >
< a name = "l00277" > < / a > 00277 < span class = "comment" > * @param[in] ip pointer to a @p SerialDriver object< / span >
< a name = "l00278" > < / a > 00278 < span class = "comment" > * @return A pointer to an @p EventSource object.< / span >
< a name = "l00279" > < / a > 00279 < span class = "comment" > */< / span >
< a name = "l00280" > < / a > < a class = "code" href = "group___s_e_r_i_a_l.html#ga7a30bf824538dd707177902453292140" > 00280< / a > < span class = "preprocessor" > #define sdGetStatusChangeEventSource(ip) (& ((ip)-> vmt-> sevent))< / span >
< a name = "l00281" > < / a > 00281 < span class = "preprocessor" > < / span >
< a name = "l00282" > < / a > 00282 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00283" > < / a > 00283 < span class = "comment" > /* External declarations. */< / span >
< a name = "l00284" > < / a > 00284 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00285" > < / a > 00285
< a name = "l00286" > < / a > 00286 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00287" > < / a > 00287 < span class = "preprocessor" > < / span > < span class = "keyword" > extern< / span > < span class = "stringliteral" > " C" < / span > {
< a name = "l00288" > < / a > 00288 < span class = "preprocessor" > #endif< / span >
< a name = "l00289" > < / a > 00289 < span class = "preprocessor" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_e_r_i_a_l.html#gaced9c1cfde941c7614183b1c887e862b" title = "Serial Driver initialization." > sdInit< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00290" > < / a > 00290 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_e_r_i_a_l.html#gacb9838adcf51106f4e481f41a851cc34" title = "Initializes a generic full duplex driver object." > sdObjectInit< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp, < a class = "code" href = "group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title = "Queue notification callback type." > qnotify_t< / a > inotify, < a class = "code" href = "group__io__queues.html#ga7c6a6ab1d0d4999011cfee832ad1c8b5" title = "Queue notification callback type." > qnotify_t< / a > onotify);
< a name = "l00291" > < / a > 00291 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_e_r_i_a_l.html#ga5e77658b4f3b559927705dc8fbfbdfad" title = "Configures and starts the driver." > sdStart< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp, < span class = "keyword" > const< / span > < a class = "code" href = "struct_serial_config.html" title = "Generic Serial Driver configuration structure." > SerialConfig< / a > *config);
< a name = "l00292" > < / a > 00292 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_e_r_i_a_l.html#gacb106a30f8007afdf9eeaf8681dbd3cf" title = "Stops the driver." > sdStop< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp);
< a name = "l00293" > < / a > 00293 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_e_r_i_a_l.html#gac94544bc991e2b85a601459463604346" title = "Handles incoming data." > sdIncomingDataI< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp, < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5" > uint8_t< / a > b);
< a name = "l00294" > < / a > 00294 < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gafa1753aa30a6b79cc7e6de3e8a156fdc" title = "Handles outgoing data." > sdRequestDataI< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp);
< a name = "l00295" > < / a > 00295 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_e_r_i_a_l.html#ga6c0462b840ea6364ca266a8d3fcb0945" title = "Handles communication events/errors." > sdAddFlagsI< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp, < a class = "code" href = "group___s_e_r_i_a_l___l_l_d.html#gaf851732a0f47524edd346fe8ce24dcb8" title = "Serial Driver condition flags type." > sdflags_t< / a > mask);
< a name = "l00296" > < / a > 00296 < a class = "code" href = "group___s_e_r_i_a_l___l_l_d.html#gaf851732a0f47524edd346fe8ce24dcb8" title = "Serial Driver condition flags type." > sdflags_t< / a > < a class = "code" href = "group___s_e_r_i_a_l.html#gaa83db03502662f959e29b9fae964512d" title = "Returns and clears the errors mask associated to the driver." > sdGetAndClearFlags< / a > (< a class = "code" href = "struct___serial_driver.html" title = "Full duplex serial driver class." > SerialDriver< / a > *sdp);
< a name = "l00297" > < / a > 00297 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00298" > < / a > 00298 < span class = "preprocessor" > < / span > }
< a name = "l00299" > < / a > 00299 < span class = "preprocessor" > #endif< / span >
< a name = "l00300" > < / a > 00300 < span class = "preprocessor" > < / span >
< a name = "l00301" > < / a > 00301 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_HAL_USE_SERIAL */< / span >
< a name = "l00302" > < / a > 00302
< a name = "l00303" > < / a > 00303 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _SERIAL_H_ */< / span >
< a name = "l00304" > < / a > 00304 < span class = "comment" > < / span >
< a name = "l00305" > < / a > 00305 < span class = "comment" > /** @} */< / span >
< / pre > < / div > < / div >
2010-11-22 05:53:37 +00:00
< / div >
2010-08-10 03:11:02 +00:00
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >