Split Getting Started page of the documentation into its own section.

[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 62cbe65..30e0fde 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -219,7 +219,7 @@
                                 *\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
@@ -730,7 +730,11 @@
                         *\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
@@ -762,6 +766,9 @@
                         *  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
                         *  \param Buffer    Pointer to the source data buffer to read from.\r
@@ -786,6 +793,9 @@
                         *  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
                         *  \param Buffer    Pointer to the source data buffer to read from.\r
@@ -810,6 +820,9 @@
                         *  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
                         *  \param Length  Number of bytes to send via the currently selected pipe.\r
@@ -833,6 +846,9 @@
                         *  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
                         *  \param Buffer    Pointer to the source data buffer to write to.\r
@@ -857,6 +873,9 @@
                         *  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
                         *  \param Buffer    Pointer to the source data buffer to write to.\r