summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/spi.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/atsam/include/libchip/include/spi.h')
-rw-r--r--bsps/arm/atsam/include/libchip/include/spi.h116
1 files changed, 116 insertions, 0 deletions
diff --git a/bsps/arm/atsam/include/libchip/include/spi.h b/bsps/arm/atsam/include/libchip/include/spi.h
new file mode 100644
index 0000000000..0d888fbdfa
--- /dev/null
+++ b/bsps/arm/atsam/include/libchip/include/spi.h
@@ -0,0 +1,116 @@
+/* ---------------------------------------------------------------------------- */
+/* Atmel Microcontroller Software Support */
+/* SAM Software Package License */
+/* ---------------------------------------------------------------------------- */
+/* Copyright (c) 2015, Atmel Corporation */
+/* */
+/* All rights reserved. */
+/* */
+/* Redistribution and use in source and binary forms, with or without */
+/* modification, are permitted provided that the following condition is met: */
+/* */
+/* - Redistributions of source code must retain the above copyright notice, */
+/* this list of conditions and the disclaimer below. */
+/* */
+/* Atmel's name may not be used to endorse or promote products derived from */
+/* this software without specific prior written permission. */
+/* */
+/* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */
+/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */
+/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */
+/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
+/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
+/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
+/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
+/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
+/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+/* ---------------------------------------------------------------------------- */
+
+/**
+ * \file
+ *
+ * Interface for Serial Peripheral Interface (SPI) controller.
+ *
+ */
+
+#ifndef _SPI_
+#define _SPI_
+
+/*----------------------------------------------------------------------------
+ * Headers
+ *----------------------------------------------------------------------------*/
+
+#include "chip.h"
+
+/*----------------------------------------------------------------------------
+ * Macros
+ *----------------------------------------------------------------------------*/
+
+/**
+ *
+ * Here are several macros which should be used when configuring a SPI
+ * peripheral.
+ *
+ * \section spi_configuration_macros SPI Configuration Macros
+ * - \ref SPI_PCS
+ * - \ref SPI_SCBR
+ * - \ref SPI_DLYBS
+ * - \ref SPI_DLYBCT
+ */
+
+/** Calculate the PCS field value given the chip select NPCS value */
+#define SPI_PCS(npcs) SPI_MR_PCS((~(1 << npcs) & 0xF))
+
+/** Calculates the value of the CSR SCBR field given the baudrate and MCK. */
+#define SPI_SCBR(baudrate, masterClock) \
+ SPI_CSR_SCBR((uint32_t)(masterClock / baudrate))
+
+/** Calculates the value of the CSR DLYBS field given the desired delay (in ns) */
+#define SPI_DLYBS(delay, masterClock) \
+ SPI_CSR_DLYBS((uint32_t) (((masterClock / 1000000) * delay) / 1000)+1)
+
+/** Calculates the value of the CSR DLYBCT field given the desired delay (in ns) */
+#define SPI_DLYBCT(delay, masterClock) \
+ SPI_CSR_DLYBCT ((uint32_t) (((masterClock / 1000000) * delay) / 32000)+1)
+
+/*------------------------------------------------------------------------------ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*----------------------------------------------------------------------------
+ * Exported functions
+ *----------------------------------------------------------------------------*/
+
+extern void SPI_Enable(Spi *spi);
+extern void SPI_Disable(Spi *spi);
+
+extern void SPI_EnableIt(Spi *spi, uint32_t dwSources);
+extern void SPI_DisableIt(Spi *spi, uint32_t dwSources);
+
+extern void SPI_Configure(Spi *spi, uint32_t dwId, uint32_t dwConfiguration);
+extern void SPI_SetMode(Spi *spi, uint32_t dwConfiguration);
+
+extern void SPI_ChipSelect(Spi *spi, uint8_t cS);
+extern void SPI_ReleaseCS(Spi *spi);
+
+extern void SPI_ConfigureNPCS(Spi *spi, uint32_t dwNpcs,
+ uint32_t dwConfiguration);
+extern void SPI_ConfigureCSMode(Spi *spi, uint32_t dwNpcs,
+ uint32_t bReleaseOnLast);
+
+extern uint32_t SPI_Read(Spi *spi);
+extern void SPI_Write(Spi *spi, uint32_t dwNpcs, uint16_t wData);
+extern void SPI_WriteLast(Spi *spi, uint32_t dwNpcs, uint16_t wData);
+
+extern uint32_t SPI_GetStatus(Spi *spi);
+extern uint32_t SPI_IsFinished(Spi *pSpi);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* #ifndef _SPI_ */
+