Add new Master SPI Mode USART serial peripheral driver for the XMEGA and AVR8 archite...

[pub/lufa.git] / LUFA / Drivers / Peripheral / SerialSPI.h

diff --git a/LUFA/Drivers/Peripheral/SerialSPI.h b/LUFA/Drivers/Peripheral/SerialSPI.h
new file mode 100644 (file)
index 0000000..f5eede8
--- /dev/null
+++ b/LUFA/Drivers/Peripheral/SerialSPI.h
@@ -0,0 +1,76 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2012.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2012  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 Hardware SPI Master Mode Serial USART driver.\r
+ *\r
+ *  This file is the master dispatch header file for the device-specific SPI Master Mode USART driver, for\r
+ *  microcontrollers containing a hardware USART capable of operating in a Master SPI mode.\r
+ *\r
+ *  User code should include this file, which will in turn include the correct ADC driver header file for the\r
+ *  currently selected architecture and microcontroller model.\r
+ */\r
+\r
+/** \ingroup Group_PeripheralDrivers\r
+ *  \defgroup Group_SerialSPI Master SPI Mode Serial USART Driver - LUFA/Drivers/Peripheral/SerialSPI.h\r
+ *  \brief Hardware SPI Master Mode Serial USART driver.\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - None\r
+ *\r
+ *  \section Sec_ModDescription Module Description\r
+ *  Hardware SPI Master Mode serial USART driver. This module provides an easy to use driver for the setup and transfer\r
+ *  of data over the selected architecture and microcontroller model's USART port, using a SPI framing format.\r
+ *\r
+ *  \note The exact API for this driver may vary depending on the target used - see\r
+ *        individual target module documentation for the API specific to your target processor.\r
+ */\r
+\r
+#ifndef __SERIAL_SPI_H__\r
+#define __SERIAL_SPI_H__\r
+\r
+       /* Macros: */\r
+               #define __INCLUDE_FROM_SERIAL_SPI_H\r
+\r
+       /* Includes: */\r
+               #include "../../Common/Common.h"\r
+\r
+       /* Includes: */\r
+               #if (ARCH == ARCH_AVR8)\r
+                       #include "AVR8/SerialSPI_AVR8.h"\r
+               #elif (ARCH == ARCH_XMEGA)\r
+                       #include "XMEGA/SerialSPI_XMEGA.h"\r
+               #else\r
+                       #error The Serial SPI Master Mode peripheral driver is not currently available for your selected architecture.\r
+               #endif\r
+\r
+#endif\r
+\r