projects
/
pub
/
USBasp.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Minor correction to MagStripe demo to fix build problems.
[pub/USBasp.git]
/
LUFA
/
Drivers
/
USB
/
LowLevel
/
Endpoint.h
diff --git
a/LUFA/Drivers/USB/LowLevel/Endpoint.h
b/LUFA/Drivers/USB/LowLevel/Endpoint.h
index
3235593
..
772d1fe
100644
(file)
--- a/
LUFA/Drivers/USB/LowLevel/Endpoint.h
+++ b/
LUFA/Drivers/USB/LowLevel/Endpoint.h
@@
-117,18
+117,18
@@
\r
/** Maximum size in bytes of a given endpoint.
\r
*
\r
\r
/** Maximum size in bytes of a given endpoint.
\r
*
\r
- * \param n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
\r
+ * \param
[in]
n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
\r
*/
\r
#define ENDPOINT_MAX_SIZE(n) _ENDPOINT_GET_MAXSIZE(n)
\r
\r
/** Indicates if the given endpoint supports double banking.
\r
*
\r
*/
\r
#define ENDPOINT_MAX_SIZE(n) _ENDPOINT_GET_MAXSIZE(n)
\r
\r
/** Indicates if the given endpoint supports double banking.
\r
*
\r
- * \param n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
\r
+ * \param
[in]
n Endpoint number, a value between 0 and (ENDPOINT_TOTAL_ENDPOINTS - 1)
\r
*/
\r
#define ENDPOINT_DOUBLEBANK_SUPPORTED(n) _ENDPOINT_GET_DOUBLEBANK(n)
\r
\r
#if !defined(CONTROL_ONLY_DEVICE)
\r
*/
\r
#define ENDPOINT_DOUBLEBANK_SUPPORTED(n) _ENDPOINT_GET_DOUBLEBANK(n)
\r
\r
#if !defined(CONTROL_ONLY_DEVICE)
\r
- #if defined(USB_
FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLE
R) || defined(__DOXYGEN__)
\r
+ #if defined(USB_
SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AV
R) || defined(__DOXYGEN__)
\r
/** Total number of endpoints (including the default control endpoint at address 0) which may
\r
* be used in the device. Different USB AVR models support different amounts of endpoints,
\r
* this value reflects the maximum number of endpoints for the currently selected AVR model.
\r
/** Total number of endpoints (including the default control endpoint at address 0) which may
\r
* be used in the device. Different USB AVR models support different amounts of endpoints,
\r
* this value reflects the maximum number of endpoints for the currently selected AVR model.
\r
@@
-169,14
+169,14
@@
* Any endpoint operations which do not require the endpoint number to be indicated will operate on
\r
* the currently selected endpoint.
\r
*
\r
* Any endpoint operations which do not require the endpoint number to be indicated will operate on
\r
* the currently selected endpoint.
\r
*
\r
- * \param EndpointNumber Endpoint number to select
\r
+ * \param
[in]
EndpointNumber Endpoint number to select
\r
*/
\r
static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);
\r
\r
/** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
\r
* In and Out pointers to the bank's contents.
\r
*
\r
*/
\r
static inline void Endpoint_SelectEndpoint(uint8_t EndpointNumber);
\r
\r
/** Resets the endpoint bank FIFO. This clears all the endpoint banks and resets the USB controller's
\r
* In and Out pointers to the bank's contents.
\r
*
\r
- * \param EndpointNumber Endpoint number whose FIFO buffers are to be reset
\r
+ * \param
[in]
EndpointNumber Endpoint number whose FIFO buffers are to be reset
\r
*/
\r
static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);
\r
\r
*/
\r
static inline void Endpoint_ResetFIFO(uint8_t EndpointNumber);
\r
\r
@@
-227,7
+227,7
@@
/** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
\r
* endpoints).
\r
*
\r
/** Determines if the specified endpoint number has interrupted (valid only for INTERRUPT type
\r
* endpoints).
\r
*
\r
- * \param EndpointNumber Index of the endpoint whose interrupt flag should be tested
\r
+ * \param
[in]
EndpointNumber Index of the endpoint whose interrupt flag should be tested
\r
*
\r
* \return Boolean true if the specified endpoint has interrupted, false otherwise
\r
*/
\r
*
\r
* \return Boolean true if the specified endpoint has interrupted, false otherwise
\r
*/
\r
@@
-316,7
+316,7
@@
*/
\r
static inline uint8_t Endpoint_GetEndpointDirection(void);
\r
#else
\r
*/
\r
static inline uint8_t Endpoint_GetEndpointDirection(void);
\r
#else
\r
- #if defined(USB_
FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLE
R) || defined(__DOXYGEN__)
\r
+ #if defined(USB_
SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AV
R) || defined(__DOXYGEN__)
\r
#define Endpoint_BytesInEndpoint() UEBCX
\r
#else
\r
#define Endpoint_BytesInEndpoint() UEBCLX
\r
#define Endpoint_BytesInEndpoint() UEBCX
\r
#else
\r
#define Endpoint_BytesInEndpoint() UEBCLX
\r
@@
-454,7
+454,7
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Byte Next byte to write into the the currently selected endpoint's FIFO buffer
\r
+ * \param
[in]
Byte Next byte to write into the the currently selected endpoint's FIFO buffer
\r
*/
\r
static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_Byte(const uint8_t Byte)
\r
*/
\r
static inline void Endpoint_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_Byte(const uint8_t Byte)
\r
@@
-515,7
+515,7
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Word Next word to write to the currently selected endpoint's FIFO buffer
\r
+ * \param
[in]
Word Next word to write to the currently selected endpoint's FIFO buffer
\r
*/
\r
static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_Word_LE(const uint16_t Word)
\r
*/
\r
static inline void Endpoint_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_Word_LE(const uint16_t Word)
\r
@@
-529,7
+529,7
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Word Next word to write to the currently selected endpoint's FIFO buffer
\r
+ * \param
[in]
Word Next word to write to the currently selected endpoint's FIFO buffer
\r
*/
\r
static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_Word_BE(const uint16_t Word)
\r
*/
\r
static inline void Endpoint_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_Word_BE(const uint16_t Word)
\r
@@
-604,7
+604,7
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param DWord Next double word to write to the currently selected endpoint's FIFO buffer
\r
+ * \param
[in]
DWord Next double word to write to the currently selected endpoint's FIFO buffer
\r
*/
\r
static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
\r
*/
\r
static inline void Endpoint_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_DWord_LE(const uint32_t DWord)
\r
@@
-620,7
+620,7
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param DWord Next double word to write to the currently selected endpoint's FIFO buffer
\r
+ * \param
[in]
DWord Next double word to write to the currently selected endpoint's FIFO buffer
\r
*/
\r
static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
\r
*/
\r
static inline void Endpoint_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;
\r
static inline void Endpoint_Write_DWord_BE(const uint32_t DWord)
\r
@@
-722,8
+722,8
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Length Number of bytes to send via the currently selected endpoint.
\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 endpoint.
\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 Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-748,9
+748,9
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\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 endpoint 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 endpoint 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 Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-775,9
+775,9
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\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 endpoint 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 endpoint 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 Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-802,9
+802,9
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Buffer Pointer to the destination data buffer to write to.
\r
- * \param Length Number of bytes to send via the currently selected endpoint.
\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 destination data buffer to write to.
\r
+ * \param
[in]
Length Number of bytes to send via the currently selected endpoint.
\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 Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-829,9
+829,9
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Buffer Pointer to the destination data buffer to write to.
\r
- * \param Length Number of bytes to send via the currently selected endpoint.
\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 destination data buffer to write to.
\r
+ * \param
[in]
Length Number of bytes to send via the currently selected endpoint.
\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 Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-855,8
+855,8
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\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 endpoint into the buffer.
\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 endpoint into the buffer.
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-874,8
+874,8
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\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 endpoint into the buffer.
\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 endpoint into the buffer.
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-893,8
+893,8
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Buffer Pointer to the destination data buffer to write to.
\r
- * \param Length Number of bytes to send via the currently selected endpoint.
\r
+ * \param
[out]
Buffer Pointer to the destination data buffer to write to.
\r
+ * \param
[in]
Length Number of bytes to send via the currently selected endpoint.
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-912,8
+912,8
@@
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
*
\r
* \ingroup Group_EndpointRW
\r
*
\r
- * \param Buffer Pointer to the destination data buffer to write to.
\r
- * \param Length Number of bytes to send via the currently selected endpoint.
\r
+ * \param
[out]
Buffer Pointer to the destination data buffer to write to.
\r
+ * \param
[in]
Length Number of bytes to send via the currently selected endpoint.
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
*
\r
* \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
\r
*/
\r
@@
-933,7
+933,7
@@
#define _ENDPOINT_GET_DOUBLEBANK2(details) _ENDPOINT_GET_DOUBLEBANK3(details)
\r
#define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
\r
\r
#define _ENDPOINT_GET_DOUBLEBANK2(details) _ENDPOINT_GET_DOUBLEBANK3(details)
\r
#define _ENDPOINT_GET_DOUBLEBANK3(maxsize, db) db
\r
\r
- #if defined(USB_
FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLE
R)
\r
+ #if defined(USB_
SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AV
R)
\r
#define ENDPOINT_DETAILS_EP0 64, true
\r
#define ENDPOINT_DETAILS_EP1 256, true
\r
#define ENDPOINT_DETAILS_EP2 64, true
\r
#define ENDPOINT_DETAILS_EP0 64, true
\r
#define ENDPOINT_DETAILS_EP1 256, true
\r
#define ENDPOINT_DETAILS_EP2 64, true
\r