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