Added incomplete PrinterHost demo application.

[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 befc996..cf61eea 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -77,6 +77,12 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\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
+                       #define PIPE_ERRORFLAG_OVERFLOW         (1 << 6)\r
+\r
+                       /** Mask for \ref Pipe_GetErrorFlags(), indicating that an underflow error occurred in the pipe on the received data. */\r
+                       #define PIPE_ERRORFLAG_UNDERFLOW        (1 << 5)\r
+\r

                        /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r
                        #define PIPE_ERRORFLAG_CRC16            (1 << 4)\r
 \r
                        /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r
                        #define PIPE_ERRORFLAG_CRC16            (1 << 4)\r
 \r


@@ -181,13 +187,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


@@ -213,14 +219,14 @@
                                 *\r
                                 *  \return The current pipe token, as a PIPE_TOKEN_* mask\r
                                 */\r
                                 *\r
                                 *  \return The current pipe token, as a PIPE_TOKEN_* mask\r
                                 */\r

-                               static inline uint8_t Pipe_GetCurrentToken(void);\r
+                               static inline uint8_t Pipe_GetPipeToken(void);\r

                                \r
                                /** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*\r
                                 *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during\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
                                \r
                                /** Sets the token for the currently selected pipe to one of the tokens specified by the PIPE_TOKEN_*\r
                                 *  masks. This can be used on CONTROL type pipes, to allow for bidirectional transfer of data during\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


@@ -230,7 +236,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


@@ -242,7 +248,7 @@
                                \r
                                /** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.\r
                                 *\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


@@ -256,7 +262,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


@@ -426,7 +432,10 @@
                                \r
                                #define Pipe_ClearErrorFlags()         MACROS{ UPERRX = 0; }MACROE\r
 \r
                                \r
                                #define Pipe_ClearErrorFlags()         MACROS{ UPERRX = 0; }MACROE\r
 \r

-                               #define Pipe_GetErrorFlags()           UPERRX\r
+                               #define Pipe_GetErrorFlags()           ((UPERRX & (PIPE_ERRORFLAG_CRC16 | PIPE_ERRORFLAG_TIMEOUT | \\r
+                                                                                  PIPE_ERRORFLAG_PID   | PIPE_ERRORFLAG_DATAPID | \\r
+                                                                                  PIPE_ERRORFLAG_DATATGL))                      | \\r
+                                                                       (UPSTAX & PIPE_ERRORFLAG_OVERFLOW | PIPE_ERRORFLAG_UNDERFLOW))\r

 \r
                                #define Pipe_IsReadWriteAllowed()      ((UPINTX & (1 << RWAL)) ? true : false)\r
 \r
 \r
                                #define Pipe_IsReadWriteAllowed()      ((UPINTX & (1 << RWAL)) ? true : false)\r
 \r


@@ -507,7 +516,7 @@
                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *\r
                         *  \ingroup Group_PipeRW\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


@@ -568,7 +577,7 @@
                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *\r
                         *  \ingroup Group_PipeRW\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


@@ -582,7 +591,7 @@
                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *\r
                         *  \ingroup Group_PipeRW\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


@@ -657,7 +666,7 @@
                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *\r
                         *  \ingroup Group_PipeRW\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
                        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


@@ -671,7 +680,7 @@
                         *\r
                         *  \ingroup Group_PipeRW\r
                         *\r
                         *\r
                         *  \ingroup Group_PipeRW\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
                        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


@@ -709,7 +718,8 @@
                /* Function Prototypes: */\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
                /* Function Prototypes: */\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).\r
+                        *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation\r
+                        *  of the USB FIFO memory.\r

                         *\r
                         *  The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the\r
                         *  PIPE_TOKEN_* masks.\r
                         *\r
                         *  The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the\r
                         *  PIPE_TOKEN_* masks.\r


@@ -720,7 +730,14 @@
                         *\r
                         *  The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.\r
                         *\r
                         *\r
                         *  The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.\r
                         *\r

-                        *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() macro.\r
+                        *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze()\r
+                        *  before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or\r
+                        *  sending data to the device in OUT mode. IN type pipes are also automatically configured to accept infinite\r
+                        *  numbers of IN requests without automatic freezing - this can be overridden by a call to\r
+                        *  \ref Pipe_SetFiniteINRequests().\r
+                        *\r
+                        *  \note The default control pipe does not have to be manually configured, as it is automatically\r
+                        *  configured by the library internally.\r

                         *\r
                         *  \note This routine will select the specified pipe, and the pipe will remain selected once the\r
                         *        routine completes regardless of if the pipe configuration succeeds.\r
                         *\r
                         *  \note This routine will select the specified pipe, and the pipe will remain selected once the\r
                         *        routine completes regardless of if the pipe configuration succeeds.\r


@@ -749,11 +766,14 @@
                         *  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
                         *  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_PipeRW\r
                         *\r
                         *  \ingroup Group_PipeRW\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


@@ -773,11 +793,14 @@
                         *  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
                         *  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_PipeRW\r
                         *\r
                         *  \ingroup Group_PipeRW\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


@@ -797,10 +820,13 @@
                         *  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
                         *  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_PipeRW\r
                         *\r
                         *  \ingroup Group_PipeRW\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] 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
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
                         */\r


@@ -820,11 +846,14 @@
                         *  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
                         *  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_PipeRW\r
                         *\r
                         *  \ingroup Group_PipeRW\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


@@ -844,11 +873,14 @@
                         *  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
                         *  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_PipeRW\r
                         *\r
                         *  \ingroup Group_PipeRW\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