--- /dev/null
+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2011.\r
+\r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+ Copyright 2011 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
+ * \brief SPI Peripheral Driver (XMEGA)\r
+ *\r
+ * On-chip SPI driver for the XMEGA microcontrollers.\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_XMEGA SPI Peripheral Driver (XMEGA)\r
+ *\r
+ * \section Sec_ModDescription Module Description\r
+ * Driver for the hardware SPI port(s) available on XMEGA AVR microcontroller models. This\r
+ * module provides an easy to use driver for the setup and transfer of data over the AVR's\r
+ * SPI ports.\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
+ * \code\r
+ * // Initialize the SPI driver before first use\r
+ * SPI_Init(&SPIC,\r
+ * SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |\r
+ * SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);\r
+ *\r
+ * // Send several bytes, ignoring the returned data\r
+ * SPI_SendByte(&SPIC, 0x01);\r
+ * SPI_SendByte(&SPIC, 0x02);\r
+ * SPI_SendByte(&SPIC, 0x03);\r
+ *\r
+ * // Receive several bytes, sending a dummy 0x00 byte each time\r
+ * uint8_t Byte1 = SPI_ReceiveByte(&SPIC);\r
+ * uint8_t Byte2 = SPI_ReceiveByte(&SPIC);\r
+ * uint8_t Byte3 = SPI_ReceiveByte(&SPIC);\r
+ *\r
+ * // Send a byte, and store the received byte from the same transaction\r
+ * uint8_t ResponseByte = SPI_TransferByte(&SPIC, 0xDC);\r
+ * \endcode\r
+ * \r
+ * @{\r
+ */\r
+\r
+#ifndef __SPI_XMEGA_H__\r
+#define __SPI_XMEGA_H__\r
+\r
+ /* Includes: */\r
+ #include "../../../Common/Common.h"\r
+\r
+ /* Enable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ extern "C" {\r
+ #endif\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
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Macros: */\r
+ #define SPI_USE_DOUBLESPEED SPI_CLK2X_bm\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Macros: */\r
+ /** \name SPI Prescaler Configuration Masks */\r
+ //@{\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 2. */\r
+ #define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED\r
+\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 4. */\r
+ #define SPI_SPEED_FCPU_DIV_4 0\r
+\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 8. */\r
+ #define SPI_SPEED_FCPU_DIV_8 (SPI_USE_DOUBLESPEED | (1 << SPI_PRESCALER_gp))\r
+\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 16. */\r
+ #define SPI_SPEED_FCPU_DIV_16 (1 << SPI_PRESCALER_gp)\r
+\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 32. */\r
+ #define SPI_SPEED_FCPU_DIV_32 (SPI_USE_DOUBLESPEED | (2 << SPI_PRESCALER_gp))\r
+\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 64. */\r
+ #define SPI_SPEED_FCPU_DIV_64 (2 << SPI_PRESCALER_gp)\r
+\r
+ /** SPI prescaler mask for \c SPI_Init(). Divides the system clock by a factor of 128. */\r
+ #define SPI_SPEED_FCPU_DIV_128 (3 << SPI_PRESCALER_gp)\r
+ //@}\r
+\r
+ /** \name SPI SCK Polarity Configuration Masks */\r
+ //@{\r
+ /** SPI clock polarity mask for \c SPI_Init(). Indicates that the SCK should lead on the rising edge. */\r
+ #define SPI_SCK_LEAD_RISING 0\r
+\r
+ /** SPI clock polarity mask for \c SPI_Init(). Indicates that the SCK should lead on the falling edge. */\r
+ #define SPI_SCK_LEAD_FALLING SPI_MODE1_bm\r
+ //@}\r
+\r
+ /** \name SPI Sample Edge Configuration Masks */\r
+ //@{\r
+ /** SPI data sample mode mask for \c SPI_Init(). Indicates that the data should sampled on the leading edge. */\r
+ #define SPI_SAMPLE_LEADING 0\r
+\r
+ /** SPI data sample mode mask for \c SPI_Init(). Indicates that the data should be sampled on the trailing edge. */\r
+ #define SPI_SAMPLE_TRAILING SPI_MODE0_bm\r
+ //@}\r
+ \r
+ /** \name SPI Data Ordering Configuration Masks */\r
+ //@{\r
+ /** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */\r
+ #define SPI_ORDER_MSB_FIRST 0\r
+\r
+ /** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out LSB first. */\r
+ #define SPI_ORDER_LSB_FIRST SPI_DORD_bm\r
+ //@}\r
+ \r
+ /** \name SPI Mode Configuration Masks */\r
+ //@{\r
+ /** SPI mode mask for \c 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 \c SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */\r
+ #define SPI_MODE_MASTER SPI_MASTER_bm\r
+ //@}\r
+ \r
+ /* Inline Functions: */\r
+ /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other\r
+ * SPI routines.\r
+ *\r
+ * \param[in, out] SPI Pointer to the base of the SPI peripheral within the device.\r
+ * \param[in] SPIOptions SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*,\r
+ * \c SPI_SCK_*, \c SPI_SAMPLE_*, \c SPI_ORDER_* and \c SPI_MODE_* masks.\r
+ */\r
+ static inline void SPI_Init(const SPI_t* SPI,\r
+ const uint8_t SPIOptions)\r
+ {\r
+ SPI->CTRL = (SPIOptions | SPI_ENABLE_bm);\r
+ }\r
+\r
+ /** Turns off the SPI driver, disabling and returning used hardware to their default configuration.\r
+ *\r
+ * \param[in, out] SPI Pointer to the base of the SPI peripheral within the device.\r
+ */\r
+ static inline void SPI_Disable(const SPI_t* SPI)\r
+ {\r
+ SPI->CTRL &= ~SPI_ENABLE_bm;\r
+ }\r
+ \r
+ /** Retrieves the currently selected SPI mode, once the SPI interface has been configured.\r
+ *\r
+ * \param[in, out] SPI Pointer to the base of the SPI peripheral within the device.\r
+ *\r
+ * \return \ref SPI_MODE_MASTER if the interface is currently in SPI Master mode, \ref SPI_MODE_SLAVE otherwise\r
+ */\r
+ static inline uint8_t SPI_GetCurrentMode(const SPI_t* SPI) ATTR_ALWAYS_INLINE;\r
+ static inline uint8_t SPI_GetCurrentMode(const SPI_t* SPI)\r
+ {\r
+ return (SPI->CTRL & SPI_MASTER_bm);\r
+ }\r
+\r
+ /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.\r
+ *\r
+ * \param[in, out] SPI Pointer to the base of the SPI peripheral within the device.\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 SPI_t* SPI,\r
+ const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
+ static inline uint8_t SPI_TransferByte(const SPI_t* SPI,\r
+ const uint8_t Byte)\r
+ {\r
+ SPI->DATA = Byte;\r
+ while (!(SPI->STATUS & SPI_IF_bm));\r
+ return SPI->DATA;\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, out] SPI Pointer to the base of the SPI peripheral within the device.\r
+ * \param[in] Byte Byte to send through the SPI interface.\r
+ */\r
+ static inline void SPI_SendByte(const SPI_t* SPI,\r
+ const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
+ static inline void SPI_SendByte(const SPI_t* SPI,\r
+ const uint8_t Byte)\r
+ {\r
+ SPI->DATA = Byte;\r
+ while (!(SPI->STATUS & SPI_IF_bm));\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
+ * \param[in, out] SPI Pointer to the base of the SPI peripheral within the device.\r
+ *\r
+ * \return The response byte from the attached SPI device.\r
+ */\r
+ static inline uint8_t SPI_ReceiveByte(const SPI_t* SPI) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
+ static inline uint8_t SPI_ReceiveByte(const SPI_t* SPI)\r
+ {\r
+ SPI->DATA = 0;\r
+ while (!(SPI->STATUS & SPI_IF_bm));\r
+ return SPI->DATA;\r
+ }\r
+\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+\r
+#endif\r
+\r
+/** @} */\r
+\r
projects / pub / USBasp.git / commitdiff