projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix newly renamed VirtualSerial demos' include filename references so that they compile.
[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Device.h
diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h
index c6e5f7f..acffd80 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Device.h
+++ b/LUFA/Drivers/USB/LowLevel/Device.h
@@ -27,11 +27,14 @@
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\r
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\r
-\r
-/** \file\r
+ \r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_Device Device Management\r
  *\r
  *  USB Device mode related macros and enums. This module contains macros and enums which are used when\r
  *  the USB controller is initialized in device mode.\r
  *\r
  *  USB Device mode related macros and enums. This module contains macros and enums which are used when\r
  *  the USB controller is initialized in device mode.\r
+ *\r
+ *  @{\r
  */\r
 \r
 #ifndef __USBDEVICE_H__\r
  */\r
 \r
 #ifndef __USBDEVICE_H__\r
@@ -45,10 +48,15 @@
                #include "../HighLevel/StdDescriptors.h"\r
                #include "Endpoint.h"\r
 \r
                #include "../HighLevel/StdDescriptors.h"\r
                #include "Endpoint.h"\r
 \r
+       /* Preprocessor Checks: */\r
+               #if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))\r
+                       #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.\r
+               #endif\r
+                       \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
-                       #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r
-                               /** Mask for the Options parameter of the USB_Init() function. This indicates that the\r
+                       #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)\r
+                               /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the\r
                                 *  USB interface should be initialized in low speed (1.5Mb/s) mode.\r
                                 *\r
                                 *  \note Low Speed mode is not available on all USB AVR models.\r
                                 *  USB interface should be initialized in low speed (1.5Mb/s) mode.\r
                                 *\r
                                 *  \note Low Speed mode is not available on all USB AVR models.\r
@@ -64,63 +72,137 @@
                         */\r
                        #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)\r
                        \r
                         */\r
                        #define USB_DEVICE_OPT_FULLSPEED               (0 << 0)\r
                        \r
-                       /** Sends a Remote Wakeup request to the host. This signals to the host that the device should\r
-                        *  be taken out of suspended mode, and communications should resume.\r
-                        *\r
-                        *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the\r
-                        *  host computer when the host has suspended all USB devices to enter a low power state.\r
-                        *\r
-                        *  \note This macro should only be used if the device has indicated to the host that it\r
-                        *        supports the Remote Wakeup feature in the device descriptors, and should only be\r
-                        *        issued if the host is currently allowing remote wakeup events from the device (i.e.,\r
-                        *        the USB_RemoteWakeupEnabled flag is set, see DevChapter9.h documentation).\r
-                        *\r
-                        *  \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.\r
-                        */\r
-                       #define USB_Device_SendRemoteWakeup()   MACROS{ UDCON |= (1 << RMWKUP); }MACROE\r
+               /* Pseudo-Function Macros: */\r
+                       #if defined(__DOXYGEN__)\r
+                               /** Sends a Remote Wakeup request to the host. This signals to the host that the device should\r
+                                *  be taken out of suspended mode, and communications should resume.\r
+                                *\r
+                                *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the\r
+                                *  host computer when the host has suspended all USB devices to enter a low power state.\r
+                                *\r
+                                *  \note This macro should only be used if the device has indicated to the host that it\r
+                                *        supports the Remote Wakeup feature in the device descriptors, and should only be\r
+                                *        issued if the host is currently allowing remote wakeup events from the device (i.e.,\r
+                                *        the \ref USB_RemoteWakeupEnabled flag is set).\r
+                                *\r
+                                *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.\r
+                                */\r
+                               static inline void USB_Device_SendRemoteWakeup(void);\r
+                               \r
+                               /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a\r
+                                *  remote wakeup is currently being sent, false otherwise.\r
+                                *\r
+                                *  This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if\r
+                                *  a sent RMWAKEUP request was accepted or rejected by the host.\r
+                                *\r
+                                *  \note This macro should only be used if the device has indicated to the host that it\r
+                                *        supports the Remote Wakeup feature in the device descriptors.\r
+                                *\r
+                                *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.\r
+                                *\r
+                                *  \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise\r
+                                */\r
+                               static inline bool USB_Device_IsRemoteWakeupSent(void);\r
+                               \r
+                               /** Indicates if the device is currently suspended by the host. Whilst suspended, the device is\r
+                                *  to enter a low power state until resumed by the host. No USB traffic to or from the device\r
+                                *  can occur (except for Remote Wakeup requests) during suspension by the host.\r
+                                *\r
+                                *  \return Boolean true if the USB communications have been suspended by the host, false otherwise.\r
+                                */\r
+                               static inline bool USB_Device_IsUSBSuspended(void);\r
+                               \r
+                               /** Enables the device mode Start Of Frame events. When enabled, this causes the\r
+                                *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,\r
+                                *  at the start of each USB frame when enumerated in device mode.\r
+                                */\r
+                               static inline bool USB_Device_EnableSOFEvents(void);\r
+                               \r
+                               /** Disables the device mode Start Of Frame events. When disabled, this stop the firing of the\r
+                                *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.\r
+                                */\r
+                               static inline bool USB_Device_DisableSOFEvents(void);\r
+                       #else\r
+                               #define USB_Device_SendRemoteWakeup()   MACROS{ UDCON |= (1 << RMWKUP); }MACROE\r
 \r
 \r
-                       /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a\r
-                        *  remote wakeup is currently being sent, false otherwise.\r
-                        *\r
-                        *  This can be used in conjunction with the USB_Device_IsUSBSuspended() macro to determine if\r
-                        *  a sent RMWAKEUP request was accepted or rejected by the host.\r
-                        *\r
-                        *  \note This macro should only be used if the device has indicated to the host that it\r
-                        *        supports the Remote Wakeup feature in the device descriptors.\r
-                        *\r
-                        *  \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.\r
-                        */\r
-                       #define USB_Device_IsRemoteWakeupSent()       ((UDCON &  (1 << RMWKUP)) ? false : true)\r
+                               #define USB_Device_IsRemoteWakeupSent()       ((UDCON &  (1 << RMWKUP)) ? false : true)\r
 \r
 \r
-                       /** Indicates if the device is currently suspended by the host. While suspended, the device is\r
-                        *  to enter a low power state until resumed by the host. While suspended no USB traffic to or\r
-                        *  from the device can occur (except for Remote Wakeup requests).\r
-                        *\r
-                        *  This macro returns true if the USB communications have been suspended by the host, false\r
-                        *  otherwise.\r
-                        */\r
-                       #define USB_Device_IsUSBSuspended()           ((UDINT &  (1 << SUSPI)) ? true : false)\r
+                               #define USB_Device_IsUSBSuspended()           ((UDINT &  (1 << SUSPI)) ? true : false)\r
+                               \r
+                               #define USB_Device_EnableSOFEvents()    MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE\r
 \r
 \r
-               /* Enums: */\r
-                       /** Enum for the ErrorCode parameter of the USB_DeviceError event.\r
-                        *\r
-                        *  \see Events.h for more information on this event.\r
-                        */\r
-                       enum USB_Device_ErrorCodes_t\r
+                               #define USB_Device_DisableSOFEvents()   MACROS{ USB_INT_Disable(USB_INT_SOFI); }MACROE\r
+                       #endif\r
+                       \r
+               /* Type Defines: */\r
+                       enum USB_Device_States_t\r
                        {\r
                        {\r
-                               DEVICE_ERROR_GetDescriptorNotHooked        = 0, /**< Indicates that the GetDescriptor() method\r
-                                                                                *   has not been hooked by the user application.\r
-                                                                                *\r
-                                                                                *   \see StdDescriptors.h for more information on\r
-                                                                                *        the GetDescriptor() method.\r
-                                                                                */\r
+                               DEVICE_STATE_Unattached                   = 0, /**< Internally implemented by the library. This state indicates\r
+                                                                               *   that the device is not currently connected to a host.\r
+                                                                               */\r
+                               DEVICE_STATE_Powered                      = 1, /**< Internally implemented by the library. This state indicates\r
+                                                                               *   that the device is connected to a host, but enumeration has not\r
+                                                                               *   yet begun.\r
+                                                                               */\r
+                               DEVICE_STATE_Default                      = 2, /**< Internally implemented by the library. This state indicates\r
+                                                                               *   that the device's USB bus has been reset by the host and it is\r
+                                                                               *   now waiting for the host to begin the enumeration process.\r
+                                                                               */\r
+                               DEVICE_STATE_Addressed                    = 3, /**< Internally implemented by the library. This state indicates\r
+                                                                               *   that the device has been addressed by the USB Host, but is not\r
+                                                                               *   yet configured.\r
+                                                                               */\r
+                               DEVICE_STATE_Configured                   = 4, /**< May be implemented by the user project. This state indicates\r
+                                                                               *   that the device has been enumerated by the host and is ready\r
+                                                                               *   for USB communications to begin.\r
+                                                                               */\r
+                               DEVICE_STATE_Suspended                    = 5, /**< May be implemented by the user project. This state indicates\r
+                                                                               *   that the USB bus has been suspended by the host, and the device\r
+                                                                               *   should power down to a minimal power level until the bus is\r
+                                                                               *   resumed.\r
+                                                                               */\r
                        };\r
                        };\r
+                       \r
+               /* Function Prototypes: */\r
+                       /** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,\r
+                        *  index and language ID. This function MUST be overridden in the user application (added with full, identical  \r
+                        *  prototype and name so that the library can call it to retrieve descriptor data.\r
+                        *\r
+                        *  \param[in] wValue  The type of the descriptor to retrieve in the upper byte, and the index in the \r
+                        *                     lower byte (when more than one descriptor of the given type exists, such as the\r
+                        *                     case of string descriptors). The type may be one of the standard types defined\r
+                        *                     in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.\r
+                        *  \param[in] wIndex  The language ID of the string to return if the wValue type indicates DTYPE_String,\r
+                        *                     otherwise zero for standard descriptors, or as defined in a class-specific\r
+                        *                     standards.\r
+                        *  \param[out] DescriptorAddress  Pointer to the descriptor in memory. This should be set by the routine to\r
+                        *                                 the address of the descriptor.\r
+                        *  \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory\r
+                        *                                 space in which the descriptor is stored. This parameter does not exist when one\r
+                        *                                 of the USE_*_DESCRIPTORS compile time options is used.\r
+                        *\r
+                        *  \note By default, the library expects all descriptors to be located in flash memory via the PROGMEM attribute.\r
+                        *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to\r
+                        *        allow the descriptors to be changed dynamically at runtime) either the USE_RAM_DESCRIPTORS or the \r
+                        *        USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D\r
+                        *        switch.\r
+                        *\r
+                        *  \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise\r
+                        */\r
+                       uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress\r
+                       #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)\r
+                                                           , uint8_t* MemoryAddressSpace\r
+                       #endif                  \r
+                                                           )\r
+                                                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */           \r
                        #define USB_Device_SetLowSpeed()        MACROS{ UDCON |=  (1 << LSM);   }MACROE\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */           \r
                        #define USB_Device_SetLowSpeed()        MACROS{ UDCON |=  (1 << LSM);   }MACROE\r
-                       #define USB_Device_SetHighSpeed()       MACROS{ UDCON &= ~(1 << LSM);   }MACROE\r
+                       #define USB_Device_SetFullSpeed()       MACROS{ UDCON &= ~(1 << LSM);   }MACROE\r
        #endif\r
        #endif\r
-       \r
+\r
 #endif\r
 #endif\r
+\r
+/** @} */\r
USB isp AVR programmer