#include <avr/pgmspace.h>
#include <stdbool.h>
#include "../../../Common/Common.h"
#include "../LowLevel/USBMode.h"
#include "Events.h"
All standard descriptors have their elements named in an identical manner to the official USB specification, however slightly more verbose alternate (non-standard) names are also supplied if the macro USE_NONSTANDARD_DESCRIPTOR_NAMES is defined in the user project makefile and passed to the compiler at compilation time using the -D option.
The non-standard names are documented here - if USE_NONSTANDARD_DESCRIPTOR_NAMES is not defined, then all descriptors will contain elements named identically to the official USB specification. The alternately named descriptor elements are placed in the same order inside the descriptor structures as their officially named counterparts, thus they can be correlated easily with the official USB specification.
#define DESCRIPTOR_ADDRESS | ( | Descriptor | ) | ((void*)&Descriptor) |
Gives a void pointer to the specified descriptor (of any type).
#define ENDPOINT_ATTR_ADAPTIVE (0b10 << 2) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is adaptive.
#define ENDPOINT_ATTR_ASYNC (0b01 << 2) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is asynchronous.
#define ENDPOINT_ATTR_NO_SYNC (0b00 << 2) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is not synchronized.
#define ENDPOINT_ATTR_SYNC (0b11 << 2) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is synchronized.
#define ENDPOINT_DESCRIPTOR_DIR_IN 0x80 |
Can be masked with an endpoint address for a USB_Descriptor_Endpoint_t endpoint descriptor's EndpointAddress value to indicate to the host that the endpoint is of the IN direction (i.e, from device to host).
#define ENDPOINT_DESCRIPTOR_DIR_OUT 0x00 |
Can be masked with an endpoint address for a USB_Descriptor_Endpoint_t endpoint descriptor's EndpointAddress value to indicate to the host that the endpoint is of the OUT direction (i.e, from host to device).
#define ENDPOINT_USAGE_DATA (0b00 << 4) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is used for data transfers.
#define ENDPOINT_USAGE_FEEDBACK (0b01 << 4) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is used for feedback.
#define ENDPOINT_USAGE_IMPLICIT_FEEDBACK (0b10 << 4) |
Can be masked with other endpoint descriptor attributes for a USB_Descriptor_Endpoint_t descriptor's Attributes value to indicate that the specified endpoint is used for implicit feedback.
#define LANGUAGE_ID_ENG 0x0409 |
String language ID for the English language. Should be used in USB_Descriptor_Language_t descriptors to indicate that the English language is supported by the device in its string descriptors.
#define NO_DESCRIPTOR 0 |
Indicates that a given descriptor does not exist in the device. This can be used inside descriptors for string descriptor indexes, or may be use as a return value for GetDescriptor when the specified descriptor does not exist.
#define USB_CONFIG_ATTR_BUSPOWERED 0b10000000 |
Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power from the host's VBUS line.
#define USB_CONFIG_ATTR_REMOTEWAKEUP 0b10100000 |
Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t descriptor's ConfigAttributes value to indicate that the specified configuration supports the remote wakeup feature of the USB standard, allowing a suspended USB device to wake up the host upon request.
#define USB_CONFIG_ATTR_SELFPOWERED 0b11000000 |
Can be masked with other configuration descriptor attributes for a USB_Descriptor_Configuration_Header_t descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power from the device's own power source.
#define USB_CONFIG_POWER_MA | ( | x | ) | (x >> 1) |
Macro to calculate the power value for the device descriptor, from a given number of milliamps.
#define USB_STRING_LEN | ( | x | ) | (sizeof(USB_Descriptor_Header_t) + (x << 1)) |
Macro to calculate the Unicode length of a string with a given number of Unicode characters. Should be used in string descriptor's headers for giving the string descriptor's byte length.
#define VERSION_BCD | ( | x | ) |
Value:
((((VERSION_TENS(x) << 4) | VERSION_ONES(x)) << 8) | \ ((VERSION_TENTHS(x) << 4) | VERSION_HUNDREDTHS(x)))
Enum for the possible standard descriptor types, as given in each descriptor's header.
RAISES_EVENT | ( | USB_DeviceError | ) |
This module raises the Device Error event while in device mode, if the USB_GetDescriptor() routine is not hooked in the user application to properly return descriptors to the library.
uint16_t USB_GetDescriptor | ( | const uint16_t | wValue, | |
const uint8_t | wIndex, | |||
void **const | DescriptorAddress | |||
) |
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 except for the ATTR_WEAK attribute) so that the library can call it to retrieve descriptor data.
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. | |
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. | |
DescriptorAddress | Pointer to the descriptor in memory. This should be set by the routine to the location of the descriptor, found by the DESCRIPTOR_ADDRESS macro. |