\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
- /** Mode mask for the USB_CurrentMode global. This indicates that the USB interface is currently not\r
+ /** Mode mask for the \ref USB_CurrentMode global. This indicates that the USB interface is currently not\r
* initialized into any mode.\r
*/\r
#define USB_MODE_NONE 0\r
\r
- /** Mode mask for the USB_CurrentMode global and the USB_Init() function. This indicates that the\r
+ /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the\r
* USB interface is or should be initialized in the USB device mode.\r
*/\r
#define USB_MODE_DEVICE 1\r
\r
#if defined(USB_CAN_BE_HOST) || defined(__DOXYGEN__)\r
- /** Mode mask for the USB_CurrentMode global and the USB_Init() function. This indicates that the\r
+ /** Mode mask for the \ref USB_CurrentMode global and the \ref USB_Init() function. This indicates that the\r
* USB interface is or should be initialized in the USB host mode.\r
*\r
* \note This token is not available on AVR models which do not support host mode.\r
#endif\r
\r
#if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)\r
- /** Mode mask for the the USB_Init() function. This indicates that the USB interface should be\r
+ /** Mode mask for the the \ref USB_Init() function. This indicates that the USB interface should be\r
* initialized into whatever mode the UID pin of the USB AVR indicates, and that the device\r
* should swap over its mode when the level of the UID pin changes during operation.\r
*\r
#define USB_MODE_UID 3\r
#endif\r
\r
- /** Regulator disable option mask for USB_Init(). This indicates that the internal 3.3V USB data pad\r
+ /** Regulator disable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad\r
* regulator should be enabled to regulate the data pin voltages to within the USB standard.\r
*\r
* \note See USB AVR data sheet for more information on the internal pad regulator.\r
*/\r
#define USB_OPT_REG_DISABLED (1 << 1)\r
\r
- /** Regulator enable option mask for USB_Init(). This indicates that the internal 3.3V USB data pad\r
+ /** Regulator enable option mask for \ref USB_Init(). This indicates that the internal 3.3V USB data pad\r
* regulator should be disabled and the AVR's VCC level used for the data pads.\r
*\r
* \note See USB AVR data sheet for more information on the internal pad regulator.\r
*/\r
#define USB_OPT_REG_ENABLED (0 << 1)\r
\r
- /** Manual PLL control option mask for USB_Init(). This indicates to the library that the user application\r
+ /** Manual PLL control option mask for \ref USB_Init(). This indicates to the library that the user application\r
* will take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock\r
* that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.\r
*/\r
#define USB_OPT_MANUAL_PLL (1 << 2)\r
\r
- /** Automatic PLL control option mask for USB_Init(). This indicates to the library that the library should\r
+ /** Automatic PLL control option mask for \ref USB_Init(). This indicates to the library that the library should\r
* take full responsibility for controlling the AVR's PLL (used to generate the high frequency clock\r
* that the USB controller requires) and ensuring that it is locked at the correct frequency for USB operations.\r
*/\r
\r
/** Detaches the device from the USB bus. This has the effect of removing the device from any\r
* host if, ceasing USB communications. If no host is present, this prevents any host from\r
- * enumerating the device once attached until USB_Attach() is called.\r
+ * enumerating the device once attached until \ref USB_Attach() is called.\r
*/\r
#define USB_Detach() MACROS{ UDCON |= (1 << DETACH); }MACROE\r
\r
* is not received or acknowledged within this time period, the stream function will fail.\r
*\r
* This value may be overridden in the user project makefile as the value of the \r
- * USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.\r
+ * \ref USB_STREAM_TIMEOUT_MS token, and passed to the compiler using the -D switch.\r
*/\r
#define USB_STREAM_TIMEOUT_MS 100\r
#endif\r
* interface reset and re-enumeration.\r
*\r
* \param Mode This is a mask indicating what mode the USB interface is to be initialized to.\r
- * Valid mode masks are USB_MODE_DEVICE, USB_MODE_HOST or USB_MODE_UID.\r
+ * Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID.\r
*\r
* \param Options Mask indicating the options which should be used when initializing the USB\r
* interface to control the USB interface's behaviour. This should be comprised of\r
\r
/** Shuts down the USB interface. This turns off the USB interface after deallocating all USB FIFO\r
* memory, endpoints and pipes. When turned off, no USB functionality can be used until the interface\r
- * is restarted with the USB_Init() function.\r
+ * is restarted with the \ref USB_Init() function.\r
*/\r
void USB_ShutDown(void);\r
\r
\r
/* Enums: */\r
/** Enum for error codes relating to the powering on of the USB interface. These error codes are\r
- * used in the ErrorCode parameter value of the USB_PowerOnFail event.\r
+ * used in the ErrorCode parameter value of the \ref USB_PowerOnFail event.\r
*/\r
enum USB_PowerOnErrorCodes_t\r
{\r
- POWERON_ERROR_NoUSBModeSpecified = 0, /**< Indicates that USB_Init() was called with an\r
+ POWERON_ERROR_NoUSBModeSpecified = 0, /**< Indicates that \ref USB_Init() was called with an\r
* invalid or missing Mode parameter.\r
*/\r
};\r
\r
#if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)\r
extern volatile uint8_t USB_Options;\r
- /** Indicates the current USB options that the USB interface was initialized with when USB_Init()\r
+ /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()\r
* was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.\r
*\r
* \note This variable should be treated as read-only in the user application, and never manually\r
#endif\r
\r
/* Throwable Events: */\r
- /** This module raises the USB_Disconnect event if the USB interface is reset (such as during a mode\r
+ /** This module raises the \ref USB_Disconnect event if the USB interface is reset (such as during a mode\r
* change while in UID mode) while the USB interface is connected to a device when in host mode, or\r
* a host while in device mode.\r
*\r
projects / pub / USBasp.git / blobdiff