18 #if !defined(_usb_h_) || defined(USBCORE_H)
19 #error "Never include UsbCore.h directly; include Usb.h instead"
28 #ifdef BOARD_BLACK_WIDDOW
30 #elif defined(CORE_TEENSY) && (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__))
36 #elif defined(BOARD_MEGA_ADK)
38 #elif defined(ARDUINO_AVR_BALANDUINO)
45 #define bmREQ_GET_DESCR USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_STANDARD|USB_SETUP_RECIPIENT_DEVICE //get descriptor request type
46 #define bmREQ_SET USB_SETUP_HOST_TO_DEVICE|USB_SETUP_TYPE_STANDARD|USB_SETUP_RECIPIENT_DEVICE //set request type for all but 'set feature' and 'set interface'
47 #define bmREQ_CL_GET_INTF USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE //get interface request type
54 #define USB_CLASS_USE_CLASS_INFO 0x00 // Use Class Info in the Interface Descriptors
55 #define USB_CLASS_AUDIO 0x01 // Audio
56 #define USB_CLASS_COM_AND_CDC_CTRL 0x02 // Communications and CDC Control
57 #define USB_CLASS_HID 0x03 // HID
58 #define USB_CLASS_PHYSICAL 0x05 // Physical
59 #define USB_CLASS_IMAGE 0x06 // Image
60 #define USB_CLASS_PRINTER 0x07 // Printer
61 #define USB_CLASS_MASS_STORAGE 0x08 // Mass Storage
62 #define USB_CLASS_HUB 0x09 // Hub
63 #define USB_CLASS_CDC_DATA 0x0a // CDC-Data
64 #define USB_CLASS_SMART_CARD 0x0b // Smart-Card
65 #define USB_CLASS_CONTENT_SECURITY 0x0d // Content Security
66 #define USB_CLASS_VIDEO 0x0e // Video
67 #define USB_CLASS_PERSONAL_HEALTH 0x0f // Personal Healthcare
68 #define USB_CLASS_DIAGNOSTIC_DEVICE 0xdc // Diagnostic Device
69 #define USB_CLASS_WIRELESS_CTRL 0xe0 // Wireless Controller
70 #define USB_CLASS_MISC 0xef // Miscellaneous
71 #define USB_CLASS_APP_SPECIFIC 0xfe // Application Specific
72 #define USB_CLASS_VENDOR_SPECIFIC 0xff // Vendor Specific
75 #define USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED 0xD1
76 #define USB_DEV_CONFIG_ERROR_DEVICE_INIT_INCOMPLETE 0xD2
77 #define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS 0xD3
78 #define USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL 0xD4
79 #define USB_ERROR_HUB_ADDRESS_OVERFLOW 0xD5
80 #define USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL 0xD6
81 #define USB_ERROR_EPINFO_IS_NULL 0xD7
82 #define USB_ERROR_INVALID_ARGUMENT 0xD8
83 #define USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE 0xD9
84 #define USB_ERROR_INVALID_MAX_PKT_SIZE 0xDA
85 #define USB_ERROR_EP_NOT_FOUND_IN_TBL 0xDB
86 #define USB_ERROR_CONFIG_REQUIRES_ADDITIONAL_RESET 0xE0
87 #define USB_ERROR_FailGetDevDescr 0xE1
88 #define USB_ERROR_FailSetDevTblEntry 0xE2
89 #define USB_ERROR_FailGetConfDescr 0xE3
90 #define USB_ERROR_TRANSFER_TIMEOUT 0xFF
92 #define USB_XFER_TIMEOUT 10000 //30000 // (5000) USB transfer timeout in milliseconds, per section 9.2.6.1 of USB 2.0 spec
94 #define USB_RETRY_LIMIT 3 // 3 retry limit for a transfer
95 #define USB_SETTLE_DELAY 200 //settle delay in milliseconds
97 #define USB_NUMDEVICES 16 //number of USB devices
99 #define HUB_PORT_RESET_DELAY 20 // hub port reset delay 10 ms recomended, can be up to 20 ms
102 #define USB_STATE_MASK 0xf0
104 #define USB_STATE_DETACHED 0x10
105 #define USB_DETACHED_SUBSTATE_INITIALIZE 0x11
106 #define USB_DETACHED_SUBSTATE_WAIT_FOR_DEVICE 0x12
107 #define USB_DETACHED_SUBSTATE_ILLEGAL 0x13
108 #define USB_ATTACHED_SUBSTATE_SETTLE 0x20
109 #define USB_ATTACHED_SUBSTATE_RESET_DEVICE 0x30
110 #define USB_ATTACHED_SUBSTATE_WAIT_RESET_COMPLETE 0x40
111 #define USB_ATTACHED_SUBSTATE_WAIT_SOF 0x50
112 #define USB_ATTACHED_SUBSTATE_WAIT_RESET 0x51
113 #define USB_ATTACHED_SUBSTATE_GET_DEVICE_DESCRIPTOR_SIZE 0x60
114 #define USB_STATE_ADDRESSING 0x70
115 #define USB_STATE_CONFIGURING 0x80
116 #define USB_STATE_RUNNING 0x90
117 #define USB_STATE_ERROR 0xa0
122 virtual uint8_t
Init(uint8_t parent, uint8_t port,
bool lowspeed) {
146 virtual boolean VIDPIDOK(uint16_t vid, uint16_t pid) {
162 uint8_t recipient : 5;
164 uint8_t direction : 1;
165 } __attribute__((packed));
175 } __attribute__((packed));
187 virtual void Parse(
const uint16_t len,
const uint8_t *pbuf,
const uint16_t &offset) = 0;
230 uint8_t
getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr);
231 uint8_t
getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr);
235 uint8_t
getStrDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t index, uint16_t langid, uint8_t* dataptr);
236 uint8_t
setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr);
237 uint8_t
setConf(uint8_t addr, uint8_t ep, uint8_t conf_value);
239 uint8_t
ctrlData(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr,
boolean direction);
240 uint8_t
ctrlStatus(uint8_t ep,
boolean direction, uint16_t nak_limit);
241 uint8_t
inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t* data);
242 uint8_t
outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* data);
243 uint8_t
dispatchPkt(uint8_t token, uint8_t ep, uint16_t nak_limit);
248 uint8_t
Configuring(uint8_t parent, uint8_t port,
bool lowspeed);
251 uint8_t
ctrlReq(uint8_t addr, uint8_t ep, uint8_t bmReqType, uint8_t bRequest, uint8_t wValLo, uint8_t wValHi,
252 uint16_t wInd, uint16_t total, uint16_t nbytes, uint8_t* dataptr,
USBReadParser *p);
256 uint8_t SetAddress(uint8_t addr, uint8_t ep,
EpInfo **ppep, uint16_t &nak_limit);
257 uint8_t OutTransfer(
EpInfo *pep, uint16_t nak_limit, uint16_t nbytes, uint8_t *data);
258 uint8_t InTransfer(
EpInfo *pep, uint16_t nak_limit, uint16_t *nbytesptr, uint8_t *data);
259 uint8_t AttemptConfig(uint8_t driver, uint8_t parent, uint8_t port,
bool lowspeed);
262 #if 0 //defined(USB_METHODS_INLINE)
265 inline uint8_t
USB::getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr) {
270 inline uint8_t
USB::getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr) {
275 inline uint8_t
USB::getStrDescr(uint8_t addr, uint8_t ep, uint16_t nuint8_ts, uint8_t index, uint16_t langid, uint8_t* dataptr) {
280 inline uint8_t
USB::setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr) {
285 inline uint8_t
USB::setConf(uint8_t addr, uint8_t ep, uint8_t conf_value) {
289 #endif // defined(USB_METHODS_INLINE)
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t *dataptr)
virtual uint8_t GetAddress()
EpInfo * getEpInfoEntry(uint8_t addr, uint8_t ep)
#define USB_DESCRIPTOR_STRING
#define USB_REQUEST_GET_DESCRIPTOR
#define USB_DESCRIPTOR_DEVICE
uint8_t setConf(uint8_t addr, uint8_t ep, uint8_t conf_value)
uint8_t setEpInfoEntry(uint8_t addr, uint8_t epcount, EpInfo *eprecord_ptr)
virtual uint8_t ConfigureDevice(uint8_t parent, uint8_t port, bool lowspeed)
uint8_t ctrlReq(uint8_t addr, uint8_t ep, uint8_t bmReqType, uint8_t bRequest, uint8_t wValLo, uint8_t wValHi, uint16_t wInd, uint16_t total, uint16_t nbytes, uint8_t *dataptr, USBReadParser *p)
#define USB_DESCRIPTOR_CONFIGURATION
uint8_t setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr)
uint8_t ctrlStatus(uint8_t ep, boolean direction, uint16_t nak_limit)
void(* UsbDeviceHandleFunc)(UsbDevice *pdev)
void setUsbTaskState(uint8_t state)
uint8_t outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *data)
virtual void ResetHubPort(uint8_t port)
#define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS
uint8_t getStrDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t index, uint16_t langid, uint8_t *dataptr)
#define USB_REQUEST_SET_ADDRESS
MAX3421e< P10, P9 > MAX3421E
uint8_t getUsbTaskState(void)
uint8_t inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t *data)
virtual boolean DEVCLASSOK(uint8_t klass)
void ForEachUsbDevice(UsbDeviceHandleFunc pfunc)
uint8_t ctrlData(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *dataptr, boolean direction)
uint8_t dispatchPkt(uint8_t token, uint8_t ep, uint16_t nak_limit)
virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed)
AddressPool & GetAddressPool()
uint8_t Configuring(uint8_t parent, uint8_t port, bool lowspeed)
virtual boolean VIDPIDOK(uint16_t vid, uint16_t pid)
virtual uint8_t Release()
uint8_t RegisterDeviceClass(USBDeviceConfig *pdev)
void ForEachUsbDevice(UsbDeviceHandleFunc pfunc)
#define USB_REQUEST_SET_CONFIGURATION
uint8_t DefaultAddressing(uint8_t parent, uint8_t port, bool lowspeed)
uint8_t getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *dataptr)
defined(USB_METHODS_INLINE)
uint8_t ReleaseDevice(uint8_t addr)