Merge pull request #1471 from qmk/lufa_lib

Update LUFA and move it to /lib/lufa

6 files changed, 1365 insertions, 0 deletions

diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h
new file mode 100644
index 0000000000..7797df11a9
--- /dev/null
+++ b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h
@@ -0,0 +1,251 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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
+ *  \brief SPI Peripheral Driver (XMEGA)
+ *
+ *  On-chip SPI driver for the XMEGA microcontrollers.
+ *
+ *  \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_XMEGA SPI Peripheral Driver (XMEGA)
+ *
+ *  \section Sec_SPI_XMEGA_ModDescription Module Description
+ *  Driver for the hardware SPI port(s) available on XMEGA AVR microcontroller models. This
+ *  module provides an easy to use driver for the setup and transfer of data over the AVR's
+ *  SPI ports.
+ *
+ *  \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.
+ *
+ *  \code
+ *      // Initialize the SPI driver before first use
+ *      SPI_Init(&SPIC,
+ *               SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
+ *               SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
+ *
+ *      // Send several bytes, ignoring the returned data
+ *      SPI_SendByte(&SPIC, 0x01);
+ *      SPI_SendByte(&SPIC, 0x02);
+ *      SPI_SendByte(&SPIC, 0x03);
+ *
+ *      // Receive several bytes, sending a dummy 0x00 byte each time
+ *      uint8_t Byte1 = SPI_ReceiveByte(&SPIC);
+ *      uint8_t Byte2 = SPI_ReceiveByte(&SPIC);
+ *      uint8_t Byte3 = SPI_ReceiveByte(&SPIC);
+ *
+ *      // Send a byte, and store the received byte from the same transaction
+ *      uint8_t ResponseByte = SPI_TransferByte(&SPIC, 0xDC);
+ *  \endcode
+ *
+ *  @{
+ */
+
+#ifndef __SPI_XMEGA_H__
+#define __SPI_XMEGA_H__
+
+	/* Includes: */
+		#include "../../../Common/Common.h"
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_SPI_H)
+			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/SPI.h instead.
+		#endif
+
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define SPI_USE_DOUBLESPEED            SPI_CLK2X_bm
+	#endif
+
+	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			/** \name SPI Prescaler Configuration Masks */
+			//@{
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 2. */
+			#define SPI_SPEED_FCPU_DIV_2           SPI_USE_DOUBLESPEED
+
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 4. */
+			#define SPI_SPEED_FCPU_DIV_4           0
+
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 8. */
+			#define SPI_SPEED_FCPU_DIV_8           (SPI_USE_DOUBLESPEED | (1 << SPI_PRESCALER_gp))
+
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 16. */
+			#define SPI_SPEED_FCPU_DIV_16          (1 << SPI_PRESCALER_gp)
+
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 32. */
+			#define SPI_SPEED_FCPU_DIV_32          (SPI_USE_DOUBLESPEED | (2 << SPI_PRESCALER_gp))
+
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 64. */
+			#define SPI_SPEED_FCPU_DIV_64          (2 << SPI_PRESCALER_gp)
+
+			/** SPI prescaler mask for \ref SPI_Init(). Divides the system clock by a factor of 128. */
+			#define SPI_SPEED_FCPU_DIV_128         (3 << SPI_PRESCALER_gp)
+			//@}
+
+			/** \name SPI SCK Polarity Configuration Masks */
+			//@{
+			/** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the rising edge. */
+			#define SPI_SCK_LEAD_RISING            0
+
+			/** SPI clock polarity mask for \ref SPI_Init(). Indicates that the SCK should lead on the falling edge. */
+			#define SPI_SCK_LEAD_FALLING           SPI_MODE1_bm
+			//@}
+
+			/** \name SPI Sample Edge Configuration Masks */
+			//@{
+			/** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should sampled on the leading edge. */
+			#define SPI_SAMPLE_LEADING             0
+
+			/** SPI data sample mode mask for \ref SPI_Init(). Indicates that the data should be sampled on the trailing edge. */
+			#define SPI_SAMPLE_TRAILING            SPI_MODE0_bm
+			//@}
+
+			/** \name SPI Data Ordering Configuration Masks */
+			//@{
+			/** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out MSB first. */
+			#define SPI_ORDER_MSB_FIRST            0
+
+			/** SPI data order mask for \ref SPI_Init(). Indicates that data should be shifted out LSB first. */
+			#define SPI_ORDER_LSB_FIRST            SPI_DORD_bm
+			//@}
+
+			/** \name SPI Mode Configuration Masks */
+			//@{
+			/** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into slave mode. */
+			#define SPI_MODE_SLAVE                 0
+
+			/** SPI mode mask for \ref SPI_Init(). Indicates that the SPI interface should be initialized into master mode. */
+			#define SPI_MODE_MASTER                SPI_MASTER_bm
+			//@}
+
+		/* Inline Functions: */
+			/** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other
+			 *  SPI routines.
+			 *
+			 *  \param[in,out] SPI         Pointer to the base of the SPI peripheral within the device.
+			 *  \param[in]     SPIOptions  SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*,
+			 *                             \c SPI_SCK_*, \c SPI_SAMPLE_*, \c SPI_ORDER_* and \c SPI_MODE_* masks.
+			 */
+			static inline void SPI_Init(SPI_t* const SPI,
+			                            const uint8_t SPIOptions) ATTR_NON_NULL_PTR_ARG(1);
+			static inline void SPI_Init(SPI_t* const SPI,
+			                            const uint8_t SPIOptions)
+			{
+				SPI->CTRL = (SPIOptions | SPI_ENABLE_bm);
+			}
+
+			/** Turns off the SPI driver, disabling and returning used hardware to their default configuration.
+			 *
+			 *  \param[in,out] SPI   Pointer to the base of the SPI peripheral within the device.
+			 */
+			static inline void SPI_Disable(SPI_t* const SPI) ATTR_NON_NULL_PTR_ARG(1);
+			static inline void SPI_Disable(SPI_t* const SPI)
+			{
+				SPI->CTRL &= ~SPI_ENABLE_bm;
+			}
+
+			/** Retrieves the currently selected SPI mode, once the SPI interface has been configured.
+			 *
+			 *  \param[in,out] SPI  Pointer to the base of the SPI peripheral within the device.
+			 *
+			 *  \return \ref SPI_MODE_MASTER if the interface is currently in SPI Master mode, \ref SPI_MODE_SLAVE otherwise
+			 */
+			static inline uint8_t SPI_GetCurrentMode(SPI_t* const SPI) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline uint8_t SPI_GetCurrentMode(SPI_t* const SPI)
+			{
+				return (SPI->CTRL & SPI_MASTER_bm);
+			}
+
+			/** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.
+			 *
+			 *  \param[in,out] SPI   Pointer to the base of the SPI peripheral within the device.
+			 *  \param[in]     Byte  Byte to send through the SPI interface.
+			 *
+			 *  \return Response byte from the attached SPI device.
+			 */
+			static inline uint8_t SPI_TransferByte(SPI_t* const SPI,
+			                                       const uint8_t Byte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline uint8_t SPI_TransferByte(SPI_t* const SPI,
+			                                       const uint8_t Byte)
+			{
+				SPI->DATA = Byte;
+				while (!(SPI->STATUS & SPI_IF_bm));
+				return SPI->DATA;
+			}
+
+			/** 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,out] SPI   Pointer to the base of the SPI peripheral within the device.
+			 *  \param[in]     Byte  Byte to send through the SPI interface.
+			 */
+			static inline void SPI_SendByte(SPI_t* const SPI,
+			                                const uint8_t Byte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void SPI_SendByte(SPI_t* const SPI,
+			                                const uint8_t Byte)
+			{
+				SPI->DATA = Byte;
+				while (!(SPI->STATUS & SPI_IF_bm));
+			}
+
+			/** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response
+			 *  byte from the attached SPI device is returned.
+			 *
+			 *  \param[in,out] SPI  Pointer to the base of the SPI peripheral within the device.
+			 *
+			 *  \return The response byte from the attached SPI device.
+			 */
+			static inline uint8_t SPI_ReceiveByte(SPI_t* const SPI) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+			static inline uint8_t SPI_ReceiveByte(SPI_t* const SPI)
+			{
+				SPI->DATA = 0;
+				while (!(SPI->STATUS & SPI_IF_bm));
+				return SPI->DATA;
+			}
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+
diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h
new file mode 100644
index 0000000000..ca3235083c
--- /dev/null
+++ b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h
@@ -0,0 +1,212 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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
+ *  \brief Master SPI Mode Serial USART Peripheral Driver (XMEGA)
+ *
+ *  On-chip Master SPI mode USART driver for the XMEGA AVR microcontrollers.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the SPI Master
+ *        Mode USART driver dispatch header located in LUFA/Drivers/Peripheral/Serial.h.
+ */
+
+/** \ingroup Group_SerialSPI
+ *  \defgroup Group_SerialSPI_XMEGA Master SPI Mode Serial USART Peripheral Driver (XMEGA)
+ *
+ *  \section Sec_SerialSPI_XMEGA_ModDescription Module Description
+ *  On-chip serial USART driver for the XMEGA AVR microcontrollers.
+ *
+ *  \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/SerialSPI.h.
+ *
+ *  \section Sec_SerialSPI_XMEGA_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
+ *  \code
+ *      // Initialize the Master SPI mode USART driver before first use, with 1Mbit baud
+ *      SerialSPI_Init(&USARTD0, (USART_SPI_SCK_LEAD_RISING | USART_SPI_SAMPLE_LEADING | USART_SPI_ORDER_MSB_FIRST), 1000000);
+ *
+ *      // Send several bytes, ignoring the returned data
+ *      SerialSPI_SendByte(&USARTD0, 0x01);
+ *      SerialSPI_SendByte(&USARTD0, 0x02);
+ *      SerialSPI_SendByte(&USARTD0, 0x03);
+ *
+ *      // Receive several bytes, sending a dummy 0x00 byte each time
+ *      uint8_t Byte1 = SerialSPI_ReceiveByte(&USARTD);
+ *      uint8_t Byte2 = SerialSPI_ReceiveByte(&USARTD);
+ *      uint8_t Byte3 = SerialSPI_ReceiveByte(&USARTD);
+ *
+ *      // Send a byte, and store the received byte from the same transaction
+ *      uint8_t ResponseByte = SerialSPI_TransferByte(&USARTD0, 0xDC);
+ *  \endcode
+ *
+ *  @{
+ */
+
+#ifndef __SERIAL_SPI_XMEGA_H__
+#define __SERIAL_SPI_XMEGA_H__
+
+	/* Includes: */
+		#include "../../../Common/Common.h"
+
+		#include <stdio.h>
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_SERIAL_SPI_H)
+			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead.
+		#endif
+
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+			#define SERIAL_SPI_UBBRVAL(Baud)       ((Baud < (F_CPU / 2)) ? ((F_CPU / (2 * Baud)) - 1) : 0)
+	#endif
+
+	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			/** \name SPI SCK Polarity Configuration Masks */
+			//@{
+			/** SPI clock polarity mask for \ref SerialSPI_Init(). Indicates that the SCK should lead on the rising edge. */
+			#define USART_SPI_SCK_LEAD_RISING      0
+			//@}
+
+			/** \name SPI Sample Edge Configuration Masks */
+			//@{
+			/** SPI data sample mode mask for \ref SerialSPI_Init(). Indicates that the data should sampled on the leading edge. */
+			#define USART_SPI_SAMPLE_LEADING       0
+
+			/** SPI data sample mode mask for \ref SerialSPI_Init(). Indicates that the data should be sampled on the trailing edge. */
+			#define USART_SPI_SAMPLE_TRAILING      (1 << 1)
+			//@}
+
+			/** \name SPI Data Ordering Configuration Masks */
+			//@{
+			/** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out MSB first. */
+			#define USART_SPI_ORDER_MSB_FIRST      0
+
+			/** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out LSB first. */
+			#define USART_SPI_ORDER_LSB_FIRST      (1 << 2)
+			//@}
+
+		/* Inline Functions: */
+			/** Initialize the USART module in Master SPI mode.
+			 *
+			 *  \param[in,out] USART        Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     SPIOptions   USART SPI Options, a mask consisting of one of each of the \c USART_SPI_SCK_*,
+			 *                              \c USART_SPI_SAMPLE_* and \c USART_SPI_ORDER_* masks.
+			 *  \param[in]     BaudRate     SPI baud rate, in bits per second.
+			 */
+			static inline void SerialSPI_Init(USART_t* const USART,
+			                                  const uint8_t SPIOptions,
+			                                  const uint32_t BaudRate) ATTR_NON_NULL_PTR_ARG(1);
+			static inline void SerialSPI_Init(USART_t* const USART,
+			                                  const uint8_t SPIOptions,
+			                                  const uint32_t BaudRate)
+			{
+				uint16_t BaudValue = SERIAL_SPI_UBBRVAL(BaudRate);
+
+				USART->BAUDCTRLB = (BaudValue >> 8);
+				USART->BAUDCTRLA = (BaudValue & 0xFF);
+
+				USART->CTRLC = (USART_CMODE_MSPI_gc | SPIOptions);
+				USART->CTRLB = (USART_RXEN_bm | USART_TXEN_bm);
+			}
+
+			/** Turns off the USART driver, disabling and returning used hardware to their default configuration.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 */
+			static inline void SerialSPI_Disable(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void SerialSPI_Disable(USART_t* const USART)
+			{
+				USART->CTRLA = 0;
+				USART->CTRLB = 0;
+				USART->CTRLC = 0;
+			}
+
+			/** Sends and receives a byte through the USART SPI interface, blocking until the transfer is complete.
+			 *
+			 *  \param[in,out] USART     Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     DataByte  Byte to send through the USART SPI interface.
+			 *
+			 *  \return Response byte from the attached SPI device.
+			 */
+			static inline uint8_t SerialSPI_TransferByte(USART_t* const USART,
+			                                             const uint8_t DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline uint8_t SerialSPI_TransferByte(USART_t* const USART,
+			                                             const uint8_t DataByte)
+			{
+				USART->DATA   = DataByte;
+				while (!(USART->STATUS & USART_TXCIF_bm));
+				USART->STATUS = USART_TXCIF_bm;
+				return USART->DATA;
+			}
+
+			/** Sends a byte through the USART SPI interface, blocking until the transfer is complete. The response
+			 *  byte sent to from the attached SPI device is ignored.
+			 *
+			 *  \param[in,out] USART     Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     DataByte  Byte to send through the USART SPI interface.
+			 */
+			static inline void SerialSPI_SendByte(USART_t* const USART,
+			                                      const uint8_t DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void SerialSPI_SendByte(USART_t* const USART,
+			                                      const uint8_t DataByte)
+			{
+				SerialSPI_TransferByte(USART, DataByte);
+			}
+
+			/** Sends a dummy byte through the USART SPI interface, blocking until the transfer is complete. The response
+			 *  byte from the attached SPI device is returned.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 *
+			 *  \return The response byte from the attached SPI device.
+			 */
+			static inline uint8_t SerialSPI_ReceiveByte(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+			static inline uint8_t SerialSPI_ReceiveByte(USART_t* const USART)
+			{
+				return SerialSPI_TransferByte(USART, 0);
+			}
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+
diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.c b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.c
new file mode 100644
index 0000000000..9ecda47d2d
--- /dev/null
+++ b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.c
@@ -0,0 +1,126 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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.
+*/
+
+#include "../../../Common/Common.h"
+#if (ARCH == ARCH_XMEGA)
+
+#define  __INCLUDE_FROM_SERIAL_C
+#include "../Serial.h"
+
+FILE USARTSerialStream;
+
+int Serial_putchar(char DataByte,
+                   FILE *Stream)
+{
+	USART_t* USART = fdev_get_udata(Stream);
+
+	Serial_SendByte(USART, DataByte);
+	return 0;
+}
+
+int Serial_getchar(FILE *Stream)
+{
+	USART_t* USART = fdev_get_udata(Stream);
+
+	if (!(Serial_IsCharReceived(USART)))
+	  return _FDEV_EOF;
+
+	return Serial_ReceiveByte(USART);
+}
+
+int Serial_getchar_Blocking(FILE *Stream)
+{
+	USART_t* USART = fdev_get_udata(Stream);
+
+	while (!(Serial_IsCharReceived(USART)));
+	return Serial_ReceiveByte(USART);
+}
+
+void Serial_SendString_P(USART_t* const USART,
+                         const char* FlashStringPtr)
+{
+	uint8_t CurrByte;
+
+	while ((CurrByte = pgm_read_byte(FlashStringPtr)) != 0x00)
+	{
+		Serial_SendByte(USART, CurrByte);
+		FlashStringPtr++;
+	}
+}
+
+void Serial_SendString(USART_t* const USART,
+                       const char* StringPtr)
+{
+	uint8_t CurrByte;
+
+	while ((CurrByte = *StringPtr) != 0x00)
+	{
+		Serial_SendByte(USART, CurrByte);
+		StringPtr++;
+	}
+}
+
+void Serial_SendData(USART_t* const USART,
+                     const void* Buffer,
+                     uint16_t Length)
+{
+	uint8_t* CurrByte = (uint8_t*)Buffer;
+
+	while (Length--)
+	  Serial_SendByte(USART, *(CurrByte++));
+}
+
+void Serial_CreateStream(USART_t* USART, FILE* Stream)
+{
+	if (!(Stream))
+	{
+		Stream = &USARTSerialStream;
+		stdin  = Stream;
+		stdout = Stream;
+    }
+
+    *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar, _FDEV_SETUP_RW);
+    fdev_set_udata(Stream, USART);
+}
+
+void Serial_CreateBlockingStream(USART_t* USART, FILE* Stream)
+{
+	if (!(Stream))
+	{
+		Stream = &USARTSerialStream;
+		stdin  = Stream;
+		stdout = Stream;
+	}
+
+    *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar_Blocking, _FDEV_SETUP_RW);
+    fdev_set_udata(Stream, USART);
+}
+
+#endif
diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
new file mode 100644
index 0000000000..36f507d43e
--- /dev/null
+++ b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
@@ -0,0 +1,289 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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
+ *  \brief Serial USART Peripheral Driver (XMEGA)
+ *
+ *  On-chip serial USART driver for the XMEGA AVR microcontrollers.
+ *
+ *  \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_XMEGA Serial USART Peripheral Driver (XMEGA)
+ *
+ *  \section Sec_Serial_XMEGA_ModDescription Module Description
+ *  On-chip serial USART driver for the XMEGA AVR microcontrollers.
+ *
+ *  \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.
+ *
+ *  \section Sec_Serial_XMEGA_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
+ *  \code
+ *      // Initialize the serial USART driver before first use, with 9600 baud (and no double-speed mode)
+ *      Serial_Init(&USARTD0, 9600, false);
+ *
+ *      // Send a string through the USART
+ *      Serial_TxString(&USARTD0, "Test String\r\n");
+ *
+ *      // Receive a byte through the USART
+ *      uint8_t DataByte = Serial_RxByte(&USARTD0);
+ *  \endcode
+ *
+ *  @{
+ */
+
+#ifndef __SERIAL_XMEGA_H__
+#define __SERIAL_XMEGA_H__
+
+	/* Includes: */
+		#include "../../../Common/Common.h"
+		#include "../../Misc/TerminalCodes.h"
+
+		#include <stdio.h>
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_SERIAL_H) && !defined(__INCLUDE_FROM_SERIAL_C)
+			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead.
+		#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 \c U2X (double speed) bit is
+			 *  not set.
+			 *
+			 *  \param[in] Baud  Target serial UART baud rate.
+			 *
+			 *  \return Closest UBRR register value for the given UART frequency.
+			 */
+			#define SERIAL_UBBRVAL(Baud)    ((((F_CPU / 16) + (Baud / 2)) / (Baud)) - 1)
+
+			/** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is
+			 *  set.
+			 *
+			 *  \param[in] Baud  Target serial UART baud rate.
+			 *
+			 *  \return Closest UBRR register value for the given UART frequency.
+			 */
+			#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,out] USART           Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     FlashStringPtr  Pointer to a string located in program space.
+			 */
+			void Serial_SendString_P(USART_t* const USART,
+			                         const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
+
+			/** Transmits a given string located in SRAM memory through the USART.
+			 *
+			 *  \param[in,out] USART      Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     StringPtr  Pointer to a string located in SRAM space.
+			 */
+			void Serial_SendString(USART_t* const USART,
+			                       const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
+
+			/** Transmits a given buffer located in SRAM memory through the USART.
+			 *
+			 *  \param[in,out] USART   Pointer to the base of the USART peripheral within the device.
+			 *  \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(USART_t* const USART,
+			                     const void* Buffer,
+			                     uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+
+			/** 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] USART   Pointer to the base of the USART peripheral within the device.
+			 *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed, if \c NULL, \c stdout
+			 *                         and \c 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.
+			 */
+			void Serial_CreateStream(USART_t* USART, FILE* Stream);
+
+            /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
+			 *  the transfer.
+			 *
+			 *  \param[in,out] USART   Pointer to the base of the USART peripheral within the device.
+			 *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed, if \c NULL, \c stdout
+			 *                         and \c 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.
+			 */
+			void Serial_CreateBlockingStream(USART_t* USART, FILE* Stream);
+
+		/* 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,out] USART        Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     BaudRate     Serial baud rate, in bits per second. This should be the target baud rate regardless of
+			 *                              the \c DoubleSpeed parameter's value.
+			 *  \param[in]     DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate.
+			 */
+			static inline void Serial_Init(USART_t* const USART,
+			                               const uint32_t BaudRate,
+			                               const bool DoubleSpeed) ATTR_NON_NULL_PTR_ARG(1);
+			static inline void Serial_Init(USART_t* const USART,
+			                               const uint32_t BaudRate,
+			                               const bool DoubleSpeed)
+			{
+				uint16_t BaudValue = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
+
+				USART->BAUDCTRLB = (BaudValue >> 8);
+				USART->BAUDCTRLA = (BaudValue & 0xFF);
+
+				USART->CTRLC = (USART_CMODE_ASYNCHRONOUS_gc | USART_PMODE_DISABLED_gc | USART_CHSIZE_8BIT_gc);
+				USART->CTRLB = (USART_RXEN_bm | USART_TXEN_bm | (DoubleSpeed ? USART_CLK2X_bm : 0));
+			}
+
+			/** Turns off the USART driver, disabling and returning used hardware to their default configuration.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 */
+			static inline void Serial_Disable(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void Serial_Disable(USART_t* const USART)
+			{
+				USART->CTRLA = 0;
+				USART->CTRLB = 0;
+				USART->CTRLC = 0;
+			}
+
+			/** Indicates whether a character has been received through the USART.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 *
+			 *  \return Boolean \c true if a character has been received, \c false otherwise.
+			 */
+			static inline bool Serial_IsCharReceived(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+			static inline bool Serial_IsCharReceived(USART_t* const USART)
+			{
+				return ((USART->STATUS & USART_RXCIF_bm) ? true : false);
+			}
+
+			/** Indicates whether there is hardware buffer space for a new transmit on the USART. This
+			 *  function can be used to determine if a call to \ref Serial_SendByte() will block in advance.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 *
+			 *  \return Boolean \c true if a character can be queued for transmission immediately, \c false otherwise.
+			 */
+			static inline bool Serial_IsSendReady(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+			static inline bool Serial_IsSendReady(USART_t* const USART)
+			{
+				return (USART->STATUS & USART_DREIF_bm) ? true : false;
+			}
+
+			/** Indicates whether the hardware USART transmit buffer is completely empty, indicating all
+			 *  pending transmissions have completed.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 *
+			 *  \return Boolean \c true if no characters are buffered for transmission, \c false otherwise.
+			 */
+			static inline bool Serial_IsSendComplete(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+			static inline bool Serial_IsSendComplete(USART_t* const USART)
+			{
+				return (USART->STATUS & USART_TXCIF_bm) ? true : false;
+			}
+
+			/** Transmits a given byte through the USART.
+			 *
+			 *  \note If no buffer space is available in the hardware USART, this function will block. To check if
+			 *        space is available before calling this function, see \ref Serial_IsSendReady().
+			 *
+			 *  \param[in,out] USART     Pointer to the base of the USART peripheral within the device.
+			 *  \param[in]     DataByte  Byte to transmit through the USART.
+			 */
+			static inline void Serial_SendByte(USART_t* const USART,
+			                                   const char DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void Serial_SendByte(USART_t* const USART,
+			                                   const char DataByte)
+			{
+				while (!(Serial_IsSendReady(USART)));
+				USART->DATA = DataByte;
+			}
+
+			/** Receives the next byte from the USART.
+			 *
+			 *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+			 *
+			 *  \return Next byte received from the USART, or a negative value if no byte has been received.
+			 */
+			static inline int16_t Serial_ReceiveByte(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline int16_t Serial_ReceiveByte(USART_t* const USART)
+			{
+				if (!(Serial_IsCharReceived(USART)))
+				  return -1;
+
+				USART->STATUS = USART_RXCIF_bm;
+				return USART->DATA;
+			}
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+
diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/TWI_XMEGA.c b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/TWI_XMEGA.c
new file mode 100644
index 0000000000..92cc643b9e
--- /dev/null
+++ b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/TWI_XMEGA.c
@@ -0,0 +1,185 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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.
+*/
+
+#include "../../../Common/Common.h"
+#if (ARCH == ARCH_XMEGA)
+
+#define  __INCLUDE_FROM_TWI_C
+#include "../TWI.h"
+
+uint8_t TWI_StartTransmission(TWI_t* const TWI,
+                              const uint8_t SlaveAddress,
+                              const uint8_t TimeoutMS)
+{
+	uint16_t TimeoutRemaining;
+
+	TWI->MASTER.ADDR = SlaveAddress;
+
+	TimeoutRemaining = (TimeoutMS * 100);
+	while (TimeoutRemaining)
+	{
+		uint8_t status = TWI->MASTER.STATUS;
+
+		if ((status & (TWI_MASTER_WIF_bm | TWI_MASTER_ARBLOST_bm)) == (TWI_MASTER_WIF_bm | TWI_MASTER_ARBLOST_bm))
+		{
+			TWI->MASTER.ADDR = SlaveAddress;
+		}
+		else if ((status & (TWI_MASTER_WIF_bm | TWI_MASTER_RXACK_bm)) == (TWI_MASTER_WIF_bm | TWI_MASTER_RXACK_bm))
+		{
+			TWI_StopTransmission(TWI);
+			return TWI_ERROR_SlaveResponseTimeout;
+		}
+		else if (status & (TWI_MASTER_WIF_bm | TWI_MASTER_RIF_bm))
+		{
+			return TWI_ERROR_NoError;
+		}
+
+		_delay_us(10);
+		TimeoutRemaining--;
+	}
+
+	if (!(TimeoutRemaining)) {
+		if (TWI->MASTER.STATUS & TWI_MASTER_CLKHOLD_bm) {
+			TWI_StopTransmission(TWI);
+		}
+	}
+
+	return TWI_ERROR_BusCaptureTimeout;
+}
+
+bool TWI_SendByte(TWI_t* const TWI,
+                  const uint8_t Byte)
+{
+	TWI->MASTER.DATA = Byte;
+
+	while (!(TWI->MASTER.STATUS & TWI_MASTER_WIF_bm));
+
+	return (TWI->MASTER.STATUS & TWI_MASTER_WIF_bm) && !(TWI->MASTER.STATUS & TWI_MASTER_RXACK_bm);
+}
+
+bool TWI_ReceiveByte(TWI_t* const TWI,
+                     uint8_t* const Byte,
+                     const bool LastByte)
+{
+	if ((TWI->MASTER.STATUS & (TWI_MASTER_BUSERR_bm | TWI_MASTER_ARBLOST_bm)) == (TWI_MASTER_BUSERR_bm | TWI_MASTER_ARBLOST_bm)) {
+		return false;
+	}
+
+	while (!(TWI->MASTER.STATUS & TWI_MASTER_RIF_bm));
+
+	*Byte = TWI->MASTER.DATA;
+
+	if (LastByte)
+	  TWI->MASTER.CTRLC = TWI_MASTER_ACKACT_bm | TWI_MASTER_CMD_STOP_gc;
+	else
+	  TWI->MASTER.CTRLC = TWI_MASTER_CMD_RECVTRANS_gc;
+
+	return true;
+}
+
+uint8_t TWI_ReadPacket(TWI_t* const TWI,
+                       const uint8_t SlaveAddress,
+                       const uint8_t TimeoutMS,
+                       const uint8_t* InternalAddress,
+                       uint8_t InternalAddressLen,
+                       uint8_t* Buffer,
+                       uint16_t Length)
+{
+	uint8_t ErrorCode;
+
+	if ((ErrorCode = TWI_StartTransmission(TWI, (SlaveAddress & TWI_DEVICE_ADDRESS_MASK) | TWI_ADDRESS_WRITE,
+	                                       TimeoutMS)) == TWI_ERROR_NoError)
+	{
+		while (InternalAddressLen--)
+		{
+			if (!(TWI_SendByte(TWI, *(InternalAddress++))))
+			{
+				ErrorCode = TWI_ERROR_SlaveNAK;
+				break;
+			}
+		}
+
+		if ((ErrorCode = TWI_StartTransmission(TWI, (SlaveAddress & TWI_DEVICE_ADDRESS_MASK) | TWI_ADDRESS_READ,
+		                                       TimeoutMS)) == TWI_ERROR_NoError)
+		{
+			while (Length--)
+			{
+				if (!(TWI_ReceiveByte(TWI, Buffer++, (Length == 0))))
+				{
+					ErrorCode = TWI_ERROR_SlaveNAK;
+					break;
+				}
+			}
+		}
+
+		TWI_StopTransmission(TWI);
+	}
+
+	return ErrorCode;
+}
+
+uint8_t TWI_WritePacket(TWI_t* const TWI,
+                        const uint8_t SlaveAddress,
+                        const uint8_t TimeoutMS,
+                        const uint8_t* InternalAddress,
+                        uint8_t InternalAddressLen,
+                        const uint8_t* Buffer,
+                        uint16_t Length)
+{
+	uint8_t ErrorCode;
+
+	if ((ErrorCode = TWI_StartTransmission(TWI, (SlaveAddress & TWI_DEVICE_ADDRESS_MASK) | TWI_ADDRESS_WRITE,
+	                                       TimeoutMS)) == TWI_ERROR_NoError)
+	{
+		while (InternalAddressLen--)
+		{
+			if (!(TWI_SendByte(TWI, *(InternalAddress++))))
+			{
+				ErrorCode = TWI_ERROR_SlaveNAK;
+				break;
+			}
+		}
+
+		while (Length--)
+		{
+			if (!(TWI_SendByte(TWI, *(Buffer++))))
+			{
+				ErrorCode = TWI_ERROR_SlaveNAK;
+				break;
+			}
+		}
+
+		TWI_StopTransmission(TWI);
+	}
+
+	return ErrorCode;
+}
+
+#endif
diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/TWI_XMEGA.h b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/TWI_XMEGA.h
new file mode 100644
index 0000000000..94ada73719
--- /dev/null
+++ b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/TWI_XMEGA.h
@@ -0,0 +1,302 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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
+ *  \brief TWI Peripheral Driver (XMEGA)
+ *
+ *  On-chip TWI driver for the XMEGA Family of AVR microcontrollers.
+ *
+ *  \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_XMEGA TWI Peripheral Driver (XMEGA)
+ *
+ *  \section Sec_TWI_XMEGA_ModDescription Module Description
+ *  Master mode TWI driver for the 8-bit AVR microcontrollers which contain 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.
+ *
+ *  \section Sec_TWI_XMEGA_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
+ *  <b>Low Level API Example:</b>
+ *  \code
+ *      // Initialize the TWI driver before first use at 200KHz
+ *      TWI_Init(&TWIC, TWI_BAUD_FROM_FREQ(200000));
+ *
+ *      // Start a write session to device at device address 0xA0, internal address 0xDC with a 10ms timeout
+ *      if (TWI_StartTransmission(&TWIC, 0xA0 | TWI_ADDRESS_WRITE, 10) == TWI_ERROR_NoError)
+ *      {
+ *          TWI_SendByte(&TWIC, 0xDC);
+ *
+ *          TWI_SendByte(&TWIC, 0x01);
+ *          TWI_SendByte(&TWIC, 0x02);
+ *          TWI_SendByte(&TWIC, 0x03);
+ *
+ *          // Must stop transmission afterwards to release the bus
+ *          TWI_StopTransmission(&TWIC);
+ *      }
+ *
+ *      // Start a read session to device at address 0xA0, internal address 0xDC with a 10ms timeout
+ *      if (TWI_StartTransmission(&TWIC, 0xA0 | TWI_ADDRESS_WRITE, 10) == TWI_ERROR_NoError)
+ *      {
+ *          TWI_SendByte(&TWIC, 0xDC);
+ *          TWI_StopTransmission(&TWIC);
+ *
+ *          if (TWI_StartTransmission(&TWIC, 0xA0 | TWI_ADDRESS_READ, 10) == TWI_ERROR_NoError)
+ *          {
+ *              uint8_t Byte1, Byte2, Byte3;
+ *
+ *              // Read three bytes, acknowledge after the third byte is received
+ *              TWI_ReceiveByte(&TWIC, &Byte1, false);
+ *              TWI_ReceiveByte(&TWIC, &Byte2, false);
+ *              TWI_ReceiveByte(&TWIC, &Byte3, true);
+ *
+ *              // Must stop transmission afterwards to release the bus
+ *              TWI_StopTransmission(&TWIC);
+ *          }
+ *      }
+ *  \endcode
+ *
+ *  <b>High Level API Example:</b>
+ *  \code
+ *      // Initialize the TWI driver before first use at 200KHz
+ *      TWI_Init(&TWIC, TWI_BAUD_FROM_FREQ(200000));
+ *
+ *      // Start a write session to device at device address 0xA0, internal address 0xDC with a 10ms timeout
+ *      uint8_t InternalWriteAddress = 0xDC;
+ *      uint8_t WritePacket[3] = {0x01, 0x02, 0x03};
+ *
+ *      TWI_WritePacket(&TWIC, 0xA0, 10, &InternalWriteAddress, sizeof(InternalWriteAddress),
+ *                      &WritePacket, sizeof(WritePacket);
+ *
+ *      // Start a read session to device at address 0xA0, internal address 0xDC with a 10ms timeout
+ *      uint8_t InternalReadAddress = 0xDC;
+ *      uint8_t ReadPacket[3];
+ *
+ *      TWI_ReadPacket(&TWIC, 0xA0, 10, &InternalReadAddress, sizeof(InternalReadAddress),
+ *                     &ReadPacket, sizeof(ReadPacket);
+ *  \endcode
+ *
+ *  @{
+ */
+
+#ifndef __TWI_XMEGA_H__
+#define __TWI_XMEGA_H__
+
+	/* Includes: */
+		#include "../../../Common/Common.h"
+
+		#include <stdio.h>
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_TWI_H) && !defined(__INCLUDE_FROM_TWI_C)
+			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/TWI.h instead.
+		#endif
+
+	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			/** TWI slave device address mask for a read session. Mask with a slave device base address to obtain
+			 *  the correct TWI bus address for the slave device when reading data from it.
+			 */
+			#define TWI_ADDRESS_READ         0x01
+
+			/** TWI slave device address mask for a write session. Mask with a slave device base address to obtain
+			 *  the correct TWI bus address for the slave device when writing data to it.
+			 */
+			#define TWI_ADDRESS_WRITE        0x00
+
+			/** Mask to retrieve the base address for a TWI device, which can then be ORed with \ref TWI_ADDRESS_READ
+			 *  or \ref TWI_ADDRESS_WRITE to obtain the device's read and write address respectively.
+			 */
+			#define TWI_DEVICE_ADDRESS_MASK  0xFE
+
+			/** Calculates the length of each bit on the TWI bus for a given target frequency. This may be used with
+			 *  the \ref TWI_Init() function to convert a bus frequency to a number of clocks for the \c BitLength
+			 *  parameter.
+			 *
+			 *  \param[in] Frequency  Desired TWI bus frequency in Hz.
+			 *
+			 *  \return Bit length in clocks for the given TWI bus frequency at the given prescaler value.
+			 */
+			#define TWI_BAUD_FROM_FREQ(Frequency) ((F_CPU / (2 * Frequency)) - 5)
+
+		/* Enums: */
+			/** Enum for the possible return codes of the TWI transfer start routine and other dependant TWI functions. */
+			enum TWI_ErrorCodes_t
+			{
+				TWI_ERROR_NoError              = 0, /**< Indicates that the command completed successfully. */
+				TWI_ERROR_BusFault             = 1, /**< A TWI bus fault occurred while attempting to capture the bus. */
+				TWI_ERROR_BusCaptureTimeout    = 2, /**< A timeout occurred whilst waiting for the bus to be ready. */
+				TWI_ERROR_SlaveResponseTimeout = 3, /**< No ACK received at the nominated slave address within the timeout period. */
+				TWI_ERROR_SlaveNotReady        = 4, /**< Slave NAKed the TWI bus START condition. */
+				TWI_ERROR_SlaveNAK             = 5, /**< Slave NAKed whilst attempting to send data to the device. */
+			};
+
+		/* Inline Functions: */
+			/** Initializes the TWI hardware into master mode, ready for data transmission and reception. This must be
+			 *  before any other TWI operations.
+			 *
+			 *  The generated SCL frequency will be according to the formula <pre>F_CPU / (2 * (5 + (BAUD)))</pre>.
+			 *
+			 *  \attention The value of the \c BitLength parameter should not be set below 10 or invalid bus conditions may
+			 *             occur, as indicated in the XMEGA microcontroller datasheet.
+			 *
+			 *  \param[in] TWI   Pointer to the base of the TWI peripheral within the device.
+			 *  \param[in] Baud  Value of the BAUD register of the TWI Master.
+			 */
+			static inline void TWI_Init(TWI_t* const TWI,
+			                            const uint8_t Baud) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void TWI_Init(TWI_t* const TWI,
+			                            const uint8_t Baud)
+			{
+				TWI->CTRL          = 0x00;
+				TWI->MASTER.BAUD   = Baud;
+				TWI->MASTER.CTRLA  = TWI_MASTER_ENABLE_bm;
+				TWI->MASTER.CTRLB  = 0;
+				TWI->MASTER.STATUS = TWI_MASTER_BUSSTATE_IDLE_gc;
+			}
+
+			/** Turns off the TWI driver hardware. If this is called, any further TWI operations will require a call to
+			 *  \ref TWI_Init() before the TWI can be used again.
+	   		 *
+			 *  \param[in] TWI  Pointer to the base of the TWI peripheral within the device.
+			 */
+			static inline void TWI_Disable(TWI_t* const TWI) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void TWI_Disable(TWI_t* const TWI)
+			{
+				TWI->MASTER.CTRLA &= ~TWI_MASTER_ENABLE_bm;
+			}
+
+			/** Sends a TWI STOP onto the TWI bus, terminating communication with the currently addressed device.
+			 *
+			 *  \param[in] TWI  Pointer to the base of the TWI peripheral within the device.
+			 */
+			static inline void TWI_StopTransmission(TWI_t* const TWI) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+			static inline void TWI_StopTransmission(TWI_t* const TWI)
+			{
+				TWI->MASTER.CTRLC = TWI_MASTER_ACKACT_bm | TWI_MASTER_CMD_STOP_gc;
+			}
+
+		/* Function Prototypes: */
+			/** Begins a master mode TWI bus communication with the given slave device address.
+			 *
+			 *  \param[in] TWI           Pointer to the base of the TWI peripheral within the device.
+			 *  \param[in] SlaveAddress  Address of the slave TWI device to communicate with.
+			 *  \param[in] TimeoutMS     Timeout period within which the slave must respond, in milliseconds.
+			 *
+			 *  \return A value from the \ref TWI_ErrorCodes_t enum.
+			 */
+			uint8_t TWI_StartTransmission(TWI_t* const TWI,
+			                              const uint8_t SlaveAddress,
+			                              const uint8_t TimeoutMS) ATTR_NON_NULL_PTR_ARG(1);
+
+			/** Sends a byte to the currently addressed device on the TWI bus.
+			 *
+			 *  \param[in] TWI   Pointer to the base of the TWI peripheral within the device.
+			 *  \param[in] Byte  Byte to send to the currently addressed device
+			 *
+			 *  \return Boolean \c true if the recipient ACKed the byte, \c false otherwise
+			 */
+			bool TWI_SendByte(TWI_t* const TWI,
+			                  const uint8_t Byte) ATTR_NON_NULL_PTR_ARG(1);
+
+			/** Receives a byte from the currently addressed device on the TWI bus.
+			 *
+			 *  \param[in] TWI       Pointer to the base of the TWI peripheral within the device.
+			 *  \param[in] Byte      Location where the read byte is to be stored.
+			 *  \param[in] LastByte  Indicates if the byte should be ACKed if false, NAKed if true.
+			 *
+			 *  \return Boolean \c true if the byte reception successfully completed, \c false otherwise.
+			 */
+			bool TWI_ReceiveByte(TWI_t* const TWI,
+			                     uint8_t* const Byte,
+			                     const bool LastByte) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+
+			/** High level function to perform a complete packet transfer over the TWI bus to the specified
+			 *  device.
+			 *
+			 *  \param[in] TWI                 Pointer to the base of the TWI peripheral within the device.
+			 *  \param[in] SlaveAddress        Base address of the TWI slave device to communicate with.
+			 *  \param[in] TimeoutMS           Timeout for bus capture and slave START ACK, in milliseconds.
+			 *  \param[in] InternalAddress     Pointer to a location where the internal slave read start address is stored.
+			 *  \param[in] InternalAddressLen  Size of the internal device address, in bytes.
+			 *  \param[in] Buffer              Pointer to a buffer where the read packet data is to be stored.
+			 *  \param[in] Length              Size of the packet to read, in bytes.
+			 *
+			 *  \return A value from the \ref TWI_ErrorCodes_t enum.
+			 */
+			uint8_t TWI_ReadPacket(TWI_t* const TWI,
+			                       const uint8_t SlaveAddress,
+			                       const uint8_t TimeoutMS,
+			                       const uint8_t* InternalAddress,
+			                       uint8_t InternalAddressLen,
+			                       uint8_t* Buffer,
+			                       uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(4);
+
+			/** High level function to perform a complete packet transfer over the TWI bus from the specified
+			 *  device.
+			 *
+			 *  \param[in] TWI                 Pointer to the base of the TWI peripheral within the device.
+			 *  \param[in] SlaveAddress        Base address of the TWI slave device to communicate with
+			 *  \param[in] TimeoutMS           Timeout for bus capture and slave START ACK, in milliseconds
+			 *  \param[in] InternalAddress     Pointer to a location where the internal slave write start address is stored
+			 *  \param[in] InternalAddressLen  Size of the internal device address, in bytes
+			 *  \param[in] Buffer              Pointer to a buffer where the packet data to send is stored
+			 *  \param[in] Length              Size of the packet to send, in bytes
+			 *
+			 *  \return A value from the \ref TWI_ErrorCodes_t enum.
+			 */
+			uint8_t TWI_WritePacket(TWI_t* const TWI,
+			                        const uint8_t SlaveAddress,
+			                        const uint8_t TimeoutMS,
+			                        const uint8_t* InternalAddress,
+			                        uint8_t InternalAddressLen,
+			                        const uint8_t* Buffer,
+			                        uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(4);
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+