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: adc.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" >
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 > adc.c< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "adc_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 >
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 adc.c< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief ADC Driver code.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > *< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @addtogroup ADC< / 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 " < a class = "code" href = "ch_8h.html" title = "ChibiOS/RT main include file." > ch.h< / a > " < / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > #include " < a class = "code" href = "hal_8h.html" title = "HAL subsystem header." > hal.h< / a > " < / span >
< a name = "l00037" > < / a > 00037
< 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 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 ADC Driver initialization.< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > */< / span >
< a name = "l00059" > < / a > < a class = "code" href = "group___a_d_c.html#gafd645b17cf0581bcaa22c56011c775e4" > 00059< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___a_d_c.html#gafd645b17cf0581bcaa22c56011c775e4" title = "ADC Driver initialization." > adcInit< / a > (< span class = "keywordtype" > void< / span > ) {
< a name = "l00060" > < / a > 00060
< a name = "l00061" > < / a > 00061 < a class = "code" href = "group___a_d_c___l_l_d.html#ga2bfcc655059180451273682ca7e0068c" title = "Low level ADC driver initialization." > adc_lld_init< / a > ();
< a name = "l00062" > < / a > 00062 }
< a name = "l00063" > < / a > 00063 < span class = "comment" > < / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > /**< / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > * @brief Initializes the standard part of a @p ADCDriver structure.< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > *< / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > * @param[in] adcp pointer to the @p ADCDriver object< / span >
< a name = "l00068" > < / a > 00068 < span class = "comment" > */< / span >
< a name = "l00069" > < / a > < a class = "code" href = "group___a_d_c.html#gac7f619e304c79c17f19221d05138d405" > 00069< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___a_d_c.html#gac7f619e304c79c17f19221d05138d405" title = "Initializes the standard part of a ADCDriver structure." > adcObjectInit< / a > (< a class = "code" href = "struct_a_d_c_driver.html" title = "Structure representing an ADC driver." > ADCDriver< / a > *adcp) {
< a name = "l00070" > < / a > 00070
2010-11-22 05:53:37 +00:00
< a name = "l00071" > < / a > 00071 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > = ADC_STOP;
2010-08-10 03:11:02 +00:00
< a name = "l00072" > < / a > 00072 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aa6f1250f7d6a398f200564527a08e1b3" title = "Current configuration data." > ad_config< / a > = NULL;
< a name = "l00073" > < / a > 00073 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#acfc6a74945032cf8614158ca5547971a" title = "Current callback function or NULL." > ad_callback< / a > = NULL;
< a name = "l00074" > < / a > 00074 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#abc52bc89d22673ed671e6ce50675acd2" title = "Current samples buffer pointer or NULL." > ad_samples< / a > = NULL;
< a name = "l00075" > < / a > 00075 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aa0af6e2decf71a731b790c4d4a4b1a81" title = "Current samples buffer depth or 0." > ad_depth< / a > = 0;
< a name = "l00076" > < / a > 00076 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#a19eb4830ebe2f504ee1e0ba8feb17868" title = "Current conversion group pointer or NULL." > ad_grpp< / a > = NULL;
< a name = "l00077" > < / a > 00077 < a class = "code" href = "group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title = "Initializes a semaphore with the specified counter value." > chSemInit< / a > (& adcp-> < a class = "code" href = "struct_a_d_c_driver.html#ad27fb341e1688e910dde532009651f9c" title = "Synchronization semaphore." > ad_sem< / a > , 0);
< a name = "l00078" > < / a > 00078 }
< a name = "l00079" > < / a > 00079 < span class = "comment" > < / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > /**< / span >
< a name = "l00081" > < / a > 00081 < span class = "comment" > * @brief Configures and activates the ADC peripheral.< / span >
< a name = "l00082" > < / a > 00082 < span class = "comment" > *< / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > * @param[in] adcp pointer to the @p ADCDriver object< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > * @param[in] config pointer to the @p ADCConfig object< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > */< / span >
< a name = "l00086" > < / a > < a class = "code" href = "group___a_d_c.html#ga92f8b4434b8199323b1469e0479de7f8" > 00086< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___a_d_c.html#ga92f8b4434b8199323b1469e0479de7f8" title = "Configures and activates the ADC peripheral." > adcStart< / a > (< a class = "code" href = "struct_a_d_c_driver.html" title = "Structure representing an ADC driver." > ADCDriver< / a > *adcp, < span class = "keyword" > const< / span > < a class = "code" href = "struct_a_d_c_config.html" title = "Driver configuration structure." > ADCConfig< / a > *config) {
< a name = "l00087" > < / a > 00087
< a name = "l00088" > < / a > 00088 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((adcp != NULL) & & (config != NULL), < span class = "stringliteral" > " adcStart" < / span > );
< a name = "l00089" > < / a > 00089
< a name = "l00090" > < / a > 00090 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00091" > < / a > 00091 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a3ce5b3b06ffd24b358cf65efdee69f30" title = "Stopped." > ADC_STOP< / a > ) || (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a7f2a1a2c5aece4f36847bf5cea31cd14" title = "Ready." > ADC_READY< / a > ),
< a name = "l00092" > < / a > 00092 < span class = "stringliteral" > " adcStart(), #1" < / span > ,
< a name = "l00093" > < / a > 00093 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00094" > < / a > 00094 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aa6f1250f7d6a398f200564527a08e1b3" title = "Current configuration data." > ad_config< / a > = config;
< a name = "l00095" > < / a > 00095 < a class = "code" href = "group___a_d_c___l_l_d.html#ga9114c26236516afddb6add35ee3251f3" title = "Configures and activates the ADC peripheral." > adc_lld_start< / a > (adcp);
2010-11-22 05:53:37 +00:00
< a name = "l00096" > < / a > 00096 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > = ADC_READY;
2010-08-10 03:11:02 +00:00
< a name = "l00097" > < / a > 00097 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< 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 Deactivates the ADC peripheral.< / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > *< / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > * @param[in] adcp pointer to the @p ADCDriver object< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > */< / span >
< a name = "l00105" > < / a > < a class = "code" href = "group___a_d_c.html#ga3caf934a28b65e6a5eda3e882ca06845" > 00105< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___a_d_c.html#ga3caf934a28b65e6a5eda3e882ca06845" title = "Deactivates the ADC peripheral." > adcStop< / a > (< a class = "code" href = "struct_a_d_c_driver.html" title = "Structure representing an ADC driver." > ADCDriver< / a > *adcp) {
< a name = "l00106" > < / a > 00106
< a name = "l00107" > < / a > 00107 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (adcp != NULL, < span class = "stringliteral" > " adcStop" < / span > );
< a name = "l00108" > < / a > 00108
< a name = "l00109" > < / a > 00109 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00110" > < / a > 00110 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a3ce5b3b06ffd24b358cf65efdee69f30" title = "Stopped." > ADC_STOP< / a > ) ||
< a name = "l00111" > < / a > 00111 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a7f2a1a2c5aece4f36847bf5cea31cd14" title = "Ready." > ADC_READY< / a > ) ||
< a name = "l00112" > < / a > 00112 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a90848166c82f38aa379ec0f89ca29ac8" title = "Conversion complete." > ADC_COMPLETE< / a > ),
< a name = "l00113" > < / a > 00113 < span class = "stringliteral" > " adcStop(), #1" < / span > ,
< a name = "l00114" > < / a > 00114 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00115" > < / a > 00115 < a class = "code" href = "group___a_d_c___l_l_d.html#ga5f4152006602b187c745bb32f915d679" title = "Deactivates the ADC peripheral." > adc_lld_stop< / a > (adcp);
2010-11-22 05:53:37 +00:00
< a name = "l00116" > < / a > 00116 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > = ADC_STOP;
2010-08-10 03:11:02 +00:00
< a name = "l00117" > < / a > 00117 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00118" > < / a > 00118 }
< a name = "l00119" > < / a > 00119 < span class = "comment" > < / span >
< a name = "l00120" > < / a > 00120 < span class = "comment" > /**< / span >
< a name = "l00121" > < / a > 00121 < span class = "comment" > * @brief Starts an ADC conversion.< / span >
< a name = "l00122" > < / a > 00122 < span class = "comment" > * @details Starts a conversion operation, there are two kind of conversion< / span >
< a name = "l00123" > < / a > 00123 < span class = "comment" > * modes:< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00124" > < / a > 00124 < span class = "comment" > * - < b> LINEAR< /b> , in this mode the buffer is filled once and then< / span >
< a name = "l00125" > < / a > 00125 < span class = "comment" > * the conversion stops automatically.< / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > * - < b> CIRCULAR< /b> , in this mode the conversion never stops and< / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > * the buffer is filled circularly.< br> < / span >
< a name = "l00128" > < / a > 00128 < span class = "comment" > * During the conversion the callback function is invoked when< / span >
< a name = "l00129" > < / a > 00129 < span class = "comment" > * the buffer is 50% filled and when the buffer is 100% filled,< / span >
< a name = "l00130" > < / a > 00130 < span class = "comment" > * this way is possible to process the conversion stream in real< / span >
< a name = "l00131" > < / a > 00131 < span class = "comment" > * time. This kind of conversion can only be stopped by explicitly< / span >
< a name = "l00132" > < / a > 00132 < span class = "comment" > * invoking @p adcStopConversion().< / span >
< a name = "l00133" > < / a > 00133 < span class = "comment" > * .< / span >
< a name = "l00134" > < / a > 00134 < span class = "comment" > * @note The buffer is organized as a matrix of M*N elements where M is the< / span >
< a name = "l00135" > < / a > 00135 < span class = "comment" > * channels number configured into the conversion group and N is the< / span >
< a name = "l00136" > < / a > 00136 < span class = "comment" > * buffer depth. The samples are sequentially written into the buffer< / span >
< a name = "l00137" > < / a > 00137 < span class = "comment" > * with no gaps.< / span >
< a name = "l00138" > < / a > 00138 < span class = "comment" > *< / span >
< a name = "l00139" > < / a > 00139 < span class = "comment" > * @param[in] adcp pointer to the @p ADCDriver object< / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > * @param[in] grpp pointer to a @p ADCConversionGroup object< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > * @param[out] samples pointer to the samples buffer< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > * @param[in] depth buffer depth (matrix rows number). The buffer depth< / span >
< a name = "l00143" > < / a > 00143 < span class = "comment" > * must be one or an even number.< / span >
< a name = "l00144" > < / a > 00144 < span class = "comment" > * @param[in] callback pointer to the conversion callback function, this< / span >
< a name = "l00145" > < / a > 00145 < span class = "comment" > * parameter can be @p NULL if a callback is not required< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00146" > < / a > 00146 < span class = "comment" > * @return The operation status.< / span >
< a name = "l00147" > < / a > 00147 < span class = "comment" > * @retval FALSE the conversion has been started.< / span >
< a name = "l00148" > < / a > 00148 < span class = "comment" > * @retval TRUE the driver is busy, conversion not started.< / span >
< a name = "l00149" > < / a > 00149 < span class = "comment" > */< / span >
< a name = "l00150" > < / a > < a class = "code" href = "group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641" > 00150< / a > < a class = "code" href = "group__types.html#ga7556af1cb61728b53228fa3af1c851de" title = "Boolean, recommended the fastest signed." > bool_t< / a > < a class = "code" href = "group___a_d_c.html#gadb9905e3fcd0f053ca1e07e9686bf641" title = "Starts an ADC conversion." > adcStartConversion< / 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 = "keyword" > const< / span > < a class = "code" href = "struct_a_d_c_conversion_group.html" title = "Conversion group configuration structure." > ADCConversionGroup< / a > *grpp,
< a name = "l00152" > < / a > 00152 < a class = "code" href = "group___a_d_c___l_l_d.html#gac232ced5da9f2b4f5d5adf499c7cb745" title = "ADC sample data type." > adcsample_t< / a > *samples,
< a name = "l00153" > < / a > 00153 < span class = "keywordtype" > size_t< / span > depth,
< a name = "l00154" > < / a > 00154 < a class = "code" href = "group___a_d_c___l_l_d.html#ga8e0e1e6b7c43117b6bd065dab8069ce0" title = "ADC notification callback type." > adccallback_t< / a > callback) {
< a name = "l00155" > < / a > 00155
< a name = "l00156" > < / a > 00156 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((adcp != NULL) & & (grpp != NULL) & & (samples != NULL) & &
< a name = "l00157" > < / a > 00157 ((depth == 1) || ((depth & 1) == 0)),
< a name = "l00158" > < / a > 00158 < span class = "stringliteral" > " adcStartConversion" < / span > );
< a name = "l00159" > < / a > 00159
< a name = "l00160" > < / a > 00160 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00161" > < / a > 00161 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a7f2a1a2c5aece4f36847bf5cea31cd14" title = "Ready." > ADC_READY< / a > ) ||
< a name = "l00162" > < / a > 00162 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30ac7e9b56ff40aed13ba7bf7ee6ed6fc20" title = "Conversion running." > ADC_RUNNING< / a > ) ||
< a name = "l00163" > < / a > 00163 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a90848166c82f38aa379ec0f89ca29ac8" title = "Conversion complete." > ADC_COMPLETE< / a > ),
< a name = "l00164" > < / a > 00164 < span class = "stringliteral" > " adcStartConversion(), #1" < / span > ,
< a name = "l00165" > < / a > 00165 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00166" > < / a > 00166 < span class = "keywordflow" > if< / span > (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30ac7e9b56ff40aed13ba7bf7ee6ed6fc20" title = "Conversion running." > ADC_RUNNING< / a > ) {
< a name = "l00167" > < / a > 00167 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00168" > < / a > 00168 < span class = "keywordflow" > return< / span > TRUE;
< a name = "l00169" > < / a > 00169 }
< a name = "l00170" > < / a > 00170 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#acfc6a74945032cf8614158ca5547971a" title = "Current callback function or NULL." > ad_callback< / a > = callback;
< a name = "l00171" > < / a > 00171 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#abc52bc89d22673ed671e6ce50675acd2" title = "Current samples buffer pointer or NULL." > ad_samples< / a > = samples;
< a name = "l00172" > < / a > 00172 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aa0af6e2decf71a731b790c4d4a4b1a81" title = "Current samples buffer depth or 0." > ad_depth< / a > = depth;
< a name = "l00173" > < / a > 00173 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#a19eb4830ebe2f504ee1e0ba8feb17868" title = "Current conversion group pointer or NULL." > ad_grpp< / a > = grpp;
< a name = "l00174" > < / a > 00174 < a class = "code" href = "group___a_d_c___l_l_d.html#ga5a23ece28ce81cc00e2ddb614d656339" title = "Starts an ADC conversion." > adc_lld_start_conversion< / a > (adcp);
2010-11-22 05:53:37 +00:00
< a name = "l00175" > < / a > 00175 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > = ADC_RUNNING;
2010-08-10 03:11:02 +00:00
< a name = "l00176" > < / a > 00176 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00177" > < / a > 00177 < span class = "keywordflow" > return< / span > FALSE;
< a name = "l00178" > < / a > 00178 }
< a name = "l00179" > < / a > 00179 < span class = "comment" > < / span >
< a name = "l00180" > < / a > 00180 < span class = "comment" > /**< / span >
< a name = "l00181" > < / a > 00181 < span class = "comment" > * @brief Stops an ongoing conversion.< / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > *< / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > * @param[in] adcp pointer to the @p ADCDriver object< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > */< / span >
< a name = "l00185" > < / a > < a class = "code" href = "group___a_d_c.html#gabce14d8f240e85715cded02c85b6585a" > 00185< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___a_d_c.html#gabce14d8f240e85715cded02c85b6585a" title = "Stops an ongoing conversion." > adcStopConversion< / a > (< a class = "code" href = "struct_a_d_c_driver.html" title = "Structure representing an ADC driver." > ADCDriver< / a > *adcp) {
< a name = "l00186" > < / a > 00186
< a name = "l00187" > < / a > 00187 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (adcp != NULL, < span class = "stringliteral" > " adcStopConversion" < / span > );
< a name = "l00188" > < / a > 00188
< a name = "l00189" > < / a > 00189 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00190" > < / a > 00190 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a7f2a1a2c5aece4f36847bf5cea31cd14" title = "Ready." > ADC_READY< / a > ) ||
< a name = "l00191" > < / a > 00191 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30ac7e9b56ff40aed13ba7bf7ee6ed6fc20" title = "Conversion running." > ADC_RUNNING< / a > ) ||
< a name = "l00192" > < / a > 00192 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a90848166c82f38aa379ec0f89ca29ac8" title = "Conversion complete." > ADC_COMPLETE< / a > ),
< a name = "l00193" > < / a > 00193 < span class = "stringliteral" > " adcStopConversion(), #1" < / span > ,
< a name = "l00194" > < / a > 00194 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00195" > < / a > 00195 < span class = "keywordflow" > if< / span > (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30ac7e9b56ff40aed13ba7bf7ee6ed6fc20" title = "Conversion running." > ADC_RUNNING< / a > ) {
< a name = "l00196" > < / a > 00196 < a class = "code" href = "group___a_d_c___l_l_d.html#ga16ce41e3fdca5b04f046f1e9099f3e92" title = "Stops an ongoing conversion." > adc_lld_stop_conversion< / a > (adcp);
< a name = "l00197" > < / a > 00197 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#a19eb4830ebe2f504ee1e0ba8feb17868" title = "Current conversion group pointer or NULL." > ad_grpp< / a > = NULL;
2010-11-22 05:53:37 +00:00
< a name = "l00198" > < / a > 00198 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > = ADC_READY;
2010-08-10 03:11:02 +00:00
< a name = "l00199" > < / a > 00199 < a class = "code" href = "group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title = "Performs a reset operation on the semaphore." > chSemResetI< / a > (& adcp-> < a class = "code" href = "struct_a_d_c_driver.html#ad27fb341e1688e910dde532009651f9c" title = "Synchronization semaphore." > ad_sem< / a > , 0);
< a name = "l00200" > < / a > 00200 < a class = "code" href = "group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title = "Performs a reschedule if a higher priority thread is runnable." > chSchRescheduleS< / a > ();
< a name = "l00201" > < / a > 00201 }
< a name = "l00202" > < / a > 00202 < span class = "keywordflow" > else< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00203" > < / a > 00203 adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > = ADC_READY;
2010-08-10 03:11:02 +00:00
< a name = "l00204" > < / a > 00204 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00205" > < / a > 00205 }
< a name = "l00206" > < / a > 00206 < span class = "comment" > < / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > /**< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > * @brief Waits for completion.< / span >
< a name = "l00209" > < / a > 00209 < span class = "comment" > * @details If the conversion is not completed or not yet started then the< / span >
< a name = "l00210" > < / a > 00210 < span class = "comment" > * invoking thread waits for a conversion completion event.< / span >
< a name = "l00211" > < / a > 00211 < span class = "comment" > *< / span >
< a name = "l00212" > < / a > 00212 < span class = "comment" > * @param[in] adcp pointer to the @p ADCDriver object< / span >
< a name = "l00213" > < / a > 00213 < span class = "comment" > * @param[in] timeout the number of ticks before the operation timeouts,< / span >
< a name = "l00214" > < / a > 00214 < span class = "comment" > * the following special values are allowed:< / span >
< a name = "l00215" > < / a > 00215 < span class = "comment" > * - @a TIME_IMMEDIATE immediate timeout.< / span >
< a name = "l00216" > < / a > 00216 < span class = "comment" > * - @a TIME_INFINITE no timeout.< / span >
< a name = "l00217" > < / a > 00217 < span class = "comment" > * .< / span >
< a name = "l00218" > < / a > 00218 < span class = "comment" > * @return The operation result.< / span >
< a name = "l00219" > < / a > 00219 < span class = "comment" > * @retval RDY_OK conversion finished.< / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > * @retval RDY_TIMEOUT conversion not finished within the specified time.< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > */< / span >
< a name = "l00222" > < / a > < a class = "code" href = "group___a_d_c.html#ga026ac46dfe36031ab177e35f3aff5b09" > 00222< / a > < a class = "code" href = "group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title = "Message, use signed pointer equivalent." > msg_t< / a > < a class = "code" href = "group___a_d_c.html#ga026ac46dfe36031ab177e35f3aff5b09" title = "Waits for completion." > adcWaitConversion< / a > (< a class = "code" href = "struct_a_d_c_driver.html" title = "Structure representing an ADC driver." > ADCDriver< / a > *adcp, < a class = "code" href = "group__types.html#gae3e32a98d431a02106616da3071832dd" title = "System Time, recommended fastest unsigned." > systime_t< / a > timeout) {
< a name = "l00223" > < / a > 00223
< a name = "l00224" > < / a > 00224 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00225" > < / a > 00225 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a7f2a1a2c5aece4f36847bf5cea31cd14" title = "Ready." > ADC_READY< / a > ) ||
< a name = "l00226" > < / a > 00226 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30ac7e9b56ff40aed13ba7bf7ee6ed6fc20" title = "Conversion running." > ADC_RUNNING< / a > ) ||
< a name = "l00227" > < / a > 00227 (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > == < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a90848166c82f38aa379ec0f89ca29ac8" title = "Conversion complete." > ADC_COMPLETE< / a > ),
< a name = "l00228" > < / a > 00228 < span class = "stringliteral" > " adcWaitConversion(), #1" < / span > ,
< a name = "l00229" > < / a > 00229 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00230" > < / a > 00230 < span class = "keywordflow" > if< / span > (adcp-> < a class = "code" href = "struct_a_d_c_driver.html#aad88dcc5b92e368e1ec5b095df1a9f28" title = "Driver state." > ad_state< / a > != < a class = "code" href = "group___a_d_c.html#gga4cc65f146a01d46dccf54d6f67a1ce30a90848166c82f38aa379ec0f89ca29ac8" title = "Conversion complete." > ADC_COMPLETE< / a > ) {
< a name = "l00231" > < / a > 00231 < span class = "keywordflow" > if< / span > (< a class = "code" href = "group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title = "Performs a wait operation on a semaphore with timeout specification." > chSemWaitTimeoutS< / a > (& adcp-> < a class = "code" href = "struct_a_d_c_driver.html#ad27fb341e1688e910dde532009651f9c" title = "Synchronization semaphore." > ad_sem< / a > , timeout) == < a class = "code" href = "group__scheduler.html#gaf28d5427eeeb8f737cc7db495157780c" title = "Low level message sent to a thread awakened by a timeout." > RDY_TIMEOUT< / a > ) {
< a name = "l00232" > < / a > 00232 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
2010-11-22 05:53:37 +00:00
< a name = "l00233" > < / a > 00233 < span class = "keywordflow" > return< / span > RDY_TIMEOUT;
2010-08-10 03:11:02 +00:00
< a name = "l00234" > < / a > 00234 }
< a name = "l00235" > < / a > 00235 }
< a name = "l00236" > < / a > 00236 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
2010-11-22 05:53:37 +00:00
< a name = "l00237" > < / a > 00237 < span class = "keywordflow" > return< / span > RDY_OK;
2010-08-10 03:11:02 +00:00
< a name = "l00238" > < / a > 00238 }
< a name = "l00239" > < / a > 00239
< a name = "l00240" > < / a > 00240 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_HAL_USE_ADC */< / span >
< a name = "l00241" > < / a > 00241 < span class = "comment" > < / span >
< a name = "l00242" > < / a > 00242 < 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:36 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 >
