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