Make SPI and USART peripheral dispatch driver headers in preparation for a set of AVR32 peripheral drivers.

6 files changed, 210 insertions, 53 deletions

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
index 8b1b47df2..06f9d3b28 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
@@ -30,16 +30,16 @@
 

 /** \file

  *

- *  ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.

+ *  ADC driver for the 8-Bit AVRs containing a hardware ADC module.

  *

  *  \note This file should not be included directly. It is automatically included as needed by the ADC driver

  *        dispatch header located in LUFA/Drivers/Peripheral/ADC.h.

  */

 

 /** \ingroup Group_ADC

- *  @defgroup Group_ADC_AVRU4U6U7 Series U4, U6 and U7 Model ADC Driver

+ *  @defgroup Group_ADC_AVR8 8-Bit AVR ADC Driver

  *

- *  ADC driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.

+ *  ADC driver for 8-Bit AVRs containing a hardware ADC module.

  *

  *  \note This file should not be included directly. It is automatically included as needed by the ADC driver

  *        dispatch header located in LUFA/Drivers/Peripheral/ADC.h.

@@ -47,8 +47,8 @@
  *  @{

  */

  

-#ifndef __ADC_AVRU4U6U7_H__

-#define __ADC_AVRU4U6U7_H__

+#ifndef __ADC_AVR8_H__

+#define __ADC_AVR8_H__

 

 	/* Includes: */

 		#include "../../../Common/Common.h"

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
index 25503b6c3..3440cc9f1 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
@@ -30,29 +30,34 @@
 

 /** \file

  *

- *  Hardware SPI subsystem driver for the supported USB AVRs models.

+ *  SPI driver for the 8-bit AVRs.

+ *

+ *  \note This file should not be included directly. It is automatically included as needed by the SPI driver

+ *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.

  */

-

-/** \ingroup Group_PeripheralDrivers

- *  @defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h

+ 

+/** \ingroup Group_SPI

+ *  @defgroup Group_SPI_AVR8 8-Bit AVR SPI Driver

  *

- *  \section Sec_Dependencies Module Source Dependencies

- *  The following files must be built with any user project that uses this module:

- *    - None

+ *  SPI driver for the 8-bit AVRs.

  *

- *  \section Module Description

- *  Driver for the hardware SPI port available on most AVR models. This module provides

- *  an easy to use driver for the setup of and transfer of data over the AVR's SPI port.

+ *  \note This file should not be included directly. It is automatically included as needed by the ADC driver

+ *        dispatch header located in LUFA/Drivers/Peripheral/SPI.h.

  *

  *  @{

  */

 

-#ifndef __SPI_H__

-#define __SPI_H__

+#ifndef __SPI_AVR8_H__

+#define __SPI_AVR8_H__

 

 	/* Includes: */

 		#include <stdbool.h>

 

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_SPI_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/SPI.h instead.

+		#endif

+

 	/* Enable C linkage for C++ Compilers: */

 		#if defined(__cplusplus)

 			extern "C" {

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h
index d00f9c1c0..0421dea73 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h
@@ -30,37 +30,34 @@
 

 /** \file

  *

- *  Driver for the USART subsystem on supported USB AVRs.

+ *  ADC driver for the 8-bit AVRs.

+ *

+ *  \note This file should not be included directly. It is automatically included as needed by the USART driver

+ *        dispatch header located in LUFA/Drivers/Peripheral/Serial.h.

  */

  

-/** \ingroup Group_PeripheralDrivers

- *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h

+/** \ingroup Group_Serial

+ *  @defgroup Group_Serial_AVR8 8-Bit AVR Serial Driver

  *

- *  \section Sec_Dependencies Module Source Dependencies

- *  The following files must be built with any user project that uses this module:

- *    - LUFA/Drivers/Peripheral/Serial.c

+ *  Serial driver for the 8-bit AVRs.

  *

- *  \section Module Description

- *  Hardware serial USART driver. This module provides an easy to use driver for

- *  the setup of and transfer of data over the AVR's USART port.

+ *  \note This file should not be included directly. It is automatically included as needed by the ADC driver

+ *        dispatch header located in LUFA/Drivers/Peripheral/USART.h.

  *

  *  @{

  */

  

-#ifndef __SERIAL_H__

-#define __SERIAL_H__

+#ifndef __SERIAL_AVR8_H__

+#define __SERIAL_AVR8_H__

 

 	/* Includes: */

 		#include <avr/io.h>

 		#include <avr/pgmspace.h>

 		#include <stdbool.h>

 		

-		#include "../../Common/Common.h"

-		#include "../Misc/TerminalCodes.h"

-

-	/* Enable C linkage for C++ Compilers: */

-		#if defined(__cplusplus)

-			extern "C" {

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_SERIAL_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead.

 		#endif

 

 	/* Public Interface - May be used in end-application: */

@@ -86,19 +83,6 @@
 				#define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)

 			#endif

 

-		/* Function Prototypes: */

-			/** Transmits a given string located in program space (FLASH) through the USART.

-			 *

-			 *  \param[in] FlashStringPtr  Pointer to a string located in program space

-			 */

-			void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);

-

-			/** Transmits a given string located in SRAM memory through the USART.

-			 *

-			 *  \param[in] StringPtr  Pointer to a string located in SRAM space

-			 */

-			void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);

-

 		/* Inline Functions: */

 			/** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to

 			 *  standard 8-bit, no parity, 1 stop bit settings suitable for most applications.

@@ -145,7 +129,7 @@
 			 *

 			 *  \return Byte received from the USART

 			 */

-			static inline char Serial_RxByte(void)

+			static inline uint8_t Serial_RxByte(void)

 			{

 				while (!(UCSR1A & (1 << RXC1)));

 				return UDR1; 

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
index 13db86e69..673f1b071 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
@@ -30,16 +30,16 @@
 

 /** \file

  *

- *  Master mode TWI driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.

+ *  Master mode TWI driver for the 8-Bit AVRs containing a hardware TWI module.

  *

  *  \note This file should not be included directly. It is automatically included as needed by the TWI driver

  *        dispatch header located in LUFA/Drivers/Peripheral/TWI.h.

  */

 

 /** \ingroup Group_TWI

- *  @defgroup Group_TWI_AVRU4U6U7 Series U4, U6 and U7 Model TWI Driver

+ *  @defgroup Group_TWI_AVR8 Series U4, U6 and U7 Model TWI Driver

  *

- *  Master mode TWI driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.

+ *  Master mode TWI driver for the 8-Bit AVRs containing a hardware TWI module.

  *

  *  \note This file should not be included directly. It is automatically included as needed by the TWI driver

  *        dispatch header located in LUFA/Drivers/Peripheral/TWI.h.

@@ -47,8 +47,8 @@
  *  @{

  */

 

-#ifndef __TWI_AVRU4U6U7_H__

-#define __TWI_AVRU4U6U7_H__

+#ifndef __TWI_AVR8_H__

+#define __TWI_AVR8_H__

 

 	/* Includes: */

 		#include "../../../Common/Common.h"

diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h
new file mode 100644
index 000000000..cd2b423ae
--- /dev/null
+++ b/LUFA/Drivers/Peripheral/SPI.h
@@ -0,0 +1,70 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2010  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

+ *

+ *  This file is the master dispatch header file for the device-specific SPI driver, for AVRs containing a SPI.

+ *

+ *  User code should include this file, which will in turn include the correct SPI driver header file for the

+ *  currently selected AVR model.

+ */

+

+/** \ingroup Group_PeripheralDrivers

+ *  @defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h

+ *

+ *  \section Sec_Dependencies Module Source Dependencies

+ *  The following files must be built with any user project that uses this module:

+ *    - None

+ *

+ *  \section Module Description

+ *  Driver for the hardware SPI port available on most AVR models. This module provides

+ *  an easy to use driver for the setup of and transfer of data over the AVR's SPI port.

+ *

+ *  @{

+ */

+

+#ifndef __SPI_H__

+#define __SPI_H__

+

+	/* Macros: */

+	#if !defined(__DOXYGEN__)

+		#define __INCLUDE_FROM_SPI_H

+	#endif

+

+	/* Includes: */

+		#if defined(__AVR32__)

+			#include "AVR32/SPI.h"

+		#else

+			#include "AVRU4U6U7/SPI.h"		

+		#endif

+		

+#endif

+

+/** @} */

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
new file mode 100644
index 000000000..51600f48c
--- /dev/null
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -0,0 +1,98 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2010  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

+ *

+ *  This file is the master dispatch header file for the device-specific USART driver, for AVRs containing a

+ *  USART.

+ *

+ *  User code should include this file, which will in turn include the correct USART driver header file for

+ *  the currently selected AVR model.

+ */

+ 

+/** \ingroup Group_PeripheralDrivers

+ *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h

+ *

+ *  \section Sec_Dependencies Module Source Dependencies

+ *  The following files must be built with any user project that uses this module:

+ *    - LUFA/Drivers/Peripheral/Serial.c

+ *

+ *  \section Module Description

+ *  Hardware serial USART driver. This module provides an easy to use driver for

+ *  the setup of and transfer of data over the AVR's USART port.

+ *

+ *  @{

+ */

+ 

+#ifndef __SERIAL_H__

+#define __SERIAL_H__

+

+	/* Macros: */

+	#if !defined(__DOXYGEN__)

+		#define __INCLUDE_FROM_SERIAL_H

+	#endif

+

+	/* Includes: */

+		#if defined(__AVR32__)

+			#include "AVR32/Serial.h"

+		#else

+			#include "AVRU4U6U7/Serial.h"		

+		#endif

+		

+		#include "../../Common/Common.h"

+		#include "../Misc/TerminalCodes.h"

+

+	/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Public Interface - May be used in end-application: */

+		/* Function Prototypes: */

+			/** Transmits a given string located in program space (FLASH) through the USART.

+			 *

+			 *  \param[in] FlashStringPtr  Pointer to a string located in program space

+			 */

+			void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);

+

+			/** Transmits a given string located in SRAM memory through the USART.

+			 *

+			 *  \param[in] StringPtr  Pointer to a string located in SRAM space

+			 */

+			void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+		

+#endif

+

+/** @} */