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
41272c2ab7
gnuk/ChibiOS_2.0.8/docs/html/struct_a_d_c_driver.html
NIIBE Yutaka c560d0ad0c import ChibiOS 2.0.8
2010-11-30 13:54:43 +09:00

276 lines
18 KiB
HTML
Raw Blame History

<!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: ADCDriver Struct Reference</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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>ADCDriver Struct Reference<br/>
<small>
[<a class="el" href="group___a_d_c___l_l_d.html">ADC Low Level Driver</a>,&nbsp;<a class="el" href="group___s_t_m32___a_d_c.html">STM32 ADC Support</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ADCDriver" -->
<p>Structure representing an ADC driver.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="templates_2adc__lld_8h_source.html">adc_lld.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ADCDriver:</div>
<div class="dyncontent">
<div class="center"><img src="struct_a_d_c_driver__coll__graph.png" border="0" usemap="#_a_d_c_driver_coll__map" alt="Collaboration graph"/></div>
<map name="_a_d_c_driver_coll__map" id="_a_d_c_driver_coll__map">
<area shape="rect" id="node2" href="struct_semaphore.html" title="Semaphore structure." alt="" coords="13,214,91,306"/>
<area shape="rect" id="node4" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element." alt="" coords="5,6,99,98"/>
<area shape="rect" id="node6" href="struct_a_d_c_config.html" title="Driver configuration structure." alt="" coords="115,221,189,299"/>
<area shape="rect" id="node8" href="struct_a_d_c_conversion_group.html" title="Conversion group configuration structure." alt="" coords="213,163,341,357"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___a_d_c.html#ga4cc65f146a01d46dccf54d6f67a1ce30">adcstate_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28">ad_state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Driver state. <a href="#aad88dcc5b92e368e1ec5b095df1a9f28"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_a_d_c_config.html">ADCConfig</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#aa6f1250f7d6a398f200564527a08e1b3">ad_config</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current configuration data. <a href="#aa6f1250f7d6a398f200564527a08e1b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_semaphore.html">Semaphore</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#ad27fb341e1688e910dde532009651f9c">ad_sem</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Synchronization semaphore. <a href="#ad27fb341e1688e910dde532009651f9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_t_m32___a_d_c.html#ga8e0e1e6b7c43117b6bd065dab8069ce0">adccallback_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#acfc6a74945032cf8614158ca5547971a">ad_callback</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current callback function or <code>NULL</code>. <a href="#acfc6a74945032cf8614158ca5547971a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___a_d_c___l_l_d.html#gac232ced5da9f2b4f5d5adf499c7cb745">adcsample_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#abc52bc89d22673ed671e6ce50675acd2">ad_samples</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current samples buffer pointer or <code>NULL</code>. <a href="#abc52bc89d22673ed671e6ce50675acd2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#aa0af6e2decf71a731b790c4d4a4b1a81">ad_depth</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current samples buffer depth or <code>0</code>. <a href="#aa0af6e2decf71a731b790c4d4a4b1a81"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_a_d_c_conversion_group.html">ADCConversionGroup</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#a19eb4830ebe2f504ee1e0ba8feb17868">ad_grpp</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current conversion group pointer or <code>NULL</code>. <a href="#a19eb4830ebe2f504ee1e0ba8feb17868"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ADC_TypeDef *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#a7ec9718e0c7ceb2ac84a75b79d71a16c">ad_adc</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the ADCx registers block. <a href="#a7ec9718e0c7ceb2ac84a75b79d71a16c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DMA_Channel_TypeDef *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#a0da4f6e1686cc09ad309cd1e0794c0a1">ad_dma</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the DMA channel registers block. <a href="#a0da4f6e1686cc09ad309cd1e0794c0a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_d_c_driver.html#ae6d3147446a5221edff4a1c8423a37fd">ad_dmaprio</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">DMA priority bit mask. <a href="#ae6d3147446a5221edff4a1c8423a37fd"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Structure representing an ADC driver. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00106">106</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="aad88dcc5b92e368e1ec5b095df1a9f28"></a><!-- doxytag: member="ADCDriver::ad_state" ref="aad88dcc5b92e368e1ec5b095df1a9f28" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___a_d_c.html#ga4cc65f146a01d46dccf54d6f67a1ce30">adcstate_t</a> <a class="el" href="struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28">ADCDriver::ad_state</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Driver state. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00110">110</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, <a class="el" href="group___a_d_c.html#ga92f8b4434b8199323b1469e0479de7f8">adcStart()</a>, <a class="el" href="group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641">adcStartConversion()</a>, <a class="el" href="group___a_d_c.html#ga3caf934a28b65e6a5eda3e882ca06845">adcStop()</a>, <a class="el" href="group___a_d_c.html#gabce14d8f240e85715cded02c85b6585a">adcStopConversion()</a>, <a class="el" href="group___a_d_c.html#ga026ac46dfe36031ab177e35f3aff5b09">adcWaitConversion()</a>, and <a class="el" href="group___s_t_m32___a_d_c.html#ga727ca25370379b53e77a820e7bfee540">CH_IRQ_HANDLER()</a>.</p>
</div>
</div>
<a class="anchor" id="aa6f1250f7d6a398f200564527a08e1b3"></a><!-- doxytag: member="ADCDriver::ad_config" ref="aa6f1250f7d6a398f200564527a08e1b3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_a_d_c_config.html">ADCConfig</a> * <a class="el" href="struct_a_d_c_driver.html#aa6f1250f7d6a398f200564527a08e1b3">ADCDriver::ad_config</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current configuration data. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00114">114</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, and <a class="el" href="group___a_d_c.html#ga92f8b4434b8199323b1469e0479de7f8">adcStart()</a>.</p>
</div>
</div>
<a class="anchor" id="ad27fb341e1688e910dde532009651f9c"></a><!-- doxytag: member="ADCDriver::ad_sem" ref="ad27fb341e1688e910dde532009651f9c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_semaphore.html">Semaphore</a> <a class="el" href="struct_a_d_c_driver.html#ad27fb341e1688e910dde532009651f9c">ADCDriver::ad_sem</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Synchronization semaphore. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00118">118</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, <a class="el" href="group___a_d_c.html#gabce14d8f240e85715cded02c85b6585a">adcStopConversion()</a>, <a class="el" href="group___a_d_c.html#ga026ac46dfe36031ab177e35f3aff5b09">adcWaitConversion()</a>, and <a class="el" href="group___s_t_m32___a_d_c.html#ga727ca25370379b53e77a820e7bfee540">CH_IRQ_HANDLER()</a>.</p>
</div>
</div>
<a class="anchor" id="acfc6a74945032cf8614158ca5547971a"></a><!-- doxytag: member="ADCDriver::ad_callback" ref="acfc6a74945032cf8614158ca5547971a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___s_t_m32___a_d_c.html#ga8e0e1e6b7c43117b6bd065dab8069ce0">adccallback_t</a> <a class="el" href="struct_a_d_c_driver.html#acfc6a74945032cf8614158ca5547971a">ADCDriver::ad_callback</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current callback function or <code>NULL</code>. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00122">122</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, <a class="el" href="group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641">adcStartConversion()</a>, and <a class="el" href="group___s_t_m32___a_d_c.html#ga727ca25370379b53e77a820e7bfee540">CH_IRQ_HANDLER()</a>.</p>
</div>
</div>
<a class="anchor" id="abc52bc89d22673ed671e6ce50675acd2"></a><!-- doxytag: member="ADCDriver::ad_samples" ref="abc52bc89d22673ed671e6ce50675acd2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___a_d_c___l_l_d.html#gac232ced5da9f2b4f5d5adf499c7cb745">adcsample_t</a> * <a class="el" href="struct_a_d_c_driver.html#abc52bc89d22673ed671e6ce50675acd2">ADCDriver::ad_samples</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current samples buffer pointer or <code>NULL</code>. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00126">126</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, <a class="el" href="group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641">adcStartConversion()</a>, and <a class="el" href="group___s_t_m32___a_d_c.html#ga727ca25370379b53e77a820e7bfee540">CH_IRQ_HANDLER()</a>.</p>
</div>
</div>
<a class="anchor" id="aa0af6e2decf71a731b790c4d4a4b1a81"></a><!-- doxytag: member="ADCDriver::ad_depth" ref="aa0af6e2decf71a731b790c4d4a4b1a81" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="struct_a_d_c_driver.html#aa0af6e2decf71a731b790c4d4a4b1a81">ADCDriver::ad_depth</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current samples buffer depth or <code>0</code>. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00130">130</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, <a class="el" href="group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641">adcStartConversion()</a>, and <a class="el" href="group___s_t_m32___a_d_c.html#ga727ca25370379b53e77a820e7bfee540">CH_IRQ_HANDLER()</a>.</p>
</div>
</div>
<a class="anchor" id="a19eb4830ebe2f504ee1e0ba8feb17868"></a><!-- doxytag: member="ADCDriver::ad_grpp" ref="a19eb4830ebe2f504ee1e0ba8feb17868" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_a_d_c_conversion_group.html">ADCConversionGroup</a> * <a class="el" href="struct_a_d_c_driver.html#a19eb4830ebe2f504ee1e0ba8feb17868">ADCDriver::ad_grpp</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current conversion group pointer or <code>NULL</code>. </p>
<p>Definition at line <a class="el" href="templates_2adc__lld_8h_source.html#l00134">134</a> of file <a class="el" href="templates_2adc__lld_8h_source.html">templates/adc_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___a_d_c.html#gac7f619e304c79c17f19221d05138d405">adcObjectInit()</a>, <a class="el" href="group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641">adcStartConversion()</a>, <a class="el" href="group___a_d_c.html#gabce14d8f240e85715cded02c85b6585a">adcStopConversion()</a>, and <a class="el" href="group___s_t_m32___a_d_c.html#ga727ca25370379b53e77a820e7bfee540">CH_IRQ_HANDLER()</a>.</p>
</div>
</div>
<a class="anchor" id="a7ec9718e0c7ceb2ac84a75b79d71a16c"></a><!-- doxytag: member="ADCDriver::ad_adc" ref="a7ec9718e0c7ceb2ac84a75b79d71a16c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ADC_TypeDef* <a class="el" href="struct_a_d_c_driver.html#a7ec9718e0c7ceb2ac84a75b79d71a16c">ADCDriver::ad_adc</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the ADCx registers block. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2adc__lld_8h_source.html#l00226">226</a> of file <a class="el" href="platforms_2_s_t_m32_2adc__lld_8h_source.html">platforms/STM32/adc_lld.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0da4f6e1686cc09ad309cd1e0794c0a1"></a><!-- doxytag: member="ADCDriver::ad_dma" ref="a0da4f6e1686cc09ad309cd1e0794c0a1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DMA_Channel_TypeDef* <a class="el" href="struct_a_d_c_driver.html#a0da4f6e1686cc09ad309cd1e0794c0a1">ADCDriver::ad_dma</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the DMA channel registers block. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2adc__lld_8h_source.html#l00230">230</a> of file <a class="el" href="platforms_2_s_t_m32_2adc__lld_8h_source.html">platforms/STM32/adc_lld.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae6d3147446a5221edff4a1c8423a37fd"></a><!-- doxytag: member="ADCDriver::ad_dmaprio" ref="ae6d3147446a5221edff4a1c8423a37fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="el" href="struct_a_d_c_driver.html#ae6d3147446a5221edff4a1c8423a37fd">ADCDriver::ad_dmaprio</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>DMA priority bit mask. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2adc__lld_8h_source.html#l00234">234</a> of file <a class="el" href="platforms_2_s_t_m32_2adc__lld_8h_source.html">platforms/STM32/adc_lld.h</a>.</p>
</div>
</div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Nov 28 2010 14:09:59 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.7.1</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink