Mark build test makefiles as being incompatible with parallel make builds, as they...
[pub/USBasp.git] / LUFA / Drivers / Peripheral / SPI.h
index aac3d95..7301994 100644 (file)
@@ -1,70 +1,76 @@
-/*\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
- *  This file is the master dispatch header file for the device-specific SPI driver, for AVRs containing a SPI.\r
- *\r
- *  User code should include this file, which will in turn include the correct SPI driver header file for the\r
- *  currently selected AVR model.\r
- */\r
-\r
-/** \ingroup Group_PeripheralDrivers\r
- *  @defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h\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 Module Description\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
-\r
-#ifndef __SPI_H__\r
-#define __SPI_H__\r
-\r
-       /* Macros: */\r
-       #if !defined(__DOXYGEN__)\r
-               #define __INCLUDE_FROM_SPI_H\r
-       #endif\r
-\r
-       /* Includes: */\r
-               #if defined(__AVR32__)\r
-                       #include "AVR32/SPI.h"\r
-               #else\r
-                       #include "AVR8/SPI.h"           \r
-               #endif\r
-               \r
-#endif\r
-\r
-/** @} */\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Hardware Serial Peripheral Interface driver.
+ *
+ *  This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
+ *  containing a hardware SPI.
+ *
+ *  User code should include this file, which will in turn include the correct SPI driver header file for the
+ *  currently selected architecture and microcontroller model.
+ */
+
+/** \ingroup Group_PeripheralDrivers
+ *  \defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h
+ *  \brief Hardware Serial Peripheral Interface driver.
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - None
+ *
+ *  \section Sec_ModDescription Module Description
+ *  Hardware SPI driver. This module provides an easy to use driver for the setup and transfer of data over
+ *  the selected architecture and microcontroller model's SPI port.
+ *
+ *  \note The exact API for this driver may vary depending on the target used - see
+ *        individual target module documentation for the API specific to your target processor.
+ */
+
+#ifndef __SPI_H__
+#define __SPI_H__
+
+       /* Macros: */
+               #define __INCLUDE_FROM_SPI_H
+
+       /* Includes: */
+               #include "../../Common/Common.h"
+
+       /* Includes: */
+               #if (ARCH == ARCH_AVR8)
+                       #include "AVR8/SPI_AVR8.h"
+               #elif (ARCH == ARCH_XMEGA)
+                       #include "XMEGA/SPI_XMEGA.h"
+               #else
+                       #error The SPI peripheral driver is not currently available for your selected architecture.
+               #endif
+
+#endif
+