Add file-level brief documentation.

Remove accidentally duplicated model-specific peripheral driver files.

4 files changed, 2 insertions, 334 deletions

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
index 9ab65af53..e307c4e09 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
@@ -29,6 +29,7 @@
 */

 

 /** \file

+ *  \brief ADC peripheral driver for the U7, U6 and U4 USB AVRs.

  *

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

  *

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
deleted file mode 100644
index 3440cc9f1..000000000
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/SPI.h
+++ /dev/null
@@ -1,189 +0,0 @@
-/*

-             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

- *

- *  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_SPI

- *  @defgroup Group_SPI_AVR8 8-Bit AVR SPI Driver

- *

- *  SPI driver for the 8-bit AVRs.

- *

- *  \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_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" {

-		#endif

-

-	/* Private Interface - For use in library only: */

-	#if !defined(__DOXYGEN__)

-		/* Macros: */

-			#define SPI_USE_DOUBLESPEED            (1 << SPE)

-	#endif

-	

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

-		/* Macros: */

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 2. */

-			#define SPI_SPEED_FCPU_DIV_2           SPI_USE_DOUBLESPEED

-

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 4. */

-			#define SPI_SPEED_FCPU_DIV_4           0

-

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 8. */

-			#define SPI_SPEED_FCPU_DIV_8           (SPI_USE_DOUBLESPEED | (1 << SPR0))

-

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 16. */

-			#define SPI_SPEED_FCPU_DIV_16          (1 << SPR0)

-

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 32. */

-			#define SPI_SPEED_FCPU_DIV_32          (SPI_USE_DOUBLESPEED | (1 << SPR1))

-

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 64. */

-			#define SPI_SPEED_FCPU_DIV_64          (SPI_USE_DOUBLESPEED | (1 << SPR1) | (1 << SPR0))

-

-			/** SPI prescaler mask for SPI_Init(). Divides the system clock by a factor of 128. */

-			#define SPI_SPEED_FCPU_DIV_128         ((1 << SPR1) | (1 << SPR0))

-			

-			/** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the rising edge. */

-			#define SPI_SCK_LEAD_RISING            (0 << CPOL)

-

-			/** SPI clock polarity mask for SPI_Init(). Indicates that the SCK should lead on the falling edge. */

-			#define SPI_SCK_LEAD_FALLING           (1 << CPOL)

-

-			/** SPI data sample mode mask for SPI_Init(). Indicates that the data should sampled on the leading edge. */

-			#define SPI_SAMPLE_LEADING             (0 << CPHA)

-

-			/** SPI data sample mode mask for SPI_Init(). Indicates that the data should be sampled on the trailing edge. */

-			#define SPI_SAMPLE_TRAILING            (1 << CPHA)

-			

-			/** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */

-			#define SPI_MODE_SLAVE                 (0 << MSTR)

-

-			/** SPI mode mask for SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */

-			#define SPI_MODE_MASTER                (1 << MSTR)

-

-		/* Inline Functions: */

-			/** Initialises the SPI subsystem, ready for transfers. Must be called before calling any other

-			 *  SPI routines.

-			 *

-			 *  \param[in] SPIOptions  SPI Options, a mask consisting of one of each of the SPI_SPEED_*,

-			 *                         SPI_SCK_*, SPI_SAMPLE_* and SPI_MODE_* masks

-			 */

-			static inline void SPI_Init(const uint8_t SPIOptions)

-			{

-				DDRB  |= ((1 << 1) | (1 << 2));

-				PORTB |= ((1 << 0) | (1 << 3));

-				

-				SPCR   = ((1 << SPE) | SPIOptions);

-				

-				if (SPIOptions & SPI_USE_DOUBLESPEED)

-				  SPSR |= (1 << SPI2X);

-				else

-				  SPSR &= ~(1 << SPI2X);

-			}

-			

-			/** Turns off the SPI driver, disabling and returning used hardware to their default configuration. */

-			static inline void SPI_ShutDown(void)

-			{

-				DDRB  &= ~((1 << 1) | (1 << 2));

-				PORTB &= ~((1 << 0) | (1 << 3));

-				

-				SPCR   = 0;

-				SPSR   = 0;

-			}

-			

-			/** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.

-			 *

-			 *  \param[in] Byte  Byte to send through the SPI interface

-			 *

-			 *  \return Response byte from the attached SPI device

-			 */

-			static inline uint8_t SPI_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;

-			static inline uint8_t SPI_TransferByte(const uint8_t Byte)

-			{

-				SPDR = Byte;

-				while (!(SPSR & (1 << SPIF)));

-				return SPDR;

-			}

-

-			/** Sends a byte through the SPI interface, blocking until the transfer is complete. The response

-			 *  byte sent to from the attached SPI device is ignored.

-			 *

-			 *  \param[in] Byte Byte to send through the SPI interface

-			 */

-			static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;

-			static inline void SPI_SendByte(const uint8_t Byte)

-			{

-				SPDR = Byte;

-				while (!(SPSR & (1 << SPIF)));

-			}

-

-			/** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response

-			 *  byte from the attached SPI device is returned.

-			 *

-			 *  \return The response byte from the attached SPI device

-			 */

-			static inline uint8_t SPI_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;

-			static inline uint8_t SPI_ReceiveByte(void)

-			{

-				SPDR = 0x00;

-				while (!(SPSR & (1 << SPIF)));

-				return SPDR;

-			}

-

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

-		#if defined(__cplusplus)

-			}

-		#endif

-		

-#endif

-

-/** @} */

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h
deleted file mode 100644
index 0421dea73..000000000
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/Serial.h
+++ /dev/null
@@ -1,145 +0,0 @@
-/*

-             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

- *

- *  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_Serial

- *  @defgroup Group_Serial_AVR8 8-Bit AVR Serial Driver

- *

- *  Serial driver for the 8-bit AVRs.

- *

- *  \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_AVR8_H__

-#define __SERIAL_AVR8_H__

-

-	/* Includes: */

-		#include <avr/io.h>

-		#include <avr/pgmspace.h>

-		#include <stdbool.h>

-		

-	/* 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: */

-		/* 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)

-

-		/* Pseudo-Function Macros: */

-			#if defined(__DOXYGEN__)

-				/** Indicates whether a character has been received through the USART.

-				 *

-				 *  \return Boolean true if a character has been received, false otherwise

-				 */

-				static inline bool Serial_IsCharReceived(void);

-			#else

-				#define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)

-			#endif

-

-		/* 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)

-			{

-				UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);

-				UCSR1B = ((1 << TXEN1)  | (1 << RXEN1));

-				UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));

-				

-				DDRD  |= (1 << 3);	

-				PORTD |= (1 << 2);

-				

-				UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));

-			}

-

-			/** Turns off the USART driver, disabling and returning used hardware to their default configuration. */

-			static inline void Serial_ShutDown(void)

-			{

-				UCSR1A = 0;

-				UCSR1B = 0;

-				UCSR1C = 0;

-				

-				DDRD  &= ~(1 << 3);	

-				PORTD &= ~(1 << 2);

-				

-				UBRR1  = 0;

-			}

-			

-			/** Transmits a given byte through the USART.

-			 *

-			 *  \param[in] DataByte  Byte to transmit through the USART

-			 */

-			static inline void Serial_TxByte(const char DataByte)

-			{

-				while (!(UCSR1A & (1 << UDRE1)));

-				UDR1 = DataByte;

-			}

-

-			/** Receives a byte from the USART.

-			 *

-			 *  \return Byte received from the USART

-			 */

-			static inline uint8_t Serial_RxByte(void)

-			{

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

-				return UDR1; 

-			}

-

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

-		#if defined(__cplusplus)

-			}

-		#endif

-		

-#endif

-

-/** @} */

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
index 2d8e6df1e..990b44d14 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
@@ -29,6 +29,7 @@
 */

 

 /** \file

+ *  \brief TWI peripheral driver for the U7, U6 and U4 USB AVRs.

  *

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

  *