aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Core/XMEGA
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2012-08-27 16:55:52 +0000
committerDean Camera <dean@fourwalledcubicle.com>2012-08-27 16:55:52 +0000
commitff00644cb8c3c6ec06cfb91b5d357f882efb6633 (patch)
tree29d1c774912b97b8b93d88b681181c13461c2bb4 /LUFA/Drivers/USB/Core/XMEGA
parent9eef78d21e4f87b929ec8174f52ac87d11fc4eb0 (diff)
downloadlufa-ff00644cb8c3c6ec06cfb91b5d357f882efb6633.tar.gz
lufa-ff00644cb8c3c6ec06cfb91b5d357f882efb6633.tar.bz2
lufa-ff00644cb8c3c6ec06cfb91b5d357f882efb6633.zip
Minor documentation corrections.
Diffstat (limited to 'LUFA/Drivers/USB/Core/XMEGA')
-rw-r--r--LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h50
1 files changed, 30 insertions, 20 deletions
diff --git a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
index f2fe28991..211f3355a 100644
--- a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
+++ b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
@@ -339,8 +339,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet
* to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -361,8 +362,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet
* to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -383,8 +385,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the
* status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -405,8 +408,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the
* status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -480,8 +484,9 @@
/** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -500,8 +505,9 @@
/** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -520,8 +526,9 @@
/** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -540,8 +547,9 @@
/** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -596,8 +604,9 @@
*
* \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
@@ -618,8 +627,9 @@
*
* \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
*
- * \note This function automatically clears the control transfer's status stage. Do not manually attempt
- * to clear the status stage when using this routine in a control transaction.
+ * \note This function automatically sends the last packet in the data stage of the transaction; when the
+ * function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+ * Note that the status stage packet is sent or received in the opposite direction of the data flow.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.