EndpointStream_AVR8.h 33.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 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 /* 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 Endpoint data stream transmission and reception management for the AVR8 microcontrollers. * \copydetails Group_EndpointStreamRW_AVR8 * * \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_EndpointStreamRW * \defgroup Group_EndpointStreamRW_AVR8 Read/Write of Multi-Byte Streams (AVR8) * \brief Endpoint data stream transmission and reception management for the Atmel AVR8 architecture. * * Functions, macros, variables, enums and types related to data reading and writing of data streams from * and to endpoints. * * @{ */ #ifndef __ENDPOINT_STREAM_AVR8_H__ #define __ENDPOINT_STREAM_AVR8_H__ /* Includes: */ #include "../../../../Common/Common.h" #include "../USBMode.h" #include "../USBTask.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 currently selected endpoint's bank, * 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 host via the \ref Endpoint_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 endpoint 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 ENDPOINT_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 = Endpoint_Discard_Stream(512, NULL)) != ENDPOINT_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 = Endpoint_Discard_Stream(512, &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != ENDPOINT_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note This routine should not be used on CONTROL type endpoints. * * \param[in] Length Number of bytes to discard via the currently selected endpoint. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Discard_Stream(uint16_t Length, uint16_t* const BytesProcessed); /** Writes a given number of zeroed bytes to the currently selected endpoint's bank, sending * full packets to the host as needed. The last packet is not automatically sent once the * remaining bytes have been written; the user is responsible for manually sending the last * packet to the host via the \ref Endpoint_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 endpoint 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 ENDPOINT_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 = Endpoint_Null_Stream(512, NULL)) != ENDPOINT_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 = Endpoint_Null_Stream(512, &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != ENDPOINT_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note This routine should not be used on CONTROL type endpoints. * * \param[in] Length Number of zero bytes to send via the currently selected endpoint. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_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 endpoint from the given buffer in little endian, * sending full packets to the host 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 Endpoint_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 endpoint 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 ENDPOINT_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 = Endpoint_Write_Stream_LE(DataStream, sizeof(DataStream), * NULL)) != ENDPOINT_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 = Endpoint_Write_Stream_LE(DataStream, sizeof(DataStream), * &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != ENDPOINT_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note This routine should not be used on CONTROL type endpoints. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_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 endpoint from the given buffer in big endian, * sending full packets to the host 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 Endpoint_ClearIN() macro. * * \note This routine should not be used on CONTROL type endpoints. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_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 endpoint from the given buffer in little endian, * 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 host via the \ref Endpoint_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 endpoint 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 ENDPOINT_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 = Endpoint_Read_Stream_LE(DataStream, sizeof(DataStream), * NULL)) != ENDPOINT_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 = Endpoint_Read_Stream_LE(DataStream, sizeof(DataStream), * &BytesProcessed)) == ENDPOINT_RWSTREAM_IncompleteTransfer) * { * // Stream not yet complete - do other actions here, abort if required * } * * if (ErrorCode != ENDPOINT_RWSTREAM_NoError) * { * // Stream failed to complete - check ErrorCode here * } * \endcode * * \note This routine should not be used on CONTROL type endpoints. * * \param[out] Buffer Pointer to the destination data buffer to write to. * \param[in] Length Number of bytes to send via the currently selected endpoint. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_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 endpoint from the given buffer in big endian, * 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 host via the \ref Endpoint_ClearOUT() macro. * * \note This routine should not be used on CONTROL type endpoints. * * \param[out] Buffer Pointer to the destination data buffer to write to. * \param[in] Length Number of bytes to send via the currently selected endpoint. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_Stream_BE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian, * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared * in both failure and success states; the user is responsible for manually clearing the setup OUT to * finalize the transfer via the \ref Endpoint_ClearOUT() macro. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_Control_Stream_LE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian, * sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared * in both failure and success states; the user is responsible for manually clearing the setup OUT to * finalize the transfer via the \ref Endpoint_ClearOUT() macro. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_Control_Stream_BE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian, * discarding fully read packets from the host as needed. The device IN acknowledgement is not * automatically sent after success or failure states; the user is responsible for manually sending the * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[out] Buffer Pointer to the destination data buffer to write to. * \param[in] Length Number of bytes to send via the currently selected endpoint. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_Control_Stream_LE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian, * discarding fully read packets from the host as needed. The device IN acknowledgement is not * automatically sent after success or failure states; the user is responsible for manually sending the * setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[out] Buffer Pointer to the destination data buffer to write to. * \param[in] Length Number of bytes to send via the currently selected endpoint. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_Control_Stream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); //@} /** \name Stream functions for EEPROM source/destination data */ //@{ /** EEPROM buffer source version of \ref Endpoint_Write_Stream_LE(). * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_EStream_LE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** EEPROM buffer source version of \ref Endpoint_Write_Stream_BE(). * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_EStream_BE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Jun 05, 2011 455  /** EEPROM buffer destination version of \ref Endpoint_Read_Stream_LE().  Dean Camera committed May 26, 2011 456 457 458 459 460 461 462 463 464 465 466 467  * * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space. * \param[in] Length Number of bytes to send via the currently selected endpoint. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_EStream_LE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Jun 05, 2011 468  /** EEPROM buffer destination version of \ref Endpoint_Read_Stream_BE().  Dean Camera committed May 26, 2011 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648  * * \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space. * \param[in] Length Number of bytes to send via the currently selected endpoint. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be read at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_EStream_BE(void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * \n\n * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_Control_EStream_LE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE(). * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * \n\n * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_Control_EStream_BE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE(). * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * \n\n * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[out] Buffer Pointer to the destination data buffer to write to. * \param[in] Length Number of bytes to send via the currently selected endpoint. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_Control_EStream_LE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE(). * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * \n\n * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[out] Buffer Pointer to the destination data buffer to write to. * \param[in] Length Number of bytes to send via the currently selected endpoint. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); //@} /** \name Stream functions for PROGMEM source/destination data */ //@{ /** FLASH buffer source version of \ref Endpoint_Write_Stream_LE(). * * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_PStream_LE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** FLASH buffer source version of \ref Endpoint_Write_Stream_BE(). * * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * \param[in] BytesProcessed Pointer to a location where the total number of bytes processed in the current * transaction should be updated, \c NULL if the entire stream should be written at once. * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_PStream_BE(const void* const Buffer, uint16_t Length, uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE(). * * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * \n\n * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_Control_PStream_LE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE(). * * \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly. * * \note This function automatically clears the control transfer's status stage. Do not manually attempt * to clear the status stage when using this routine in a control transaction. * \n\n * * \note This routine should only be used on CONTROL type endpoints. * \n\n * * \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained * together; i.e. the entire stream data must be read or written at the one time. * * \param[in] Buffer Pointer to the source data buffer to read from. * \param[in] Length Number of bytes to read for the currently selected endpoint into the buffer. * * \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum. */ uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1); //@} /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */