protocol/lufa/LUFA-120730/LUFA/Drivers/Peripheral/SerialSPI.h

   1 /*\r
   2              LUFA Library\r
   3      Copyright (C) Dean Camera, 2012.\r
   4 \r
   5   dean [at] fourwalledcubicle [dot] com\r
   6            www.lufa-lib.org\r
   7 */\r
   8 \r
   9 /*\r
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
  11 \r
  12   Permission to use, copy, modify, distribute, and sell this\r
  13   software and its documentation for any purpose is hereby granted\r
  14   without fee, provided that the above copyright notice appear in\r
  15   all copies and that both that the copyright notice and this\r
  16   permission notice and warranty disclaimer appear in supporting\r
  17   documentation, and that the name of the author not be used in\r
  18   advertising or publicity pertaining to distribution of the\r
  19   software without specific, written prior permission.\r
  20 \r
  21   The author disclaim all warranties with regard to this\r
  22   software, including all implied warranties of merchantability\r
  23   and fitness.  In no event shall the author be liable for any\r
  24   special, indirect or consequential damages or any damages\r
  25   whatsoever resulting from loss of use, data or profits, whether\r
  26   in an action of contract, negligence or other tortious action,\r
  27   arising out of or in connection with the use or performance of\r
  28   this software.\r
  29 */\r
  30 \r
  31 /** \file\r
  32  *  \brief Hardware SPI Master Mode Serial USART driver.\r
  33  *\r
  34  *  This file is the master dispatch header file for the device-specific SPI Master Mode USART driver, for\r
  35  *  microcontrollers containing a hardware USART capable of operating in a Master SPI mode.\r
  36  *\r
  37  *  User code should include this file, which will in turn include the correct ADC driver header file for the\r
  38  *  currently selected architecture and microcontroller model.\r
  39  */\r
  40 \r
  41 /** \ingroup Group_PeripheralDrivers\r
  42  *  \defgroup Group_SerialSPI Master SPI Mode Serial USART Driver - LUFA/Drivers/Peripheral/SerialSPI.h\r
  43  *  \brief Hardware SPI Master Mode Serial USART driver.\r
  44  *\r
  45  *  \section Sec_Dependencies Module Source Dependencies\r
  46  *  The following files must be built with any user project that uses this module:\r
  47  *    - None\r
  48  *\r
  49  *  \section Sec_ModDescription Module Description\r
  50  *  Hardware SPI Master Mode serial USART driver. This module provides an easy to use driver for the setup and transfer\r
  51  *  of data over the selected architecture and microcontroller model's USART port, using a SPI framing format.\r
  52  *\r
  53  *  \note The exact API for this driver may vary depending on the target used - see\r
  54  *        individual target module documentation for the API specific to your target processor.\r
  55  */\r
  56 \r
  57 #ifndef __SERIAL_SPI_H__\r
  58 #define __SERIAL_SPI_H__\r
  59 \r
  60         /* Macros: */\r
  61                 #define __INCLUDE_FROM_SERIAL_SPI_H\r
  62 \r
  63         /* Includes: */\r
  64                 #include "../../Common/Common.h"\r
  65 \r
  66         /* Includes: */\r
  67                 #if (ARCH == ARCH_AVR8)\r
  68                         #include "AVR8/SerialSPI_AVR8.h"\r
  69                 #elif (ARCH == ARCH_XMEGA)\r
  70                         #include "XMEGA/SerialSPI_XMEGA.h"\r
  71                 #else\r
  72                         #error The Serial SPI Master Mode peripheral driver is not currently available for your selected architecture.\r
  73                 #endif\r
  74 \r
  75 #endif\r
  76 \r