Defines | |
#define | USB_DEVICE_OPT_LOWSPEED (1 << 0) |
#define | USB_DEVICE_OPT_FULLSPEED (0 << 0) |
Enumerations | |
enum | USB_DescriptorMemorySpaces_t { MEMSPACE_FLASH = 0, MEMSPACE_EEPROM = 1, MEMSPACE_RAM = 2 } |
enum | USB_Device_States_t { DEVICE_STATE_Unattached = 0, DEVICE_STATE_Powered = 1, DEVICE_STATE_Default = 2, DEVICE_STATE_Addressed = 3, DEVICE_STATE_Configured = 4, DEVICE_STATE_Suspended = 5 } |
Functions | |
static void | USB_Device_SendRemoteWakeup (void) |
static bool | USB_Device_IsRemoteWakeupSent (void) |
static bool | USB_Device_IsUSBSuspended (void) |
uint16_t | CALLBACK_USB_GetDescriptor (const uint16_t wValue, const uint8_t wIndex, void **const DescriptorAddress, uint8_t *MemoryAddressSpace) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3) |
Variables | |
volatile uint8_t | USB_DeviceState |
uint8_t | USB_ConfigurationNumber |
bool | USB_RemoteWakeupEnabled |
bool | USB_CurrentlySelfPowered |
#define USB_DEVICE_OPT_FULLSPEED (0 << 0) |
Mask for the Options parameter of the USB_Init() function. This indicates that the USB interface should be initialized in full speed (12Mb/s) mode.
#define USB_DEVICE_OPT_LOWSPEED (1 << 0) |
Mask for the Options parameter of the USB_Init() function. This indicates that the USB interface should be initialized in low speed (1.5Mb/s) mode.
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.
Enum for the possible descriptor memory spaces, for the MemoryAddressSpace of the CALLBACK_USB_GetDescriptor() function. This can be used when none of the USE_*_DESCRIPTORS compile time options are used, to indicate in which memory space the descriptor is stored.
enum USB_Device_States_t |
uint16_t CALLBACK_USB_GetDescriptor | ( | const uint16_t | wValue, | |
const uint8_t | wIndex, | |||
void **const | DescriptorAddress, | |||
uint8_t * | MemoryAddressSpace | |||
) |
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 prototype and name so that the library can call it to retrieve descriptor data.
[in] | wValue | The type of the descriptor to retrieve in the upper byte, and the index in the lower byte (when more than one descriptor of the given type exists, such as the case of string descriptors). The type may be one of the standard types defined in the DescriptorTypes_t enum, or may be a class-specific descriptor type value. |
[in] | wIndex | The language ID of the string to return if the wValue type indicates DTYPE_String, otherwise zero for standard descriptors, or as defined in a class-specific standards. |
[out] | DescriptorAddress | Pointer to the descriptor in memory. This should be set by the routine to the address of the descriptor. |
[out] | MemoryAddressSpace | A value from the USB_DescriptorMemorySpaces_t enum to indicate the memory space in which the descriptor is stored. This parameter does not exist when one of the USE_*_DESCRIPTORS compile time options is used. |
static bool USB_Device_IsRemoteWakeupSent | ( | void | ) | [inline, static] |
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 USB_Device_IsUSBSuspended() macro to determine if a sent RMWAKEUP request was accepted or rejected by the host.
static bool USB_Device_IsUSBSuspended | ( | void | ) | [inline, static] |
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.
static void USB_Device_SendRemoteWakeup | ( | void | ) | [inline, static] |
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.
uint8_t USB_ConfigurationNumber |
Indicates the currently set configuration number of the device. USB devices may have several different configurations which the host can select between; this indicates the currently selected value, or 0 if no configuration has been selected.
Indicates if the device is currently being powered by its own power supply, rather than being powered by the host's USB supply. This flag should remain cleared if the device does not support self powered mode, as indicated in the device descriptors.
volatile uint8_t USB_DeviceState |
Indicates the current device state machine state. When in device mode, this indicates the state via one of the values of the USB_Device_States_t enum values.
This value should not be altered by the user application as it is handled automatically by the library. The only exception to this rule is if the NO_LIMITED_CONTROLLER_CONNECT token is used (see EVENT_USB_Device_Connect() and EVENT_USB_Device_Disconnect() events).
To reduce program size and speed up checks of this global, it can be placed into one of the AVR's GPIOR hardware registers instead of RAM by defining the DEVICE_STATE_AS_GPIOR token to a value between 0 and 2 in the project makefile and passing it to the compiler via the -D switch. When defined, the corresponding GPIOR register should not be used in the user application except implicitly via the library APIs.
This variable should be treated as read-only in the user application, and never manually changed in value except in the circumstances outlined above.
Indicates if the host is currently allowing the device to issue remote wakeup events. If this flag is cleared, the device should not issue remote wakeup events to the host.