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