This commit was manufactured by cvs2svn to create tag
[linux-2.6.git] / include / linux / usb.h
index 2d1ac50..18ee075 100644 (file)
@@ -40,22 +40,9 @@ struct usb_driver;
  * Devices may also have class-specific or vendor-specific descriptors.
  */
 
-/**
- * struct usb_host_endpoint - host-side endpoint descriptor and queue
- * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
- * @urb_list: urbs queued to this endpoint; maintained by usbcore
- * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
- *     with one or more transfer descriptors (TDs) per urb
- * @extra: descriptors following this endpoint in the configuration
- * @extralen: how many bytes of "extra" are valid
- *
- * USB requests are always queued to a given endpoint, identified by a
- * descriptor within an active interface in a given USB configuration.
- */
+/* host-side wrapper for parsed endpoint descriptors */
 struct usb_host_endpoint {
        struct usb_endpoint_descriptor  desc;
-       struct list_head                urb_list;
-       void                            *hcpriv;
 
        unsigned char *extra;   /* Extra descriptors */
        int extralen;
@@ -70,7 +57,6 @@ struct usb_host_interface {
         */
        struct usb_host_endpoint *endpoint;
 
-       char *string;           /* iInterface string, if present */
        unsigned char *extra;   /* Extra descriptors */
        int extralen;
 };
@@ -190,8 +176,6 @@ struct usb_interface_cache {
 /**
  * struct usb_host_config - representation of a device's configuration
  * @desc: the device's configuration descriptor.
- * @string: pointer to the cached version of the iConfiguration string, if
- *     present for this configuration.
  * @interface: array of pointers to usb_interface structures, one for each
  *     interface in the configuration.  The number of interfaces is stored
  *     in desc.bNumInterfaces.  These pointers are valid only while the
@@ -228,7 +212,6 @@ struct usb_interface_cache {
 struct usb_host_config {
        struct usb_config_descriptor    desc;
 
-       char *string;
        /* the interfaces associated with this configuration,
         * stored in no particular order */
        struct usb_interface *interface[USB_MAXINTERFACES];
@@ -241,6 +224,11 @@ struct usb_host_config {
        int extralen;
 };
 
+// FIXME remove; exported only for drivers/usb/misc/auserwald.c
+// prefer usb_device->epnum[0..31]
+extern struct usb_endpoint_descriptor *
+       usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum);
+
 int __usb_get_extra_descriptor(char *buffer, unsigned size,
        unsigned char type, void **ptr);
 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
@@ -289,10 +277,6 @@ struct usb_bus {
 
        struct class_device class_dev;  /* class device for this bus */
        void (*release)(struct usb_bus *bus);   /* function to destroy this bus's memory */
-#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
-       struct mon_bus *mon_bus;        /* non-null when associated */
-       int monitored;                  /* non-zero when monitored */
-#endif
 };
 #define        to_usb_bus(d) container_of(d, struct usb_bus, class_dev)
 
@@ -327,28 +311,25 @@ struct usb_device {
        struct semaphore serialize;
 
        unsigned int toggle[2];         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
+       int epmaxpacketin[16];          /* INput endpoint specific maximums */
+       int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
 
        struct usb_device *parent;      /* our hub, unless we're the root */
        struct usb_bus *bus;            /* Bus we're part of */
-       struct usb_host_endpoint ep0;
 
        struct device dev;              /* Generic device interface */
 
        struct usb_device_descriptor descriptor;/* Descriptor */
        struct usb_host_config *config; /* All of the configs */
-
        struct usb_host_config *actconfig;/* the active configuration */
-       struct usb_host_endpoint *ep_in[16];
-       struct usb_host_endpoint *ep_out[16];
 
        char **rawdescriptors;          /* Raw descriptors for each config */
 
        int have_langid;                /* whether string_langid is valid yet */
        int string_langid;              /* language ID for strings */
 
-       char *product;
-       char *manufacturer;
-       char *serial;                   /* static strings from the device */
+       void *hcpriv;                   /* Host Controller private data */
+       
        struct list_head filelist;
        struct dentry *usbfs_dentry;    /* usbfs dentry entry for the device */
 
@@ -379,8 +360,6 @@ extern int usb_reset_device(struct usb_device *dev);
 
 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
 
-/*-------------------------------------------------------------------------*/
-
 /* for drivers using iso endpoints */
 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
 
@@ -558,7 +537,7 @@ struct usb_driver {
 
        int (*ioctl) (struct usb_interface *intf, unsigned int code, void *buf);
 
-       int (*suspend) (struct usb_interface *intf, pm_message_t message);
+       int (*suspend) (struct usb_interface *intf, u32 state);
        int (*resume) (struct usb_interface *intf);
 
        const struct usb_device_id *id_table;
@@ -750,8 +729,8 @@ typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
  * to poll for transfers.  After the URB has been submitted, the interval
  * field reflects how the transfer was actually scheduled.
  * The polling interval may be more frequent than requested.
- * For example, some controllers have a maximum interval of 32 milliseconds,
- * while others support intervals of up to 1024 milliseconds.
+ * For example, some controllers have a maximum interval of 32 microseconds,
+ * while others support intervals of up to 1024 microseconds.
  * Isochronous URBs also have transfer intervals.  (Note that for isochronous
  * endpoints, as well as high speed interrupt endpoints, the encoding of
  * the transfer interval in the endpoint descriptor is logarithmic.
@@ -796,10 +775,6 @@ typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
  * of the iso_frame_desc array, and the number of errors is reported in
  * error_count.  Completion callbacks for ISO transfers will normally
  * (re)submit URBs to ensure a constant transfer rate.
- *
- * Note that even fields marked "public" should not be touched by the driver
- * when the urb is owned by the hcd, that is, since the call to
- * usb_submit_urb() till the entry into the completion routine.
  */
 struct urb
 {
@@ -807,12 +782,12 @@ struct urb
        struct kref kref;               /* reference count of the URB */
        spinlock_t lock;                /* lock for the URB */
        void *hcpriv;                   /* private data for host controller */
+       struct list_head urb_list;      /* list pointer to all active urbs */
        int bandwidth;                  /* bandwidth for INT/ISO request */
        atomic_t use_count;             /* concurrent submissions counter */
        u8 reject;                      /* submissions will fail */
 
        /* public, documented fields in the urb that can be used by drivers */
-       struct list_head urb_list;      /* list head for use by the urb owner */
        struct usb_device *dev;         /* (in) pointer to associated device */
        unsigned int pipe;              /* (in) pipe information */
        int status;                     /* (return) non-ISO status */
@@ -953,11 +928,11 @@ void *usb_buffer_alloc (struct usb_device *dev, size_t size,
 void usb_buffer_free (struct usb_device *dev, size_t size,
        void *addr, dma_addr_t dma);
 
-#if 0
 struct urb *usb_buffer_map (struct urb *urb);
+#if 0
 void usb_buffer_dmasync (struct urb *urb);
-void usb_buffer_unmap (struct urb *urb);
 #endif
+void usb_buffer_unmap (struct urb *urb);
 
 struct scatterlist;
 int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
@@ -981,7 +956,7 @@ extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
        int timeout);
 
 /* selective suspend/resume */
-extern int usb_suspend_device(struct usb_device *dev, pm_message_t message);
+extern int usb_suspend_device(struct usb_device *dev, u32 state);
 extern int usb_resume_device(struct usb_device *dev);
 
 
@@ -1001,13 +976,13 @@ extern int usb_reset_configuration(struct usb_device *dev);
 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
 
 /*
- * timeouts, in milliseconds, used for sending/receiving control messages
+ * timeouts, in seconds, used for sending/receiving control messages
  * they typically complete within a few frames (msec) after they're issued
  * USB identifies 5 second timeouts, maybe more in a few cases, and a few
  * slow devices (like some MGE Ellipse UPSes) actually push that limit.
  */
-#define USB_CTRL_GET_TIMEOUT   5000
-#define USB_CTRL_SET_TIMEOUT   5000
+#define USB_CTRL_GET_TIMEOUT   5
+#define USB_CTRL_SET_TIMEOUT   5
 
 
 /**
@@ -1065,35 +1040,55 @@ void usb_sg_wait (struct usb_sg_request *io);
 /* -------------------------------------------------------------------------- */
 
 /*
- * For various legacy reasons, Linux has a small cookie that's paired with
- * a struct usb_device to identify an endpoint queue.  Queue characteristics
- * are defined by the endpoint's descriptor.  This cookie is called a "pipe",
- * an unsigned int encoded as:
+ * Calling this entity a "pipe" is glorifying it. A USB pipe
+ * is something embarrassingly simple: it basically consists
+ * of the following information:
+ *  - device number (7 bits)
+ *  - endpoint number (4 bits)
+ *  - current Data0/1 state (1 bit) [Historical; now gone]
+ *  - direction (1 bit)
+ *  - speed (1 bit) [Historical and specific to USB 1.1; now gone.]
+ *  - max packet size (2 bits: 8, 16, 32 or 64) [Historical; now gone.]
+ *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
+ *
+ * That's 18 bits. Really. Nothing more. And the USB people have
+ * documented these eighteen bits as some kind of glorious
+ * virtual data structure.
+ *
+ * Let's not fall in that trap. We'll just encode it as a simple
+ * unsigned int. The encoding is:
  *
+ *  - max size:                bits 0-1        [Historical; now gone.]
  *  - direction:       bit 7           (0 = Host-to-Device [Out],
  *                                      1 = Device-to-Host [In] ...
  *                                     like endpoint bEndpointAddress)
- *  - device address:  bits 8-14       ... bit positions known to uhci-hcd
+ *  - device:          bits 8-14       ... bit positions known to uhci-hcd
  *  - endpoint:                bits 15-18      ... bit positions known to uhci-hcd
+ *  - Data0/1:         bit 19          [Historical; now gone. ]
+ *  - lowspeed:                bit 26          [Historical; now gone. ]
  *  - pipe type:       bits 30-31      (00 = isochronous, 01 = interrupt,
  *                                      10 = control, 11 = bulk)
  *
- * Given the device address and endpoint descriptor, pipes are redundant.
+ * Why? Because it's arbitrary, and whatever encoding we select is really
+ * up to us. This one happens to share a lot of bit positions with the UHCI
+ * specification, so that much of the uhci driver can just mask the bits
+ * appropriately.
  */
 
 /* NOTE:  these are not the standard USB_ENDPOINT_XFER_* values!! */
-/* (yet ... they're the values used by usbfs) */
 #define PIPE_ISOCHRONOUS               0
 #define PIPE_INTERRUPT                 1
 #define PIPE_CONTROL                   2
 #define PIPE_BULK                      3
 
+#define usb_maxpacket(dev, pipe, out)  (out \
+                               ? (dev)->epmaxpacketout[usb_pipeendpoint(pipe)] \
+                               : (dev)->epmaxpacketin [usb_pipeendpoint(pipe)] )
+
 #define usb_pipein(pipe)       ((pipe) & USB_DIR_IN)
 #define usb_pipeout(pipe)      (!usb_pipein(pipe))
-
 #define usb_pipedevice(pipe)   (((pipe) >> 8) & 0x7f)
 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
-
 #define usb_pipetype(pipe)     (((pipe) >> 30) & 3)
 #define usb_pipeisoc(pipe)     (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
 #define usb_pipeint(pipe)      (usb_pipetype((pipe)) == PIPE_INTERRUPT)
@@ -1121,28 +1116,6 @@ static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int en
 #define usb_sndintpipe(dev,endpoint)   ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
 #define usb_rcvintpipe(dev,endpoint)   ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
 
-/*-------------------------------------------------------------------------*/
-
-static inline __u16
-usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
-{
-       struct usb_host_endpoint        *ep;
-       unsigned                        epnum = usb_pipeendpoint(pipe);
-
-       if (is_out) {
-               WARN_ON(usb_pipein(pipe));
-               ep = udev->ep_out[epnum];
-       } else {
-               WARN_ON(usb_pipeout(pipe));
-               ep = udev->ep_in[epnum];
-       }
-       if (!ep)
-               return 0;
-
-       /* NOTE:  only 0x07ff bits are for packet size... */
-       return le16_to_cpu(ep->desc.wMaxPacketSize);
-}
-
 /* -------------------------------------------------------------------------- */
 
 #ifdef DEBUG