Add new ARCH option to the makefiles to (eventually) specify the target device architecture. Update non-usb peripheral drivers to reflect future multiple architecture support.

1 files changed, 21 insertions, 195 deletions

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index e7c2fa065..0c6cd86bf 100644
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -31,218 +31,44 @@
 /** \file
  *  \brief Master include file for the USART peripheral driver.
  *
- *  Driver for the USART subsystem on supported USB AVRs.
+ *  This file is the master dispatch header file for the device-specific USART driver, for microcontrollers
+ *  containing a hardware USART.
+ *
+ *  User code should include this file, which will in turn include the correct ADC driver header file for the
+ *  currently selected architecture and microcontroller model.
  */
 
 /** \ingroup Group_PeripheralDrivers
- *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
+ *  \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 <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
+ *    - LUFA/Drivers/Peripheral/$(ARCH)/Serial.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
  *
  *  \section Sec_ModDescription 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.
- *
- *  \section Sec_ExampleUsage Example Usage
- *  The following snippet is an example of how this module may be used within a typical
- *  application.
- *
- *  \code
- *      // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode)
- *      Serial_Init(9600, false);
- *
- *      // Send a string through the USART
- *      Serial_TxString("Test String\r\n");
+ *  Hardware serial USART driver. This module provides an easy to use driver for the setup and transfer
+ *  of data over the selected architecture and microcontroller model's USART port.
  *
- *      // Receive a byte through the USART
- *      uint8_t DataByte = Serial_RxByte();
- *  \endcode
- *
- *  @{
+ *  \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 __SERIAL_H__
 #define __SERIAL_H__
 
-	/* Includes: */
-		#include <avr/io.h>
-		#include <avr/pgmspace.h>
-		#include <stdbool.h>
-		#include <stdio.h>
-
-		#include "../../Common/Common.h"
-		#include "../Misc/TerminalCodes.h"
-
-	/* Enable C linkage for C++ Compilers: */
-		#if defined(__cplusplus)
-			extern "C" {
+	/* Macros: */
+		#if !defined(__DOXYGEN__)
+			#define __INCLUDE_FROM_SERIAL_H
 		#endif
 
-	/* Private Interface - For use in library only: */
-	#if !defined(__DOXYGEN__)
-		/* External Variables: */
-			extern FILE USARTSerialStream;
-	
-		/* Function Prototypes: */
-			int Serial_putchar(char DataByte,
-			                   FILE *Stream);
-			int Serial_getchar(FILE *Stream);
-			int Serial_getchar_Blocking(FILE *Stream);
-	#endif
-
-	/* Public Interface - May be used in end-application: */
-		/* Macros: */
-			/** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
-			 *  not set.
-			 */
-			#define SERIAL_UBBRVAL(baud)    ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1)
-
-			/** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
-			 *  set.
-			 */
-			#define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1)
-
-		/* 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_SendString_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_SendString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
-			
-			/** Transmits a given buffer located in SRAM memory through the USART.
-			 *
-			 *  \param[in] Buffer  Pointer to a buffer containing the data to send.
-			 *  \param[in] Length  Length of the data to send, in bytes.
-			 */
-			void Serial_SendData(const uint8_t* Buffer, uint16_t Length) 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.
-			 *
-			 *  \param[in] BaudRate     Serial baud rate, in bits per second.
-			 *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate.
-			 */
-			static inline void Serial_Init(const uint32_t BaudRate,
-			                               const bool DoubleSpeed)
-			{
-				UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
-
-				UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));
-				UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);
-				UCSR1B = ((1 << TXEN1)  | (1 << RXEN1));
-
-				DDRD  |= (1 << 3);
-				PORTD |= (1 << 2);
-			}
-
-			/** Turns off the USART driver, disabling and returning used hardware to their default configuration. */
-			static inline void Serial_Disable(void)
-			{
-				UCSR1B = 0;
-				UCSR1A = 0;
-				UCSR1C = 0;
-
-				UBRR1  = 0;
-
-				DDRD  &= ~(1 << 3);
-				PORTD &= ~(1 << 2);
-			}
-
-			/** Creates a standard character stream from the USART so that it can be used with all the regular functions
-			 *  in the avr-libc \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
-			 *  stream is bidirectional and can be used for both input and output functions.
-			 *
-			 *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
-			 *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
-			 *  be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
-			 *  line buffering.
-			 *
-			 *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed, if \c NULL stdio
-			 *                         and stdin will be configured to use the USART.
-			 *
-			 *  \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
-			 */
-			static inline void Serial_CreateStream(FILE* Stream)
-			{
-				if (!(Stream))
-				{
-					Stream = &USARTSerialStream;
-					stdin  = Stream;
-					stdout = Stream;
-				}
-			
-				*Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar, _FDEV_SETUP_RW);
-			}
-
-			/** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
-			 *  the transfer.
-			 *
-			 *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed, if \c NULL stdio
-			 *                         and stdin will be configured to use the USART.
-			 *
-			 *  \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
-			 */
-			static inline void Serial_CreateBlockingStream(FILE* Stream)
-			{
-				if (!(Stream))
-				{
-					Stream = &USARTSerialStream;
-					stdin  = Stream;
-					stdout = Stream;
-				}
-
-				*Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar_Blocking, _FDEV_SETUP_RW);
-			}
-
-			/** Indicates whether a character has been received through the USART.
-			 *
-			 *  \return Boolean \c true if a character has been received, \c false otherwise.
-			 */
-			static inline bool Serial_IsCharReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
-			static inline bool Serial_IsCharReceived(void)
-			{
-				return ((UCSR1A & (1 << RXC1)) ? true : false);
-			}
-
-			/** Transmits a given byte through the USART.
-			 *
-			 *  \param[in] DataByte  Byte to transmit through the USART.
-			 */
-			static inline void Serial_SendByte(const char DataByte) ATTR_ALWAYS_INLINE;
-			static inline void Serial_SendByte(const char DataByte)
-			{
-				while (!(UCSR1A & (1 << UDRE1)));
-				UDR1 = DataByte;
-			}
-
-			/** Receives the next byte from the USART.
-			 *
-			 *  \return Next byte received from the USART, or a negative value if no byte has been received.
-			 */
-			static inline int16_t Serial_ReceiveByte(void) ATTR_ALWAYS_INLINE;
-			static inline int16_t Serial_ReceiveByte(void)
-			{
-				if (!(Serial_IsCharReceived()))
-				  return -1;
-				
-				return UDR1;
-			}
+	/* Includes: */
+		#include "../../Common/Common.h"
 
-	/* Disable C linkage for C++ Compilers: */
-		#if defined(__cplusplus)
-			}
+	/* Includes: */
+		#if (ARCH == ARCH_AVR8)
+			#include "AVR8/Serial.h"
+		#else
+			#error The Serial peripheral driver is not currently available for your selected architecture.
 		#endif
 
 #endif
-
-/** @} */
-