More fixes to the AVRISP command timeout system so that it should no longer lock...

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Pipe.h

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index 30e0fde..3e25d49 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -32,7 +32,7 @@
  *  @defgroup Group_PipeManagement Pipe Management\r
  *\r
  *  This module contains functions, macros and enums related to pipe management when in USB Host mode. This\r
  *  @defgroup Group_PipeManagement Pipe Management\r
  *\r
  *  This module contains functions, macros and enums related to pipe management when in USB Host mode. This\r

- *  module contains the pipe management macros, as well as pipe interrupt and data send/recieve functions\r
+ *  module contains the pipe management macros, as well as pipe interrupt and data send/receive functions\r

  *  for various data types.\r
  *\r
  *  @{\r
  *  for various data types.\r
  *\r
  *  @{\r


@@ -43,6 +43,20 @@
  *  Functions, macros, variables, enums and types related to data reading and writing from and to pipes.\r
  */\r
  \r
  *  Functions, macros, variables, enums and types related to data reading and writing from and to pipes.\r
  */\r
  \r

+/** \ingroup Group_PipeRW  \r
+ *  @defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types\r
+ *\r
+ *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types\r
+ *  from and to pipes.\r
+ */ \r
+\r
+/** \ingroup Group_PipeRW  \r
+ *  @defgroup Group_PipeStreamRW Read/Write of Multi-Byte Streams\r
+ *\r
+ *  Functions, macros, variables, enums and types related to data reading and writing of data streams from\r
+ *  and to pipes.\r
+ */ \r
+ \r

 /** @defgroup Group_PipePacketManagement Pipe Packet Management\r
  *\r
  *  Functions, macros, variables, enums and types related to packet management of pipes.\r
 /** @defgroup Group_PipePacketManagement Pipe Packet Management\r
  *\r
  *  Functions, macros, variables, enums and types related to packet management of pipes.\r


@@ -61,6 +75,8 @@
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r

+               #include <avr/pgmspace.h>\r
+               #include <avr/eeprom.h>\r

                #include <stdbool.h>\r
 \r
                #include "../../../Common/Common.h"\r
                #include <stdbool.h>\r
 \r
                #include "../../../Common/Common.h"\r


@@ -75,6 +91,11 @@
                        extern "C" {\r
                #endif\r
 \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.h instead.\r
+               #endif\r
+               \r

        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Mask for \ref Pipe_GetErrorFlags(), indicating that an overflow error occurred in the pipe on the received data. */\r


@@ -108,7 +129,7 @@
                         */\r
                        #define PIPE_TOKEN_IN                   (1 << PTOKEN0)\r
 \r
                         */\r
                        #define PIPE_TOKEN_IN                   (1 << PTOKEN0)\r
 \r

-                       /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+                       /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a OUT token (for non-CONTROL type pipes),\r

                         *  indicating that the pipe data will flow from host to device.\r
                         */\r
                        #define PIPE_TOKEN_OUT                  (2 << PTOKEN0)\r
                         *  indicating that the pipe data will flow from host to device.\r
                         */\r
                        #define PIPE_TOKEN_OUT                  (2 << PTOKEN0)\r


@@ -157,12 +178,12 @@
                        /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's\r
                         *  numerical address in the attached device.\r
                         */\r
                        /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's\r
                         *  numerical address in the attached device.\r
                         */\r

-                       #define PIPE_EPNUM_MASK                 0x07\r
+                       #define PIPE_EPNUM_MASK                 0x0F\r

 \r
 \r

-                       /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's\r
-                        *  bank size in the attached device.\r
+                       /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's\r
+                        *  direction for comparing with the ENDPOINT_DESCRIPTOR_DIR_* masks.\r

                         */\r
                         */\r

-                       #define PIPE_EPSIZE_MASK                0x7FF\r
+                       #define PIPE_EPDIR_MASK                 0x80\r

 \r
                /* Pseudo-Function Macros: */\r
                        #if defined(__DOXYGEN__)\r
 \r
                /* Pseudo-Function Macros: */\r
                        #if defined(__DOXYGEN__)\r


@@ -187,13 +208,13 @@
                                /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be\r
                                 *  indicated will operate on the currently selected pipe.\r
                                 *\r
                                /** Selects the given pipe number. Any pipe operations which do not require the pipe number to be\r
                                 *  indicated will operate on the currently selected pipe.\r
                                 *\r

-                                *  \param PipeNumber  Index of the pipe to select\r
+                                *  \param[in] PipeNumber  Index of the pipe to select\r

                                 */\r
                                static inline void Pipe_SelectPipe(uint8_t PipeNumber);\r
                                \r
                                /** Resets the desired pipe, including the pipe banks and flags.\r
                                 *\r
                                 */\r
                                static inline void Pipe_SelectPipe(uint8_t PipeNumber);\r
                                \r
                                /** Resets the desired pipe, including the pipe banks and flags.\r
                                 *\r

-                                *  \param PipeNumber  Index of the pipe to reset\r
+                                *  \param[in] PipeNumber  Index of the pipe to reset\r

                                 */\r
                                static inline void Pipe_ResetPipe(uint8_t PipeNumber);\r
                                \r
                                 */\r
                                static inline void Pipe_ResetPipe(uint8_t PipeNumber);\r
                                \r


@@ -226,7 +247,7 @@
                                 *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices\r
                                 *  which have two endpoints of opposite direction sharing the same endpoint address within the device.\r
                                 *\r
                                 *  control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices\r
                                 *  which have two endpoints of opposite direction sharing the same endpoint address within the device.\r
                                 *\r

-                                *  \param Token  New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask\r
+                                *  \param[in] Token  New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask\r

                                 */\r
                                static inline void Pipe_SetPipeToken(uint8_t Token);\r
                                \r
                                 */\r
                                static inline void Pipe_SetPipeToken(uint8_t Token);\r
                                \r


@@ -236,7 +257,7 @@
                                /** Configures the currently selected pipe to only allow the specified number of IN requests to be\r
                                 *  accepted by the pipe before it is automatically frozen.\r
                                 *\r
                                /** Configures the currently selected pipe to only allow the specified number of IN requests to be\r
                                 *  accepted by the pipe before it is automatically frozen.\r
                                 *\r

-                                *  \param TotalINRequests  Total number of IN requests that the pipe may receive before freezing\r
+                                *  \param[in] TotalINRequests  Total number of IN requests that the pipe may receive before freezing\r

                                 */\r
                                static inline void Pipe_SetFiniteINRequests(uint8_t TotalINRequests);\r
 \r
                                 */\r
                                static inline void Pipe_SetFiniteINRequests(uint8_t TotalINRequests);\r
 \r


@@ -246,9 +267,16 @@
                                 */\r
                                static inline bool Pipe_IsConfigured(void);\r
                                \r
                                 */\r
                                static inline bool Pipe_IsConfigured(void);\r
                                \r

+                               /** Retrieves the endpoint number of the endpoint within the attached device that the currently selected\r
+                                *  pipe is bound to.\r
+                                *\r
+                                *  \return Endpoint number the currently selected pipe is bound to\r
+                                */\r
+                               static inline uint8_t Pipe_BoundEndpointNumber(void);\r
+\r

                                /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.\r
                                 *\r
                                /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.\r
                                 *\r

-                                *  \param Milliseconds  Number of milliseconds between each pipe poll\r
+                                *  \param[in] Milliseconds  Number of milliseconds between each pipe poll\r

                                 */\r
                                static inline void Pipe_SetInterruptPeriod(uint8_t Milliseconds);\r
                                \r
                                 */\r
                                static inline void Pipe_SetInterruptPeriod(uint8_t Milliseconds);\r
                                \r


@@ -262,7 +290,7 @@
                                /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type\r
                                 *  pipes).\r
                                 *\r
                                /** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type\r
                                 *  pipes).\r
                                 *\r

-                                *  \param PipeNumber  Index of the pipe whose interrupt flag should be tested\r
+                                *  \param[in] PipeNumber  Index of the pipe whose interrupt flag should be tested\r

                                 *\r
                                 *  \return Boolean true if the specified pipe has interrupted, false otherwise\r
                                 */\r
                                 *\r
                                 *  \return Boolean true if the specified pipe has interrupted, false otherwise\r
                                 */\r


@@ -274,6 +302,12 @@
                                /** Freezes the selected pipe, preventing it from communicating with an attached device. */\r
                                static inline void Pipe_Freeze(void);\r
 \r
                                /** Freezes the selected pipe, preventing it from communicating with an attached device. */\r
                                static inline void Pipe_Freeze(void);\r
 \r

+                               /** Determines if the currently selected pipe is frozen, and not able to accept data.\r
+                                *\r
+                                *  \return Boolean true if the currently selected pipe is frozen, false otherwise\r
+                                */\r
+                               static inline bool Pipe_IsFrozen(void);\r
+                               \r

                                /** Clears the master pipe error flag. */\r
                                static inline void Pipe_ClearError(void);\r
                                \r
                                /** Clears the master pipe error flag. */\r
                                static inline void Pipe_ClearError(void);\r
                                \r


@@ -396,9 +430,9 @@
 \r
                                #define Pipe_GetCurrentPipe()          (UPNUM & PIPE_PIPENUM_MASK)\r
 \r
 \r
                                #define Pipe_GetCurrentPipe()          (UPNUM & PIPE_PIPENUM_MASK)\r
 \r

-                               #define Pipe_SelectPipe(pipenum)       MACROS{ UPNUM = pipenum; }MACROE\r
+                               #define Pipe_SelectPipe(pipenum)       MACROS{ UPNUM = (pipenum); }MACROE\r

                                \r
                                \r

-                               #define Pipe_ResetPipe(pipenum)        MACROS{ UPRST = (1 << pipenum); UPRST = 0; }MACROE\r
+                               #define Pipe_ResetPipe(pipenum)        MACROS{ UPRST = (1 << (pipenum)); UPRST = 0; }MACROE\r

 \r
                                #define Pipe_EnablePipe()              MACROS{ UPCONX |= (1 << PEN); }MACROE\r
 \r
 \r
                                #define Pipe_EnablePipe()              MACROS{ UPCONX |= (1 << PEN); }MACROE\r
 \r


@@ -408,23 +442,27 @@
 \r
                                #define Pipe_GetPipeToken()            (UPCFG0X & PIPE_TOKEN_MASK)\r
 \r
 \r
                                #define Pipe_GetPipeToken()            (UPCFG0X & PIPE_TOKEN_MASK)\r
 \r

-                               #define Pipe_SetToken(token)           MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | token); }MACROE\r
+                               #define Pipe_SetPipeToken(token)       MACROS{ UPCFG0X = ((UPCFG0X & ~PIPE_TOKEN_MASK) | (token)); }MACROE\r

                                \r
                                #define Pipe_SetInfiniteINRequests()   MACROS{ UPCONX |= (1 << INMODE); }MACROE\r
 \r
                                \r
                                #define Pipe_SetInfiniteINRequests()   MACROS{ UPCONX |= (1 << INMODE); }MACROE\r
 \r

-                               #define Pipe_SetFiniteINRequests(n)    MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = n; }MACROE\r
+                               #define Pipe_SetFiniteINRequests(n)    MACROS{ UPCONX &= ~(1 << INMODE); UPINRQX = (n); }MACROE\r

 \r
                                #define Pipe_IsConfigured()            ((UPSTAX  & (1 << CFGOK)) ? true : false)\r
 \r
 \r
                                #define Pipe_IsConfigured()            ((UPSTAX  & (1 << CFGOK)) ? true : false)\r
 \r

-                               #define Pipe_SetInterruptPeriod(ms)    MACROS{ UPCFG2X = ms; }MACROE\r
+                               #define Pipe_BoundEndpointNumber()     ((UPCFG0X >> PEPNUM0) & PIPE_EPNUM_MASK)\r
+                               \r
+                               #define Pipe_SetInterruptPeriod(ms)    MACROS{ UPCFG2X = (ms); }MACROE\r

 \r
                                #define Pipe_GetPipeInterrupts()       UPINT\r
 \r
 \r
                                #define Pipe_GetPipeInterrupts()       UPINT\r
 \r

-                               #define Pipe_HasPipeInterrupted(n)     ((UPINT & (1 << n)) ? true : false)\r
+                               #define Pipe_HasPipeInterrupted(n)     ((UPINT & (1 << (n))) ? true : false)\r

 \r
                                #define Pipe_Unfreeze()                MACROS{ UPCONX &= ~(1 << PFREEZE); }MACROE\r
 \r
                                #define Pipe_Freeze()                  MACROS{ UPCONX |= (1 << PFREEZE); }MACROE\r
 \r
                                #define Pipe_Unfreeze()                MACROS{ UPCONX &= ~(1 << PFREEZE); }MACROE\r
 \r
                                #define Pipe_Freeze()                  MACROS{ UPCONX |= (1 << PFREEZE); }MACROE\r

+                               \r
+                               #define Pipe_IsFrozen()                ((UPCONX & (1 << PFREEZE)) ? true : false)\r

 \r
                                #define Pipe_ClearError()              MACROS{ UPINTX &= ~(1 << PERRI); }MACROE\r
 \r
 \r
                                #define Pipe_ClearError()              MACROS{ UPINTX &= ~(1 << PERRI); }MACROE\r
 \r


@@ -502,7 +540,7 @@
                /* Inline Functions: */\r
                        /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.\r
                         *\r
                /* Inline Functions: */\r
                        /** Reads one byte from the currently selected pipe's bank, for OUT direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *  \return Next byte in the currently selected pipe's FIFO buffer\r
                         */\r
                         *\r
                         *  \return Next byte in the currently selected pipe's FIFO buffer\r
                         */\r


@@ -514,9 +552,9 @@
 \r
                        /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.\r
                         *\r
 \r
                        /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *\r

-                        *  \param Byte  Next byte to write into the the currently selected pipe's FIFO buffer\r
+                        *  \param[in] Byte  Next byte to write into the the currently selected pipe's FIFO buffer\r

                         */\r
                        static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_Byte(const uint8_t Byte)\r
                         */\r
                        static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_Byte(const uint8_t Byte)\r


@@ -526,7 +564,7 @@
 \r
                        /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.\r
                         *\r
 \r
                        /** Discards one byte from the currently selected pipe's bank, for OUT direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         */\r
                        static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Discard_Byte(void)\r
                         */\r
                        static inline void Pipe_Discard_Byte(void) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Discard_Byte(void)\r


@@ -539,45 +577,53 @@
                        /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT\r
                         *  direction pipes.\r
                         *\r
                        /** Reads two bytes from the currently selected pipe's bank in little endian format, for OUT\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *  \return Next word in the currently selected pipe's FIFO buffer\r
                         */\r
                        static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
                        static inline uint16_t Pipe_Read_Word_LE(void)\r
                        {\r
                         *\r
                         *  \return Next word in the currently selected pipe's FIFO buffer\r
                         */\r
                        static inline uint16_t Pipe_Read_Word_LE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
                        static inline uint16_t Pipe_Read_Word_LE(void)\r
                        {\r

-                               uint16_t Data;\r
+                               union\r
+                               {\r
+                                       uint16_t Word;\r
+                                       uint8_t  Bytes[2];\r
+                               } Data;\r

                                \r
                                \r

-                               Data  = UPDATX;\r
-                               Data |= (((uint16_t)UPDATX) << 8);\r
+                               Data.Bytes[0] = UPDATX;\r
+                               Data.Bytes[1] = UPDATX;\r

                        \r
                        \r

-                               return Data;\r
+                               return Data.Word;\r

                        }\r
 \r
                        /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT\r
                         *  direction pipes.\r
                         *\r
                        }\r
 \r
                        /** Reads two bytes from the currently selected pipe's bank in big endian format, for OUT\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *  \return Next word in the currently selected pipe's FIFO buffer\r
                         */\r
                        static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
                        static inline uint16_t Pipe_Read_Word_BE(void)\r
                        {\r
                         *\r
                         *  \return Next word in the currently selected pipe's FIFO buffer\r
                         */\r
                        static inline uint16_t Pipe_Read_Word_BE(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;\r
                        static inline uint16_t Pipe_Read_Word_BE(void)\r
                        {\r

-                               uint16_t Data;\r
+                               union\r
+                               {\r
+                                       uint16_t Word;\r
+                                       uint8_t  Bytes[2];\r
+                               } Data;\r

                                \r
                                \r

-                               Data  = (((uint16_t)UPDATX) << 8);\r
-                               Data |= UPDATX;\r
+                               Data.Bytes[1] = UPDATX;\r
+                               Data.Bytes[0] = UPDATX;\r

                        \r
                        \r

-                               return Data;\r
+                               return Data.Word;\r

                        }\r
                        \r
                        /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN\r
                         *  direction pipes.\r
                         *\r
                        }\r
                        \r
                        /** Writes two bytes to the currently selected pipe's bank in little endian format, for IN\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *\r

-                        *  \param Word  Next word to write to the currently selected pipe's FIFO buffer\r
+                        *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer\r

                         */\r
                        static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_Word_LE(const uint16_t Word)\r
                         */\r
                        static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_Word_LE(const uint16_t Word)\r


@@ -589,9 +635,9 @@
                        /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN\r
                         *  direction pipes.\r
                         *\r
                        /** Writes two bytes to the currently selected pipe's bank in big endian format, for IN\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *\r

-                        *  \param Word  Next word to write to the currently selected pipe's FIFO buffer\r
+                        *  \param[in] Word  Next word to write to the currently selected pipe's FIFO buffer\r

                         */\r
                        static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_Word_BE(const uint16_t Word)\r
                         */\r
                        static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_Word_BE(const uint16_t Word)\r


@@ -602,7 +648,7 @@
 \r
                        /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.\r
                         *\r
 \r
                        /** Discards two bytes from the currently selected pipe's bank, for OUT direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         */\r
                        static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Discard_Word(void)\r
                         */\r
                        static inline void Pipe_Discard_Word(void) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Discard_Word(void)\r


@@ -616,7 +662,7 @@
                        /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT\r
                         *  direction pipes.\r
                         *\r
                        /** Reads four bytes from the currently selected pipe's bank in little endian format, for OUT\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *  \return Next double word in the currently selected pipe's FIFO buffer\r
                         */\r
                         *\r
                         *  \return Next double word in the currently selected pipe's FIFO buffer\r
                         */\r


@@ -640,7 +686,7 @@
                        /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT\r
                         *  direction pipes.\r
                         *\r
                        /** Reads four bytes from the currently selected pipe's bank in big endian format, for OUT\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *  \return Next double word in the currently selected pipe's FIFO buffer\r
                         */\r
                         *\r
                         *  \return Next double word in the currently selected pipe's FIFO buffer\r
                         */\r


@@ -664,34 +710,38 @@
                        /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN\r
                         *  direction pipes.\r
                         *\r
                        /** Writes four bytes to the currently selected pipe's bank in little endian format, for IN\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *\r

-                        *  \param DWord  Next double word to write to the currently selected pipe's FIFO buffer\r
+                        *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer\r

                         */\r
                        static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_DWord_LE(const uint32_t DWord)\r
                        {\r
                         */\r
                        static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_DWord_LE(const uint32_t DWord)\r
                        {\r

-                               Pipe_Write_Word_LE(DWord);\r
-                               Pipe_Write_Word_LE(DWord >> 16);\r
+                               UPDATX = (DWord &  0xFF);\r
+                               UPDATX = (DWord >> 8);\r
+                               UPDATX = (DWord >> 16);\r
+                               UPDATX = (DWord >> 24);\r

                        }\r
                        \r
                        /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN\r
                         *  direction pipes.\r
                         *\r
                        }\r
                        \r
                        /** Writes four bytes to the currently selected pipe's bank in big endian format, for IN\r
                         *  direction pipes.\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         *\r
                         *\r

-                        *  \param DWord  Next double word to write to the currently selected pipe's FIFO buffer\r
+                        *  \param[in] DWord  Next double word to write to the currently selected pipe's FIFO buffer\r

                         */\r
                        static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_DWord_BE(const uint32_t DWord)\r
                        {\r
                         */\r
                        static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Write_DWord_BE(const uint32_t DWord)\r
                        {\r

-                               Pipe_Write_Word_BE(DWord >> 16);\r
-                               Pipe_Write_Word_BE(DWord);\r
+                               UPDATX = (DWord >> 24);\r
+                               UPDATX = (DWord >> 16);\r
+                               UPDATX = (DWord >> 8);\r
+                               UPDATX = (DWord &  0xFF);\r

                        }                       \r
                        \r
                        /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.       \r
                         *\r
                        }                       \r
                        \r
                        /** Discards four bytes from the currently selected pipe's bank, for OUT direction pipes.       \r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipePrimitiveRW\r

                         */\r
                        static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Discard_DWord(void)\r
                         */\r
                        static inline void Pipe_Discard_DWord(void) ATTR_ALWAYS_INLINE;\r
                        static inline void Pipe_Discard_DWord(void)\r


@@ -716,6 +766,12 @@
                        extern uint8_t USB_ControlPipeSize;\r
 \r
                /* Function Prototypes: */\r
                        extern uint8_t USB_ControlPipeSize;\r
 \r
                /* Function Prototypes: */\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

                        /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the\r
                         *  attached device, bank size and banking mode. Pipes should be allocated in ascending order by their\r
                         *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation\r
                        /** Configures the specified pipe number with the given pipe type, token, target endpoint number in the\r
                         *  attached device, bank size and banking mode. Pipes should be allocated in ascending order by their\r
                         *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation\r


@@ -747,15 +803,47 @@
                        bool Pipe_ConfigurePipe(const uint8_t  Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,\r
                                                const uint16_t Size, const uint8_t Banks);\r
 \r
                        bool Pipe_ConfigurePipe(const uint8_t  Number, const uint8_t Type, const uint8_t Token, const uint8_t EndpointNumber,\r
                                                const uint16_t Size, const uint8_t Banks);\r
 \r

-                       /** Spinloops until the currently selected non-control pipe is ready for the next packed of data\r
-                        *  to be read or written to it.\r
+                       /** Spin-loops until the currently selected non-control pipe is ready for the next packed of data to be read \r
+                        *  or written to it, aborting in the case of an error condition (such as a timeout or device disconnect).\r

                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *  \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.\r
                         */\r
                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *  \return A value from the Pipe_WaitUntilReady_ErrorCodes_t enum.\r
                         */\r

-                       uint8_t Pipe_WaitUntilReady(void);              \r
+                       uint8_t Pipe_WaitUntilReady(void);\r
+                       \r
+                       /** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given\r
+                        *  endpoint is found, it is automatically selected.\r
+                        *\r
+                        *  \param[in] EndpointAddress Address and direction mask of the endpoint within the attached device to check\r
+                        *\r
+                        *  \return Boolean true if a pipe bound to the given endpoint address of the specified direction is found, false\r
+                        *          otherwise\r
+                        */\r
+                       bool Pipe_IsEndpointBound(const uint8_t EndpointAddress);\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
+                        *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,\r
+                        *  allowing for early aborts of stream transfers.\r
+                        *\r
+                        *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
+                        *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
+                        *  disabled and this function has the Callback parameter omitted.\r
+                        *\r
+                        *  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
+                        *  \ingroup Group_PipeStreamRW\r
+                        *\r
+                        *  \param[in] Length  Number of bytes to send via the currently selected pipe.\r
+                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        */\r
+                       uint8_t Pipe_Discard_Stream(uint16_t Length __CALLBACK_PARAM);\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
                        /** 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


@@ -769,20 +857,42 @@
                         *  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
                         *  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

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipeStreamRW\r

                         *\r
                         *\r

-                        *  \param Buffer    Pointer to the source data buffer to read from.\r
-                        *  \param Length    Number of bytes to read for the currently selected pipe into the buffer.\r
-                        *  \param Callback  Name of a callback routine to call between successive USB packet transfers, 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 pipe into the buffer.\r
+                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r

                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r

-                       uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length\r
-                       #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
-                                                    , StreamCallbackPtr_t Callback\r
-                       #endif\r
-                                                    ) ATTR_NON_NULL_PTR_ARG(1);                                \r
+                       uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);                            \r

 \r
 \r

+                       /** EEPROM buffer source version of \ref Pipe_Write_Stream_LE().\r
+                        *\r
+                        *  \ingroup Group_PipeStreamRW\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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        */\r
+                       uint8_t Pipe_Write_EStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** FLASH buffer source version of \ref Pipe_Write_Stream_LE().\r
+                        *\r
+                        *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
+                        *\r
+                        *  \ingroup Group_PipeStreamRW\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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        */\r
+                       uint8_t Pipe_Write_PStream_LE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) 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
                        /** 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


@@ -796,45 +906,41 @@
                         *  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
                         *  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

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipeStreamRW\r

                         *\r
                         *\r

-                        *  \param Buffer    Pointer to the source data buffer to read from.\r
-                        *  \param Length    Number of bytes to read for the currently selected pipe into the buffer.\r
-                        *  \param Callback  Name of a callback routine to call between successive USB packet transfers, 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 pipe into the buffer.\r
+                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r

                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r

-                       uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length\r
-                       #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
-                                                    , StreamCallbackPtr_t Callback\r
-                       #endif\r
-                                                    ) ATTR_NON_NULL_PTR_ARG(1);\r
+                       uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\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
-                        *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,\r
-                        *  allowing for early aborts of stream transfers.\r
+                       /** EEPROM buffer source version of \ref Pipe_Write_Stream_BE().\r

                         *\r
                         *\r

-                        *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
-                        *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are\r
-                        *  disabled and this function has the Callback parameter omitted.\r
+                        *  \ingroup Group_PipeStreamRW\r

                         *\r
                         *\r

-                        *  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
+                        *  \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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r

                         *\r
                         *\r

-                        *  \ingroup Group_PipeRW\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        */\r
+                       uint8_t Pipe_Write_EStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** FLASH buffer source version of \ref Pipe_Write_Stream_BE().\r
+                        *\r
+                        *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.\r
+                        *\r
+                        *  \ingroup Group_PipeStreamRW\r

                         *\r
                         *\r

-                        *  \param Length  Number of bytes to send via the currently selected pipe.\r
-                        *  \param Callback  Name of a callback routine to call between successive USB packet transfers, 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 pipe into the buffer.\r
+                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r

                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\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
-                       #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
-                                                   , StreamCallbackPtr_t Callback\r
-                       #endif\r
-                                                   );\r
+                       uint8_t Pipe_Write_PStream_BE(const void* Buffer, uint16_t Length __CALLBACK_PARAM) 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
 \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


@@ -849,19 +955,27 @@
                         *  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
                         *  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

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipeStreamRW\r

                         *\r
                         *\r

-                        *  \param Buffer    Pointer to the source data buffer to write to.\r
-                        *  \param Length    Number of bytes to read for the currently selected pipe to read from.\r
-                        *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r

                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r

-                       uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length\r
-                       #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
-                                                   , StreamCallbackPtr_t Callback\r
-                       #endif\r
-                                                   ) ATTR_NON_NULL_PTR_ARG(1);\r
+                       uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** EEPROM buffer source version of \ref Pipe_Read_Stream_LE().\r
+                        *\r
+                        *  \ingroup Group_PipeStreamRW\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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        */\r
+                       uint8_t Pipe_Read_EStream_LE(void* Buffer, uint16_t Length __CALLBACK_PARAM) 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
 \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


@@ -876,20 +990,28 @@
                         *  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
                         *  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

-                        *  \ingroup Group_PipeRW\r
+                        *  \ingroup Group_PipeStreamRW\r

                         *\r
                         *\r

-                        *  \param Buffer    Pointer to the source data buffer to write to.\r
-                        *  \param Length    Number of bytes to read for the currently selected pipe to read from.\r
-                        *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r

                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r

-                       uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length\r
-                       #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
-                                                   , StreamCallbackPtr_t Callback\r
-                       #endif\r
-                                                   ) ATTR_NON_NULL_PTR_ARG(1);\r
+                       uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        \r

+                       /** EEPROM buffer source version of \ref Pipe_Read_Stream_BE().\r
+                        *\r
+                        *  \ingroup Group_PipeStreamRW\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] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        */\r
+                       uint8_t Pipe_Read_EStream_BE(void* Buffer, uint16_t Length __CALLBACK_PARAM) ATTR_NON_NULL_PTR_ARG(1);\r
+\r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r


@@ -921,7 +1043,7 @@
                                  return (4 << EPSIZE0);\r
                                else\r
                                  return (5 << EPSIZE0);\r
                                  return (4 << EPSIZE0);\r
                                else\r
                                  return (5 << EPSIZE0);\r

-                       };\r
+                       }\r

 \r
        #endif\r
 \r
 \r
        #endif\r
 \r