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: pal_lld.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 > pal_lld.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "templates_2pal__lld_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 templates/pal_lld.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief PAL subsystem low level driver header template.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > *< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @addtogroup PAL_LLD< / 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 _PAL_LLD_H_< / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _PAL_LLD_H_< / span >
< a name = "l00037" > < / a > 00037 < span class = "preprocessor" > < / span >
< a name = "l00038" > < / a > 00038 < span class = "preprocessor" > #if CH_HAL_USE_PAL || 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" > /* Unsupported modes and specific modes */< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00043" > < / a > 00043
< a name = "l00044" > < / a > 00044 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00045" > < / a > 00045 < span class = "comment" > /* I/O Ports Types and constants. */< / span >
< a name = "l00046" > < / a > 00046 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00047" > < / a > 00047 < span class = "comment" > < / span >
< a name = "l00048" > < / a > 00048 < span class = "comment" > /**< / span >
< a name = "l00049" > < / a > 00049 < span class = "comment" > * @brief Generic I/O ports static initializer.< / span >
< a name = "l00050" > < / a > 00050 < span class = "comment" > * @details An instance of this structure must be passed to @p palInit() at< / span >
< a name = "l00051" > < / a > 00051 < span class = "comment" > * system startup time in order to initialized the digital I/O< / span >
< a name = "l00052" > < / a > 00052 < span class = "comment" > * subsystem. This represents only the initial setup, specific pads< / span >
< a name = "l00053" > < / a > 00053 < span class = "comment" > * or whole ports can be reprogrammed at later time.< / span >
< a name = "l00054" > < / a > 00054 < span class = "comment" > * @note This structure content is architecture dependent. The nome should< / span >
< a name = "l00055" > < / a > 00055 < span class = "comment" > * be changed to include the architecture name following this< / span >
< a name = "l00056" > < / a > 00056 < span class = "comment" > * pattern:< br> < / span >
< a name = "l00057" > < / a > 00057 < span class = "comment" > * - [ARCH][CELL]Config.< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > * .< / span >
< a name = "l00059" > < / a > 00059 < span class = "comment" > * As example:< br> < / span >
< a name = "l00060" > < / a > 00060 < span class = "comment" > * - MSP430DIOConfig.< / span >
< a name = "l00061" > < / a > 00061 < span class = "comment" > * .< / span >
< a name = "l00062" > < / a > 00062 < span class = "comment" > */< / span >
< a name = "l00063" > < / a > < a class = "code" href = "struct_generic_config.html" > 00063< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {
< a name = "l00064" > < / a > 00064
< a name = "l00065" > < / a > 00065 } < a class = "code" href = "struct_generic_config.html" title = "Generic I/O ports static initializer." > GenericConfig< / a > ;
< a name = "l00066" > < / a > 00066 < span class = "comment" > < / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > /**< / span >
< a name = "l00068" > < / a > 00068 < span class = "comment" > * @brief Width, in bits, of an I/O port.< / span >
< a name = "l00069" > < / a > 00069 < span class = "comment" > */< / span >
< a name = "l00070" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga20ffc1985d583352e179f5f2c3fa700e" > 00070< / a > < span class = "preprocessor" > #define PAL_IOPORTS_WIDTH 32< / span >
< a name = "l00071" > < / a > 00071 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00072" > < / a > 00072 < span class = "comment" > /**< / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > * @brief Whole port mask.< / span >
< a name = "l00074" > < / a > 00074 < span class = "comment" > * @brief This macro specifies all the valid bits into a port.< / span >
< a name = "l00075" > < / a > 00075 < span class = "comment" > */< / span >
< a name = "l00076" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga713ecb1a9d4fcc2fa53c7a91b8832600" > 00076< / a > < span class = "preprocessor" > #define PAL_WHOLE_PORT ((ioportmask_t)0xFFFFFFFF)< / span >
< a name = "l00077" > < / a > 00077 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00078" > < / a > 00078 < span class = "comment" > /**< / span >
< a name = "l00079" > < / a > 00079 < span class = "comment" > * @brief Digital I/O port sized unsigned type.< / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > */< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00081" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga6115967a8db28246105e03741ff5eb18" > 00081< / a > < span class = "keyword" > typedef< / span > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8" > uint32_t< / a > ioportmask_t;
2010-08-10 03:11:02 +00:00
< a name = "l00082" > < / a > 00082 < span class = "comment" > < / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > /**< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > * @brief Port Identifier.< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > * @details This type can be a scalar or some kind of pointer, do not make< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > * any assumption about it, use the provided macros when populating< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > * variables of this type.< / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > */< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00089" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga4a3294068a07606c952cefda0866761a" > 00089< / a > < span class = "keyword" > typedef< / span > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8" > uint32_t< / a > ioportid_t;
2010-08-10 03:11:02 +00:00
< a name = "l00090" > < / a > 00090
< a name = "l00091" > < / a > 00091 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00092" > < / a > 00092 < span class = "comment" > /* I/O Ports Identifiers. */< / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > < / span >
< a name = "l00095" > < / a > 00095 < span class = "comment" > /**< / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > * @brief First I/O port identifier.< / span >
< a name = "l00097" > < / a > 00097 < span class = "comment" > * @details Low level drivers can define multiple ports, it is suggested to< / span >
< a name = "l00098" > < / a > 00098 < span class = "comment" > * use this naming convention.< / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > */< / span >
< a name = "l00100" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#gaef5823310b8302e832ae22ab895ddde1" > 00100< / a > < span class = "preprocessor" > #define IOPORT1 0< / span >
< a name = "l00101" > < / a > 00101 < span class = "preprocessor" > < / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > /* Implementation, some of the following macros could be implemented as */< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > /* functions, if so please put them in pal_lld.c. */< / span >
< 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" > /**< / span >
< a name = "l00108" > < / a > 00108 < span class = "comment" > * @brief Low level PAL subsystem initialization.< / span >
< a name = "l00109" > < / a > 00109 < span class = "comment" > *< / span >
< a name = "l00110" > < / a > 00110 < span class = "comment" > * @param[in] config architecture-dependent ports configuration< / span >
< a name = "l00111" > < / a > 00111 < span class = "comment" > */< / span >
< a name = "l00112" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga94461ae7e12014a0a71319df5d48fb1a" > 00112< / a > < span class = "preprocessor" > #define pal_lld_init(config)< / span >
< a name = "l00113" > < / a > 00113 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00114" > < / a > 00114 < span class = "comment" > /**< / span >
< a name = "l00115" > < / a > 00115 < span class = "comment" > * @brief Reads the physical I/O port states.< / span >
< a name = "l00116" > < / a > 00116 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00117" > < / a > 00117 < span class = "comment" > * application code.< / span >
< a name = "l00118" > < / a > 00118 < span class = "comment" > *< / span >
< a name = "l00119" > < / a > 00119 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00120" > < / a > 00120 < span class = "comment" > * @return The port bits.< / span >
< a name = "l00121" > < / a > 00121 < span class = "comment" > */< / span >
< a name = "l00122" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga9cf4c7dec4e8ce455857cd1be2c60d59" > 00122< / a > < span class = "preprocessor" > #define pal_lld_readport(port)< / span >
< a name = "l00123" > < / a > 00123 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00124" > < / a > 00124 < span class = "comment" > /**< / span >
< a name = "l00125" > < / a > 00125 < span class = "comment" > * @brief Reads the output latch.< / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > * @details The purpose of this function is to read back the latched output< / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > * value.< / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00129" > < / a > 00129 < span class = "comment" > * application code.< / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > *< / span >
< a name = "l00131" > < / a > 00131 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00132" > < / a > 00132 < span class = "comment" > * @return The latched logical states.< / span >
< a name = "l00133" > < / a > 00133 < span class = "comment" > */< / span >
< a name = "l00134" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#gae1158b9ebac440d69c81765bbaa7931d" > 00134< / a > < span class = "preprocessor" > #define pal_lld_readlatch(port)< / span >
< a name = "l00135" > < / a > 00135 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00136" > < / a > 00136 < span class = "comment" > /**< / span >
< a name = "l00137" > < / a > 00137 < span class = "comment" > * @brief Writes a bits mask on a I/O port.< / span >
< a name = "l00138" > < / a > 00138 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00139" > < / a > 00139 < span class = "comment" > * application code.< / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > *< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > * @param[in] bits bits to be written on the specified port< / span >
< a name = "l00143" > < / a > 00143 < span class = "comment" > */< / span >
< a name = "l00144" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#gab927bfab9c894975177705c314feed62" > 00144< / a > < span class = "preprocessor" > #define pal_lld_writeport(port, bits)< / span >
< a name = "l00145" > < / a > 00145 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00146" > < / a > 00146 < span class = "comment" > /**< / span >
< a name = "l00147" > < / a > 00147 < span class = "comment" > * @brief Sets a bits mask on a I/O port.< / span >
< a name = "l00148" > < / a > 00148 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > * application code.< / span >
< a name = "l00150" > < / a > 00150 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00151" > < / a > 00151 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00152" > < / a > 00152 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00153" > < / a > 00153 < span class = "comment" > *< / span >
< a name = "l00154" > < / a > 00154 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00155" > < / a > 00155 < span class = "comment" > * @param[in] bits bits to be ORed on the specified port< / span >
< a name = "l00156" > < / a > 00156 < span class = "comment" > */< / span >
< a name = "l00157" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga3bdaa97aee564600e297faa34a6aa041" > 00157< / a > < span class = "preprocessor" > #define pal_lld_setport(port, bits)< / span >
< a name = "l00158" > < / a > 00158 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00159" > < / a > 00159 < span class = "comment" > /**< / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > * @brief Clears a bits mask on a I/O port.< / span >
< a name = "l00161" > < / a > 00161 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00162" > < / a > 00162 < span class = "comment" > * application code.< / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00165" > < / a > 00165 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00166" > < / a > 00166 < span class = "comment" > *< / span >
< a name = "l00167" > < / a > 00167 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00168" > < / a > 00168 < span class = "comment" > * @param[in] bits bits to be cleared on the specified port< / span >
< a name = "l00169" > < / a > 00169 < span class = "comment" > */< / span >
< a name = "l00170" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga313da00085ab6f5ba2761eb269090961" > 00170< / a > < span class = "preprocessor" > #define pal_lld_clearport(port, bits)< / span >
< a name = "l00171" > < / a > 00171 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00172" > < / a > 00172 < span class = "comment" > /**< / span >
< a name = "l00173" > < / a > 00173 < span class = "comment" > * @brief Toggles a bits mask on a I/O port.< / span >
< a name = "l00174" > < / a > 00174 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00175" > < / a > 00175 < span class = "comment" > * application code.< / span >
< a name = "l00176" > < / a > 00176 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00177" > < / a > 00177 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00178" > < / a > 00178 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00179" > < / a > 00179 < span class = "comment" > *< / span >
< a name = "l00180" > < / a > 00180 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00181" > < / a > 00181 < span class = "comment" > * @param[in] bits bits to be XORed on the specified port< / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > */< / span >
< a name = "l00183" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga89c47569615c994b56ccc2caa582e38b" > 00183< / a > < span class = "preprocessor" > #define pal_lld_toggleport(port, bits)< / span >
< a name = "l00184" > < / a > 00184 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > /**< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > * @brief Reads a group of bits.< / span >
< a name = "l00187" > < / a > 00187 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00188" > < / a > 00188 < span class = "comment" > * application code.< / span >
< a name = "l00189" > < / a > 00189 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00190" > < / a > 00190 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00191" > < / a > 00191 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00192" > < / a > 00192 < span class = "comment" > *< / span >
< a name = "l00193" > < / a > 00193 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00194" > < / a > 00194 < span class = "comment" > * @param[in] mask group mask< / span >
< a name = "l00195" > < / a > 00195 < span class = "comment" > * @param[in] offset group bit offset within the port< / span >
< a name = "l00196" > < / a > 00196 < span class = "comment" > * @return The group logical states.< / span >
< a name = "l00197" > < / a > 00197 < span class = "comment" > */< / span >
< a name = "l00198" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga232943013bbee9d09b09ffa90da7bd0b" > 00198< / a > < span class = "preprocessor" > #define pal_lld_readgroup(port, mask, offset)< / span >
< a name = "l00199" > < / a > 00199 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00200" > < / a > 00200 < span class = "comment" > /**< / span >
< a name = "l00201" > < / a > 00201 < span class = "comment" > * @brief Writes a group of bits.< / span >
< a name = "l00202" > < / a > 00202 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00203" > < / a > 00203 < span class = "comment" > * application code.< / span >
< a name = "l00204" > < / a > 00204 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00205" > < / a > 00205 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00206" > < / a > 00206 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > *< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00209" > < / a > 00209 < span class = "comment" > * @param[in] mask group mask< / span >
< a name = "l00210" > < / a > 00210 < span class = "comment" > * @param[in] offset group bit offset within the port< / span >
< a name = "l00211" > < / a > 00211 < span class = "comment" > * @param[in] bits bits to be written. Values exceeding the group width< / span >
< a name = "l00212" > < / a > 00212 < span class = "comment" > * are masked.< / span >
< a name = "l00213" > < / a > 00213 < span class = "comment" > */< / span >
< a name = "l00214" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#gaf7896552442b80d846a5bc55a97c7808" > 00214< / a > < span class = "preprocessor" > #define pal_lld_writegroup(port, mask, offset, bits)< / span >
< a name = "l00215" > < / a > 00215 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00216" > < / a > 00216 < span class = "comment" > /**< / span >
< a name = "l00217" > < / a > 00217 < span class = "comment" > * @brief Pads group mode setup.< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * @details This function programs a pads group belonging to the same port< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > * with the specified mode.< / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > * application code.< / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > * @note Programming an unknown or unsupported mode is silently ignored.< / span >
< a name = "l00223" > < / a > 00223 < span class = "comment" > *< / span >
< a name = "l00224" > < / a > 00224 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00225" > < / a > 00225 < span class = "comment" > * @param[in] mask group mask< / span >
< a name = "l00226" > < / a > 00226 < span class = "comment" > * @param[in] mode group mode< / span >
< a name = "l00227" > < / a > 00227 < span class = "comment" > */< / span >
< a name = "l00228" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga4787de055e5ef29a5d386bcd5e7e2011" > 00228< / a > < span class = "preprocessor" > #define pal_lld_setgroupmode(port, mask, mode)< / span >
< a name = "l00229" > < / a > 00229 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00230" > < / a > 00230 < span class = "comment" > /**< / span >
< a name = "l00231" > < / a > 00231 < span class = "comment" > * @brief Reads a logical state from an I/O pad.< / span >
< a name = "l00232" > < / a > 00232 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00233" > < / a > 00233 < span class = "comment" > * application code.< / span >
< a name = "l00234" > < / a > 00234 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00235" > < / a > 00235 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00236" > < / a > 00236 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00237" > < / a > 00237 < span class = "comment" > *< / span >
< a name = "l00238" > < / a > 00238 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00239" > < / a > 00239 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00240" > < / a > 00240 < span class = "comment" > * @return The logical state.< / span >
< a name = "l00241" > < / a > 00241 < span class = "comment" > * @retval PAL_LOW low logical state.< / span >
< a name = "l00242" > < / a > 00242 < span class = "comment" > * @retval PAL_HIGH high logical state.< / span >
< a name = "l00243" > < / a > 00243 < span class = "comment" > */< / span >
< a name = "l00244" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga95f6c65f8f4166d329e857e01125046e" > 00244< / a > < span class = "preprocessor" > #define pal_lld_readpad(port, pad)< / span >
< a name = "l00245" > < / a > 00245 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00246" > < / a > 00246 < span class = "comment" > /**< / span >
< a name = "l00247" > < / a > 00247 < span class = "comment" > * @brief Writes a logical state on an output pad.< / span >
< a name = "l00248" > < / a > 00248 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00249" > < / a > 00249 < span class = "comment" > * application code.< / span >
< a name = "l00250" > < / a > 00250 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00251" > < / a > 00251 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00252" > < / a > 00252 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00253" > < / a > 00253 < span class = "comment" > *< / span >
< a name = "l00254" > < / a > 00254 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00255" > < / a > 00255 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00256" > < / a > 00256 < span class = "comment" > * @param[out] bit logical value, the value must be @p PAL_LOW or< / span >
< a name = "l00257" > < / a > 00257 < span class = "comment" > * @p PAL_HIGH< / span >
< a name = "l00258" > < / a > 00258 < span class = "comment" > */< / span >
< a name = "l00259" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga80d21355227550d52741e04a4882a7b4" > 00259< / a > < span class = "preprocessor" > #define pal_lld_writepad(port, pad, bit)< / span >
< a name = "l00260" > < / a > 00260 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00261" > < / a > 00261 < span class = "comment" > /**< / span >
< a name = "l00262" > < / a > 00262 < span class = "comment" > * @brief Sets a pad logical state to @p PAL_HIGH.< / span >
< a name = "l00263" > < / a > 00263 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00264" > < / a > 00264 < span class = "comment" > * application code.< / span >
< a name = "l00265" > < / a > 00265 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00266" > < / a > 00266 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00267" > < / a > 00267 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00268" > < / a > 00268 < span class = "comment" > *< / span >
< a name = "l00269" > < / a > 00269 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00270" > < / a > 00270 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00271" > < / a > 00271 < span class = "comment" > */< / span >
< a name = "l00272" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#gac0b779928f669896d70b9700485102b3" > 00272< / a > < span class = "preprocessor" > #define pal_lld_setpad(port, pad)< / span >
< a name = "l00273" > < / a > 00273 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00274" > < / a > 00274 < span class = "comment" > /**< / span >
< a name = "l00275" > < / a > 00275 < span class = "comment" > * @brief Clears a pad logical state to @p PAL_LOW.< / span >
< a name = "l00276" > < / a > 00276 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00277" > < / a > 00277 < span class = "comment" > * application code.< / span >
< a name = "l00278" > < / a > 00278 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00279" > < / a > 00279 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00280" > < / a > 00280 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00281" > < / a > 00281 < span class = "comment" > *< / span >
< a name = "l00282" > < / a > 00282 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00283" > < / a > 00283 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00284" > < / a > 00284 < span class = "comment" > */< / span >
< a name = "l00285" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga78ec89ccd1150520d6edf7af93b31b4f" > 00285< / a > < span class = "preprocessor" > #define pal_lld_clearpad(port, pad)< / span >
< a name = "l00286" > < / a > 00286 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00287" > < / a > 00287 < span class = "comment" > /**< / span >
< a name = "l00288" > < / a > 00288 < span class = "comment" > * @brief Toggles a pad logical state.< / span >
< a name = "l00289" > < / a > 00289 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00290" > < / a > 00290 < span class = "comment" > * application code.< / span >
< a name = "l00291" > < / a > 00291 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00292" > < / a > 00292 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00293" > < / a > 00293 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00294" > < / a > 00294 < span class = "comment" > *< / span >
< a name = "l00295" > < / a > 00295 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00296" > < / a > 00296 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00297" > < / a > 00297 < span class = "comment" > */< / span >
< a name = "l00298" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#gaff32956e06caaf121a48262c6f2fba53" > 00298< / a > < span class = "preprocessor" > #define pal_lld_togglepad(port, pad)< / span >
< a name = "l00299" > < / a > 00299 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00300" > < / a > 00300 < span class = "comment" > /**< / span >
< a name = "l00301" > < / a > 00301 < span class = "comment" > * @brief Pad mode setup.< / span >
< a name = "l00302" > < / a > 00302 < span class = "comment" > * @details This function programs a pad with the specified mode.< / span >
< a name = "l00303" > < / a > 00303 < span class = "comment" > * @note This function is not meant to be invoked directly by the< / span >
< a name = "l00304" > < / a > 00304 < span class = "comment" > * application code.< / span >
< a name = "l00305" > < / a > 00305 < span class = "comment" > * @note The @ref PAL provides a default software implementation of this< / span >
< a name = "l00306" > < / a > 00306 < span class = "comment" > * functionality, implement this function if can optimize it by using< / span >
< a name = "l00307" > < / a > 00307 < span class = "comment" > * special hardware functionalities or special coding.< / span >
< a name = "l00308" > < / a > 00308 < span class = "comment" > * @note Programming an unknown or unsupported mode is silently ignored.< / span >
< a name = "l00309" > < / a > 00309 < span class = "comment" > *< / span >
< a name = "l00310" > < / a > 00310 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00311" > < / a > 00311 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00312" > < / a > 00312 < span class = "comment" > * @param[in] mode pad mode< / span >
< a name = "l00313" > < / a > 00313 < span class = "comment" > */< / span >
< a name = "l00314" > < / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga34f944d44e7e129d1c458514b833b240" > 00314< / a > < span class = "preprocessor" > #define pal_lld_setpadmode(port, pad, mode)< / span >
< a name = "l00315" > < / a > 00315 < span class = "preprocessor" > < / span >
< a name = "l00316" > < / a > 00316 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_HAL_USE_PAL */< / span >
< a name = "l00317" > < / a > 00317
< a name = "l00318" > < / a > 00318 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _PAL_LLD_H_ */< / span >
< a name = "l00319" > < / a > 00319 < span class = "comment" > < / span >
< a name = "l00320" > < / a > 00320 < 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 >