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.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.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "pal_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 pal.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief I/O Ports Abstraction Layer macros, types and structures.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > *< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @addtogroup PAL< / 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_H_< / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _PAL_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" > /* 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" > /**< / span >
< a name = "l00045" > < / a > 00045 < span class = "comment" > * @brief Bits in a mode word dedicated as mode selector.< / span >
< a name = "l00046" > < / a > 00046 < span class = "comment" > * @details The other bits are not defined and may be used as device-specific< / span >
< a name = "l00047" > < / a > 00047 < span class = "comment" > * option bits.< / span >
< a name = "l00048" > < / a > 00048 < span class = "comment" > */< / span >
< a name = "l00049" > < / a > < a class = "code" href = "group___p_a_l.html#ga75a61e666497d9486a2d0495a2ad9e83" > 00049< / a > < span class = "preprocessor" > #define PAL_MODE_MASK 0xF< / span >
< a name = "l00050" > < / a > 00050 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00051" > < / a > 00051 < span class = "comment" > /**< / span >
< a name = "l00052" > < / a > 00052 < span class = "comment" > * @brief After reset state.< / span >
< a name = "l00053" > < / a > 00053 < span class = "comment" > * @details The state itself is not specified and is architecture dependent,< / span >
< a name = "l00054" > < / a > 00054 < span class = "comment" > * it is guaranteed to be equal to the after-reset state. It is< / span >
< a name = "l00055" > < / a > 00055 < span class = "comment" > * usually an input state.< / span >
< a name = "l00056" > < / a > 00056 < span class = "comment" > */< / span >
< a name = "l00057" > < / a > < a class = "code" href = "group___p_a_l.html#ga3f3d0c21b3190fc732a4c51b8d1e6c8d" > 00057< / a > < span class = "preprocessor" > #define PAL_MODE_RESET 0< / span >
< a name = "l00058" > < / a > 00058 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00059" > < / a > 00059 < span class = "comment" > /**< / span >
< a name = "l00060" > < / a > 00060 < span class = "comment" > * @brief Safe state for < b> unconnected< /b> pads.< / span >
< a name = "l00061" > < / a > 00061 < span class = "comment" > * @details The state itself is not specified and is architecture dependent,< / span >
< a name = "l00062" > < / a > 00062 < span class = "comment" > * it may be mapped on @p PAL_MODE_INPUT_PULLUP,< / span >
< a name = "l00063" > < / a > 00063 < span class = "comment" > * @p PAL_MODE_INPUT_PULLDOWN or @p PAL_MODE_OUTPUT_PUSHPULL as< / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > * example.< / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > */< / span >
< a name = "l00066" > < / a > < a class = "code" href = "group___p_a_l.html#ga688f69ad947fc020c9d3840b542e1958" > 00066< / a > < span class = "preprocessor" > #define PAL_MODE_UNCONNECTED 1< / span >
< a name = "l00067" > < / a > 00067 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00068" > < / a > 00068 < span class = "comment" > /**< / span >
< a name = "l00069" > < / a > 00069 < span class = "comment" > * @brief Regular input high-Z pad.< / span >
< a name = "l00070" > < / a > 00070 < span class = "comment" > */< / span >
< a name = "l00071" > < / a > < a class = "code" href = "group___p_a_l.html#ga6a896b827967dc3016560920d7d74d63" > 00071< / a > < span class = "preprocessor" > #define PAL_MODE_INPUT 2< / span >
< a name = "l00072" > < / a > 00072 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > /**< / span >
< a name = "l00074" > < / a > 00074 < span class = "comment" > * @brief Input pad with weak pull up resistor.< / span >
< a name = "l00075" > < / a > 00075 < span class = "comment" > */< / span >
< a name = "l00076" > < / a > < a class = "code" href = "group___p_a_l.html#gadb37ffcbe38167c0642f7618f0d5b398" > 00076< / a > < span class = "preprocessor" > #define PAL_MODE_INPUT_PULLUP 3< / 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 Input pad with weak pull down resistor.< / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > */< / span >
< a name = "l00081" > < / a > < a class = "code" href = "group___p_a_l.html#ga0b2c436c6b72194e8c81f92c4e8c0312" > 00081< / a > < span class = "preprocessor" > #define PAL_MODE_INPUT_PULLDOWN 4< / span >
< a name = "l00082" > < / a > 00082 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > /**< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > * @brief Analog input mode.< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > */< / span >
< a name = "l00086" > < / a > < a class = "code" href = "group___p_a_l.html#ga4c506305ade80cef5e580bc65ec54349" > 00086< / a > < span class = "preprocessor" > #define PAL_MODE_INPUT_ANALOG 5< / span >
< a name = "l00087" > < / a > 00087 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > /**< / span >
< a name = "l00089" > < / a > 00089 < span class = "comment" > * @brief Push-pull output pad.< / span >
< a name = "l00090" > < / a > 00090 < span class = "comment" > */< / span >
< a name = "l00091" > < / a > < a class = "code" href = "group___p_a_l.html#gaedde8679d38abe282c7a70d75a04cda6" > 00091< / a > < span class = "preprocessor" > #define PAL_MODE_OUTPUT_PUSHPULL 6< / span >
< a name = "l00092" > < / a > 00092 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > /**< / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > * @brief Open-drain output pad.< / span >
< a name = "l00095" > < / a > 00095 < span class = "comment" > */< / span >
< a name = "l00096" > < / a > < a class = "code" href = "group___p_a_l.html#ga174456e1b2ba6ce57f196de6db8c846c" > 00096< / a > < span class = "preprocessor" > #define PAL_MODE_OUTPUT_OPENDRAIN 7< / span >
< a name = "l00097" > < / a > 00097 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00098" > < / a > 00098 < span class = "comment" > /**< / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > * @brief Logical low state.< / span >
< a name = "l00100" > < / a > 00100 < span class = "comment" > */< / span >
< a name = "l00101" > < / a > < a class = "code" href = "group___p_a_l.html#gabdc4b674dd16fd5dbe8aa36b884cf3ed" > 00101< / a > < span class = "preprocessor" > #define PAL_LOW 0< / span >
< a name = "l00102" > < / a > 00102 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > /**< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > * @brief Logical high state.< / span >
< a name = "l00105" > < / a > 00105 < span class = "comment" > */< / span >
< a name = "l00106" > < / a > < a class = "code" href = "group___p_a_l.html#ga6a0e02bcb9a99574ff39d32db9a48f63" > 00106< / a > < span class = "preprocessor" > #define PAL_HIGH 1< / span >
< a name = "l00107" > < / a > 00107 < span class = "preprocessor" > < / span >
< a name = "l00108" > < / a > 00108 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00109" > < / a > 00109 < span class = "comment" > /* Driver pre-compile time settings. */< / span >
< a name = "l00110" > < / a > 00110 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00111" > < / a > 00111
< a name = "l00112" > < / a > 00112 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00113" > < / a > 00113 < span class = "comment" > /* Derived constants and error checks. */< / span >
< a name = "l00114" > < / a > 00114 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00115" > < / a > 00115
< a name = "l00116" > < / a > 00116 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00117" > < / a > 00117 < span class = "comment" > /* Driver data structures and types. */< / span >
< a name = "l00118" > < / a > 00118 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00119" > < / a > 00119
< a name = "l00120" > < / a > 00120 < span class = "preprocessor" > #include " < a class = "code" href = "platforms_2_s_t_m8_2pal__lld_8h.html" title = "STM8 GPIO low level driver header." > pal_lld.h< / a > " < / span >
< a name = "l00121" > < / a > 00121 < span class = "comment" > < / span >
< a name = "l00122" > < / a > 00122 < span class = "comment" > /**< / span >
< a name = "l00123" > < / a > 00123 < span class = "comment" > * @brief I/O bus descriptor.< / span >
< a name = "l00124" > < / a > 00124 < span class = "comment" > * @details This structure describes a group of contiguous digital I/O lines< / span >
< a name = "l00125" > < / a > 00125 < span class = "comment" > * that have to be handled as bus.< / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > * @note I/O operations on a bus do not affect I/O lines on the same port but< / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > * not belonging to the bus.< / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > */< / span >
< a name = "l00129" > < / a > < a class = "code" href = "struct_i_o_bus.html" > 00129< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< span class = "comment" > < / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > /**< / span >
< a name = "l00131" > < / a > 00131 < span class = "comment" > * @brief Port identifier.< / span >
< a name = "l00132" > < / a > 00132 < span class = "comment" > */< / span >
< a name = "l00133" > < / a > < a class = "code" href = "struct_i_o_bus.html#a79c1372324fc1d9d2c571ac6d47163f9" > 00133< / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga4a3294068a07606c952cefda0866761a" title = "Port Identifier." > ioportid_t< / a > bus_portid;< span class = "comment" > < / span >
< a name = "l00134" > < / a > 00134 < span class = "comment" > /**< / span >
< a name = "l00135" > < / a > 00135 < span class = "comment" > * @brief Bus mask aligned to port bit 0.< / span >
< a name = "l00136" > < / a > 00136 < span class = "comment" > * @note The bus mask implicitly define the bus width. A logical AND is< / span >
< a name = "l00137" > < / a > 00137 < span class = "comment" > * performed on the bus data.< / span >
< a name = "l00138" > < / a > 00138 < span class = "comment" > */< / span >
< a name = "l00139" > < / a > < a class = "code" href = "struct_i_o_bus.html#ab2efb4f2a7504ac2e737de26c1e4f33a" > 00139< / a > < a class = "code" href = "group___p_a_l___l_l_d.html#ga6115967a8db28246105e03741ff5eb18" title = "Digital I/O port sized unsigned type." > ioportmask_t< / a > bus_mask;< span class = "comment" > < / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > /**< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > * @brief Offset, within the port, of the least significant bit of the bus.< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > */< / span >
< a name = "l00143" > < / a > < a class = "code" href = "struct_i_o_bus.html#a50c155a7f9aa5b254faa372f0619286a" > 00143< / a > < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gad0fca8b15c218d2c687f8c373a71d228" > uint_fast8_t< / a > bus_offset;
< a name = "l00144" > < / a > 00144 } < a class = "code" href = "struct_i_o_bus.html" title = "I/O bus descriptor." > IOBus< / a > ;
< a name = "l00145" > < / a > 00145
< a name = "l00146" > < / a > 00146 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00147" > < / a > 00147 < span class = "comment" > /* Driver macros. */< / span >
< a name = "l00148" > < / a > 00148 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > < / span >
< a name = "l00150" > < / a > 00150 < span class = "comment" > /**< / span >
< a name = "l00151" > < / a > 00151 < span class = "comment" > * @brief Port bit helper macro.< / span >
< a name = "l00152" > < / a > 00152 < span class = "comment" > * @details This macro calculates the mask of a bit within a port.< / span >
< a name = "l00153" > < / a > 00153 < span class = "comment" > *< / span >
< a name = "l00154" > < / a > 00154 < span class = "comment" > * @param[in] n bit position within the port< / span >
< a name = "l00155" > < / a > 00155 < span class = "comment" > * @return The bit mask.< / span >
< a name = "l00156" > < / a > 00156 < span class = "comment" > */< / span >
< a name = "l00157" > < / a > < a class = "code" href = "group___p_a_l.html#ga7355801d0ad0c2dc5fd181115d899e74" > 00157< / a > < span class = "preprocessor" > #define PAL_PORT_BIT(n) ((ioportmask_t)(1 < < (n)))< / span >
< a name = "l00158" > < / a > 00158 < span class = "preprocessor" > < / span >
< a name = "l00159" > < / a > 00159 < span class = "comment" > < / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > /**< / span >
< a name = "l00161" > < / a > 00161 < span class = "comment" > * @brief Bits group mask helper.< / span >
< a name = "l00162" > < / a > 00162 < span class = "comment" > * @details This macro calculates the mask of a bits group.< / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > *< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > * @param[in] width group width< / span >
< a name = "l00165" > < / a > 00165 < span class = "comment" > * @return The group mask.< / span >
< a name = "l00166" > < / a > 00166 < span class = "comment" > */< / span >
< a name = "l00167" > < / a > < a class = "code" href = "group___p_a_l.html#ga394f79edb774c84dcbaec679df4de24f" > 00167< / a > < span class = "preprocessor" > #define PAL_GROUP_MASK(width) ((ioportmask_t)(1 < < (width)) - 1)< / span >
< a name = "l00168" > < / a > 00168 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00169" > < / a > 00169 < span class = "comment" > /**< / span >
< a name = "l00170" > < / a > 00170 < span class = "comment" > * @brief Data part of a static I/O bus initializer.< / span >
< a name = "l00171" > < / a > 00171 < span class = "comment" > * @details This macro should be used when statically initializing an I/O bus< / span >
< a name = "l00172" > < / a > 00172 < span class = "comment" > * that is part of a bigger structure.< / span >
< a name = "l00173" > < / a > 00173 < span class = "comment" > *< / span >
< a name = "l00174" > < / a > 00174 < span class = "comment" > * @param[in] name name of the IOBus variable< / span >
< a name = "l00175" > < / a > 00175 < span class = "comment" > * @param[in] port I/O port descriptor< / span >
< a name = "l00176" > < / a > 00176 < span class = "comment" > * @param[in] width bus width in bits< / span >
< a name = "l00177" > < / a > 00177 < span class = "comment" > * @param[in] offset bus bit offset within the port< / span >
< a name = "l00178" > < / a > 00178 < span class = "comment" > */< / span >
< a name = "l00179" > < / a > < a class = "code" href = "group___p_a_l.html#ga9b2ca125fccdac75e7513b597f3a4a39" > 00179< / a > < span class = "preprocessor" > #define _IOBUS_DATA(name, port, width, offset) \< / span >
< a name = "l00180" > < / a > 00180 < span class = "preprocessor" > {port, PAL_GROUP_MASK(width), offset}< / span >
< a name = "l00181" > < / a > 00181 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > /**< / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > * @brief Static I/O bus initializer.< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > *< / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > * @param[in] name name of the IOBus variable< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > * @param[in] port I/O port descriptor< / span >
< a name = "l00187" > < / a > 00187 < span class = "comment" > * @param[in] width bus width in bits< / span >
< a name = "l00188" > < / a > 00188 < span class = "comment" > * @param[in] offset bus bit offset within the port< / span >
< a name = "l00189" > < / a > 00189 < span class = "comment" > */< / span >
< a name = "l00190" > < / a > < a class = "code" href = "group___p_a_l.html#ga94861905a3eda098da30009d710fb176" > 00190< / a > < span class = "preprocessor" > #define IOBUS_DECL(name, port, width, offset) \< / span >
< a name = "l00191" > < / a > 00191 < span class = "preprocessor" > IOBus name = _IOBUS_DATA(name, port, width, offset)< / 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 PAL subsystem initialization.< / span >
< a name = "l00195" > < / a > 00195 < span class = "comment" > *< / span >
< a name = "l00196" > < / a > 00196 < span class = "comment" > * @param[in] config pointer to an architecture specific configuration< / span >
< a name = "l00197" > < / a > 00197 < span class = "comment" > * structure. This structure is defined in the low level driver< / span >
< a name = "l00198" > < / a > 00198 < span class = "comment" > * header.< / span >
< a name = "l00199" > < / a > 00199 < span class = "comment" > */< / span >
< a name = "l00200" > < / a > < a class = "code" href = "group___p_a_l.html#ga5a9743283a30e13f2513f5abbcac9f97" > 00200< / a > < span class = "preprocessor" > #define palInit(config) pal_lld_init(config)< / span >
< a name = "l00201" > < / a > 00201 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00202" > < / a > 00202 < span class = "comment" > /**< / span >
< a name = "l00203" > < / a > 00203 < span class = "comment" > * @brief Reads the physical I/O port states.< / span >
< a name = "l00204" > < / a > 00204 < span class = "comment" > * @note The default implementation always return zero and computes the< / span >
< a name = "l00205" > < / a > 00205 < span class = "comment" > * parameter eventual side effects.< / span >
< a name = "l00206" > < / a > 00206 < span class = "comment" > *< / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > * @return The port logical states.< / span >
< a name = "l00209" > < / a > 00209 < span class = "comment" > */< / span >
< a name = "l00210" > < / a > 00210 < span class = "preprocessor" > #if !defined(pal_lld_readport) || defined(__DOXYGEN__)< / span >
< a name = "l00211" > < / a > < a class = "code" href = "group___p_a_l.html#gaf9df3944b1ef206cce8c42ba5de5e3f9" > 00211< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadPort(port) ((void)(port), 0)< / span >
< a name = "l00212" > < / a > 00212 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00213" > < / a > 00213 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadPort(port) pal_lld_readport(port)< / span >
< a name = "l00214" > < / a > 00214 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / 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 Reads the output latch.< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * @details The purpose of this function is to read back the latched output< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > * value.< / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > * @note The default implementation always return zero and computes the< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > * parameter eventual side effects.< / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > *< / span >
< a name = "l00223" > < / a > 00223 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00224" > < / a > 00224 < span class = "comment" > * @return The latched logical states.< / span >
< a name = "l00225" > < / a > 00225 < span class = "comment" > */< / span >
< a name = "l00226" > < / a > 00226 < span class = "preprocessor" > #if !defined(pal_lld_readlatch) || defined(__DOXYGEN__)< / span >
< a name = "l00227" > < / a > < a class = "code" href = "group___p_a_l.html#ga250da7237d3ccf872944d77d151fce24" > 00227< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadLatch(port) ((void)(port), 0)< / span >
< a name = "l00228" > < / a > 00228 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00229" > < / a > 00229 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadLatch(port) pal_lld_readlatch(port)< / span >
< a name = "l00230" > < / a > 00230 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00231" > < / a > 00231 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00232" > < / a > 00232 < span class = "comment" > /**< / span >
< a name = "l00233" > < / a > 00233 < span class = "comment" > * @brief Writes a bits mask on a I/O port.< / span >
< a name = "l00234" > < / a > 00234 < span class = "comment" > * @note The default implementation does nothing except computing the< / span >
< a name = "l00235" > < / a > 00235 < span class = "comment" > * parameters eventual side effects.< / span >
< a name = "l00236" > < / a > 00236 < span class = "comment" > *< / span >
< a name = "l00237" > < / a > 00237 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00238" > < / a > 00238 < span class = "comment" > * @param[in] bits bits to be written on the specified port< / span >
< a name = "l00239" > < / a > 00239 < span class = "comment" > */< / span >
< a name = "l00240" > < / a > 00240 < span class = "preprocessor" > #if !defined(pal_lld_writeport) || defined(__DOXYGEN__)< / span >
< a name = "l00241" > < / a > < a class = "code" href = "group___p_a_l.html#ga7b6d3c589c78f451bc9e1fb080222e71" > 00241< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palWritePort(port, bits) ((void)(port), (void)(bits))< / span >
< a name = "l00242" > < / a > 00242 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00243" > < / a > 00243 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palWritePort(port, bits) pal_lld_writeport(port, bits)< / span >
< a name = "l00244" > < / a > 00244 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / 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 Sets a bits mask on a I/O port.< / span >
< a name = "l00248" > < / a > 00248 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00249" > < / a > 00249 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00250" > < / a > 00250 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00251" > < / a > 00251 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00252" > < / a > 00252 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00253" > < / a > 00253 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00254" > < / a > 00254 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00255" > < / a > 00255 < span class = "comment" > *< / span >
< a name = "l00256" > < / a > 00256 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00257" > < / a > 00257 < span class = "comment" > * @param[in] bits bits to be ORed on the specified port< / span >
< a name = "l00258" > < / a > 00258 < span class = "comment" > */< / span >
< a name = "l00259" > < / a > 00259 < span class = "preprocessor" > #if !defined(pal_lld_setport) || defined(__DOXYGEN__)< / span >
< a name = "l00260" > < / a > < a class = "code" href = "group___p_a_l.html#gafd09c5ce655dd5daf9b39cd5f842e422" > 00260< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetPort(port, bits) { \< / span >
< a name = "l00261" > < / a > 00261 < span class = "preprocessor" > palWritePort(port, palReadLatch(port) | (bits)); \< / span >
< a name = "l00262" > < / a > 00262 < span class = "preprocessor" > }< / span >
< a name = "l00263" > < / a > 00263 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00264" > < / a > 00264 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetPort(port, bits) pal_lld_setport(port, bits)< / span >
< a name = "l00265" > < / a > 00265 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00266" > < / a > 00266 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00267" > < / a > 00267 < span class = "comment" > /**< / span >
< a name = "l00268" > < / a > 00268 < span class = "comment" > * @brief Clears a bits mask on a I/O port.< / span >
< a name = "l00269" > < / a > 00269 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00270" > < / a > 00270 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00271" > < / a > 00271 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00272" > < / a > 00272 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00273" > < / a > 00273 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00274" > < / a > 00274 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00275" > < / a > 00275 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00276" > < / a > 00276 < span class = "comment" > *< / span >
< a name = "l00277" > < / a > 00277 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00278" > < / a > 00278 < span class = "comment" > * @param[in] bits bits to be cleared on the specified port< / span >
< a name = "l00279" > < / a > 00279 < span class = "comment" > *< / span >
< a name = "l00280" > < / a > 00280 < span class = "comment" > */< / span >
< a name = "l00281" > < / a > 00281 < span class = "preprocessor" > #if !defined(pal_lld_clearport) || defined(__DOXYGEN__)< / span >
< a name = "l00282" > < / a > < a class = "code" href = "group___p_a_l.html#ga5ff3b75aeb4fcd1cb82f451f952ab9a9" > 00282< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palClearPort(port, bits) { \< / span >
< a name = "l00283" > < / a > 00283 < span class = "preprocessor" > palWritePort(port, palReadLatch(port) & ~(bits)); \< / span >
< a name = "l00284" > < / a > 00284 < span class = "preprocessor" > }< / span >
< a name = "l00285" > < / a > 00285 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00286" > < / a > 00286 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palClearPort(port, bits) pal_lld_clearport(port, bits)< / span >
< a name = "l00287" > < / a > 00287 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00288" > < / a > 00288 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00289" > < / a > 00289 < span class = "comment" > /**< / span >
< a name = "l00290" > < / a > 00290 < span class = "comment" > * @brief Toggles a bits mask on a I/O port.< / span >
< a name = "l00291" > < / a > 00291 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00292" > < / a > 00292 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00293" > < / a > 00293 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00294" > < / a > 00294 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00295" > < / a > 00295 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00296" > < / a > 00296 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00297" > < / a > 00297 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00298" > < / a > 00298 < span class = "comment" > *< / span >
< a name = "l00299" > < / a > 00299 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00300" > < / a > 00300 < span class = "comment" > * @param[in] bits bits to be XORed on the specified port< / span >
< a name = "l00301" > < / a > 00301 < span class = "comment" > */< / span >
< a name = "l00302" > < / a > 00302 < span class = "preprocessor" > #if !defined(pal_lld_toggleport) || defined(__DOXYGEN__)< / span >
< a name = "l00303" > < / a > < a class = "code" href = "group___p_a_l.html#ga55408d900323e7dd43c0fa83337de7ba" > 00303< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palTogglePort(port, bits) { \< / span >
< a name = "l00304" > < / a > 00304 < span class = "preprocessor" > palWritePort(port, palReadLatch(port) ^ (bits)); \< / span >
< a name = "l00305" > < / a > 00305 < span class = "preprocessor" > }< / span >
< a name = "l00306" > < / a > 00306 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00307" > < / a > 00307 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palTogglePort(port, bits) pal_lld_toggleport(port, bits)< / span >
< a name = "l00308" > < / a > 00308 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00309" > < / a > 00309 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00310" > < / a > 00310 < span class = "comment" > /**< / span >
< a name = "l00311" > < / a > 00311 < span class = "comment" > * @brief Reads a group of bits.< / span >
< a name = "l00312" > < / a > 00312 < span class = "comment" > *< / span >
< a name = "l00313" > < / a > 00313 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00314" > < / a > 00314 < span class = "comment" > * @param[in] mask group mask, a logical AND is performed on the input< / span >
< a name = "l00315" > < / a > 00315 < span class = "comment" > * data< / span >
< a name = "l00316" > < / a > 00316 < span class = "comment" > * @param[in] offset group bit offset within the port< / span >
< a name = "l00317" > < / a > 00317 < span class = "comment" > * @return The group logical states.< / span >
< a name = "l00318" > < / a > 00318 < span class = "comment" > */< / span >
< a name = "l00319" > < / a > 00319 < span class = "preprocessor" > #if !defined(pal_lld_readgroup) || defined(__DOXYGEN__)< / span >
< a name = "l00320" > < / a > < a class = "code" href = "group___p_a_l.html#gad286cfdb9f088a7c8e5085d19ac728d3" > 00320< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadGroup(port, mask, offset) \< / span >
< a name = "l00321" > < / a > 00321 < span class = "preprocessor" > ((palReadPort(port) > > (offset)) & (mask))< / span >
< a name = "l00322" > < / a > 00322 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00323" > < / a > 00323 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadGroup(port, mask, offset) pal_lld_readgroup(port, mask, offset)< / span >
< a name = "l00324" > < / a > 00324 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00325" > < / a > 00325 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00326" > < / a > 00326 < span class = "comment" > /**< / span >
< a name = "l00327" > < / a > 00327 < span class = "comment" > * @brief Writes a group of bits.< / span >
< a name = "l00328" > < / a > 00328 < span class = "comment" > *< / span >
< a name = "l00329" > < / a > 00329 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00330" > < / a > 00330 < span class = "comment" > * @param[in] mask group mask, a logical AND is performed on the< / span >
< a name = "l00331" > < / a > 00331 < span class = "comment" > * output data< / span >
< a name = "l00332" > < / a > 00332 < span class = "comment" > * @param[in] offset group bit offset within the port< / span >
< a name = "l00333" > < / a > 00333 < span class = "comment" > * @param[in] bits bits to be written. Values exceeding the group< / span >
< a name = "l00334" > < / a > 00334 < span class = "comment" > * width are masked.< / span >
< a name = "l00335" > < / a > 00335 < span class = "comment" > */< / span >
< a name = "l00336" > < / a > 00336 < span class = "preprocessor" > #if !defined(pal_lld_writegroup) || defined(__DOXYGEN__)< / span >
< a name = "l00337" > < / a > < a class = "code" href = "group___p_a_l.html#gacb25ee0b16d9fb701e3fd21e5dbb990a" > 00337< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palWriteGroup(port, mask, offset, bits) { \< / span >
< a name = "l00338" > < / a > 00338 < span class = "preprocessor" > palWritePort(port, (palReadLatch(port) & ~((mask) < < (offset))) | \< / span >
< a name = "l00339" > < / a > 00339 < span class = "preprocessor" > (((bits) & (mask)) < < (offset))); \< / span >
< a name = "l00340" > < / a > 00340 < span class = "preprocessor" > }< / span >
< a name = "l00341" > < / a > 00341 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00342" > < / a > 00342 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palWriteGroup(port, mask, offset, bits) \< / span >
< a name = "l00343" > < / a > 00343 < span class = "preprocessor" > pal_lld_writegroup(port, mask, offset, bits)< / span >
< a name = "l00344" > < / a > 00344 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00345" > < / a > 00345 < span class = "preprocessor" > < / span >
< a name = "l00346" > < / a > 00346 < span class = "comment" > < / span >
< a name = "l00347" > < / a > 00347 < span class = "comment" > /**< / span >
< a name = "l00348" > < / a > 00348 < span class = "comment" > * @brief Pads group mode setup.< / span >
< a name = "l00349" > < / a > 00349 < span class = "comment" > * @details This function programs a pads group belonging to the same port< / span >
< a name = "l00350" > < / a > 00350 < span class = "comment" > * with the specified mode.< / span >
< a name = "l00351" > < / a > 00351 < span class = "comment" > * @note Programming an unknown or unsupported mode is silently ignored.< / span >
< a name = "l00352" > < / a > 00352 < span class = "comment" > *< / span >
< a name = "l00353" > < / a > 00353 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00354" > < / a > 00354 < span class = "comment" > * @param[in] mask group mask< / span >
< a name = "l00355" > < / a > 00355 < span class = "comment" > * @param[in] mode group mode< / span >
< a name = "l00356" > < / a > 00356 < span class = "comment" > *< / span >
< a name = "l00357" > < / a > 00357 < span class = "comment" > */< / span >
< a name = "l00358" > < / a > 00358 < span class = "preprocessor" > #if !defined(pal_lld_setgroupmode) || defined(__DOXYGEN__)< / span >
< a name = "l00359" > < / a > < a class = "code" href = "group___p_a_l.html#ga24789efd90288773d2f928458d1dc6e5" > 00359< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetGroupMode(port, mask, mode)< / span >
< a name = "l00360" > < / a > 00360 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00361" > < / a > 00361 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetGroupMode(port, mask, mode) pal_lld_setgroupmode(port, mask, mode)< / span >
< a name = "l00362" > < / a > 00362 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00363" > < / a > 00363 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00364" > < / a > 00364 < span class = "comment" > /**< / span >
< a name = "l00365" > < / a > 00365 < span class = "comment" > * @brief Reads an input pad logical state.< / span >
< a name = "l00366" > < / a > 00366 < span class = "comment" > * @note The default implementation not necessarily optimal. Low level< / span >
< a name = "l00367" > < / a > 00367 < span class = "comment" > * drivers may optimize the function by using specific hardware< / span >
< a name = "l00368" > < / a > 00368 < span class = "comment" > * or coding.< / span >
< a name = "l00369" > < / a > 00369 < span class = "comment" > * @note The default implementation internally uses the @p palReadPort().< / span >
< a name = "l00370" > < / a > 00370 < span class = "comment" > *< / span >
< a name = "l00371" > < / a > 00371 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00372" > < / a > 00372 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00373" > < / a > 00373 < span class = "comment" > * @return The logical state.< / span >
< a name = "l00374" > < / a > 00374 < span class = "comment" > * @retval PAL_LOW low logical state.< / span >
< a name = "l00375" > < / a > 00375 < span class = "comment" > * @retval PAL_HIGH high logical state.< / span >
< a name = "l00376" > < / a > 00376 < span class = "comment" > *< / span >
< a name = "l00377" > < / a > 00377 < span class = "comment" > */< / span >
< a name = "l00378" > < / a > 00378 < span class = "preprocessor" > #if !defined(pal_lld_readpad) || defined(__DOXYGEN__)< / span >
< a name = "l00379" > < / a > < a class = "code" href = "group___p_a_l.html#ga06917ae7f34a92d3a04be8e9364dcfbf" > 00379< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadPad(port, pad) ((palReadPort(port) > > (pad)) & 1)< / span >
< a name = "l00380" > < / a > 00380 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00381" > < / a > 00381 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palReadPad(port, pad) pal_lld_readpad(port, pad)< / span >
< a name = "l00382" > < / a > 00382 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00383" > < / a > 00383 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00384" > < / a > 00384 < span class = "comment" > /**< / span >
< a name = "l00385" > < / a > 00385 < span class = "comment" > * @brief Writes a logical state on an output pad.< / span >
< a name = "l00386" > < / a > 00386 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00387" > < / a > 00387 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00388" > < / a > 00388 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00389" > < / a > 00389 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00390" > < / a > 00390 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00391" > < / a > 00391 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00392" > < / a > 00392 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00393" > < / a > 00393 < span class = "comment" > * @note The default implementation internally uses the @p palReadLatch()< / span >
< a name = "l00394" > < / a > 00394 < span class = "comment" > * and @p palWritePort().< / span >
< a name = "l00395" > < / a > 00395 < span class = "comment" > *< / span >
< a name = "l00396" > < / a > 00396 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00397" > < / a > 00397 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00398" > < / a > 00398 < span class = "comment" > * @param[in] bit logical value, the value must be @p PAL_LOW or< / span >
< a name = "l00399" > < / a > 00399 < span class = "comment" > * @p PAL_HIGH< / span >
< a name = "l00400" > < / a > 00400 < span class = "comment" > */< / span >
< a name = "l00401" > < / a > 00401 < span class = "preprocessor" > #if !defined(pal_lld_writepad) || defined(__DOXYGEN__)< / span >
< a name = "l00402" > < / a > < a class = "code" href = "group___p_a_l.html#ga1b2ea64780d20f11eedaeb34c5b42daa" > 00402< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palWritePad(port, pad, bit) { \< / span >
< a name = "l00403" > < / a > 00403 < span class = "preprocessor" > palWritePort(port, (palReadLatch(port) & ~PAL_PORT_BIT(pad)) | \< / span >
< a name = "l00404" > < / a > 00404 < span class = "preprocessor" > (((bit) & 1) < < pad)); \< / span >
< a name = "l00405" > < / a > 00405 < span class = "preprocessor" > }< / span >
< a name = "l00406" > < / a > 00406 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00407" > < / a > 00407 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palWritePad(port, pad, bit) pal_lld_writepad(port, pad, bit)< / span >
< a name = "l00408" > < / a > 00408 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00409" > < / a > 00409 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00410" > < / a > 00410 < span class = "comment" > /**< / span >
< a name = "l00411" > < / a > 00411 < span class = "comment" > * @brief Sets a pad logical state to @p PAL_HIGH.< / span >
< a name = "l00412" > < / a > 00412 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00413" > < / a > 00413 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00414" > < / a > 00414 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00415" > < / a > 00415 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00416" > < / a > 00416 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00417" > < / a > 00417 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00418" > < / a > 00418 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00419" > < / a > 00419 < span class = "comment" > * @note The default implementation internally uses the @p palSetPort().< / span >
< a name = "l00420" > < / a > 00420 < span class = "comment" > *< / span >
< a name = "l00421" > < / a > 00421 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00422" > < / a > 00422 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00423" > < / a > 00423 < span class = "comment" > */< / span >
< a name = "l00424" > < / a > 00424 < span class = "preprocessor" > #if !defined(pal_lld_setpad) || defined(__DOXYGEN__)< / span >
< a name = "l00425" > < / a > < a class = "code" href = "group___p_a_l.html#gaf2c820c1657afa77cdce398329baaf68" > 00425< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetPad(port, pad) palSetPort(port, PAL_PORT_BIT(pad))< / span >
< a name = "l00426" > < / a > 00426 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00427" > < / a > 00427 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetPad(port, pad) pal_lld_setpad(port, pad)< / span >
< a name = "l00428" > < / a > 00428 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00429" > < / a > 00429 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00430" > < / a > 00430 < span class = "comment" > /**< / span >
< a name = "l00431" > < / a > 00431 < span class = "comment" > * @brief Clears a pad logical state to @p PAL_LOW.< / span >
< a name = "l00432" > < / a > 00432 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00433" > < / a > 00433 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00434" > < / a > 00434 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00435" > < / a > 00435 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00436" > < / a > 00436 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00437" > < / a > 00437 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00438" > < / a > 00438 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00439" > < / a > 00439 < span class = "comment" > * @note The default implementation internally uses the @p palClearPort().< / span >
< a name = "l00440" > < / a > 00440 < span class = "comment" > *< / span >
< a name = "l00441" > < / a > 00441 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00442" > < / a > 00442 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00443" > < / a > 00443 < span class = "comment" > */< / span >
< a name = "l00444" > < / a > 00444 < span class = "preprocessor" > #if !defined(pal_lld_clearpad) || defined(__DOXYGEN__)< / span >
< a name = "l00445" > < / a > < a class = "code" href = "group___p_a_l.html#ga4dce65e0515a349a06bea353f2303286" > 00445< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palClearPad(port, pad) palClearPort(port, PAL_PORT_BIT(pad))< / span >
< a name = "l00446" > < / a > 00446 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00447" > < / a > 00447 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palClearPad(port, pad) pal_lld_clearpad(port, pad)< / span >
< a name = "l00448" > < / a > 00448 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00449" > < / a > 00449 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00450" > < / a > 00450 < span class = "comment" > /**< / span >
< a name = "l00451" > < / a > 00451 < span class = "comment" > * @brief Toggles a pad logical state.< / span >
< a name = "l00452" > < / a > 00452 < span class = "comment" > * @note The operation is not guaranteed to be atomic on all the< / span >
< a name = "l00453" > < / a > 00453 < span class = "comment" > * architectures, for atomicity and/or portability reasons you may< / span >
< a name = "l00454" > < / a > 00454 < span class = "comment" > * need to enclose port I/O operations between @p chSysLock() and< / span >
< a name = "l00455" > < / a > 00455 < span class = "comment" > * @p chSysUnlock().< / span >
< a name = "l00456" > < / a > 00456 < span class = "comment" > * @note The default implementation is non atomic and not necessarily< / span >
< a name = "l00457" > < / a > 00457 < span class = "comment" > * optimal. Low level drivers may optimize the function by using< / span >
< a name = "l00458" > < / a > 00458 < span class = "comment" > * specific hardware or coding.< / span >
< a name = "l00459" > < / a > 00459 < span class = "comment" > * @note The default implementation internally uses the @p palTogglePort().< / span >
< a name = "l00460" > < / a > 00460 < span class = "comment" > *< / span >
< a name = "l00461" > < / a > 00461 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00462" > < / a > 00462 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00463" > < / a > 00463 < span class = "comment" > */< / span >
< a name = "l00464" > < / a > 00464 < span class = "preprocessor" > #if !defined(pal_lld_togglepad) || defined(__DOXYGEN__)< / span >
< a name = "l00465" > < / a > < a class = "code" href = "group___p_a_l.html#ga76b4f6024add76681d618f5ac7daeedf" > 00465< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palTogglePad(port, pad) palTogglePort(port, PAL_PORT_BIT(pad))< / span >
< a name = "l00466" > < / a > 00466 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00467" > < / a > 00467 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palTogglePad(port, pad) pal_lld_togglepad(port, pad)< / span >
< a name = "l00468" > < / a > 00468 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00469" > < / a > 00469 < span class = "preprocessor" > < / span >
< a name = "l00470" > < / a > 00470 < span class = "comment" > < / span >
< a name = "l00471" > < / a > 00471 < span class = "comment" > /**< / span >
< a name = "l00472" > < / a > 00472 < span class = "comment" > * @brief Pad mode setup.< / span >
< a name = "l00473" > < / a > 00473 < span class = "comment" > * @details This function programs a pad with the specified mode.< / span >
< a name = "l00474" > < / a > 00474 < span class = "comment" > * @note The default implementation not necessarily optimal. Low level< / span >
< a name = "l00475" > < / a > 00475 < span class = "comment" > * drivers may optimize the function by using specific hardware< / span >
< a name = "l00476" > < / a > 00476 < span class = "comment" > * or coding.< / span >
< a name = "l00477" > < / a > 00477 < span class = "comment" > * @note Programming an unknown or unsupported mode is silently ignored.< / span >
< a name = "l00478" > < / a > 00478 < span class = "comment" > *< / span >
< a name = "l00479" > < / a > 00479 < span class = "comment" > * @param[in] port port identifier< / span >
< a name = "l00480" > < / a > 00480 < span class = "comment" > * @param[in] pad pad number within the port< / span >
< a name = "l00481" > < / a > 00481 < span class = "comment" > * @param[in] mode pad mode< / span >
< a name = "l00482" > < / a > 00482 < span class = "comment" > */< / span >
< a name = "l00483" > < / a > 00483 < span class = "preprocessor" > #if !defined(pal_lld_setpadmode) || defined(__DOXYGEN__)< / span >
< a name = "l00484" > < / a > < a class = "code" href = "group___p_a_l.html#gab6377829df3700e742044a2e669c7db7" > 00484< / a > < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetPadMode(port, pad, mode) \< / span >
< a name = "l00485" > < / a > 00485 < span class = "preprocessor" > palSetGroupMode(port, PAL_PORT_BIT(pad), mode)< / span >
< a name = "l00486" > < / a > 00486 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #else< / span >
< a name = "l00487" > < / a > 00487 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define palSetPadMode(port, pad, mode) pal_lld_setpadmode(port, pad, mode)< / span >
< a name = "l00488" > < / a > 00488 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif< / span >
< a name = "l00489" > < / a > 00489 < span class = "preprocessor" > < / span >
< a name = "l00490" > < / a > 00490 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00491" > < / a > 00491 < span class = "comment" > /* External declarations. */< / span >
< a name = "l00492" > < / a > 00492 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00493" > < / a > 00493
< a name = "l00494" > < / a > 00494 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00495" > < / a > 00495 < span class = "preprocessor" > < / span > < span class = "keyword" > extern< / span > < span class = "stringliteral" > " C" < / span > {
< a name = "l00496" > < / a > 00496 < span class = "preprocessor" > #endif< / span >
< a name = "l00497" > < / a > 00497 < span class = "preprocessor" > < / span > < a class = "code" href = "group___p_a_l___l_l_d.html#ga6115967a8db28246105e03741ff5eb18" title = "Digital I/O port sized unsigned type." > ioportmask_t< / a > < a class = "code" href = "group___p_a_l.html#gac464cacee6890a3eab2e2db1b7d8d6f9" title = "Read from an I/O bus." > palReadBus< / a > (< a class = "code" href = "struct_i_o_bus.html" title = "I/O bus descriptor." > IOBus< / a > *bus);
< a name = "l00498" > < / a > 00498 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_a_l.html#ga486b5ab6062e6a8f9d5efdd7a8908a79" title = "Write to an I/O bus." > palWriteBus< / a > (< a class = "code" href = "struct_i_o_bus.html" title = "I/O bus descriptor." > IOBus< / a > *bus, < a class = "code" href = "group___p_a_l___l_l_d.html#ga6115967a8db28246105e03741ff5eb18" title = "Digital I/O port sized unsigned type." > ioportmask_t< / a > bits);
< a name = "l00499" > < / a > 00499 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_a_l.html#ga25ef645e442638716008408357f4ea59" title = "Programs a bus with the specified mode." > palSetBusMode< / a > (< a class = "code" href = "struct_i_o_bus.html" title = "I/O bus descriptor." > IOBus< / a > *bus, < a class = "code" href = "group___s_t_m8___c_o_r_e.html#gad0fca8b15c218d2c687f8c373a71d228" > uint_fast8_t< / a > mode);
< a name = "l00500" > < / a > 00500 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00501" > < / a > 00501 < span class = "preprocessor" > < / span > }
< a name = "l00502" > < / a > 00502 < span class = "preprocessor" > #endif< / span >
< a name = "l00503" > < / a > 00503 < span class = "preprocessor" > < / span >
< a name = "l00504" > < / a > 00504 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _PAL_H_ */< / span >
< a name = "l00505" > < / a > 00505
< a name = "l00506" > < / a > 00506 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_HAL_USE_PAL */< / span >
< a name = "l00507" > < / a > 00507 < span class = "comment" > < / span >
< a name = "l00508" > < / a > 00508 < 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 >