-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2011.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief Endpoint data stream transmission and reception management.\r
- * \copydetails Group_EndpointStreamRW\r
- *\r
- * \note This file should not be included directly. It is automatically included as needed by the USB driver\r
- * dispatch header located in LUFA/Drivers/USB/USB.h.\r
- */\r
-\r
-/** \ingroup Group_EndpointRW \r
- * \defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams\r
- * \brief Endpoint data stream transmission and reception management.\r
- *\r
- * Functions, macros, variables, enums and types related to data reading and writing of data streams from\r
- * and to endpoints.\r
- *\r
- * @{\r
- */ \r
-\r
-#ifndef __ENDPOINT_STREAM_H__\r
-#define __ENDPOINT_STREAM_H__\r
-\r
- /* Includes: */\r
- #include "../../../Common/Common.h"\r
- #include "USBTask.h"\r
- \r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Preprocessor Checks: */\r
- #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
- #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Enums: */\r
- /** Enum for the possible error return codes of the \c Endpoint_*_Stream_* functions. */\r
- enum Endpoint_Stream_RW_ErrorCodes_t\r
- {\r
- ENDPOINT_RWSTREAM_NoError = 0, /**< Command completed successfully, no error. */\r
- ENDPOINT_RWSTREAM_EndpointStalled = 1, /**< The endpoint was stalled during the stream\r
- * transfer by the host or device.\r
- */\r
- ENDPOINT_RWSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during\r
- * the transfer.\r
- */\r
- ENDPOINT_RWSTREAM_BusSuspended = 3, /**< The USB bus has been suspended by the host and\r
- * no USB endpoint traffic can occur until the bus\r
- * has resumed.\r
- */\r
- ENDPOINT_RWSTREAM_Timeout = 4, /**< The host failed to accept or send the next packet\r
- * within the software timeout period set by the\r
- * \ref USB_STREAM_TIMEOUT_MS macro.\r
- */\r
- ENDPOINT_RWSTREAM_IncompleteTransfer = 5, /**< Indicates that the endpoint bank became full or empty before\r
- * the complete contents of the current stream could be\r
- * transferred. The endpoint stream function should be called\r
- * again to process the next chunk of data in the transfer.\r
- */\r
- };\r
- \r
- /** Enum for the possible error return codes of the \c Endpoint_*_Control_Stream_* functions. */\r
- enum Endpoint_ControlStream_RW_ErrorCodes_t\r
- {\r
- ENDPOINT_RWCSTREAM_NoError = 0, /**< Command completed successfully, no error. */\r
- ENDPOINT_RWCSTREAM_HostAborted = 1, /**< The aborted the transfer prematurely. */\r
- ENDPOINT_RWCSTREAM_DeviceDisconnected = 2, /**< Device was disconnected from the host during\r
- * the transfer.\r
- */\r
- ENDPOINT_RWCSTREAM_BusSuspended = 3, /**< The USB bus has been suspended by the host and\r
- * no USB endpoint traffic can occur until the bus\r
- * has resumed.\r
- */\r
- };\r
-\r
- /* Function Prototypes: */\r
-\r
- /** \name Stream functions for null data */\r
- //@{\r
-\r
- /** Reads and discards the given number of bytes from the currently selected endpoint's bank,\r
- * discarding fully read packets from the host as needed. The last packet is not automatically\r
- * discarded once the remaining bytes has been read; the user is responsible for manually\r
- * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once,\r
- * failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid\r
- * storage location, the transfer will instead be performed as a series of chunks. Each time\r
- * the endpoint bank becomes empty while there is still data to process (and after the current\r
- * packet has been acknowledged) the BytesProcessed location will be updated with the total number\r
- * of bytes processed in the stream, and the function will exit with an error code of\r
- * \ref ENDPOINT_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed\r
- * in the user code - to continue the transfer, call the function again with identical parameters\r
- * and it will resume until the BytesProcessed value reaches the total transfer length.\r
- *\r
- * <b>Single Stream Transfer Example:</b>\r
- * \code\r
- * uint8_t ErrorCode;\r
- *\r
- * if ((ErrorCode = Endpoint_Discard_Stream(512, NULL)) != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * <b>Partial Stream Transfers Example:</b>\r
- * \code\r
- * uint8_t ErrorCode;\r
- * uint16_t BytesProcessed;\r
- *\r
- * BytesProcessed = 0;\r
- * while ((ErrorCode = Endpoint_Discard_Stream(512, &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- *\r
- * if (ErrorCode != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \param[in] Length Number of bytes to discard via the currently selected endpoint.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Discard_Stream(uint16_t Length,\r
- uint16_t* const BytesProcessed);\r
-\r
- /** Writes a given number of zeroed bytes to the currently selected endpoint's bank, sending\r
- * full packets to the host as needed. The last packet is not automatically sent once the \r
- * remaining bytes have been written; the user is responsible for manually sending the last\r
- * packet to the host via the \ref Endpoint_ClearIN() macro.\r
- *\r
- * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once,\r
- * failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid\r
- * storage location, the transfer will instead be performed as a series of chunks. Each time\r
- * the endpoint bank becomes full while there is still data to process (and after the current\r
- * packet transmission has been initiated) the BytesProcessed location will be updated with the\r
- * total number of bytes processed in the stream, and the function will exit with an error code of\r
- * \ref ENDPOINT_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed\r
- * in the user code - to continue the transfer, call the function again with identical parameters\r
- * and it will resume until the BytesProcessed value reaches the total transfer length.\r
- *\r
- * <b>Single Stream Transfer Example:</b>\r
- * \code\r
- * uint8_t ErrorCode;\r
- *\r
- * if ((ErrorCode = Endpoint_Null_Stream(512, NULL)) != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * <b>Partial Stream Transfers Example:</b>\r
- * \code\r
- * uint8_t ErrorCode;\r
- * uint16_t BytesProcessed;\r
- *\r
- * BytesProcessed = 0;\r
- * while ((ErrorCode = Endpoint_Null_Stream(512, &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- *\r
- * if (ErrorCode != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \param[in] Length Number of zero bytes to send via the currently selected endpoint.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Null_Stream(uint16_t Length,\r
- uint16_t* const BytesProcessed);\r
-\r
- //@}\r
-\r
- /** \name Stream functions for RAM source/destination data */\r
- //@{\r
- \r
- /** Writes the given number of bytes to the endpoint from the given buffer in little endian,\r
- * sending full packets to the host as needed. The last packet filled is not automatically sent;\r
- * the user is responsible for manually sending the last written packet to the host via the\r
- * \ref Endpoint_ClearIN() macro.\r
- *\r
- * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once,\r
- * failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid\r
- * storage location, the transfer will instead be performed as a series of chunks. Each time\r
- * the endpoint bank becomes full while there is still data to process (and after the current\r
- * packet transmission has been initiated) the BytesProcessed location will be updated with the\r
- * total number of bytes processed in the stream, and the function will exit with an error code of\r
- * \ref ENDPOINT_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed\r
- * in the user code - to continue the transfer, call the function again with identical parameters\r
- * and it will resume until the BytesProcessed value reaches the total transfer length.\r
- *\r
- * <b>Single Stream Transfer Example:</b>\r
- * \code\r
- * uint8_t DataStream[512];\r
- * uint8_t ErrorCode;\r
- *\r
- * if ((ErrorCode = Endpoint_Write_Stream_LE(DataStream, sizeof(DataStream),\r
- * NULL)) != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * <b>Partial Stream Transfers Example:</b>\r
- * \code\r
- * uint8_t DataStream[512];\r
- * uint8_t ErrorCode;\r
- * uint16_t BytesProcessed;\r
- *\r
- * BytesProcessed = 0;\r
- * while ((ErrorCode = Endpoint_Write_Stream_LE(DataStream, sizeof(DataStream),\r
- * &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- *\r
- * if (ErrorCode != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Stream_LE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Writes the given number of bytes to the endpoint from the given buffer in big endian,\r
- * sending full packets to the host as needed. The last packet filled is not automatically sent;\r
- * the user is responsible for manually sending the last written packet to the host via the\r
- * \ref Endpoint_ClearIN() macro.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Stream_BE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
- \r
- /** Reads the given number of bytes from the endpoint from the given buffer in little endian,\r
- * discarding fully read packets from the host as needed. The last packet is not automatically\r
- * discarded once the remaining bytes has been read; the user is responsible for manually\r
- * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once,\r
- * failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid\r
- * storage location, the transfer will instead be performed as a series of chunks. Each time\r
- * the endpoint bank becomes empty while there is still data to process (and after the current\r
- * packet has been acknowledged) the BytesProcessed location will be updated with the total number\r
- * of bytes processed in the stream, and the function will exit with an error code of\r
- * \ref ENDPOINT_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed\r
- * in the user code - to continue the transfer, call the function again with identical parameters\r
- * and it will resume until the BytesProcessed value reaches the total transfer length.\r
- *\r
- * <b>Single Stream Transfer Example:</b>\r
- * \code\r
- * uint8_t DataStream[512];\r
- * uint8_t ErrorCode;\r
- *\r
- * if ((ErrorCode = Endpoint_Read_Stream_LE(DataStream, sizeof(DataStream),\r
- * NULL)) != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * <b>Partial Stream Transfers Example:</b>\r
- * \code\r
- * uint8_t DataStream[512];\r
- * uint8_t ErrorCode;\r
- * uint16_t BytesProcessed;\r
- *\r
- * BytesProcessed = 0;\r
- * while ((ErrorCode = Endpoint_Read_Stream_LE(DataStream, sizeof(DataStream),\r
- * &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- *\r
- * if (ErrorCode != ENDPOINT_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Stream_LE(void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Reads the given number of bytes from the endpoint from the given buffer in big endian,\r
- * discarding fully read packets from the host as needed. The last packet is not automatically\r
- * discarded once the remaining bytes has been read; the user is responsible for manually\r
- * discarding the last packet from the host via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * \note This routine should not be used on CONTROL type endpoints.\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Stream_BE(void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,\r
- * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared\r
- * in both failure and success states; the user is responsible for manually clearing the setup OUT to\r
- * finalize the transfer via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_Stream_LE(const void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,\r
- * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared\r
- * in both failure and success states; the user is responsible for manually clearing the setup OUT to\r
- * finalize the transfer via the \ref Endpoint_ClearOUT() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_Stream_BE(const void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,\r
- * discarding fully read packets from the host as needed. The device IN acknowledgement is not\r
- * automatically sent after success or failure states; the user is responsible for manually sending the\r
- * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_Stream_LE(void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,\r
- * discarding fully read packets from the host as needed. The device IN acknowledgement is not\r
- * automatically sent after success or failure states; the user is responsible for manually sending the\r
- * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_Stream_BE(void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
- //@}\r
-\r
- /** \name Stream functions for EEPROM source/destination data */\r
- //@{\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE().\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_EStream_LE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE().\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_EStream_BE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_EStream_LE(void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_EStream_BE(void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_EStream_LE(const void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_EStream_BE(const void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_EStream_LE(void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[out] Buffer Pointer to the destination data buffer to write to.\r
- * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
- //@}\r
-\r
- /** \name Stream functions for PROGMEM source/destination data */\r
- //@{\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().\r
- *\r
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_PStream_LE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().\r
- *\r
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current\r
- * transaction should be updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_PStream_BE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().\r
- *\r
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_PStream_LE(const void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().\r
- *\r
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
- *\r
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt\r
- * to clear the status stage when using this routine in a control transaction.\r
- * \n\n\r
- *\r
- * \note This routine should only be used on CONTROL type endpoints.\r
- *\r
- * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained\r
- * together; i.e. the entire stream data must be read or written at the one time.\r
- *\r
- * \param[in] Buffer Pointer to the source data buffer to read from.\r
- * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer.\r
- *\r
- * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
- //@}\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2012.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2012 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
+ * \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
+
+/** @} */
projects / pub / USBasp.git / blobdiff