sys/dev/netif/pdq_layer/pdqvar.h

   1 /*-
   2  * Copyright (c) 1995, 1996 Matt Thomas <matt@3am-software.com>
   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. The name of the author may not be used to endorse or promote products
  11  *    derived from this software withough specific prior written permission
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  *
  24  * $FreeBSD: src/sys/dev/pdq/pdqvar.h,v 1.3.2.1 2002/05/14 21:02:11 gallatin Exp $
  25  * $DragonFly: src/sys/dev/netif/pdq_layer/Attic/pdqvar.h,v 1.2 2003/06/17 04:28:29 dillon Exp $
  26  *
  27  */
  28
  29 /*
  30  * DEC PDQ FDDI Controller; PDQ O/S dependent definitions
  31  *
  32  * Written by Matt Thomas
  33  *
  34  */
  35
  36 #ifndef _PDQ_OS_H
  37 #define _PDQ_OS_H
  38
  39 #define PDQ_OS_TX_TIMEOUT               5       /* seconds */
  40
  41 typedef struct _pdq_t pdq_t;
  42 typedef struct _pdq_csrs_t pdq_csrs_t;
  43 typedef struct _pdq_pci_csrs_t pdq_pci_csrs_t;
  44 typedef struct _pdq_lanaddr_t pdq_lanaddr_t;
  45 typedef unsigned int pdq_uint32_t;
  46 typedef unsigned short pdq_uint16_t;
  47 typedef unsigned char pdq_uint8_t;
  48 typedef enum _pdq_boolean_t pdq_boolean_t;
  49 typedef enum _pdq_type_t pdq_type_t;
  50 typedef enum _pdq_state_t pdq_state_t;
  51
  52 enum _pdq_type_t {
  53     PDQ_DEFPA,          /* PCI-bus */
  54     PDQ_DEFEA,          /* EISA-bus */
  55     PDQ_DEFTA,          /* TurboChannel */
  56     PDQ_DEFAA,          /* FutureBus+ */
  57     PDQ_DEFQA           /* Q-bus */
  58 };
  59
  60 #if defined(PDQTEST)
  61 #include <pdq_os_test.h>
  62 #elif defined(__FreeBSD__) || defined(__bsdi__) || defined(__NetBSD__)
  63
  64 #include <sys/param.h>
  65 #include <sys/systm.h>
  66 #ifndef M_MCAST
  67 #include <sys/mbuf.h>
  68 #endif /* M_CAST */
  69 #include <sys/malloc.h>
  70 #include <vm/vm.h>
  71 #include <vm/vm_kern.h>
  72
  73 #define PDQ_USE_MBUFS
  74 #if defined(__NetBSD__)
  75 #define PDQ_OS_PREFIX                   "%s: "
  76 #define PDQ_OS_PREFIX_ARGS              pdq->pdq_os_name
  77 #else
  78 #define PDQ_OS_PREFIX                   "%s%d: "
  79 #define PDQ_OS_PREFIX_ARGS              pdq->pdq_os_name, pdq->pdq_unit
  80 #endif
  81 #if defined(__FreeBSD__) && BSD >= 199506
  82 #define PDQ_OS_PAGESIZE                 PAGE_SIZE
  83 #else
  84 #define PDQ_OS_PAGESIZE                 NBPG
  85 #endif
  86 #define PDQ_OS_USEC_DELAY(n)            DELAY(n)
  87 #define PDQ_OS_MEMZERO(p, n)            bzero((caddr_t)(p), (n))
  88 #if defined(__NetBSD__) && defined(__alpha__)
  89 #define PDQ_OS_VA_TO_PA(pdq, p)         (vtophys((vm_offset_t)p) | (pdq->pdq_type == PDQ_DEFTA ? 0 : 0x40000000))
  90 #elif defined(__FreeBSD__) && defined(__alpha__)
  91 #define PDQ_OS_VA_TO_PA(pdq, p)         (vtophys((vm_offset_t)p) | (pdq->pdq_type == PDQ_DEFTA ? 0 : alpha_XXX_dmamap_or))
  92 #else
  93 #define PDQ_OS_VA_TO_PA(pdq, p)         vtophys(p)
  94 #endif
  95 #define PDQ_OS_MEMALLOC(n)              malloc(n, M_DEVBUF, M_NOWAIT)
  96 #define PDQ_OS_MEMFREE(p, n)            free((void *) p, M_DEVBUF)
  97 #ifdef __FreeBSD__
  98 #define PDQ_OS_MEMALLOC_CONTIG(n)       vm_page_alloc_contig(n, 0, 0xffffffff, PAGE_SIZE)
  99 #define PDQ_OS_MEMFREE_CONTIG(p, n)     kmem_free(kernel_map, (vm_offset_t) p, n)
 100 #else
 101 #define PDQ_OS_MEMALLOC_CONTIG(n)       kmem_alloc(kernel_map, round_page(n))
 102 #define PDQ_OS_MEMFREE_CONTIG(p, n)     kmem_free(kernel_map, (vm_offset_t) p, n)
 103 #endif /* __FreeBSD__ */
 104
 105 #if defined(__FreeBSD__)
 106 #include <vm/pmap.h>
 107 #include <vm/vm_extern.h>
 108 #include <machine/bus.h>
 109 #include <machine/cpufunc.h>
 110 #include <machine/clock.h>
 111 typedef void ifnet_ret_t;
 112 typedef u_long ioctl_cmd_t;
 113 typedef enum { PDQ_BUS_EISA, PDQ_BUS_PCI } pdq_bus_t;
 114 typedef u_int16_t pdq_bus_ioport_t;
 115 typedef volatile pdq_uint32_t *pdq_bus_memaddr_t;
 116 typedef pdq_bus_memaddr_t pdq_bus_memoffset_t;
 117 #if BSD >= 199506       /* __FreeBSD__ */
 118 #define PDQ_BPF_MTAP(sc, m)     bpf_mtap(&(sc)->sc_if, m)
 119 #define PDQ_BPFATTACH(sc, t, s) bpfattach(&(sc)->sc_if, t, s)
 120 #endif
 121
 122
 123 #elif defined(__bsdi__)
 124 #include <machine/inline.h>
 125 typedef int ifnet_ret_t;
 126 typedef int ioctl_cmd_t;
 127 typedef enum { PDQ_BUS_EISA, PDQ_BUS_PCI } pdq_bus_t;
 128 typedef u_int16_t pdq_bus_ioport_t;
 129 typedef volatile pdq_uint32_t *pdq_bus_memaddr_t;
 130 typedef pdq_bus_memaddr_t pdq_bus_memoffset_t;
 131
 132
 133 #elif defined(__NetBSD__)
 134 #include <machine/bus.h>
 135 #include <machine/intr.h>
 136 #define PDQ_OS_PTR_FMT          "%p"
 137 typedef void ifnet_ret_t;
 138 typedef u_long ioctl_cmd_t;
 139 typedef bus_chipset_tag_t pdq_bus_t;
 140 typedef bus_io_handle_t pdq_bus_ioport_t;
 141 #if defined(PDQ_IOMAPPED)
 142 typedef bus_io_handle_t pdq_bus_memaddr_t;
 143 #else
 144 typedef bus_mem_handle_t pdq_bus_memaddr_t;
 145 #endif
 146 typedef pdq_uint32_t pdq_bus_memoffset_t;
 147 #define PDQ_OS_IOMEM
 148 #define PDQ_OS_IORD_32(t, base, offset)         bus_io_read_4  (t, base, offset)
 149 #define PDQ_OS_IOWR_32(t, base, offset, data)   bus_io_write_4 (t, base, offset, data)
 150 #define PDQ_OS_IORD_8(t, base, offset)          bus_io_read_1  (t, base, offset)
 151 #define PDQ_OS_IOWR_8(t, base, offset, data)    bus_io_write_1 (t, base, offset, data)
 152 #define PDQ_OS_MEMRD_32(t, base, offset)        bus_mem_read_4(t, base, offset)
 153 #define PDQ_OS_MEMWR_32(t, base, offset, data)  bus_mem_write_4(t, base, offset, data)
 154 #define PDQ_CSR_OFFSET(base, offset)            (0 + (offset)*sizeof(pdq_uint32_t))
 155
 156 #if defined(PDQ_IOMAPPED)
 157 #define PDQ_CSR_WRITE(csr, name, data)          PDQ_OS_IOWR_32((csr)->csr_bus, (csr)->csr_base, (csr)->name, data)
 158 #define PDQ_CSR_READ(csr, name)                 PDQ_OS_IORD_32((csr)->csr_bus, (csr)->csr_base, (csr)->name)
 159 #else
 160 #define PDQ_CSR_WRITE(csr, name, data)          PDQ_OS_MEMWR_32((csr)->csr_bus, (csr)->csr_base, (csr)->name, data)
 161 #define PDQ_CSR_READ(csr, name)                 PDQ_OS_MEMRD_32((csr)->csr_bus, (csr)->csr_base, (csr)->name)
 162 #endif
 163
 164 #endif
 165
 166 #if !defined(PDQ_BPF_MTAP)
 167 #define PDQ_BPF_MTAP(sc, m)     bpf_mtap((sc)->sc_bpf, m)
 168 #endif
 169
 170 #if !defined(PDQ_BPFATTACH)
 171 #define PDQ_BPFATTACH(sc, t, s) bpfattach(&(sc)->sc_bpf, &(sc)->sc_if, t, s)
 172 #endif
 173
 174 #if !defined(PDQ_OS_PTR_FMT)
 175 #define PDQ_OS_PTR_FMT  "0x%x"
 176 #endif
 177
 178 #if !defined(PDQ_OS_IOMEM)
 179 #define PDQ_OS_IORD_32(t, base, offset)         inl((base) + (offset))
 180 #define PDQ_OS_IOWR_32(t, base, offset, data)   outl((base) + (offset), data)
 181 #define PDQ_OS_IORD_8(t, base, offset)          inb((base) + (offset))
 182 #define PDQ_OS_IOWR_8(t, base, offset, data)    outb((base) + (offset), data)
 183 #define PDQ_OS_MEMRD_32(t, base, offset)        readl((base) + (offset))
 184 #define PDQ_OS_MEMWR_32(t, base, offset, data)  writel((base) + (offset), data)
 185 #endif
 186 #ifndef PDQ_CSR_OFFSET
 187 #define PDQ_CSR_OFFSET(base, offset)            (0 + (base) + (offset))
 188 #endif
 189
 190 #ifndef PDQ_CSR_WRITE
 191 #define PDQ_CSR_WRITE(csr, name, data)          PDQ_OS_MEMWR_32((csr)->csr_bus, (csr)->name, 0, data)
 192 #define PDQ_CSR_READ(csr, name)                 PDQ_OS_MEMRD_32((csr)->csr_bus, (csr)->name, 0)
 193 #endif
 194
 195 #if !defined(PDQ_HWSUPPORT)
 196
 197 typedef struct {
 198 #if defined(__bsdi__)
 199     struct device sc_dev;               /* base device */
 200     struct isadev sc_id;                /* ISA device */
 201     struct intrhand sc_ih;              /* interrupt vectoring */
 202     struct atshutdown sc_ats;           /* shutdown routine */
 203 #elif defined(__NetBSD__)
 204     struct device sc_dev;               /* base device */
 205     void *sc_ih;                        /* interrupt vectoring */
 206     void *sc_ats;                       /* shutdown hook */
 207 #elif defined(__FreeBSD__)
 208     struct kern_devconf *sc_kdc;        /* freebsd cruft */
 209 #endif
 210     struct arpcom sc_ac;
 211 #define sc_if           sc_ac.ac_if
 212     pdq_t *sc_pdq;
 213 #if defined(__alpha__) || defined(__i386__)
 214     pdq_bus_ioport_t sc_iobase;
 215 #endif
 216 #ifdef PDQ_IOMAPPED
 217 #define sc_membase      sc_iobase
 218 #else
 219     pdq_bus_memaddr_t sc_membase;
 220 #endif
 221     pdq_bus_t sc_bc;
 222 #if !defined(__bsdi__) || _BSDI_VERSION >= 199401
 223 #define sc_bpf          sc_if.if_bpf
 224 #else
 225     caddr_t sc_bpf;
 226 #endif
 227 } pdq_softc_t;
 228
 229
 230 extern void pdq_ifreset(pdq_softc_t *sc);
 231 extern void pdq_ifinit(pdq_softc_t *sc);
 232 extern void pdq_ifwatchdog(struct ifnet *ifp);
 233 extern ifnet_ret_t pdq_ifstart(struct ifnet *ifp);
 234 extern int pdq_ifioctl(struct ifnet *ifp, ioctl_cmd_t cmd, caddr_t data);
 235 extern void pdq_ifattach(pdq_softc_t *sc, ifnet_ret_t (*ifwatchdog)(int unit));
 236 #endif /* !PDQ_HWSUPPORT */
 237
 238
 239 #elif defined(DLPI_PDQ)
 240 #include <sys/param.h>
 241 #include <sys/kmem.h>
 242 #include <sys/ddi.h>
 243 #include <sys/stream.h>
 244
 245 #define PDQ_USE_STREAMS
 246 #define PDQ_OS_PREFIX                   "%s board %d "
 247 #define PDQ_OS_PREFIX_ARGS              pdq->pdq_os_name, pdq->pdq_unit
 248
 249 #define PDQ_OS_PAGESIZE                 PAGESIZE
 250 #define PDQ_OS_USEC_DELAY(n)            drv_usecwait(n)
 251 #define PDQ_OS_MEMZERO(p, n)            bzero((caddr_t)(p), (n))
 252 #define PDQ_OS_VA_TO_PA(pdq, p)         vtop((caddr_t)p, NULL)
 253 #define PDQ_OS_MEMALLOC(n)              kmem_zalloc(n, KM_NOSLEEP)
 254 #define PDQ_OS_MEMFREE(p, n)            kmem_free((caddr_t) p, n)
 255 #define PDQ_OS_MEMALLOC_CONTIG(n)       kmem_zalloc_physreq(n, decfddiphysreq_db, KM_NOSLEEP)
 256 #define PDQ_OS_MEMFREE_CONTIG(p, n)     PDQ_OS_MEMFREE(p, n)
 257
 258 extern physreq_t *decfddiphysreq_db;
 259 extern physreq_t *decfddiphysreq_mblk;
 260
 261 #define PDQ_OS_DATABUF_ALLOC(b)         ((void) (((b) = allocb_physreq(PDQ_OS_DATABUF_SIZE, BPRI_MED, decfddiphysreq_mblk)) && ((b)->b_wptr = (b)->b_rptr + PDQ_OS_DATABUF_SIZE)))
 262
 263 #define PDQ_OS_IORD_8(port)             inb(port)
 264 #define PDQ_OS_IOWR_8(port, data)       outb(port, data)
 265 #endif
 266
 267
 268 #ifdef PDQ_USE_MBUFS
 269 #define PDQ_OS_DATABUF_SIZE                     (MCLBYTES)
 270 #define PDQ_OS_DATABUF_FREE(b)                  (m_freem(b))
 271 #define PDQ_OS_DATABUF_NEXT(b)                  ((b)->m_next)
 272 #define PDQ_OS_DATABUF_NEXT_SET(b, b1)          ((b)->m_next = (b1))
 273 #define PDQ_OS_DATABUF_NEXTPKT(b)               ((b)->m_nextpkt)
 274 #define PDQ_OS_DATABUF_NEXTPKT_SET(b, b1)       ((b)->m_nextpkt = (b1))
 275 #define PDQ_OS_DATABUF_LEN(b)                   ((b)->m_len)
 276 #define PDQ_OS_DATABUF_LEN_SET(b, n)            ((b)->m_len = (n))
 277 /* #define      PDQ_OS_DATABUF_LEN_ADJ(b, n)            ((b)->m_len += (n)) */
 278 #define PDQ_OS_DATABUF_PTR(b)                   (mtod((b), pdq_uint8_t *))
 279 #define PDQ_OS_DATABUF_ADJ(b, n)                ((b)->m_data += (n), (b)->m_len -= (n))
 280 typedef struct mbuf PDQ_OS_DATABUF_T;
 281
 282 #define PDQ_OS_DATABUF_ALLOC(b) do { \
 283     PDQ_OS_DATABUF_T *x_m0; \
 284     MGETHDR(x_m0, M_DONTWAIT, MT_DATA); \
 285     if (x_m0 != NULL) { \
 286         MCLGET(x_m0, M_DONTWAIT);       \
 287         if ((x_m0->m_flags & M_EXT) == 0) { \
 288             m_free(x_m0); \
 289             (b) = NULL; \
 290         } else { \
 291             (b) = x_m0; \
 292             x_m0->m_len = PDQ_OS_DATABUF_SIZE; \
 293         } \
 294     } else { \
 295         (b) = NULL; \
 296     } \
 297 } while (0)
 298 #define PDQ_OS_DATABUF_RESET(b) ((b)->m_data = (b)->m_ext.ext_buf, (b)->m_len = MCLBYTES)
 299 #endif /* PDQ_USE_MBUFS */
 300
 301 #ifdef PDQ_USE_STREAMS
 302 #define PDQ_OS_DATABUF_SIZE                     (2048)
 303 #define PDQ_OS_DATABUF_FREE(b)                  (freemsg(b))
 304 #define PDQ_OS_DATABUF_NEXT(b)                  ((b)->b_cont)
 305 #define PDQ_OS_DATABUF_NEXT_SET(b, b1)          ((b)->b_cont = (b1))
 306 #define PDQ_OS_DATABUF_NEXTPKT(b)               ((b)->b_next)
 307 #define PDQ_OS_DATABUF_NEXTPKT_SET(b, b1)       ((b)->b_next = (b1))
 308 #define PDQ_OS_DATABUF_LEN(b)                   ((b)->b_wptr - (b)->b_rptr)
 309 #define PDQ_OS_DATABUF_LEN_SET(b, n)            ((b)->b_wptr = (b)->b_rptr + (n))
 310 /*#define       PDQ_OS_DATABUF_LEN_ADJ(b, n)            ((b)->b_wptr += (n))*/
 311 #define PDQ_OS_DATABUF_PTR(b)                   ((pdq_uint8_t *) (b)->b_rptr)
 312 #define PDQ_OS_DATABUF_ADJ(b, n)                ((b)->b_rptr += (n))
 313 typedef mblk_t PDQ_OS_DATABUF_T;
 314
 315 #ifndef PDQ_OS_DATABUF_ALLOC
 316 #define PDQ_OS_DATABUF_ALLOC(b)                 ((void) (((b) = allocb(PDQ_OS_DATABUF_SIZE, BPRI_MED)) && ((b)->b_wptr = (b)->b_rptr + PDQ_OS_DATABUF_SIZE)))
 317 #endif /* PDQ_OS_DATABUF_ALLOC */
 318 #endif /* PDQ_USE_STREAMS */
 319
 320 #define PDQ_OS_TX_TRANSMIT              5
 321
 322 #define PDQ_OS_DATABUF_ENQUEUE(q, b)    do { \
 323     PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \
 324     if ((q)->q_tail == NULL) \
 325         (q)->q_head = (b); \
 326     else \
 327         PDQ_OS_DATABUF_NEXTPKT_SET(((PDQ_OS_DATABUF_T *)(q)->q_tail), b); \
 328     (q)->q_tail = (b); \
 329 } while (0)
 330
 331 #define PDQ_OS_DATABUF_DEQUEUE(q, b)    do { \
 332     if (((b) = (PDQ_OS_DATABUF_T *) (q)->q_head) != NULL) { \
 333         if (((q)->q_head = PDQ_OS_DATABUF_NEXTPKT(b)) == NULL) \
 334             (q)->q_tail = NULL; \
 335         PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \
 336     } \
 337 } while (0)
 338
 339 extern void pdq_os_addr_fill(pdq_t *pdq, pdq_lanaddr_t *addrs, size_t numaddrs);
 340 extern void pdq_os_receive_pdu(pdq_t *, PDQ_OS_DATABUF_T *pdu, size_t pdulen);
 341 extern void pdq_os_restart_transmitter(pdq_t *pdq);
 342 extern void pdq_os_transmit_done(pdq_t *pdq, PDQ_OS_DATABUF_T *pdu);
 343
 344 extern pdq_boolean_t pdq_queue_transmit_data(pdq_t *pdq, PDQ_OS_DATABUF_T *pdu);
 345 extern void pdq_flush_transmitter(pdq_t *pdq);
 346
 347 extern void pdq_run(pdq_t *pdq);
 348 extern pdq_state_t pdq_stop(pdq_t *pdq);
 349 extern void pdq_hwreset(pdq_t *pdq);
 350
 351 extern int pdq_interrupt(pdq_t *pdq);
 352 extern pdq_t *pdq_initialize(pdq_bus_t bus, pdq_bus_memaddr_t csr_va,
 353                              const char *name, int unit,
 354                              void *ctx, pdq_type_t type);
 355 #endif /* _PDQ_OS_H */