* multiple places in the user or library code, which may or may not be inside an ISR, thus each handler\r
* should be written to be as small and fast as possible to prevent possible problems.\r
*\r
- * Events can be hooked by the user application using the EVENT_HANDLER() and HANDLES_EVENT() macros. If an\r
+ * Events can be hooked by the user application using the \ref EVENT_HANDLER() and \ref HANDLES_EVENT() macros. If an\r
* event with no associated handler is fired within the library, it by default fires an internal empty stub\r
* function. This is achieved through the use of the GCC compiler's "alias" attribute.\r
*\r
\r
/** Indicates that a given module can raise a given event. This is the equivalent of putting the\r
* event function's prototype into the module, but in a cleaner way. Each event which may be\r
- * fired via the RAISE_EVENT macro in the module should have an accompanying RAISES_EVENT\r
+ * fired via the \ref RAISE_EVENT macro in the module should have an accompanying \ref RAISES_EVENT\r
* prototype in the module's header file.\r
*\r
* Usage Examples:\r
\r
/** Indicates that a given module handles an event. This is the equivalent of putting the\r
* event function's prototype into the module, but in a cleaner way. Each event which may be\r
- * handled via the EVENT_HANDLER macro in the module should have an accompanying HANDLES_EVENT\r
+ * handled via the \ref EVENT_HANDLER macro in the module should have an accompanying \ref HANDLES_EVENT\r
* prototype in the module's header file.\r
*\r
* Usage Examples:\r
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
- * and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
+ * and disconnection events may be manually fired by \ref RAISE_EVENT(), and the \ref USB_IsConnected global changed manually.\r
*\r
* \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
*/\r
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state\r
* needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
* passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
- * and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
+ * and disconnection events may be manually fired by \ref RAISE_EVENT(), and the \ref USB_IsConnected global changed manually.\r
*\r
* \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
*/\r
/** Event for USB device power on failure. This event fires when the USB interface fails to\r
* initialize correctly due to a hardware or software fault.\r
*\r
- * \param ErrorCode Error code indicating the failure reason, a value in USB_PowerOnErrorCodes_t\r
+ * \param ErrorCode Error code indicating the failure reason, a value in \ref USB_PowerOnErrorCodes_t\r
* located in LowLevel.h.\r
*/\r
void USB_PowerOnFail(const uint8_t ErrorCode);\r
/** Event for USB host error. This event fires when a hardware fault has occurred whilst the USB\r
* interface is in host mode.\r
*\r
- * \param ErrorCode Error code indicating the failure reason, a value in USB_Host_ErrorCodes_t\r
+ * \param ErrorCode Error code indicating the failure reason, a value in \ref USB_Host_ErrorCodes_t\r
* located in Host.h.\r
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
\r
/** Event for USB device attachment. This event fires when a the USB interface is in host mode, and\r
* a USB device has been connected to the USB interface. This is interrupt driven, thus fires before\r
- * the standard USB_DeviceConnect event and so can be used to programmatically start the USB management\r
+ * the standard \ref USB_Connect event and so can be used to programmatically start the USB management\r
* task to reduce CPU consumption.\r
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
* issued to the device which must be handled appropriately. Due to the strict timing requirements\r
* on control transfers, interrupts are disabled during control request processing.\r
*\r
- * \param bRequest Request value, indicating what command the host has issued.\r
- * \param bmRequestType Mask indicating the request data direction (if any), type and recipient.\r
- *\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* LowLevel.h documentation).\r
*\r
* \note Requests should be handled in the same manner as described in the USB 2.0 Specification,\r
- * or appropriate class' specification. In all instances, the library has already read the\r
- * request bmRequestType and bRequest values out (into the Request and RequestType parameters\r
- * respectively) so that it can correctly determine if it is able to handle the request\r
- * internally, or hand off the request to the user application via this event. Other request\r
- * parameters (wValue, wIndex, wLength, and Data) remain in the control endpoint bank until\r
- * read out by the user application for processing.\r
+ * or appropriate class specification. In all instances, the library has already read the\r
+ * request SETUP parameters into the \ref USB_ControlRequest structure which should then be used\r
+ * by the application to determine how to handle the issued request.\r
*/\r
void USB_UnhandledControlPacket(void);\r
\r
* selected configuration number while in device mode. This event should be hooked in device\r
* applications to create the endpoints and configure the device for the selected configuration.\r
*\r
- * This event fires after the value of USB_ConfigurationNumber has been changed.\r
+ * This event fires after the value of \ref USB_ConfigurationNumber has been changed.\r
*\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* LowLevel.h documentation).\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* LowLevel.h documentation).\r
*\r
- * \see USB_WakeUp() event for accompanying Wake Up event.\r
+ * \see \ref USB_WakeUp() event for accompanying Wake Up event.\r
*/\r
void USB_Suspend(void);\r
\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* LowLevel.h documentation).\r
*\r
- * \see USB_Suspend() event for accompanying Suspend event.\r
+ * \see \ref USB_Suspend() event for accompanying Suspend event.\r
*/\r
void USB_WakeUp(void);\r
\r
* and an error occurs which prevents it from operating normally.\r
*\r
* \param ErrorCode Error code indicating the source of the error. One of the values in the\r
- * USB_Device_ErrorCodes_t enum located in Device.h.\r
+ * \ref USB_Device_ErrorCodes_t enum located in Device.h.\r
*\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* LowLevel.h documentation).\r
projects / pub / USBasp.git / blobdiff