summaryrefslogtreecommitdiffstats
path: root/sys/legacy/dev/usb/uhcivar.h
diff options
context:
space:
mode:
authorthompsa <thompsa@FreeBSD.org>2009-02-23 18:16:17 +0000
committerthompsa <thompsa@FreeBSD.org>2009-02-23 18:16:17 +0000
commit44cdb003f768f8f466e2546d2963fd109144656d (patch)
tree8f5871490a716fe01fdd8316568d9ba35036b3fa /sys/legacy/dev/usb/uhcivar.h
parentffd00ec82d4a755e3b6446e81ff6edf721cdf88d (diff)
downloadFreeBSD-src-44cdb003f768f8f466e2546d2963fd109144656d.zip
FreeBSD-src-44cdb003f768f8f466e2546d2963fd109144656d.tar.gz
Move usb to a graveyard location under sys/legacy/dev, it is intended that the
new USB2 stack will fully replace this for 8.0. Remove kernel modules, a subsequent commit will update conf/files. Unhook usbdevs from the build.
Diffstat (limited to 'sys/legacy/dev/usb/uhcivar.h')
-rw-r--r--sys/legacy/dev/usb/uhcivar.h206
1 files changed, 206 insertions, 0 deletions
diff --git a/sys/legacy/dev/usb/uhcivar.h b/sys/legacy/dev/usb/uhcivar.h
new file mode 100644
index 0000000..0df23f1
--- /dev/null
+++ b/sys/legacy/dev/usb/uhcivar.h
@@ -0,0 +1,206 @@
+/* $NetBSD: uhcivar.h,v 1.33 2002/02/11 11:41:30 augustss Exp $ */
+/* $FreeBSD$ */
+
+/*-
+ * Copyright (c) 1998 The NetBSD Foundation, Inc.
+ * All rights reserved.
+ *
+ * This code is derived from software contributed to The NetBSD Foundation
+ * by Lennart Augustsson (lennart@augustsson.net) at
+ * Carlstedt Research & Technology.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ * must display the following acknowledgement:
+ * This product includes software developed by the NetBSD
+ * Foundation, Inc. and its contributors.
+ * 4. Neither the name of The NetBSD Foundation nor the names of its
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * To avoid having 1024 TDs for each isochronous transfer we introduce
+ * a virtual frame list. Every UHCI_VFRAMELIST_COUNT entries in the real
+ * frame list points to a non-active TD. These, in turn, form the
+ * starts of the virtual frame list. This also has the advantage that it
+ * simplifies linking in/out of TDs/QHs in the schedule.
+ * Furthermore, initially each of the inactive TDs point to an inactive
+ * QH that forms the start of the interrupt traffic for that slot.
+ * Each of these QHs point to the same QH that is the start of control
+ * traffic. This QH points at another QH which is the start of the
+ * bulk traffic.
+ *
+ * UHCI_VFRAMELIST_COUNT should be a power of 2 and <= UHCI_FRAMELIST_COUNT.
+ */
+#define UHCI_VFRAMELIST_COUNT 128
+
+typedef struct uhci_soft_qh uhci_soft_qh_t;
+typedef struct uhci_soft_td uhci_soft_td_t;
+
+typedef union {
+ struct uhci_soft_qh *sqh;
+ struct uhci_soft_td *std;
+} uhci_soft_td_qh_t;
+
+/*
+ * An interrupt info struct contains the information needed to
+ * execute a requested routine when the controller generates an
+ * interrupt. Since we cannot know which transfer generated
+ * the interrupt all structs are linked together so they can be
+ * searched at interrupt time.
+ */
+typedef struct uhci_intr_info {
+ struct uhci_softc *sc;
+ usbd_xfer_handle xfer;
+ uhci_soft_td_t *stdstart;
+ uhci_soft_td_t *stdend;
+ LIST_ENTRY(uhci_intr_info) list;
+#ifdef DIAGNOSTIC
+ int isdone;
+#endif
+} uhci_intr_info_t;
+
+struct uhci_xfer {
+ struct usbd_xfer xfer;
+ uhci_intr_info_t iinfo;
+ struct usb_task abort_task;
+ int curframe;
+ u_int32_t uhci_xfer_flags;
+};
+
+#define UHCI_XFER_ABORTING 0x0001 /* xfer is aborting. */
+#define UHCI_XFER_ABORTWAIT 0x0002 /* abort completion is being awaited. */
+
+#define UXFER(xfer) ((struct uhci_xfer *)(xfer))
+
+/*
+ * Extra information that we need for a TD.
+ */
+struct uhci_soft_td {
+ uhci_td_t td; /* The real TD, must be first */
+ uhci_soft_td_qh_t link; /* soft version of the td_link field */
+ uhci_physaddr_t physaddr; /* TD's physical address. */
+ usb_dma_t aux_dma; /* Auxillary storage if needed. */
+ void *aux_data; /* Original aux data virtual address. */
+ int aux_len; /* Auxillary storage size. */
+};
+/*
+ * Make the size such that it is a multiple of UHCI_TD_ALIGN. This way
+ * we can pack a number of soft TD together and have the real TD well
+ * aligned.
+ * NOTE: Minimum size is 32 bytes.
+ */
+#define UHCI_STD_SIZE ((sizeof (struct uhci_soft_td) + UHCI_TD_ALIGN - 1) / UHCI_TD_ALIGN * UHCI_TD_ALIGN)
+#define UHCI_STD_CHUNK (PAGE_SIZE / UHCI_STD_SIZE)
+
+/*
+ * Extra information that we need for a QH.
+ */
+struct uhci_soft_qh {
+ uhci_qh_t qh; /* The real QH, must be first */
+ uhci_soft_qh_t *hlink; /* soft version of qh_hlink */
+ uhci_soft_td_t *elink; /* soft version of qh_elink */
+ uhci_physaddr_t physaddr; /* QH's physical address. */
+ int pos; /* Timeslot position */
+};
+/* See comment about UHCI_STD_SIZE. */
+#define UHCI_SQH_SIZE ((sizeof (struct uhci_soft_qh) + UHCI_QH_ALIGN - 1) / UHCI_QH_ALIGN * UHCI_QH_ALIGN)
+#define UHCI_SQH_CHUNK (PAGE_SIZE / UHCI_SQH_SIZE)
+
+/*
+ * Information about an entry in the virtual frame list.
+ */
+struct uhci_vframe {
+ uhci_soft_td_t *htd; /* pointer to dummy TD */
+ uhci_soft_td_t *etd; /* pointer to last TD */
+ uhci_soft_qh_t *hqh; /* pointer to dummy QH */
+ uhci_soft_qh_t *eqh; /* pointer to last QH */
+ u_int bandwidth; /* max bandwidth used by this frame */
+};
+
+#define UHCI_SCFLG_DONEINIT 0x0001 /* uhci_init() done */
+
+typedef struct uhci_softc {
+ struct usbd_bus sc_bus; /* base device */
+ int sc_flags;
+ bus_space_tag_t iot;
+ bus_space_handle_t ioh;
+ bus_size_t sc_size;
+ void *ih;
+
+ struct resource *io_res;
+ struct resource *irq_res;
+ uhci_physaddr_t *sc_pframes;
+ usb_dma_t sc_dma;
+ struct uhci_vframe sc_vframes[UHCI_VFRAMELIST_COUNT];
+
+ uhci_soft_qh_t *sc_lctl_start; /* dummy QH for low speed control */
+ uhci_soft_qh_t *sc_lctl_end; /* last control QH */
+ uhci_soft_qh_t *sc_hctl_start; /* dummy QH for high speed control */
+ uhci_soft_qh_t *sc_hctl_end; /* last control QH */
+ uhci_soft_qh_t *sc_bulk_start; /* dummy QH for bulk */
+ uhci_soft_qh_t *sc_bulk_end; /* last bulk transfer */
+ uhci_soft_qh_t *sc_last_qh; /* dummy QH at the end */
+ u_int32_t sc_loops; /* number of QHs that wants looping */
+
+ uhci_soft_td_t *sc_freetds; /* TD free list */
+ uhci_soft_qh_t *sc_freeqhs; /* QH free list */
+
+ STAILQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
+
+ u_int8_t sc_addr; /* device address */
+ u_int8_t sc_conf; /* device configuration */
+
+ u_int8_t sc_saved_sof;
+ u_int16_t sc_saved_frnum;
+
+#ifdef USB_USE_SOFTINTR
+ char sc_softwake;
+#endif /* USB_USE_SOFTINTR */
+
+ char sc_isreset;
+ char sc_suspend;
+ char sc_dying;
+
+ LIST_HEAD(, uhci_intr_info) sc_intrhead;
+
+ /* Info for the root hub interrupt channel. */
+ int sc_ival; /* time between root hub intrs */
+ usbd_xfer_handle sc_intr_xfer; /* root hub interrupt transfer */
+ struct callout sc_poll_handle;
+
+ char sc_vendor[16]; /* vendor string for root hub */
+ int sc_id_vendor; /* vendor ID for root hub */
+
+#if defined(__NetBSD__)
+ void *sc_powerhook; /* cookie from power hook */
+ void *sc_shutdownhook; /* cookie from shutdown hook */
+#endif
+} uhci_softc_t;
+
+usbd_status uhci_init(uhci_softc_t *);
+int uhci_intr(void *);
+int uhci_detach(uhci_softc_t *, int);
+void uhci_shutdown(void *v);
+void uhci_power(int state, void *priv);
+
OpenPOWER on IntegriCloud