usbopt - Configuration options for USB APIs

List of available configuration options for the usbdev - USB Device Driver API. More...

Detailed Description

List of available configuration options for the usbdev - USB Device Driver API.

Files

file  usbopt.h
 Definition of global USB peripheral and USB peripheral endpoint configuration options.
 

Enumerations

enum  usbopt_t {
  USBOPT_ADDRESS, USBOPT_ATTACH, USBOPT_CONNECTED, USBOPT_MAX_VERSION,
  USBOPT_MAX_SPEED
}
 List of configuration settings for USB peripherals. More...
 
enum  usbopt_ep_t { USBOPT_EP_ENABLE, USBOPT_EP_STALL, USBOPT_EP_READY, USBOPT_EP_AVAILABLE }
 List of configuration settings for USB peripheral endpoints. More...
 
enum  usbopt_enable_t { USBOPT_DISABLE = 0, USBOPT_ENABLE = 1 }
 Binary parameter for enabling and disabling options. More...
 

Enumeration Type Documentation

◆ usbopt_enable_t

Binary parameter for enabling and disabling options.

Enumerator
USBOPT_DISABLE 

disable a given option

USBOPT_ENABLE 

enable a given option

Definition at line 110 of file usbopt.h.

◆ usbopt_ep_t

List of configuration settings for USB peripheral endpoints.

The data type specified in parentheses for each individual option is the data type to use for the argument when getting/setting the value of the option.

Enumerator
USBOPT_EP_ENABLE 

(usbopt_enable_t) Enable or disable the endpoint

USBOPT_EP_STALL 

(usbopt_enable_t) Enable or disable stall replies for endpoint

USBOPT_EP_READY 

(usbopt_enable_t) Signal data ready or not ready anymore

USBOPT_EP_AVAILABLE 

(size_t) Retrieve number of bytes available on endpoint.

Definition at line 82 of file usbopt.h.

◆ usbopt_t

enum usbopt_t

List of configuration settings for USB peripherals.

The data type specified in parentheses for each individual option is the data type to use for the argument when getting/setting the value of the option.

Enumerator
USBOPT_ADDRESS 

(uint8_t) USB device address, limited to 7 bit by the protocol

USBOPT_ATTACH 

(usbopt_enable_t) Attach/detach USB peripheral to host

In practice this happens by enabling or disabling the pull-up resistor on one of the data lines.

USBOPT_CONNECTED 

(usbopt_enable_t) Whether a USB host connection is detected

Setting this option must return -ENOTSUP

USBOPT_MAX_VERSION 

(usb_version_t) Highest USB version supported by peripheral

Setting this option must return -ENOTSUP

USBOPT_MAX_SPEED 

(usb_version_t) Highest USB speed supported by peripheral

Setting this option must return -ENOTSUP

Definition at line 37 of file usbopt.h.