2.11 USB Device Stack Library

• struct USB_EP_STATIC_CONFIG_BITS_struct

  Static endpoint settings.

• struct endpointStaticConfig

  Configuration of static endpoint settings.

• struct USB_APPLICATION_CONFIGURATION1_struct

  USB Configuration, Interface and Endpoint descriptors for Config1.

• struct USB_APPLICATION_CONFIGURATION_struct

  USB Configuration, Interface and Endpoint descriptors.

• struct USB_APPLICATION_STRING_DESCRIPTORS_struct

  USB String descriptors.

• struct descriptorPointers

  Pointers to the standard USB descriptors.

• #define USB_EP_NUM 3U

  Limits the size of the endpoint table and transfer array in the RAM to 1 + the highest endpoint address used by the application.

• #define USB_EP0_SIZE 64U

  Controls the packet size of endpoint 0 and must correspond to bMaxPacketSize0 in the device descriptor.

• #define LANG_ID_NUM 1U

  Controls the number of language IDs supported by the application.

• #define USB_CDC_INTERRUPT_EP INTERFACE0ALTERNATE0_INTERRUPT_EP1_IN

  The address for the Communication Device Class (CDC) interrupt notification endpoint.

• #define USB_CDC_BULK_EP_IN INTERFACE1ALTERNATE0_BULK_EP2_IN

  The address for the CDC bulk IN endpoint.

• #define USB_CDC_BULK_EP_OUT INTERFACE1ALTERNATE0_BULK_EP2_OUT

  The address for the CDC bulk OUT endpoint.

• #define USB_CDC_DATA_ENDPOINT_SIZE INTERFACE1ALTERNATE0_BULK_EP2_OUT_SIZE

  Controls the size of the CDC data endpoints.

• #define USB_CDC_TX_BUFFER_SIZE (2*MAX_ENDPOINT_SIZE_DEFAULT)

  Macro for the transmit buffer size.

• #define USB_CDC_RX_BUFFER_SIZE (2*MAX_ENDPOINT_SIZE_DEFAULT)

  Macro for the receive buffer size.

• #define USB_CDC_RX_PACKET_SIZE USB_CDC_DATA_ENDPOINT_SIZE

  Macro for the receive packet size.

• #define USB_CDC_UNION_SUBORDINATE_NUM 0u

  Macro for the maximum number of configured subordinate interfaces of union functional descriptors.

• #define USB_HID_INTERRUPT_EP INTERFACE0ALTERNATE0_INTERRUPT_EP1_IN

  Macro for the interrupt endpoint.

• #define USB_HID_REPORT_DESCRIPTOR_SIZE 50U

  Macro for the Human Interface Devices (HID) report descriptor size.

• #define USB_INTERFACE_NUM 2U

  The number of interfaces used by a configuration, excluding alternate interfaces.

• #define LANG_EN_US 0x0409U

  Language ID String Descriptor, for English (US).

• #define STRING_MANUFACTURER L"Microchip Technology Inc."

  Manufacturer String descriptor.

• #define STRING_PRODUCT L"HID Class Demo"

  Product String descriptor.

• #define STRING_SERIAL L"1"

  Serial Number String descriptor.

• void USBDevice_Initialize (void)

  Initializes the USB device.

• RETURN_CODE_t USBDevice_Handle (void)

  Handles the USB stack events and in progress transfers for the USB stack to function.

• RETURN_CODE_t USBDevice_StatusGet (void)

  Returns the status of the USB device.

• void USBDevice_StartOfFrameCallbackRegister (USB_EVENT_CALLBACK_t cb)

  Registers a callback function handling the Start Of Frame (SOF) events.

• void USBDevice_SuspendCallbackRegister (USB_EVENT_CALLBACK_t cb)

  Registers a callback function handling the Suspend events.

• void USBDevice_WakeFromSuspendCallbackRegister (USB_EVENT_CALLBACK_t cb)

  Registers a callback function handling the Wake From Suspend events.

• void USBDevice_ResetCallbackRegister (USB_EVENT_CALLBACK_t cb)

  Registers a callback function handling the Reset events.

• void Vendor_InterfaceEnCallbackRegister (USB_SETUP_EVENT_CALLBACK_t cb)

  Registers the callback for the interface enable setup request handler.

• void Vendor_ControlReqCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t cb)

  Registers the callback for the control request handler.

• void HID_SetReportCallbackRegister (USB_HID_REPORT_CALLBACK_t cb)

  Registers the callback for the HID report handler.

#define LANG_EN_US 0x0409U

Language ID String Descriptor, for English (US).

#define LANG_ID_NUM 1U

Controls the number of language IDs supported by the application.

#define STRING_MANUFACTURER L"Microchip Technology Inc."

Manufacturer String descriptor.

#define STRING_PRODUCT L"HID Class Demo"

Product String descriptor.

#define STRING_SERIAL L"1"

Serial Number String descriptor.

#define USB_CDC_BULK_EP_IN INTERFACE1ALTERNATE0_BULK_EP2_IN

The address for the CDC bulk IN endpoint.

#define USB_CDC_BULK_EP_OUT INTERFACE1ALTERNATE0_BULK_EP2_OUT

The address for the CDC bulk OUT endpoint.

#define USB_CDC_DATA_ENDPOINT_SIZE INTERFACE1ALTERNATE0_BULK_EP2_OUT_SIZE

Controls the size of the CDC data endpoints.

#define USB_CDC_INTERRUPT_EP INTERFACE0ALTERNATE0_INTERRUPT_EP1_IN

The address for the Communication Device Class (CDC) interrupt notification endpoint.

#define USB_CDC_RX_BUFFER_SIZE (2*MAX_ENDPOINT_SIZE_DEFAULT)

Macro for the receive buffer size.

#define USB_CDC_RX_PACKET_SIZE USB_CDC_DATA_ENDPOINT_SIZE

Macro for the receive packet size.

#define USB_CDC_TX_BUFFER_SIZE (2*MAX_ENDPOINT_SIZE_DEFAULT)

Macro for the transmit buffer size.

#define USB_CDC_UNION_SUBORDINATE_NUM 0u

Macro for the maximum number of configured subordinate interfaces of union functional descriptors.

#define USB_EP0_SIZE 64U

Controls the packet size of endpoint 0 and must correspond to bMaxPacketSize0 in the device descriptor.

#define USB_EP_NUM 3U

Limits the size of the endpoint table and transfer array in the RAM to 1 + the highest endpoint address used by the application.

#define USB_HID_INTERRUPT_EP INTERFACE0ALTERNATE0_INTERRUPT_EP1_IN

Macro for the interrupt endpoint.

#define USB_HID_REPORT_DESCRIPTOR_SIZE 50U

Macro for the Human Interface Devices (HID) report descriptor size.

#define USB_INTERFACE_NUM 2U

The number of interfaces used by a configuration, excluding alternate interfaces.

void HID_SetReportCallbackRegister (USB_HID_REPORT_CALLBACK_t cb)

Registers the callback for the HID report handler.

RETURN_CODE_t USBDevice_Handle (void )

Handles the USB stack events and in progress transfers for the USB stack to function.

void USBDevice_Initialize (void )

Initializes the USB device.

void USBDevice_ResetCallbackRegister (USB_EVENT_CALLBACK_t cb)

Registers a callback function handling the Reset events.

void USBDevice_StartOfFrameCallbackRegister (USB_EVENT_CALLBACK_t cb)

Registers a callback function handling the Start Of Frame (SOF) events.

RETURN_CODE_t USBDevice_StatusGet (void )

Returns the status of the USB device.

void USBDevice_SuspendCallbackRegister (USB_EVENT_CALLBACK_t cb)

Registers a callback function handling the Suspend events.

void USBDevice_WakeFromSuspendCallbackRegister (USB_EVENT_CALLBACK_t cb)

Registers a callback function handling the Wake From Suspend events.

void Vendor_ControlReqCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t cb)

Registers the callback for the control request handler.

void Vendor_InterfaceEnCallbackRegister (USB_SETUP_EVENT_CALLBACK_t cb)

Registers the callback for the interface enable setup request handler.

• USB_CONFIGURATION_DESCRIPTOR_t Configuration

• USB_INTERFACE_DESCRIPTOR_t Interface0Alternate0

• USB_HID_DESCRIPTOR_t HID_Descriptor0

• USB_ENDPOINT_DESCRIPTOR_t Interface0Alternate0_Endpoint1IN

USB_CONFIGURATION_DESCRIPTOR_t Configuration

USB_HID_DESCRIPTOR_t HID_Descriptor0

USB_INTERFACE_DESCRIPTOR_t Interface0Alternate0

USB_ENDPOINT_DESCRIPTOR_t Interface0Alternate0_Endpoint1IN

• USB_APPLICATION_CONFIGURATION1_t Config1

USB_APPLICATION_CONFIGURATION1_t Config1

• USB_DESCRIPTOR_HEADER_t manufacturer_header

• wchar_t manufacturer [DESCRIPTOR_STRING_LENGTH(STRING_MANUFACTURER)]

• USB_DESCRIPTOR_HEADER_t product_header

• wchar_t product [DESCRIPTOR_STRING_LENGTH(STRING_PRODUCT)]

• USB_DESCRIPTOR_HEADER_t serial_header

• wchar_t serial [DESCRIPTOR_STRING_LENGTH(STRING_SERIAL)]

wchar_t manufacturer[DESCRIPTOR_STRING_LENGTH(STRING_MANUFACTURER)]

USB_DESCRIPTOR_HEADER_t manufacturer_header

wchar_t product[DESCRIPTOR_STRING_LENGTH(STRING_PRODUCT)]

USB_DESCRIPTOR_HEADER_t product_header

wchar_t serial[DESCRIPTOR_STRING_LENGTH(STRING_SERIAL)]

USB_DESCRIPTOR_HEADER_t serial_header

• uint8_t InMultipktEnable: 1

• uint8_t InAzlpEnable: 1

• uint8_t InTrncInterruptEnable: 1

• uint8_t OutMultipktEnable: 1

• uint8_t OutAzlpEnable: 1

• uint8_t OutTrncInterruptEnable: 1

• uint8_t reserved: 2

uint8_t InAzlpEnable

uint8_t InMultipktEnable

uint8_t InTrncInterruptEnable

uint8_t OutAzlpEnable

uint8_t OutMultipktEnable

uint8_t OutTrncInterruptEnable

uint8_t reserved

#define INTERFACE0ALTERNATE0_INTERRUPT_EP1_IN 1U

#define INTERFACE0ALTERNATE0_INTERRUPT_EP1_IN_SIZE 64U

#define INTERFACE1ALTERNATE0_BULK_EP2_IN 2U

#define INTERFACE1ALTERNATE0_BULK_EP2_IN_SIZE 16U

#define INTERFACE1ALTERNATE0_BULK_EP2_OUT 2U

#define INTERFACE1ALTERNATE0_BULK_EP2_OUT_SIZE 16U

typedef struct USB_EP_STATIC_CONFIG_BITS_struct USB_EP_STATIC_CONFIG_BITS_t

const USB_EP_STATIC_CONFIG_BITS_t endpointStaticConfig[USB_EP_NUM][static]

Initial value:

= {
    [0] = {.InTrncInterruptEnable = 1, .OutTrncInterruptEnable = 1, .InMultipktEnable = 1, .InAzlpEnable = 0, .OutMultipktEnable = 1, .OutAzlpEnable = 0},
    [1] = {.InTrncInterruptEnable = 1, .OutTrncInterruptEnable = 1, .InMultipktEnable = 0, .InAzlpEnable = 0},
    [2] = {.InTrncInterruptEnable = 1, .OutTrncInterruptEnable = 1, .InMultipktEnable = 0, .InAzlpEnable = 0, .OutMultipktEnable = 0, .OutAzlpEnable = 0},
}

USB_APPLICATION_CONFIGURATION_t configurationDescriptor[static]

USB_DESCRIPTOR_POINTERS_t descriptorPointers

Initial value:

= {
    .devicePtr = (USB_DEVICE_DESCRIPTOR_t *) & deviceDescriptor,
    .configurationsPtr = (USB_CONFIGURATION_DESCRIPTOR_t *) & configurationDescriptor,
    .deviceBOSptr = NULL,
    .langIDptr = &langIDDescriptor,
    .stringPtrs =
    {
        &stringDescriptors.manufacturer_header,
    },
}

USB_DEVICE_DESCRIPTOR_t deviceDescriptor[static]

Initial value:

= {
    .header = {
        .bLength = sizeof(USB_DEVICE_DESCRIPTOR_t),
        .bDescriptorType = USB_DESCRIPTOR_TYPE_DEVICE,
    },
    .bcdUSB = 0x200,            
    .bDeviceClass = USB_NO_DEVICE_CLASS,        
    .bDeviceSubClass = 0x00,            
    .bDeviceProtocol = 0x00,            
    .bMaxPacketSize0 = USB_EP0_SIZE,    
    .idVendor = 0x04D8,            
    .idProduct = 0x0B13,          
    .bcdDevice = 0x0110,   
    .iManufacturer = 0x01,              
    .iProduct = 0x02,                   
    .iSerialNumber = 0x03,              
    .bNumConfigurations = 0x01          
}

USB_STRING_LANG_ID_DESCRIPTOR_t langIDDescriptor[static]

Initial value:

= {
    .header =
    {
        .bLength = sizeof (USB_STRING_LANG_ID_DESCRIPTOR_t),
        .bDescriptorType = USB_DESCRIPTOR_TYPE_STRING,
    },
    .id_array =
    {LANG_EN_US},
}

USB_APPLICATION_STRING_DESCRIPTORS_t stringDescriptors[static]

Initial value:

= {
    .manufacturer_header =
    {
        .bLength = sizeof (stringDescriptors.manufacturer) + sizeof (USB_DESCRIPTOR_HEADER_t),
        .bDescriptorType = USB_DESCRIPTOR_TYPE_STRING,
    },
    .manufacturer = STRING_MANUFACTURER,
    .product_header =
    {
        .bLength = sizeof (stringDescriptors.product) + sizeof (USB_DESCRIPTOR_HEADER_t),
        .bDescriptorType = USB_DESCRIPTOR_TYPE_STRING,
    },
    .product = STRING_PRODUCT,
    .serial_header =
    {
        .bLength = sizeof (stringDescriptors.serial) + sizeof (USB_DESCRIPTOR_HEADER_t),
        .bDescriptorType = USB_DESCRIPTOR_TYPE_STRING,
    },
    .serial = STRING_SERIAL,
}

USB_HID_REPORT_DESCRIPTOR_t USB_HIDMouseReportDescriptor

Initial value:

= {
    {
        0x05, 0x01, 
        0x09, 0x02, 
        0xA1, 0x01, 
        0x09, 0x01, 
        0xA1, 0x00, 
        0x05, 0x09, 
        0x19, 0x01, 
        0x29, 0x03, 
        0x15, 0x00, 
        0x25, 0x01, 
        0x75, 0x01, 
        0x95, 0x03, 
        0x81, 0x02, 
        0x75, 0x05, 
        0x95, 0x01, 
        0x81, 0x01, 
        0x05, 0x01, 
        0x09, 0x30, 
        0x09, 0x31, 
        0x15, 0x81, 
        0x25, 0x7F, 
        0x75, 0x08, 
        0x95, 0x02, 
        0x81, 0x06, 
        0xC0, 
        0xC0, 
    }
}

typedef struct USB_APPLICATION_CONFIGURATION1_struct USB_APPLICATION_CONFIGURATION1_t

typedef struct USB_APPLICATION_CONFIGURATION_struct USB_APPLICATION_CONFIGURATION_t

typedef struct USB_APPLICATION_STRING_DESCRIPTORS_struct USB_APPLICATION_STRING_DESCRIPTORS_t

USB_DESCRIPTOR_POINTERS_t descriptorPointers

USB_HID_REPORT_DESCRIPTOR_t USB_HIDMouseReportDescriptor

static void USBDevice_EventHandler (void )[static]

static void USBDevice_TransferHandler (void )[static]

static RETURN_CODE_t Vendor_DefaultControlReqCallback (USB_SETUP_REQUEST_t * setupRequestPtr)[static]

static void Vendor_DefaultInterfaceEnCallback (USB_SETUP_REQUEST_t * setupRequestPtr)[static]

RETURN_CODE_t usbStatus[static]

USB_SETUP_PROCESS_CALLBACK_t Vendor_ControlReq_cb = &Vendor_DefaultControlReqCallback[static]

USB_SETUP_EVENT_CALLBACK_t Vendor_InterfaceEn_cb = &Vendor_DefaultInterfaceEnCallback[static]

• struct CIRCULAR_BUFFER_t

  Type define for circular buffers of varying length.

• struct USB_CDC_HEADER_FUNCTIONAL_DESCRIPTOR_t

  Type define for the CDC Header functional descriptor subtype.

• struct USB_CDC_ACM_FUNCTIONAL_DESCRIPTOR_t

  Type define for the CDC Abstract Control Management functional descriptor subtype.

• struct USB_CDC_COUNTRY_SELECTION_FUNCTIONAL_DESCRIPTOR_t

  Type define for the CDC country selection functional descriptor subtype.

• struct USB_CDC_LINE_CODING_t

  Type define for CDC Line Encoding.

• BUFFER_RETURN_CODE_t CIRCBUF_Enqueue (CIRCULAR_BUFFER_t *buffer, uint8_t data)

  Adds input data to circular buffer if there is space available.

• BUFFER_RETURN_CODE_t CIRCBUF_Dequeue (CIRCULAR_BUFFER_t *buffer, uint8_t *data)

  Pulls data from the circular buffer if it's available.

• bool CIRCBUF_Empty (CIRCULAR_BUFFER_t *buffer)

  Checks if the circular buffer is empty.

• bool CIRCBUF_Full (CIRCULAR_BUFFER_t *buffer)

  Checks if the circular buffer is full.

• uint16_t CIRCBUF_FreeSpace (CIRCULAR_BUFFER_t *buffer)

  Returns the number of available bytes in the circular buffer.

• void USB_CDCInitialize (void)

  Initializes the CDC class.

• RETURN_CODE_t USB_CDCRequestHandler (USB_SETUP_REQUEST_t *setupRequestPtr)

  Performs handling of control transfers.

• bool USB_CDCDataTerminalReady (void)

  Checks if the Data Terminal Equipment bit has been set from the host.

• void USB_CDCSetBaud (uint16_t baud)

  Sets the data transfer baud rate for the CDC communication.

• uint32_t USB_CDCGetBaud (void)

  Gets the data transfer baud rate for the CDC communication.

• void USB_CDCSetStopBits (USB_CDC_LINE_CODING_STOP_BITS_t numStopBits)

  Sets the number of data transfer stop bits for the CDC communication.

• USB_CDC_LINE_CODING_STOP_BITS_t USB_CDCGetStopBits (void)

  Gets the number of data transfer stop bits for the CDC communication.

• void USB_CDCSetParity (USD_CDC_LINE_CODING_PARITY_t parity)

  Sets the data transfer parity for the CDC communication.

• USD_CDC_LINE_CODING_PARITY_t USB_CDCGetParity (void)

  Gets the data transfer parity for the CDC communication.

• void USB_CDCSetDataBits (USD_CDC_LINE_CODING_DATA_BITS_t numDataBits)

  Sets the number of data transfer data bits for the CDC communication.

• USD_CDC_LINE_CODING_DATA_BITS_t USB_CDCGetDataBits (void)

  Gets the number of data transfer data bits for the CDC communication.

• void USB_CDCVirtualSerialPortInitialize (void)

  Initializes the CDC Virtual Serial Port functionality.

• RETURN_CODE_t USB_CDCVirtualSerialPortHandler (void)

  Performs Virtual Serial Port writes using the CDC class.

• CDC_RETURN_CODE_t USB_CDCRead (uint8_t *data)

  Pulls data from the CDC receive buffer.

• CDC_RETURN_CODE_t USB_CDCWrite (uint8_t data)

  Adds data to the CDC transmit buffer.

• bool USB_CDCTxBusy (void)

  Checks if the transmit buffer is full.

• void USB_CDCDataTransmitted (USB_PIPE_t pipe, USB_TRANSFER_STATUS_t status, uint16_t bytesTransferred)

  Callback function called after the USB IN transaction started.

• void USB_CDCDataReceived (USB_PIPE_t pipe, USB_TRANSFER_STATUS_t status, uint16_t bytesTransferred)

  Callback function called after the USB OUT transaction started.

BUFFER_RETURN_CODE_t CIRCBUF_Dequeue (CIRCULAR_BUFFER_t * buffer, uint8_t * data)

Pulls data from the circular buffer if it's available.

bool CIRCBUF_Empty (CIRCULAR_BUFFER_t * buffer)

Checks if the circular buffer is empty.

BUFFER_RETURN_CODE_t CIRCBUF_Enqueue (CIRCULAR_BUFFER_t * buffer, uint8_t data)

Adds input data to circular buffer if there is space available.

uint16_t CIRCBUF_FreeSpace (CIRCULAR_BUFFER_t * buffer)

Returns the number of available bytes in the circular buffer.

bool CIRCBUF_Full (CIRCULAR_BUFFER_t * buffer)

Checks if the circular buffer is full.

void USB_CDCDataReceived (USB_PIPE_t pipe, USB_TRANSFER_STATUS_t status, uint16_t bytesTransferred)

Callback function called after the USB OUT transaction started.

bool USB_CDCDataTerminalReady (void )

Checks if the Data Terminal Equipment bit has been set from the host.

void USB_CDCDataTransmitted (USB_PIPE_t pipe, USB_TRANSFER_STATUS_t status, uint16_t bytesTransferred)

Callback function called after the USB IN transaction started.

uint32_t USB_CDCGetBaud (void )

Gets the data transfer baud rate for the CDC communication.

USD_CDC_LINE_CODING_DATA_BITS_t USB_CDCGetDataBits (void )

Gets the number of data transfer data bits for the CDC communication.

USD_CDC_LINE_CODING_PARITY_t USB_CDCGetParity (void )

Gets the data transfer parity for the CDC communication.

USB_CDC_LINE_CODING_STOP_BITS_t USB_CDCGetStopBits (void )

Gets the number of data transfer stop bits for the CDC communication.

void USB_CDCInitialize (void )

Initializes the CDC class.

CDC_RETURN_CODE_t USB_CDCRead (uint8_t * data)

Pulls data from the CDC receive buffer.

RETURN_CODE_t USB_CDCRequestHandler (USB_SETUP_REQUEST_t * setupRequestPtr)

Performs handling of control transfers.

void USB_CDCSetBaud (uint16_t baud)

Sets the data transfer baud rate for the CDC communication.

void USB_CDCSetDataBits (USD_CDC_LINE_CODING_DATA_BITS_t numDataBits)

Sets the number of data transfer data bits for the CDC communication.

void USB_CDCSetParity (USD_CDC_LINE_CODING_PARITY_t parity)

Sets the data transfer parity for the CDC communication.

void USB_CDCSetStopBits (USB_CDC_LINE_CODING_STOP_BITS_t numStopBits)

Sets the number of data transfer stop bits for the CDC communication.

bool USB_CDCTxBusy (void )

Checks if the transmit buffer is full.

RETURN_CODE_t USB_CDCVirtualSerialPortHandler (void )

Performs Virtual Serial Port writes using the CDC class.

void USB_CDCVirtualSerialPortInitialize (void )

Initializes the CDC Virtual Serial Port functionality.

CDC_RETURN_CODE_t USB_CDCWrite (uint8_t data)

Adds data to the CDC transmit buffer.

• #define MAX_ENDPOINT_SIZE_DEFAULT (64)

  The maximum endpoint packet size for the default endpoint types (control, bulk, interrupt).

• #define MAX_ENDPOINT_SIZE_ISO (1023)

  The maximum endpoint packet size for the isochronous endpoint type.

• enum RETURN_CODE_enum { UNSUPPORTED = 2, UNINITIALIZED = 1, SUCCESS = 0, ENDPOINT_SIZE_ERROR = -1, ENDPOINT_ADDRESS_ERROR = -2, ENDPOINT_DIRECTION_ERROR = -3, ENDPOINT_TYPE_ERROR = -4, ENDPOINT_AZLP_ERROR = -5, ENDPOINT_ALIGN_ERROR = -6, PIPE_BUSY_ERROR = -10, PIPE_TRANSFER_ERROR = -11, CONTROL_SIZE_ERROR = -20, CONTROL_TRANSACTION_STATUS_ERROR = -21, CONTROL_SETUP_CALLBACK_ERROR = -22, CONTROL_SETUP_DIRECTION_ERROR = -23, DESCRIPTOR_POINTER_ERROR = -30, DESCRIPTOR_CONFIGURATIONS_ERROR = -31, DESCRIPTOR_INTERFACE_ERROR = -32, DESCRIPTOR_ENDPOINT_ERROR = -33, DESCRIPTOR_REQUEST_ERROR = -34, DESCRIPTOR_SEARCH_ERROR = -35, INTERFACE_SET_ERROR = -40, INTERFACE_GET_ERROR = -41, USB_CONNECTION_ERROR = -50, USB_CLASS_ERROR = -60 }

  Describes the different function return reserved codes used by the USB stack.

#define MAX_ENDPOINT_SIZE_DEFAULT (64)

The maximum endpoint packet size for the default endpoint types (control, bulk, interrupt).

#define MAX_ENDPOINT_SIZE_ISO (1023)

The maximum endpoint packet size for the isochronous endpoint type.

enum RETURN_CODE_enum

Describes the different function return reserved codes used by the USB stack.

• USB Common Elements

  Common elements for the USB stack.

• USB Descriptor Definitions

  In this file the active configuration and interfaces can be changed. The active configuration and active interface is referenced by a pointer as two global variables.

• USB Core Events

  Event handling for the USB Core Stack.

• USB Core Requests

  USB Device Core Requests handling.

• USB Core Transfer

  USB core layer implementation file.

• USB Protocol

  Common data structures, enumerations and macro definitons based on the USB 2.0 base protocol.

• struct USB_EVENT_HANDLERS_struct

  Represents the event callbacks, the configuration and the enumeration setups.

• RETURN_CODE_t USB_SetupProcess (USB_SETUP_REQUEST_t *setupRequestPtr)

  Setup function for the Standard Device Request USB 2.0 Specification Ch 9.4.

• RETURN_CODE_t USB_Start (void)

  Starts the USB peripheral, configures the callbacks and attaches it to the bus.

• RETURN_CODE_t USB_Stop (void)

  Stops the USB peripheral and detaches it from the bus.

• RETURN_CODE_t USB_Reset (void)

  Resets the USB peripheral.

• RETURN_CODE_t USB_DescriptorPointersSet (USB_DESCRIPTOR_POINTERS_t *descriptorPtr)

  Handles Descriptor pointer setup. Sets the address to the application descriptor pointers. Checks if the device pointer and a pointer to the start of the application configuration(s) are set before saving the address to the USB Core Stack.

• RETURN_CODE_t USB_DescriptorConfigurationEnable (uint8_t configurationValue)

  Enables endpoint configuration descriptor.

• bool USB_DescriptorActiveConfigurationSelfPoweredGet (void)

  Gets the Self-Powered setting from the active configuration.

• bool USB_DescriptorActiveConfigurationRemoteWakeupGet (void)

  Gets the Remote Wake-up setting from the active configuration.

• uint8_t USB_DescriptorActiveConfigurationValueGet (void)

  Gets the active configuration value.

• RETURN_CODE_t USB_DescriptorInterfaceConfigure (uint8_t interfaceNumber, uint8_t alternateSetting, bool enable)

  Enables or Disables an Interface Descriptor.

• RETURN_CODE_t USB_DescriptorPointerGet (USB_DESCRIPTOR_TYPE_t descriptor, uint8_t attribute, uint8_t **descriptorPtr, uint16_t *descriptorLength)

  Gets the pointer to the descriptor.

• RETURN_CODE_t USB_DescriptorStringPointerGet (uint8_t stringIndex, uint16_t langID, uint8_t **descriptorAddressPtr, uint16_t *descriptorLength)

  Gets the pointer to the string descriptor.

• RETURN_CODE_t ActiveAlternateSettingGet (uint8_t interfaceNumber, uint8_t *alternateSetting)

  Get the active alternate interface number for an interface.

• RETURN_CODE_t ActiveAlternateSettingSet (uint8_t interfaceNumber, uint8_t alternateSetting)

  Set the active alternate interface number for an interface.

• RETURN_CODE_t ConfigurationPointerGet (uint8_t configurationValue, USB_CONFIGURATION_DESCRIPTOR_t **configurationPtr)

  Collects the configuration pointer.

• RETURN_CODE_t DescriptorEndpointsConfigure (USB_INTERFACE_DESCRIPTOR_t *interfacePtr, bool enable)

  Configures the endpoints as given in the descriptor.

• RETURN_CODE_t NextDescriptorPointerGet (USB_DESCRIPTOR_TYPE_t descriptorType, USB_DESCRIPTOR_HEADER_t **descriptorHeaderPtr)

  Gets the next descriptor.

• RETURN_CODE_t USB_EventHandler (void)

  Handles the different types of events.

• void USB_SetConfigurationCallbackRegister (USB_SETUP_EVENT_CALLBACK_t callback)

  Registers a callback for Set Configuration requests.

• void USB_SetInterfaceCallbackRegister (USB_SETUP_EVENT_CALLBACK_t callback)

  Registers a callback for Set Interface requests.

• void USB_InterfaceDisabledCallbackRegister (USB_EVENT_CALLBACK_t callback)

  Registers a callback for disabling interfaces.

• void USB_VendorRequestCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

  Registers a callback for vendor requests.

• void USB_ClassRequestCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

  Registers a callback for class requests.

• void USB_OtherRequestCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

  Registers a callback for other requests.

• void USB_SOFCallbackRegister (USB_EVENT_CALLBACK_t callback)

  Registers a callback for Start-Of-Frame (SOF) events.

• void USB_ResetCallbackRegister (USB_EVENT_CALLBACK_t callback)

  Registers a callback for Reset events.

• void USB_SuspendCallbackRegister (USB_EVENT_CALLBACK_t callback)

  Registers a callback for Suspend events.

• void USB_ResumeCallbackRegister (USB_EVENT_CALLBACK_t callback)

  Registers a callback for Resume events.

RETURN_CODE_t ActiveAlternateSettingGet (uint8_t interfaceNumber, uint8_t * alternateSetting)

Get the active alternate interface number for an interface.

RETURN_CODE_t ActiveAlternateSettingSet (uint8_t interfaceNumber, uint8_t alternateSetting)

Set the active alternate interface number for an interface.

RETURN_CODE_t ConfigurationPointerGet (uint8_t configurationValue, USB_CONFIGURATION_DESCRIPTOR_t ** configurationPtr)

Collects the configuration pointer.

RETURN_CODE_t DescriptorEndpointsConfigure (USB_INTERFACE_DESCRIPTOR_t * interfacePtr, bool enable)

Configures the endpoints as given in the descriptor.

RETURN_CODE_t NextDescriptorPointerGet (USB_DESCRIPTOR_TYPE_t descriptorType, USB_DESCRIPTOR_HEADER_t ** descriptorHeaderPtr)

Gets the next descriptor.

void USB_ClassRequestCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

Registers a callback for class requests.

bool USB_DescriptorActiveConfigurationRemoteWakeupGet (void )

Gets the Remote Wake-up setting from the active configuration.

bool USB_DescriptorActiveConfigurationSelfPoweredGet (void )

Gets the Self-Powered setting from the active configuration.

uint8_t USB_DescriptorActiveConfigurationValueGet (void )

Gets the active configuration value.

RETURN_CODE_t USB_DescriptorConfigurationEnable (uint8_t configurationValue)

Enables endpoint configuration descriptor.

RETURN_CODE_t USB_DescriptorInterfaceConfigure (uint8_t interfaceNumber, uint8_t alternateSetting, bool enable)

Enables or Disables an Interface Descriptor.

RETURN_CODE_t USB_DescriptorPointerGet (USB_DESCRIPTOR_TYPE_t descriptor, uint8_t attribute, uint8_t ** descriptorPtr, uint16_t * descriptorLength)

Gets the pointer to the descriptor.

RETURN_CODE_t USB_DescriptorPointersSet (USB_DESCRIPTOR_POINTERS_t * descriptorPtr)

Handles Descriptor pointer setup. Sets the address to the application descriptor pointers. Checks if the device pointer and a pointer to the start of the application configuration(s) are set before saving the address to the USB Core Stack.

RETURN_CODE_t USB_DescriptorStringPointerGet (uint8_t stringIndex, uint16_t langID, uint8_t ** descriptorAddressPtr, uint16_t * descriptorLength)

Gets the pointer to the string descriptor.

RETURN_CODE_t USB_EventHandler (void )

Handles the different types of events.

void USB_InterfaceDisabledCallbackRegister (USB_EVENT_CALLBACK_t callback)

Registers a callback for disabling interfaces.

void USB_OtherRequestCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

Registers a callback for other requests.

RETURN_CODE_t USB_Reset (void )

Resets the USB peripheral.

void USB_ResetCallbackRegister (USB_EVENT_CALLBACK_t callback)

Registers a callback for Reset events.

void USB_ResumeCallbackRegister (USB_EVENT_CALLBACK_t callback)

Registers a callback for Resume events.

void USB_SetConfigurationCallbackRegister (USB_SETUP_EVENT_CALLBACK_t callback)

Registers a callback for Set Configuration requests.

void USB_SetInterfaceCallbackRegister (USB_SETUP_EVENT_CALLBACK_t callback)

Registers a callback for Set Interface requests.

RETURN_CODE_t USB_SetupProcess (USB_SETUP_REQUEST_t * setupRequestPtr)

Setup function for the Standard Device Request USB 2.0 Specification Ch 9.4.

void USB_SOFCallbackRegister (USB_EVENT_CALLBACK_t callback)

Registers a callback for Start-Of-Frame (SOF) events.

RETURN_CODE_t USB_Start (void )

Starts the USB peripheral, configures the callbacks and attaches it to the bus.

RETURN_CODE_t USB_Stop (void )

Stops the USB peripheral and detaches it from the bus.

void USB_SuspendCallbackRegister (USB_EVENT_CALLBACK_t callback)

Registers a callback for Suspend events.

void USB_VendorRequestCallbackRegister (USB_SETUP_PROCESS_CALLBACK_t callback)

Registers a callback for vendor requests.

• #define USB_DEFAULT_INTERFACE 0u

  Default interface number.

• #define USB_DEFAULT_ALTERNATE_SETTING 0u

  Default alternate setting.

• #define USB_DESCRIPTOR_SEARCH_LIMIT 30u

  The number of descriptors NextDescriptorPointerGet will search through before returning an error.

#define USB_DEFAULT_ALTERNATE_SETTING 0u

Default alternate setting.

#define USB_DEFAULT_INTERFACE 0u

Default interface number.

#define USB_DESCRIPTOR_SEARCH_LIMIT 30u

The number of descriptors NextDescriptorPointerGet will search through before returning an error.

• #define GET_STATUS_ENDPOINT_STALLED (1u << 0u)

  Mask for the endpoint stall status in the first byte of the data stage of the setup request.

• #define ENDPOINT_ADDRESS_MASK (0x7fu)

  Mask for the endpoint address in the wIndex field of the setup request.

• #define ENDPOINT_DIRECTION_BITPOSITION (7u)

  Bit position for the endpoint direction in the wIndex field of the setup request.

• #define GET_INTERFACE_REQUEST_NUMBER_MASK (0xffu)

  Mask for the interface number in the wIndex field of the setup request.

• #define GET_INTERFACE_REQUEST_WVALUE 0u

  Value for the wValue field of the setup request.

• #define GET_INTERFACE_RESPONSE_SIZE 1u

  Size of the response to the Get Interface request.

• RETURN_CODE_t USB_SetupProcessDeviceRequest (USB_SETUP_REQUEST_t *setupRequestPtr)

  Setup function for the device requests.

• RETURN_CODE_t USB_SetupProcessEndpointRequest (USB_SETUP_REQUEST_t *setupRequestPtr)

  Setup function for the endpoint requests.

• RETURN_CODE_t USB_SetupProcessInterfaceRequest (USB_SETUP_REQUEST_t *setupRequestPtr)

  Setup function for the interface requests.

• RETURN_CODE_t SetupDeviceRequestGetStatus (void)

  Returns the status of the device features.

• RETURN_CODE_t SetupDeviceRequestClearFeature (USB_SETUP_REQUEST_t *setupRequestPtr)

  Clears the device feature.

• RETURN_CODE_t SetupDeviceRequestSetFeature (USB_SETUP_REQUEST_t *setupRequestPtr)

  Sets the device feature.

• RETURN_CODE_t SetupDeviceRequestSetAddress (uint8_t address)

  Sets the device address.

• void SetupDeviceAddressCallback (void)

  Callback function for the address.

• RETURN_CODE_t SetupDeviceRequestGetDescriptor (USB_SETUP_REQUEST_t *setupRequestPtr)

  Gets the device descriptor.

• RETURN_CODE_t SetupDeviceRequestGetConfiguration (void)

  Gets the device configuration.

• RETURN_CODE_t SetupDeviceRequestSetConfiguration (uint8_t configurationValue)

  Sets the device configuration.

• USB_PIPE_t EndpointFromRequestGet (uint16_t wIndex)

  Gets the endpoint status.

• RETURN_CODE_t SetupEndpointRequestGetStatus (USB_SETUP_REQUEST_t *setupRequestPtr)

  Gets the endpoint status.

• RETURN_CODE_t SetupEndpointRequestClearFeature (USB_SETUP_REQUEST_t *setupRequestPtr)

  Clears the endpoint feature.

• RETURN_CODE_t SetupEndpointRequestSetFeature (USB_SETUP_REQUEST_t *setupRequestPtr)

  Sets the endpoint feature.

• RETURN_CODE_t SetupEndpointRequestSynchFrame (void)

  Gets the current frame number.

• RETURN_CODE_t USB_SetupInterfaceRequestGetStatus (void)

  Returns status for the specified interface.

• RETURN_CODE_t USB_SetupInterfaceRequestGetInterface (USB_SETUP_REQUEST_t *setupRequestPtr)

  Returns the alternate setting for the specified interface.

• RETURN_CODE_t USB_SetupInterfaceRequestSetInterface (USB_SETUP_REQUEST_t *setupRequestPtr)

  Setup function for the interface request to select the alternate setting.

• RETURN_CODE_t USB_SetupInterfaceRequestGetDescriptor (USB_SETUP_REQUEST_t *setupRequestPtr)

  Setup function for the interface request for class-specific descriptors.

#define ENDPOINT_ADDRESS_MASK (0x7fu)

Mask for the endpoint address in the wIndex field of the setup request.

#define ENDPOINT_DIRECTION_BITPOSITION (7u)

Bit position for the endpoint direction in the wIndex field of the setup request.

#define GET_INTERFACE_REQUEST_NUMBER_MASK (0xffu)

Mask for the interface number in the wIndex field of the setup request.

#define GET_INTERFACE_REQUEST_WVALUE 0u

Value for the wValue field of the setup request.

#define GET_INTERFACE_RESPONSE_SIZE 1u

Size of the response to the Get Interface request.

#define GET_STATUS_ENDPOINT_STALLED (1u << 0u)

Mask for the endpoint stall status in the first byte of the data stage of the setup request.

USB_PIPE_t EndpointFromRequestGet (uint16_t wIndex)

Gets the endpoint status.

void SetupDeviceAddressCallback (void )

Callback function for the address.

RETURN_CODE_t SetupDeviceRequestClearFeature (USB_SETUP_REQUEST_t * setupRequestPtr)

Clears the device feature.

RETURN_CODE_t SetupDeviceRequestGetConfiguration (void )

Gets the device configuration.

RETURN_CODE_t SetupDeviceRequestGetDescriptor (USB_SETUP_REQUEST_t * setupRequestPtr)

Gets the device descriptor.

RETURN_CODE_t SetupDeviceRequestGetStatus (void )

Returns the status of the device features.

RETURN_CODE_t SetupDeviceRequestSetAddress (uint8_t address)

Sets the device address.

RETURN_CODE_t SetupDeviceRequestSetConfiguration (uint8_t configurationValue)

Sets the device configuration.

RETURN_CODE_t SetupDeviceRequestSetFeature (USB_SETUP_REQUEST_t * setupRequestPtr)

Sets the device feature.

RETURN_CODE_t SetupEndpointRequestClearFeature (USB_SETUP_REQUEST_t * setupRequestPtr)

Clears the endpoint feature.

RETURN_CODE_t SetupEndpointRequestGetStatus (USB_SETUP_REQUEST_t * setupRequestPtr)

Gets the endpoint status.

RETURN_CODE_t SetupEndpointRequestSetFeature (USB_SETUP_REQUEST_t * setupRequestPtr)

Sets the endpoint feature.

RETURN_CODE_t SetupEndpointRequestSynchFrame (void )

Gets the current frame number.

RETURN_CODE_t USB_SetupInterfaceRequestGetDescriptor (USB_SETUP_REQUEST_t * setupRequestPtr)

Setup function for the interface request for class-specific descriptors.

RETURN_CODE_t USB_SetupInterfaceRequestGetInterface (USB_SETUP_REQUEST_t * setupRequestPtr)

Returns the alternate setting for the specified interface.

RETURN_CODE_t USB_SetupInterfaceRequestGetStatus (void )

Returns status for the specified interface.

RETURN_CODE_t USB_SetupInterfaceRequestSetInterface (USB_SETUP_REQUEST_t * setupRequestPtr)

Setup function for the interface request to select the alternate setting.

RETURN_CODE_t USB_SetupProcessDeviceRequest (USB_SETUP_REQUEST_t * setupRequestPtr)

Setup function for the device requests.

RETURN_CODE_t USB_SetupProcessEndpointRequest (USB_SETUP_REQUEST_t * setupRequestPtr)

Setup function for the endpoint requests.

RETURN_CODE_t USB_SetupProcessInterfaceRequest (USB_SETUP_REQUEST_t * setupRequestPtr)

Setup function for the interface requests.

• RETURN_CODE_t USB_TransferWriteStart (USB_PIPE_t pipe, uint8_t *dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback)

  Sets up the pipe for the write transfers.

• RETURN_CODE_t USB_TransferReadStart (USB_PIPE_t pipe, uint8_t *dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback)

  Sets up the pipe for the read transfers.

• RETURN_CODE_t USB_TransferControlDataSet (uint8_t *dataPtr, uint16_t dataSize, USB_SETUP_ENDOFREQUEST_CALLBACK_t callback)

  Sets up vendor or class control request data transfers.

• RETURN_CODE_t USB_TransferAbort (USB_PIPE_t pipe)

  Aborts an ongoing transfer.

• RETURN_CODE_t USB_TransferHandler (void)

  Handles the different types of packages received or transferred.

RETURN_CODE_t USB_TransferAbort (USB_PIPE_t pipe)

Aborts an ongoing transfer.

Will call the pipe transferEndCallback with the abort status, if configured.

RETURN_CODE_t USB_TransferControlDataSet (uint8_t * dataPtr, uint16_t dataSize, USB_SETUP_ENDOFREQUEST_CALLBACK_t callback)

Sets up vendor or class control request data transfers.

Sets up the pointer and size of the read or write trnasfer in the control data stage.

RETURN_CODE_t USB_TransferHandler (void )

Handles the different types of packages received or transferred.

Checks if a setup package is received or if a transaction is completed and which pipe has a completed transaction, then it handles them accordingly. Sends an ACK upon completed transaction confirmation.

RETURN_CODE_t USB_TransferReadStart (USB_PIPE_t pipe, uint8_t * dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback)

Sets up the pipe for the read transfers.

Sets up the pipe for the write transfers and checks to see if it is busy. If it is not busy, then the routine resets the pipe, setting it up for read transfer, then starts the transfer.

RETURN_CODE_t USB_TransferWriteStart (USB_PIPE_t pipe, uint8_t * dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback)

Sets up the pipe for the write transfers.

Sets up the pipe for the write transfers and checks to see if it is busy. If it is not busy, then the routine resets the pipe, setting it up for write transfer, then starts the transfer.

• struct USB_PIPE_struct

  Structure for a pipe which has an address and direction.

• struct USB_IAD_DESC_struct

  Standard USB association descriptor structure.

• struct USB_INTERFACE_DESCRIPTOR_struct

  Ch. 9.6.5 Standard USB interface descriptor structure.

• struct USB_STRING_LANG_ID_DESCRIPTOR_struct

  Structure for the USB string Language ID descriptor.

• struct USB_STRING_DESCRIPTOR_struct

  Structure with pointers to the standard USB descriptors.

• typedef void(* USB_TRANSFER_END_CALLBACK_t) (USB_PIPE_t pipe, USB_TRANSFER_STATUS_t status, uint16_t bytesTransferred)

  Function callback type USB_TRANSFER_END_CALLBACK_t. Callback type used for transfer complete notifications.

• typedef RETURN_CODE_t(* USB_SETUP_PROCESS_CALLBACK_t) (USB_SETUP_REQUEST_t *setupRequestPtr)

  Function callback type USB_SETUP_PROCESS_CALLBACK_t. Callback type used for setup request processing, with a return code to let the stack know to proceed.

• typedef RETURN_CODE_t(* USB_SETUP_STRING_CALLBACK_t) (uint8_t stringIndex, uint16_t langID, uint8_t **descriptorAddressPtr, uint16_t *descriptorLength)

  Function callback type USB_SETUP_STRING_CALLBACK_t. Callback type used for setup request processing a string descriptor, with a return code to let the stack know to proceed.

• typedef void(* USB_SETUP_EVENT_CALLBACK_t) (USB_SETUP_REQUEST_t *setupRequestPtr)

  Function callback type USB_SETUP_EVENT_CALLBACK_t. Callback type used for setup request notifications.

• typedef RETURN_CODE_t(* USB_SETUP_OVERUNDERRUN_CALLBACK_t) (void)

  Function callback type USB_SETUP_OVERUNDERRUN_CALLBACK_t. Callback type used for USB Overrun and Underrun event processing on the control endpoints, with a return code to let the stack know to proceed.

• typedef void(* USB_SETUP_ENDOFREQUEST_CALLBACK_t) (void)

  Function callback type USB_SETUP_ENDOFREQUEST_CALLBACK_t. Callback type used for setup request complete notifications.

• typedef void(* USB_EVENT_CALLBACK_t) (void)

  Function callback type USB_EVENT_CALLBACK_t. Callback type used for USB event notifications.

• #define USB_EP_DIR_IN 0x01u

  Endpoint direction IN.

• #define USB_EP_DIR_OUT 0x00u

  Endpoint direction OUT.

• #define OVERFLOW_EVENT 1u

  Overflow event for the endpoint.

• #define UNDERFLOW_EVENT 2u

  Underflow event for the endpoint.

• #define USB_V2_0 0x0200

  USB Specification version 2.00.

• #define USB_V2_1 0x0201

  USB Specification version 2.01.

• #define NO_SUBCLASS 0x00

  No subclass code.

• #define NO_PROTOCOL 0x00

  No protocol code.

• #define CLASS_IAD 0xEF

  IAD class code.

• #define SUB_CLASS_IAD 0x02

  IAD subclass code.

• #define PROTOCOL_IAD 0x01

  IAD protocol code.

• #define USB_ENDPOINT_FEATURE_HALT 0x00u

  USB endpoint feature halt.

• #define DESCRIPTOR_STRING_LENGTH(wstring) (sizeof(wstring) / sizeof(wchar_t) - 1)

  Calculates descriptor length of a UTF-16 string descriptor without the null character.

• #define USB_CONFIG_ATTR_MUST_SET (1u << 7u)

  USB Attribute bitfield for the configuration descriptor.

• #define USB_CONFIG_ATTR_BUS_POWERED (0u << 6u)

  USB Attribute Bus Powered bitfield for the configuration descriptor.

• #define USB_CONFIG_ATTR_SELF_POWERED (1u << 6u)

  USB Attribute Self Powered bitfield for the configuration descriptor.

• #define USB_CONFIG_ATTR_REMOTE_WAKEUP (1u << 5u)

  USB Attribute Remote Wakeup bitfield for the configuration descriptor.

• #define USB_CONFIG_MAX_POWER(ma) (((ma) + 1u) / 2u)

  USB Max Power bitfield for the configuration descriptor.

• enum USB_ENDPOINT_enum { CONTROL = 0, ISOCHRONOUS = 1, BULK = 2, INTERRUPT = 3, DISABLED = 0xff }

  Defines labels for the different endpoint types as per the USB 2.0 base specification.

• enum USB_TRANSFER_STATUS_enum { USB_PIPE_TRANSFER_OK = 0, USB_PIPE_TRANSFER_BUSY = 1, USB_PIPE_TRANSFER_ABORTED = 2, USB_PIPE_TRANSFER_ERROR = 3 }

  Defines the possible states of a configured transfer.

• enum USB_CONTROL_STATUS_enum { USB_CONTROL_SETUP = 0, USB_CONTROL_DATA_OUT = 1, USB_CONTROL_DATA_IN = 2, USB_CONTROL_ZLP = 3, USB_CONTROL_STALL_REQ = 4 }

  Defines the possible states of a configured control transfer.

• enum USB_REQUEST_DIR_enum { USB_REQUEST_DIR_OUT = 0, USB_REQUEST_DIR_IN = 1 }

  Standard USB enumeration used by setup requests.

• enum USB_REQUEST_TYPE_enum { USB_REQUEST_TYPE_STANDARD = 0, USB_REQUEST_TYPE_CLASS = 1, USB_REQUEST_TYPE_VENDOR = 2 }

  USB request types (bmRequestType).

• enum USB_REQUEST_RECIPIENT_enum { USB_REQUEST_RECIPIENT_DEVICE = 0, USB_REQUEST_RECIPIENT_INTERFACE = 1, USB_REQUEST_RECIPIENT_ENDPOINT = 2, USB_REQUEST_RECIPIENT_OTHER = 3 }

  USB recipient codes (bmRequestType).

• enum USB_REQUEST_ID_enum { USB_REQUEST_GET_STATUS = 0, USB_REQUEST_CLEAR_FEATURE = 1, USB_REQUEST_SET_FEATURE = 3, USB_REQUEST_SET_ADDRESS = 5, USB_REQUEST_GET_DESCRIPTOR = 6, USB_REQUEST_SET_DESCRIPTOR = 7, USB_REQUEST_GET_CONFIGURATION = 8, USB_REQUEST_SET_CONFIGURATION = 9, USB_REQUEST_GET_INTERFACE = 10, USB_REQUEST_SET_INTERFACE = 11, USB_REQUEST_SYNCH_FRAME = 12 }

  Standard USB requests (bRequest).

• enum USB_DESCRIPTOR_TYPE_enum { USB_DESCRIPTOR_TYPE_DEVICE = 1, USB_DESCRIPTOR_TYPE_CONFIGURATION = 2, USB_DESCRIPTOR_TYPE_STRING = 3, USB_DESCRIPTOR_TYPE_INTERFACE = 4, USB_DESCRIPTOR_TYPE_ENDPOINT = 5, USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER = 6, USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION = 7, USB_DESCRIPTOR_TYPE_INTERFACE_POWER = 8, USB_DESCRIPTOR_TYPE_IAD = 11, USB_DESCRIPTOR_TYPE_BOS = 15, USB_DESCRIPTOR_TYPE_DEVICE_CAPABILITY = 16, USB_DESCRIPTOR_TYPE_CLASS = 0x20, USB_DESCRIPTOR_TYPE_VENDOR = 0x40 }

  Standard USB descriptor types.

#define CLASS_IAD 0xEF

IAD class code.

#define DESCRIPTOR_STRING_LENGTH( wstring) (sizeof(wstring) / sizeof(wchar_t) - 1)

Calculates descriptor length of a UTF-16 string descriptor without the null character.

#define NO_PROTOCOL 0x00

No protocol code.

#define NO_SUBCLASS 0x00

No subclass code.

#define OVERFLOW_EVENT 1u

Overflow event for the endpoint.

#define PROTOCOL_IAD 0x01

IAD protocol code.

#define SUB_CLASS_IAD 0x02

IAD subclass code.

#define UNDERFLOW_EVENT 2u

Underflow event for the endpoint.

#define USB_CONFIG_ATTR_BUS_POWERED (0u << 6u)

USB Attribute Bus Powered bitfield for the configuration descriptor.

Bus-Powered

#define USB_CONFIG_ATTR_MUST_SET (1u << 7u)

USB Attribute bitfield for the configuration descriptor.

Must always be set

#define USB_CONFIG_ATTR_REMOTE_WAKEUP (1u << 5u)

USB Attribute Remote Wakeup bitfield for the configuration descriptor.

Remote wakeup supported

#define USB_CONFIG_ATTR_SELF_POWERED (1u << 6u)

USB Attribute Self Powered bitfield for the configuration descriptor.

Self-Powered

#define USB_CONFIG_MAX_POWER( ma) (((ma) + 1u) / 2u)

USB Max Power bitfield for the configuration descriptor.

Maximum power in mA

#define USB_ENDPOINT_FEATURE_HALT 0x00u

USB endpoint feature halt.

#define USB_EP_DIR_IN 0x01u

Endpoint direction IN.

#define USB_EP_DIR_OUT 0x00u

Endpoint direction OUT.

#define USB_V2_0 0x0200

USB Specification version 2.00.

#define USB_V2_1 0x0201

USB Specification version 2.01.

typedef void(* USB_EVENT_CALLBACK_t) (void)

Function callback type USB_EVENT_CALLBACK_t. Callback type used for USB event notifications.

typedef void(* USB_SETUP_ENDOFREQUEST_CALLBACK_t) (void)

Function callback type USB_SETUP_ENDOFREQUEST_CALLBACK_t. Callback type used for setup request complete notifications.

typedef void(* USB_SETUP_EVENT_CALLBACK_t) (USB_SETUP_REQUEST_t *setupRequestPtr)

Function callback type USB_SETUP_EVENT_CALLBACK_t. Callback type used for setup request notifications.

typedef RETURN_CODE_t(* USB_SETUP_OVERUNDERRUN_CALLBACK_t) (void)

Function callback type USB_SETUP_OVERUNDERRUN_CALLBACK_t. Callback type used for USB Overrun and Underrun event processing on the control endpoints, with a return code to let the stack know to proceed.

typedef RETURN_CODE_t(* USB_SETUP_PROCESS_CALLBACK_t) (USB_SETUP_REQUEST_t *setupRequestPtr)

Function callback type USB_SETUP_PROCESS_CALLBACK_t. Callback type used for setup request processing, with a return code to let the stack know to proceed.

typedef RETURN_CODE_t(* USB_SETUP_STRING_CALLBACK_t) (uint8_t stringIndex, uint16_t langID, uint8_t **descriptorAddressPtr, uint16_t *descriptorLength)

Function callback type USB_SETUP_STRING_CALLBACK_t. Callback type used for setup request processing a string descriptor, with a return code to let the stack know to proceed.

typedef void(* USB_TRANSFER_END_CALLBACK_t) (USB_PIPE_t pipe, USB_TRANSFER_STATUS_t status, uint16_t bytesTransferred)

Function callback type USB_TRANSFER_END_CALLBACK_t. Callback type used for transfer complete notifications.

enum USB_CONTROL_STATUS_enum

Defines the possible states of a configured control transfer.

enum USB_DESCRIPTOR_TYPE_enum

Standard USB descriptor types.

enum USB_ENDPOINT_enum

Defines labels for the different endpoint types as per the USB 2.0 base specification.

enum USB_REQUEST_DIR_enum

Standard USB enumeration used by setup requests.

enum USB_REQUEST_ID_enum

Standard USB requests (bRequest).

enum USB_REQUEST_RECIPIENT_enum

USB recipient codes (bmRequestType).

enum USB_REQUEST_TYPE_enum

USB request types (bmRequestType).

enum USB_TRANSFER_STATUS_enum

Defines the possible states of a configured transfer.

READ WRITE LAYER

• struct USB_HID_DESCRIPTOR_t

  Type defines for a standard HID descriptor.

• struct USB_HID_REPORT_DESCRIPTOR_t

  Report descriptor for a HID application.

• struct USB_MOUSE_REPORT_DATA_t

  Type defines for a standard mouse input report.

• struct USB_KEYBOARD_REPORT_DATA_t

  Type defines for a standard keyboard input report.

• typedef void(* USB_HID_REPORT_CALLBACK_t) (uint16_t report)

  Defines a type for registering a callback for the HID report.

• void USB_HIDReportUpdatedCallbackRegister (USB_HID_REPORT_CALLBACK_t callback)

  Registers a callback to the HID report.

• void USB_HIDReportUpdatedCallback (void)

  Checks if a callback is registered and calls the End Of Request function.

• void USB_HIDInitialize (uint8_t *ratePtr, uint8_t *protocolPtr, USB_HID_REPORT_DESCRIPTOR_t *reportPtr)

  Registers the rate, protocol and report descriptor for HID.

• RETURN_CODE_t USB_HIDRequestHandler (USB_SETUP_REQUEST_t *setupRequestPtr)

  Initializes the HID class and performs control transfers.

typedef void(* USB_HID_REPORT_CALLBACK_t) (uint16_t report)

Defines a type for registering a callback for the HID report.

void USB_HIDInitialize (uint8_t * ratePtr, uint8_t * protocolPtr, USB_HID_REPORT_DESCRIPTOR_t * reportPtr)

Registers the rate, protocol and report descriptor for HID.

void USB_HIDReportUpdatedCallback (void )

Checks if a callback is registered and calls the End Of Request function.

void USB_HIDReportUpdatedCallbackRegister (USB_HID_REPORT_CALLBACK_t callback)

Registers a callback to the HID report.

RETURN_CODE_t USB_HIDRequestHandler (USB_SETUP_REQUEST_t * setupRequestPtr)

Initializes the HID class and performs control transfers.

Macros for the input report for a standard HID keyboard.

• void USB_HIDKeyboardInitialize (USB_HID_REPORT_DESCRIPTOR_t *reportPtr, USB_HID_REPORT_CALLBACK_t callback)

  Sets up the keyboard application for use with the HID class.

• RETURN_CODE_t USB_HIDKeyModifierDown (uint8_t modifierID)

  Updates the keyboard report by adding the pressed modifier key in the modifier byte in the report array.

• RETURN_CODE_t USB_HIDKeyModifierUp (uint8_t modifierID)

  Updates the keyboard report by removing the released modifier key in the modifier byte in the report array.

• int8_t USB_HIDKeyCodeIndexGet (uint8_t keyID)

  Checks the report array to see that the key is already present.

• RETURN_CODE_t USB_HIDKeyPressDown (uint8_t keyID)

  Updates the keyboard report by adding the pressed key at the first available byte in the report array.

• RETURN_CODE_t USB_HIDKeyPressUp (uint8_t keyID)

  Updates the keyboard report by removing the released key and shifts the registered keys towards the beginning of the report array.

• #define USB_HID_KEYBOARD_REPORT_KEYNUM 6u

• #define USB_HID_KEYBOARD_REPORT_SIZE (USB_HID_KEYBOARD_REPORT_KEYNUM + 2u)

#define USB_HID_KEYBOARD_REPORT_KEYNUM 6u

#define USB_HID_KEYBOARD_REPORT_SIZE (USB_HID_KEYBOARD_REPORT_KEYNUM + 2u)

void USB_HIDKeyboardInitialize (USB_HID_REPORT_DESCRIPTOR_t * reportPtr, USB_HID_REPORT_CALLBACK_t callback)

Sets up the keyboard application for use with the HID class.

int8_t USB_HIDKeyCodeIndexGet (uint8_t keyID)

Checks the report array to see that the key is already present.

RETURN_CODE_t USB_HIDKeyModifierDown (uint8_t modifierID)

Updates the keyboard report by adding the pressed modifier key in the modifier byte in the report array.

RETURN_CODE_t USB_HIDKeyModifierUp (uint8_t modifierID)

Updates the keyboard report by removing the released modifier key in the modifier byte in the report array.

RETURN_CODE_t USB_HIDKeyPressDown (uint8_t keyID)

Updates the keyboard report by adding the pressed key at the first available byte in the report array.

RETURN_CODE_t USB_HIDKeyPressUp (uint8_t keyID)

Updates the keyboard report by removing the released key and shifts the registered keys towards the beginning of the report array.

• #define USB_HID_MOUSE_REPORT_SIZE 8

  Size of the report for a standard HID mouse.

• void USB_HIDMouseInitialize (USB_HID_REPORT_DESCRIPTOR_t *reportPtr)

  Sets up the mouse application for use with the HID class.

• RETURN_CODE_t USB_HIDMouseMove (int8_t x_position, int8_t y_position)

  Registers mouse movement and sends its coordinates to the host.

• RETURN_CODE_t USB_HIDMouseButton (bool buttonState, uint8_t button)

  Registers the button and its state and sends it to the host.

• RETURN_CODE_t USB_HIDMouseButtonLeft (bool buttonState)

  Registers the button state of the left button.

• RETURN_CODE_t USB_HIDMouseButtonRight (bool buttonState)

  Registers the button state of the right button.

• RETURN_CODE_t USB_HIDMouseButtonMiddle (bool buttonState)

  Registers the button state of the middle button.