sys/dev/qbus/ubavar.h

   1 /*      $NetBSD: ubavar.h,v 1.38 2007/03/04 06:02:30 christos Exp $     */
   2
   3 /*
   4  * Copyright (c) 1982, 1986 Regents of the University of California.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)ubavar.h    7.7 (Berkeley) 6/28/90
  32  */
  33 #ifndef _QBUS_UBAVAR_H
  34 #define _QBUS_UBAVAR_H
  35
  36 /*
  37  * This file contains definitions related to the kernel structures
  38  * for dealing with the unibus adapters.
  39  *
  40  * Each uba has a uba_softc structure.
  41  * Each unibus controller which is not a device has a uba_ctlr structure.
  42  * Each unibus device has a uba_device structure.
  43  */
  44
  45 /*
  46  * Per-uba structure.
  47  *
  48  * This structure holds the interrupt vector for the uba,
  49  * and its address in physical and virtual space.  At boot time
  50  * we determine the devices attached to the uba's and their
  51  * interrupt vectors, filling in uh_vec.  We free the map
  52  * register and bdp resources of the uba into the structures
  53  * defined here.
  54  *
  55  * During normal operation, resources are allocated and returned
  56  * to the structures here.  We watch the number of passive releases
  57  * on each uba, and if the number is excessive may reset the uba.
  58  *
  59  * When uba resources are needed and not available, or if a device
  60  * which can tolerate no other uba activity (rk07) gets on the bus,
  61  * then device drivers may have to wait to get to the bus and are
  62  * queued here.  It is also possible for processes to block in
  63  * the unibus driver in resource wait (mrwant, bdpwant); these
  64  * wait states are also recorded here.
  65  */
  66 struct  uba_softc {
  67         device_t uh_dev;                /* Device struct, autoconfig */
  68         struct evcnt uh_intrcnt;                /* interrupt counting */
  69         SIMPLEQ_HEAD(, uba_unit) uh_resq;       /* resource wait chain */
  70         SIMPLEQ_HEAD(, uba_reset) uh_resetq;    /* ubareset queue */
  71         int     uh_lastiv;              /* last free interrupt vector */
  72         int     (*uh_errchk)(struct uba_softc *);
  73         void    (*uh_beforescan)(struct uba_softc *);
  74         void    (*uh_afterscan)(struct uba_softc *);
  75         void    (*uh_ubainit)(struct uba_softc *);
  76         void    (*uh_ubapurge)(struct uba_softc *, int);
  77         short   uh_nr;                  /* Unibus sequential number */
  78         short   uh_type;                /* Type of bus */
  79         bus_space_tag_t uh_iot;         /* Tag for this Unibus */
  80         bus_space_handle_t uh_ioh;      /* Handle for I/O space */
  81         bus_dma_tag_t   uh_dmat;
  82         char    *uh_used;               /* I/O addresses used */
  83 };
  84
  85 /*
  86  * Per-controller structure.
  87  * The unit struct is common to both the adapter and the controller
  88  * to which it belongs. It is only used on controllers that handles
  89  * BDP's, and calls the adapter queueing subroutines.
  90  */
  91 struct  uba_unit {
  92         SIMPLEQ_ENTRY(uba_unit) uu_resq;/* Queue while waiting for resources */
  93         device_t uu_dev;        /* unit's device_t */
  94         int     uu_bdp;         /* for controllers that hang on to bdp's */
  95         int    (*uu_ready)(struct uba_unit *);
  96         void    *uu_ref;        /* Buffer this is related to */
  97         short   uu_xclu;        /* want exclusive use of bdp's */
  98         short   uu_keepbdp;     /* hang on to bdp's once allocated */
  99 };
 100
 101 /*
 102  * Reset structure. All devices that needs to be reinitialized
 103  * after an ubareset registers with this struct.
 104  */
 105 struct  uba_reset {
 106         SIMPLEQ_ENTRY(uba_reset) ur_resetq;
 107         void (*ur_reset)(device_t);
 108         device_t ur_dev;
 109 };
 110
 111 /*
 112  * uba_attach_args is used during autoconfiguration. It is sent
 113  * from ubascan() to each (possible) device.
 114  */
 115 struct uba_attach_args {
 116         bus_space_tag_t ua_iot;         /* Tag for this bus I/O-space */
 117         bus_addr_t      ua_ioh;         /* I/O regs addr */
 118         bus_dma_tag_t   ua_dmat;        /* DMA tag for this bus'es dma */
 119         struct evcnt    *ua_evcnt;
 120         void            *ua_icookie;    /* Cookie for interrupt establish */
 121         int             ua_iaddr;       /* Full CSR address of device */
 122         int             ua_br;          /* IPL this dev interrupted on */
 123         int             ua_cvec;        /* Vector for this device */
 124 };
 125
 126 /*
 127  * Flags to UBA map/bdp allocation routines
 128  */
 129 #define UBA_NEEDBDP     0x01            /* transfer needs a bdp */
 130 #define UBA_CANTWAIT    0x02            /* don't block me */
 131 #define UBA_NEED16      0x04            /* need 16 bit addresses only */
 132 #define UBA_HAVEBDP     0x08            /* use bdp specified in high bits */
 133 #define UBA_DONTQUE     0x10            /* Do not enqueue xfer */
 134
 135 /*
 136  * Type of adapter.
 137  */
 138 #define UBA_UBA         0               /* Traditional unibus adapter */
 139 #define UBA_MVI         1               /* MVI direct-mapped unibus */
 140 #define UBA_QBUS        2               /* Qbus with map registers */
 141 /*
 142  * Struct for unibus allocation.
 143  */
 144 struct ubinfo {
 145         bus_dmamap_t ui_dmam;
 146         bus_dma_segment_t ui_seg;
 147         int ui_rseg;
 148         void *ui_vaddr;
 149         bus_addr_t ui_baddr;
 150         bus_size_t ui_size;
 151 };
 152
 153 /*
 154  * Some common defines for all subtypes of U/Q-buses/adapters.
 155  */
 156 #define MAXUBAXFER      (63*1024)       /* Max transfer size in bytes */
 157 #define ubdevreg(addr) ((addr) & 017777)
 158
 159 #ifdef _KERNEL
 160 void uba_intr_establish(void *, int, void (*)(void *), void *, struct evcnt *);
 161 void uba_reset_establish(void (*)(device_t), device_t);
 162 void uba_attach(struct uba_softc *, unsigned long);
 163 void uba_enqueue(struct uba_unit *);
 164 void uba_done(struct uba_softc *);
 165 void ubareset(struct uba_softc *);
 166 int uballoc(struct uba_softc *, struct ubinfo *, int);
 167 int ubmemalloc(struct uba_softc *, struct ubinfo *, int);
 168 void ubfree(struct uba_softc *, struct ubinfo *);
 169 void ubmemfree(struct uba_softc *, struct ubinfo *);
 170 #endif /* _KERNEL */
 171
 172 #endif /* _QBUS_UBAVAR_H */