-/*\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 8-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_AVR8 8-Bit AVR SPI Driver\r
- *\r
- * SPI driver for the 8-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_AVR8_H__\r
-#define __SPI_AVR8_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\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
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define SPI_USE_DOUBLESPEED (1 << SPE)\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 2. */\r
- #define SPI_SPEED_FCPU_DIV_2 SPI_USE_DOUBLESPEED\r
-\r
- /** SPI prescaler mask for 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 SPI_Init(). Divides the system clock by a factor of 8. */\r
- #define SPI_SPEED_FCPU_DIV_8 (SPI_USE_DOUBLESPEED | (1 << SPR0))\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 16. */\r
- #define SPI_SPEED_FCPU_DIV_16 (1 << SPR0)\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 32. */\r
- #define SPI_SPEED_FCPU_DIV_32 (SPI_USE_DOUBLESPEED | (1 << SPR1))\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 64. */\r
- #define SPI_SPEED_FCPU_DIV_64 (SPI_USE_DOUBLESPEED | (1 << SPR1) | (1 << SPR0))\r
-\r
- /** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 128. */\r
- #define SPI_SPEED_FCPU_DIV_128 ((1 << SPR1) | (1 << SPR0))\r
- \r
- /** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the rising edge. */\r
- #define SPI_SCK_LEAD_RISING (0 << CPOL)\r
-\r
- /** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the falling edge. */\r
- #define SPI_SCK_LEAD_FALLING (1 << CPOL)\r
-\r
- /** SPI data sample mode mask for SPI_Init(). Indicates that the data should sampled on the leading edge. */\r
- #define SPI_SAMPLE_LEADING (0 << CPHA)\r
-\r
- /** SPI data sample mode mask for SPI_Init(). Indicates that the data should be sampled on the trailing edge. */\r
- #define SPI_SAMPLE_TRAILING (1 << CPHA)\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 << MSTR)\r
-\r
- /** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */\r
- #define SPI_MODE_MASTER (1 << MSTR)\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
- * SPI_SCK_*, SPI_SAMPLE_* and SPI_MODE_* masks\r
- */\r
- static inline void SPI_Init(const uintN_t SPIOptions)\r
- {\r
- DDRB |= ((1 << 1) | (1 << 2));\r
- PORTB |= ((1 << 0) | (1 << 3));\r
- \r
- SPCR = ((1 << SPE) | SPIOptions);\r
- \r
- if (SPIOptions & SPI_USE_DOUBLESPEED)\r
- SPSR |= (1 << SPI2X);\r
- else\r
- SPSR &= ~(1 << SPI2X);\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
- DDRB &= ~((1 << 1) | (1 << 2));\r
- PORTB &= ~((1 << 0) | (1 << 3));\r
- \r
- SPCR = 0;\r
- SPSR = 0;\r
- }\r
- \r
- /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.\r
- *\r
- * \param[in] Data Byte to send through the SPI interface\r
- *\r
- * \return Response byte from the attached SPI device\r
- */\r
- static inline uint8_t SPI_Transfer(const uint8_t Data) ATTR_ALWAYS_INLINE;\r
- static inline uint8_t SPI_Transfer(const uint8_t Data)\r
- {\r
- SPDR = Data;\r
- while (!(SPSR & (1 << SPIF)));\r
- return SPDR;\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] Data Byte to send through the SPI interface\r
- */\r
- static inline void SPI_Send(const uint8_t Data) ATTR_ALWAYS_INLINE;\r
- static inline void SPI_Send(const uint8_t Data)\r
- {\r
- SPDR = Data;\r
- while (!(SPSR & (1 << SPIF)));\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_Receive(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
- static inline uint8_t SPI_Receive(void)\r
- {\r
- SPDR = 0x00;\r
- while (!(SPSR & (1 << SPIF)));\r
- return SPDR;\r
- }\r
- \r
- #if defined(__DOXYGEN__)\r
- /** Alias for \ref SPI_Transfer(), for compatibility with legacy LUFA applications. */\r
- static inline uint8_t SPI_TransferByte(const uint8_t Byte) ATTR_DEPRECATED;\r
-\r
- /** Alias for \ref SPI_Send(), for compatibility with legacy LUFA applications. */\r
- static inline void SPI_SendByte(const uint8_t Byte) ATTR_DEPRECATED;\r
-\r
- /** Alias for \ref SPI_Receive(), for compatibility with legacy LUFA applications. */\r
- static inline uint8_t SPI_ReceiveByte(void) ATTR_DEPRECATED;\r
- #else\r
- #define SPI_TransferByte(x) SPI_Transfer(x)\r
- #define SPI_SendByte(x) SPI_Send(x)\r
- #define SPI_ReceiveByte() SPI_Receive()\r
- #endif\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
projects / pub / lufa.git / blobdiff