/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- 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
+ 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
* - None\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the setup of a the SPI port.\r
+ * Driver for the hardware SPI port available on most AVR models. This module provides\r
+ * an easy to use driver for the setup of and transfer of data over the AVR's SPI port.\r
*\r
* @{\r
*/\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Macros: */\r
- #define SPI_USE_DOUBLESPEED (1 << 7)\r
+ #define SPI_USE_DOUBLESPEED (1 << SPE)\r
#endif\r
\r
/* Public Interface - May be used in end-application: */\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
/** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other\r
* SPI routines.\r
*\r
- * \param[in] PrescalerMask Prescaler mask to set the SPI clock speed\r
- * \param[in] Master If true, sets the SPI system to use master mode, slave if false\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 uint8_t PrescalerMask, const bool Master)\r
+ static inline void SPI_Init(const uint8_t SPIOptions)\r
{\r
DDRB |= ((1 << 1) | (1 << 2));\r
PORTB |= ((1 << 0) | (1 << 3));\r
\r
- SPCR = ((1 << SPE) | (Master << MSTR) | (1 << CPOL) | (1 << CPHA) |\r
- (PrescalerMask & ~SPI_USE_DOUBLESPEED));\r
+ SPCR = ((1 << SPE) | SPIOptions);\r
\r
- if (PrescalerMask & SPI_USE_DOUBLESPEED)\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] Byte Byte to send through the SPI interface\r
projects / pub / USBasp.git / blobdiff