+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 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 Pipe data stream transmission and reception management for the AVR8 microcontrollers\r
- * \copydetails Group_PipeStreamRW_AVR8\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_PipeStreamRW\r
- * \defgroup Group_PipeStreamRW_AVR8 Read/Write of Multi-Byte Streams (AVR8)\r
- * \brief Pipe data stream transmission and reception management for the Atmel AVR8 architecture.\r
- *\r
- * Functions, macros, variables, enums and types related to data reading and writing of data streams from\r
- * and to pipes.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __PIPE_STREAM_AVR8_H__\r
-#define __PIPE_STREAM_AVR8_H__\r
-\r
- /* Includes: */\r
- #include "../../../../Common/Common.h"\r
- #include "../USBMode.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
- /* Function Prototypes: */\r
- /** \name Stream functions for null data */\r
- //@{\r
-\r
- /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host\r
- * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the\r
- * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.\r
- *\r
- * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once, failing or\r
- * succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer\r
- * will instead be performed as a series of chunks. Each time the pipe bank becomes empty while there is still data\r
- * to process (and after the current packet has been acknowledged) the BytesProcessed location will be updated with\r
- * the total number of bytes processed in the stream, and the function will exit with an error code of\r
- * \ref PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to\r
- * continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed\r
- * value reaches the total transfer length.\r
- *\r
- * <b>Single Stream Transfer Example:</b>\r
- * \code\r
- * uint8_t ErrorCode;\r
- * \r
- * if ((ErrorCode = Pipe_Discard_Stream(512, NULL)) != PIPE_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 = Pipe_Discard_Stream(512, &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- * \r
- * if (ErrorCode != PIPE_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
- * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
- *\r
- * \param[in] Length Number of bytes to discard via the currently selected pipe.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be processed at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_Discard_Stream(uint16_t Length,\r
- uint16_t* const BytesProcessed);\r
-\r
- /** Writes a given number of zeroed bytes to the pipe, sending full pipe packets from the host to the device\r
- * as needed. The last packet is not automatically sent once the remaining bytes has been written; the\r
- * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearOUT() macro.\r
- *\r
- * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once, failing or\r
- * succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer\r
- * will instead be performed as a series of chunks. Each time the pipe bank becomes full while there is still data\r
- * to process (and after the current packet transmission has been initiated) the BytesProcessed location will be\r
- * updated with the total number of bytes processed in the stream, and the function will exit with an error code of\r
- * \ref PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to\r
- * continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed\r
- * value reaches the total transfer length.\r
- *\r
- * <b>Single Stream Transfer Example:</b>\r
- * \code\r
- * uint8_t ErrorCode;\r
- * \r
- * if ((ErrorCode = Pipe_Null_Stream(512, NULL)) != PIPE_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 = Pipe_Null_Stream(512, &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- * \r
- * if (ErrorCode != PIPE_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
- * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
- *\r
- * \param[in] Length Number of zero bytes to write via the currently selected pipe.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be processed at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 pipe from the given buffer in little endian,\r
- * sending full packets to the device 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 Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
- * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\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 pipe 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 PIPE_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 = Pipe_Write_Stream_LE(DataStream, sizeof(DataStream),\r
- * NULL)) != PIPE_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 = Pipe_Write_Stream_LE(DataStream, sizeof(DataStream),\r
- * &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- * \r
- * if (ErrorCode != PIPE_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
- * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\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 pipe into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 pipe from the given buffer in big endian,\r
- * sending full packets to the device 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 Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
- * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
- *\r
- * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
- * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\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 pipe into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 pipe into the given buffer in little endian,\r
- * sending full packets to the device 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 Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
- * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\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 pipe 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 PIPE_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 = Pipe_Read_Stream_LE(DataStream, sizeof(DataStream),\r
- * NULL)) != PIPE_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 = Pipe_Read_Stream_LE(DataStream, sizeof(DataStream),\r
- * &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer)\r
- * {\r
- * // Stream not yet complete - do other actions here, abort if required\r
- * }\r
- * \r
- * if (ErrorCode != PIPE_RWSTREAM_NoError)\r
- * {\r
- * // Stream failed to complete - check ErrorCode here\r
- * }\r
- * \endcode\r
- *\r
- * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
- * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
- *\r
- * \param[out] Buffer Pointer to the source data buffer to write to.\r
- * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 pipe into the given buffer in big endian,\r
- * sending full packets to the device 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 Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
- * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
- *\r
- * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without\r
- * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken().\r
- *\r
- * \param[out] Buffer Pointer to the source data buffer to write to.\r
- * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_Read_Stream_BE(void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) 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 Pipe_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 pipe into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 Pipe_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 pipe into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 Pipe_Read_Stream_LE().\r
- *\r
- * \param[out] Buffer Pointer to the source data buffer to write to.\r
- * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 Pipe_Read_Stream_BE().\r
- *\r
- * \param[out] Buffer Pointer to the source data buffer to write to.\r
- * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be read at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_Read_EStream_BE(void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) 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 Pipe_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 pipe into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_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 Pipe_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 pipe into the buffer.\r
- * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should\r
- * updated, \c NULL if the entire stream should be written at once.\r
- *\r
- * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
- */\r
- uint8_t Pipe_Write_PStream_BE(const void* const Buffer,\r
- uint16_t Length,\r
- uint16_t* const BytesProcessed) 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
-\r
projects / qmk_firmware.git / blobdiff