sys/dev/pdq/pdq_freebsd.h

   1 /*      $NetBSD: pdqvar.h,v 1.27 2000/05/03 19:17:54 thorpej Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1995, 1996 Matt Thomas <matt@3am-software.com>
   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. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * Id: pdqvar.h,v 1.21 1997/03/21 21:16:04 thomas Exp
  27  * $FreeBSD$
  28  *
  29  */
  30
  31 /*
  32  * DEC PDQ FDDI Controller; PDQ O/S dependent definitions
  33  *
  34  * Written by Matt Thomas
  35  *
  36  */
  37
  38 #if defined(PDQ_HWSUPPORT)
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/kernel.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/malloc.h>
  45 #include <sys/socket.h>
  46 #include <sys/sockio.h>
  47
  48 #include <sys/module.h>
  49 #include <sys/bus.h>
  50
  51 #include <machine/bus_memio.h>
  52 #include <machine/bus_pio.h>
  53 #include <machine/bus.h>
  54 #include <machine/resource.h>
  55 #include <sys/rman.h>
  56
  57 #include <net/if.h>
  58 #include <net/if_arp.h>
  59 #include <net/if_dl.h>
  60 #include <net/if_media.h>
  61 #include <net/fddi.h>
  62
  63 #include <net/bpf.h>
  64
  65 #include <vm/vm.h>              /* for vtophys */
  66 #include <vm/pmap.h>            /* for vtophys */
  67 #include <machine/clock.h>      /* for DELAY */
  68
  69 #endif  /* PDQ_HWSUPPORT */
  70
  71 typedef struct _pdq_t pdq_t;
  72 typedef struct _pdq_csrs_t pdq_csrs_t;
  73 typedef struct _pdq_pci_csrs_t pdq_pci_csrs_t;
  74 typedef struct _pdq_lanaddr_t pdq_lanaddr_t;
  75 typedef unsigned int pdq_uint32_t;
  76 typedef unsigned short pdq_uint16_t;
  77 typedef unsigned char pdq_uint8_t;
  78 typedef enum _pdq_boolean_t pdq_boolean_t;
  79 typedef enum _pdq_type_t pdq_type_t;
  80 typedef enum _pdq_state_t pdq_state_t;
  81 typedef struct mbuf PDQ_OS_DATABUF_T;
  82
  83 typedef bus_space_tag_t pdq_bus_t;
  84 typedef bus_space_handle_t pdq_bus_memaddr_t;
  85 typedef pdq_bus_memaddr_t pdq_bus_memoffset_t;
  86
  87 extern devclass_t pdq_devclass;
  88
  89 enum _pdq_type_t {
  90     PDQ_DEFPA,          /* PCI-bus */
  91     PDQ_DEFEA,          /* EISA-bus */
  92     PDQ_DEFTA,          /* TurboChannel */
  93     PDQ_DEFAA,          /* FutureBus+ */
  94     PDQ_DEFQA           /* Q-bus */
  95 };
  96
  97 #define sc_ifmedia      ifmedia
  98 #define sc_if           arpcom.ac_if
  99 #define sc_bpf          sc_if.if_bpf
 100 #define IFQ_DEQUEUE     IF_DEQUEUE
 101 #define IFQ_IS_EMPTY(q) ((q)->ifq_len == 0)
 102
 103 typedef struct _pdq_os_ctx_t {
 104         struct arpcom           arpcom;
 105         struct ifmedia          ifmedia;
 106         device_t                dev;
 107         int                     debug;
 108
 109         pdq_t *                 sc_pdq;
 110         int                     sc_flags;
 111 #define PDQIF_DOWNCALL          0x0001  /* active calling from if to pdq */
 112
 113         struct resource *       io;
 114         int                     io_rid;
 115         int                     io_type;
 116         bus_space_handle_t      io_bsh;
 117         bus_space_tag_t         io_bst;
 118
 119         struct resource *       mem;
 120         int                     mem_rid;
 121         int                     mem_type;
 122         bus_space_handle_t      mem_bsh;
 123         bus_space_tag_t         mem_bst;
 124
 125         struct resource *       irq;
 126         int                     irq_rid;
 127         void *                  irq_ih;
 128
 129         struct mtx              mtx;
 130 } pdq_softc_t;
 131
 132 #define PDQ_LOCK(_sc)           mtx_lock(&(_sc)->mtx)
 133 #define PDQ_UNLOCK(_sc)         mtx_unlock(&(_sc)->mtx)
 134
 135 #define PDQ_OS_HDR_OFFSET       PDQ_RX_FC_OFFSET
 136
 137 #define PDQ_OS_PAGESIZE         PAGE_SIZE
 138 #define PDQ_OS_TX_TRANSMIT      5
 139
 140 #define PDQ_OS_IORD_32(bt, bh, off)             bus_space_read_4(bt, bh, off)
 141 #define PDQ_OS_IOWR_32(bt, bh, off, data)       bus_space_write_4(bt, bh, off, data)
 142 #define PDQ_OS_IORD_8(bt, bh, off)              bus_space_read_1(bt, bh, off)
 143 #define PDQ_OS_IOWR_8(bt, bh, off, data)        bus_space_write_1(bt, bh, off, data)
 144
 145 #define PDQ_CSR_OFFSET(base, offset)            (0 + (offset)*sizeof(pdq_uint32_t))
 146 #define PDQ_CSR_WRITE(csr, name, data)          PDQ_OS_IOWR_32((csr)->csr_bus, (csr)->csr_base, (csr)->name, data)
 147 #define PDQ_CSR_READ(csr, name)                 PDQ_OS_IORD_32((csr)->csr_bus, (csr)->csr_base, (csr)->name)
 148
 149 #define PDQ_OS_DATABUF_FREE(pdq, b)             (m_freem(b))
 150
 151 #if defined(PDQ_OSSUPPORT)
 152 #define PDQ_OS_TX_TIMEOUT               5       /* seconds */
 153
 154 #define PDQ_OS_IFP_TO_SOFTC(ifp)        ((pdq_softc_t *) (ifp)->if_softc)
 155 #define PDQ_BPF_MTAP(sc, m)             bpf_mtap(&(sc)->arpcom.ac_if, m)
 156
 157 #endif  /* PDQ_OSSUPPORT */
 158
 159 #if defined(PDQ_HWSUPPORT)
 160
 161 #define PDQ_OS_PREFIX                   "%s%d: "
 162 #define PDQ_OS_PREFIX_ARGS              pdq->pdq_os_name, pdq->pdq_unit
 163
 164 #define PDQ_OS_PTR_FMT  "%p"
 165 #define PDQ_OS_CSR_FMT  "0x%x"
 166
 167 #define PDQ_OS_USEC_DELAY(n)            DELAY(n)
 168 #define PDQ_OS_VA_TO_BUSPA(pdq, p)      vtophys(p)
 169
 170 #define PDQ_OS_MEMALLOC(n)              malloc(n, M_DEVBUF, M_NOWAIT)
 171 #define PDQ_OS_MEMFREE(p, n)            free((void *) p, M_DEVBUF)
 172 #define PDQ_OS_MEMZERO(p, n)            bzero((caddr_t)(p), (n))
 173 #define PDQ_OS_MEMALLOC_CONTIG(n)       contigmalloc(n, M_DEVBUF, M_NOWAIT, 0x800000, ~0, PAGE_SIZE, 0)
 174 #define PDQ_OS_MEMFREE_CONTIG(p, n)     contigfree(p, n, M_DEVBUF)
 175
 176 #define PDQ_OS_DATABUF_SIZE                     (MCLBYTES)
 177 #define PDQ_OS_DATABUF_NEXT(b)                  ((b)->m_next)
 178 #define PDQ_OS_DATABUF_NEXT_SET(b, b1)          ((b)->m_next = (b1))
 179 #define PDQ_OS_DATABUF_NEXTPKT(b)               ((b)->m_nextpkt)
 180 #define PDQ_OS_DATABUF_NEXTPKT_SET(b, b1)       ((b)->m_nextpkt = (b1))
 181 #define PDQ_OS_DATABUF_LEN(b)                   ((b)->m_len)
 182 #define PDQ_OS_DATABUF_LEN_SET(b, n)            ((b)->m_len = (n))
 183 /* #define      PDQ_OS_DATABUF_LEN_ADJ(b, n)            ((b)->m_len += (n)) */
 184 #define PDQ_OS_DATABUF_PTR(b)                   (mtod((b), pdq_uint8_t *))
 185 #define PDQ_OS_DATABUF_ADJ(b, n)                ((b)->m_data += (n), (b)->m_len -= (n))
 186
 187 #define PDQ_OS_DATABUF_ALLOC(pdq, b) do { \
 188     PDQ_OS_DATABUF_T *x_m0; \
 189     MGETHDR(x_m0, M_DONTWAIT, MT_DATA); \
 190     if (x_m0 != NULL) { \
 191         MCLGET(x_m0, M_DONTWAIT);       \
 192         if ((x_m0->m_flags & M_EXT) == 0) { \
 193             m_free(x_m0); \
 194             (b) = NULL; \
 195         } else { \
 196             (b) = x_m0; \
 197             x_m0->m_len = PDQ_OS_DATABUF_SIZE; \
 198         } \
 199     } else { \
 200         (b) = NULL; \
 201     } \
 202 } while (0)
 203
 204 #define PDQ_OS_DATABUF_RESET(b) ((b)->m_data = (b)->m_ext.ext_buf, (b)->m_len = MCLBYTES)
 205
 206 #define PDQ_OS_DATABUF_ENQUEUE(q, b)    do { \
 207     PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \
 208     if ((q)->q_tail == NULL) \
 209         (q)->q_head = (b); \
 210     else \
 211         PDQ_OS_DATABUF_NEXTPKT_SET(((PDQ_OS_DATABUF_T *)(q)->q_tail), b); \
 212     (q)->q_tail = (b); \
 213 } while (0)
 214
 215 #define PDQ_OS_DATABUF_DEQUEUE(q, b)    do { \
 216     if (((b) = (PDQ_OS_DATABUF_T *) (q)->q_head) != NULL) { \
 217         if (((q)->q_head = PDQ_OS_DATABUF_NEXTPKT(b)) == NULL) \
 218             (q)->q_tail = NULL; \
 219         PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \
 220     } \
 221 } while (0)
 222
 223 #define PDQ_OS_DATABUF_BUSPA(pdq, b)    PDQ_OS_VA_TO_BUSPA(pdq, PDQ_OS_DATABUF_PTR(b))
 224
 225 #define PDQ_OS_CONSUMER_PRESYNC(pdq)            do { } while(0)
 226 #define PDQ_OS_CONSUMER_POSTSYNC(pdq)           do { } while(0)
 227 #define PDQ_OS_DESC_PRESYNC(pdq, d, s)          do { } while(0)
 228 #define PDQ_OS_DESC_POSTSYNC(pdq, d, s)         do { } while(0)
 229 #define PDQ_OS_CMDRQST_PRESYNC(pdq, s)          do { } while(0)
 230 #define PDQ_OS_CMDRQST_POSTSYNC(pdq, s)         do { } while(0)
 231 #define PDQ_OS_CMDRSP_PRESYNC(pdq, s)           do { } while(0)
 232 #define PDQ_OS_CMDRSP_POSTSYNC(pdq, s)          do { } while(0)
 233 #define PDQ_OS_RXPDU_PRESYNC(pdq, b, o, l)      do { } while(0)
 234 #define PDQ_OS_RXPDU_POSTSYNC(pdq, b, o, l)     do { } while(0)
 235 #define PDQ_OS_UNSOL_EVENT_PRESYNC(pdq, e)      do { } while(0)
 236 #define PDQ_OS_UNSOL_EVENT_POSTSYNC(pdq, e)     do { } while(0)
 237
 238 #endif  /* PDQ_HWSUPPORT */
 239
 240 /*
 241  * OS dependent functions provided by pdq_ifsubr.c to pdq.c
 242  */
 243 void    pdq_os_addr_fill (pdq_t *pdq, pdq_lanaddr_t *addrs, size_t numaddrs);
 244 void    pdq_os_receive_pdu (pdq_t *, PDQ_OS_DATABUF_T *, size_t, int);
 245 void    pdq_os_restart_transmitter (pdq_t *pdq);
 246 void    pdq_os_transmit_done (pdq_t *, PDQ_OS_DATABUF_T *);
 247 void    pdq_os_update_status (pdq_t *, const void *);
 248
 249 /*
 250  * Driver interfaces functions provided by pdq.c to pdq_ifsubr.c
 251  */
 252 pdq_boolean_t   pdq_queue_transmit_data (pdq_t *pdq, PDQ_OS_DATABUF_T *pdu);
 253 void            pdq_run  (pdq_t *pdq);
 254 pdq_state_t     pdq_stop (pdq_t *pdq);
 255
 256 /*
 257  * OS dependent functions provided by
 258  * pdq_ifsubr.c or pdq.c to the bus front ends
 259  */
 260 void            pdq_ifattach (pdq_softc_t *);
 261 void            pdq_ifdetach (pdq_softc_t *);
 262 void            pdq_free (device_t);
 263 int             pdq_interrupt (pdq_t *pdq);
 264 void            pdq_hwreset (pdq_t *pdq);
 265 pdq_t *         pdq_initialize (pdq_bus_t bus, pdq_bus_memaddr_t csr_va,
 266                                 const char *name, int unit,
 267                                 void *ctx, pdq_type_t type);
 268 /*
 269  * Misc prototypes.
 270  */
 271 void            pdq_flush_transmitter(pdq_t *pdq);