\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
#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 \c Endpoint_*_Stream_* functions. */\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
+ 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
};\r
\r
/* Function Prototypes: */\r
- /** Reads and discards the given number of bytes from the endpoint from the given buffer,\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. 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 \c 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
+ * 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 send via the currently selected endpoint.\r
- * \param[in] Callback Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.\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
- __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 \c 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
+ 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] 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, \c NULL if no callback.\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_Write_Stream_LE(const void* Buffer,\r
- uint16_t Length\r
- __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Endpoint_Null_Stream(uint16_t Length,\r
+ uint16_t* const BytesProcessed);\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, \c 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
\r
- /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().\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
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\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, \c NULL if no callback.\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* Buffer,\r
- uint16_t Length\r
- __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Endpoint_Write_Stream_LE(const void* 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. 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 \c 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
+ * \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] Callback Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.\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* 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, \c 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, \c 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
+ 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. 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 \c 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
+ * 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] Callback Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.\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* Buffer,\r
- uint16_t Length\r
- __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\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] Callback Name of a callback routine to call between successive USB packet transfers, \c 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 \c 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
+ * 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] Callback Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.\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* 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, \c 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
+ 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
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
+ /** 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
*\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
+ uint8_t Endpoint_Write_Control_Stream_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_LE().\r
- *\r
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\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
* \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
+ * \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_Write_Control_PStream_LE(const void* Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Endpoint_Read_Control_Stream_LE(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
+ /** 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
* \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
+ * \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_Write_Control_Stream_BE(const void* Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer,\r
+ uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ //@}\r
\r
- /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().\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* 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* 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* 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* 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
*\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
+ 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_BE().\r
- *\r
- * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\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
*\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
+ uint8_t Endpoint_Write_Control_EStream_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
+ /** 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
*\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
+ uint8_t Endpoint_Read_Control_EStream_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
+ /** 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
*\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
+ uint8_t Endpoint_Read_Control_EStream_BE(void* Buffer,\r
uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ //@}\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
+ /** \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* 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* 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
* \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
+ * \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_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
+ uint8_t Endpoint_Write_Control_PStream_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_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
* \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
+ * \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_Read_Control_EStream_BE(void* Buffer,\r
- uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t Endpoint_Write_Control_PStream_BE(const void* 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
projects / pub / USBasp.git / blobdiff