usbdevice.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769
  1. /*
  2. * (C) Copyright 2003
  3. * Gerry Hamel, geh@ti.com, Texas Instruments
  4. *
  5. * Based on linux/drivers/usbd/usbd.h
  6. *
  7. * Copyright (c) 2000, 2001, 2002 Lineo
  8. * Copyright (c) 2001 Hewlett Packard
  9. *
  10. * By:
  11. * Stuart Lynne <sl@lineo.com>,
  12. * Tom Rushworth <tbr@lineo.com>,
  13. * Bruce Balden <balden@lineo.com>
  14. *
  15. * This program is free software; you can redistribute it and/or modify
  16. * it under the terms of the GNU General Public License as published by
  17. * the Free Software Foundation; either version 2 of the License, or
  18. * (at your option) any later version.
  19. *
  20. * This program is distributed in the hope that it will be useful,
  21. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23. * GNU General Public License for more details.
  24. *
  25. * You should have received a copy of the GNU General Public License
  26. * along with this program; if not, write to the Free Software
  27. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28. *
  29. */
  30. #ifndef __USBDCORE_H__
  31. #define __USBDCORE_H__
  32. #include <common.h>
  33. #include "usbdescriptors.h"
  34. #define MAX_URBS_QUEUED 5
  35. #if 1
  36. #define usberr(fmt,args...) serial_printf("ERROR: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
  37. #else
  38. #define usberr(fmt,args...) do{}while(0)
  39. #endif
  40. #if 0
  41. #define usbdbg(fmt,args...) serial_printf("debug: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
  42. #else
  43. #define usbdbg(fmt,args...) do{}while(0)
  44. #endif
  45. #if 0
  46. #define usbinfo(fmt,args...) serial_printf("info: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
  47. #else
  48. #define usbinfo(fmt,args...) do{}while(0)
  49. #endif
  50. #ifndef le16_to_cpu
  51. #define le16_to_cpu(x) (x)
  52. #endif
  53. #ifndef inb
  54. #define inb(p) (*(volatile u8*)(p))
  55. #endif
  56. #ifndef outb
  57. #define outb(val,p) (*(volatile u8*)(p) = (val))
  58. #endif
  59. #ifndef inw
  60. #define inw(p) (*(volatile u16*)(p))
  61. #endif
  62. #ifndef outw
  63. #define outw(val,p) (*(volatile u16*)(p) = (val))
  64. #endif
  65. #ifndef inl
  66. #define inl(p) (*(volatile u32*)(p))
  67. #endif
  68. #ifndef outl
  69. #define outl(val,p) (*(volatile u32*)(p) = (val))
  70. #endif
  71. #ifndef insw
  72. #define insw(p,to,len) mmio_insw(p,to,len)
  73. #endif
  74. #ifndef outsw
  75. #define outsw(p,from,len) mmio_outsw(p,from,len)
  76. #endif
  77. #ifndef insb
  78. #define insb(p,to,len) mmio_insb(p,to,len)
  79. #endif
  80. #ifndef mmio_insw
  81. #define mmio_insw(r,b,l) ({ int __i ; \
  82. u16 *__b2; \
  83. __b2 = (u16 *) b; \
  84. for (__i = 0; __i < l; __i++) { \
  85. *(__b2 + __i) = inw(r); \
  86. }; \
  87. })
  88. #endif
  89. #ifndef mmio_outsw
  90. #define mmio_outsw(r,b,l) ({ int __i; \
  91. u16 *__b2; \
  92. __b2 = (u16 *) b; \
  93. for (__i = 0; __i < l; __i++) { \
  94. outw( *(__b2 + __i), r); \
  95. } \
  96. })
  97. #endif
  98. #ifndef mmio_insb
  99. #define mmio_insb(r,b,l) ({ int __i ; \
  100. u8 *__b2; \
  101. __b2 = (u8 *) b; \
  102. for (__i = 0; __i < l; __i++) { \
  103. *(__b2 + __i) = inb(r); \
  104. }; \
  105. })
  106. #endif
  107. /*
  108. * Structure member address manipulation macros.
  109. * These are used by client code (code using the urb_link routines), since
  110. * the urb_link structure is embedded in the client data structures.
  111. *
  112. * Note: a macro offsetof equivalent to member_offset is defined in stddef.h
  113. * but this is kept here for the sake of portability.
  114. *
  115. * p2surround returns a pointer to the surrounding structure given
  116. * type of the surrounding structure, the name memb of the structure
  117. * member pointed at by ptr. For example, if you have:
  118. *
  119. * struct foo {
  120. * int x;
  121. * float y;
  122. * char z;
  123. * } thingy;
  124. *
  125. * char *cp = &thingy.z;
  126. *
  127. * then
  128. *
  129. * &thingy == p2surround(struct foo, z, cp)
  130. *
  131. * Clear?
  132. */
  133. #define _cv_(ptr) ((char*)(void*)(ptr))
  134. #define member_offset(type,memb) (_cv_(&(((type*)0)->memb))-(char*)0)
  135. #define p2surround(type,memb,ptr) ((type*)(void*)(_cv_(ptr)-member_offset(type,memb)))
  136. struct urb;
  137. struct usb_endpoint_instance;
  138. struct usb_interface_instance;
  139. struct usb_configuration_instance;
  140. struct usb_device_instance;
  141. struct usb_bus_instance;
  142. /*
  143. * Device and/or Interface Class codes
  144. */
  145. #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
  146. #define USB_CLASS_AUDIO 1
  147. #define USB_CLASS_COMM 2
  148. #define USB_CLASS_HID 3
  149. #define USB_CLASS_PHYSICAL 5
  150. #define USB_CLASS_PRINTER 7
  151. #define USB_CLASS_MASS_STORAGE 8
  152. #define USB_CLASS_HUB 9
  153. #define USB_CLASS_DATA 10
  154. #define USB_CLASS_APP_SPEC 0xfe
  155. #define USB_CLASS_VENDOR_SPEC 0xff
  156. /*
  157. * USB types
  158. */
  159. #define USB_TYPE_STANDARD (0x00 << 5)
  160. #define USB_TYPE_CLASS (0x01 << 5)
  161. #define USB_TYPE_VENDOR (0x02 << 5)
  162. #define USB_TYPE_RESERVED (0x03 << 5)
  163. /*
  164. * USB recipients
  165. */
  166. #define USB_RECIP_DEVICE 0x00
  167. #define USB_RECIP_INTERFACE 0x01
  168. #define USB_RECIP_ENDPOINT 0x02
  169. #define USB_RECIP_OTHER 0x03
  170. /*
  171. * USB directions
  172. */
  173. #define USB_DIR_OUT 0
  174. #define USB_DIR_IN 0x80
  175. /*
  176. * Descriptor types
  177. */
  178. #define USB_DT_DEVICE 0x01
  179. #define USB_DT_CONFIG 0x02
  180. #define USB_DT_STRING 0x03
  181. #define USB_DT_INTERFACE 0x04
  182. #define USB_DT_ENDPOINT 0x05
  183. #define USB_DT_HID (USB_TYPE_CLASS | 0x01)
  184. #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
  185. #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
  186. #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
  187. /*
  188. * Descriptor sizes per descriptor type
  189. */
  190. #define USB_DT_DEVICE_SIZE 18
  191. #define USB_DT_CONFIG_SIZE 9
  192. #define USB_DT_INTERFACE_SIZE 9
  193. #define USB_DT_ENDPOINT_SIZE 7
  194. #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
  195. #define USB_DT_HUB_NONVAR_SIZE 7
  196. #define USB_DT_HID_SIZE 9
  197. /*
  198. * Endpoints
  199. */
  200. #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
  201. #define USB_ENDPOINT_DIR_MASK 0x80
  202. #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
  203. #define USB_ENDPOINT_XFER_CONTROL 0
  204. #define USB_ENDPOINT_XFER_ISOC 1
  205. #define USB_ENDPOINT_XFER_BULK 2
  206. #define USB_ENDPOINT_XFER_INT 3
  207. /*
  208. * USB Packet IDs (PIDs)
  209. */
  210. #define USB_PID_UNDEF_0 0xf0
  211. #define USB_PID_OUT 0xe1
  212. #define USB_PID_ACK 0xd2
  213. #define USB_PID_DATA0 0xc3
  214. #define USB_PID_PING 0xb4 /* USB 2.0 */
  215. #define USB_PID_SOF 0xa5
  216. #define USB_PID_NYET 0x96 /* USB 2.0 */
  217. #define USB_PID_DATA2 0x87 /* USB 2.0 */
  218. #define USB_PID_SPLIT 0x78 /* USB 2.0 */
  219. #define USB_PID_IN 0x69
  220. #define USB_PID_NAK 0x5a
  221. #define USB_PID_DATA1 0x4b
  222. #define USB_PID_PREAMBLE 0x3c /* Token mode */
  223. #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
  224. #define USB_PID_SETUP 0x2d
  225. #define USB_PID_STALL 0x1e
  226. #define USB_PID_MDATA 0x0f /* USB 2.0 */
  227. /*
  228. * Standard requests
  229. */
  230. #define USB_REQ_GET_STATUS 0x00
  231. #define USB_REQ_CLEAR_FEATURE 0x01
  232. #define USB_REQ_SET_FEATURE 0x03
  233. #define USB_REQ_SET_ADDRESS 0x05
  234. #define USB_REQ_GET_DESCRIPTOR 0x06
  235. #define USB_REQ_SET_DESCRIPTOR 0x07
  236. #define USB_REQ_GET_CONFIGURATION 0x08
  237. #define USB_REQ_SET_CONFIGURATION 0x09
  238. #define USB_REQ_GET_INTERFACE 0x0A
  239. #define USB_REQ_SET_INTERFACE 0x0B
  240. #define USB_REQ_SYNCH_FRAME 0x0C
  241. #define USBD_DEVICE_REQUESTS(x) (((unsigned int)x <= USB_REQ_SYNCH_FRAME) ? usbd_device_requests[x] : "UNKNOWN")
  242. /*
  243. * HID requests
  244. */
  245. #define USB_REQ_GET_REPORT 0x01
  246. #define USB_REQ_GET_IDLE 0x02
  247. #define USB_REQ_GET_PROTOCOL 0x03
  248. #define USB_REQ_SET_REPORT 0x09
  249. #define USB_REQ_SET_IDLE 0x0A
  250. #define USB_REQ_SET_PROTOCOL 0x0B
  251. /*
  252. * USB Spec Release number
  253. */
  254. #define USB_BCD_VERSION 0x0110
  255. /*
  256. * Device Requests (c.f Table 9-2)
  257. */
  258. #define USB_REQ_DIRECTION_MASK 0x80
  259. #define USB_REQ_TYPE_MASK 0x60
  260. #define USB_REQ_RECIPIENT_MASK 0x1f
  261. #define USB_REQ_DEVICE2HOST 0x80
  262. #define USB_REQ_HOST2DEVICE 0x00
  263. #define USB_REQ_TYPE_STANDARD 0x00
  264. #define USB_REQ_TYPE_CLASS 0x20
  265. #define USB_REQ_TYPE_VENDOR 0x40
  266. #define USB_REQ_RECIPIENT_DEVICE 0x00
  267. #define USB_REQ_RECIPIENT_INTERFACE 0x01
  268. #define USB_REQ_RECIPIENT_ENDPOINT 0x02
  269. #define USB_REQ_RECIPIENT_OTHER 0x03
  270. /*
  271. * get status bits
  272. */
  273. #define USB_STATUS_SELFPOWERED 0x01
  274. #define USB_STATUS_REMOTEWAKEUP 0x02
  275. #define USB_STATUS_HALT 0x01
  276. /*
  277. * descriptor types
  278. */
  279. #define USB_DESCRIPTOR_TYPE_DEVICE 0x01
  280. #define USB_DESCRIPTOR_TYPE_CONFIGURATION 0x02
  281. #define USB_DESCRIPTOR_TYPE_STRING 0x03
  282. #define USB_DESCRIPTOR_TYPE_INTERFACE 0x04
  283. #define USB_DESCRIPTOR_TYPE_ENDPOINT 0x05
  284. #define USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER 0x06
  285. #define USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION 0x07
  286. #define USB_DESCRIPTOR_TYPE_INTERFACE_POWER 0x08
  287. #define USB_DESCRIPTOR_TYPE_HID 0x21
  288. #define USB_DESCRIPTOR_TYPE_REPORT 0x22
  289. #define USBD_DEVICE_DESCRIPTORS(x) (((unsigned int)x <= USB_DESCRIPTOR_TYPE_INTERFACE_POWER) ? \
  290. usbd_device_descriptors[x] : "UNKNOWN")
  291. /*
  292. * standard feature selectors
  293. */
  294. #define USB_ENDPOINT_HALT 0x00
  295. #define USB_DEVICE_REMOTE_WAKEUP 0x01
  296. #define USB_TEST_MODE 0x02
  297. /* USB Requests
  298. *
  299. */
  300. struct usb_device_request {
  301. u8 bmRequestType;
  302. u8 bRequest;
  303. u16 wValue;
  304. u16 wIndex;
  305. u16 wLength;
  306. } __attribute__ ((packed));
  307. /* USB Status
  308. *
  309. */
  310. typedef enum urb_send_status {
  311. SEND_IN_PROGRESS,
  312. SEND_FINISHED_OK,
  313. SEND_FINISHED_ERROR,
  314. RECV_READY,
  315. RECV_OK,
  316. RECV_ERROR
  317. } urb_send_status_t;
  318. /*
  319. * Device State (c.f USB Spec 2.0 Figure 9-1)
  320. *
  321. * What state the usb device is in.
  322. *
  323. * Note the state does not change if the device is suspended, we simply set a
  324. * flag to show that it is suspended.
  325. *
  326. */
  327. typedef enum usb_device_state {
  328. STATE_INIT, /* just initialized */
  329. STATE_CREATED, /* just created */
  330. STATE_ATTACHED, /* we are attached */
  331. STATE_POWERED, /* we have seen power indication (electrical bus signal) */
  332. STATE_DEFAULT, /* we been reset */
  333. STATE_ADDRESSED, /* we have been addressed (in default configuration) */
  334. STATE_CONFIGURED, /* we have seen a set configuration device command */
  335. STATE_UNKNOWN, /* destroyed */
  336. } usb_device_state_t;
  337. #define USBD_DEVICE_STATE(x) (((unsigned int)x <= STATE_UNKNOWN) ? usbd_device_states[x] : "UNKNOWN")
  338. /*
  339. * Device status
  340. *
  341. * Overall state
  342. */
  343. typedef enum usb_device_status {
  344. USBD_OPENING, /* we are currently opening */
  345. USBD_OK, /* ok to use */
  346. USBD_SUSPENDED, /* we are currently suspended */
  347. USBD_CLOSING, /* we are currently closing */
  348. } usb_device_status_t;
  349. #define USBD_DEVICE_STATUS(x) (((unsigned int)x <= USBD_CLOSING) ? usbd_device_status[x] : "UNKNOWN")
  350. /*
  351. * Device Events
  352. *
  353. * These are defined in the USB Spec (c.f USB Spec 2.0 Figure 9-1).
  354. *
  355. * There are additional events defined to handle some extra actions we need
  356. * to have handled.
  357. *
  358. */
  359. typedef enum usb_device_event {
  360. DEVICE_UNKNOWN, /* bi - unknown event */
  361. DEVICE_INIT, /* bi - initialize */
  362. DEVICE_CREATE, /* bi - */
  363. DEVICE_HUB_CONFIGURED, /* bi - bus has been plugged int */
  364. DEVICE_RESET, /* bi - hub has powered our port */
  365. DEVICE_ADDRESS_ASSIGNED, /* ep0 - set address setup received */
  366. DEVICE_CONFIGURED, /* ep0 - set configure setup received */
  367. DEVICE_SET_INTERFACE, /* ep0 - set interface setup received */
  368. DEVICE_SET_FEATURE, /* ep0 - set feature setup received */
  369. DEVICE_CLEAR_FEATURE, /* ep0 - clear feature setup received */
  370. DEVICE_DE_CONFIGURED, /* ep0 - set configure setup received for ?? */
  371. DEVICE_BUS_INACTIVE, /* bi - bus in inactive (no SOF packets) */
  372. DEVICE_BUS_ACTIVITY, /* bi - bus is active again */
  373. DEVICE_POWER_INTERRUPTION, /* bi - hub has depowered our port */
  374. DEVICE_HUB_RESET, /* bi - bus has been unplugged */
  375. DEVICE_DESTROY, /* bi - device instance should be destroyed */
  376. DEVICE_HOTPLUG, /* bi - a hotplug event has occured */
  377. DEVICE_FUNCTION_PRIVATE, /* function - private */
  378. } usb_device_event_t;
  379. typedef struct urb_link {
  380. struct urb_link *next;
  381. struct urb_link *prev;
  382. } urb_link;
  383. /* USB Data structure - for passing data around.
  384. *
  385. * This is used for both sending and receiving data.
  386. *
  387. * The callback function is used to let the function driver know when
  388. * transmitted data has been sent.
  389. *
  390. * The callback function is set by the alloc_recv function when an urb is
  391. * allocated for receiving data for an endpoint and used to call the
  392. * function driver to inform it that data has arrived.
  393. */
  394. #define URB_BUF_SIZE 128 /* in linux we'd malloc this, but in u-boot we prefer static data */
  395. struct urb {
  396. struct usb_endpoint_instance *endpoint;
  397. struct usb_device_instance *device;
  398. struct usb_device_request device_request; /* contents of received SETUP packet */
  399. struct urb_link link; /* embedded struct for circular doubly linked list of urbs */
  400. u8* buffer;
  401. unsigned int buffer_length;
  402. unsigned int actual_length;
  403. urb_send_status_t status;
  404. int data;
  405. u16 buffer_data[URB_BUF_SIZE]; /* data received (OUT) or being sent (IN) */
  406. };
  407. /* Endpoint configuration
  408. *
  409. * Per endpoint configuration data. Used to track which function driver owns
  410. * an endpoint.
  411. *
  412. */
  413. struct usb_endpoint_instance {
  414. int endpoint_address; /* logical endpoint address */
  415. /* control */
  416. int status; /* halted */
  417. int state; /* available for use by bus interface driver */
  418. /* receive side */
  419. struct urb_link rcv; /* received urbs */
  420. struct urb_link rdy; /* empty urbs ready to receive */
  421. struct urb *rcv_urb; /* active urb */
  422. int rcv_attributes; /* copy of bmAttributes from endpoint descriptor */
  423. int rcv_packetSize; /* maximum packet size from endpoint descriptor */
  424. int rcv_transferSize; /* maximum transfer size from function driver */
  425. int rcv_queue;
  426. /* transmit side */
  427. struct urb_link tx; /* urbs ready to transmit */
  428. struct urb_link done; /* transmitted urbs */
  429. struct urb *tx_urb; /* active urb */
  430. int tx_attributes; /* copy of bmAttributes from endpoint descriptor */
  431. int tx_packetSize; /* maximum packet size from endpoint descriptor */
  432. int tx_transferSize; /* maximum transfer size from function driver */
  433. int tx_queue;
  434. int sent; /* data already sent */
  435. int last; /* data sent in last packet XXX do we need this */
  436. };
  437. struct usb_alternate_instance {
  438. struct usb_interface_descriptor *interface_descriptor;
  439. int endpoints;
  440. int *endpoint_transfersize_array;
  441. struct usb_endpoint_descriptor **endpoints_descriptor_array;
  442. };
  443. struct usb_interface_instance {
  444. int alternates;
  445. struct usb_alternate_instance *alternates_instance_array;
  446. };
  447. struct usb_configuration_instance {
  448. int interfaces;
  449. struct usb_configuration_descriptor *configuration_descriptor;
  450. struct usb_interface_instance *interface_instance_array;
  451. };
  452. /* USB Device Instance
  453. *
  454. * For each physical bus interface we create a logical device structure. This
  455. * tracks all of the required state to track the USB HOST's view of the device.
  456. *
  457. * Keep track of the device configuration for a real physical bus interface,
  458. * this includes the bus interface, multiple function drivers, the current
  459. * configuration and the current state.
  460. *
  461. * This will show:
  462. * the specific bus interface driver
  463. * the default endpoint 0 driver
  464. * the configured function driver
  465. * device state
  466. * device status
  467. * endpoint list
  468. */
  469. struct usb_device_instance {
  470. /* generic */
  471. char *name;
  472. struct usb_device_descriptor *device_descriptor; /* per device descriptor */
  473. void (*event) (struct usb_device_instance *device, usb_device_event_t event, int data);
  474. /* Do cdc device specific control requests */
  475. int (*cdc_recv_setup)(struct usb_device_request *request, struct urb *urb);
  476. /* bus interface */
  477. struct usb_bus_instance *bus; /* which bus interface driver */
  478. /* configuration descriptors */
  479. int configurations;
  480. struct usb_configuration_instance *configuration_instance_array;
  481. /* device state */
  482. usb_device_state_t device_state; /* current USB Device state */
  483. usb_device_state_t device_previous_state; /* current USB Device state */
  484. u8 address; /* current address (zero is default) */
  485. u8 configuration; /* current show configuration (zero is default) */
  486. u8 interface; /* current interface (zero is default) */
  487. u8 alternate; /* alternate flag */
  488. usb_device_status_t status; /* device status */
  489. int urbs_queued; /* number of submitted urbs */
  490. /* Shouldn't need to make this atomic, all we need is a change indicator */
  491. unsigned long usbd_rxtx_timestamp;
  492. unsigned long usbd_last_rxtx_timestamp;
  493. };
  494. /* Bus Interface configuration structure
  495. *
  496. * This is allocated for each configured instance of a bus interface driver.
  497. *
  498. * The privdata pointer may be used by the bus interface driver to store private
  499. * per instance state information.
  500. */
  501. struct usb_bus_instance {
  502. struct usb_device_instance *device;
  503. struct usb_endpoint_instance *endpoint_array; /* array of available configured endpoints */
  504. int max_endpoints; /* maximimum number of rx enpoints */
  505. unsigned char maxpacketsize;
  506. unsigned int serial_number;
  507. char *serial_number_str;
  508. void *privdata; /* private data for the bus interface */
  509. };
  510. extern char *usbd_device_events[];
  511. extern char *usbd_device_states[];
  512. extern char *usbd_device_status[];
  513. extern char *usbd_device_requests[];
  514. extern char *usbd_device_descriptors[];
  515. void urb_link_init (urb_link * ul);
  516. void urb_detach (struct urb *urb);
  517. urb_link *first_urb_link (urb_link * hd);
  518. struct urb *first_urb (urb_link * hd);
  519. struct urb *first_urb_detached (urb_link * hd);
  520. void urb_append (urb_link * hd, struct urb *urb);
  521. struct urb *usbd_alloc_urb (struct usb_device_instance *device, struct usb_endpoint_instance *endpoint);
  522. void usbd_dealloc_urb (struct urb *urb);
  523. /*
  524. * usbd_device_event is used by bus interface drivers to tell the higher layers that
  525. * certain events have taken place.
  526. */
  527. void usbd_device_event_irq (struct usb_device_instance *conf, usb_device_event_t, int);
  528. void usbd_device_event (struct usb_device_instance *conf, usb_device_event_t, int);
  529. /* descriptors
  530. *
  531. * Various ways of finding descriptors based on the current device and any
  532. * possible configuration / interface / endpoint for it.
  533. */
  534. struct usb_configuration_descriptor *usbd_device_configuration_descriptor (struct usb_device_instance *, int, int);
  535. struct usb_function_instance *usbd_device_function_instance (struct usb_device_instance *, unsigned int);
  536. struct usb_interface_instance *usbd_device_interface_instance (struct usb_device_instance *, int, int, int);
  537. struct usb_alternate_instance *usbd_device_alternate_instance (struct usb_device_instance *, int, int, int, int);
  538. struct usb_interface_descriptor *usbd_device_interface_descriptor (struct usb_device_instance *, int, int, int, int);
  539. struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
  540. struct usb_class_descriptor *usbd_device_class_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
  541. struct usb_class_report_descriptor *usbd_device_class_report_descriptor_index( struct usb_device_instance *, int , int , int , int , int );
  542. struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor (struct usb_device_instance *, int, int, int, int, int);
  543. int usbd_device_endpoint_transfersize (struct usb_device_instance *, int, int, int, int, int);
  544. struct usb_string_descriptor *usbd_get_string (u8);
  545. struct usb_device_descriptor *usbd_device_device_descriptor (struct usb_device_instance *, int);
  546. int usbd_endpoint_halted (struct usb_device_instance *device, int endpoint);
  547. void usbd_rcv_complete(struct usb_endpoint_instance *endpoint, int len, int urb_bad);
  548. void usbd_tx_complete (struct usb_endpoint_instance *endpoint);
  549. /* These are macros used in debugging */
  550. #ifdef DEBUG
  551. static inline void print_urb(struct urb *u)
  552. {
  553. serial_printf("urb %p\n", (u));
  554. serial_printf("\tendpoint %p\n", u->endpoint);
  555. serial_printf("\tdevice %p\n", u->device);
  556. serial_printf("\tbuffer %p\n", u->buffer);
  557. serial_printf("\tbuffer_length %d\n", u->buffer_length);
  558. serial_printf("\tactual_length %d\n", u->actual_length);
  559. serial_printf("\tstatus %d\n", u->status);
  560. serial_printf("\tdata %d\n", u->data);
  561. }
  562. static inline void print_usb_device_request(struct usb_device_request *r)
  563. {
  564. serial_printf("usb request\n");
  565. serial_printf("\tbmRequestType 0x%2.2x\n", r->bmRequestType);
  566. if ((r->bmRequestType & USB_REQ_DIRECTION_MASK) == 0)
  567. serial_printf("\t\tDirection : To device\n");
  568. else
  569. serial_printf("\t\tDirection : To host\n");
  570. if ((r->bmRequestType & USB_TYPE_STANDARD) == USB_TYPE_STANDARD)
  571. serial_printf("\t\tType : Standard\n");
  572. if ((r->bmRequestType & USB_TYPE_CLASS) == USB_TYPE_CLASS)
  573. serial_printf("\t\tType : Standard\n");
  574. if ((r->bmRequestType & USB_TYPE_VENDOR) == USB_TYPE_VENDOR)
  575. serial_printf("\t\tType : Standard\n");
  576. if ((r->bmRequestType & USB_TYPE_RESERVED) == USB_TYPE_RESERVED)
  577. serial_printf("\t\tType : Standard\n");
  578. if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
  579. USB_REQ_RECIPIENT_DEVICE)
  580. serial_printf("\t\tRecipient : Device\n");
  581. if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
  582. USB_REQ_RECIPIENT_INTERFACE)
  583. serial_printf("\t\tRecipient : Interface\n");
  584. if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
  585. USB_REQ_RECIPIENT_ENDPOINT)
  586. serial_printf("\t\tRecipient : Endpoint\n");
  587. if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
  588. USB_REQ_RECIPIENT_OTHER)
  589. serial_printf("\t\tRecipient : Other\n");
  590. serial_printf("\tbRequest 0x%2.2x\n", r->bRequest);
  591. if (r->bRequest == USB_REQ_GET_STATUS)
  592. serial_printf("\t\tGET_STATUS\n");
  593. else if (r->bRequest == USB_REQ_SET_ADDRESS)
  594. serial_printf("\t\tSET_ADDRESS\n");
  595. else if (r->bRequest == USB_REQ_SET_FEATURE)
  596. serial_printf("\t\tSET_FEATURE\n");
  597. else if (r->bRequest == USB_REQ_GET_DESCRIPTOR)
  598. serial_printf("\t\tGET_DESCRIPTOR\n");
  599. else if (r->bRequest == USB_REQ_SET_CONFIGURATION)
  600. serial_printf("\t\tSET_CONFIGURATION\n");
  601. else if (r->bRequest == USB_REQ_SET_INTERFACE)
  602. serial_printf("\t\tUSB_REQ_SET_INTERFACE\n");
  603. else
  604. serial_printf("\tUNKNOWN %d\n", r->bRequest);
  605. serial_printf("\twValue 0x%4.4x\n", r->wValue);
  606. if (r->bRequest == USB_REQ_GET_DESCRIPTOR) {
  607. switch (r->wValue >> 8) {
  608. case USB_DESCRIPTOR_TYPE_DEVICE:
  609. serial_printf("\tDEVICE\n");
  610. break;
  611. case USB_DESCRIPTOR_TYPE_CONFIGURATION:
  612. serial_printf("\tCONFIGURATION\n");
  613. break;
  614. case USB_DESCRIPTOR_TYPE_STRING:
  615. serial_printf("\tSTRING\n");
  616. break;
  617. case USB_DESCRIPTOR_TYPE_INTERFACE:
  618. serial_printf("\tINTERFACE\n");
  619. break;
  620. case USB_DESCRIPTOR_TYPE_ENDPOINT:
  621. serial_printf("\tENDPOINT\n");
  622. break;
  623. case USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER:
  624. serial_printf("\tDEVICE_QUALIFIER\n");
  625. break;
  626. case USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION:
  627. serial_printf("\tOTHER_SPEED_CONFIGURATION\n");
  628. break;
  629. case USB_DESCRIPTOR_TYPE_INTERFACE_POWER:
  630. serial_printf("\tINTERFACE_POWER\n");
  631. break;
  632. case USB_DESCRIPTOR_TYPE_HID:
  633. serial_printf("\tHID\n");
  634. break;
  635. case USB_DESCRIPTOR_TYPE_REPORT:
  636. serial_printf("\tREPORT\n");
  637. break;
  638. default:
  639. serial_printf("\tUNKNOWN TYPE\n");
  640. break;
  641. }
  642. }
  643. serial_printf("\twIndex 0x%4.4x\n", r->wIndex);
  644. serial_printf("\twLength 0x%4.4x\n", r->wLength);
  645. }
  646. #else
  647. /* stubs */
  648. #define print_urb(u)
  649. #define print_usb_device_request(r)
  650. #endif /* DEBUG */
  651. #endif