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: spi.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 > spi.c< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "spi_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 spi.c< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief SPI Driver code.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > *< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @addtogroup SPI< / 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_SPI || 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 SPI Driver initialization.< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > */< / span >
< a name = "l00059" > < / a > < a class = "code" href = "group___s_p_i.html#ga3c484a97cdec02c5dbf46a11245e3395" > 00059< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga3c484a97cdec02c5dbf46a11245e3395" title = "SPI Driver initialization." > spiInit< / a > (< span class = "keywordtype" > void< / span > ) {
< a name = "l00060" > < / a > 00060
< a name = "l00061" > < / a > 00061 < a class = "code" href = "group___s_p_i___l_l_d.html#ga5bdaf423b4fa6a78a1689b5a7721ea7e" title = "Low level SPI driver initialization." > spi_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 SPIDriver structure.< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > *< / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00068" > < / a > 00068 < span class = "comment" > */< / span >
< a name = "l00069" > < / a > < a class = "code" href = "group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf" > 00069< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf" title = "Initializes the standard part of a SPIDriver structure." > spiObjectInit< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip) {
< a name = "l00070" > < / a > 00070
2010-11-22 05:53:37 +00:00
< a name = "l00071" > < / a > 00071 spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > = SPI_STOP;
< a name = "l00072" > < / a > 00072 < span class = "preprocessor" > #if SPI_USE_MUTUAL_EXCLUSION< / span >
< a name = "l00073" > < / a > 00073 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #if CH_USE_MUTEXES< / span >
< a name = "l00074" > < / a > 00074 < span class = "preprocessor" > < / span > < a class = "code" href = "group__mutexes.html#gac55fe4d05aa6bbeb31594193d2e4d2b6" title = "Initializes s Mutex structure." > chMtxInit< / a > (& spip-> < a class = "code" href = "struct_s_p_i_driver.html#aad4a0dbb074013406c4bce20d1cb9326" title = "Mutex protecting the bus." > spd_mutex< / a > );
< a name = "l00075" > < / a > 00075 < span class = "preprocessor" > #else< / span >
< a name = "l00076" > < / a > 00076 < span class = "preprocessor" > < / span > < a class = "code" href = "group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title = "Initializes a semaphore with the specified counter value." > chSemInit< / a > (& spip-> spd_semaphore, 1);
< a name = "l00077" > < / a > 00077 < span class = "preprocessor" > #endif< / span >
< a name = "l00078" > < / a > 00078 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* SPI_USE_MUTUAL_EXCLUSION */< / span >
< a name = "l00079" > < / a > 00079 spip-> < a class = "code" href = "struct_s_p_i_driver.html#a5dd4d2ee17acb22bf3e14dc8fa392195" title = "Current configuration data." > spd_config< / a > = NULL;
< a name = "l00080" > < / a > 00080 }
< a name = "l00081" > < / a > 00081 < span class = "comment" > < / span >
< a name = "l00082" > < / a > 00082 < span class = "comment" > /**< / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > * @brief Configures and activates the SPI peripheral.< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > *< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > * @param[in] config pointer to the @p SPIConfig object< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > */< / span >
< a name = "l00088" > < / a > < a class = "code" href = "group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e" > 00088< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e" title = "Configures and activates the SPI peripheral." > spiStart< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip, < span class = "keyword" > const< / span > < a class = "code" href = "struct_s_p_i_config.html" title = "Driver configuration structure." > SPIConfig< / a > *config) {
2010-08-10 03:11:02 +00:00
< a name = "l00089" > < / a > 00089
2010-11-22 05:53:37 +00:00
< a name = "l00090" > < / a > 00090 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((spip != NULL) & & (config != NULL), < span class = "stringliteral" > " spiStart" < / span > );
< a name = "l00091" > < / a > 00091
< a name = "l00092" > < / a > 00092 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00093" > < / a > 00093 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a22a603b07f381cba1ced3de36a0c3ce7" title = "Stopped." > SPI_STOP< / a > ) || (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba" title = "Ready." > SPI_READY< / a > ),
< a name = "l00094" > < / a > 00094 < span class = "stringliteral" > " spiStart(), #1" < / span > ,
< a name = "l00095" > < / a > 00095 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00096" > < / a > 00096 spip-> < a class = "code" href = "struct_s_p_i_driver.html#a5dd4d2ee17acb22bf3e14dc8fa392195" title = "Current configuration data." > spd_config< / a > = config;
< a name = "l00097" > < / a > 00097 < a class = "code" href = "group___s_p_i___l_l_d.html#gaf35495bd4459608ae22a3f728fd4697b" title = "Configures and activates the SPI peripheral." > spi_lld_start< / a > (spip);
< a name = "l00098" > < / a > 00098 spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > = SPI_READY;
< a name = "l00099" > < / a > 00099 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00100" > < / a > 00100 }
< a name = "l00101" > < / a > 00101 < span class = "comment" > < / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > /**< / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > * @brief Deactivates the SPI peripheral.< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > *< / span >
< a name = "l00105" > < / a > 00105 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00106" > < / a > 00106 < span class = "comment" > */< / span >
< a name = "l00107" > < / a > < a class = "code" href = "group___s_p_i.html#gad3a359eea03e68e95899886ae93a06e4" > 00107< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#gad3a359eea03e68e95899886ae93a06e4" title = "Deactivates the SPI peripheral." > spiStop< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip) {
2010-08-10 03:11:02 +00:00
< a name = "l00108" > < / a > 00108
2010-11-22 05:53:37 +00:00
< a name = "l00109" > < / a > 00109 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (spip != NULL, < span class = "stringliteral" > " spiStop" < / span > );
< a name = "l00110" > < / a > 00110
< a name = "l00111" > < / a > 00111 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00112" > < / a > 00112 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a22a603b07f381cba1ced3de36a0c3ce7" title = "Stopped." > SPI_STOP< / a > ) || (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba" title = "Ready." > SPI_READY< / a > ),
< a name = "l00113" > < / a > 00113 < span class = "stringliteral" > " spiStop(), #1" < / span > ,
< a name = "l00114" > < / a > 00114 < span class = "stringliteral" > " invalid state" < / span > );
< a name = "l00115" > < / a > 00115 < a class = "code" href = "group___s_p_i___l_l_d.html#ga8d6b2e0764d39b892b51e6abe4923f80" title = "Deactivates the SPI peripheral." > spi_lld_stop< / a > (spip);
< a name = "l00116" > < / a > 00116 spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > = SPI_STOP;
< 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 Asserts the slave select signal and prepares for transfers.< / span >
< a name = "l00122" > < / a > 00122 < span class = "comment" > *< / span >
< a name = "l00123" > < / a > 00123 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00124" > < / a > 00124 < span class = "comment" > */< / span >
< a name = "l00125" > < / a > < a class = "code" href = "group___s_p_i.html#ga00809152c869db80192aa3e04266a99a" > 00125< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga00809152c869db80192aa3e04266a99a" title = "Asserts the slave select signal and prepares for transfers." > spiSelect< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip) {
2010-08-10 03:11:02 +00:00
< a name = "l00126" > < / a > 00126
2010-11-22 05:53:37 +00:00
< a name = "l00127" > < / a > 00127 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (spip != NULL, < span class = "stringliteral" > " spiSelect" < / span > );
< a name = "l00128" > < / a > 00128
< a name = "l00129" > < / a > 00129 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00130" > < / a > 00130 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba" title = "Ready." > SPI_READY< / a > ) ||
< a name = "l00131" > < / a > 00131 (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title = "Slave selected." > SPI_ACTIVE< / a > ),
< a name = "l00132" > < / a > 00132 < span class = "stringliteral" > " spiSelect(), #1" < / span > ,
< a name = "l00133" > < / a > 00133 < span class = "stringliteral" > " not idle" < / span > );
< a name = "l00134" > < / a > 00134 < a class = "code" href = "group___s_p_i___l_l_d.html#ga5a671d4e8d120120a26d9bfb0c016507" title = "Asserts the slave select signal and prepares for transfers." > spi_lld_select< / a > (spip);
< a name = "l00135" > < / a > 00135 spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > = SPI_ACTIVE;
< a name = "l00136" > < / a > 00136 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00137" > < / a > 00137 }
< a name = "l00138" > < / a > 00138 < span class = "comment" > < / span >
< a name = "l00139" > < / a > 00139 < span class = "comment" > /**< / span >
< a name = "l00140" > < / a > 00140 < span class = "comment" > * @brief Deasserts the slave select signal.< / span >
< a name = "l00141" > < / a > 00141 < span class = "comment" > * @details The previously selected peripheral is unselected.< / span >
< a name = "l00142" > < / a > 00142 < span class = "comment" > *< / span >
< a name = "l00143" > < / a > 00143 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00144" > < / a > 00144 < span class = "comment" > */< / span >
< a name = "l00145" > < / a > < a class = "code" href = "group___s_p_i.html#gae291c012872da9c89dec23581f701b5f" > 00145< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#gae291c012872da9c89dec23581f701b5f" title = "Deasserts the slave select signal." > spiUnselect< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip) {
2010-08-10 03:11:02 +00:00
< a name = "l00146" > < / a > 00146
2010-11-22 05:53:37 +00:00
< a name = "l00147" > < / a > 00147 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (spip != NULL, < span class = "stringliteral" > " spiUnselect" < / span > );
< a name = "l00148" > < / a > 00148
< a name = "l00149" > < / a > 00149 < a class = "code" href = "group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title = "Enters the kernel lock mode." > chSysLock< / a > ();
< a name = "l00150" > < / a > 00150 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba" title = "Ready." > SPI_READY< / a > ) ||
< a name = "l00151" > < / a > 00151 (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title = "Slave selected." > SPI_ACTIVE< / a > ),
< a name = "l00152" > < / a > 00152 < span class = "stringliteral" > " spiUnselect(), #1" < / span > ,
< a name = "l00153" > < / a > 00153 < span class = "stringliteral" > " not locked" < / span > );
< a name = "l00154" > < / a > 00154 < a class = "code" href = "group___s_p_i___l_l_d.html#gafa343fd905298991aa4005015263bcd2" title = "Deasserts the slave select signal." > spi_lld_unselect< / a > (spip);
< a name = "l00155" > < / a > 00155 spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > = SPI_READY;
< a name = "l00156" > < / a > 00156 < a class = "code" href = "group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title = "Leaves the kernel lock mode." > chSysUnlock< / a > ();
< a name = "l00157" > < / a > 00157 }
< a name = "l00158" > < / a > 00158 < span class = "comment" > < / span >
< a name = "l00159" > < / a > 00159 < span class = "comment" > /**< / span >
< a name = "l00160" > < / a > 00160 < span class = "comment" > * @brief Ignores data on the SPI bus.< / span >
< a name = "l00161" > < / a > 00161 < span class = "comment" > * @details This function transmits a series of idle words on the SPI bus and< / span >
< a name = "l00162" > < / a > 00162 < span class = "comment" > * ignores the received data. This function can be invoked even< / span >
< a name = "l00163" > < / a > 00163 < span class = "comment" > * when a slave select signal has not been yet asserted.< / span >
< a name = "l00164" > < / a > 00164 < span class = "comment" > *< / span >
< a name = "l00165" > < / a > 00165 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00166" > < / a > 00166 < span class = "comment" > * @param[in] n number of words to be ignored< / span >
< a name = "l00167" > < / a > 00167 < span class = "comment" > */< / span >
< a name = "l00168" > < / a > < a class = "code" href = "group___s_p_i.html#ga43889a7d4c473f653596f8c0acafce2a" > 00168< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga43889a7d4c473f653596f8c0acafce2a" title = "Ignores data on the SPI bus." > spiIgnore< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip, < span class = "keywordtype" > size_t< / span > n) {
< a name = "l00169" > < / a > 00169
< a name = "l00170" > < / a > 00170 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((spip != NULL) & & (n > 0), < span class = "stringliteral" > " spiIgnore" < / span > );
< a name = "l00171" > < / a > 00171 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > ((spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba" title = "Ready." > SPI_READY< / a > ) || (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title = "Slave selected." > SPI_ACTIVE< / a > ),
< a name = "l00172" > < / a > 00172 < span class = "stringliteral" > " spiIgnore(), #1" < / span > ,
< a name = "l00173" > < / a > 00173 < span class = "stringliteral" > " not active" < / span > );
< a name = "l00174" > < / a > 00174
< a name = "l00175" > < / a > 00175 < a class = "code" href = "group___s_p_i___l_l_d.html#ga076fdc5d74009a7917723b663984d502" title = "Ignores data on the SPI bus." > spi_lld_ignore< / a > (spip, n);
< a name = "l00176" > < / a > 00176 }
< a name = "l00177" > < / a > 00177 < span class = "comment" > < / span >
< a name = "l00178" > < / a > 00178 < span class = "comment" > /**< / span >
< a name = "l00179" > < / a > 00179 < span class = "comment" > * @brief Exchanges data on the SPI bus.< / span >
< a name = "l00180" > < / a > 00180 < span class = "comment" > * @details This function performs a simultaneous transmit/receive operation.< / span >
< a name = "l00181" > < / a > 00181 < span class = "comment" > * @note The buffers are organized as uint8_t arrays for data sizes below< / span >
< a name = "l00182" > < / a > 00182 < span class = "comment" > * or equal to 8 bits else it is organized as uint16_t arrays.< / span >
< a name = "l00183" > < / a > 00183 < span class = "comment" > *< / span >
< a name = "l00184" > < / a > 00184 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00185" > < / a > 00185 < span class = "comment" > * @param[in] n number of words to be exchanged< / span >
< a name = "l00186" > < / a > 00186 < span class = "comment" > * @param[in] txbuf the pointer to the transmit buffer< / span >
< a name = "l00187" > < / a > 00187 < span class = "comment" > * @param[out] rxbuf the pointer to the receive buffer< / span >
< a name = "l00188" > < / a > 00188 < span class = "comment" > */< / span >
< a name = "l00189" > < / a > < a class = "code" href = "group___s_p_i.html#gaf1c59f3fd2f85620a5253c23d9586095" > 00189< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#gaf1c59f3fd2f85620a5253c23d9586095" title = "Exchanges data on the SPI bus." > spiExchange< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip, < span class = "keywordtype" > size_t< / span > n, < span class = "keyword" > const< / span > < span class = "keywordtype" > void< / span > *txbuf, < span class = "keywordtype" > void< / span > *rxbuf) {
< a name = "l00190" > < / a > 00190
< a name = "l00191" > < / a > 00191 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((spip != NULL) & & (n > 0) & & (rxbuf != NULL) & & (txbuf != NULL),
< a name = "l00192" > < / a > 00192 < span class = "stringliteral" > " spiExchange" < / span > );
< a name = "l00193" > < / a > 00193 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title = "Slave selected." > SPI_ACTIVE< / a > ,
< a name = "l00194" > < / a > 00194 < span class = "stringliteral" > " spiExchange(), #1" < / span > ,
< a name = "l00195" > < / a > 00195 < span class = "stringliteral" > " not active" < / span > );
< a name = "l00196" > < / a > 00196
< a name = "l00197" > < / a > 00197 < a class = "code" href = "group___s_p_i___l_l_d.html#ga61b61b0999c813c1d8a3ddc415e8b0c7" title = "Exchanges data on the SPI bus." > spi_lld_exchange< / a > (spip, n, txbuf, rxbuf);
< a name = "l00198" > < / a > 00198 }
< a name = "l00199" > < / a > 00199 < span class = "comment" > < / span >
< a name = "l00200" > < / a > 00200 < span class = "comment" > /**< / span >
< a name = "l00201" > < / a > 00201 < span class = "comment" > * @brief Sends data over the SPI bus.< / span >
< a name = "l00202" > < / a > 00202 < span class = "comment" > * @note The buffers are organized as uint8_t arrays for data sizes below< / span >
< a name = "l00203" > < / a > 00203 < span class = "comment" > * or equal to 8 bits else it is organized as uint16_t arrays.< / span >
< a name = "l00204" > < / a > 00204 < span class = "comment" > *< / span >
< a name = "l00205" > < / a > 00205 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00206" > < / a > 00206 < span class = "comment" > * @param[in] n number of words to send< / span >
< a name = "l00207" > < / a > 00207 < span class = "comment" > * @param[in] txbuf the pointer to the transmit buffer< / span >
< a name = "l00208" > < / a > 00208 < span class = "comment" > */< / span >
< a name = "l00209" > < / a > < a class = "code" href = "group___s_p_i.html#ga382cfbdffd2df57cf3843d45164e8bfc" > 00209< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga382cfbdffd2df57cf3843d45164e8bfc" title = "Sends data over the SPI bus." > spiSend< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip, < span class = "keywordtype" > size_t< / span > n, < span class = "keyword" > const< / span > < span class = "keywordtype" > void< / span > *txbuf) {
< a name = "l00210" > < / a > 00210
< a name = "l00211" > < / a > 00211 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((spip != NULL) & & (n > 0) & & (txbuf != NULL),
< a name = "l00212" > < / a > 00212 < span class = "stringliteral" > " spiSend" < / span > );
< a name = "l00213" > < / a > 00213 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title = "Slave selected." > SPI_ACTIVE< / a > ,
< a name = "l00214" > < / a > 00214 < span class = "stringliteral" > " spiSend(), #1" < / span > ,
< a name = "l00215" > < / a > 00215 < span class = "stringliteral" > " not active" < / span > );
< a name = "l00216" > < / a > 00216
< a name = "l00217" > < / a > 00217 < a class = "code" href = "group___s_p_i___l_l_d.html#gaa460d53de2de1c3bac67f95fe04da0fe" title = "Sends data ever the SPI bus." > spi_lld_send< / a > (spip, n, txbuf);
< a name = "l00218" > < / a > 00218 }
< a name = "l00219" > < / a > 00219 < span class = "comment" > < / span >
< a name = "l00220" > < / a > 00220 < span class = "comment" > /**< / span >
< a name = "l00221" > < / a > 00221 < span class = "comment" > * @brief Receives data from the SPI bus.< / span >
< a name = "l00222" > < / a > 00222 < span class = "comment" > * @note The buffers are organized as uint8_t arrays for data sizes below< / span >
< a name = "l00223" > < / a > 00223 < span class = "comment" > * or equal to 8 bits else it is organized as uint16_t arrays.< / span >
< a name = "l00224" > < / a > 00224 < span class = "comment" > *< / span >
< a name = "l00225" > < / a > 00225 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00226" > < / a > 00226 < span class = "comment" > * @param[in] n number of words to receive< / span >
< a name = "l00227" > < / a > 00227 < span class = "comment" > * @param[out] rxbuf the pointer to the receive buffer< / span >
< a name = "l00228" > < / a > 00228 < span class = "comment" > */< / span >
< a name = "l00229" > < / a > < a class = "code" href = "group___s_p_i.html#gadd99ad823b391dde114f04dedafe5e80" > 00229< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#gadd99ad823b391dde114f04dedafe5e80" title = "Receives data from the SPI bus." > spiReceive< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip, < span class = "keywordtype" > size_t< / span > n, < span class = "keywordtype" > void< / span > *rxbuf) {
< a name = "l00230" > < / a > 00230
< a name = "l00231" > < / a > 00231 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > ((spip != NULL) & & (n > 0) & & (rxbuf != NULL),
< a name = "l00232" > < / a > 00232 < span class = "stringliteral" > " spiReceive" < / span > );
< a name = "l00233" > < / a > 00233 < a class = "code" href = "group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title = "Condition assertion." > chDbgAssert< / a > (spip-> < a class = "code" href = "struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title = "Driver state." > spd_state< / a > == < a class = "code" href = "group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title = "Slave selected." > SPI_ACTIVE< / a > ,
< a name = "l00234" > < / a > 00234 < span class = "stringliteral" > " spiReceive(), #1" < / span > ,
< a name = "l00235" > < / a > 00235 < span class = "stringliteral" > " not active" < / span > );
< a name = "l00236" > < / a > 00236
< a name = "l00237" > < / a > 00237 < a class = "code" href = "group___s_p_i___l_l_d.html#ga5b608b91dcec69818b2b3977a0d98bcb" title = "Receives data from the SPI bus." > spi_lld_receive< / a > (spip, n, rxbuf);
< a name = "l00238" > < / a > 00238 }
< a name = "l00239" > < / a > 00239
< a name = "l00240" > < / a > 00240 < span class = "preprocessor" > #if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)< / span >
< a name = "l00241" > < / a > 00241 < span class = "preprocessor" > < / span > < span class = "comment" > /**< / span >
< a name = "l00242" > < / a > 00242 < span class = "comment" > * @brief Gains exclusive access to the SPI bus.< / span >
< a name = "l00243" > < / a > 00243 < span class = "comment" > * @details This function tries to gain ownership to the SPI bus, if the bus< / span >
< a name = "l00244" > < / a > 00244 < span class = "comment" > * is already being used then the invoking thread is queued.< / span >
< a name = "l00245" > < / a > 00245 < span class = "comment" > * @note This function is only available when the @p SPI_USE_MUTUAL_EXCLUSION< / span >
< a name = "l00246" > < / a > 00246 < span class = "comment" > * option is set to @p TRUE.< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00247" > < / a > 00247 < span class = "comment" > *< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00248" > < / a > 00248 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00249" > < / a > 00249 < span class = "comment" > *< / span >
< a name = "l00250" > < / a > 00250 < span class = "comment" > */< / span >
< a name = "l00251" > < / a > < a class = "code" href = "group___s_p_i.html#ga803cec73f6dd8d3d1f18fb6a61b8255a" > 00251< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga803cec73f6dd8d3d1f18fb6a61b8255a" title = "Gains exclusive access to the SPI bus." > spiAcquireBus< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip) {
2010-08-10 03:11:02 +00:00
< a name = "l00252" > < / a > 00252
2010-11-22 05:53:37 +00:00
< a name = "l00253" > < / a > 00253 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (spip != NULL, < span class = "stringliteral" > " spiAcquireBus" < / span > );
< a name = "l00254" > < / a > 00254
< a name = "l00255" > < / a > 00255 < span class = "preprocessor" > #if CH_USE_MUTEXES< / span >
< a name = "l00256" > < / a > 00256 < span class = "preprocessor" > < / span > < a class = "code" href = "group__mutexes.html#gafa06b82e3496c44eb7bf31d9f1b655ba" title = "Locks the specified mutex." > chMtxLock< / a > (& spip-> < a class = "code" href = "struct_s_p_i_driver.html#aad4a0dbb074013406c4bce20d1cb9326" title = "Mutex protecting the bus." > spd_mutex< / a > );
< a name = "l00257" > < / a > 00257 < span class = "preprocessor" > #elif CH_USE_SEMAPHORES< / span >
< a name = "l00258" > < / a > 00258 < span class = "preprocessor" > < / span > < a class = "code" href = "group__semaphores.html#gabc8f7e509870e9b0527a6a68fad71425" title = "Performs a wait operation on a semaphore." > chSemWait< / a > (& spip-> spd_semaphore);
< a name = "l00259" > < / a > 00259 < span class = "preprocessor" > #endif< / span >
< a name = "l00260" > < / a > 00260 < span class = "preprocessor" > < / span > }
< a name = "l00261" > < / a > 00261 < span class = "comment" > < / span >
< a name = "l00262" > < / a > 00262 < span class = "comment" > /**< / span >
< a name = "l00263" > < / a > 00263 < span class = "comment" > * @brief Releases exclusive access to the SPI bus.< / span >
< a name = "l00264" > < / a > 00264 < span class = "comment" > * @note This function is only available when the @p SPI_USE_MUTUAL_EXCLUSION< / span >
< a name = "l00265" > < / a > 00265 < span class = "comment" > * option is set to @p TRUE.< / span >
< a name = "l00266" > < / a > 00266 < span class = "comment" > *< / span >
< a name = "l00267" > < / a > 00267 < span class = "comment" > * @param[in] spip pointer to the @p SPIDriver object< / span >
< a name = "l00268" > < / a > 00268 < span class = "comment" > */< / span >
< a name = "l00269" > < / a > < a class = "code" href = "group___s_p_i.html#ga1b04a2410ef4323ee4e37c63f320c18f" > 00269< / a > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___s_p_i.html#ga1b04a2410ef4323ee4e37c63f320c18f" title = "Releases exclusive access to the SPI bus." > spiReleaseBus< / a > (< a class = "code" href = "struct_s_p_i_driver.html" title = "Structure representing a SPI driver." > SPIDriver< / a > *spip) {
2010-08-10 03:11:02 +00:00
< a name = "l00270" > < / a > 00270
2010-11-22 05:53:37 +00:00
< a name = "l00271" > < / a > 00271 < a class = "code" href = "group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title = "Function parameter check." > chDbgCheck< / a > (spip != NULL, < span class = "stringliteral" > " spiReleaseBus" < / span > );
< a name = "l00272" > < / a > 00272
< a name = "l00273" > < / a > 00273 < span class = "preprocessor" > #if CH_USE_MUTEXES< / span >
< a name = "l00274" > < / a > 00274 < span class = "preprocessor" > < / span > (void)spip;
< a name = "l00275" > < / a > 00275 < a class = "code" href = "group__mutexes.html#gae9ae07165126c9f6c0ce0b17bdb53669" title = "Unlocks the next owned mutex in reverse lock order." > chMtxUnlock< / a > ();
< a name = "l00276" > < / a > 00276 < span class = "preprocessor" > #elif CH_USE_SEMAPHORES< / span >
< a name = "l00277" > < / a > 00277 < span class = "preprocessor" > < / span > < a class = "code" href = "group__semaphores.html#ga7ec0cbda23e49e2370e0b91f20baf05e" title = "Performs a signal operation on a semaphore." > chSemSignal< / a > (& spip-> spd_semaphore);
< a name = "l00278" > < / a > 00278 < span class = "preprocessor" > #endif< / span >
< a name = "l00279" > < / a > 00279 < span class = "preprocessor" > < / span > }
< a name = "l00280" > < / a > 00280 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* SPI_USE_MUTUAL_EXCLUSION */< / span >
< a name = "l00281" > < / a > 00281
< a name = "l00282" > < / a > 00282 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_HAL_USE_SPI */< / span >
< a name = "l00283" > < / a > 00283 < span class = "comment" > < / span >
< a name = "l00284" > < / a > 00284 < span class = "comment" > /** @} */< / span >
2010-08-10 03:11:02 +00:00
< / pre > < / div > < / div >
2010-11-22 05:53:37 +00:00
< / div >
2010-08-10 03:11:02 +00:00
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >