sys/isa/isavar.h

   1 /*-
   2  * Copyright (c) 1998 Doug Rabson
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _ISA_ISAVAR_H_
  30 #define _ISA_ISAVAR_H_
  31
  32 struct isa_config;
  33 struct isa_pnp_id;
  34 typedef void isa_config_cb(void *arg, struct isa_config *config, int enable);
  35
  36 #include "isa_if.h"
  37 #include <isa/pnpvar.h>
  38
  39 #ifdef _KERNEL
  40
  41 /*
  42  * ISA devices are partially ordered.  This is to ensure that hardwired
  43  * devices the BIOS tells us are there appear first, then speculative
  44  * devices that are sensitive to the probe order, then devices that
  45  * are hinted to be there, then the most flexible devices which support
  46  * the ISA bus PNP standard.
  47  */
  48 #define ISA_ORDER_PNPBIOS       10 /* plug-and-play BIOS inflexible hardware */
  49 #define ISA_ORDER_SENSITIVE     20 /* legacy sensitive hardware */
  50 #define ISA_ORDER_SPECULATIVE   30 /* legacy non-sensitive hardware */
  51 #define ISA_ORDER_PNP           40 /* plug-and-play flexible hardware */
  52
  53 /*
  54  * Limits on resources that we can manage
  55  */
  56 #define ISA_NPORT       50
  57 #define ISA_NMEM        50
  58 #define ISA_NIRQ        50
  59 #define ISA_NDRQ        50
  60
  61 /*
  62  * Limits on resources the hardware can actually handle
  63  */
  64 #define ISA_PNP_NPORT   8
  65 #define ISA_PNP_NMEM    4
  66 #define ISA_PNP_NIRQ    2
  67 #define ISA_PNP_NDRQ    2
  68
  69 #define ISADMA_READ     0x00100000
  70 #define ISADMA_WRITE    0
  71 #define ISADMA_RAW      0x00080000
  72 /*
  73  * Plug and play cards can support a range of resource
  74  * configurations. This structure is used by the isapnp parser to
  75  * inform the isa bus about the resource possibilities of the
  76  * device. Each different alternative should be supplied by calling
  77  * ISA_ADD_CONFIG().
  78  */
  79 struct isa_range {
  80         u_int32_t               ir_start;
  81         u_int32_t               ir_end;
  82         u_int32_t               ir_size;
  83         u_int32_t               ir_align;
  84 };
  85
  86 struct isa_config {
  87         struct isa_range        ic_mem[ISA_NMEM];
  88         struct isa_range        ic_port[ISA_NPORT];
  89         u_int32_t               ic_irqmask[ISA_NIRQ];
  90         u_int32_t               ic_drqmask[ISA_NDRQ];
  91         int                     ic_nmem;
  92         int                     ic_nport;
  93         int                     ic_nirq;
  94         int                     ic_ndrq;
  95 };
  96
  97 /*
  98  * Used to build lists of IDs and description strings for PnP drivers.
  99  */
 100 struct isa_pnp_id {
 101         u_int32_t               ip_id;
 102         const char              *ip_desc;
 103 };
 104
 105 enum isa_device_ivars {
 106         ISA_IVAR_PORT,
 107         ISA_IVAR_PORT_0 = ISA_IVAR_PORT,
 108         ISA_IVAR_PORT_1,
 109         ISA_IVAR_PORTSIZE,
 110         ISA_IVAR_PORTSIZE_0 = ISA_IVAR_PORTSIZE,
 111         ISA_IVAR_PORTSIZE_1,
 112         ISA_IVAR_MADDR,
 113         ISA_IVAR_MADDR_0 = ISA_IVAR_MADDR,
 114         ISA_IVAR_MADDR_1,
 115         ISA_IVAR_MEMSIZE,
 116         ISA_IVAR_MEMSIZE_0 = ISA_IVAR_MEMSIZE,
 117         ISA_IVAR_MEMSIZE_1,
 118         ISA_IVAR_IRQ,
 119         ISA_IVAR_IRQ_0 = ISA_IVAR_IRQ,
 120         ISA_IVAR_IRQ_1,
 121         ISA_IVAR_DRQ,
 122         ISA_IVAR_DRQ_0 = ISA_IVAR_DRQ,
 123         ISA_IVAR_DRQ_1,
 124         ISA_IVAR_VENDORID,
 125         ISA_IVAR_SERIAL,
 126         ISA_IVAR_LOGICALID,
 127         ISA_IVAR_COMPATID,
 128         ISA_IVAR_CONFIGATTR,
 129         ISA_IVAR_PNP_CSN,
 130         ISA_IVAR_PNP_LDN,
 131         ISA_IVAR_PNPBIOS_HANDLE
 132 };
 133
 134 /*
 135  * ISA_IVAR_CONFIGATTR bits
 136  */
 137 #define ISACFGATTR_CANDISABLE   (1 << 0)        /* can be disabled */
 138 #define ISACFGATTR_DYNAMIC      (1 << 1)        /* dynamic configuration */
 139 #define ISACFGATTR_HINTS        (1 << 3)        /* source of config is hints */
 140
 141 /*
 142  * Simplified accessors for isa devices
 143  */
 144 #define ISA_ACCESSOR(var, ivar, type)                                   \
 145         __BUS_ACCESSOR(isa, var, ISA, ivar, type)
 146
 147 ISA_ACCESSOR(port, PORT, int)
 148 ISA_ACCESSOR(portsize, PORTSIZE, int)
 149 ISA_ACCESSOR(irq, IRQ, int)
 150 ISA_ACCESSOR(drq, DRQ, int)
 151 ISA_ACCESSOR(maddr, MADDR, int)
 152 ISA_ACCESSOR(msize, MEMSIZE, int)
 153 ISA_ACCESSOR(vendorid, VENDORID, int)
 154 ISA_ACCESSOR(serial, SERIAL, int)
 155 ISA_ACCESSOR(logicalid, LOGICALID, int)
 156 ISA_ACCESSOR(compatid, COMPATID, int)
 157 ISA_ACCESSOR(configattr, CONFIGATTR, int)
 158 ISA_ACCESSOR(pnp_csn, PNP_CSN, int)
 159 ISA_ACCESSOR(pnp_ldn, PNP_LDN, int)
 160 ISA_ACCESSOR(pnpbios_handle, PNPBIOS_HANDLE, int)
 161
 162 /* Device class for ISA bridges. */
 163 extern devclass_t isab_devclass;
 164
 165 extern intrmask_t isa_irq_pending(void);
 166 extern void     isa_probe_children(device_t dev);
 167
 168 void    isa_dmacascade(int chan);
 169 void    isa_dmadone(int flags, caddr_t addr, int nbytes, int chan);
 170 int     isa_dma_init(int chan, u_int bouncebufsize, int flag);
 171 void    isa_dmastart(int flags, caddr_t addr, u_int nbytes, int chan);
 172 int     isa_dma_acquire(int chan);
 173 void    isa_dma_release(int chan);
 174 int     isa_dmastatus(int chan);
 175 int     isa_dmastop(int chan);
 176 int     isa_dmatc(int chan);
 177
 178 #define isa_dmainit(chan, size) do { \
 179         if (isa_dma_init(chan, size, M_NOWAIT)) \
 180                 printf("WARNING: isa_dma_init(%d, %ju) failed\n", \
 181                     (int)(chan), (uintmax_t)(size)); \
 182         } while (0)
 183
 184 void    isa_hinted_child(device_t parent, const char *name, int unit);
 185 void    isa_hint_device_unit(device_t bus, device_t child, const char *name,
 186             int *unitp);
 187 int     isab_attach(device_t dev);
 188
 189 #ifdef PC98
 190 #include <machine/bus.h>
 191
 192 /*
 193  * Allocate discontinuous resources for ISA bus.
 194  */
 195 struct resource *
 196 isa_alloc_resourcev(device_t child, int type, int *rid,
 197                     bus_addr_t *res, bus_size_t count, u_int flags);
 198 int
 199 isa_load_resourcev(struct resource *re, bus_addr_t *res, bus_size_t count);
 200 #endif
 201
 202 #endif /* _KERNEL */
 203
 204 #endif /* !_ISA_ISAVAR_H_ */