aboutsummaryrefslogtreecommitdiffstats
path: root/os/io/platforms/STM32/spi_lld.h
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-10-24 07:28:54 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-10-24 07:28:54 +0000
commit09194e6f2232390b16ed37c65cf750bd47bc4bf4 (patch)
tree1cb7783d9e0582a32ff79ac0fd67e28907864d8d /os/io/platforms/STM32/spi_lld.h
parent78089875470cd21e6ee5edb98ba61c417d556735 (diff)
downloadChibiOS-09194e6f2232390b16ed37c65cf750bd47bc4bf4.tar.gz
ChibiOS-09194e6f2232390b16ed37c65cf750bd47bc4bf4.tar.bz2
ChibiOS-09194e6f2232390b16ed37c65cf750bd47bc4bf4.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1250 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/io/platforms/STM32/spi_lld.h')
-rw-r--r--os/io/platforms/STM32/spi_lld.h112
1 files changed, 112 insertions, 0 deletions
diff --git a/os/io/platforms/STM32/spi_lld.h b/os/io/platforms/STM32/spi_lld.h
new file mode 100644
index 000000000..26a70d0a4
--- /dev/null
+++ b/os/io/platforms/STM32/spi_lld.h
@@ -0,0 +1,112 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @file templates/spi_lld.h
+ * @brief SPI Driver subsystem low level driver header template
+ * @addtogroup SPI_LLD
+ * @{
+ */
+
+#ifndef _SPI_LLD_H_
+#define _SPI_LLD_H_
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @brief Enables the mutual exclusion APIs on the SPI bus.
+ */
+#if !defined(SPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
+#define SPI_USE_MUTUAL_EXCLUSION TRUE
+#endif
+
+#if SPI_USE_MUTUAL_EXCLUSION && !CH_USE_MUTEXES && !CH_USE_SEMAPHORES
+#error "SPI_USE_MUTUAL_EXCLUSION requires CH_USE_MUTEXES and/or CH_USE_SEMAPHORES"
+#endif
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Driver state machine possible states.
+ */
+typedef enum {
+ SPI_UNINIT = 0,//!< SPI_UNINIT
+ SPI_IDLE = 1, //!< SPI_IDLE
+ SPI_ACTIVE = 2 //!< SPI_ACTIVE
+} spistate_t;
+
+/**
+ * @brief Driver configuration structure.
+ */
+typedef struct {
+ /**
+ * @brief Clock pulses to be generated after initialization.
+ */
+ cnt_t spc_clkpulses;
+ /* End of the mandatory fields.*/
+} SPIConfig;
+
+/**
+ * @brief Structure representing a MAC driver.
+ */
+typedef struct {
+ /**
+ * @brief Driver state.
+ */
+ spistate_t spd_state;
+#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
+#if CH_USE_MUTEXES || defined(__DOXYGEN__)
+ /**
+ * @brief Mutex protecting the bus.
+ */
+ Mutex spd_mutex;
+#elif CH_USE_SEMAPHORES
+ Semaphore spd_semaphore;
+#endif
+#endif /* SPI_USE_MUTUAL_EXCLUSION */
+ /**
+ * Current configuration data.
+ */
+ const SPIConfig *spd_config;
+ /* End of the mandatory fields.*/
+} SPIDriver;
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void spi_lld_init(void);
+ void spi_lld_setup(SPIDriver *spip);
+ void spi_lld_select(SPIDriver *spip);
+ void spi_lld_unselect(SPIDriver *spip);
+ void spi_lld_exchange(SPIDriver *spip, size_t n, void *rxbuf, void *txbuf);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _SPI_LLD_H_ */
+
+/** @} */