\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
- * \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
* 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
- * \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
/** 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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
* \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
projects / pub / lufa.git / blobdiff