usbdevice.h 22 KB

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