X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/328ed71ce728de4a6633d981441ac9837c9cd62a..d36c96d6a526f74e3853466bcecf49261c58b9bd:/LUFA/Drivers/USB/LowLevel/Device.h?ds=sidebyside diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 7f9d540bf..2f54d1dd4 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -50,11 +50,13 @@ #define __USBDEVICE_H__ /* Includes: */ + #include #include #include #include "../../../Common/Common.h" #include "../HighLevel/StdDescriptors.h" + #include "USBInterrupt.h" #include "Endpoint.h" /* Preprocessor Checks: */ @@ -73,84 +75,40 @@ * USB interface should be initialized in low speed (1.5Mb/s) mode. * * \note Low Speed mode is not available on all USB AVR models. - * \n\n + * \n * * \note Restrictions apply on the number, size and type of endpoints which can be used - * when running in low speed mode -- refer to the USB 2.0 standard. + * when running in low speed mode - refer to the USB 2.0 specification. */ #define USB_DEVICE_OPT_LOWSPEED (1 << 0) #endif - /** Mask for the Options parameter of the USB_Init() function. This indicates that the + /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the * USB interface should be initialized in full speed (12Mb/s) mode. */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0) - - /* Pseudo-Function Macros: */ - #if defined(__DOXYGEN__) - /** Sends a Remote Wakeup request to the host. This signals to the host that the device should - * be taken out of suspended mode, and communications should resume. - * - * Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the - * host computer when the host has suspended all USB devices to enter a low power state. - * - * \note This macro should only be used if the device has indicated to the host that it - * supports the Remote Wakeup feature in the device descriptors, and should only be - * issued if the host is currently allowing remote wakeup events from the device (i.e., - * the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile - * time option is used, this macro is unavailable. - * - * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors. - */ - static inline void USB_Device_SendRemoteWakeup(void); - - /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a - * remote wakeup is currently being sent, false otherwise. - * - * This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if - * a sent RMWAKEUP request was accepted or rejected by the host. - * - * \note This macro should only be used if the device has indicated to the host that it - * supports the Remote Wakeup feature in the device descriptors. When the NO_DEVICE_REMOTE_WAKEUP - * compile time option is used, this macro is unavailable. - * - * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors. - * - * \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise - */ - static inline bool USB_Device_IsRemoteWakeupSent(void); - - /** Indicates if the device is currently suspended by the host. Whilst suspended, the device is - * to enter a low power state until resumed by the host. No USB traffic to or from the device - * can occur (except for Remote Wakeup requests) during suspension by the host. - * - * \return Boolean true if the USB communications have been suspended by the host, false otherwise. - */ - static inline bool USB_Device_IsUSBSuspended(void); - - /** Enables the device mode Start Of Frame events. When enabled, this causes the - * \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, - * at the start of each USB frame when enumerated in device mode. - */ - static inline bool USB_Device_EnableSOFEvents(void); - - /** Disables the device mode Start Of Frame events. When disabled, this stop the firing of the - * \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode. - */ - static inline bool USB_Device_DisableSOFEvents(void); - #else - #if !defined(NO_DEVICE_REMOTE_WAKEUP) - #define USB_Device_SendRemoteWakeup() MACROS{ UDCON |= (1 << RMWKUP); }MACROE - #define USB_Device_IsRemoteWakeupSent() ((UDCON & (1 << RMWKUP)) ? false : true) - #endif - - #define USB_Device_IsUSBSuspended() ((UDINT & (1 << SUSPI)) ? true : false) - - #define USB_Device_EnableSOFEvents() MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE - - #define USB_Device_DisableSOFEvents() MACROS{ USB_INT_Disable(USB_INT_SOFI); }MACROE - #endif + /* Function Prototypes: */ + /** Sends a Remote Wakeup request to the host. This signals to the host that the device should + * be taken out of suspended mode, and communications should resume. + * + * Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the + * host computer when the host has suspended all USB devices to enter a low power state. + * + * \note This macro should only be used if the device has indicated to the host that it + * supports the Remote Wakeup feature in the device descriptors, and should only be + * issued if the host is currently allowing remote wakeup events from the device (i.e., + * the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile + * time option is used, this macro is unavailable. + * \n\n + * + * \note The USB clock must be running for this function to operate. If the stack is initialized with + * the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running + * before attempting to call this function. + * + * \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors. + */ + void USB_Device_SendRemoteWakeup(void); /* Type Defines: */ enum USB_Device_States_t @@ -181,6 +139,34 @@ */ }; + /* Inline Functions: */ + /** Returns the current USB frame number, when in device mode. Every millisecond the USB bus is active (i.e. enumerated to a host) + * the frame number is incremented by one. + */ + static inline uint16_t USB_Device_GetFrameNumber(void) + { + return UDFNUM; + } + + /** Enables the device mode Start Of Frame events. When enabled, this causes the + * \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, + * at the start of each USB frame when enumerated in device mode. + */ + static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE; + static inline void USB_Device_EnableSOFEvents(void) + { + USB_INT_Enable(USB_INT_SOFI); + } + + /** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the + * \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode. + */ + static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE; + static inline void USB_Device_DisableSOFEvents(void) + { + USB_INT_Disable(USB_INT_SOFI); + } + /* Function Prototypes: */ /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value, * index and language ID. This function MUST be overridden in the user application (added with full, identical @@ -205,20 +191,45 @@ * USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D * switch. * - * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise + * \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise. */ - uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress + uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, + const uint8_t wIndex, + const void** const DescriptorAddress #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS) , uint8_t* MemoryAddressSpace - #endif - ) - ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3); + #endif + ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3); /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) - /* Macros: */ - #define USB_Device_SetLowSpeed() MACROS{ UDCON |= (1 << LSM); }MACROE - #define USB_Device_SetFullSpeed() MACROS{ UDCON &= ~(1 << LSM); }MACROE + /* Inline Functions: */ + #if (defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)) + static inline void USB_Device_SetLowSpeed(void) ATTR_ALWAYS_INLINE; + static inline void USB_Device_SetLowSpeed(void) + { + UDCON |= (1 << LSM); + } + + static inline void USB_Device_SetFullSpeed(void) ATTR_ALWAYS_INLINE; + static inline void USB_Device_SetFullSpeed(void) + { + UDCON &= ~(1 << LSM); + } + #endif + + static inline void USB_Device_SetDeviceAddress(const uint8_t Address) ATTR_ALWAYS_INLINE; + static inline void USB_Device_SetDeviceAddress(const uint8_t Address) + { + UDADDR = ((UDADDR & (1 << ADDEN)) | (Address & 0x7F)); + UDADDR |= (1 << ADDEN); + } + + static inline bool USB_Device_IsAddressSet(void) ATTR_ALWAYS_INLINE; + static inline bool USB_Device_IsAddressSet(void) + { + return (UDADDR & (1 << ADDEN)); + } #endif #endif