patch-2.3.34 linux/drivers/usb/uhci.h

• Lines: 412
• Date: Fri Dec 17 16:49:45 1999
• Orig file: v2.3.33/linux/drivers/usb/uhci.h
• Orig date: Sun Nov 7 16:37:34 1999

diff -u --recursive --new-file v2.3.33/linux/drivers/usb/uhci.h linux/drivers/usb/uhci.h
@@ -1,13 +1,12 @@
 #ifndef __LINUX_UHCI_H
 #define __LINUX_UHCI_H
 
-#include <linux/list.h>
-
-#include "usb.h"
-
 /*
- * Universal Host Controller Interface data structures and defines
+   $Id: uhci.h,v 1.30 1999/12/15 17:57:25 fliegl Exp $
  */
+#define MODNAME "usb-uhci"
+#define MODSTR MODNAME": "
+#define VERSTR "version v0.9 time " __TIME__ " " __DATE__
 
 /* Command register */
 #define USBCMD		0
@@ -55,7 +54,7 @@
 
 /* Legacy support register */
 #define USBLEGSUP 0xc0
-#define USBLEGSUP_DEFAULT 0x2000 /* only PIRQ enable set */
+#define USBLEGSUP_DEFAULT 0x2000	/* only PIRQ enable set */
 
 #define UHCI_NULL_DATA_SIZE	0x7ff	/* for UHCI controller TD */
 
@@ -68,27 +67,6 @@
 #define UHCI_MAX_SOF_NUMBER	2047	/* in an SOF packet */
 #define CAN_SCHEDULE_FRAMES	1000	/* how far future frames can be scheduled */
 
-struct uhci_td;
-
-struct uhci_qh {
-	/* Hardware fields */
-	__u32 link;				/* Next queue */
-	__u32 element;				/* Queue element pointer */
-
-	/* Software fields */
-	atomic_t refcnt;			/* Reference counting */
-	struct uhci_device *dev;		/* The owning device */
-	struct uhci_qh *skel;			/* Skeleton head */
-
-	struct uhci_td *first;			/* First TD in the chain */
-
-	wait_queue_head_t wakeup;
-} __attribute__((aligned(16)));
-
-struct uhci_framelist {
-	__u32 frame[UHCI_NUMFRAMES];
-} __attribute__((aligned(4096)));
-
 /*
  * for TD <status>:
  */
@@ -104,20 +82,19 @@
 #define TD_CTRL_NAK		(1 << 19)	/* NAK Received */
 #define TD_CTRL_CRCTIMEO	(1 << 18)	/* CRC/Time Out Error */
 #define TD_CTRL_BITSTUFF	(1 << 17)	/* Bit Stuff Error */
-#define TD_CTRL_ACTLEN_MASK	0x7ff		/* actual length, encoded as n - 1 */
+#define TD_CTRL_ACTLEN_MASK	0x7ff	/* actual length, encoded as n - 1 */
 
 #define TD_CTRL_ANY_ERROR	(TD_CTRL_STALLED | TD_CTRL_DBUFERR | \
 				 TD_CTRL_BABBLE | TD_CTRL_CRCTIME | TD_CTRL_BITSTUFF)
 
 #define uhci_status_bits(ctrl_sts)	(ctrl_sts & 0xFE0000)
-#define uhci_actual_length(ctrl_sts)	((ctrl_sts + 1) & TD_CTRL_ACTLEN_MASK) /* 1-based */
-
+#define uhci_actual_length(ctrl_sts)	((ctrl_sts + 1) & TD_CTRL_ACTLEN_MASK)	/* 1-based */
 #define uhci_ptr_to_virt(x)	bus_to_virt(x & ~UHCI_PTR_BITS)
 
 /*
  * for TD <flags>:
  */
-#define UHCI_TD_REMOVE		0x0001		/* Remove when done */
+#define UHCI_TD_REMOVE		0x0001	/* Remove when done */
 
 /*
  * for TD <info>: (a.k.a. Token)
@@ -125,7 +102,6 @@
 #define TD_TOKEN_TOGGLE		19
 
 #define uhci_maxlen(token)	((token) >> 21)
-#define uhci_expected_length(info) (((info >> 21) + 1) & TD_CTRL_ACTLEN_MASK) /* 1-based */
 #define uhci_toggle(token)	(((token) >> TD_TOKEN_TOGGLE) & 1)
 #define uhci_endpoint(token)	(((token) >> 15) & 0xf)
 #define uhci_devaddr(token)	(((token) >> 8) & 0x7f)
@@ -134,201 +110,143 @@
 #define uhci_packetout(token)	(uhci_packetid(token) != USB_PID_IN)
 #define uhci_packetin(token)	(uhci_packetid(token) == USB_PID_IN)
 
-/*
- * The documentation says "4 words for hardware, 4 words for software".
- *
- * That's silly, the hardware doesn't care. The hardware only cares that
- * the hardware words are 16-byte aligned, and we can have any amount of
- * sw space after the TD entry as far as I can tell.
- *
- * But let's just go with the documentation, at least for 32-bit machines.
- * On 64-bit machines we probably want to take advantage of the fact that
- * hw doesn't really care about the size of the sw-only area.
- *
- * Alas, not anymore, we have more than 4 words for software, woops
- */
-struct uhci_td {
-	/* Hardware fields */
+/* ------------------------------------------------------------------------------------
+   New TD/QH-structures
+   ------------------------------------------------------------------------------------ */
+typedef enum {
+	TD_TYPE, QH_TYPE
+} uhci_desc_type_t;
+
+typedef struct {
 	__u32 link;
 	__u32 status;
 	__u32 info;
 	__u32 buffer;
+} uhci_td_t, *puhci_td_t;
 
-	/* Software fields */
-	unsigned int *backptr;		/* Where to remove this from.. */
-	struct list_head irq_list;	/* Active interrupt list.. */
-
-	usb_device_irq completed;	/* Completion handler routine */
-	void *dev_id;
-
-	atomic_t refcnt;		/* Reference counting */
-
-	struct uhci_device *dev;	/* The owning device */
-	struct uhci_qh *qh;		/* QH this TD is a part of (ignored for Isochronous) */
-	unsigned char pipetype;		/* Control, Bulk, Interrupt, Isoc */
-	int flags;			/* Remove, etc */
-	int isoc_td_number;		/* 0-relative number within a usb_isoc_desc. */
-	int bandwidth_alloc;            /* in microsecs; used only for Interrupt
-					 * transfers, to return its bandwidth */
-} __attribute__((aligned(16)));
-
-/*
- * Note the alignment requirements of the entries
- *
- * Each UHCI device has pre-allocated QH and TD entries.
- * You can use more than the pre-allocated ones, but I
- * don't see you usually needing to.
- */
-struct uhci;
-
-/* The usb device part must be first! Not anymore -jerdfelt */
-struct uhci_device {
-	struct usb_device	*usb;
-
-	atomic_t		refcnt;
-
-	struct uhci		*uhci;
-
-	unsigned long		data[16];
+typedef struct {
+	__u32 head;
+	__u32 element;		/* Queue element pointer */
+} uhci_qh_t, *puhci_qh_t;
+
+typedef struct {
+	union {
+		uhci_td_t td;
+		uhci_qh_t qh;
+	} hw;
+	uhci_desc_type_t type;
+	struct list_head horizontal;
+	struct list_head vertical;
+	struct list_head desc_list;
+} uhci_desc_t, *puhci_desc_t;
+
+typedef struct {
+	struct list_head desc_list;	// list pointer to all corresponding TDs/QHs associated with this request
+	int short_control_packet;
+} urb_priv_t, *purb_priv_t;
+
+struct virt_root_hub {
+	int devnum;		/* Address of Root Hub endpoint */
+	void *urb;
+	void *int_addr;
+	int send;
+	int interval;
+	int numports;
+	int c_p_r[8];
+	struct timer_list rh_int_timer;
 };
 
-#define uhci_to_usb(uhci)	((uhci)->usb)
-#define usb_to_uhci(usb)	((struct uhci_device *)(usb)->hcpriv)
-
-/*
- * There are various standard queues. We set up several different
- * queues for each of the three basic queue types: interrupt,
- * control, and bulk.
- *
- *  - There are various different interrupt latencies: ranging from
- *    every other USB frame (2 ms apart) to every 256 USB frames (ie
- *    256 ms apart). Make your choice according to how obnoxious you
- *    want to be on the wire, vs how critical latency is for you.
- *  - The control list is done every frame.
- *  - There are 4 bulk lists, so that up to four devices can have a
- *    bulk list of their own and when run concurrently all four lists
- *    will be be serviced.
- *
- * This is a bit misleading, there are various interrupt latencies, but they
- * vary a bit, interrupt2 isn't exactly 2ms, it can vary up to 4ms since the
- * other queues can "override" it. interrupt4 can vary up to 8ms, etc. Minor
- * problem
- *
- * In the case of the root hub, these QH's are just head's of qh's. Don't
- * be scared, it kinda makes sense. Look at this wonderful picture care of
- * Linus:
- *
- *  generic-  ->  dev1-  ->  generic-  ->  dev1-  ->  control-  ->  bulk- -> ...
- *   iso-QH      iso-QH       irq-QH      irq-QH        QH           QH
- *      |           |            |           |           |            |
- *     End     dev1-iso-TD1     End     dev1-irq-TD1    ...          ... 
- *                  |
- *             dev1-iso-TD2
- *                  |
- *                ....
- *
- * This may vary a bit (the UHCI docs don't explicitly say you can put iso
- * transfers in QH's and all of their pictures don't have that either) but
- * other than that, that is what we're doing now
- *
- * And now we don't put Iso transfers in QH's, so we don't waste one on it
- * --jerdfelt
- *
- * To keep with Linus' nomenclature, this is called the QH skeleton. These
- * labels (below) are only signficant to the root hub's QH's
- */
-#define UHCI_NUM_SKELQH		11
-
-#define skel_int1_qh		skelqh[0]
-#define skel_int2_qh		skelqh[1]
-#define skel_int4_qh		skelqh[2]
-#define skel_int8_qh		skelqh[3]
-#define skel_int16_qh		skelqh[4]
-#define skel_int32_qh		skelqh[5]
-#define skel_int64_qh		skelqh[6]
-#define skel_int128_qh		skelqh[7]
-#define skel_int256_qh		skelqh[8]
-
-#define skel_control_qh		skelqh[9]
-
-#define skel_bulk_qh		skelqh[10]
-
-/*
- * Search tree for determining where <interval> fits in the
- * skelqh[] skeleton.
- *
- * An interrupt request should be placed into the slowest skelqh[]
- * which meets the interval/period/frequency requirement.
- * An interrupt request is allowed to be faster than <interval> but not slower.
- *
- * For a given <interval>, this function returns the appropriate/matching
- * skelqh[] index value.
- *
- * NOTE: For UHCI, we don't really need int256_qh since the maximum interval
- * is 255 ms.  However, we do need an int1_qh since 1 is a valid interval
- * and we should meet that frequency when requested to do so.
- * This will require some change(s) to the UHCI skeleton.
- */
-static inline int __interval_to_skel(int interval)
-{
-	if (interval < 16) {
-		if (interval < 4) {
-			if (interval < 2) {
-				return 0;	/* int1 for 0-1 ms */
-			}
-			return 1;		/* int2 for 2-3 ms */
-		}
-		if (interval < 8) {
-			return 2;		/* int4 for 4-7 ms */
-		}
-		return 3;			/* int8 for 8-15 ms */
-	}
-	if (interval < 64) {
-		if (interval < 32) {
-			return 4;		/* int16 for 16-31 ms */
-		}
-		return 5;			/* int32 for 32-63 ms */
-	}
-	if (interval < 128)
-		return 6;			/* int64 for 64-127 ms */
-	return 7;				/* int128 for 128-255 ms (Max.) */
-}
-
-/*
- * This describes the full uhci information.
- *
- * Note how the "proper" USB information is just
- * a subset of what the full implementation needs.
- */
-struct uhci {
+typedef struct uhci {
 	int irq;
 	unsigned int io_addr;
 	unsigned int io_size;
+	unsigned int maxports;
 
-	int control_pid;
-	int control_running;
-	int control_continue;
-
-	struct list_head uhci_list;
+	int apm_state;
 
-	struct usb_bus *bus;
+	struct uhci *next;	// chain of uhci device contexts
 
-	struct uhci_qh skelqh[UHCI_NUM_SKELQH];	/* Skeleton QH's */
+	struct list_head urb_list;	// list of all pending urbs
 
-	struct uhci_framelist *fl;		/* Frame list */
-	struct list_head interrupt_list;	/* List of interrupt-active TD's for this uhci */
+	spinlock_t urb_list_lock;	// lock to keep consistency 
+
+	struct usb_bus *bus;	// our bus
+
+	spinlock_t unlink_urb_lock;	// lock for unlink_urb
+
+	__u32 *framelist;
+	uhci_desc_t **iso_td;
+	uhci_desc_t *int_chain[8];
+	uhci_desc_t *control_chain;
+	uhci_desc_t *bulk_chain;
+	uhci_desc_t *chain_end;
+	spinlock_t qh_lock;
+	spinlock_t td_lock;
+	struct virt_root_hub rh;	//private data of the virtual root hub
+} uhci_t, *puhci_t;
+
+
+#define MAKE_TD_ADDR(a) (virt_to_bus(a)&~UHCI_PTR_QH)
+#define MAKE_QH_ADDR(a) (virt_to_bus(a)|UHCI_PTR_QH)
+#define UHCI_GET_CURRENT_FRAME(uhci) (inw ((uhci)->io_addr + USBFRNUM))
+
+/* ------------------------------------------------------------------------------------ 
+   Virtual Root HUB 
+   ------------------------------------------------------------------------------------ */
+/* destination of request */
+#define RH_INTERFACE               0x01
+#define RH_ENDPOINT                0x02
+#define RH_OTHER                   0x03
+
+#define RH_CLASS                   0x20
+#define RH_VENDOR                  0x40
+
+/* Requests: bRequest << 8 | bmRequestType */
+#define RH_GET_STATUS           0x0080
+#define RH_CLEAR_FEATURE        0x0100
+#define RH_SET_FEATURE          0x0300
+#define RH_SET_ADDRESS			0x0500
+#define RH_GET_DESCRIPTOR		0x0680
+#define RH_SET_DESCRIPTOR       0x0700
+#define RH_GET_CONFIGURATION	0x0880
+#define RH_SET_CONFIGURATION	0x0900
+#define RH_GET_STATE            0x0280
+#define RH_GET_INTERFACE        0x0A80
+#define RH_SET_INTERFACE        0x0B00
+#define RH_SYNC_FRAME           0x0C80
+/* Our Vendor Specific Request */
+#define RH_SET_EP               0x2000
+
+
+/* Hub port features */
+#define RH_PORT_CONNECTION         0x00
+#define RH_PORT_ENABLE             0x01
+#define RH_PORT_SUSPEND            0x02
+#define RH_PORT_OVER_CURRENT       0x03
+#define RH_PORT_RESET              0x04
+#define RH_PORT_POWER              0x08
+#define RH_PORT_LOW_SPEED          0x09
+#define RH_C_PORT_CONNECTION       0x10
+#define RH_C_PORT_ENABLE           0x11
+#define RH_C_PORT_SUSPEND          0x12
+#define RH_C_PORT_OVER_CURRENT     0x13
+#define RH_C_PORT_RESET            0x14
+
+/* Hub features */
+#define RH_C_HUB_LOCAL_POWER       0x00
+#define RH_C_HUB_OVER_CURRENT      0x01
+
+#define RH_DEVICE_REMOTE_WAKEUP    0x00
+#define RH_ENDPOINT_STALL          0x01
+
+/* Our Vendor Specific feature */
+#define RH_REMOVE_EP               0x00
+
+
+#define RH_ACK                     0x01
+#define RH_REQ_ERR                 -1
+#define RH_NACK                    0x00
 
-	struct uhci_td *ticktd;
-};
-
-/* needed for the debugging code */
-struct uhci_td *uhci_link_to_td(unsigned int element);
-
-/* Debugging code */
-void uhci_show_td(struct uhci_td *td);
-void uhci_show_status(struct uhci *uhci);
-void uhci_show_queue(struct uhci_qh *qh);
-void uhci_show_queues(struct uhci *uhci);
+#define min(a,b) (((a)<(b))?(a):(b))
 
 #endif
-