+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2010.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2010 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 USB device endpoint stream function definitions.\r
+ *\r
+ * This file contains structures, function prototypes and macros related to the sending and receiving of\r
+ * arbitrary data streams through the device's data endpoints when the library is initialized in USB device mode.\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
+ *\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 <avr/io.h>\r
+ #include <avr/pgmspace.h>\r
+ #include <avr/eeprom.h>\r
+ #include <stdbool.h>\r
+\r
+ #include "../../../Common/Common.h"\r
+ #include "USBTask.h"\r
+\r
+ #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
+ #include "StreamCallbacks.h"\r
+ #endif\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
+ #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
+ #define __CALLBACK_PARAM , StreamCallbackPtr_t Callback\r
+ #else\r
+ #define __CALLBACK_PARAM\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Enums: */\r
+ /** Enum for the possible error return codes of the 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_CallbackAborted = 5, /**< Indicates that the stream's callback function\r
+ * aborted the transfer early.\r
+ */\r
+ };\r
+ \r
+ /** Enum for the possible error return codes of the 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
+ /** Reads and discards the given number of bytes from the endpoint from the given buffer,\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. Between\r
+ * each USB packet, the given stream callback function is executed repeatedly until the next\r
+ * packet is ready, allowing for early aborts of stream transfers.\r
+ *\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\r
+ *\r
+ * \note This routine should not be used on CONTROL type endpoints.\r
+ *\r
+ * \param[in] Length Number of bytes to send via the currently selected endpoint.\r
+ * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\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
+ __CALLBACK_PARAM);\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. Between each USB packet, the given stream callback function\r
+ * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early\r
+ * aborts of stream transfers.\r
+ *\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Write_Stream_LE(const void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Write_EStream_LE(const void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Write_PStream_LE(const void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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. Between each USB packet, the given stream callback function\r
+ * is executed repeatedly until the endpoint is ready to accept the next packet, allowing for early\r
+ * aborts of stream transfers.\r
+ *\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Write_Stream_BE(const void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Write_EStream_BE(const void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Write_PStream_BE(const void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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. Between\r
+ * each USB packet, the given stream callback function is executed repeatedly until the endpoint\r
+ * is ready to accept the next packet, allowing for early aborts of stream transfers.\r
+ *\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Read_Stream_LE(void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Read_EStream_LE(void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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. Between\r
+ * each USB packet, the given stream callback function is executed repeatedly until the endpoint\r
+ * is ready to accept the next packet, allowing for early aborts of stream transfers.\r
+ *\r
+ * The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+ * If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+ * disabled and this function has the Callback parameter omitted.\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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Read_Stream_BE(void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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] Callback Name of a callback routine to call between successive USB packet transfers, NULL if no callback.\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
+ */\r
+ uint8_t Endpoint_Read_EStream_BE(void* Buffer,\r
+ uint16_t Length\r
+ __CALLBACK_PARAM) 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* Buffer,\r
+ uint16_t Length) 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* Buffer,\r
+ uint16_t Length) 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* 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* 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* 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* 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* 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* 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* 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* Buffer,\r
+ uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+ \r
+#endif\r
+\r
+/** @} */\r
projects / pub / lufa.git / blobdiff