PipeStream.h 3.56 KB
 Dean Camera committed Aug 22, 2010 1 2 /* LUFA Library  Dean Camera committed Jan 01, 2011 3  Copyright (C) Dean Camera, 2011.  Dean Camera committed Aug 22, 2010 4 5  dean [at] fourwalledcubicle [dot] com  Dean Camera committed Oct 28, 2010 6  www.lufa-lib.org  Dean Camera committed Aug 22, 2010 7 8 9 */ /*  Dean Camera committed Jan 01, 2011 10  Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed Aug 22, 2010 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31  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  Dean Camera committed Feb 20, 2011 32 33  * \brief Pipe data stream transmission and reception management. * \copydetails Group_PipeStreamRW  Dean Camera committed Aug 22, 2010 34 35 36 37 38 39  * * \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_PipeRW  Dean Camera committed Feb 19, 2011 40  * \defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams  Dean Camera committed Feb 20, 2011 41  * \brief Pipe data stream transmission and reception management.  Dean Camera committed Aug 22, 2010 42 43 44 45 46 47 48 49 50 51 52 53  * * Functions, macros, variables, enums and types related to data reading and writing of data streams from * and to pipes. * * @{ */ #ifndef __PIPE_STREAM_H__ #define __PIPE_STREAM_H__ /* Includes: */ #include "../../../Common/Common.h"  Dean Camera committed May 26, 2011 54  #include "USBMode.h"  Dean Camera committed Aug 22, 2010 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79  /* 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 Pipe_*_Stream_* functions. */ enum Pipe_Stream_RW_ErrorCodes_t { PIPE_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */ PIPE_RWSTREAM_PipeStalled = 1, /**< The device stalled the pipe during the transfer. */ PIPE_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during * the transfer. */ PIPE_RWSTREAM_Timeout = 3, /**< The device failed to accept or send the next packet * within the software timeout period set by the * \ref USB_STREAM_TIMEOUT_MS macro. */  Dean Camera committed Jan 10, 2011 80 81  PIPE_RWSTREAM_IncompleteTransfer = 4, /**< Indicates that the pipe bank became full/empty before the * complete contents of the stream could be transferred.  Dean Camera committed Aug 22, 2010 82 83 84  */ };  Dean Camera committed May 26, 2011 85 86 87 88 89  /* Architecture Includes: */ #if (ARCH == ARCH_AVR8) #include "AVR8/PipeStream_AVR8.h" #elif (ARCH == ARCH_UC3) #include "UC3/PipeStream_UC3.h"  Dean Camera committed Aug 22, 2010 90 91 92 93 94  #endif #endif /** @} */  Dean Camera committed May 26, 2011 95