开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 嵌入式/单片机编程 > 嵌入式Linux > 查看源码
usb.h
资源名称：SBC-2410X_kernel.tar.gz　[点击查看]
上传用户：lgb322
上传日期：2013-02-24
资源大小：30529k
文件大小：35k
源码类别：

嵌入式Linux

开发平台：

Unix_Linux

usb.h：源码内容
  1. #ifndef __LINUX_USB_H
  2. #define __LINUX_USB_H
  4. /* USB constants */
  6. /*
  7.  * Device and/or Interface Class codes
  8.  */
  9. #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
  10. #define USB_CLASS_AUDIO 1
  11. #define USB_CLASS_COMM 2
  12. #define USB_CLASS_HID 3
  13. #define USB_CLASS_PHYSICAL 5
  14. #define USB_CLASS_STILL_IMAGE 6
  15. #define USB_CLASS_PRINTER 7
  16. #define USB_CLASS_MASS_STORAGE 8
  17. #define USB_CLASS_HUB 9
  18. #define USB_CLASS_CDC_DATA 0x0a
  19. #define USB_CLASS_CSCID 0x0b /* chip+ smart card */
  20. #define USB_CLASS_CONTENT_SEC 0x0d /* content security */
  21. #define USB_CLASS_APP_SPEC 0xfe
  22. #define USB_CLASS_VENDOR_SPEC 0xff
  24. /*
  25.  * USB types
  26.  */
  27. #define USB_TYPE_MASK (0x03 << 5)
  28. #define USB_TYPE_STANDARD (0x00 << 5)
  29. #define USB_TYPE_CLASS (0x01 << 5)
  30. #define USB_TYPE_VENDOR (0x02 << 5)
  31. #define USB_TYPE_RESERVED (0x03 << 5)
  33. /*
  34.  * USB recipients
  35.  */
  36. #define USB_RECIP_MASK 0x1f
  37. #define USB_RECIP_DEVICE 0x00
  38. #define USB_RECIP_INTERFACE 0x01
  39. #define USB_RECIP_ENDPOINT 0x02
  40. #define USB_RECIP_OTHER 0x03
  42. /*
  43.  * USB directions
  44.  */
  45. #define USB_DIR_OUT 0
  46. #define USB_DIR_IN 0x80
  48. /*
  49.  * Descriptor types
  50.  */
  51. #define USB_DT_DEVICE 0x01
  52. #define USB_DT_CONFIG 0x02
  53. #define USB_DT_STRING 0x03
  54. #define USB_DT_INTERFACE 0x04
  55. #define USB_DT_ENDPOINT 0x05
  57. #define USB_DT_HID (USB_TYPE_CLASS | 0x01)
  58. #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
  59. #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
  60. #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
  62. /*
  63.  * Descriptor sizes per descriptor type
  64.  */
  65. #define USB_DT_DEVICE_SIZE 18
  66. #define USB_DT_CONFIG_SIZE 9
  67. #define USB_DT_INTERFACE_SIZE 9
  68. #define USB_DT_ENDPOINT_SIZE 7
  69. #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
  70. #define USB_DT_HUB_NONVAR_SIZE 7
  71. #define USB_DT_HID_SIZE 9
  73. /*
  74.  * Endpoints
  75.  */
  76. #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
  77. #define USB_ENDPOINT_DIR_MASK 0x80
  79. #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
  80. #define USB_ENDPOINT_XFER_CONTROL 0
  81. #define USB_ENDPOINT_XFER_ISOC 1
  82. #define USB_ENDPOINT_XFER_BULK 2
  83. #define USB_ENDPOINT_XFER_INT 3
  85. /*
  86.  * USB Packet IDs (PIDs)
  87.  */
  88. #define USB_PID_UNDEF_0                        0xf0
  89. #define USB_PID_OUT                            0xe1
  90. #define USB_PID_ACK                            0xd2
  91. #define USB_PID_DATA0                          0xc3
  92. #define USB_PID_PING                           0xb4 /* USB 2.0 */
  93. #define USB_PID_SOF                            0xa5
  94. #define USB_PID_NYET                           0x96 /* USB 2.0 */
  95. #define USB_PID_DATA2                          0x87 /* USB 2.0 */
  96. #define USB_PID_SPLIT                          0x78 /* USB 2.0 */
  97. #define USB_PID_IN                             0x69
  98. #define USB_PID_NAK                            0x5a
  99. #define USB_PID_DATA1                          0x4b
  100. #define USB_PID_PREAMBLE                       0x3c /* Token mode */
  101. #define USB_PID_ERR                            0x3c /* USB 2.0: handshake mode */
  102. #define USB_PID_SETUP                          0x2d
  103. #define USB_PID_STALL                          0x1e
  104. #define USB_PID_MDATA                          0x0f /* USB 2.0 */
  106. /*
  107.  * Standard requests
  108.  */
  109. #define USB_REQ_GET_STATUS 0x00
  110. #define USB_REQ_CLEAR_FEATURE 0x01
  111. #define USB_REQ_SET_FEATURE 0x03
  112. #define USB_REQ_SET_ADDRESS 0x05
  113. #define USB_REQ_GET_DESCRIPTOR 0x06
  114. #define USB_REQ_SET_DESCRIPTOR 0x07
  115. #define USB_REQ_GET_CONFIGURATION 0x08
  116. #define USB_REQ_SET_CONFIGURATION 0x09
  117. #define USB_REQ_GET_INTERFACE 0x0A
  118. #define USB_REQ_SET_INTERFACE 0x0B
  119. #define USB_REQ_SYNCH_FRAME 0x0C
  121. /*
  122.  * HID requests
  123.  */
  124. #define USB_REQ_GET_REPORT 0x01
  125. #define USB_REQ_GET_IDLE 0x02
  126. #define USB_REQ_GET_PROTOCOL 0x03
  127. #define USB_REQ_SET_REPORT 0x09
  128. #define USB_REQ_SET_IDLE 0x0A
  129. #define USB_REQ_SET_PROTOCOL 0x0B
  132. #ifdef __KERNEL__
  134. #include <linux/types.h>
  135. #include <linux/ioctl.h>
  136. #include <linux/version.h>
  137. #include <linux/sched.h>
  138. #include <linux/delay.h>
  139. #include <linux/interrupt.h> /* for in_interrupt() */
  140. #include <linux/config.h>
  141. #include <linux/list.h>
  143. #define USB_MAJOR 180
  145. static __inline__ void wait_ms(unsigned int ms)
  146. {
  147. if(!in_interrupt()) {
  148. current->state = TASK_UNINTERRUPTIBLE;
  149. schedule_timeout(1 + ms * HZ / 1000);
  150. }
  151. else
  152. mdelay(ms);
  153. }
  155. typedef struct {
  156. __u8 requesttype;
  157. __u8 request;
  158. __u16 value;
  159. __u16 index;
  160. __u16 length;
  161. } devrequest __attribute__ ((packed));
  163. /*
  164.  * USB-status codes:
  165.  * USB_ST* maps to -E* and should go away in the future
  166.  */
  168. #define USB_ST_NOERROR 0
  169. #define USB_ST_CRC (-EILSEQ)
  170. #define USB_ST_BITSTUFF (-EPROTO)
  171. #define USB_ST_NORESPONSE (-ETIMEDOUT) /* device not responding/handshaking */
  172. #define USB_ST_DATAOVERRUN (-EOVERFLOW)
  173. #define USB_ST_DATAUNDERRUN (-EREMOTEIO)
  174. #define USB_ST_BUFFEROVERRUN (-ECOMM)
  175. #define USB_ST_BUFFERUNDERRUN (-ENOSR)
  176. #define USB_ST_INTERNALERROR (-EPROTO)  /* unknown error */
  177. #define USB_ST_SHORT_PACKET     (-EREMOTEIO)
  178. #define USB_ST_PARTIAL_ERROR   (-EXDEV) /* ISO transfer only partially completed */
  179. #define USB_ST_URB_KILLED      (-ENOENT) /* URB canceled by user */
  180. #define USB_ST_URB_PENDING       (-EINPROGRESS)
  181. #define USB_ST_REMOVED (-ENODEV)  /* device not existing or removed */
  182. #define USB_ST_TIMEOUT (-ETIMEDOUT) /* communication timed out, also in urb->status**/
  183. #define USB_ST_NOTSUPPORTED (-ENOSYS)
  184. #define USB_ST_BANDWIDTH_ERROR (-ENOSPC) /* too much bandwidth used */
  185. #define USB_ST_URB_INVALID_ERROR  (-EINVAL) /* invalid value/transfer type */
  186. #define USB_ST_URB_REQUEST_ERROR  (-ENXIO) /* invalid endpoint */
  187. #define USB_ST_STALL (-EPIPE)  /* pipe stalled, also in urb->status*/
  189. /*
  190.  * USB device number allocation bitmap. There's one bitmap
  191.  * per USB tree.
  192.  */
  193. struct usb_devmap {
  194. unsigned long devicemap[128 / (8*sizeof(unsigned long))];
  195. };
  197. #define USB_MAXBUS 64
  199. struct usb_busmap {
  200. unsigned long busmap[USB_MAXBUS / (8*sizeof(unsigned long))];
  201. };
  203. /*
  204.  * This is a USB device descriptor.
  205.  *
  206.  * USB device information
  207.  */
  209. /* Everything but the endpoint maximums are aribtrary */
  210. #define USB_MAXCONFIG 8
  211. #define USB_ALTSETTINGALLOC     4
  212. #define USB_MAXALTSETTING 128  /* Hard limit */
  213. #define USB_MAXINTERFACES 32
  214. #define USB_MAXENDPOINTS 32
  216. /* All standard descriptors have these 2 fields in common */
  217. struct usb_descriptor_header {
  218. __u8  bLength;
  219. __u8  bDescriptorType;
  220. } __attribute__ ((packed));
  222. /* Device descriptor */
  223. struct usb_device_descriptor {
  224. __u8  bLength;
  225. __u8  bDescriptorType;
  226. __u16 bcdUSB;
  227. __u8  bDeviceClass;
  228. __u8  bDeviceSubClass;
  229. __u8  bDeviceProtocol;
  230. __u8  bMaxPacketSize0;
  231. __u16 idVendor;
  232. __u16 idProduct;
  233. __u16 bcdDevice;
  234. __u8  iManufacturer;
  235. __u8  iProduct;
  236. __u8  iSerialNumber;
  237. __u8  bNumConfigurations;
  238. } __attribute__ ((packed));
  240. /* Endpoint descriptor */
  241. struct usb_endpoint_descriptor {
  242. __u8  bLength __attribute__ ((packed));
  243. __u8  bDescriptorType __attribute__ ((packed));
  244. __u8  bEndpointAddress __attribute__ ((packed));
  245. __u8  bmAttributes __attribute__ ((packed));
  246. __u16 wMaxPacketSize __attribute__ ((packed));
  247. __u8  bInterval __attribute__ ((packed));
  248. __u8  bRefresh __attribute__ ((packed));
  249. __u8  bSynchAddress __attribute__ ((packed));
  251.     unsigned char *extra;   /* Extra descriptors */
  252. int extralen;
  253. };
  255. /* Interface descriptor */
  256. struct usb_interface_descriptor {
  257. __u8  bLength __attribute__ ((packed));
  258. __u8  bDescriptorType __attribute__ ((packed));
  259. __u8  bInterfaceNumber __attribute__ ((packed));
  260. __u8  bAlternateSetting __attribute__ ((packed));
  261. __u8  bNumEndpoints __attribute__ ((packed));
  262. __u8  bInterfaceClass __attribute__ ((packed));
  263. __u8  bInterfaceSubClass __attribute__ ((packed));
  264. __u8  bInterfaceProtocol __attribute__ ((packed));
  265. __u8  iInterface __attribute__ ((packed));
  267.    struct usb_endpoint_descriptor *endpoint;
  269.     unsigned char *extra;   /* Extra descriptors */
  270. int extralen;
  271. };
  273. struct usb_interface {
  274. struct usb_interface_descriptor *altsetting;
  276. int act_altsetting; /* active alternate setting */
  277. int num_altsetting; /* number of alternate settings */
  278. int max_altsetting;             /* total memory allocated */
  279.  
  280. struct usb_driver *driver; /* driver */
  281. void *private_data;
  282. };
  284. /* Configuration descriptor information.. */
  285. struct usb_config_descriptor {
  286. __u8  bLength __attribute__ ((packed));
  287. __u8  bDescriptorType __attribute__ ((packed));
  288. __u16 wTotalLength __attribute__ ((packed));
  289. __u8  bNumInterfaces __attribute__ ((packed));
  290. __u8  bConfigurationValue __attribute__ ((packed));
  291. __u8  iConfiguration __attribute__ ((packed));
  292. __u8  bmAttributes __attribute__ ((packed));
  293. __u8  MaxPower __attribute__ ((packed));
  295. struct usb_interface *interface;
  297.     unsigned char *extra;   /* Extra descriptors */
  298. int extralen;
  299. };
  301. /* String descriptor */
  302. struct usb_string_descriptor {
  303. __u8  bLength;
  304. __u8  bDescriptorType;
  305. __u16 wData[1];
  306. } __attribute__ ((packed));
  308. struct usb_device;
  310. /*
  311.  * Device table entry for "new style" table-driven USB drivers.
  312.  * User mode code can read these tables to choose which modules to load.
  313.  * Declare the table as __devinitdata, and as a MODULE_DEVICE_TABLE.
  314.  *
  315.  * With a device table provide bind() instead of probe().  Then the
  316.  * third bind() parameter will point to a matching entry from this
  317.  * table.  (Null value reserved.)
  318.  * 
  319.  * Terminate the driver's table with an all-zeroes entry.
  320.  * Init the fields you care about; zeroes are not used in comparisons.
  321.  */
  322. #define USB_DEVICE_ID_MATCH_VENDOR 0x0001
  323. #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
  324. #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
  325. #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
  326. #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
  327. #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
  328. #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
  329. #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
  330. #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
  331. #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
  333. #define USB_DEVICE_ID_MATCH_DEVICE (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
  334. #define USB_DEVICE_ID_MATCH_DEV_RANGE (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
  335. #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
  336. #define USB_DEVICE_ID_MATCH_DEV_INFO 
  337. (USB_DEVICE_ID_MATCH_DEV_CLASS | USB_DEVICE_ID_MATCH_DEV_SUBCLASS | USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
  338. #define USB_DEVICE_ID_MATCH_INT_INFO 
  339. (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS | USB_DEVICE_ID_MATCH_INT_PROTOCOL)
  341. /* Some useful macros */
  342. #define USB_DEVICE(vend,prod) 
  343. match_flags: USB_DEVICE_ID_MATCH_DEVICE, idVendor: (vend), idProduct: (prod)
  344. #define USB_DEVICE_VER(vend,prod,lo,hi) 
  345. match_flags: USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, idVendor: (vend), idProduct: (prod), bcdDevice_lo: (lo), bcdDevice_hi: (hi)
  346. #define USB_DEVICE_INFO(cl,sc,pr) 
  347. match_flags: USB_DEVICE_ID_MATCH_DEV_INFO, bDeviceClass: (cl), bDeviceSubClass: (sc), bDeviceProtocol: (pr)
  348. #define USB_INTERFACE_INFO(cl,sc,pr) 
  349. match_flags: USB_DEVICE_ID_MATCH_INT_INFO, bInterfaceClass: (cl), bInterfaceSubClass: (sc), bInterfaceProtocol: (pr)
  351. struct usb_device_id {
  352. /* This bitmask is used to determine which of the following fields
  353.  * are to be used for matching.
  354.  */
  355. __u16 match_flags;
  357. /*
  358.  * vendor/product codes are checked, if vendor is nonzero
  359.  * Range is for device revision (bcdDevice), inclusive;
  360.  * zero values here mean range isn't considered
  361.  */
  362. __u16 idVendor;
  363. __u16 idProduct;
  364. __u16 bcdDevice_lo, bcdDevice_hi;
  366. /*
  367.  * if device class != 0, these can be match criteria;
  368.  * but only if this bDeviceClass value is nonzero
  369.  */
  370. __u8 bDeviceClass;
  371. __u8 bDeviceSubClass;
  372. __u8 bDeviceProtocol;
  374. /*
  375.  * if interface class != 0, these can be match criteria;
  376.  * but only if this bInterfaceClass value is nonzero
  377.  */
  378. __u8 bInterfaceClass;
  379. __u8 bInterfaceSubClass;
  380. __u8 bInterfaceProtocol;
  382. /*
  383.  * for driver's use; not involved in driver matching.
  384.  */
  385. unsigned long driver_info;
  386. };
  388. struct usb_driver {
  389. const char *name;
  391. void *(*probe)(
  392.     struct usb_device *dev, /* the device */
  393.     unsigned intf, /* what interface */
  394.     const struct usb_device_id *id /* from id_table */
  395.     );
  396. void (*disconnect)(struct usb_device *, void *);
  398. struct list_head driver_list;
  400. struct file_operations *fops;
  401. int minor;
  403. struct semaphore serialize;
  405. /* ioctl -- userspace apps can talk to drivers through usbdevfs */
  406. int (*ioctl)(struct usb_device *dev, unsigned int code, void *buf);
  408. /* support for "new-style" USB hotplugging
  409.  * binding policy can be driven from user mode too
  410.  */
  411. const struct usb_device_id *id_table;
  413. /* suspend before the bus suspends;
  414.  * disconnect or resume when the bus resumes */
  415. // void (*suspend)(struct usb_device *dev);
  416. // void (*resume)(struct usb_device *dev);
  417. };
  419. /*----------------------------------------------------------------------------* 
  420.  * New USB Structures                                                         *
  421.  *----------------------------------------------------------------------------*/
  423. /*
  424.  * urb->transfer_flags:
  425.  */
  426. #define USB_DISABLE_SPD         0x0001
  427. #define USB_ISO_ASAP            0x0002
  428. #define USB_ASYNC_UNLINK        0x0008
  429. #define USB_QUEUE_BULK          0x0010
  430. #define USB_NO_FSBR 0x0020
  431. #define USB_ZERO_PACKET         0x0040  // Finish bulk OUTs always with zero length packet
  432. #define USB_TIMEOUT_KILLED 0x1000 // only set by HCD!
  434. typedef struct
  435. {
  436. unsigned int offset;
  437. unsigned int length; // expected length
  438. unsigned int actual_length;
  439. unsigned int status;
  440. } iso_packet_descriptor_t, *piso_packet_descriptor_t;
  442. struct urb;
  443. typedef void (*usb_complete_t)(struct urb *);
  445. typedef struct urb
  446. {
  447. spinlock_t lock; // lock for the URB
  448. void *hcpriv; // private data for host controller
  449. struct list_head urb_list; // list pointer to all active urbs 
  450. struct urb *next; // pointer to next URB
  451. struct usb_device *dev; // pointer to associated USB device
  452. unsigned int pipe; // pipe information
  453. int status; // returned status
  454. unsigned int transfer_flags; // USB_DISABLE_SPD | USB_ISO_ASAP | etc.
  455. void *transfer_buffer; // associated data buffer
  456. int transfer_buffer_length; // data buffer length
  457. int actual_length;              // actual data buffer length
  458. int bandwidth; // bandwidth for this transfer request (INT or ISO)
  459. unsigned char *setup_packet; // setup packet (control only)
  460. //
  461. int start_frame; // start frame (iso/irq only)
  462. int number_of_packets; // number of packets in this request (iso)
  463. int interval;                   // polling interval (irq only)
  464. int error_count; // number of errors in this transfer (iso only)
  465. int timeout; // timeout (in jiffies)
  466. //
  467. void *context; // context for completion routine
  468. usb_complete_t complete; // pointer to completion routine
  469. //
  470. iso_packet_descriptor_t iso_frame_desc[0];
  471. } urb_t, *purb_t;
  473. /**
  474.  * FILL_CONTROL_URB - macro to help initialize a control urb
  475.  * @URB: pointer to the urb to initialize.
  476.  * @DEV: pointer to the struct usb_device for this urb.
  477.  * @PIPE: the endpoint pipe
  478.  * @SETUP_PACKET: pointer to the setup_packet buffer
  479.  * @TRANSFER_BUFFER: pointer to the transfer buffer
  480.  * @BUFFER_LENGTH: length of the transfer buffer
  481.  * @COMPLETE: pointer to the usb_complete_t function
  482.  * @CONTEXT: what to set the urb context to.
  483.  *
  484.  * Initializes a control urb with the proper information needed to submit
  485.  * it to a device.  This macro is depreciated, the usb_fill_control_urb()
  486.  * function should be used instead.
  487.  */
  488. #define FILL_CONTROL_URB(URB,DEV,PIPE,SETUP_PACKET,TRANSFER_BUFFER,BUFFER_LENGTH,COMPLETE,CONTEXT) 
  489.     do {
  490. spin_lock_init(&(URB)->lock);
  491. (URB)->dev=DEV;
  492. (URB)->pipe=PIPE;
  493. (URB)->setup_packet=SETUP_PACKET;
  494. (URB)->transfer_buffer=TRANSFER_BUFFER;
  495. (URB)->transfer_buffer_length=BUFFER_LENGTH;
  496. (URB)->complete=COMPLETE;
  497. (URB)->context=CONTEXT;
  498.     } while (0)
  500. /**
  501.  * FILL_BULK_URB - macro to help initialize a bulk urb
  502.  * @URB: pointer to the urb to initialize.
  503.  * @DEV: pointer to the struct usb_device for this urb.
  504.  * @PIPE: the endpoint pipe
  505.  * @TRANSFER_BUFFER: pointer to the transfer buffer
  506.  * @BUFFER_LENGTH: length of the transfer buffer
  507.  * @COMPLETE: pointer to the usb_complete_t function
  508.  * @CONTEXT: what to set the urb context to.
  509.  *
  510.  * Initializes a bulk urb with the proper information needed to submit it
  511.  * to a device.  This macro is depreciated, the usb_fill_bulk_urb()
  512.  * function should be used instead.
  513.  */
  514. #define FILL_BULK_URB(URB,DEV,PIPE,TRANSFER_BUFFER,BUFFER_LENGTH,COMPLETE,CONTEXT) 
  515.     do {
  516. spin_lock_init(&(URB)->lock);
  517. (URB)->dev=DEV;
  518. (URB)->pipe=PIPE;
  519. (URB)->transfer_buffer=TRANSFER_BUFFER;
  520. (URB)->transfer_buffer_length=BUFFER_LENGTH;
  521. (URB)->complete=COMPLETE;
  522. (URB)->context=CONTEXT;
  523.     } while (0)
  524.     
  525. /**
  526.  * FILL_INT_URB - macro to help initialize a interrupt urb
  527.  * @URB: pointer to the urb to initialize.
  528.  * @DEV: pointer to the struct usb_device for this urb.
  529.  * @PIPE: the endpoint pipe
  530.  * @TRANSFER_BUFFER: pointer to the transfer buffer
  531.  * @BUFFER_LENGTH: length of the transfer buffer
  532.  * @COMPLETE: pointer to the usb_complete_t function
  533.  * @CONTEXT: what to set the urb context to.
  534.  * @INTERVAL: what to set the urb interval to.
  535.  *
  536.  * Initializes a interrupt urb with the proper information needed to submit
  537.  * it to a device.  This macro is depreciated, the usb_fill_int_urb()
  538.  * function should be used instead.
  539.  */
  540. #define FILL_INT_URB(URB,DEV,PIPE,TRANSFER_BUFFER,BUFFER_LENGTH,COMPLETE,CONTEXT,INTERVAL) 
  541.     do {
  542. spin_lock_init(&(URB)->lock);
  543. (URB)->dev=DEV;
  544. (URB)->pipe=PIPE;
  545. (URB)->transfer_buffer=TRANSFER_BUFFER;
  546. (URB)->transfer_buffer_length=BUFFER_LENGTH;
  547. (URB)->complete=COMPLETE;
  548. (URB)->context=CONTEXT;
  549. (URB)->interval=INTERVAL;
  550. (URB)->start_frame=-1;
  551.     } while (0)
  553. #define FILL_CONTROL_URB_TO(a,aa,b,c,d,e,f,g,h) 
  554.     do {
  555. spin_lock_init(&(a)->lock);
  556. (a)->dev=aa;
  557. (a)->pipe=b;
  558. (a)->setup_packet=c;
  559. (a)->transfer_buffer=d;
  560. (a)->transfer_buffer_length=e;
  561. (a)->complete=f;
  562. (a)->context=g;
  563. (a)->timeout=h;
  564.     } while (0)
  566. #define FILL_BULK_URB_TO(a,aa,b,c,d,e,f,g) 
  567.     do {
  568. spin_lock_init(&(a)->lock);
  569. (a)->dev=aa;
  570. (a)->pipe=b;
  571. (a)->transfer_buffer=c;
  572. (a)->transfer_buffer_length=d;
  573. (a)->complete=e;
  574. (a)->context=f;
  575. (a)->timeout=g;
  576.     } while (0)
  577.  
  578. /**
  579.  * usb_fill_control_urb - initializes a control urb
  580.  * @urb: pointer to the urb to initialize.
  581.  * @dev: pointer to the struct usb_device for this urb.
  582.  * @pipe: the endpoint pipe
  583.  * @setup_packet: pointer to the setup_packet buffer
  584.  * @transfer_buffer: pointer to the transfer buffer
  585.  * @buffer_length: length of the transfer buffer
  586.  * @complete: pointer to the usb_complete_t function
  587.  * @context: what to set the urb context to.
  588.  *
  589.  * Initializes a control urb with the proper information needed to submit
  590.  * it to a device.
  591.  */
  592. static inline void usb_fill_control_urb (struct urb *urb,
  593.  struct usb_device *dev,
  594.  unsigned int pipe,
  595.  unsigned char *setup_packet,
  596.  void *transfer_buffer,
  597.  int buffer_length,
  598.  usb_complete_t complete,
  599.  void *context)
  600. {
  601. spin_lock_init(&urb->lock);
  602. urb->dev = dev;
  603. urb->pipe = pipe;
  604. urb->setup_packet = setup_packet;
  605. urb->transfer_buffer = transfer_buffer;
  606. urb->transfer_buffer_length = buffer_length;
  607. urb->complete = complete;
  608. urb->context = context;
  609. }
  611. /**
  612.  * usb_fill_bulk_urb - macro to help initialize a bulk urb
  613.  * @urb: pointer to the urb to initialize.
  614.  * @dev: pointer to the struct usb_device for this urb.
  615.  * @pipe: the endpoint pipe
  616.  * @transfer_buffer: pointer to the transfer buffer
  617.  * @buffer_length: length of the transfer buffer
  618.  * @complete: pointer to the usb_complete_t function
  619.  * @context: what to set the urb context to.
  620.  *
  621.  * Initializes a bulk urb with the proper information needed to submit it
  622.  * to a device.
  623.  */
  624. static inline void usb_fill_bulk_urb (struct urb *urb,
  625.       struct usb_device *dev,
  626.       unsigned int pipe,
  627.       void *transfer_buffer,
  628.       int buffer_length,
  629.       usb_complete_t complete,
  630.       void *context)
  631.       
  632. {
  633. spin_lock_init(&urb->lock);
  634. urb->dev = dev;
  635. urb->pipe = pipe;
  636. urb->transfer_buffer = transfer_buffer;
  637. urb->transfer_buffer_length = buffer_length;
  638. urb->complete = complete;
  639. urb->context = context;
  640. }
  641.     
  642. /**
  643.  * usb_fill_int_urb - macro to help initialize a interrupt urb
  644.  * @urb: pointer to the urb to initialize.
  645.  * @dev: pointer to the struct usb_device for this urb.
  646.  * @pipe: the endpoint pipe
  647.  * @transfer_buffer: pointer to the transfer buffer
  648.  * @buffer_length: length of the transfer buffer
  649.  * @complete: pointer to the usb_complete_t function
  650.  * @context: what to set the urb context to.
  651.  * @interval: what to set the urb interval to.
  652.  *
  653.  * Initializes a interrupt urb with the proper information needed to submit
  654.  * it to a device.
  655.  */
  656. static inline void usb_fill_int_urb (struct urb *urb,
  657.      struct usb_device *dev,
  658.      unsigned int pipe,
  659.      void *transfer_buffer,
  660.      int buffer_length,
  661.      usb_complete_t complete,
  662.      void *context,
  663.      int interval)
  664. {
  665. spin_lock_init(&urb->lock);
  666. urb->dev = dev;
  667. urb->pipe = pipe;
  668. urb->transfer_buffer = transfer_buffer;
  669. urb->transfer_buffer_length = buffer_length;
  670. urb->complete = complete;
  671. urb->context = context;
  672. urb->interval = interval;
  673. urb->start_frame = -1;
  674. }
  676. purb_t usb_alloc_urb(int iso_packets);
  677. void usb_free_urb (purb_t purb);
  678. int usb_submit_urb(purb_t purb);
  679. int usb_unlink_urb(purb_t purb);
  680. int usb_internal_control_msg(struct usb_device *usb_dev, unsigned int pipe, devrequest *cmd,  void *data, int len, int timeout);
  681. int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout);
  683. /*-------------------------------------------------------------------*
  684.  *                         SYNCHRONOUS CALL SUPPORT                  *
  685.  *-------------------------------------------------------------------*/
  687. struct usb_api_data
  688. {
  689. wait_queue_head_t wqh;
  690. int done;
  691. /* void* stuff; */ /* Possible extension later. */
  692. };
  694. /* -------------------------------------------------------------------------- */
  696. struct usb_operations {
  697. int (*allocate)(struct usb_device *);
  698. int (*deallocate)(struct usb_device *);
  699. int (*get_frame_number) (struct usb_device *usb_dev);
  700. int (*submit_urb) (struct urb* purb);
  701. int (*unlink_urb) (struct urb* purb);
  702. };
  704. #define DEVNUM_ROUND_ROBIN /***** OPTION *****/
  706. /*
  707.  * Allocated per bus we have
  708.  */
  709. struct usb_bus {
  710. int busnum; /* Bus number (in order of reg) */
  712. #ifdef DEVNUM_ROUND_ROBIN
  713. int devnum_next;                /* Next open device number in round-robin allocation */
  714. #endif /* DEVNUM_ROUND_ROBIN */
  716. struct usb_devmap devmap;       /* Device map */
  717. struct usb_operations *op;      /* Operations (specific to the HC) */
  718. struct usb_device *root_hub;    /* Root hub */
  719. struct list_head bus_list;
  720. void *hcpriv;                   /* Host Controller private data */
  722. int bandwidth_allocated; /* on this Host Controller; */
  723.   /* applies to Int. and Isoc. pipes; */
  724.   /* measured in microseconds/frame; */
  725.   /* range is 0..900, where 900 = */
  726.   /* 90% of a 1-millisecond frame */
  727. int bandwidth_int_reqs; /* number of Interrupt requesters */
  728. int bandwidth_isoc_reqs; /* number of Isoc. requesters */
  730. /* usbdevfs inode list */
  731. struct list_head inodes;
  733. atomic_t refcnt;
  734. };
  736. /* This is arbitrary.
  737.  * From USB 2.0 spec Table 11-13, offset 7, a hub can
  738.  * have up to 255 ports. The most yet reported is 10.
  739.  */
  740. #define USB_MAXCHILDREN (16)
  742. struct usb_device {
  743. int devnum; /* Device number on USB bus */
  745. enum {
  746. USB_SPEED_UNKNOWN = 0, /* enumerating */
  747. USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
  748. USB_SPEED_HIGH /* usb 2.0 */
  749. } speed;
  751. struct usb_device *tt; /* usb1.1 device on usb2.0 bus */
  752. int ttport; /* device/hub port on that tt */
  754. atomic_t refcnt; /* Reference count */
  755. struct semaphore serialize;
  757. unsigned int toggle[2]; /* one bit for each endpoint ([0] = IN, [1] = OUT) */
  758. unsigned int halted[2]; /* endpoint halts; one bit per endpoint # & direction; */
  759. /* [0] = IN, [1] = OUT */
  760. int epmaxpacketin[16]; /* INput endpoint specific maximums */
  761. int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
  763. struct usb_device *parent;
  764. struct usb_bus *bus; /* Bus we're part of */
  766. struct usb_device_descriptor descriptor;/* Descriptor */
  767. struct usb_config_descriptor *config; /* All of the configs */
  768. struct usb_config_descriptor *actconfig;/* the active configuration */
  770. char **rawdescriptors; /* Raw descriptors for each config */
  772. int have_langid; /* whether string_langid is valid yet */
  773. int string_langid; /* language ID for strings */
  774.   
  775. void *hcpriv; /* Host Controller private data */
  777.         /* usbdevfs inode list */
  778. struct list_head inodes;
  779. struct list_head filelist;
  781. /*
  782.  * Child devices - these can be either new devices
  783.  * (if this is a hub device), or different instances
  784.  * of this same device.
  785.  *
  786.  * Each instance needs its own set of data structures.
  787.  */
  789. int maxchild; /* Number of ports if hub */
  790. struct usb_device *children[USB_MAXCHILDREN];
  791. };
  793. extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum);
  794. extern struct usb_endpoint_descriptor *usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum);
  796. extern int usb_register(struct usb_driver *);
  797. extern void usb_deregister(struct usb_driver *);
  798. extern void usb_scan_devices(void);
  800. /* used these for multi-interface device registration */
  801. extern void usb_driver_claim_interface(struct usb_driver *driver, struct usb_interface *iface, void* priv);
  802. extern int usb_interface_claimed(struct usb_interface *iface);
  803. extern void usb_driver_release_interface(struct usb_driver *driver, struct usb_interface *iface);
  804. const struct usb_device_id *usb_match_id(struct usb_device *dev,
  805.  struct usb_interface *interface,
  806.  const struct usb_device_id *id);
  808. extern struct usb_bus *usb_alloc_bus(struct usb_operations *);
  809. extern void usb_free_bus(struct usb_bus *);
  810. extern void usb_register_bus(struct usb_bus *);
  811. extern void usb_deregister_bus(struct usb_bus *);
  813. extern struct usb_device *usb_alloc_dev(struct usb_device *parent, struct usb_bus *);
  814. extern void usb_free_dev(struct usb_device *);
  815. extern void usb_inc_dev_use(struct usb_device *);
  816. #define usb_dec_dev_use usb_free_dev
  818. extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
  819. extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc);
  820. extern void usb_release_bandwidth(struct usb_device *dev, struct urb *urb, int isoc);
  822. extern int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype, __u16 value, __u16 index, void *data, __u16 size, int timeout);
  824. extern int usb_root_hub_string(int id, int serial, char *type, __u8 *data, int len);
  825. extern void usb_connect(struct usb_device *dev);
  826. extern void usb_disconnect(struct usb_device **);
  828. extern void usb_destroy_configuration(struct usb_device *dev);
  830. int usb_get_current_frame_number (struct usb_device *usb_dev);
  832. /*
  833.  * Calling this entity a "pipe" is glorifying it. A USB pipe
  834.  * is something embarrassingly simple: it basically consists
  835.  * of the following information:
  836.  *  - device number (7 bits)
  837.  *  - endpoint number (4 bits)
  838.  *  - current Data0/1 state (1 bit)
  839.  *  - direction (1 bit)
  840.  *  - speed (1 bit)
  841.  *  - max packet size (2 bits: 8, 16, 32 or 64) [Historical; now gone.]
  842.  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
  843.  *
  844.  * That's 18 bits. Really. Nothing more. And the USB people have
  845.  * documented these eighteen bits as some kind of glorious
  846.  * virtual data structure.
  847.  *
  848.  * Let's not fall in that trap. We'll just encode it as a simple
  849.  * unsigned int. The encoding is:
  850.  *
  851.  *  - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) [Historical; now gone.]
  852.  *  - direction: bit 7 (0 = Host-to-Device [Out], 1 = Device-to-Host [In])
  853.  *  - device: bits 8-14
  854.  *  - endpoint: bits 15-18
  855.  *  - Data0/1: bit 19
  856.  *  - speed: bit 26 (0 = Full, 1 = Low Speed)
  857.  *  - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk)
  858.  *
  859.  * Why? Because it's arbitrary, and whatever encoding we select is really
  860.  * up to us. This one happens to share a lot of bit positions with the UHCI
  861.  * specification, so that much of the uhci driver can just mask the bits
  862.  * appropriately.
  863.  *
  864.  * NOTE:  there's no encoding (yet?) for a "high speed" endpoint; treat them
  865.  * like full speed devices.
  866.  */
  868. #define PIPE_ISOCHRONOUS 0
  869. #define PIPE_INTERRUPT 1
  870. #define PIPE_CONTROL 2
  871. #define PIPE_BULK 3
  873. #define usb_maxpacket(dev, pipe, out) (out 
  874. ? (dev)->epmaxpacketout[usb_pipeendpoint(pipe)] 
  875. : (dev)->epmaxpacketin [usb_pipeendpoint(pipe)] )
  876. #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : USB_PID_OUT)
  878. #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
  879. #define usb_pipein(pipe) (((pipe) >> 7) & 1)
  880. #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
  881. #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
  882. #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
  883. #define usb_pipedata(pipe) (((pipe) >> 19) & 1)
  884. #define usb_pipeslow(pipe) (((pipe) >> 26) & 1)
  885. #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
  886. #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
  887. #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
  888. #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
  889. #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
  891. #define PIPE_DEVEP_MASK 0x0007ff00
  893. /* The D0/D1 toggle bits */
  894. #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
  895. #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
  896. #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << ep)) | ((bit) << ep))
  898. /* Endpoint halt control/status */
  899. #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
  900. #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
  901. #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
  902. #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
  904. static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int endpoint)
  905. {
  906. return (dev->devnum << 8) | (endpoint << 15) |
  907. ((dev->speed == USB_SPEED_LOW) << 26);
  908. }
  910. static inline unsigned int __default_pipe(struct usb_device *dev)
  911. {
  912. return ((dev->speed == USB_SPEED_LOW) << 26);
  913. }
  915. /* Create various pipes... */
  916. #define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
  917. #define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  918. #define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
  919. #define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  920. #define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
  921. #define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  922. #define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
  923. #define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
  924. #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | __default_pipe(dev))
  925. #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | __default_pipe(dev) | USB_DIR_IN)
  927. /*
  928.  * Send and receive control messages..
  929.  */
  930. int usb_new_device(struct usb_device *dev);
  931. int usb_reset_device(struct usb_device *dev);
  932. int usb_set_address(struct usb_device *dev);
  933. int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
  934. unsigned char descindex, void *buf, int size);
  935. int usb_get_class_descriptor(struct usb_device *dev, int ifnum, unsigned char desctype,
  936. unsigned char descindex, void *buf, int size);
  937. int usb_get_device_descriptor(struct usb_device *dev);
  938. int __usb_get_extra_descriptor(char *buffer, unsigned size, unsigned char type, void **ptr);
  939. int usb_get_status(struct usb_device *dev, int type, int target, void *data);
  940. int usb_get_configuration(struct usb_device *dev);
  941. int usb_get_protocol(struct usb_device *dev, int ifnum);
  942. int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
  943. int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
  944. int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id);
  945. int usb_set_configuration(struct usb_device *dev, int configuration);
  946. int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
  947. unsigned char id, void *buf, int size);
  948. int usb_set_report(struct usb_device *dev, int ifnum, unsigned char type,
  949. unsigned char id, void *buf, int size);
  950. int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
  951. int usb_clear_halt(struct usb_device *dev, int pipe);
  952. void usb_set_maxpacket(struct usb_device *dev);
  954. #define usb_get_extra_descriptor(ifpoint,type,ptr)
  955. __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,type,(void**)ptr)
  957. /*
  958.  * Some USB bandwidth allocation constants.
  959.  */
  960. #define BW_HOST_DELAY 1000L /* nanoseconds */
  961. #define BW_HUB_LS_SETUP 333L /* nanoseconds */
  962.                         /* 4 full-speed bit times (est.) */
  964. #define FRAME_TIME_BITS         12000L /* frame = 1 millisecond */
  965. #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
  966. #define FRAME_TIME_USECS 1000L
  967. #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
  969. #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
  970. /* Trying not to use worst-case bit-stuffing
  971.                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
  972. /* bytecount = data payload byte count */
  974. #define NS_TO_US(ns) ((ns + 500L) / 1000L)
  975. /* convert & round nanoseconds to microseconds */
  977. /*
  978.  * Debugging helpers..
  979.  */
  980. void usb_show_device_descriptor(struct usb_device_descriptor *);
  981. void usb_show_config_descriptor(struct usb_config_descriptor *);
  982. void usb_show_interface_descriptor(struct usb_interface_descriptor *);
  983. void usb_show_endpoint_descriptor(struct usb_endpoint_descriptor *);
  984. void usb_show_device(struct usb_device *);
  985. void usb_show_string(struct usb_device *dev, char *id, int index);
  987. #ifdef DEBUG
  988. #define dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "n" , ## arg)
  989. #else
  990. #define dbg(format, arg...) do {} while (0)
  991. #endif
  992. #define err(format, arg...) printk(KERN_ERR __FILE__ ": " format "n" , ## arg)
  993. #define info(format, arg...) printk(KERN_INFO __FILE__ ": " format "n" , ## arg)
  994. #define warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "n" , ## arg)
  997. /*
  998.  * bus and driver list
  999.  */
  1001. extern struct list_head usb_driver_list;
  1002. extern struct list_head usb_bus_list;
  1003. extern struct semaphore usb_bus_list_lock;
  1005. /*
  1006.  * USB device fs stuff
  1007.  */
  1009. #ifdef CONFIG_USB_DEVICEFS
  1011. /*
  1012.  * these are expected to be called from the USB core/hub thread
  1013.  * with the kernel lock held
  1014.  */
  1015. extern void usbdevfs_add_bus(struct usb_bus *bus);
  1016. extern void usbdevfs_remove_bus(struct usb_bus *bus);
  1017. extern void usbdevfs_add_device(struct usb_device *dev);
  1018. extern void usbdevfs_remove_device(struct usb_device *dev);
  1020. extern int usbdevfs_init(void);
  1021. extern void usbdevfs_cleanup(void);
  1023. #else /* CONFIG_USB_DEVICEFS */
  1025. static inline void usbdevfs_add_bus(struct usb_bus *bus) {}
  1026. static inline void usbdevfs_remove_bus(struct usb_bus *bus) {}
  1027. static inline void usbdevfs_add_device(struct usb_device *dev) {}
  1028. static inline void usbdevfs_remove_device(struct usb_device *dev) {}
  1030. static inline int usbdevfs_init(void) { return 0; }
  1031. static inline void usbdevfs_cleanup(void) { }
  1033. #endif /* CONFIG_USB_DEVICEFS */
  1035. #endif  /* __KERNEL__ */
  1037. #endif