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

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

1 files changed, 124 insertions, 0 deletions

diff --git a/LUFA/Drivers/USB/Core/EndpointStream.h b/LUFA/Drivers/USB/Core/EndpointStream.h
new file mode 100644
index 0000000000..156d155b3d
--- /dev/null
+++ b/LUFA/Drivers/USB/Core/EndpointStream.h
@@ -0,0 +1,124 @@
+/*
+             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 Endpoint data stream transmission and reception management.
+ *  \copydetails Group_EndpointStreamRW
+ *
+ *  \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_EndpointRW
+ *  \defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams
+ *  \brief Endpoint data stream transmission and reception management.
+ *
+ *  Functions, macros, variables, enums and types related to data reading and writing of data streams from
+ *  and to endpoints.
+ *
+ *  @{
+ */
+
+#ifndef __ENDPOINT_STREAM_H__
+#define __ENDPOINT_STREAM_H__
+
+	/* Includes: */
+		#include "../../../Common/Common.h"
+		#include "USBMode.h"
+
+	/* Enable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			extern "C" {
+		#endif
+
+	/* Preprocessor Checks: */
+		#if !defined(__INCLUDE_FROM_USB_DRIVER)
+			#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+		#endif
+
+	/* Public Interface - May be used in end-application: */
+		/* Enums: */
+			/** Enum for the possible error return codes of the \c Endpoint_*_Stream_* functions. */
+			enum Endpoint_Stream_RW_ErrorCodes_t
+			{
+				ENDPOINT_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
+				ENDPOINT_RWSTREAM_EndpointStalled    = 1, /**< The endpoint was stalled during the stream
+				                                           *   transfer by the host or device.
+				                                           */
+				ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
+				                                           *   the transfer.
+				                                           */
+				ENDPOINT_RWSTREAM_BusSuspended       = 3, /**< The USB bus has been suspended by the host and
+				                                           *   no USB endpoint traffic can occur until the bus
+				                                           *   has resumed.
+				                                           */
+				ENDPOINT_RWSTREAM_Timeout            = 4, /**< The host failed to accept or send the next packet
+				                                           *   within the software timeout period set by the
+				                                           *   \ref USB_STREAM_TIMEOUT_MS macro.
+				                                           */
+				ENDPOINT_RWSTREAM_IncompleteTransfer = 5, /**< Indicates that the endpoint bank became full or empty before
+				                                           *   the complete contents of the current stream could be
+				                                           *   transferred. The endpoint stream function should be called
+				                                           *   again to process the next chunk of data in the transfer.
+				                                           */
+			};
+
+			/** Enum for the possible error return codes of the \c Endpoint_*_Control_Stream_* functions. */
+			enum Endpoint_ControlStream_RW_ErrorCodes_t
+			{
+				ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */
+				ENDPOINT_RWCSTREAM_HostAborted        = 1, /**< The aborted the transfer prematurely. */
+				ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during
+				                                            *   the transfer.
+				                                            */
+				ENDPOINT_RWCSTREAM_BusSuspended       = 3, /**< The USB bus has been suspended by the host and
+				                                            *   no USB endpoint traffic can occur until the bus
+				                                            *   has resumed.
+				                                            */
+			};
+
+	/* Architecture Includes: */
+		#if (ARCH == ARCH_AVR8)
+			#include "AVR8/EndpointStream_AVR8.h"
+		#elif (ARCH == ARCH_UC3)
+			#include "UC3/EndpointStream_UC3.h"
+		#elif (ARCH == ARCH_XMEGA)
+			#include "XMEGA/EndpointStream_XMEGA.h"
+		#endif
+
+	/* Disable C linkage for C++ Compilers: */
+		#if defined(__cplusplus)
+			}
+		#endif
+
+#endif
+
+/** @} */
+