/* Public Interface - May be used in end-application: */ \r
/* Pseudo-Functions for Doxygen: */\r
#if !defined(INCLUDE_FROM_EVENTS_C) || defined(__DOXYGEN__)\r
- /** Event for VBUS level change. This event fires when the VBUS line of the USB AVR changes from\r
- * high to low or vice-versa, before the new VBUS level is sampled and the appropriate action\r
- * taken.\r
- *\r
- * \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
- */\r
- void EVENT_USB_VBUSChange(void);\r
-\r
- /** Event for VBUS attachment. On the AVR models with a dedicated VBUS pin, this event fires when\r
- * the VBUS line of the USB AVR changes from low to high (after the VBUS events have been handled),\r
- * signalling the attachment of the USB device to a host, before the enumeration process has begun.\r
- *\r
- * \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
- */\r
- void EVENT_USB_VBUSConnect(void);\r
-\r
- /** Event for VBUS attachment. On the AVR models with a dedicated VBUS pin, this event fires when\r
- * the VBUS line of the USB AVR changes from high to low (after the VBUS events have been handled),\r
- * signalling the detatchment of the USB device from a host, regardless of its enumeration state.\r
- *\r
- * \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
- */\r
- void EVENT_USB_VBUSDisconnect(void);\r
-\r
- /** Event for USB device connection. This event fires when the AVR is in USB host mode and a device\r
- * has been attached (but not yet fully enumerated), or when in device mode and the device is connected\r
- * to a host, beginning the enumeration process.\r
- *\r
- * When in device mode, this can be used to programmatically start the USB management task to reduce\r
- * CPU usage.\r
- *\r
- * \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
- * this means that the current connection state is derived from the bus suspension and wake up events by default,\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, and the \ref USB_DeviceState global changed manually.\r
- *\r
- * \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
- */\r
- void EVENT_USB_Connect(void);\r
-\r
- /** Event for USB device disconnection. This event fires when the AVR is in USB host mode and an\r
- * attached and enumerated device has been disconnected, or when in device mode and the device is\r
- * disconnected from the host.\r
- *\r
- * When in device mode, this can be used to programmatically stop the USB management task to reduce\r
- * CPU usage.\r
- *\r
- * \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
- * this means that the current connection state is derived from the bus suspension and wake up events by default,\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, and the \ref USB_DeviceState global changed manually.\r
- *\r
- * \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
- */\r
- void EVENT_USB_Disconnect(void);\r
- \r
- /** Event for USB initialization failure. This event fires when the USB interface fails to\r
+ /** Event for USB stack initialization failure. This event fires when the USB interface fails to\r
* initialize correctly due to a hardware or software fault.\r
*\r
* \note This event only exists on USB AVR models which support dual role modes.\r
\r
/** Event for USB mode pin level change. This event fires when the USB interface is set to dual role\r
* mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires\r
- * before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Disconnect event\r
- * has fired (if connected before the role change).\r
+ * before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect\r
+ * event has fired (if connected before the role change).\r
*\r
* \note This event only exists on USB AVR models which support dual role modes.\r
*\r
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
*/\r
- void EVENT_USB_HostError(const uint8_t ErrorCode);\r
+ void EVENT_USB_Host_HostError(const uint8_t ErrorCode);\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 \ref EVENT_USB_Connect event and so can be used to programmatically start the USB management\r
- * task to reduce CPU consumption.\r
+ * the standard \ref EVENT_USB_Device_Connect event and so can be used to programmatically start the USB\r
+ * management task to reduce CPU consumption.\r
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
*\r
*\r
* \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.\r
*/\r
- void EVENT_USB_DeviceAttached(void);\r
+ void EVENT_USB_Host_DeviceAttached(void);\r
\r
/** Event for USB device removal. This event fires when a the USB interface is in host mode, and\r
* a USB device has been removed the USB interface whether or not it has been enumerated. This\r
*\r
* \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.\r
*/\r
- void EVENT_USB_DeviceUnattached(void);\r
+ void EVENT_USB_Host_DeviceUnattached(void);\r
\r
/** Event for USB device enumeration failure. This event fires when a the USB interface is\r
* in host mode, and an attached USB device has failed to enumerate completely.\r
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
*/\r
- void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
+ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
\r
/** Event for USB device enumeration completion. This event fires when a the USB interface is\r
* in host mode and an attached USB device has been completely enumerated and is ready to be\r
- * controlled by the user application, or when the library is in device mode, and the Host\r
- * has finished enumerating the device.\r
+ * controlled by the user application.\r
*/\r
- void EVENT_USB_DeviceEnumerationComplete(void);\r
+ void EVENT_USB_Host_DeviceEnumerationComplete(void);\r
+\r
+ /** Event for USB device connection. This event fires when the AVR in device mode and the device is connected\r
+ * to a host, beginning the enumeration process, measured by a rising level on the AVR's VBUS pin.\r
+ *\r
+ * \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
+ * this means that the current connection state is derived from the bus suspension and wake up events by default,\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, and the \ref USB_DeviceState global changed manually.\r
+ *\r
+ * \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+ */\r
+ void EVENT_USB_Device_Connect(void);\r
+\r
+ /** Event for USB device disconnection. This event fires when the AVR in device mode and the device is disconnected\r
+ * from a host, measured by a falling level on the AVR's VBUS pin.\r
+ *\r
+ * \note For the smaller USB AVRs (AT90USBXX2) with limited USB controllers, VBUS is not available to the USB controller.\r
+ * this means that the current connection state is derived from the bus suspension and wake up events by default,\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, and the \ref USB_DeviceState global changed manually.\r
+ *\r
+ * \see USBTask.h for more information on the USB management task and reducing CPU usage.\r
+ */\r
+ void EVENT_USB_Device_Disconnect(void);\r
\r
/** Event for unhandled control requests. This event fires when a the USB host issues a control\r
* request to the control endpoint (address 0) that the library does not handle. This may either\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 EVENT_USB_UnhandledControlPacket(void);\r
+ void EVENT_USB_Device_UnhandledControlRequest(void);\r
\r
/** Event for USB configuration number changed. This event fires when a the USB host changes the\r
* selected configuration number while in device mode. This event should be hooked in device\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
*/\r
- void EVENT_USB_ConfigurationChanged(void);\r
+ void EVENT_USB_Device_ConfigurationChanged(void);\r
\r
/** Event for USB suspend. This event fires when a the USB host suspends the device by halting its\r
* transmission of Start Of Frame pulses to the device. This is generally hooked in order to move\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
*\r
- * \see \ref EVENT_USB_WakeUp() event for accompanying Wake Up event.\r
+ * \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.\r
*/\r
- void EVENT_USB_Suspend(void);\r
+ void EVENT_USB_Device_Suspend(void);\r
\r
/** Event for USB wake up. This event fires when a the USB interface is suspended while in device\r
* mode, and the host wakes up the device by supplying Start Of Frame pulses. This is generally\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
*\r
- * \see \ref EVENT_USB_Suspend() event for accompanying Suspend event.\r
+ * \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.\r
*/\r
- void EVENT_USB_WakeUp(void);\r
+ void EVENT_USB_Device_WakeUp(void);\r
\r
/** Event for USB interface reset. This event fires when the USB interface is in device mode, and\r
* a the USB host requests that the device reset its interface. This event fires after the control\r
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see\r
* \ref Group_USBManagement documentation).\r
*/\r
- void EVENT_USB_Reset(void);\r
+ void EVENT_USB_Device_Reset(void);\r
#endif\r
\r
/* Private Interface - For use in library only: */\r
/* Function Prototypes: */\r
#if defined(INCLUDE_FROM_EVENTS_C)\r
void USB_Event_Stub(void) ATTR_CONST;\r
-\r
- #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR))\r
- void EVENT_USB_VBUSChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_VBUSConnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_VBUSDisconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- #endif\r
\r
- void EVENT_USB_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- \r
#if defined(USB_CAN_BE_BOTH)\r
void EVENT_USB_InitFailure(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
void EVENT_USB_UIDChange(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
#endif\r
\r
#if defined(USB_CAN_BE_HOST)\r
- void EVENT_USB_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+ void EVENT_USB_Host_HostError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Host_DeviceAttached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Host_DeviceUnattached(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Host_DeviceEnumerationComplete(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
#endif\r
\r
- void EVENT_USB_UnhandledControlPacket(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
- void EVENT_USB_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ #if defined(USB_CAN_BE_DEVICE)\r
+ void EVENT_USB_Device_Connect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Device_Disconnect(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Device_UnhandledControlRequest(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Device_ConfigurationChanged(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Device_Suspend(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Device_WakeUp(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ void EVENT_USB_Device_Reset(void) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
+ #endif\r
#endif\r
#endif\r
\r
projects / pub / lufa.git / blobdiff