Configuration defines for USB peripheral devices. More...

Detailed Description

Configuration defines for USB peripheral devices.

Modules

 CDC - USB communications device class
 Generic USB CDC defines and helpers.
 
 USB descriptors
 Provides USB protocol descriptors and defines for USB frameworks.
 
 USBUS CDC ECM - USBUS CDC ethernet control model
 USBUS CDC ECM interface module.
 
 USBUS device and endpoint manager
 USBUS (Universal Serial Bus Unified Stack), USB device management interface.
 
 usbopt - Configuration options for USB APIs
 List of available configuration options for the usbdev - USB Device Driver API.
 

Files

file  usb.h
 Definition of global compile time configuration options.
 

Macros

#define USB_CONFIG_MANUF_STR   "RIOT-os.org"
 USB peripheral device vendor ID. More...
 
#define USB_CONFIG_PRODUCT_STR   "USB device"
 USB peripheral product string.
 
#define USB_CONFIG_CONFIGURATION_STR   "USB config"
 USB peripheral configuration string.
 
#define USB_CONFIG_PRODUCT_BCDVERSION   0x0100
 USB peripheral device version. More...
 
#define USB_CONFIG_SPEC_BCDVERSION   0x0200
 USB specification version.
 
#define USB_CONFIG_SELF_POWERED   (0)
 USB peripheral setting to indicate self powered devices.
 
#define USB_CONFIG_MAX_POWER   (100)
 USB device max power draw in mA, between 0 and 500mA.
 
#define USB_CONFIG_DEFAULT_LANGID   0x0409 /* EN-US */
 Default LANG ID reported to the host.
 

Enumerations

enum  usb_version_t { USB_VERSION_1x, USB_VERSION_20 }
 USB version definitions.
 
enum  usb_speed_t { USB_SPEED_LOW, USB_SPEED_FULL, USB_SPEED_HIGH }
 USB speed definitions.
 
enum  usb_ep_type_t {
  USB_EP_TYPE_NONE = 0, USB_EP_TYPE_CONTROL, USB_EP_TYPE_INTERRUPT, USB_EP_TYPE_BULK,
  USB_EP_TYPE_ISOCHRONOUS
}
 USB endpoint types. More...
 
enum  usb_ep_dir_t { USB_EP_DIR_OUT, USB_EP_DIR_IN }
 USB endpoint directions. More...
 

Macro Definition Documentation

◆ USB_CONFIG_MANUF_STR

#define USB_CONFIG_MANUF_STR   "RIOT-os.org"

USB peripheral device vendor ID.

USB peripheral device product ID

You must provide your own VID/PID combination when manufacturing a device with USB USB peripheral manufacturer string

Definition at line 48 of file usb.h.

◆ USB_CONFIG_PRODUCT_BCDVERSION

#define USB_CONFIG_PRODUCT_BCDVERSION   0x0100

USB peripheral device version.

This is the version number of this peripheral

Note
Not to be be confused with the USB version number

Definition at line 72 of file usb.h.

Enumeration Type Documentation

◆ usb_ep_dir_t

USB endpoint directions.

Enumerator
USB_EP_DIR_OUT 

Host out, device in.

USB_EP_DIR_IN 

Host in, device out.

Definition at line 134 of file usb.h.

◆ usb_ep_type_t

USB endpoint types.

Enumerator
USB_EP_TYPE_NONE 

Unused endpoint.

USB_EP_TYPE_CONTROL 

Control type.

USB_EP_TYPE_INTERRUPT 

Interrupt type.

USB_EP_TYPE_BULK 

Bulk type.

USB_EP_TYPE_ISOCHRONOUS 

Isochronous type.

Definition at line 123 of file usb.h.