diff options
Diffstat (limited to 'LUFA/Drivers/USB/LowLevel')
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Endpoint.h | 6 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Pipe.h | 6 |
2 files changed, 9 insertions, 3 deletions
diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index bf3384848..323559320 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -671,7 +671,8 @@ /* Function Prototypes: */
/** Configures the specified endpoint number with the given endpoint type, direction, bank size
* and banking mode. Endpoints should be allocated in ascending order by their address in the
- * device (i.e. endpoint 1 should be configured before endpoint 2 and so on).
+ * device (i.e. endpoint 1 should be configured before endpoint 2 and so on) to prevent fragmentation
+ * of the USB FIFO memory.
*
* The endpoint type may be one of the EP_TYPE_* macros listed in LowLevel.h and the direction
* may be either \ref ENDPOINT_DIR_OUT or \ref ENDPOINT_DIR_IN.
@@ -682,7 +683,8 @@ *
* The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
*
- * The success of this routine can be determined via the \ref Endpoint_IsConfigured() macro.
+ * \note The default control endpoint does not have to be manually configured, as it is automatically
+ * configured by the library internally.
*
* \note This routine will select the specified endpoint, and the endpoint will remain selected
* once the routine completes regardless of if the endpoint configuration succeeds.
diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index befc996a2..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.
*
|