\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r
#define PIPE_ERRORFLAG_CRC16 (1 << 4)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_TIMEOUT (1 << 3)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_PID (1 << 2)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_DATAPID (1 << 1)\r
\r
- /** Mask for Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */\r
+ /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */\r
#define PIPE_ERRORFLAG_DATATGL (1 << 0)\r
\r
- /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),\r
+ /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),\r
* which will trigger a control request on the attached device when data is written to the pipe.\r
*/\r
#define PIPE_TOKEN_SETUP (0 << PTOKEN0)\r
\r
- /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+ /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
* indicating that the pipe data will flow from device to host.\r
*/\r
#define PIPE_TOKEN_IN (1 << PTOKEN0)\r
\r
- /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+ /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
* indicating that the pipe data will flow from host to device.\r
*/\r
#define PIPE_TOKEN_OUT (2 << PTOKEN0)\r
\r
- /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe\r
+ /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe\r
* should have one single bank, which requires less USB FIFO memory but results in slower transfers as\r
* only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.\r
*/\r
#define PIPE_BANK_SINGLE (0 << EPBK0)\r
\r
- /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe\r
+ /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe\r
* should have two banks, which requires more USB FIFO memory but results in faster transfers as one\r
* USB device (the AVR or the attached device) can access one bank while the other accesses the second\r
* bank.\r
* \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
* is selected), and will fire the common pipe interrupt vector.\r
*\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ * \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
*/\r
#define PIPE_INT_IN UPIENX, (1 << RXINE) , UPINTX, (1 << RXINI)\r
\r
* \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
* is selected), and will fire the common pipe interrupt vector.\r
*\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ * \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
*/\r
#define PIPE_INT_OUT UPIENX, (1 << TXOUTE), UPINTX, (1 << TXOUTI)\r
\r
* \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
* is selected), and will fire the common pipe interrupt vector.\r
*\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ * \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
*/\r
#define PIPE_INT_SETUP UPIENX, (1 << TXSTPE) , UPINTX, (1 << TXSTPI)\r
\r
* \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
* is selected), and will fire the common pipe interrupt vector.\r
*\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ * \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
*\r
- * \see Pipe_GetErrorFlags() for more information on the pipe errors.\r
+ * \see \ref Pipe_GetErrorFlags() for more information on the pipe errors.\r
*/\r
#define PIPE_INT_ERROR UPIENX, (1 << PERRE), UPINTX, (1 << PERRI)\r
\r
* \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
* is selected), and will fire the common pipe interrupt vector.\r
*\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ * \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
*\r
- * \see Pipe_IsNAKReceived() for more information on pipe NAKs.\r
+ * \see \ref Pipe_IsNAKReceived() for more information on pipe NAKs.\r
*/\r
#define PIPE_INT_NAK UPIENX, (1 << NAKEDE), UPINTX, (1 << NAKEDI)\r
\r
* \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
* is selected), and will fire the common pipe interrupt vector.\r
*\r
- * \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+ * \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
*/\r
#define PIPE_INT_STALL UPIENX, (1 << RXSTALLE), UPINTX, (1 << RXSTALLI)\r
\r
/** Enables the currently selected pipe so that data can be sent and received through it to and from\r
* an attached device.\r
*\r
- * \note Pipes must first be configured properly rather than just being enabled via the\r
- * Pipe_ConfigurePipe() macro, which calls Pipe_EnablePipe() automatically.\r
+ * \note Pipes must first be configured properly via \ref Pipe_ConfigurePipe().\r
*/\r
static inline void Pipe_EnablePipe(void);\r
\r
/** Determines if the master pipe error flag is set for the currently selected pipe, indicating that\r
* some sort of hardware error has occurred on the pipe.\r
*\r
- * \see Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.\r
+ * \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.\r
*\r
* \return Boolean true if an error has occurred on the selected pipe, false otherwise\r
*/\r
/** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on\r
* the currently selected pipe. This occurs when the host sends a packet to the device, but the device\r
* is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been\r
- * received, it must be cleared using Pipe_ClearNAKReceived() before the previous (or any other) packet\r
+ * received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet\r
* can be re-sent.\r
*\r
* \ingroup Group_PipePacketManagement\r
*\r
* \ingroup Group_PipePacketManagement\r
*\r
- * \see Pipe_IsNAKReceived() for more details.\r
+ * \see \ref Pipe_IsNAKReceived() for more details.\r
*/\r
static inline void Pipe_ClearNAKReceived(void);\r
\r
PIPE_READYWAIT_DeviceDisconnected = 2, /**< Device was disconnected from the host while waiting. */\r
PIPE_READYWAIT_Timeout = 3, /**< The device failed to accept or send the next packet\r
* within the software timeout period set by the\r
- * USB_STREAM_TIMEOUT_MS macro.\r
+ * \ref USB_STREAM_TIMEOUT_MS macro.\r
*/\r
};\r
\r
*/ \r
PIPE_RWSTREAM_ERROR_Timeout = 3, /**< The device failed to accept or send the next packet\r
* within the software timeout period set by the\r
- * USB_STREAM_TIMEOUT_MS macro.\r
+ * \ref USB_STREAM_TIMEOUT_MS macro.\r
*/\r
PIPE_RWSTREAM_ERROR_CallbackAborted = 4, /**< Indicates that the stream's callback function aborted\r
* the transfer early.\r
* numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to\r
* determine the maximum bank size for each pipe.\r
*\r
- * The banking mode may be either PIPE_BANK_SINGLE or PIPE_BANK_DOUBLE.\r
+ * The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.\r
*\r
- * A newly configured pipe is frozen by default, and must be unfrozen before use via the Pipe_Unfreeze() macro.\r
+ * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() macro.\r
*\r
* \note This routine will select the specified pipe, and the pipe will remain selected once the\r
* routine completes regardless of if the pipe configuration succeeds.\r
/** Writes the given number of bytes to the pipe from the given buffer in little endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
+ * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+ * The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
* and this function has the Callback parameter omitted.\r
*\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
*\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length\r
#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
/** Writes the given number of bytes to the pipe from the given buffer in big endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
+ * \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+ * The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
* and this function has the Callback parameter omitted.\r
*\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
*\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length\r
#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
\r
/** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host\r
* as needed. The last packet is not automatically discarded once the remaining bytes has been read; the\r
- * user is responsible for manually discarding the last packet from the device via the Pipe_ClearIN() macro.\r
+ * user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.\r
* Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,\r
* allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+ * The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
* and this function has the Callback parameter omitted.\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
*\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
uint8_t Pipe_Discard_Stream(uint16_t Length\r
#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
/** Reads the given number of bytes from the pipe into the given buffer in little endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
+ * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+ * The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
* and this function has the Callback parameter omitted.\r
*\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
*\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length\r
#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
/** Reads the given number of bytes from the pipe into the given buffer in big endian,\r
* sending full packets to the device as needed. The last packet filled is not automatically sent;\r
* the user is responsible for manually sending the last written packet to the host via the\r
- * Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
+ * \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
* executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
*\r
- * The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+ * The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r
* NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
* and this function has the Callback parameter omitted.\r
*\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
*\r
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r
*/\r
uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length\r
#if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
projects / pub / USBasp.git / blobdiff