X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/9cec85bfd92a77a97e7d12625897de2682dfacd7..a908773a13ee491f2f8907cdf57c26fb39e10658:/LUFA/Drivers/USB/HighLevel/Events.h diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h index 317495cc0..36e16c98b 100644 --- a/LUFA/Drivers/USB/HighLevel/Events.h +++ b/LUFA/Drivers/USB/HighLevel/Events.h @@ -202,13 +202,15 @@ */ void USB_Disconnect(void); - /** Event for USB device power on failure. This event fires when the USB interface fails to + /** Event for USB initialization failure. This event fires when the USB interface fails to * initialize correctly due to a hardware or software fault. * - * \param ErrorCode Error code indicating the failure reason, a value in \ref USB_PowerOnErrorCodes_t + * \note This event only exists on USB AVR models which support dual role modes. + * + * \param ErrorCode Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t * located in LowLevel.h. */ - void USB_PowerOnFail(const uint8_t ErrorCode); + void USB_InitFailure(const uint8_t ErrorCode); /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role * mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires @@ -217,7 +219,7 @@ * \note This event only exists on USB AVR models which support dual role modes. * * \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied - * to the compiler (see LowLevel.h documentation). + * to the compiler (see \ref Group_USBManagement documentation). */ void USB_UIDChange(void); @@ -230,7 +232,7 @@ * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). */ void USB_HostError(const uint8_t ErrorCode); @@ -242,9 +244,9 @@ * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). * - * \see USBTask.h for more information on the USB management task and reducing CPU usage. + * \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage. */ void USB_DeviceAttached(void); @@ -255,9 +257,9 @@ * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). * - * \see USBTask.h for more information on the USB management task and reducing CPU usage. + * \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage. */ void USB_DeviceUnattached(void); @@ -265,16 +267,16 @@ * in host mode, and an attached USB device has failed to enumerate completely. * * \param ErrorCode Error code indicating the failure reason, a value in - * USB_Host_EnumerationErrorCodes_t located in Host.h. + * \ref USB_Host_EnumerationErrorCodes_t located in Host.h. * * \param SubErrorCode Sub error code indicating the reason for failure - for example, if the * ErrorCode parameter indicates a control error, this will give the error - * code returned by the USB_Host_SendControlRequest() function. + * code returned by the \ref USB_Host_SendControlRequest() function. * * \note This event only exists on USB AVR models which supports host mode. * * \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). */ void USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode); @@ -292,7 +294,7 @@ * on control transfers, interrupts are disabled during control request processing. * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). * * \note Requests should be handled in the same manner as described in the USB 2.0 Specification, * or appropriate class specification. In all instances, the library has already read the @@ -308,7 +310,7 @@ * This event fires after the value of \ref USB_ConfigurationNumber has been changed. * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). */ void USB_ConfigurationChanged(void); @@ -317,7 +319,7 @@ * the device over to a low power state until the host wakes up the device. * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). * * \see \ref USB_WakeUp() event for accompanying Wake Up event. */ @@ -329,7 +331,7 @@ * mode. * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). * * \see \ref USB_Suspend() event for accompanying Suspend event. */ @@ -342,7 +344,7 @@ * disabled. * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). */ void USB_Reset(void); @@ -353,7 +355,7 @@ * \ref USB_Device_ErrorCodes_t enum located in Device.h. * * \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see - * LowLevel.h documentation). + * \ref Group_USBManagement documentation). */ void USB_DeviceError(const uint8_t ErrorCode); #endif @@ -374,7 +376,7 @@ #define USB_DeviceEnumerationComplete_P (void) #if defined(USB_CAN_BE_BOTH) - #define USB_PowerOnFail_P (const uint8_t ErrorCode) + #define USB_InitFailure_P (const uint8_t ErrorCode) #define USB_UIDChange_P (void) #endif @@ -409,7 +411,7 @@ ALIAS_STUB(USB_DeviceEnumerationComplete); #if defined(USB_CAN_BE_BOTH) - ALIAS_STUB(USB_PowerOnFail); + ALIAS_STUB(USB_InitFailure); ALIAS_STUB(USB_UIDChange); #endif