sys/bus/usb/ohcivar.h

   1 /*      $NetBSD: ohcivar.h,v 1.30 2001/12/31 12:20:35 augustss Exp $    */
   2 /*      $FreeBSD: src/sys/dev/usb/ohcivar.h,v 1.40.2.1 2005/12/04 05:52:23 iedowse Exp $        */
   3 /*      $DragonFly: src/sys/bus/usb/ohcivar.h,v 1.8 2007/06/28 13:55:12 hasso Exp $     */
   4
   5 /*
   6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Lennart Augustsson (lennart@augustsson.net) at
  11  * Carlstedt Research & Technology.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *        This product includes software developed by the NetBSD
  24  *        Foundation, Inc. and its contributors.
  25  * 4. Neither the name of The NetBSD Foundation nor the names of its
  26  *    contributors may be used to endorse or promote products derived
  27  *    from this software without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  30  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  32  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39  * POSSIBILITY OF SUCH DAMAGE.
  40  */
  41
  42 typedef struct ohci_soft_ed {
  43         ohci_ed_t ed;
  44         struct ohci_soft_ed *next;
  45         ohci_physaddr_t physaddr;
  46 } ohci_soft_ed_t;
  47 #define OHCI_SED_SIZE ((sizeof (struct ohci_soft_ed) + OHCI_ED_ALIGN - 1) / OHCI_ED_ALIGN * OHCI_ED_ALIGN)
  48 #define OHCI_SED_CHUNK  (PAGE_SIZE / OHCI_SED_SIZE)
  49
  50 typedef struct ohci_soft_td {
  51         ohci_td_t td;
  52         struct ohci_soft_td *nexttd; /* mirrors nexttd in TD */
  53         struct ohci_soft_td *dnext; /* next in done list */
  54         ohci_physaddr_t physaddr;
  55         LIST_ENTRY(ohci_soft_td) hnext;
  56         usbd_xfer_handle xfer;
  57         u_int16_t len;
  58         u_int16_t flags;
  59 #define OHCI_CALL_DONE  0x0001
  60 #define OHCI_ADD_LEN    0x0002
  61 } ohci_soft_td_t;
  62 #define OHCI_STD_SIZE ((sizeof (struct ohci_soft_td) + OHCI_TD_ALIGN - 1) / OHCI_TD_ALIGN * OHCI_TD_ALIGN)
  63 #define OHCI_STD_CHUNK (PAGE_SIZE / OHCI_STD_SIZE)
  64
  65 typedef struct ohci_soft_itd {
  66         ohci_itd_t itd;
  67         struct ohci_soft_itd *nextitd; /* mirrors nexttd in ITD */
  68         struct ohci_soft_itd *dnext; /* next in done list */
  69         ohci_physaddr_t physaddr;
  70         LIST_ENTRY(ohci_soft_itd) hnext;
  71         usbd_xfer_handle xfer;
  72         u_int16_t flags;
  73 #define OHCI_ITD_ACTIVE 0x0010          /* Hardware op in progress */
  74 #define OHCI_ITD_INTFIN 0x0020          /* Hw completion interrupt seen.*/
  75 #ifdef DIAGNOSTIC
  76         char isdone;
  77 #endif
  78 } ohci_soft_itd_t;
  79 #define OHCI_SITD_SIZE ((sizeof (struct ohci_soft_itd) + OHCI_ITD_ALIGN - 1) / OHCI_ITD_ALIGN * OHCI_ITD_ALIGN)
  80 #define OHCI_SITD_CHUNK (PAGE_SIZE / OHCI_SITD_SIZE)
  81
  82 #define OHCI_NO_EDS (2*OHCI_NO_INTRS-1)
  83
  84 #define OHCI_HASH_SIZE 128
  85
  86 #define OHCI_SCFLG_DONEINIT     0x0001  /* ohci_init() done. */
  87
  88 typedef struct ohci_softc {
  89         struct usbd_bus sc_bus;         /* base device */
  90         int sc_flags;
  91         bus_space_tag_t iot;
  92         bus_space_handle_t ioh;
  93         bus_size_t sc_size;
  94
  95         void *ih;
  96
  97         struct resource *io_res;
  98         struct resource *irq_res;
  99
 100         usb_dma_t sc_hccadma;
 101         struct ohci_hcca *sc_hcca;
 102         ohci_soft_ed_t *sc_eds[OHCI_NO_EDS];
 103         u_int sc_bws[OHCI_NO_INTRS];
 104
 105         u_int32_t sc_eintrs;            /* enabled interrupts */
 106
 107         ohci_soft_ed_t *sc_isoc_head;
 108         ohci_soft_ed_t *sc_ctrl_head;
 109         ohci_soft_ed_t *sc_bulk_head;
 110
 111         LIST_HEAD(, ohci_soft_td)  sc_hash_tds[OHCI_HASH_SIZE];
 112         LIST_HEAD(, ohci_soft_itd) sc_hash_itds[OHCI_HASH_SIZE];
 113
 114         int sc_noport;
 115         u_int8_t sc_addr;               /* device address */
 116         u_int8_t sc_conf;               /* device configuration */
 117
 118 #ifdef USB_USE_SOFTINTR
 119         char sc_softwake;
 120 #endif /* USB_USE_SOFTINTR */
 121
 122         ohci_soft_ed_t *sc_freeeds;
 123         ohci_soft_td_t *sc_freetds;
 124         ohci_soft_itd_t *sc_freeitds;
 125
 126         STAILQ_HEAD(, usbd_xfer) sc_free_xfers; /* free xfers */
 127
 128         usbd_xfer_handle sc_intrxfer;
 129
 130         ohci_soft_itd_t *sc_sidone;
 131         ohci_soft_td_t  *sc_sdone;
 132
 133         char sc_vendor[16];
 134         int sc_id_vendor;
 135
 136         u_int32_t sc_control;           /* Preserved during suspend/standby */
 137         u_int32_t sc_intre;
 138
 139         u_int sc_overrun_cnt;
 140         struct timeval sc_overrun_ntc;
 141
 142         usb_callout_t sc_tmo_rhsc;
 143
 144         char sc_dying;
 145 } ohci_softc_t;
 146
 147 struct ohci_xfer {
 148         struct usbd_xfer xfer;
 149         struct usb_task abort_task;
 150         u_int32_t ohci_xfer_flags;
 151 };
 152 #define OHCI_ISOC_DIRTY  0x01
 153 #define OHCI_XFER_ABORTING      0x02    /* xfer is aborting. */
 154 #define OHCI_XFER_ABORTWAIT     0x04    /* abort completion is being awaited. */
 155
 156 #define OXFER(xfer) ((struct ohci_xfer *)(xfer))
 157
 158 usbd_status     ohci_init(ohci_softc_t *);
 159 int             ohci_intr(void *);
 160 int             ohci_detach(ohci_softc_t *, int);
 161
 162 #define MS_TO_TICKS(ms) ((ms) * hz / 1000)
 163
 164 void            ohci_shutdown(void *v);
 165 void            ohci_power(int state, void *priv);