coelner/gnuk
1
0
Fork 0
mirror of https://salsa.debian.org/gnuk-team/gnuk/gnuk.git synced 2024-09-21 11:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
6e6d97db5f
gnuk/ChibiOS_2.0.2/docs/html/pal_8c_source.html

162 lines
16 KiB
HTML
Raw Normal View History

Initial import
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.c 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">
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>pal.c</h1><a href="pal_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<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 &lt;http://www.gnu.org/licenses/&gt;.</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.c</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief I/O Ports Abstraction Layer code.</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">#include &quot;<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>&quot;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="hal_8h.html" title="HAL subsystem header.">hal.h</a>&quot;</span>
<a name="l00037"></a>00037
<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 exported variables. */</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">/* Driver local variables. */</span>
<a name="l00046"></a>00046 <span class="comment">/*===========================================================================*/</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/*===========================================================================*/</span>
<a name="l00049"></a>00049 <span class="comment">/* Driver local functions. */</span>
<a name="l00050"></a>00050 <span class="comment">/*===========================================================================*/</span>
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">/*===========================================================================*/</span>
<a name="l00053"></a>00053 <span class="comment">/* Driver exported functions. */</span>
<a name="l00054"></a>00054 <span class="comment">/*===========================================================================*/</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">/**</span>
<a name="l00057"></a>00057 <span class="comment"> * @brief Read from an I/O bus.</span>
<a name="l00058"></a>00058 <span class="comment"> * @note The operation is not guaranteed to be atomic on all the</span>
<a name="l00059"></a>00059 <span class="comment"> * architectures, for atomicity and/or portability reasons you may</span>
<a name="l00060"></a>00060 <span class="comment"> * need to enclose port I/O operations between @p chSysLock() and</span>
<a name="l00061"></a>00061 <span class="comment"> * @p chSysUnlock().</span>
<a name="l00062"></a>00062 <span class="comment"> * @note The function internally uses the @p palReadGroup() macro. The use</span>
<a name="l00063"></a>00063 <span class="comment"> * of this function is preferred when you value code size, readability</span>
<a name="l00064"></a>00064 <span class="comment"> * and error checking over speed.</span>
<a name="l00065"></a>00065 <span class="comment"> *</span>
<a name="l00066"></a>00066 <span class="comment"> * @param[in] bus the I/O bus, pointer to a @p IOBus structure</span>
<a name="l00067"></a>00067 <span class="comment"> * @return The bus logical states.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a><a class="code" href="group___p_a_l.html#gac464cacee6890a3eab2e2db1b7d8d6f9">00069</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> <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="l00070"></a>00070
<a name="l00071"></a>00071 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((bus != NULL) &amp;&amp;
<a name="l00072"></a>00072 (bus-&gt;<a class="code" href="struct_i_o_bus.html#a50c155a7f9aa5b254faa372f0619286a" title="Offset, within the port, of the least significant bit of the bus.">bus_offset</a> &gt; <a class="code" href="group___p_a_l___l_l_d.html#ga20ffc1985d583352e179f5f2c3fa700e" title="Width, in bits, of an I/O port.">PAL_IOPORTS_WIDTH</a>), <span class="stringliteral">&quot;palReadBus&quot;</span>);
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keywordflow">return</span> <a class="code" href="group___p_a_l.html#gad286cfdb9f088a7c8e5085d19ac728d3" title="Reads a group of bits.">palReadGroup</a>(bus-&gt;<a class="code" href="struct_i_o_bus.html#a79c1372324fc1d9d2c571ac6d47163f9" title="Port identifier.">bus_portid</a>, bus-&gt;<a class="code" href="struct_i_o_bus.html#ab2efb4f2a7504ac2e737de26c1e4f33a" title="Bus mask aligned to port bit 0.">bus_mask</a>, bus-&gt;<a class="code" href="struct_i_o_bus.html#a50c155a7f9aa5b254faa372f0619286a" title="Offset, within the port, of the least significant bit of the bus.">bus_offset</a>);
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">/**</span>
<a name="l00078"></a>00078 <span class="comment"> * @brief Write to an I/O bus.</span>
<a name="l00079"></a>00079 <span class="comment"> * @note The operation is not guaranteed to be atomic on all the</span>
<a name="l00080"></a>00080 <span class="comment"> * architectures, for atomicity and/or portability reasons you may</span>
<a name="l00081"></a>00081 <span class="comment"> * need to enclose port I/O operations between @p chSysLock() and</span>
<a name="l00082"></a>00082 <span class="comment"> * @p chSysUnlock().</span>
<a name="l00083"></a>00083 <span class="comment"> * @note The default implementation is non atomic and not necessarily</span>
<a name="l00084"></a>00084 <span class="comment"> * optimal. Low level drivers may optimize the function by using</span>
<a name="l00085"></a>00085 <span class="comment"> * specific hardware or coding.</span>
<a name="l00086"></a>00086 <span class="comment"> *</span>
<a name="l00087"></a>00087 <span class="comment"> * @param[in] bus the I/O bus, pointer to a @p IOBus structure</span>
<a name="l00088"></a>00088 <span class="comment"> * @param[in] bits the bits to be written on the I/O bus. Values exceeding</span>
<a name="l00089"></a>00089 <span class="comment"> * the bus width are masked so most significant bits are</span>
<a name="l00090"></a>00090 <span class="comment"> * lost.</span>
<a name="l00091"></a>00091 <span class="comment"> */</span>
<a name="l00092"></a><a class="code" href="group___p_a_l.html#ga486b5ab6062e6a8f9d5efdd7a8908a79">00092</a> <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="l00093"></a>00093
<a name="l00094"></a>00094 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((bus != NULL) &amp;&amp;
<a name="l00095"></a>00095 (bus-&gt;<a class="code" href="struct_i_o_bus.html#a50c155a7f9aa5b254faa372f0619286a" title="Offset, within the port, of the least significant bit of the bus.">bus_offset</a> &gt; <a class="code" href="group___p_a_l___l_l_d.html#ga20ffc1985d583352e179f5f2c3fa700e" title="Width, in bits, of an I/O port.">PAL_IOPORTS_WIDTH</a>), <span class="stringliteral">&quot;palWriteBus&quot;</span>);
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <a class="code" href="group___p_a_l.html#gacb25ee0b16d9fb701e3fd21e5dbb990a" title="Writes a group of bits.">palWriteGroup</a>(bus-&gt;<a class="code" href="struct_i_o_bus.html#a79c1372324fc1d9d2c571ac6d47163f9" title="Port identifier.">bus_portid</a>, bus-&gt;<a class="code" href="struct_i_o_bus.html#ab2efb4f2a7504ac2e737de26c1e4f33a" title="Bus mask aligned to port bit 0.">bus_mask</a>, bus-&gt;<a class="code" href="struct_i_o_bus.html#a50c155a7f9aa5b254faa372f0619286a" title="Offset, within the port, of the least significant bit of the bus.">bus_offset</a>, bits);
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment">/**</span>
<a name="l00101"></a>00101 <span class="comment"> * @brief Programs a bus with the specified mode.</span>
<a name="l00102"></a>00102 <span class="comment"> * @note The operation is not guaranteed to be atomic on all the</span>
<a name="l00103"></a>00103 <span class="comment"> * architectures, for atomicity and/or portability reasons you may</span>
<a name="l00104"></a>00104 <span class="comment"> * need to enclose port I/O operations between @p chSysLock() and</span>
<a name="l00105"></a>00105 <span class="comment"> * @p chSysUnlock().</span>
<a name="l00106"></a>00106 <span class="comment"> * @note The default implementation is non atomic and not necessarily</span>
<a name="l00107"></a>00107 <span class="comment"> * optimal. Low level drivers may optimize the function by using</span>
<a name="l00108"></a>00108 <span class="comment"> * specific hardware or coding.</span>
<a name="l00109"></a>00109 <span class="comment"> *</span>
<a name="l00110"></a>00110 <span class="comment"> * @param[in] bus the I/O bus, pointer to a @p IOBus structure</span>
<a name="l00111"></a>00111 <span class="comment"> * @param[in] mode the mode</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a><a class="code" href="group___p_a_l.html#ga25ef645e442638716008408357f4ea59">00113</a> <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="l00114"></a>00114
<a name="l00115"></a>00115 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((bus != NULL) &amp;&amp;
<a name="l00116"></a>00116 (bus-&gt;<a class="code" href="struct_i_o_bus.html#a50c155a7f9aa5b254faa372f0619286a" title="Offset, within the port, of the least significant bit of the bus.">bus_offset</a> &gt; <a class="code" href="group___p_a_l___l_l_d.html#ga20ffc1985d583352e179f5f2c3fa700e" title="Width, in bits, of an I/O port.">PAL_IOPORTS_WIDTH</a>), <span class="stringliteral">&quot;palSetBusMode&quot;</span>);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <a class="code" href="group___p_a_l.html#ga24789efd90288773d2f928458d1dc6e5" title="Pads group mode setup.">palSetGroupMode</a>(bus-&gt;<a class="code" href="struct_i_o_bus.html#a79c1372324fc1d9d2c571ac6d47163f9" title="Port identifier.">bus_portid</a>, bus-&gt;<a class="code" href="struct_i_o_bus.html#ab2efb4f2a7504ac2e737de26c1e4f33a" title="Bus mask aligned to port bit 0.">bus_mask</a>, mode);
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_PAL */</span>
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">/** @} */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Jul 11 13:13:01 2010 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.3</small></address>
</body>
</html>
Reference in New Issue Copy Permalink