PipeStream_UC3.h 17.4 KB
 Dean Camera committed May 26, 2011 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 /* LUFA Library Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* Copyright 2011 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 Pipe data stream transmission and reception management for the AVR32 UC3 microcontrollers. * \copydetails Group_PipeStreamRW_UC3 * * \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_PipeStreamRW * \defgroup Group_PipeStreamRW_UC3 Read/Write of Multi-Byte Streams (UC3) * \brief Pipe data stream transmission and reception management for the Atmel AVR32 UC3 architecture. * * Functions, macros, variables, enums and types related to data reading and writing of data streams from * and to pipes. * * @{ */ #ifndef __PIPE_STREAM_UC3_H__ #define __PIPE_STREAM_UC3_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: */ /* Function Prototypes: */ /** \name Stream functions for null data */ //@{ /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host * as needed. The last packet is not automatically discarded once the remaining bytes has been read; the * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro. * * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once, failing or * succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer * will instead be performed as a series of chunks. Each time the pipe bank becomes empty while there is still data * to process (and after the current packet has been acknowledged) the BytesProcessed location will be updated with * the total number of bytes processed in the stream, and the function will exit with an error code of * \ref PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to * continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed * value reaches the total transfer length. * * Single Stream Transfer Example: * \code * uint8_t ErrorCode; * * if ((ErrorCode = Pipe_Discard_Stream(512, NULL)) != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * Partial Stream Transfers Example: * \code * uint8_t ErrorCode; * uint16_t BytesProcessed; * * BytesProcessed = 0; * while ((ErrorCode = Pipe_Discard_Stream(512, &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken(). * * \param[in] Length Number of bytes to discard via the currently selected pipe. * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should * updated, \c NULL if the entire stream should be processed at once. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum. */ uint8_t Pipe_Discard_Stream(uint16_t Length, uint16_t* const BytesProcessed); /** Writes a given number of zeroed bytes to the pipe, sending full pipe packets from the host to the device * as needed. The last packet is not automatically sent once the remaining bytes has been written; the * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearOUT() macro. * * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once, failing or * succeeding as a single unit. If the BytesProcessed parameter points to a valid storage location, the transfer * will instead be performed as a series of chunks. Each time the pipe bank becomes full while there is still data * to process (and after the current packet transmission has been initiated) the BytesProcessed location will be * updated with the total number of bytes processed in the stream, and the function will exit with an error code of * \ref PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed in the user code - to * continue the transfer, call the function again with identical parameters and it will resume until the BytesProcessed * value reaches the total transfer length. * * Single Stream Transfer Example: * \code * uint8_t ErrorCode; * * if ((ErrorCode = Pipe_Null_Stream(512, NULL)) != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * Partial Stream Transfers Example: * \code * uint8_t ErrorCode; * uint16_t BytesProcessed; * * BytesProcessed = 0; * while ((ErrorCode = Pipe_Null_Stream(512, &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken(). * * \param[in] Length Number of zero bytes to write via the currently selected pipe. * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should * updated, \c NULL if the entire stream should be processed at once. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum. */ uint8_t Pipe_Null_Stream(uint16_t Length, uint16_t* const BytesProcessed); //@} /** \name Stream functions for RAM source/destination data */ //@{ /** Writes the given number of bytes to the pipe from the given buffer in little endian, * sending full packets to the device as needed. The last packet filled is not automatically sent; * the user is responsible for manually sending the last written packet to the host via the * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. * * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once, * failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid * storage location, the transfer will instead be performed as a series of chunks. Each time * the pipe bank becomes full while there is still data to process (and after the current * packet transmission has been initiated) the BytesProcessed location will be updated with the * total number of bytes processed in the stream, and the function will exit with an error code of * \ref PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed * in the user code - to continue the transfer, call the function again with identical parameters * and it will resume until the BytesProcessed value reaches the total transfer length. * * Single Stream Transfer Example: * \code * uint8_t DataStream[512]; * uint8_t ErrorCode; * * if ((ErrorCode = Pipe_Write_Stream_LE(DataStream, sizeof(DataStream), * NULL)) != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * Partial Stream Transfers Example: * \code * uint8_t DataStream[512]; * uint8_t ErrorCode; * uint16_t BytesProcessed; * * BytesProcessed = 0; * while ((ErrorCode = Pipe_Write_Stream_LE(DataStream, sizeof(DataStream), * &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken(). * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should * updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum. */ uint8_t Pipe_Write_Stream_LE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** Writes the given number of bytes to the pipe from the given buffer in big endian, * sending full packets to the device as needed. The last packet filled is not automatically sent; * the user is responsible for manually sending the last written packet to the host via the * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. * * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken(). * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected pipe into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should * updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum. */ uint8_t Pipe_Write_Stream_BE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** Reads the given number of bytes from the pipe into the given buffer in little endian, * sending full packets to the device as needed. The last packet filled is not automatically sent; * the user is responsible for manually sending the last written packet to the host via the * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. * * If the BytesProcessed parameter is \c NULL, the entire stream transfer is attempted at once, * failing or succeeding as a single unit. If the BytesProcessed parameter points to a valid * storage location, the transfer will instead be performed as a series of chunks. Each time * the pipe bank becomes empty while there is still data to process (and after the current * packet has been acknowledged) the BytesProcessed location will be updated with the total number * of bytes processed in the stream, and the function will exit with an error code of * \ref PIPE_RWSTREAM_IncompleteTransfer. This allows for any abort checking to be performed * in the user code - to continue the transfer, call the function again with identical parameters * and it will resume until the BytesProcessed value reaches the total transfer length. * * Single Stream Transfer Example: * \code * uint8_t DataStream[512]; * uint8_t ErrorCode; * * if ((ErrorCode = Pipe_Read_Stream_LE(DataStream, sizeof(DataStream), * NULL)) != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * Partial Stream Transfers Example: * \code * uint8_t DataStream[512]; * uint8_t ErrorCode; * uint16_t BytesProcessed; * * BytesProcessed = 0; * while ((ErrorCode = Pipe_Read_Stream_LE(DataStream, sizeof(DataStream), * &BytesProcessed)) == PIPE_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != PIPE_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken(). * * \param[out] Buffer Pointer to the source data buffer to write to. * \param[in] Length Number of bytes to read for the currently selected pipe to read from. * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should * updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum. */ uint8_t Pipe_Read_Stream_LE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** Reads the given number of bytes from the pipe into the given buffer in big endian, * sending full packets to the device as needed. The last packet filled is not automatically sent; * the user is responsible for manually sending the last written packet to the host via the * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is * executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers. * * \note The pipe token is set automatically, thus this can be used on bi-directional pipes directly without * having to explicitly change the data direction with a call to \ref Pipe_SetPipeToken(). * * \param[out] Buffer Pointer to the source data buffer to write to. * \param[in] Length Number of bytes to read for the currently selected pipe to read from. * \param[in] BytesProcessed Pointer to a location where the total number of bytes already processed should * updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum. */ uint8_t Pipe_Read_Stream_BE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); //@} /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */