* 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 \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
+ * Events can be hooked by the user application by declaring a handler function with the same name and parameters\r
+ * listed here. If an event with no user-associated handler is fired within the library, it by default maps to an\r
+ * internal empty stub function. This is achieved through the use of the GCC compiler's "alias" attribute.\r
*\r
* Each event must only have one associated event handler, but can be raised by multiple sources.\r
*\r
extern "C" {\r
#endif\r
\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** Raises a given event name, with the specified parameters. For events with no parameters the\r
- * only argument to the macro is the event name, events with parameters list the parameter values\r
- * after the name as a comma separated list.\r
- *\r
- * When a given event is fired, its corresponding event handler code is executed.\r
- *\r
- * Usage Examples:\r
- * \code\r
- * // Raise the USB_VBUSChange event, which takes no parameters\r
- * RAISE_EVENT(USB_VBUSChange);\r
- *\r
- * // Raise the USB_UnhandledControlPacket event which takes two parameters\r
- * RAISE_EVENT(USB_UnhandledControlPacket, 0, 1);\r
- * \endcode\r
- *\r
- * \see RAISES_EVENT()\r
- */\r
- #define RAISE_EVENT(e, ...) Event_ ## e (__VA_ARGS__)\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 \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
- * \code\r
- * // Module can raise the USB_VBUSChange event\r
- * RAISES_EVENT(USB_VBUSChange);\r
- *\r
- * // ...\r
- * // Inside a block of code in a function of the module, raise the USB_VBUSChange event\r
- * RAISE_EVENT(USB_VBUSChange);\r
- * \endcode\r
- *\r
- * \see RAISE_EVENT()\r
- */\r
- #define RAISES_EVENT(e) HANDLES_EVENT(e)\r
-\r
- /** Defines an event handler for the given event. Event handlers should be short in length, as they\r
- * may be raised from inside an ISR. The user application can react to each event as it sees fit,\r
- * such as logging the event, indicating the change to the user or performing some other action.\r
- *\r
- * Only one event handler may be defined in any user project for each individual event. Events may\r
- * or may not have parameters - for each event, refer to its documentation elsewhere in this module\r
- * to determine the presence and purpose of any event parameters.\r
- *\r
- * Usage Example:\r
- * \code\r
- * // Create an event handler for the USB_VBUSChange event\r
- * EVENT_HANDLER(USB_VBUSChange)\r
- * {\r
- * // Code to execute when the VBUS level changes\r
- * }\r
- * \endcode\r
- *\r
- * \see HANDLES_EVENT()\r
- */\r
- #define EVENT_HANDLER(e) void Event_ ## e e ## _P\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 \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
- * \code\r
- * // Module handles the USB_VBUSChange event\r
- * HANDLES_EVENT(USB_VBUSChange);\r
- *\r
- * // Create the USB_VBUSChange event handler\r
- * EVENT_HANDLER(USB_VBUSChange)\r
- * {\r
- * // Event handler code here\r
- * }\r
- * \endcode\r
- *\r
- * \see EVENT_HANDLER()\r
- */\r
- #define HANDLES_EVENT(e) EVENT_HANDLER(e)\r
- \r
+ /* Public Interface - May be used in end-application: */ \r
/* Pseudo-Functions for Doxygen: */\r
- #if defined(__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.\r
*\r
* \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
*/\r
- void USB_VBUSChange(void);\r
+ void EVENT_USB_VBUSChange(void);\r
\r
/** Event for VBUS attachment. This event fires when the VBUS line of the USB AVR changes from\r
* low to high, signalling the attachment of the USB device to a host, before the enumeration\r
*\r
* \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
*/\r
- void USB_VBUSConnect(void);\r
+ void EVENT_USB_VBUSConnect(void);\r
\r
/** Event for VBUS detachment. This event fires when the VBUS line of the USB AVR changes from\r
* high to low, signalling the USB device has been removed from a host whether it has been enumerated\r
*\r
* \note This event is only available on USB AVR models which support VBUS notification interrupts.\r
*/\r
- void USB_VBUSDisconnect(void);\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
* 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 \ref RAISE_EVENT(), and the \ref USB_IsConnected global changed manually.\r
+ * and disconnection events may be manually fired, 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
- void USB_Connect(void);\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
* 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 \ref RAISE_EVENT(), and the \ref USB_IsConnected global changed manually.\r
+ * and disconnection events may be manually fired, 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
- void USB_Disconnect(void);\r
+ void EVENT_USB_Disconnect(void);\r
\r
/** Event for USB initialization failure. This event fires when the USB interface fails to\r
* initialize correctly due to a hardware or software fault.\r
* \note This event only exists on USB AVR models which support dual role modes.\r
*\r
* \param ErrorCode Error code indicating the failure reason, a value in \ref USB_InitErrorCodes_t\r
- * located in LowLevel.h.\r
*/\r
- void USB_InitFailure(const uint8_t ErrorCode);\r
+ void EVENT_USB_InitFailure(const uint8_t ErrorCode);\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
* \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied\r
* to the compiler (see \ref Group_USBManagement documentation).\r
*/\r
- void USB_UIDChange(void);\r
+ void EVENT_USB_UIDChange(void);\r
\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 \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
* \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 USB_HostError(const uint8_t ErrorCode);\r
+ void EVENT_USB_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 USB_Connect event and so can be used to programmatically start the USB management\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
*\r
* \note This event only exists on USB AVR models which supports host mode.\r
*\r
* \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.\r
*/\r
- void USB_DeviceAttached(void);\r
+ void EVENT_USB_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 TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.\r
*/\r
- void USB_DeviceUnattached(void);\r
+ void EVENT_USB_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
*\r
* \param ErrorCode Error code indicating the failure reason, a value in \r
- * \ref USB_Host_EnumerationErrorCodes_t located in Host.h.\r
+ * \ref USB_Host_EnumerationErrorCodes_t\r
*\r
* \param SubErrorCode Sub error code indicating the reason for failure - for example, if the\r
* ErrorCode parameter indicates a control error, this will give the error\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 USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
+ void EVENT_USB_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
*/\r
- void USB_DeviceEnumerationComplete(void);\r
+ void EVENT_USB_DeviceEnumerationComplete(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 USB_UnhandledControlPacket(void);\r
+ void EVENT_USB_UnhandledControlPacket(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 USB_ConfigurationChanged(void);\r
+ void EVENT_USB_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 USB_WakeUp() event for accompanying Wake Up event.\r
+ * \see \ref EVENT_USB_WakeUp() event for accompanying Wake Up event.\r
*/\r
- void USB_Suspend(void);\r
+ void EVENT_USB_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 USB_Suspend() event for accompanying Suspend event.\r
+ * \see \ref EVENT_USB_Suspend() event for accompanying Suspend event.\r
*/\r
- void USB_WakeUp(void);\r
+ void EVENT_USB_WakeUp(void);\r
\r
/** Event for USB interface reset. This event fires when a the USB interface is in device mode, and\r
* a the USB host requests that the device reset its interface. This is generally hooked so that\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 USB_Reset(void);\r
+ void EVENT_USB_Reset(void);\r
\r
/** Event for USB device mode error. This event fires when the USB interface is in device mode,\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
- * \ref USB_Device_ErrorCodes_t enum located in Device.h.\r
+ * \param ErrorCode Error code indicating the source of the error, a value in\r
+ * \ref USB_Device_ErrorCodes_t\r
*\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 USB_DeviceError(const uint8_t ErrorCode);\r
+ void EVENT_USB_DeviceError(const uint8_t ErrorCode);\r
#endif\r
\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define ALIAS_STUB(e) EVENT_HANDLER(e) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub)\r
- \r
- #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)\r
- #define USB_VBUSChange_P (void)\r
- #define USB_VBUSConnect_P (void)\r
- #define USB_VBUSDisconnect_P (void)\r
- #endif\r
- \r
- #define USB_Connect_P (void)\r
- #define USB_Disconnect_P (void)\r
- #define USB_DeviceEnumerationComplete_P (void)\r
- \r
- #if defined(USB_CAN_BE_BOTH)\r
- #define USB_InitFailure_P (const uint8_t ErrorCode)\r
- #define USB_UIDChange_P (void)\r
- #endif\r
-\r
- #if defined(USB_CAN_BE_HOST)\r
- #define USB_HostError_P (const uint8_t ErrorCode)\r
- #define USB_DeviceAttached_P (void)\r
- #define USB_DeviceUnattached_P (void)\r
- #define USB_DeviceEnumerationFailed_P (const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
- #endif\r
- \r
- #if defined(USB_CAN_BE_DEVICE)\r
- #define USB_UnhandledControlPacket_P (void)\r
- #define USB_ConfigurationChanged_P (void)\r
- #define USB_Suspend_P (void)\r
- #define USB_WakeUp_P (void)\r
- #define USB_Reset_P (void)\r
- #define USB_DeviceError_P (const uint8_t ErrorCode)\r
- #endif\r
-\r
/* Function Prototypes: */\r
#if defined(INCLUDE_FROM_EVENTS_C)\r
void USB_Event_Stub(void) ATTR_CONST;\r
\r
#if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER)\r
- ALIAS_STUB(USB_VBUSChange);\r
- ALIAS_STUB(USB_VBUSConnect);\r
- ALIAS_STUB(USB_VBUSDisconnect);\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
- ALIAS_STUB(USB_Connect);\r
- ALIAS_STUB(USB_Disconnect);\r
- ALIAS_STUB(USB_DeviceEnumerationComplete);\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
- ALIAS_STUB(USB_InitFailure);\r
- ALIAS_STUB(USB_UIDChange);\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
- ALIAS_STUB(USB_HostError);\r
- ALIAS_STUB(USB_DeviceAttached);\r
- ALIAS_STUB(USB_DeviceUnattached);\r
- ALIAS_STUB(USB_DeviceEnumerationFailed);\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
+ ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
#endif\r
\r
- #if defined(USB_CAN_BE_DEVICE)\r
- ALIAS_STUB(USB_UnhandledControlPacket);\r
- ALIAS_STUB(USB_ConfigurationChanged);\r
- ALIAS_STUB(USB_Suspend);\r
- ALIAS_STUB(USB_WakeUp);\r
- ALIAS_STUB(USB_Reset);\r
- ALIAS_STUB(USB_DeviceError);\r
- #endif\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
+ void EVENT_USB_DeviceError(const uint8_t ErrorCode) ATTR_WEAK ATTR_ALIAS(USB_Event_Stub);\r
#endif\r
#endif\r
\r
projects / pub / USBasp.git / blobdiff