193383Smdodd/* $NetBSD: pdqvar.h,v 1.27 2000/05/03 19:17:54 thorpej Exp $ */ 293383Smdodd 393383Smdodd/*- 493383Smdodd * Copyright (c) 1995, 1996 Matt Thomas <matt@3am-software.com> 593383Smdodd * All rights reserved. 693383Smdodd * 793383Smdodd * Redistribution and use in source and binary forms, with or without 893383Smdodd * modification, are permitted provided that the following conditions 993383Smdodd * are met: 1093383Smdodd * 1. Redistributions of source code must retain the above copyright 1193383Smdodd * notice, this list of conditions and the following disclaimer. 1293383Smdodd * 2. The name of the author may not be used to endorse or promote products 1397748Sschweikh * derived from this software without specific prior written permission 1493383Smdodd * 1593383Smdodd * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 1693383Smdodd * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1793383Smdodd * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 1893383Smdodd * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 1993383Smdodd * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2093383Smdodd * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2193383Smdodd * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2293383Smdodd * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2393383Smdodd * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2493383Smdodd * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2593383Smdodd * 2693383Smdodd * Id: pdqvar.h,v 1.21 1997/03/21 21:16:04 thomas Exp 2793383Smdodd * $FreeBSD$ 2893383Smdodd * 2993383Smdodd */ 3093383Smdodd 3193383Smdodd/* 3293383Smdodd * DEC PDQ FDDI Controller; PDQ O/S dependent definitions 3393383Smdodd * 3493383Smdodd * Written by Matt Thomas 3593383Smdodd * 3693383Smdodd */ 3793383Smdodd 3893383Smdodd#if defined(PDQ_HWSUPPORT) 3993383Smdodd#include <sys/param.h> 4093383Smdodd#include <sys/systm.h> 4193383Smdodd#include <sys/kernel.h> 4293383Smdodd#include <sys/lock.h> 4393383Smdodd#include <sys/mutex.h> 4493383Smdodd#include <sys/malloc.h> 4593383Smdodd#include <sys/socket.h> 4693383Smdodd#include <sys/sockio.h> 4793383Smdodd 4893383Smdodd#include <sys/module.h> 4993383Smdodd#include <sys/bus.h> 5093383Smdodd 5193383Smdodd#include <machine/bus.h> 5293383Smdodd#include <machine/resource.h> 5393383Smdodd#include <sys/rman.h> 5493383Smdodd 5593383Smdodd#include <net/if.h> 5693383Smdodd#include <net/if_arp.h> 5793383Smdodd#include <net/if_dl.h> 5893383Smdodd#include <net/if_media.h> 5993383Smdodd#include <net/fddi.h> 6093383Smdodd 6193383Smdodd#include <net/bpf.h> 6293383Smdodd 6393383Smdodd#include <vm/vm.h> /* for vtophys */ 6493383Smdodd#include <vm/pmap.h> /* for vtophys */ 6593383Smdodd 6693383Smdodd#endif /* PDQ_HWSUPPORT */ 6793383Smdodd 6893383Smdoddtypedef struct _pdq_t pdq_t; 6993383Smdoddtypedef struct _pdq_csrs_t pdq_csrs_t; 7093383Smdoddtypedef struct _pdq_pci_csrs_t pdq_pci_csrs_t; 7193383Smdoddtypedef struct _pdq_lanaddr_t pdq_lanaddr_t; 7293383Smdoddtypedef unsigned int pdq_uint32_t; 7393383Smdoddtypedef unsigned short pdq_uint16_t; 7493383Smdoddtypedef unsigned char pdq_uint8_t; 7593383Smdoddtypedef enum _pdq_boolean_t pdq_boolean_t; 7693383Smdoddtypedef enum _pdq_type_t pdq_type_t; 7793383Smdoddtypedef enum _pdq_state_t pdq_state_t; 7893383Smdoddtypedef struct mbuf PDQ_OS_DATABUF_T; 7993383Smdodd 8093383Smdoddtypedef bus_space_tag_t pdq_bus_t; 8193383Smdoddtypedef bus_space_handle_t pdq_bus_memaddr_t; 8293383Smdoddtypedef pdq_bus_memaddr_t pdq_bus_memoffset_t; 8393383Smdodd 8493383Smdoddextern devclass_t pdq_devclass; 8593383Smdodd 8693383Smdoddenum _pdq_type_t { 8793383Smdodd PDQ_DEFPA, /* PCI-bus */ 8893383Smdodd PDQ_DEFEA, /* EISA-bus */ 8993383Smdodd PDQ_DEFTA, /* TurboChannel */ 9093383Smdodd PDQ_DEFAA, /* FutureBus+ */ 9193383Smdodd PDQ_DEFQA /* Q-bus */ 9293383Smdodd}; 9393383Smdodd 9493383Smdodd#define sc_ifmedia ifmedia 95130416Smlaier#if 0 /* ALTQ */ 9693383Smdodd#define IFQ_DEQUEUE IF_DEQUEUE 9793383Smdodd#define IFQ_IS_EMPTY(q) ((q)->ifq_len == 0) 98130416Smlaier#endif 9993383Smdodd 10093383Smdoddtypedef struct _pdq_os_ctx_t { 101147256Sbrooks struct ifnet *ifp; 10293383Smdodd struct ifmedia ifmedia; 10393383Smdodd device_t dev; 10493383Smdodd int debug; 10593383Smdodd 10693383Smdodd pdq_t * sc_pdq; 10793383Smdodd int sc_flags; 10893383Smdodd#define PDQIF_DOWNCALL 0x0001 /* active calling from if to pdq */ 10993383Smdodd 11093383Smdodd struct resource * io; 11193383Smdodd int io_rid; 11293383Smdodd int io_type; 11393383Smdodd bus_space_handle_t io_bsh; 11493383Smdodd bus_space_tag_t io_bst; 11593383Smdodd 11693383Smdodd struct resource * mem; 11793383Smdodd int mem_rid; 11893383Smdodd int mem_type; 11993383Smdodd bus_space_handle_t mem_bsh; 12093383Smdodd bus_space_tag_t mem_bst; 12193383Smdodd 12293383Smdodd struct resource * irq; 12393383Smdodd int irq_rid; 12493383Smdodd void * irq_ih; 12593383Smdodd 12693383Smdodd struct mtx mtx; 127199542Sjhb struct callout watchdog; 128199542Sjhb int timer; 12993383Smdodd} pdq_softc_t; 13093383Smdodd 13193383Smdodd#define PDQ_LOCK(_sc) mtx_lock(&(_sc)->mtx) 13293383Smdodd#define PDQ_UNLOCK(_sc) mtx_unlock(&(_sc)->mtx) 133199542Sjhb#define PDQ_LOCK_ASSERT(_sc) mtx_assert(&(_sc)->mtx, MA_OWNED) 13493383Smdodd 13593383Smdodd#define PDQ_OS_HDR_OFFSET PDQ_RX_FC_OFFSET 13693383Smdodd 13793383Smdodd#define PDQ_OS_PAGESIZE PAGE_SIZE 13893383Smdodd#define PDQ_OS_TX_TRANSMIT 5 13993383Smdodd 14093383Smdodd#define PDQ_OS_IORD_32(bt, bh, off) bus_space_read_4(bt, bh, off) 14193383Smdodd#define PDQ_OS_IOWR_32(bt, bh, off, data) bus_space_write_4(bt, bh, off, data) 14293383Smdodd#define PDQ_OS_IORD_8(bt, bh, off) bus_space_read_1(bt, bh, off) 14393383Smdodd#define PDQ_OS_IOWR_8(bt, bh, off, data) bus_space_write_1(bt, bh, off, data) 14493383Smdodd 14593383Smdodd#define PDQ_CSR_OFFSET(base, offset) (0 + (offset)*sizeof(pdq_uint32_t)) 14693383Smdodd#define PDQ_CSR_WRITE(csr, name, data) PDQ_OS_IOWR_32((csr)->csr_bus, (csr)->csr_base, (csr)->name, data) 14793383Smdodd#define PDQ_CSR_READ(csr, name) PDQ_OS_IORD_32((csr)->csr_bus, (csr)->csr_base, (csr)->name) 14893383Smdodd 14993383Smdodd#define PDQ_OS_DATABUF_FREE(pdq, b) (m_freem(b)) 15093383Smdodd 15193383Smdodd#if defined(PDQ_OSSUPPORT) 15293383Smdodd#define PDQ_OS_TX_TIMEOUT 5 /* seconds */ 15393383Smdodd 15493383Smdodd#define PDQ_OS_IFP_TO_SOFTC(ifp) ((pdq_softc_t *) (ifp)->if_softc) 155147256Sbrooks#define PDQ_BPF_MTAP(sc, m) BPF_MTAP((sc)->ifp, m) 156147256Sbrooks#define PDQ_IFNET(sc) ((sc)->ifp) 15793383Smdodd 15893383Smdodd#endif /* PDQ_OSSUPPORT */ 15993383Smdodd 16093383Smdodd#if defined(PDQ_HWSUPPORT) 16193383Smdodd 162121816Sbrooks#define PDQ_OS_PREFIX "%s: " 163121816Sbrooks#define PDQ_OS_PREFIX_ARGS pdq->pdq_os_name 16493383Smdodd 16593383Smdodd#define PDQ_OS_PTR_FMT "%p" 16693383Smdodd#define PDQ_OS_CSR_FMT "0x%x" 16793383Smdodd 16893383Smdodd#define PDQ_OS_USEC_DELAY(n) DELAY(n) 16993383Smdodd#define PDQ_OS_VA_TO_BUSPA(pdq, p) vtophys(p) 17093383Smdodd 17193383Smdodd#define PDQ_OS_MEMALLOC(n) malloc(n, M_DEVBUF, M_NOWAIT) 17293383Smdodd#define PDQ_OS_MEMFREE(p, n) free((void *) p, M_DEVBUF) 17393383Smdodd#define PDQ_OS_MEMZERO(p, n) bzero((caddr_t)(p), (n)) 17493383Smdodd#define PDQ_OS_MEMALLOC_CONTIG(n) contigmalloc(n, M_DEVBUF, M_NOWAIT, 0x800000, ~0, PAGE_SIZE, 0) 17593383Smdodd#define PDQ_OS_MEMFREE_CONTIG(p, n) contigfree(p, n, M_DEVBUF) 17693383Smdodd 17793383Smdodd#define PDQ_OS_DATABUF_SIZE (MCLBYTES) 17893383Smdodd#define PDQ_OS_DATABUF_NEXT(b) ((b)->m_next) 17993383Smdodd#define PDQ_OS_DATABUF_NEXT_SET(b, b1) ((b)->m_next = (b1)) 18093383Smdodd#define PDQ_OS_DATABUF_NEXTPKT(b) ((b)->m_nextpkt) 18193383Smdodd#define PDQ_OS_DATABUF_NEXTPKT_SET(b, b1) ((b)->m_nextpkt = (b1)) 18293383Smdodd#define PDQ_OS_DATABUF_LEN(b) ((b)->m_len) 18393383Smdodd#define PDQ_OS_DATABUF_LEN_SET(b, n) ((b)->m_len = (n)) 18493383Smdodd/* #define PDQ_OS_DATABUF_LEN_ADJ(b, n) ((b)->m_len += (n)) */ 18593383Smdodd#define PDQ_OS_DATABUF_PTR(b) (mtod((b), pdq_uint8_t *)) 18693383Smdodd#define PDQ_OS_DATABUF_ADJ(b, n) ((b)->m_data += (n), (b)->m_len -= (n)) 18793383Smdodd 18893383Smdodd#define PDQ_OS_DATABUF_ALLOC(pdq, b) do { \ 18993383Smdodd PDQ_OS_DATABUF_T *x_m0; \ 190248078Smarius MGETHDR(x_m0, M_NOWAIT, MT_DATA); \ 19193383Smdodd if (x_m0 != NULL) { \ 192248078Smarius MCLGET(x_m0, M_NOWAIT); \ 19393383Smdodd if ((x_m0->m_flags & M_EXT) == 0) { \ 19493383Smdodd m_free(x_m0); \ 19593383Smdodd (b) = NULL; \ 19693383Smdodd } else { \ 19793383Smdodd (b) = x_m0; \ 19893383Smdodd x_m0->m_len = PDQ_OS_DATABUF_SIZE; \ 19993383Smdodd } \ 20093383Smdodd } else { \ 20193383Smdodd (b) = NULL; \ 20293383Smdodd } \ 20393383Smdodd} while (0) 20493383Smdodd 20593383Smdodd#define PDQ_OS_DATABUF_RESET(b) ((b)->m_data = (b)->m_ext.ext_buf, (b)->m_len = MCLBYTES) 20693383Smdodd 20793383Smdodd#define PDQ_OS_DATABUF_ENQUEUE(q, b) do { \ 20893383Smdodd PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \ 20993383Smdodd if ((q)->q_tail == NULL) \ 21093383Smdodd (q)->q_head = (b); \ 21193383Smdodd else \ 21293383Smdodd PDQ_OS_DATABUF_NEXTPKT_SET(((PDQ_OS_DATABUF_T *)(q)->q_tail), b); \ 21393383Smdodd (q)->q_tail = (b); \ 21493383Smdodd} while (0) 21593383Smdodd 21693383Smdodd#define PDQ_OS_DATABUF_DEQUEUE(q, b) do { \ 21793383Smdodd if (((b) = (PDQ_OS_DATABUF_T *) (q)->q_head) != NULL) { \ 21893383Smdodd if (((q)->q_head = PDQ_OS_DATABUF_NEXTPKT(b)) == NULL) \ 21993383Smdodd (q)->q_tail = NULL; \ 22093383Smdodd PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \ 22193383Smdodd } \ 22293383Smdodd} while (0) 22393383Smdodd 22493383Smdodd#define PDQ_OS_DATABUF_BUSPA(pdq, b) PDQ_OS_VA_TO_BUSPA(pdq, PDQ_OS_DATABUF_PTR(b)) 22593383Smdodd 22693383Smdodd#define PDQ_OS_CONSUMER_PRESYNC(pdq) do { } while(0) 22793383Smdodd#define PDQ_OS_CONSUMER_POSTSYNC(pdq) do { } while(0) 22893383Smdodd#define PDQ_OS_DESC_PRESYNC(pdq, d, s) do { } while(0) 22993383Smdodd#define PDQ_OS_DESC_POSTSYNC(pdq, d, s) do { } while(0) 23093383Smdodd#define PDQ_OS_CMDRQST_PRESYNC(pdq, s) do { } while(0) 23193383Smdodd#define PDQ_OS_CMDRQST_POSTSYNC(pdq, s) do { } while(0) 23293383Smdodd#define PDQ_OS_CMDRSP_PRESYNC(pdq, s) do { } while(0) 23393383Smdodd#define PDQ_OS_CMDRSP_POSTSYNC(pdq, s) do { } while(0) 23493383Smdodd#define PDQ_OS_RXPDU_PRESYNC(pdq, b, o, l) do { } while(0) 23593383Smdodd#define PDQ_OS_RXPDU_POSTSYNC(pdq, b, o, l) do { } while(0) 23693383Smdodd#define PDQ_OS_UNSOL_EVENT_PRESYNC(pdq, e) do { } while(0) 23793383Smdodd#define PDQ_OS_UNSOL_EVENT_POSTSYNC(pdq, e) do { } while(0) 23893383Smdodd 23993383Smdodd#endif /* PDQ_HWSUPPORT */ 24093383Smdodd 24193383Smdodd/* 24293383Smdodd * OS dependent functions provided by pdq_ifsubr.c to pdq.c 24393383Smdodd */ 24493383Smdoddvoid pdq_os_addr_fill (pdq_t *pdq, pdq_lanaddr_t *addrs, size_t numaddrs); 24593383Smdoddvoid pdq_os_receive_pdu (pdq_t *, PDQ_OS_DATABUF_T *, size_t, int); 24693383Smdoddvoid pdq_os_restart_transmitter (pdq_t *pdq); 24793383Smdoddvoid pdq_os_transmit_done (pdq_t *, PDQ_OS_DATABUF_T *); 24893383Smdoddvoid pdq_os_update_status (pdq_t *, const void *); 24993383Smdodd 25093383Smdodd/* 25193383Smdodd * Driver interfaces functions provided by pdq.c to pdq_ifsubr.c 25293383Smdodd */ 25393383Smdoddpdq_boolean_t pdq_queue_transmit_data (pdq_t *pdq, PDQ_OS_DATABUF_T *pdu); 25493383Smdoddvoid pdq_run (pdq_t *pdq); 25593383Smdoddpdq_state_t pdq_stop (pdq_t *pdq); 25693383Smdodd 25793383Smdodd/* 25893383Smdodd * OS dependent functions provided by 25993383Smdodd * pdq_ifsubr.c or pdq.c to the bus front ends 26093383Smdodd */ 261199542Sjhbint pdq_ifattach (pdq_softc_t *, const pdq_uint8_t *, 262199542Sjhb pdq_type_t type); 26393383Smdoddvoid pdq_ifdetach (pdq_softc_t *); 26493383Smdoddvoid pdq_free (device_t); 26593383Smdoddint pdq_interrupt (pdq_t *pdq); 26693383Smdoddvoid pdq_hwreset (pdq_t *pdq); 26793383Smdoddpdq_t * pdq_initialize (pdq_bus_t bus, pdq_bus_memaddr_t csr_va, 26893383Smdodd const char *name, int unit, 26993383Smdodd void *ctx, pdq_type_t type); 27093383Smdodd/* 27193383Smdodd * Misc prototypes. 27293383Smdodd */ 27393383Smdoddvoid pdq_flush_transmitter(pdq_t *pdq); 274