X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/32f0f605efa293430a47d60bb857695ff6937d21..6be24e44046ffc386e2f4072aa5cccb1c462f47f:/LUFA/Drivers/USB/LowLevel/Pipe.h

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index 796b4c5a2..f3da9d1ce 100644
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -709,7 +709,8 @@
 		/* Function Prototypes: */
 			/** Configures the specified pipe number with the given pipe type, token, target endpoint number in the
 			 *  attached device, bank size and banking mode. Pipes should be allocated in ascending order by their
-			 *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on).
+			 *  address in the device (i.e. pipe 1 should be configured before pipe 2 and so on) to prevent fragmentation
+			 *  of the USB FIFO memory.
 			 *
 			 *  The pipe type may be one of the EP_TYPE_* macros listed in LowLevel.h, the token may be one of the
 			 *  PIPE_TOKEN_* masks.
@@ -722,6 +723,9 @@
 			 *
 			 *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() macro.
 			 *
+			 *  \note The default control pipe does not have to be manually configured, as it is automatically
+			 *  configured by the library internally.
+			 *
 			 *  \note This routine will select the specified pipe, and the pipe will remain selected once the
 			 *        routine completes regardless of if the pipe configuration succeeds.
 			 *
@@ -745,9 +749,9 @@
 			 *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
 			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 			 *
-			 *	The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token
-			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
-			 *  and this function has the Callback parameter omitted.
+			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+			 *  disabled and this function has the Callback parameter omitted.
 			 *
 			 *  \ingroup Group_PipeRW
 			 *
@@ -759,7 +763,7 @@
 			 */
 			uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length
 			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
-			                             , uint8_t (* const Callback)(void)
+			                             , StreamCallbackPtr_t Callback
 			#endif
 			                             ) ATTR_NON_NULL_PTR_ARG(1);				
 
@@ -769,9 +773,9 @@
 			 *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is
 			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 			 *
-			 *	The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token
-			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
-			 *  and this function has the Callback parameter omitted.
+			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+			 *  disabled and this function has the Callback parameter omitted.
 			 *
 			 *  \ingroup Group_PipeRW
 			 *
@@ -783,7 +787,7 @@
 			 */
 			uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length
 			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
-			                             , uint8_t (* const Callback)(void)
+			                             , StreamCallbackPtr_t Callback
 			#endif
 			                             ) ATTR_NON_NULL_PTR_ARG(1);
 
@@ -793,9 +797,9 @@
 			 *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,
 			 *  allowing for early aborts of stream transfers.
 			 *
-			 *	The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token
-			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
-			 *  and this function has the Callback parameter omitted.
+			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+			 *  disabled and this function has the Callback parameter omitted.
 			 *
 			 *  \ingroup Group_PipeRW
 			 *
@@ -806,7 +810,7 @@
 			 */
 			uint8_t Pipe_Discard_Stream(uint16_t Length
 			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
-			                            , uint8_t (* const Callback)(void)
+			                            , StreamCallbackPtr_t Callback
 			#endif
 			                            );
 
@@ -816,9 +820,9 @@
 			 *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
 			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 			 *
-			 *	The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token
-			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
-			 *  and this function has the Callback parameter omitted.
+			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+			 *  disabled and this function has the Callback parameter omitted.
 			 *
 			 *  \ingroup Group_PipeRW
 			 *
@@ -830,7 +834,7 @@
 			 */
 			uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length
 			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
-			                            , uint8_t (* const Callback)(void)
+			                            , StreamCallbackPtr_t Callback
 			#endif
 			                            ) ATTR_NON_NULL_PTR_ARG(1);
 
@@ -840,9 +844,9 @@
 			 *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is
 			 *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.
 			 *
-			 *	The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token
-			 *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled
-			 *  and this function has the Callback parameter omitted.
+			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.
+			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are
+			 *  disabled and this function has the Callback parameter omitted.
 			 *
 			 *  \ingroup Group_PipeRW
 			 *
@@ -854,7 +858,7 @@
 			 */
 			uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length
 			#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)
-			                            , uint8_t (* const Callback)(void)
+			                            , StreamCallbackPtr_t Callback
 			#endif
 			                            ) ATTR_NON_NULL_PTR_ARG(1);