mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
Move Usb.h UsbCore.h and trim. Usb.h is now only includes, as it aught to be. Clean up more header files, more include traps.
This commit is contained in:
Andrew J. Kroll
parent
db39f5f347
commit
387ec30447
8 changed files with 289 additions and 258 deletions
248
Usb.h
248
Usb.h
|
|
@ -19,13 +19,12 @@ e-mail : support@circuitsathome.com
|
||||||
#define _usb_h_
|
#define _usb_h_
|
||||||
|
|
||||||
|
|
||||||
// Not used anymore?
|
// WARNING: Do not change the order of includes, or stuff will break!
|
||||||
//#define USB_METHODS_INLINE
|
|
||||||
//#include <assert.h>
|
|
||||||
#include <inttypes.h>
|
#include <inttypes.h>
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
|
|
||||||
|
// None of these should ever be included by a driver, or a user's sketch.
|
||||||
#include "settings.h"
|
#include "settings.h"
|
||||||
#include "printhex.h"
|
#include "printhex.h"
|
||||||
#include "message.h"
|
#include "message.h"
|
||||||
|
|
@ -35,248 +34,7 @@ e-mail : support@circuitsathome.com
|
||||||
#include "avrpins.h"
|
#include "avrpins.h"
|
||||||
#include "usb_ch9.h"
|
#include "usb_ch9.h"
|
||||||
#include "usbhost.h"
|
#include "usbhost.h"
|
||||||
|
#include "UsbCore.h"
|
||||||
/* shield pins. First parameter - SS pin, second parameter - INT pin */
|
|
||||||
#ifdef BOARD_BLACK_WIDDOW
|
|
||||||
typedef MAX3421e<P6, P3> MAX3421E; // Black Widow
|
|
||||||
#elif defined(BOARD_TEENSY_PLUS_PLUS)
|
|
||||||
typedef MAX3421e<P9, P8> MAX3421E; // Teensy++ 2.0 & 1.0
|
|
||||||
#elif defined(BOARD_MEGA_ADK)
|
|
||||||
typedef MAX3421e<P53, P54> MAX3421E; // Arduino Mega ADK
|
|
||||||
#elif defined(BOARD_BALANDUINO)
|
|
||||||
typedef MAX3421e<P20, P19> MAX3421E; // Balanduino
|
|
||||||
#else
|
|
||||||
typedef MAX3421e<P10, P9> MAX3421E; // Official Arduinos (UNO, Duemilanove, Mega, 2560, Leonardo etc.)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
//Debug macros. In 1.0 it is possible to move strings to PROGMEM by defining USBTRACE (USB_HOST_SERIAL.print(F(s)))
|
|
||||||
#define USBTRACE(s) (Notify(PSTR(s), 0x80))
|
|
||||||
#define USBTRACE2(s,r) (Notify(PSTR(s), 0x80), D_PrintHex((r), 0x80), Notify(PSTR("\r\n"), 0x80))
|
|
||||||
|
|
||||||
/* Common setup data constant combinations */
|
|
||||||
#define bmREQ_GET_DESCR USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_STANDARD|USB_SETUP_RECIPIENT_DEVICE //get descriptor request type
|
|
||||||
#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'
|
|
||||||
#define bmREQ_CL_GET_INTF USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE //get interface request type
|
|
||||||
|
|
||||||
// D7 data transfer direction (0 - host-to-device, 1 - device-to-host)
|
|
||||||
// D6-5 Type (0- standard, 1 - class, 2 - vendor, 3 - reserved)
|
|
||||||
// D4-0 Recipient (0 - device, 1 - interface, 2 - endpoint, 3 - other, 4..31 - reserved)
|
|
||||||
|
|
||||||
// USB Device Classes
|
|
||||||
#define USB_CLASS_USE_CLASS_INFO 0x00 // Use Class Info in the Interface Descriptors
|
|
||||||
#define USB_CLASS_AUDIO 0x01 // Audio
|
|
||||||
#define USB_CLASS_COM_AND_CDC_CTRL 0x02 // Communications and CDC Control
|
|
||||||
#define USB_CLASS_HID 0x03 // HID
|
|
||||||
#define USB_CLASS_PHYSICAL 0x05 // Physical
|
|
||||||
#define USB_CLASS_IMAGE 0x06 // Image
|
|
||||||
#define USB_CLASS_PRINTER 0x07 // Printer
|
|
||||||
#define USB_CLASS_MASS_STORAGE 0x08 // Mass Storage
|
|
||||||
#define USB_CLASS_HUB 0x09 // Hub
|
|
||||||
#define USB_CLASS_CDC_DATA 0x0a // CDC-Data
|
|
||||||
#define USB_CLASS_SMART_CARD 0x0b // Smart-Card
|
|
||||||
#define USB_CLASS_CONTENT_SECURITY 0x0d // Content Security
|
|
||||||
#define USB_CLASS_VIDEO 0x0e // Video
|
|
||||||
#define USB_CLASS_PERSONAL_HEALTH 0x0f // Personal Healthcare
|
|
||||||
#define USB_CLASS_DIAGNOSTIC_DEVICE 0xdc // Diagnostic Device
|
|
||||||
#define USB_CLASS_WIRELESS_CTRL 0xe0 // Wireless Controller
|
|
||||||
#define USB_CLASS_MISC 0xef // Miscellaneous
|
|
||||||
#define USB_CLASS_APP_SPECIFIC 0xfe // Application Specific
|
|
||||||
#define USB_CLASS_VENDOR_SPECIFIC 0xff // Vendor Specific
|
|
||||||
|
|
||||||
// Additional Error Codes
|
|
||||||
#define USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED 0xD1
|
|
||||||
#define USB_DEV_CONFIG_ERROR_DEVICE_INIT_INCOMPLETE 0xD2
|
|
||||||
#define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS 0xD3
|
|
||||||
#define USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL 0xD4
|
|
||||||
#define USB_ERROR_HUB_ADDRESS_OVERFLOW 0xD5
|
|
||||||
#define USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL 0xD6
|
|
||||||
#define USB_ERROR_EPINFO_IS_NULL 0xD7
|
|
||||||
#define USB_ERROR_INVALID_ARGUMENT 0xD8
|
|
||||||
#define USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE 0xD9
|
|
||||||
#define USB_ERROR_INVALID_MAX_PKT_SIZE 0xDA
|
|
||||||
#define USB_ERROR_EP_NOT_FOUND_IN_TBL 0xDB
|
|
||||||
#define USB_ERROR_CONFIG_REQUIRES_ADDITIONAL_RESET 0xE0
|
|
||||||
#define USB_ERROR_FailGetDevDescr 0xE1
|
|
||||||
#define USB_ERROR_FailSetDevTblEntry 0xE2
|
|
||||||
#define USB_ERROR_FailGetConfDescr 0xE3
|
|
||||||
#define USB_ERROR_TRANSFER_TIMEOUT 0xFF
|
|
||||||
|
|
||||||
#define USB_XFER_TIMEOUT 10000 //30000 // (5000) USB transfer timeout in milliseconds, per section 9.2.6.1 of USB 2.0 spec
|
|
||||||
//#define USB_NAK_LIMIT 32000 //NAK limit for a transfer. 0 means NAKs are not counted
|
|
||||||
#define USB_RETRY_LIMIT 3 // 3 retry limit for a transfer
|
|
||||||
#define USB_SETTLE_DELAY 200 //settle delay in milliseconds
|
|
||||||
|
|
||||||
#define USB_NUMDEVICES 16 //number of USB devices
|
|
||||||
//#define HUB_MAX_HUBS 7 // maximum number of hubs that can be attached to the host controller
|
|
||||||
#define HUB_PORT_RESET_DELAY 20 // hub port reset delay 10 ms recomended, can be up to 20 ms
|
|
||||||
|
|
||||||
/* USB state machine states */
|
|
||||||
#define USB_STATE_MASK 0xf0
|
|
||||||
|
|
||||||
#define USB_STATE_DETACHED 0x10
|
|
||||||
#define USB_DETACHED_SUBSTATE_INITIALIZE 0x11
|
|
||||||
#define USB_DETACHED_SUBSTATE_WAIT_FOR_DEVICE 0x12
|
|
||||||
#define USB_DETACHED_SUBSTATE_ILLEGAL 0x13
|
|
||||||
#define USB_ATTACHED_SUBSTATE_SETTLE 0x20
|
|
||||||
#define USB_ATTACHED_SUBSTATE_RESET_DEVICE 0x30
|
|
||||||
#define USB_ATTACHED_SUBSTATE_WAIT_RESET_COMPLETE 0x40
|
|
||||||
#define USB_ATTACHED_SUBSTATE_WAIT_SOF 0x50
|
|
||||||
#define USB_ATTACHED_SUBSTATE_WAIT_RESET 0x51
|
|
||||||
#define USB_ATTACHED_SUBSTATE_GET_DEVICE_DESCRIPTOR_SIZE 0x60
|
|
||||||
#define USB_STATE_ADDRESSING 0x70
|
|
||||||
#define USB_STATE_CONFIGURING 0x80
|
|
||||||
#define USB_STATE_RUNNING 0x90
|
|
||||||
#define USB_STATE_ERROR 0xa0
|
|
||||||
|
|
||||||
class USBDeviceConfig {
|
|
||||||
public:
|
|
||||||
virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed) { return 0; }
|
|
||||||
virtual uint8_t ConfigureDevice(uint8_t parent, uint8_t port, bool lowspeed) {return 0; }
|
|
||||||
virtual uint8_t Release() { return 0; }
|
|
||||||
virtual uint8_t Poll() { return 0; }
|
|
||||||
virtual uint8_t GetAddress() { return 0; }
|
|
||||||
virtual void ResetHubPort(uint8_t port) { return; } // Note used for hubs only!
|
|
||||||
virtual boolean VIDPIDOK(uint16_t vid, uint16_t pid) { return false; }
|
|
||||||
virtual boolean DEVCLASSOK(uint8_t klass) { return false; }
|
|
||||||
};
|
|
||||||
|
|
||||||
/* USB Setup Packet Structure */
|
|
||||||
typedef struct {
|
|
||||||
|
|
||||||
union { // offset description
|
|
||||||
uint8_t bmRequestType; // 0 Bit-map of request type
|
|
||||||
|
|
||||||
struct {
|
|
||||||
uint8_t recipient : 5; // Recipient of the request
|
|
||||||
uint8_t type : 2; // Type of request
|
|
||||||
uint8_t direction : 1; // Direction of data X-fer
|
|
||||||
} __attribute__((packed));
|
|
||||||
} ReqType_u;
|
|
||||||
uint8_t bRequest; // 1 Request
|
|
||||||
|
|
||||||
union {
|
|
||||||
uint16_t wValue; // 2 Depends on bRequest
|
|
||||||
|
|
||||||
struct {
|
|
||||||
uint8_t wValueLo;
|
|
||||||
uint8_t wValueHi;
|
|
||||||
} __attribute__((packed));
|
|
||||||
} wVal_u;
|
|
||||||
uint16_t wIndex; // 4 Depends on bRequest
|
|
||||||
uint16_t wLength; // 6 Depends on bRequest
|
|
||||||
} SETUP_PKT, *PSETUP_PKT __attribute__((packed));
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// Base class for incoming data parser
|
|
||||||
|
|
||||||
class USBReadParser {
|
|
||||||
public:
|
|
||||||
virtual void Parse(const uint16_t len, const uint8_t *pbuf, const uint16_t &offset) = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
class USB : public MAX3421E {
|
|
||||||
AddressPoolImpl<USB_NUMDEVICES> addrPool;
|
|
||||||
USBDeviceConfig* devConfig[USB_NUMDEVICES];
|
|
||||||
uint8_t bmHubPre;
|
|
||||||
|
|
||||||
public:
|
|
||||||
USB(void);
|
|
||||||
|
|
||||||
void SetHubPreMask() {
|
|
||||||
bmHubPre |= bmHUBPRE;
|
|
||||||
};
|
|
||||||
|
|
||||||
void ResetHubPreMask() {
|
|
||||||
bmHubPre &= (~bmHUBPRE);
|
|
||||||
};
|
|
||||||
|
|
||||||
AddressPool& GetAddressPool() {
|
|
||||||
return(AddressPool&) addrPool;
|
|
||||||
};
|
|
||||||
|
|
||||||
uint8_t RegisterDeviceClass(USBDeviceConfig *pdev) {
|
|
||||||
for(uint8_t i = 0; i < USB_NUMDEVICES; i++) {
|
|
||||||
if(!devConfig[i]) {
|
|
||||||
devConfig[i] = pdev;
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS;
|
|
||||||
};
|
|
||||||
|
|
||||||
void ForEachUsbDevice(UsbDeviceHandleFunc pfunc) {
|
|
||||||
addrPool.ForEachUsbDevice(pfunc);
|
|
||||||
};
|
|
||||||
uint8_t getUsbTaskState(void);
|
|
||||||
void setUsbTaskState(uint8_t state);
|
|
||||||
|
|
||||||
EpInfo* getEpInfoEntry(uint8_t addr, uint8_t ep);
|
|
||||||
uint8_t setEpInfoEntry(uint8_t addr, uint8_t epcount, EpInfo* eprecord_ptr);
|
|
||||||
|
|
||||||
/* Control requests */
|
|
||||||
uint8_t getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr);
|
|
||||||
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr);
|
|
||||||
|
|
||||||
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint8_t conf, USBReadParser *p);
|
|
||||||
|
|
||||||
uint8_t getStrDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t index, uint16_t langid, uint8_t* dataptr);
|
|
||||||
uint8_t setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr);
|
|
||||||
uint8_t setConf(uint8_t addr, uint8_t ep, uint8_t conf_value);
|
|
||||||
/**/
|
|
||||||
uint8_t ctrlData(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr, boolean direction);
|
|
||||||
uint8_t ctrlStatus(uint8_t ep, boolean direction, uint16_t nak_limit);
|
|
||||||
uint8_t inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t* data);
|
|
||||||
uint8_t outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* data);
|
|
||||||
uint8_t dispatchPkt(uint8_t token, uint8_t ep, uint16_t nak_limit);
|
|
||||||
|
|
||||||
void Task(void);
|
|
||||||
|
|
||||||
uint8_t DefaultAddressing(uint8_t parent, uint8_t port, bool lowspeed);
|
|
||||||
uint8_t Configuring(uint8_t parent, uint8_t port, bool lowspeed);
|
|
||||||
uint8_t ReleaseDevice(uint8_t addr);
|
|
||||||
|
|
||||||
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);
|
|
||||||
|
|
||||||
private:
|
|
||||||
void init();
|
|
||||||
uint8_t SetAddress(uint8_t addr, uint8_t ep, EpInfo **ppep, uint16_t &nak_limit);
|
|
||||||
uint8_t OutTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t nbytes, uint8_t *data);
|
|
||||||
uint8_t InTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t *nbytesptr, uint8_t *data);
|
|
||||||
uint8_t AttemptConfig(uint8_t driver, uint8_t parent, uint8_t port, bool lowspeed);
|
|
||||||
};
|
|
||||||
|
|
||||||
#if 0 //defined(USB_METHODS_INLINE)
|
|
||||||
//get device descriptor
|
|
||||||
|
|
||||||
inline uint8_t USB::getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr) {
|
|
||||||
return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, 0x00, USB_DESCRIPTOR_DEVICE, 0x0000, nbytes, dataptr));
|
|
||||||
}
|
|
||||||
//get configuration descriptor
|
|
||||||
|
|
||||||
inline uint8_t USB::getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr) {
|
|
||||||
return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, conf, USB_DESCRIPTOR_CONFIGURATION, 0x0000, nbytes, dataptr));
|
|
||||||
}
|
|
||||||
//get string descriptor
|
|
||||||
|
|
||||||
inline uint8_t USB::getStrDescr(uint8_t addr, uint8_t ep, uint16_t nuint8_ts, uint8_t index, uint16_t langid, uint8_t* dataptr) {
|
|
||||||
return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, index, USB_DESCRIPTOR_STRING, langid, nuint8_ts, dataptr));
|
|
||||||
}
|
|
||||||
//set address
|
|
||||||
|
|
||||||
inline uint8_t USB::setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr) {
|
|
||||||
return( ctrlReq(oldaddr, ep, bmREQ_SET, USB_REQUEST_SET_ADDRESS, newaddr, 0x00, 0x0000, 0x0000, NULL));
|
|
||||||
}
|
|
||||||
//set configuration
|
|
||||||
|
|
||||||
inline uint8_t USB::setConf(uint8_t addr, uint8_t ep, uint8_t conf_value) {
|
|
||||||
return( ctrlReq(addr, ep, bmREQ_SET, USB_REQUEST_SET_CONFIGURATION, conf_value, 0x00, 0x0000, 0x0000, NULL));
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif // defined(USB_METHODS_INLINE)
|
|
||||||
|
|
||||||
|
|
||||||
#include "parsetools.h"
|
#include "parsetools.h"
|
||||||
#include "confdescparser.h"
|
#include "confdescparser.h"
|
||||||
|
|
||||||
|
|
|
||||||
254
UsbCore.h
Normal file
254
UsbCore.h
Normal file
|
|
@ -0,0 +1,254 @@
|
||||||
|
/*
|
||||||
|
* File: UsbCore.h
|
||||||
|
* Author: root
|
||||||
|
*
|
||||||
|
* Created on September 29, 2013, 9:25 PM
|
||||||
|
*/
|
||||||
|
|
||||||
|
#if !defined(_usb_h_) || defined(USBCORE_H)
|
||||||
|
#error "Never include UsbCore.h directly; include Usb.h instead"
|
||||||
|
#else
|
||||||
|
#define USBCORE_H
|
||||||
|
|
||||||
|
// Not used anymore? If anyone uses this, please let us know so that this may be
|
||||||
|
// moved to the proper place, settings.h.
|
||||||
|
//#define USB_METHODS_INLINE
|
||||||
|
|
||||||
|
/* shield pins. First parameter - SS pin, second parameter - INT pin */
|
||||||
|
#ifdef BOARD_BLACK_WIDDOW
|
||||||
|
typedef MAX3421e<P6, P3> MAX3421E; // Black Widow
|
||||||
|
#elif defined(BOARD_TEENSY_PLUS_PLUS)
|
||||||
|
typedef MAX3421e<P9, P8> MAX3421E; // Teensy++ 2.0 & 1.0
|
||||||
|
#elif defined(BOARD_MEGA_ADK)
|
||||||
|
typedef MAX3421e<P53, P54> MAX3421E; // Arduino Mega ADK
|
||||||
|
#elif defined(BOARD_BALANDUINO)
|
||||||
|
typedef MAX3421e<P20, P19> MAX3421E; // Balanduino
|
||||||
|
#else
|
||||||
|
typedef MAX3421e<P10, P9> MAX3421E; // Official Arduinos (UNO, Duemilanove, Mega, 2560, Leonardo etc.)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/* Common setup data constant combinations */
|
||||||
|
#define bmREQ_GET_DESCR USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_STANDARD|USB_SETUP_RECIPIENT_DEVICE //get descriptor request type
|
||||||
|
#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'
|
||||||
|
#define bmREQ_CL_GET_INTF USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE //get interface request type
|
||||||
|
|
||||||
|
// D7 data transfer direction (0 - host-to-device, 1 - device-to-host)
|
||||||
|
// D6-5 Type (0- standard, 1 - class, 2 - vendor, 3 - reserved)
|
||||||
|
// D4-0 Recipient (0 - device, 1 - interface, 2 - endpoint, 3 - other, 4..31 - reserved)
|
||||||
|
|
||||||
|
// USB Device Classes
|
||||||
|
#define USB_CLASS_USE_CLASS_INFO 0x00 // Use Class Info in the Interface Descriptors
|
||||||
|
#define USB_CLASS_AUDIO 0x01 // Audio
|
||||||
|
#define USB_CLASS_COM_AND_CDC_CTRL 0x02 // Communications and CDC Control
|
||||||
|
#define USB_CLASS_HID 0x03 // HID
|
||||||
|
#define USB_CLASS_PHYSICAL 0x05 // Physical
|
||||||
|
#define USB_CLASS_IMAGE 0x06 // Image
|
||||||
|
#define USB_CLASS_PRINTER 0x07 // Printer
|
||||||
|
#define USB_CLASS_MASS_STORAGE 0x08 // Mass Storage
|
||||||
|
#define USB_CLASS_HUB 0x09 // Hub
|
||||||
|
#define USB_CLASS_CDC_DATA 0x0a // CDC-Data
|
||||||
|
#define USB_CLASS_SMART_CARD 0x0b // Smart-Card
|
||||||
|
#define USB_CLASS_CONTENT_SECURITY 0x0d // Content Security
|
||||||
|
#define USB_CLASS_VIDEO 0x0e // Video
|
||||||
|
#define USB_CLASS_PERSONAL_HEALTH 0x0f // Personal Healthcare
|
||||||
|
#define USB_CLASS_DIAGNOSTIC_DEVICE 0xdc // Diagnostic Device
|
||||||
|
#define USB_CLASS_WIRELESS_CTRL 0xe0 // Wireless Controller
|
||||||
|
#define USB_CLASS_MISC 0xef // Miscellaneous
|
||||||
|
#define USB_CLASS_APP_SPECIFIC 0xfe // Application Specific
|
||||||
|
#define USB_CLASS_VENDOR_SPECIFIC 0xff // Vendor Specific
|
||||||
|
|
||||||
|
// Additional Error Codes
|
||||||
|
#define USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED 0xD1
|
||||||
|
#define USB_DEV_CONFIG_ERROR_DEVICE_INIT_INCOMPLETE 0xD2
|
||||||
|
#define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS 0xD3
|
||||||
|
#define USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL 0xD4
|
||||||
|
#define USB_ERROR_HUB_ADDRESS_OVERFLOW 0xD5
|
||||||
|
#define USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL 0xD6
|
||||||
|
#define USB_ERROR_EPINFO_IS_NULL 0xD7
|
||||||
|
#define USB_ERROR_INVALID_ARGUMENT 0xD8
|
||||||
|
#define USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE 0xD9
|
||||||
|
#define USB_ERROR_INVALID_MAX_PKT_SIZE 0xDA
|
||||||
|
#define USB_ERROR_EP_NOT_FOUND_IN_TBL 0xDB
|
||||||
|
#define USB_ERROR_CONFIG_REQUIRES_ADDITIONAL_RESET 0xE0
|
||||||
|
#define USB_ERROR_FailGetDevDescr 0xE1
|
||||||
|
#define USB_ERROR_FailSetDevTblEntry 0xE2
|
||||||
|
#define USB_ERROR_FailGetConfDescr 0xE3
|
||||||
|
#define USB_ERROR_TRANSFER_TIMEOUT 0xFF
|
||||||
|
|
||||||
|
#define USB_XFER_TIMEOUT 10000 //30000 // (5000) USB transfer timeout in milliseconds, per section 9.2.6.1 of USB 2.0 spec
|
||||||
|
//#define USB_NAK_LIMIT 32000 //NAK limit for a transfer. 0 means NAKs are not counted
|
||||||
|
#define USB_RETRY_LIMIT 3 // 3 retry limit for a transfer
|
||||||
|
#define USB_SETTLE_DELAY 200 //settle delay in milliseconds
|
||||||
|
|
||||||
|
#define USB_NUMDEVICES 16 //number of USB devices
|
||||||
|
//#define HUB_MAX_HUBS 7 // maximum number of hubs that can be attached to the host controller
|
||||||
|
#define HUB_PORT_RESET_DELAY 20 // hub port reset delay 10 ms recomended, can be up to 20 ms
|
||||||
|
|
||||||
|
/* USB state machine states */
|
||||||
|
#define USB_STATE_MASK 0xf0
|
||||||
|
|
||||||
|
#define USB_STATE_DETACHED 0x10
|
||||||
|
#define USB_DETACHED_SUBSTATE_INITIALIZE 0x11
|
||||||
|
#define USB_DETACHED_SUBSTATE_WAIT_FOR_DEVICE 0x12
|
||||||
|
#define USB_DETACHED_SUBSTATE_ILLEGAL 0x13
|
||||||
|
#define USB_ATTACHED_SUBSTATE_SETTLE 0x20
|
||||||
|
#define USB_ATTACHED_SUBSTATE_RESET_DEVICE 0x30
|
||||||
|
#define USB_ATTACHED_SUBSTATE_WAIT_RESET_COMPLETE 0x40
|
||||||
|
#define USB_ATTACHED_SUBSTATE_WAIT_SOF 0x50
|
||||||
|
#define USB_ATTACHED_SUBSTATE_WAIT_RESET 0x51
|
||||||
|
#define USB_ATTACHED_SUBSTATE_GET_DEVICE_DESCRIPTOR_SIZE 0x60
|
||||||
|
#define USB_STATE_ADDRESSING 0x70
|
||||||
|
#define USB_STATE_CONFIGURING 0x80
|
||||||
|
#define USB_STATE_RUNNING 0x90
|
||||||
|
#define USB_STATE_ERROR 0xa0
|
||||||
|
|
||||||
|
class USBDeviceConfig {
|
||||||
|
public:
|
||||||
|
virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed) { return 0; }
|
||||||
|
virtual uint8_t ConfigureDevice(uint8_t parent, uint8_t port, bool lowspeed) {return 0; }
|
||||||
|
virtual uint8_t Release() { return 0; }
|
||||||
|
virtual uint8_t Poll() { return 0; }
|
||||||
|
virtual uint8_t GetAddress() { return 0; }
|
||||||
|
virtual void ResetHubPort(uint8_t port) { return; } // Note used for hubs only!
|
||||||
|
virtual boolean VIDPIDOK(uint16_t vid, uint16_t pid) { return false; }
|
||||||
|
virtual boolean DEVCLASSOK(uint8_t klass) { return false; }
|
||||||
|
};
|
||||||
|
|
||||||
|
/* USB Setup Packet Structure */
|
||||||
|
typedef struct {
|
||||||
|
|
||||||
|
union { // offset description
|
||||||
|
uint8_t bmRequestType; // 0 Bit-map of request type
|
||||||
|
|
||||||
|
struct {
|
||||||
|
uint8_t recipient : 5; // Recipient of the request
|
||||||
|
uint8_t type : 2; // Type of request
|
||||||
|
uint8_t direction : 1; // Direction of data X-fer
|
||||||
|
} __attribute__((packed));
|
||||||
|
} ReqType_u;
|
||||||
|
uint8_t bRequest; // 1 Request
|
||||||
|
|
||||||
|
union {
|
||||||
|
uint16_t wValue; // 2 Depends on bRequest
|
||||||
|
|
||||||
|
struct {
|
||||||
|
uint8_t wValueLo;
|
||||||
|
uint8_t wValueHi;
|
||||||
|
} __attribute__((packed));
|
||||||
|
} wVal_u;
|
||||||
|
uint16_t wIndex; // 4 Depends on bRequest
|
||||||
|
uint16_t wLength; // 6 Depends on bRequest
|
||||||
|
} SETUP_PKT, *PSETUP_PKT __attribute__((packed));
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Base class for incoming data parser
|
||||||
|
|
||||||
|
class USBReadParser {
|
||||||
|
public:
|
||||||
|
virtual void Parse(const uint16_t len, const uint8_t *pbuf, const uint16_t &offset) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
class USB : public MAX3421E {
|
||||||
|
AddressPoolImpl<USB_NUMDEVICES> addrPool;
|
||||||
|
USBDeviceConfig* devConfig[USB_NUMDEVICES];
|
||||||
|
uint8_t bmHubPre;
|
||||||
|
|
||||||
|
public:
|
||||||
|
USB(void);
|
||||||
|
|
||||||
|
void SetHubPreMask() {
|
||||||
|
bmHubPre |= bmHUBPRE;
|
||||||
|
};
|
||||||
|
|
||||||
|
void ResetHubPreMask() {
|
||||||
|
bmHubPre &= (~bmHUBPRE);
|
||||||
|
};
|
||||||
|
|
||||||
|
AddressPool& GetAddressPool() {
|
||||||
|
return(AddressPool&) addrPool;
|
||||||
|
};
|
||||||
|
|
||||||
|
uint8_t RegisterDeviceClass(USBDeviceConfig *pdev) {
|
||||||
|
for(uint8_t i = 0; i < USB_NUMDEVICES; i++) {
|
||||||
|
if(!devConfig[i]) {
|
||||||
|
devConfig[i] = pdev;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS;
|
||||||
|
};
|
||||||
|
|
||||||
|
void ForEachUsbDevice(UsbDeviceHandleFunc pfunc) {
|
||||||
|
addrPool.ForEachUsbDevice(pfunc);
|
||||||
|
};
|
||||||
|
uint8_t getUsbTaskState(void);
|
||||||
|
void setUsbTaskState(uint8_t state);
|
||||||
|
|
||||||
|
EpInfo* getEpInfoEntry(uint8_t addr, uint8_t ep);
|
||||||
|
uint8_t setEpInfoEntry(uint8_t addr, uint8_t epcount, EpInfo* eprecord_ptr);
|
||||||
|
|
||||||
|
/* Control requests */
|
||||||
|
uint8_t getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr);
|
||||||
|
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr);
|
||||||
|
|
||||||
|
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint8_t conf, USBReadParser *p);
|
||||||
|
|
||||||
|
uint8_t getStrDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t index, uint16_t langid, uint8_t* dataptr);
|
||||||
|
uint8_t setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr);
|
||||||
|
uint8_t setConf(uint8_t addr, uint8_t ep, uint8_t conf_value);
|
||||||
|
/**/
|
||||||
|
uint8_t ctrlData(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr, boolean direction);
|
||||||
|
uint8_t ctrlStatus(uint8_t ep, boolean direction, uint16_t nak_limit);
|
||||||
|
uint8_t inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t* data);
|
||||||
|
uint8_t outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* data);
|
||||||
|
uint8_t dispatchPkt(uint8_t token, uint8_t ep, uint16_t nak_limit);
|
||||||
|
|
||||||
|
void Task(void);
|
||||||
|
|
||||||
|
uint8_t DefaultAddressing(uint8_t parent, uint8_t port, bool lowspeed);
|
||||||
|
uint8_t Configuring(uint8_t parent, uint8_t port, bool lowspeed);
|
||||||
|
uint8_t ReleaseDevice(uint8_t addr);
|
||||||
|
|
||||||
|
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);
|
||||||
|
|
||||||
|
private:
|
||||||
|
void init();
|
||||||
|
uint8_t SetAddress(uint8_t addr, uint8_t ep, EpInfo **ppep, uint16_t &nak_limit);
|
||||||
|
uint8_t OutTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t nbytes, uint8_t *data);
|
||||||
|
uint8_t InTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t *nbytesptr, uint8_t *data);
|
||||||
|
uint8_t AttemptConfig(uint8_t driver, uint8_t parent, uint8_t port, bool lowspeed);
|
||||||
|
};
|
||||||
|
|
||||||
|
#if 0 //defined(USB_METHODS_INLINE)
|
||||||
|
//get device descriptor
|
||||||
|
|
||||||
|
inline uint8_t USB::getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr) {
|
||||||
|
return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, 0x00, USB_DESCRIPTOR_DEVICE, 0x0000, nbytes, dataptr));
|
||||||
|
}
|
||||||
|
//get configuration descriptor
|
||||||
|
|
||||||
|
inline uint8_t USB::getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr) {
|
||||||
|
return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, conf, USB_DESCRIPTOR_CONFIGURATION, 0x0000, nbytes, dataptr));
|
||||||
|
}
|
||||||
|
//get string descriptor
|
||||||
|
|
||||||
|
inline uint8_t USB::getStrDescr(uint8_t addr, uint8_t ep, uint16_t nuint8_ts, uint8_t index, uint16_t langid, uint8_t* dataptr) {
|
||||||
|
return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, index, USB_DESCRIPTOR_STRING, langid, nuint8_ts, dataptr));
|
||||||
|
}
|
||||||
|
//set address
|
||||||
|
|
||||||
|
inline uint8_t USB::setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr) {
|
||||||
|
return( ctrlReq(oldaddr, ep, bmREQ_SET, USB_REQUEST_SET_ADDRESS, newaddr, 0x00, 0x0000, 0x0000, NULL));
|
||||||
|
}
|
||||||
|
//set configuration
|
||||||
|
|
||||||
|
inline uint8_t USB::setConf(uint8_t addr, uint8_t ep, uint8_t conf_value) {
|
||||||
|
return( ctrlReq(addr, ep, bmREQ_SET, USB_REQUEST_SET_CONFIGURATION, conf_value, 0x00, 0x0000, 0x0000, NULL));
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // defined(USB_METHODS_INLINE)
|
||||||
|
|
||||||
|
#endif /* USBCORE_H */
|
||||||
|
|
||||||
|
|
@ -17,7 +17,9 @@ e-mail : support@circuitsathome.com
|
||||||
|
|
||||||
/* derived from Konstantin Chizhov's AVR port templates */
|
/* derived from Konstantin Chizhov's AVR port templates */
|
||||||
|
|
||||||
#ifndef _avrpins_h_
|
#if !defined(_usb_h_) || defined(_avrpins_h_)
|
||||||
|
#error "Never include avrpins.h directly; include Usb.h instead"
|
||||||
|
#else
|
||||||
#define _avrpins_h_
|
#define _avrpins_h_
|
||||||
|
|
||||||
// Support for these boards needs to be manually activated in settings.h or in a makefile
|
// Support for these boards needs to be manually activated in settings.h or in a makefile
|
||||||
|
|
@ -31,7 +33,7 @@ e-mail : support@circuitsathome.com
|
||||||
#define BOARD_BLACK_WIDDOW
|
#define BOARD_BLACK_WIDDOW
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#include <avr/io.h>
|
//#include <avr/io.h>
|
||||||
|
|
||||||
#ifdef PORTA
|
#ifdef PORTA
|
||||||
#define USE_PORTA
|
#define USE_PORTA
|
||||||
|
|
|
||||||
10
macros.h
10
macros.h
|
|
@ -5,7 +5,9 @@
|
||||||
* Created on September 23, 2013, 12:31 AM
|
* Created on September 23, 2013, 12:31 AM
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef MACROS_H
|
#if !defined(_usb_h_) || defined(MACROS_H)
|
||||||
|
#error "Never include macros.h directly; include Usb.h instead"
|
||||||
|
#else
|
||||||
#define MACROS_H
|
#define MACROS_H
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
@ -52,6 +54,12 @@
|
||||||
#define BMAKE64(__usc7__,__usc6__,__usc5__,__usc4__,__usc3__,__usc2__,__usc1__,__usc0__) ((uint64_t)((uint64_t)__usc0__ | (uint64_t)BOVER1(__usc1__) | (uint64_t)BOVER2(__usc2__) | (uint64_t)BOVER3(__usc3__) | (uint64_t)BOVER4(__usc4__) | (uint64_t)BOVER5(__usc5__) | (uint64_t)BOVER6(__usc6__) | (uint64_t)BOVER1(__usc7__)))
|
#define BMAKE64(__usc7__,__usc6__,__usc5__,__usc4__,__usc3__,__usc2__,__usc1__,__usc0__) ((uint64_t)((uint64_t)__usc0__ | (uint64_t)BOVER1(__usc1__) | (uint64_t)BOVER2(__usc2__) | (uint64_t)BOVER3(__usc3__) | (uint64_t)BOVER4(__usc4__) | (uint64_t)BOVER5(__usc5__) | (uint64_t)BOVER6(__usc6__) | (uint64_t)BOVER1(__usc7__)))
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Debug macros: Strings are stored in progmem (flash) instead of RAM.
|
||||||
|
*/
|
||||||
|
#define USBTRACE(s) (Notify(PSTR(s), 0x80))
|
||||||
|
#define USBTRACE2(s,r) (Notify(PSTR(s), 0x80), D_PrintHex((r), 0x80), Notify(PSTR("\r\n"), 0x80))
|
||||||
|
|
||||||
|
|
||||||
#endif /* MACROS_H */
|
#endif /* MACROS_H */
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -75,6 +75,4 @@ void ErrorMessage(char const * msg, ERROR_TYPE rcode = 0) {
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
//#include "hexdump.h"
|
|
||||||
|
|
||||||
#endif // __MESSAGE_H__
|
#endif // __MESSAGE_H__
|
||||||
|
|
|
||||||
15
settings.h
15
settings.h
|
|
@ -16,13 +16,16 @@
|
||||||
/* Set this to 1 to activate serial debugging */
|
/* Set this to 1 to activate serial debugging */
|
||||||
#define ENABLE_UHS_DEBUGGING 0
|
#define ENABLE_UHS_DEBUGGING 0
|
||||||
|
|
||||||
/* This can be used to select which serial port to use if multiple are available */
|
/* This can be used to select which serial port to use for debugging if
|
||||||
|
* multiple serial ports are available.
|
||||||
|
* For example Serial3.
|
||||||
|
*/
|
||||||
#ifndef USB_HOST_SERIAL
|
#ifndef USB_HOST_SERIAL
|
||||||
#define USB_HOST_SERIAL Serial
|
#define USB_HOST_SERIAL Serial
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
// Manual boards activation
|
// Manual board activation
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
/* Set this to 1 if you are using an Arduino Mega ADK board with MAX3421e built-in */
|
/* Set this to 1 if you are using an Arduino Mega ADK board with MAX3421e built-in */
|
||||||
|
|
@ -51,6 +54,9 @@
|
||||||
// AUTOMATIC Settings
|
// AUTOMATIC Settings
|
||||||
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
|
// No user serviceable parts below this line.
|
||||||
|
// DO NOT change anything below here unless you are a developer!
|
||||||
|
|
||||||
#if !defined(DEBUG_USB_HOST) && ENABLE_UHS_DEBUGGING
|
#if !defined(DEBUG_USB_HOST) && ENABLE_UHS_DEBUGGING
|
||||||
#define DEBUG_USB_HOST
|
#define DEBUG_USB_HOST
|
||||||
#endif
|
#endif
|
||||||
|
|
@ -59,13 +65,14 @@
|
||||||
#define BOARD_TEENSY_PLUS_PLUS
|
#define BOARD_TEENSY_PLUS_PLUS
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// No user serviceable parts below this line, DO NOT change anything below here
|
|
||||||
// When will we drop support for the older bug-ridden stuff?
|
// When will we drop support for the older bug-ridden stuff?
|
||||||
#if defined(ARDUINO) && ARDUINO >=100
|
#if defined(ARDUINO) && ARDUINO >=100
|
||||||
#include "Arduino.h"
|
#include "Arduino.h"
|
||||||
#else
|
#else
|
||||||
#include <WProgram.h>
|
#include <WProgram.h>
|
||||||
#endif
|
// I am not sure what WProgram.h does not include, so these are here. --xxxajk
|
||||||
#include <avr/pgmspace.h>
|
#include <avr/pgmspace.h>
|
||||||
|
#include <avr/io.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
#endif /* SETTINGS_H */
|
#endif /* SETTINGS_H */
|
||||||
|
|
@ -14,8 +14,12 @@ Circuits At Home, LTD
|
||||||
Web : http://www.circuitsathome.com
|
Web : http://www.circuitsathome.com
|
||||||
e-mail : support@circuitsathome.com
|
e-mail : support@circuitsathome.com
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
#if !defined(_usb_h_) || defined(_ch9_h_)
|
||||||
|
#error "Never include usb_ch9.h directly; include Usb.h instead"
|
||||||
|
#else
|
||||||
|
|
||||||
/* USB chapter 9 structures */
|
/* USB chapter 9 structures */
|
||||||
#ifndef _ch9_h_
|
|
||||||
#define _ch9_h_
|
#define _ch9_h_
|
||||||
|
|
||||||
/* Misc.USB constants */
|
/* Misc.USB constants */
|
||||||
|
|
|
||||||
|
|
@ -52,10 +52,10 @@ typedef SPi< Pb5, Pb3, Pb4, Pb2 > spi;
|
||||||
typedef SPi< Pb7, Pb5, Pb6, Pb4 > spi;
|
typedef SPi< Pb7, Pb5, Pb6, Pb4 > spi;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
typedef enum VBUS_t {
|
typedef enum {
|
||||||
vbus_on = 0,
|
vbus_on = 0,
|
||||||
vbus_off = GPX_VBDET
|
vbus_off = GPX_VBDET
|
||||||
};
|
} VBUS_t;
|
||||||
|
|
||||||
template< typename SS, typename INTR > class MAX3421e /* : public spi */ {
|
template< typename SS, typename INTR > class MAX3421e /* : public spi */ {
|
||||||
static uint8_t vbusState;
|
static uint8_t vbusState;
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue