USB Host Shield 2.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Usb.h
Go to the documentation of this file.
1 /* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.
2 
3 This software may be distributed and modified under the terms of the GNU
4 General Public License version 2 (GPL2) as published by the Free Software
5 Foundation and appearing in the file GPL2.TXT included in the packaging of
6 this file. Please note that GPL2 Section 2[b] requires that all works based
7 on this software must also be made publicly available under the terms of
8 the GPL2 ("Copyleft").
9 
10 Contact information
11 -------------------
12 
13 Circuits At Home, LTD
14 Web : http://www.circuitsathome.com
15 e-mail : support@circuitsathome.com
16  */
17 /* USB functions */
18 #ifndef _usb_h_
19 #define _usb_h_
20 
21 //#define BOARD_BLACK_WIDDOW
22 
23 // Not used anymore?
24 //#define USB_METHODS_INLINE
25 
26 #include <inttypes.h>
27 
28 #include <assert.h>
29 
30 #include "avrpins.h"
31 #include "max3421e.h"
32 #include "usbhost.h"
33 #include "usb_ch9.h"
34 #include "address.h"
35 
36 #if defined(ARDUINO) && ARDUINO >=100
37 #include "Arduino.h"
38 #else
39 #include <WProgram.h>
40 #endif
41 #include "message.h"
42 
43 /* shield pins. First parameter - SS pin, second parameter - INT pin */
44 
45 #if defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB1286__)
46 #define BOARD_TEENSY_PLUS_PLUS
47 #endif
48 
49 #ifdef BOARD_BLACK_WIDDOW
50 typedef MAX3421e<P6, P3> MAX3421E; // Black Widow
51 #elif defined(BOARD_TEENSY_PLUS_PLUS)
52 typedef MAX3421e<P9, P8> MAX3421E; // Teensy++ 2.0 & 1.0
53 #elif defined(BOARD_MEGA_ADK)
54 typedef MAX3421e<P53, P54> MAX3421E; // Arduino Mega ADK
55 #elif defined(BOARD_BALANDUINO)
56 typedef MAX3421e<P20, P19> MAX3421E; // Balanduino
57 #else
58 typedef MAX3421e<P10, P9> MAX3421E; // Official Arduinos (UNO, Duemilanove, Mega, 2560, Leonardo etc.)
59 #endif
60 
61 //Debug macros. In 1.0 it is possible to move strings to PROGMEM by defining USBTRACE (USB_HOST_SERIAL.print(F(s)))
62 #define USBTRACE(s) (Notify(PSTR(s), 0x80))
63 #define USBTRACE2(s,r) (Notify(PSTR(s), 0x80), PrintHex((r), 0x80), Notify(PSTR("\r\n"), 0x80))
64 
65 
66 
67 /* Common setup data constant combinations */
68 #define bmREQ_GET_DESCR USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_STANDARD|USB_SETUP_RECIPIENT_DEVICE //get descriptor request type
69 #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'
70 #define bmREQ_CL_GET_INTF USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE //get interface request type
71 
72 // D7 data transfer direction (0 - host-to-device, 1 - device-to-host)
73 // D6-5 Type (0- standard, 1 - class, 2 - vendor, 3 - reserved)
74 // D4-0 Recipient (0 - device, 1 - interface, 2 - endpoint, 3 - other, 4..31 - reserved)
75 
76 // USB Device Classes
77 #define USB_CLASS_USE_CLASS_INFO 0x00 // Use Class Info in the Interface Descriptors
78 #define USB_CLASS_AUDIO 0x01 // Audio
79 #define USB_CLASS_COM_AND_CDC_CTRL 0x02 // Communications and CDC Control
80 #define USB_CLASS_HID 0x03 // HID
81 #define USB_CLASS_PHYSICAL 0x05 // Physical
82 #define USB_CLASS_IMAGE 0x06 // Image
83 #define USB_CLASS_PRINTER 0x07 // Printer
84 #define USB_CLASS_MASS_STORAGE 0x08 // Mass Storage
85 #define USB_CLASS_HUB 0x09 // Hub
86 #define USB_CLASS_CDC_DATA 0x0a // CDC-Data
87 #define USB_CLASS_SMART_CARD 0x0b // Smart-Card
88 #define USB_CLASS_CONTENT_SECURITY 0x0d // Content Security
89 #define USB_CLASS_VIDEO 0x0e // Video
90 #define USB_CLASS_PERSONAL_HEALTH 0x0f // Personal Healthcare
91 #define USB_CLASS_DIAGNOSTIC_DEVICE 0xdc // Diagnostic Device
92 #define USB_CLASS_WIRELESS_CTRL 0xe0 // Wireless Controller
93 #define USB_CLASS_MISC 0xef // Miscellaneous
94 #define USB_CLASS_APP_SPECIFIC 0xfe // Application Specific
95 #define USB_CLASS_VENDOR_SPECIFIC 0xff // Vendor Specific
96 
97 // Additional Error Codes
98 #define USB_DEV_CONFIG_ERROR_DEVICE_NOT_SUPPORTED 0xD1
99 #define USB_DEV_CONFIG_ERROR_DEVICE_INIT_INCOMPLETE 0xD2
100 #define USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS 0xD3
101 #define USB_ERROR_OUT_OF_ADDRESS_SPACE_IN_POOL 0xD4
102 #define USB_ERROR_HUB_ADDRESS_OVERFLOW 0xD5
103 #define USB_ERROR_ADDRESS_NOT_FOUND_IN_POOL 0xD6
104 #define USB_ERROR_EPINFO_IS_NULL 0xD7
105 #define USB_ERROR_INVALID_ARGUMENT 0xD8
106 #define USB_ERROR_CLASS_INSTANCE_ALREADY_IN_USE 0xD9
107 #define USB_ERROR_INVALID_MAX_PKT_SIZE 0xDA
108 #define USB_ERROR_EP_NOT_FOUND_IN_TBL 0xDB
109 #define USB_ERROR_CONFIG_REQUIRES_ADDITIONAL_RESET 0xE0
110 #define USB_ERROR_FailGetDevDescr 0xE1
111 #define USB_ERROR_FailSetDevTblEntry 0xE2
112 #define USB_ERROR_FailGetConfDescr 0xE3
113 #define USB_ERROR_TRANSFER_TIMEOUT 0xFF
114 
115 #define USB_XFER_TIMEOUT 10000 //30000 // (5000) USB transfer timeout in milliseconds, per section 9.2.6.1 of USB 2.0 spec
116 //#define USB_NAK_LIMIT 32000 //NAK limit for a transfer. 0 means NAKs are not counted
117 #define USB_RETRY_LIMIT 3 // 3 retry limit for a transfer
118 #define USB_SETTLE_DELAY 200 //settle delay in milliseconds
119 
120 #define USB_NUMDEVICES 16 //number of USB devices
121 //#define HUB_MAX_HUBS 7 // maximum number of hubs that can be attached to the host controller
122 #define HUB_PORT_RESET_DELAY 20 // hub port reset delay 10 ms recomended, can be up to 20 ms
123 
124 /* USB state machine states */
125 #define USB_STATE_MASK 0xf0
126 
127 #define USB_STATE_DETACHED 0x10
128 #define USB_DETACHED_SUBSTATE_INITIALIZE 0x11
129 #define USB_DETACHED_SUBSTATE_WAIT_FOR_DEVICE 0x12
130 #define USB_DETACHED_SUBSTATE_ILLEGAL 0x13
131 #define USB_ATTACHED_SUBSTATE_SETTLE 0x20
132 #define USB_ATTACHED_SUBSTATE_RESET_DEVICE 0x30
133 #define USB_ATTACHED_SUBSTATE_WAIT_RESET_COMPLETE 0x40
134 #define USB_ATTACHED_SUBSTATE_WAIT_SOF 0x50
135 #define USB_ATTACHED_SUBSTATE_WAIT_RESET 0x51
136 #define USB_ATTACHED_SUBSTATE_GET_DEVICE_DESCRIPTOR_SIZE 0x60
137 #define USB_STATE_ADDRESSING 0x70
138 #define USB_STATE_CONFIGURING 0x80
139 #define USB_STATE_RUNNING 0x90
140 #define USB_STATE_ERROR 0xa0
141 
142 class USBDeviceConfig {
143 public:
144  virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed) = 0;
145  virtual uint8_t ConfigureDevice(uint8_t parent, uint8_t port, bool lowspeed) {return 0; }
146  virtual uint8_t Release() = 0;
147  virtual uint8_t Poll() = 0;
148  virtual uint8_t GetAddress() = 0;
149 };
150 
151 /* USB Setup Packet Structure */
152 typedef struct {
153 
154  union { // offset description
155  uint8_t bmRequestType; // 0 Bit-map of request type
156 
157  struct {
158  uint8_t recipient : 5; // Recipient of the request
159  uint8_t type : 2; // Type of request
160  uint8_t direction : 1; // Direction of data X-fer
161  } __attribute__((packed));
162  } ReqType_u;
163  uint8_t bRequest; // 1 Request
164 
165  union {
166  uint16_t wValue; // 2 Depends on bRequest
167 
168  struct {
169  uint8_t wValueLo;
170  uint8_t wValueHi;
171  } __attribute__((packed));
172  } wVal_u;
173  uint16_t wIndex; // 4 Depends on bRequest
174  uint16_t wLength; // 6 Depends on bRequest
175 } SETUP_PKT, *PSETUP_PKT __attribute__((packed));
176 
177 
178 
179 // Base class for incoming data parser
180 
181 class USBReadParser {
182 public:
183  virtual void Parse(const uint16_t len, const uint8_t *pbuf, const uint16_t &offset) = 0;
184 };
185 
186 class USB : public MAX3421E {
187  AddressPoolImpl<USB_NUMDEVICES> addrPool;
188  USBDeviceConfig* devConfig[USB_NUMDEVICES];
189  uint8_t devConfigIndex;
190  uint8_t bmHubPre;
191 
192 public:
193  USB(void);
194 
195  void SetHubPreMask() {
196  bmHubPre |= bmHUBPRE;
197  };
198 
199  void ResetHubPreMask() {
200  bmHubPre &= (~bmHUBPRE);
201  };
202 
203  AddressPool& GetAddressPool() {
204  return(AddressPool&) addrPool;
205  };
206 
207  uint8_t RegisterDeviceClass(USBDeviceConfig *pdev) {
208  for(uint8_t i = 0; i < USB_NUMDEVICES; i++) {
209  if(!devConfig[i]) {
210  devConfig[i] = pdev;
211  return 0;
212  }
213  }
214  return USB_ERROR_UNABLE_TO_REGISTER_DEVICE_CLASS;
215  };
216 
217  void ForEachUsbDevice(UsbDeviceHandleFunc pfunc) {
218  addrPool.ForEachUsbDevice(pfunc);
219  };
220  uint8_t getUsbTaskState(void);
221  void setUsbTaskState(uint8_t state);
222 
223  EpInfo* getEpInfoEntry(uint8_t addr, uint8_t ep);
224  uint8_t setEpInfoEntry(uint8_t addr, uint8_t epcount, EpInfo* eprecord_ptr);
225 
226  //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 nbytes, uint8_t* dataptr);
227 
228  /* Control requests */
229  uint8_t getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr);
230  uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr);
231 
232  uint8_t getConfDescr(uint8_t addr, uint8_t ep, uint8_t conf, USBReadParser *p);
233 
234  uint8_t getStrDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t index, uint16_t langid, uint8_t* dataptr);
235  uint8_t setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr);
236  uint8_t setConf(uint8_t addr, uint8_t ep, uint8_t conf_value);
237 
238  uint8_t ctrlData(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr, boolean direction);
239  uint8_t ctrlStatus(uint8_t ep, boolean direction, uint16_t nak_limit);
240  uint8_t inTransfer(uint8_t addr, uint8_t ep, uint16_t *nbytesptr, uint8_t* data);
241  uint8_t outTransfer(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* data);
242  uint8_t dispatchPkt(uint8_t token, uint8_t ep, uint16_t nak_limit);
243 
244  void Task(void);
245 
246  uint8_t DefaultAddressing(uint8_t parent, uint8_t port, bool lowspeed);
247  uint8_t Configuring(uint8_t parent, uint8_t port, bool lowspeed);
248  uint8_t ReleaseDevice(uint8_t addr);
249 
250  uint8_t ctrlReq(uint8_t addr, uint8_t ep, uint8_t bmReqType, uint8_t bRequest, uint8_t wValLo, uint8_t wValHi,
251  uint16_t wInd, uint16_t total, uint16_t nbytes, uint8_t* dataptr, USBReadParser *p);
252 
253 private:
254  void init();
255  uint8_t SetAddress(uint8_t addr, uint8_t ep, EpInfo **ppep, uint16_t &nak_limit);
256  uint8_t OutTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t nbytes, uint8_t *data);
257  uint8_t InTransfer(EpInfo *pep, uint16_t nak_limit, uint16_t *nbytesptr, uint8_t *data);
258 };
259 
260 #if 0 //defined(USB_METHODS_INLINE)
261 //get device descriptor
262 
263 inline uint8_t USB::getDevDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t* dataptr) {
264  return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, 0x00, USB_DESCRIPTOR_DEVICE, 0x0000, nbytes, dataptr));
265 }
266 //get configuration descriptor
267 
268 inline uint8_t USB::getConfDescr(uint8_t addr, uint8_t ep, uint16_t nbytes, uint8_t conf, uint8_t* dataptr) {
269  return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, conf, USB_DESCRIPTOR_CONFIGURATION, 0x0000, nbytes, dataptr));
270 }
271 //get string descriptor
272 
273 inline uint8_t USB::getStrDescr(uint8_t addr, uint8_t ep, uint16_t nuint8_ts, uint8_t index, uint16_t langid, uint8_t* dataptr) {
274  return( ctrlReq(addr, ep, bmREQ_GET_DESCR, USB_REQUEST_GET_DESCRIPTOR, index, USB_DESCRIPTOR_STRING, langid, nuint8_ts, dataptr));
275 }
276 //set address
277 
278 inline uint8_t USB::setAddr(uint8_t oldaddr, uint8_t ep, uint8_t newaddr) {
279  return( ctrlReq(oldaddr, ep, bmREQ_SET, USB_REQUEST_SET_ADDRESS, newaddr, 0x00, 0x0000, 0x0000, NULL));
280 }
281 //set configuration
282 
283 inline uint8_t USB::setConf(uint8_t addr, uint8_t ep, uint8_t conf_value) {
284  return( ctrlReq(addr, ep, bmREQ_SET, USB_REQUEST_SET_CONFIGURATION, conf_value, 0x00, 0x0000, 0x0000, NULL));
285 }
286 
287 #endif // defined(USB_METHODS_INLINE)
288 
289 #endif //_usb_h_
Generated by   doxygen 1.8.4