Add start of an AVR32 SPI driver.
[pub/lufa.git] / LUFA / Drivers / Peripheral / AVR32 / SPI.h
diff --git a/LUFA/Drivers/Peripheral/AVR32/SPI.h b/LUFA/Drivers/Peripheral/AVR32/SPI.h
new file mode 100644 (file)
index 0000000..e07eb6c
--- /dev/null
@@ -0,0 +1,145 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2010.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  SPI driver for the 32-bit AVRs.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the SPI driver\r
+ *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.\r
+ */\r
\r
+/** \ingroup Group_SPI\r
+ *  @defgroup Group_SPI_AVR32 32-Bit AVR SPI Driver\r
+ *\r
+ *  SPI driver for the 32-bit AVRs.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the ADC driver\r
+ *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef __SPI_AVR32_H__\r
+#define __SPI_AVR32_H__\r
+\r
+       /* Includes: */\r
+               #include <stdbool.h>\r
+\r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_SPI_H)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Peripheral/SPI.h instead.\r
+               #endif\r
+\r
+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r
+       \r
+       /* Public Interface - May be used in end-application: */\r
+               /* Macros: */\r
+                       /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 1. */\r
+                       #define SPI_SPEED_FCPU_DIV_1           0\r
+\r
+                       /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 32. */\r
+                       #define SPI_SPEED_FCPU_DIV_32          AVR32_SPI_MR_FDIV_MASK\r
+                       \r
+                       /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */\r
+                       #define SPI_MODE_SLAVE                 0\r
+\r
+                       /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */\r
+                       #define SPI_MODE_MASTER                AVR32_SPI_MR_MSTR_MASK\r
+\r
+               /* Inline Functions: */\r
+                       /** Initialises the SPI subsystem, ready for transfers. Must be called before calling any other\r
+                        *  SPI routines.\r
+                        *\r
+                        *  \param[in] SPIOptions  SPI Options, a mask consisting of one of each of the SPI_SPEED_*\r
+                        *                         and SPI_MODE_* masks\r
+                        */\r
+                       static inline void SPI_Init(const uint8_t SPIOptions)\r
+                       {\r
+                               AVR32_SPI.cr = AVR32_SPI_CR_SPIEN_MASK | AVR32_SPI_CR_SWRST_MASK;\r
+                               AVR32_SPI.mr = SPIOptions;\r
+                       }\r
+                       \r
+                       /** Turns off the SPI driver, disabling and returning used hardware to their default configuration. */\r
+                       static inline void SPI_ShutDown(void)\r
+                       {\r
+                               AVR32_SPI.cr = AVR32_SPI_CR_SPIDIS_MASK;\r
+                       }\r
+                       \r
+                       /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.\r
+                        *\r
+                        *  \param[in] Byte  Byte to send through the SPI interface\r
+                        *\r
+                        *  \return Response byte from the attached SPI device\r
+                        */\r
+                       static inline uint8_t SPI_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
+                       static inline uint8_t SPI_TransferByte(const uint8_t Byte)\r
+                       {\r
+                               AVR32_SPI.tdr = Byte;\r
+                               // TODO: Wait for receive\r
+                               return AVR32_SPI.rdr;\r
+                       }\r
+\r
+                       /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response\r
+                        *  byte sent to from the attached SPI device is ignored.\r
+                        *\r
+                        *  \param[in] Byte Byte to send through the SPI interface\r
+                        */\r
+                       static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
+                       static inline void SPI_SendByte(const uint8_t Byte)\r
+                       {\r
+                               AVR32_SPI.tdr = Byte;\r
+                               // TODO: Wait for receive                               \r
+                       }\r
+\r
+                       /** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response\r
+                        *  byte from the attached SPI device is returned.\r
+                        *\r
+                        *  \return The response byte from the attached SPI device\r
+                        */\r
+                       static inline uint8_t SPI_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
+                       static inline uint8_t SPI_ReceiveByte(void)\r
+                       {\r
+                               AVR32_SPI.tdr = 0x00;\r
+                               // TODO: Wait for receive                               \r
+                               return AVR32_SPI.rdr;\r
+                       }\r
+\r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+               \r
+#endif\r
+\r
+/** @} */\r