/** Selects the given pipe number. Any pipe operations which do not require the pipe number to be\r
* indicated will operate on the currently selected pipe.\r
*\r
- * \param PipeNumber Index of the pipe to select\r
+ * \param[in] PipeNumber Index of the pipe to select\r
*/\r
static inline void Pipe_SelectPipe(uint8_t PipeNumber);\r
\r
/** Resets the desired pipe, including the pipe banks and flags.\r
*\r
- * \param PipeNumber Index of the pipe to reset\r
+ * \param[in] PipeNumber Index of the pipe to reset\r
*/\r
static inline void Pipe_ResetPipe(uint8_t PipeNumber);\r
\r
* control requests, or on regular pipes to allow for half-duplex bidirectional data transfer to devices\r
* which have two endpoints of opposite direction sharing the same endpoint address within the device.\r
*\r
- * \param Token New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask\r
+ * \param[in] Token New pipe token to set the selected pipe to, as a PIPE_TOKEN_* mask\r
*/\r
static inline void Pipe_SetPipeToken(uint8_t Token);\r
\r
/** Configures the currently selected pipe to only allow the specified number of IN requests to be\r
* accepted by the pipe before it is automatically frozen.\r
*\r
- * \param TotalINRequests Total number of IN requests that the pipe may receive before freezing\r
+ * \param[in] TotalINRequests Total number of IN requests that the pipe may receive before freezing\r
*/\r
static inline void Pipe_SetFiniteINRequests(uint8_t TotalINRequests);\r
\r
\r
/** Sets the period between interrupts for an INTERRUPT type pipe to a specified number of milliseconds.\r
*\r
- * \param Milliseconds Number of milliseconds between each pipe poll\r
+ * \param[in] Milliseconds Number of milliseconds between each pipe poll\r
*/\r
static inline void Pipe_SetInterruptPeriod(uint8_t Milliseconds);\r
\r
/** Determines if the specified pipe number has interrupted (valid only for INTERRUPT type\r
* pipes).\r
*\r
- * \param PipeNumber Index of the pipe whose interrupt flag should be tested\r
+ * \param[in] PipeNumber Index of the pipe whose interrupt flag should be tested\r
*\r
* \return Boolean true if the specified pipe has interrupted, false otherwise\r
*/\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param Byte Next byte to write into the the currently selected pipe's FIFO buffer\r
+ * \param[in] Byte Next byte to write into the the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_Byte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_Byte(const uint8_t Byte)\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param Word Next word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_Word_LE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_Word_LE(const uint16_t Word)\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param Word Next word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] Word Next word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_Word_BE(const uint16_t Word) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_Word_BE(const uint16_t Word)\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param DWord Next double word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_DWord_LE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_DWord_LE(const uint32_t DWord)\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param DWord Next double word to write to the currently selected pipe's FIFO buffer\r
+ * \param[in] DWord Next double word to write to the currently selected pipe's FIFO buffer\r
*/\r
static inline void Pipe_Write_DWord_BE(const uint32_t DWord) ATTR_ALWAYS_INLINE;\r
static inline void Pipe_Write_DWord_BE(const uint32_t DWord)\r
*\r
* \ingroup Group_PipeRW\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 pipe 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 pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* \ingroup Group_PipeRW\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 pipe 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 pipe 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 Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param Length Number of bytes to send via the currently selected pipe.\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 pipe.\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 Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param Buffer Pointer to the source data buffer to write to.\r
- * \param Length Number of bytes to read for the currently selected pipe to read from.\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 source data buffer to write to.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\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 Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
*\r
* \ingroup Group_PipeRW\r
*\r
- * \param Buffer Pointer to the source data buffer to write to.\r
- * \param Length Number of bytes to read for the currently selected pipe to read from.\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 source data buffer to write to.\r
+ * \param[in] Length Number of bytes to read for the currently selected pipe to read from.\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 Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
projects / pub / USBasp.git / blobdiff