SPI.h 2.63 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  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
19
20
21
22
23
24
25
26
27
28
29
30
31
  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
32
 *  \brief Hardware Serial Peripheral Interface driver.
33
 *
34
35
36
37
38
 *  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.
39
40
41
 */

/** \ingroup Group_PeripheralDrivers
42
 *  \defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h
43
 *  \brief Hardware Serial Peripheral Interface driver.
44
45
46
47
48
 *
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - None
 *
49
 *  \section Sec_ModDescription Module Description
50
51
 *  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.
52
 *
53
54
 *  \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.
55
56
57
58
59
 */

#ifndef __SPI_H__
#define __SPI_H__

60
	/* Macros: */
61
		#define __INCLUDE_FROM_SPI_H
62

63
64
	/* Includes: */
		#include "../../Common/Common.h"
65

66
67
	/* Includes: */
		#if (ARCH == ARCH_AVR8)
68
			#include "AVR8/SPI_AVR8.h"
Dean Camera's avatar
Dean Camera committed
69
70
		#elif (ARCH == ARCH_XMEGA)
			#include "XMEGA/SPI_XMEGA.h"			
71
72
		#else
			#error The SPI peripheral driver is not currently available for your selected architecture.
73
		#endif
74

75
#endif