mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
207 lines
20 KiB
HTML
207 lines
20 KiB
HTML
<!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: adc_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">
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<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>
|
|
<div class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<h1>adc_lld.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="templates_2adc__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>
|
|
<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/adc_lld.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief ADC Driver 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 ADC_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 _ADC_LLD_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _ADC_LLD_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_HAL_USE_ADC || 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
|
|
<a name="l00044"></a>00044 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00045"></a>00045 <span class="comment">/* Driver pre-compile time settings. */</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">/* Derived constants and error checks. */</span>
|
|
<a name="l00050"></a>00050 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00051"></a>00051
|
|
<a name="l00052"></a>00052 <span class="preprocessor">#if !CH_USE_SEMAPHORES</span>
|
|
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#error "the ADC driver requires CH_USE_SEMAPHORES"</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00055"></a>00055 <span class="preprocessor"></span>
|
|
<a name="l00056"></a>00056 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00057"></a>00057 <span class="comment">/* Driver data structures and types. */</span>
|
|
<a name="l00058"></a>00058 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00059"></a>00059 <span class="comment"></span>
|
|
<a name="l00060"></a>00060 <span class="comment">/**</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * @brief ADC sample data type.</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> */</span>
|
|
<a name="l00063"></a><a class="code" href="group___a_d_c___l_l_d.html#gac232ced5da9f2b4f5d5adf499c7cb745">00063</a> <span class="keyword">typedef</span> <a class="code" href="group___s_t_m8___c_o_r_e.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> adcsample_t;
|
|
<a name="l00064"></a>00064 <span class="comment"></span>
|
|
<a name="l00065"></a>00065 <span class="comment">/**</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> * @brief Channels number in a conversion group.</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> */</span>
|
|
<a name="l00068"></a><a class="code" href="group___a_d_c___l_l_d.html#ga846a9eca7d0cf63206680e49deb513ec">00068</a> <span class="keyword">typedef</span> <a class="code" href="group___s_t_m8___c_o_r_e.html#ga1f1825b69244eb3ad2c7165ddc99c956">uint16_t</a> adc_channels_num_t;
|
|
<a name="l00069"></a>00069 <span class="comment"></span>
|
|
<a name="l00070"></a>00070 <span class="comment">/**</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> * @brief ADC notification callback type.</span>
|
|
<a name="l00072"></a>00072 <span class="comment"> *</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> * @param[in] buffer pointer to the most recent samples data</span>
|
|
<a name="l00074"></a>00074 <span class="comment"> * @param[in] n number of buffer rows available starting from @p buffer</span>
|
|
<a name="l00075"></a>00075 <span class="comment"> */</span>
|
|
<a name="l00076"></a><a class="code" href="group___a_d_c___l_l_d.html#ga8e0e1e6b7c43117b6bd065dab8069ce0">00076</a> <span class="keyword">typedef</span> void (*<a class="code" href="group___a_d_c___l_l_d.html#ga8e0e1e6b7c43117b6bd065dab8069ce0" title="ADC notification callback type.">adccallback_t</a>)(<a class="code" href="group___a_d_c___l_l_d.html#gac232ced5da9f2b4f5d5adf499c7cb745" title="ADC sample data type.">adcsample_t</a> *buffer, <span class="keywordtype">size_t</span> n);
|
|
<a name="l00077"></a>00077 <span class="comment"></span>
|
|
<a name="l00078"></a>00078 <span class="comment">/**</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> * @brief Conversion group configuration structure.</span>
|
|
<a name="l00080"></a>00080 <span class="comment"> * @details This implementation-dependent structure describes a conversion</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> * operation.</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> */</span>
|
|
<a name="l00083"></a><a class="code" href="struct_a_d_c_conversion_group.html">00083</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span>
|
|
<a name="l00084"></a>00084 <span class="comment"> /**</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * @brief Enables the circular buffer mode for the group.</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> */</span>
|
|
<a name="l00087"></a><a class="code" href="struct_a_d_c_conversion_group.html#a703d0d96235c69bdc0349ee6fc65193f">00087</a> <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> acg_circular;<span class="comment"></span>
|
|
<a name="l00088"></a>00088 <span class="comment"> /**</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * @brief Number of the analog channels belonging to the conversion group.</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> */</span>
|
|
<a name="l00091"></a><a class="code" href="struct_a_d_c_conversion_group.html#a7b5003893448dc7c72f4666e284d3b91">00091</a> <a class="code" href="group___a_d_c___l_l_d.html#ga846a9eca7d0cf63206680e49deb513ec" title="Channels number in a conversion group.">adc_channels_num_t</a> acg_num_channels;
|
|
<a name="l00092"></a>00092 <span class="comment">/* End of the mandatory fields.*/</span>
|
|
<a name="l00093"></a>00093 } <a class="code" href="struct_a_d_c_conversion_group.html" title="Conversion group configuration structure.">ADCConversionGroup</a>;
|
|
<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 Driver configuration structure.</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * @note It could be empty on some architectures.</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> */</span>
|
|
<a name="l00099"></a><a class="code" href="struct_a_d_c_config.html">00099</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00100"></a>00100
|
|
<a name="l00101"></a>00101 } <a class="code" href="struct_a_d_c_config.html" title="Driver configuration structure.">ADCConfig</a>;
|
|
<a name="l00102"></a>00102 <span class="comment"></span>
|
|
<a name="l00103"></a>00103 <span class="comment">/**</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * @brief Structure representing an ADC driver.</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> */</span>
|
|
<a name="l00106"></a><a class="code" href="struct_a_d_c_driver.html">00106</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span>
|
|
<a name="l00107"></a>00107 <span class="comment"> /**</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> * @brief Driver state.</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> */</span>
|
|
<a name="l00110"></a><a class="code" href="struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28">00110</a> <a class="code" href="group___a_d_c.html#ga4cc65f146a01d46dccf54d6f67a1ce30" title="Driver state machine possible states.">adcstate_t</a> ad_state;<span class="comment"></span>
|
|
<a name="l00111"></a>00111 <span class="comment"> /**</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * @brief Current configuration data.</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> */</span>
|
|
<a name="l00114"></a><a class="code" href="struct_a_d_c_driver.html#aa6f1250f7d6a398f200564527a08e1b3">00114</a> <span class="keyword">const</span> <a class="code" href="struct_a_d_c_config.html" title="Driver configuration structure.">ADCConfig</a> *ad_config;<span class="comment"></span>
|
|
<a name="l00115"></a>00115 <span class="comment"> /**</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> * @brief Synchronization semaphore.</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> */</span>
|
|
<a name="l00118"></a><a class="code" href="struct_a_d_c_driver.html#ad27fb341e1688e910dde532009651f9c">00118</a> <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> ad_sem;<span class="comment"></span>
|
|
<a name="l00119"></a>00119 <span class="comment"> /**</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> * @brief Current callback function or @p NULL.</span>
|
|
<a name="l00121"></a>00121 <span class="comment"> */</span>
|
|
<a name="l00122"></a><a class="code" href="struct_a_d_c_driver.html#acfc6a74945032cf8614158ca5547971a">00122</a> <a class="code" href="group___a_d_c___l_l_d.html#ga8e0e1e6b7c43117b6bd065dab8069ce0" title="ADC notification callback type.">adccallback_t</a> ad_callback;<span class="comment"></span>
|
|
<a name="l00123"></a>00123 <span class="comment"> /**</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> * @brief Current samples buffer pointer or @p NULL.</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> */</span>
|
|
<a name="l00126"></a><a class="code" href="struct_a_d_c_driver.html#abc52bc89d22673ed671e6ce50675acd2">00126</a> <a class="code" href="group___a_d_c___l_l_d.html#gac232ced5da9f2b4f5d5adf499c7cb745" title="ADC sample data type.">adcsample_t</a> *ad_samples;<span class="comment"></span>
|
|
<a name="l00127"></a>00127 <span class="comment"> /**</span>
|
|
<a name="l00128"></a>00128 <span class="comment"> * @brief Current samples buffer depth or @p 0.</span>
|
|
<a name="l00129"></a>00129 <span class="comment"> */</span>
|
|
<a name="l00130"></a><a class="code" href="struct_a_d_c_driver.html#aa0af6e2decf71a731b790c4d4a4b1a81">00130</a> <span class="keywordtype">size_t</span> ad_depth;<span class="comment"></span>
|
|
<a name="l00131"></a>00131 <span class="comment"> /**</span>
|
|
<a name="l00132"></a>00132 <span class="comment"> * @brief Current conversion group pointer or @p NULL.</span>
|
|
<a name="l00133"></a>00133 <span class="comment"> */</span>
|
|
<a name="l00134"></a><a class="code" href="struct_a_d_c_driver.html#a19eb4830ebe2f504ee1e0ba8feb17868">00134</a> <span class="keyword">const</span> <a class="code" href="struct_a_d_c_conversion_group.html" title="Conversion group configuration structure.">ADCConversionGroup</a> *ad_grpp;
|
|
<a name="l00135"></a>00135 <span class="comment">/* End of the mandatory fields.*/</span>
|
|
<a name="l00136"></a>00136 } <a class="code" href="struct_a_d_c_driver.html" title="Structure representing an ADC driver.">ADCDriver</a>;
|
|
<a name="l00137"></a>00137
|
|
<a name="l00138"></a>00138 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00139"></a>00139 <span class="comment">/* Driver macros. */</span>
|
|
<a name="l00140"></a>00140 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00141"></a>00141
|
|
<a name="l00142"></a>00142 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00143"></a>00143 <span class="comment">/* External declarations. */</span>
|
|
<a name="l00144"></a>00144 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00145"></a>00145
|
|
<a name="l00146"></a>00146 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00147"></a>00147 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00148"></a>00148 <span class="preprocessor">#endif</span>
|
|
<a name="l00149"></a>00149 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group___a_d_c___l_l_d.html#ga2bfcc655059180451273682ca7e0068c" title="Low level ADC driver initialization.">adc_lld_init</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00150"></a>00150 <span class="keywordtype">void</span> <a class="code" href="group___a_d_c___l_l_d.html#ga9114c26236516afddb6add35ee3251f3" title="Configures and activates the ADC peripheral.">adc_lld_start</a>(<a class="code" href="struct_a_d_c_driver.html" title="Structure representing an ADC driver.">ADCDriver</a> *adcp);
|
|
<a name="l00151"></a>00151 <span class="keywordtype">void</span> <a class="code" href="group___a_d_c___l_l_d.html#ga5f4152006602b187c745bb32f915d679" title="Deactivates the ADC peripheral.">adc_lld_stop</a>(<a class="code" href="struct_a_d_c_driver.html" title="Structure representing an ADC driver.">ADCDriver</a> *adcp);
|
|
<a name="l00152"></a>00152 <span class="keywordtype">void</span> <a class="code" href="group___a_d_c___l_l_d.html#ga5a23ece28ce81cc00e2ddb614d656339" title="Starts an ADC conversion.">adc_lld_start_conversion</a>(<a class="code" href="struct_a_d_c_driver.html" title="Structure representing an ADC driver.">ADCDriver</a> *adcp);
|
|
<a name="l00153"></a>00153 <span class="keywordtype">void</span> <a class="code" href="group___a_d_c___l_l_d.html#ga16ce41e3fdca5b04f046f1e9099f3e92" title="Stops an ongoing conversion.">adc_lld_stop_conversion</a>(<a class="code" href="struct_a_d_c_driver.html" title="Structure representing an ADC driver.">ADCDriver</a> *adcp);
|
|
<a name="l00154"></a>00154 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00155"></a>00155 <span class="preprocessor"></span>}
|
|
<a name="l00156"></a>00156 <span class="preprocessor">#endif</span>
|
|
<a name="l00157"></a>00157 <span class="preprocessor"></span>
|
|
<a name="l00158"></a>00158 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_ADC */</span>
|
|
<a name="l00159"></a>00159
|
|
<a name="l00160"></a>00160 <span class="preprocessor">#endif </span><span class="comment">/* _ADC_LLD_H_ */</span>
|
|
<a name="l00161"></a>00161 <span class="comment"></span>
|
|
<a name="l00162"></a>00162 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Nov 28 2010 14:09:48 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>
|
|
</body>
|
|
</html>
|