Squashed 'lib/lufa/' content from commit 385d40300

git-subtree-dir: lib/lufa
git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b

1 files changed, 165 insertions, 0 deletions

diff --git a/LUFA/Drivers/USB/Core/USBController.h b/LUFA/Drivers/USB/Core/USBController.h
new file mode 100644
index 0000000000..5980a37ce6
--- /dev/null
+++ b/LUFA/Drivers/USB/Core/USBController.h
@@ -0,0 +1,165 @@
+/*
+             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 Common USB Controller definitions for all architectures.
+ *  \copydetails Group_USBManagement
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+/** \ingroup Group_USB
+ *  \defgroup Group_USBManagement USB Interface Management
+ *  \brief USB Controller definitions for general USB controller management.
+ *
+ *  Functions, macros, variables, enums and types related to the setup and management of the USB interface.
+ *
+ *  @{
+ */
+
+#ifndef __USBCONTROLLER_H__
+#define __USBCONTROLLER_H__
+
+	/* Includes: */
+		#include "../../../Common/Common.h"
+		#include "USBMode.h"
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks and Defines: */
+		#if !defined(__INCLUDE_FROM_USB_DRIVER)
+			#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+		#endif
+
+	/* Defines: */
+		/** \name Endpoint Direction Masks */
+		//@{
+		/** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
+		 *  direction for comparing with the \c ENDPOINT_DIR_* masks.
+		 */
+		#define ENDPOINT_DIR_MASK                  0x80
+
+		/** Endpoint address direction mask for an OUT direction (Host to Device) endpoint. This may be ORed with
+		 *  the index of the address within a device to obtain the full endpoint address.
+		 */
+		#define ENDPOINT_DIR_OUT                   0x00
+
+		/** Endpoint address direction mask for an IN direction (Device to Host) endpoint. This may be ORed with
+		 *  the index of the address within a device to obtain the full endpoint address.
+		 */
+		#define ENDPOINT_DIR_IN                    0x80
+		//@}
+
+		/** \name Pipe Direction Masks */
+		//@{
+		/** Pipe direction mask, for masking against pipe addresses to retrieve the pipe's
+		 *  direction for comparing with the \c PIPE_DIR_* masks.
+		 */
+		#define PIPE_DIR_MASK                      0x80
+
+		/** Endpoint address direction mask for an OUT direction (Host to Device) endpoint. This may be ORed with
+		 *  the index of the address within a device to obtain the full endpoint address.
+		 */
+		#define PIPE_DIR_OUT                       0x00
+
+		/** Endpoint address direction mask for an IN direction (Device to Host) endpoint. This may be ORed with
+		 *  the index of the address within a device to obtain the full endpoint address.
+		 */
+		#define PIPE_DIR_IN                        0x80
+		//@}
+
+		/** \name Endpoint/Pipe Type Masks */
+		//@{
+		/** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
+		 *  with the \c EP_TYPE_* masks to determine the exact type of the endpoint.
+		 */
+		#define EP_TYPE_MASK                       0x03
+
+		/** Mask for a CONTROL type endpoint or pipe.
+		 *
+		 *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+		 */
+		#define EP_TYPE_CONTROL                    0x00
+
+		/** Mask for an ISOCHRONOUS type endpoint or pipe.
+		 *
+		 *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+		 */
+		#define EP_TYPE_ISOCHRONOUS                0x01
+
+		/** Mask for a BULK type endpoint or pipe.
+		 *
+		 *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+		 */
+		#define EP_TYPE_BULK                       0x02
+
+		/** Mask for an INTERRUPT type endpoint or pipe.
+		 *
+		 *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+		 */
+		#define EP_TYPE_INTERRUPT                  0x03
+		//@}
+
+	/* Enums: */
+		/** Enum for the possible USB controller modes, for initialization via \ref USB_Init() and indication back to the
+		 *  user application via \ref USB_CurrentMode.
+		 */
+		enum USB_Modes_t
+		{
+			USB_MODE_None   = 0, /**< Indicates that the controller is currently not initialized in any specific USB mode. */
+			USB_MODE_Device = 1, /**< Indicates that the controller is currently initialized in USB Device mode. */
+			USB_MODE_Host   = 2, /**< Indicates that the controller is currently initialized in USB Host mode. */
+			USB_MODE_UID    = 3, /**< Indicates that the controller should determine the USB mode from the UID pin of the
+			                      *   USB connector.
+			                      */
+		};
+
+	/* Architecture Includes: */
+		#if (ARCH == ARCH_AVR8)
+			#include "AVR8/USBController_AVR8.h"
+		#elif (ARCH == ARCH_UC3)
+			#include "UC3/USBController_UC3.h"
+		#elif (ARCH == ARCH_XMEGA)
+			#include "XMEGA/USBController_XMEGA.h"
+		#endif
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+