USB Host Shield 2.0
Loading...
Searching...
No Matches
UsbCore.h
Go to the documentation of this file.
1/* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.
2
3This program is free software; you can redistribute it and/or modify
4it under the terms of the GNU General Public License as published by
5the Free Software Foundation; either version 2 of the License, or
6(at your option) any later version.
7
8This program is distributed in the hope that it will be useful,
9but WITHOUT ANY WARRANTY; without even the implied warranty of
10MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11GNU General Public License for more details.
12
13You should have received a copy of the GNU General Public License
14along with this program; if not, write to the Free Software
15Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17Contact information
18-------------------
19
20Circuits At Home, LTD
21Web : http://www.circuitsathome.com
22e-mail : support@circuitsathome.com
23 */
24
25#if !defined(_usb_h_) || defined(USBCORE_H)
26#error "Never include UsbCore.h directly; include Usb.h instead"
27#else
28#define USBCORE_H
29
30// Not used anymore? If anyone uses this, please let us know so that this may be
31// moved to the proper place, settings.h.
32//#define USB_METHODS_INLINE
33
34/* shield pins. First parameter - SS pin, second parameter - INT pin */
35#ifdef BOARD_BLACK_WIDDOW
36typedef MAX3421e<P6, P3> MAX3421E; // Black Widow
37#elif defined(CORE_TEENSY) && (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__))
38#if EXT_RAM
39typedef MAX3421e<P20, P7> MAX3421E; // Teensy++ 2.0 with XMEM2
40#else
41typedef MAX3421e<P9, P8> MAX3421E; // Teensy++ 1.0 and 2.0
42#endif
43#elif defined(BOARD_MEGA_ADK)
44typedef MAX3421e<P53, P54> MAX3421E; // Arduino Mega ADK
45#elif defined(ARDUINO_AVR_BALANDUINO)
46typedef MAX3421e<P20, P19> MAX3421E; // Balanduino
47#elif defined(__ARDUINO_X86__) && PLATFORM_ID == 0x06
48typedef MAX3421e<P3, P2> MAX3421E; // The Intel Galileo supports much faster read and write speed at pin 2 and 3
49#elif defined(ESP8266)
50typedef MAX3421e<P15, P5> MAX3421E; // ESP8266 boards
51#elif defined(ARDUINO_M5STACK_CORES3)
52typedef MAX3421e<P1, P14> MAX3421E; // M5Stack Core S3
53#elif defined(ARDUINO_XIAO_ESP32S3)
54typedef MAX3421e<P44, P4> MAX3421E; // ESP32 XIAO boards
55#elif defined(ESP32)
56typedef MAX3421e<P5, P17> MAX3421E; // ESP32 boards
57#elif defined(ARDUINO_Seeed_XIAO_nRF52840_Sense)
58typedef MAX3421e<P7, P5> MAX3421E; // Seeed_XIAO_nRF52840_Sense
59#elif defined(MIGHTYCORE)
60typedef MAX3421e<Pb4, Pb3> MAX3421E; // MightyCore
61#elif (defined(__AVR_ATmega644P__) || defined(__AVR_ATmega1284P__))
62typedef MAX3421e<Pb4, Pb3> MAX3421E; // Sanguino
63#elif defined(ARDUINO_NRF52840_FEATHER_SENSE)
64typedef MAX3421e<P5, P6> MAX3421E; // ARDUINO_NRF52840_FEATHER_SENSE
65#else
66typedef MAX3421e<P10, P9> MAX3421E; // Official Arduinos (UNO, Duemilanove, Mega, 2560, Leonardo, Due etc.), Intel Edison, Intel Galileo 2 or Teensy 2.0 and 3.x
67#endif
68
69/* Common setup data constant combinations */
70#define bmREQ_GET_DESCR USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_STANDARD|USB_SETUP_RECIPIENT_DEVICE //get descriptor request type
71#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'
72#define bmREQ_CL_GET_INTF USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE //get interface request type
73
74// D7 data transfer direction (0 - host-to-device, 1 - device-to-host)
75// D6-5 Type (0- standard, 1 - class, 2 - vendor, 3 - reserved)
76// D4-0 Recipient (0 - device, 1 - interface, 2 - endpoint, 3 - other, 4..31 - reserved)
77
78// USB Device Classes
79#define USB_CLASS_USE_CLASS_INFO 0x00 // Use Class Info in the Interface Descriptors
80#define USB_CLASS_AUDIO 0x01 // Audio
81#define USB_CLASS_COM_AND_CDC_CTRL 0x02 // Communications and CDC Control
82#define USB_CLASS_HID 0x03 // HID
83#define USB_CLASS_PHYSICAL 0x05 // Physical
84#define USB_CLASS_IMAGE 0x06 // Image
85#define USB_CLASS_PRINTER 0x07 // Printer
86#define USB_CLASS_MASS_STORAGE 0x08 // Mass Storage
87#define USB_CLASS_HUB 0x09 // Hub
88#define USB_CLASS_CDC_DATA 0x0a // CDC-Data
89#define USB_CLASS_SMART_CARD 0x0b // Smart-Card
90#define USB_CLASS_CONTENT_SECURITY 0x0d // Content Security
91#define USB_CLASS_VIDEO 0x0e // Video
92#define USB_CLASS_PERSONAL_HEALTH 0x0f // Personal Healthcare
93#define USB_CLASS_DIAGNOSTIC_DEVICE 0xdc // Diagnostic Device
94#define USB_CLASS_WIRELESS_CTRL 0xe0 // Wireless Controller
95#define USB_CLASS_MISC 0xef // Miscellaneous
96#define USB_CLASS_APP_SPECIFIC 0xfe // Application Specific
97#define USB_CLASS_VENDOR_SPECIFIC 0xff // Vendor Specific
98
99// Additional Error Codes
100#define USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED 0xD1
101#define USB_DEV_CONFIG_ERROR_DEVICE_INIT_INCOMPLETE 0xD2
102#define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS 0xD3
103#define USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL 0xD4
104#define USB_ERROR_HUB_ADDRESS_OVERFLOW 0xD5
105#define USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL 0xD6
106#define USB_ERROR_EPINFO_IS_NULL 0xD7
107#define USB_ERROR_INVALID_ARGUMENT 0xD8
108#define USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE 0xD9
109#define USB_ERROR_INVALID_MAX_PKT_SIZE 0xDA
110#define USB_ERROR_EP_NOT_FOUND_IN_TBL 0xDB
111#define USB_ERROR_CONFIG_REQUIRES_ADDITIONAL_RESET 0xE0
112#define USB_ERROR_FailGetDevDescr 0xE1
113#define USB_ERROR_FailSetDevTblEntry 0xE2
114#define USB_ERROR_FailGetConfDescr 0xE3
115#define USB_ERROR_TRANSFER_TIMEOUT 0xFF
116
117#define USB_XFER_TIMEOUT 5000 // (5000) USB transfer timeout in milliseconds, per section 9.2.6.1 of USB 2.0 spec
118//#define USB_NAK_LIMIT 32000 // NAK limit for a transfer. 0 means NAKs are not counted
119#define USB_RETRY_LIMIT 3 // 3 retry limit for a transfer
120#define USB_SETTLE_DELAY 200 // settle delay in milliseconds
121
122#define USB_NUMDEVICES 16 //number of USB devices
123//#define HUB_MAX_HUBS 7 // maximum number of hubs that can be attached to the host controller
124#define HUB_PORT_RESET_DELAY 20 // hub port reset delay 10 ms recomended, can be up to 20 ms
125
126/* USB state machine states */
127#define USB_STATE_MASK 0xf0
128
129#define USB_STATE_DETACHED 0x10
130#define USB_DETACHED_SUBSTATE_INITIALIZE 0x11
131#define USB_DETACHED_SUBSTATE_WAIT_FOR_DEVICE 0x12
132#define USB_DETACHED_SUBSTATE_ILLEGAL 0x13
133#define USB_ATTACHED_SUBSTATE_SETTLE 0x20
134#define USB_ATTACHED_SUBSTATE_RESET_DEVICE 0x30
135#define USB_ATTACHED_SUBSTATE_WAIT_RESET_COMPLETE 0x40
136#define USB_ATTACHED_SUBSTATE_WAIT_SOF 0x50
137#define USB_ATTACHED_SUBSTATE_WAIT_RESET 0x51
138#define USB_ATTACHED_SUBSTATE_GET_DEVICE_DESCRIPTOR_SIZE 0x60
139#define USB_STATE_ADDRESSING 0x70
140#define USB_STATE_CONFIGURING 0x80
141#define USB_STATE_RUNNING 0x90
142#define USB_STATE_ERROR 0xa0
143
145public:
146
147 virtual uint8_t Init(uint8_t parent __attribute__((unused)), uint8_t port __attribute__((unused)), bool lowspeed __attribute__((unused))) {
148 return 0;
149 }
150
151 virtual uint8_t ConfigureDevice(uint8_t parent __attribute__((unused)), uint8_t port __attribute__((unused)), bool lowspeed __attribute__((unused))) {
152 return 0;
153 }
154
155 virtual uint8_t Release() {
156 return 0;
157 }
158
159 virtual uint8_t Poll() {
160 return 0;
161 }
162
163 virtual uint8_t GetAddress() {
164 return 0;
165 }
166
167 virtual void ResetHubPort(uint8_t port __attribute__((unused))) {
168 return;
169 } // Note used for hubs only!
170
171 virtual bool VIDPIDOK(uint16_t vid __attribute__((unused)), uint16_t pid __attribute__((unused))) {
172 return false;
173 }
174
175 virtual bool DEVCLASSOK(uint8_t klass __attribute__((unused))) {
176 return false;
177 }
178
179 virtual bool DEVSUBCLASSOK(uint8_t subklass __attribute__((unused))) {
180 return true;
181 }
182
183};
184
185/* USB Setup Packet Structure */
186typedef struct {
187
188 union { // offset description
189 uint8_t bmRequestType; // 0 Bit-map of request type
190
191 struct {
192 uint8_t recipient : 5; // Recipient of the request
193 uint8_t type : 2; // Type of request
194 uint8_t direction : 1; // Direction of data X-fer
196 } ReqType_u;
197 uint8_t bRequest; // 1 Request
198
199 union {
200 uint16_t wValue; // 2 Depends on bRequest
201
202 struct {
206 } wVal_u;
207 uint16_t wIndex; // 4 Depends on bRequest
208 uint16_t wLength; // 6 Depends on bRequest
210
211
212
213// Base class for incoming data parser
214
216public:
217 virtual void Parse(const uint16_t len, const uint8_t *pbuf, const uint16_t &offset) = 0;
218};
219
220class USB : public MAX3421E {
223 uint8_t bmHubPre;
224
225public:
226 USB(void);
227
229 bmHubPre |= bmHUBPRE;
230 };
231
233 bmHubPre &= (~bmHUBPRE);
234 };
235
237 return (AddressPool&)addrPool;
238 };
239
241 for(uint8_t i = 0; i < USB_NUMDEVICES; i++) {
242 if(!devConfig[i]) {
243 devConfig[i] = pdev;
244 return 0;
245 }
246 }
248 };
249
251 addrPool.ForEachUsbDevice(pfunc);
252 };
255
258
259 /* Control requests */
262
264
268
274
275 void Task(void);
276
278 uint8_t Configuring(uint8_t parent, uint8_t port, bool lowspeed);
280
283
284private:
285 void init();
287 uint8_t OutTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t nbytes, uint8_t *data);
288 uint8_t InTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t *nbytesptr, uint8_t *data, uint8_t bInterval = 0);
289 uint8_t AttemptConfig(uint8_t driver, uint8_t parent, uint8_t port, bool lowspeed);
290};
291
292#if 0 //defined(USB_METHODS_INLINE)
293//get device descriptor
294
297}
298//get configuration descriptor
299
302}
303//get string descriptor
304
307}
308//set address
309
311 return ( ctrlReq(oldaddr, ep, bmREQ_SET, USB_REQUEST_SET_ADDRESS, newaddr, 0x00, 0x0000, 0x0000, NULL));
312}
313//set configuration
314
316 return ( ctrlReq(addr, ep, bmREQ_SET, USB_REQUEST_SET_CONFIGURATION, conf_value, 0x00, 0x0000, 0x0000, NULL));
317}
318
319#endif // defined(USB_METHODS_INLINE)
320
321#endif /* USBCORE_H */
#define USB_NUMDEVICES
Definition UsbCore.h:122
#define bmREQ_GET_DESCR
Definition UsbCore.h:70
#define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS
Definition UsbCore.h:102
MAX3421e< P10, P9 > MAX3421E
Definition UsbCore.h:66
struct SETUP_PKT * PSETUP_PKT
#define bmREQ_SET
Definition UsbCore.h:71
void(* UsbDeviceHandleFunc)(UsbDevice *pdev)
Definition address.h:97
virtual void ResetHubPort(uint8_t port)
Definition UsbCore.h:167
virtual bool DEVCLASSOK(uint8_t klass)
Definition UsbCore.h:175
virtual uint8_t GetAddress()
Definition UsbCore.h:163
virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed)
Definition UsbCore.h:147
virtual uint8_t Release()
Definition UsbCore.h:155
virtual uint8_t Poll()
Definition UsbCore.h:159
virtual bool DEVSUBCLASSOK(uint8_t subklass)
Definition UsbCore.h:179
virtual uint8_t ConfigureDevice(uint8_t parent, uint8_t port, bool lowspeed)
Definition UsbCore.h:151
virtual bool VIDPIDOK(uint16_t vid, uint16_t pid)
Definition UsbCore.h:171
Definition UsbCore.h:220
AddressPool & GetAddressPool()
Definition UsbCore.h:236
uint8_t ctrlData(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *dataptr, bool direction)
uint8_t getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *dataptr)
defined(USB_METHODS_INLINE)
Definition Usb.cpp:801
uint8_t getUsbTaskState(void)
Definition Usb.cpp:36
uint8_t setConf(uint8_t addr, uint8_t ep, uint8_t conf_value)
Definition Usb.cpp:850
uint8_t dispatchPkt(uint8_t token, uint8_t ep, uint16_t nak_limit)
Definition Usb.cpp:406
uint8_t getStrDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t index, uint16_t langid, uint8_t *dataptr)
Definition Usb.cpp:836
uint8_t setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr)
Definition Usb.cpp:841
uint8_t RegisterDeviceClass(USBDeviceConfig *pdev)
Definition UsbCore.h:240
EpInfo * getEpInfoEntry(uint8_t addr, uint8_t ep)
Definition Usb.cpp:44
void ResetHubPreMask()
Definition UsbCore.h:232
uint8_t DefaultAddressing(uint8_t parent, uint8_t port, bool lowspeed)
Definition Usb.cpp:566
uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t *dataptr)
Definition Usb.cpp:806
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)
Definition Usb.cpp:126
uint8_t setEpInfoEntry(uint8_t addr, uint8_t epcount, EpInfo *eprecord_ptr)
Definition Usb.cpp:64
void ForEachUsbDevice(UsbDeviceHandleFunc pfunc)
Definition UsbCore.h:250
void setUsbTaskState(uint8_t state)
Definition Usb.cpp:40
USB(void)
Definition Usb.cpp:25
uint8_t ReleaseDevice(uint8_t addr)
Definition Usb.cpp:786
uint8_t inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t *data, uint8_t bInterval=0)
Definition Usb.cpp:209
uint8_t ctrlStatus(uint8_t ep, bool direction, uint16_t nak_limit)
void SetHubPreMask()
Definition UsbCore.h:228
uint8_t Configuring(uint8_t parent, uint8_t port, bool lowspeed)
Definition Usb.cpp:688
void Task(void)
Definition Usb.cpp:460
uint8_t outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t *data)
Definition Usb.cpp:303
virtual void Parse(const uint16_t len, const uint8_t *pbuf, const uint16_t &offset)=0
#define bmHUBPRE
Definition max3421e.h:172
uint8_t wValueHi
Definition UsbCore.h:204
uint16_t wValue
Definition UsbCore.h:200
uint16_t wLength
Definition UsbCore.h:208
uint16_t wIndex
Definition UsbCore.h:207
uint8_t bRequest
Definition UsbCore.h:197
uint8_t wValueLo
Definition UsbCore.h:203
uint8_t recipient
Definition UsbCore.h:192
uint8_t bmRequestType
Definition UsbCore.h:189
uint8_t direction
Definition UsbCore.h:194
uint8_t type
Definition UsbCore.h:193
#define USB_REQUEST_GET_DESCRIPTOR
Definition usb_ch9.h:44
#define USB_DESCRIPTOR_CONFIGURATION
Definition usb_ch9.h:71
#define USB_REQUEST_SET_CONFIGURATION
Definition usb_ch9.h:47
#define USB_DESCRIPTOR_STRING
Definition usb_ch9.h:72
#define USB_DESCRIPTOR_DEVICE
Definition usb_ch9.h:70
#define USB_REQUEST_SET_ADDRESS
Definition usb_ch9.h:43