1 /* $NetBSD: pdqvar.h,v 1.27 2000/05/03 19:17:54 thorpej Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
6 * Copyright (c) 1995, 1996 Matt Thomas <matt@3am-software.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Id: pdqvar.h,v 1.21 1997/03/21 21:16:04 thomas Exp
34 * DEC PDQ FDDI Controller; PDQ O/S dependent definitions
36 * Written by Matt Thomas
43 #define PDQ_OS_TX_TIMEOUT 5 /* seconds */
45 typedef struct _pdq_t pdq_t;
46 typedef struct _pdq_csrs_t pdq_csrs_t;
47 typedef struct _pdq_pci_csrs_t pdq_pci_csrs_t;
48 typedef struct _pdq_lanaddr_t pdq_lanaddr_t;
49 typedef unsigned int pdq_uint32_t;
50 typedef unsigned short pdq_uint16_t;
51 typedef unsigned char pdq_uint8_t;
52 typedef enum _pdq_boolean_t pdq_boolean_t;
53 typedef enum _pdq_type_t pdq_type_t;
54 typedef enum _pdq_state_t pdq_state_t;
57 PDQ_DEFPA, /* PCI-bus */
61 #include <pdq_os_test.h>
64 #include <sys/param.h>
65 #include <sys/systm.h>
69 #include <sys/malloc.h>
71 #include <vm/vm_kern.h>
73 #define PDQ_OS_PREFIX "%s: "
74 #define PDQ_OS_PREFIX_ARGS pdq->pdq_os_name
75 #define PDQ_OS_PAGESIZE PAGE_SIZE
76 #define PDQ_OS_USEC_DELAY(n) DELAY(n)
77 #define PDQ_OS_MEMZERO(p, n) bzero((caddr_t)(p), (n))
78 #if !defined(PDQ_BUS_DMA)
79 #define PDQ_OS_VA_TO_BUSPA(pdq, p) vtophys(p)
81 #define PDQ_OS_MEMALLOC(n) malloc(n, M_DEVBUF, M_NOWAIT)
82 #define PDQ_OS_MEMFREE(p, n) free((void *) p, M_DEVBUF)
83 #define PDQ_OS_MEMALLOC_CONTIG(n) contigmalloc(n, M_DEVBUF, M_NOWAIT, 0, 0xffffffff, PAGE_SIZE, 0)
84 #define PDQ_OS_MEMFREE_CONTIG(p, n) contigfree((void *) p, n, M_DEVBUF)
87 #include <vm/vm_extern.h>
88 #include <machine/cpufunc.h>
89 #define ifnet_ret_t void
90 typedef int ioctl_cmd_t;
91 typedef enum { PDQ_BUS_EISA, PDQ_BUS_PCI } pdq_bus_t;
92 typedef u_int16_t pdq_bus_ioport_t;
93 typedef volatile pdq_uint32_t *pdq_bus_memaddr_t;
94 typedef pdq_bus_memaddr_t pdq_bus_memoffset_t;
95 #define pdq_os_update_status(a, b) ((void) 0)
98 #if !defined(PDQ_OS_SPL_RAISE)
99 #define PDQ_OS_SPL_RAISE() splimp()
102 #if !defined(PDQ_OS_SPL_LOWER)
103 #define PDQ_OS_SPL_LOWER(s) splx(s)
106 #if !defined(PDQ_FDDICOM)
107 #define PDQ_FDDICOM(sc) (&(sc)->sc_ac)
110 #if !defined(PDQ_IFNET)
111 #define PDQ_IFNET(sc) (PDQ_FDDICOM((sc))->ac_ifp)
114 #define PDQ_BPF_MTAP(sc, m) bpf_mtap(PDQ_IFNET(sc), m)
115 #define PDQ_BPFATTACH(sc, t, s) bpfattach(PDQ_IFNET(sc), t, s)
117 #if !defined(PDQ_ARP_IFINIT)
118 #define PDQ_ARP_IFINIT(sc, ifa) arp_ifinit(&(sc)->sc_ac, (ifa))
121 #if !defined(PDQ_OS_PTR_FMT)
122 #define PDQ_OS_PTR_FMT "0x%x"
125 #if !defined(PDQ_OS_CSR_FMT)
126 #define PDQ_OS_CSR_FMT "0x%x"
129 #if !defined(PDQ_LANADDR)
130 #define PDQ_LANADDR(sc) ((sc)->sc_ac.ac_enaddr)
131 #define PDQ_LANADDR_SIZE(sc) (sizeof((sc)->sc_ac.ac_enaddr))
134 #if !defined(PDQ_OS_IOMEM)
135 #define PDQ_OS_IORD_32(t, base, offset) inl((base) + (offset))
136 #define PDQ_OS_IOWR_32(t, base, offset, data) outl((base) + (offset), data)
137 #define PDQ_OS_IORD_8(t, base, offset) inb((base) + (offset))
138 #define PDQ_OS_IOWR_8(t, base, offset, data) outb((base) + (offset), data)
139 #define PDQ_OS_MEMRD_32(t, base, offset) (0 + *((base) + (offset)))
140 #define PDQ_OS_MEMWR_32(t, base, offset, data) do *((base) + (offset)) = (data); while (0)
142 #ifndef PDQ_CSR_OFFSET
143 #define PDQ_CSR_OFFSET(base, offset) (0 + (base) + (offset))
146 #ifndef PDQ_CSR_WRITE
147 #define PDQ_CSR_WRITE(csr, name, data) PDQ_OS_MEMWR_32((csr)->csr_bus, (csr)->name, 0, data)
148 #define PDQ_CSR_READ(csr, name) PDQ_OS_MEMRD_32((csr)->csr_bus, (csr)->name, 0)
151 #ifndef PDQ_OS_IFP_TO_SOFTC
152 #define PDQ_OS_IFP_TO_SOFTC(ifp) ((pdq_softc_t *) ((caddr_t) ifp - offsetof(pdq_softc_t, sc_ac.ac_if)))
156 #if !defined(PDQ_HWSUPPORT)
158 typedef struct _pdq_os_ctx_t {
159 struct kern_devconf *sc_kdc; /* freebsd cruft */
161 #if defined(IFM_FDDI)
162 struct ifmedia sc_ifmedia;
165 #if defined(__i386__)
166 pdq_bus_ioport_t sc_iobase;
168 #if defined(PDQ_IOMAPPED)
169 #define sc_membase sc_iobase
171 pdq_bus_memaddr_t sc_membase;
176 #if defined(PDQ_BUS_DMA)
177 bus_dma_tag_t sc_dmatag;
178 bus_dmamap_t sc_dbmap; /* DMA map for descriptor block */
179 bus_dmamap_t sc_uimap; /* DMA map for unsolicited events */
180 bus_dmamap_t sc_cbmap; /* DMA map for consumer block */
185 extern void pdq_ifreset(pdq_softc_t *sc);
186 extern void pdq_ifinit(pdq_softc_t *sc);
187 extern void pdq_ifwatchdog(struct ifnet *ifp);
188 extern ifnet_ret_t pdq_ifstart(struct ifnet *ifp);
189 extern int pdq_ifioctl(struct ifnet *ifp, ioctl_cmd_t cmd, caddr_t data);
190 extern void pdq_ifattach(pdq_softc_t *sc, ifnet_ret_t (*ifwatchdog)(int unit));
191 #endif /* !PDQ_HWSUPPORT */
197 #define PDQ_OS_DATABUF_SIZE (MCLBYTES)
198 #ifndef PDQ_OS_DATABUF_FREE
199 #define PDQ_OS_DATABUF_FREE(pdq, b) (m_freem(b))
201 #define PDQ_OS_DATABUF_NEXT(b) ((b)->m_next)
202 #define PDQ_OS_DATABUF_NEXT_SET(b, b1) ((b)->m_next = (b1))
203 #define PDQ_OS_DATABUF_NEXTPKT(b) ((b)->m_nextpkt)
204 #define PDQ_OS_DATABUF_NEXTPKT_SET(b, b1) ((b)->m_nextpkt = (b1))
205 #define PDQ_OS_DATABUF_LEN(b) ((b)->m_len)
206 #define PDQ_OS_DATABUF_LEN_SET(b, n) ((b)->m_len = (n))
207 /* #define PDQ_OS_DATABUF_LEN_ADJ(b, n) ((b)->m_len += (n)) */
208 #define PDQ_OS_DATABUF_PTR(b) (mtod((b), pdq_uint8_t *))
209 #define PDQ_OS_DATABUF_ADJ(b, n) ((b)->m_data += (n), (b)->m_len -= (n))
210 typedef struct mbuf PDQ_OS_DATABUF_T;
212 #ifndef PDQ_OS_DATABUF_ALLOC
213 #define PDQ_OS_DATABUF_ALLOC(pdq, b) do { \
214 PDQ_OS_DATABUF_T *x_m0; \
215 MGETHDR(x_m0, M_NOWAIT, MT_DATA); \
216 if (x_m0 != NULL) { \
217 if (!(MCLGET(x_m0, M_NOWAIT))) { \
222 x_m0->m_len = PDQ_OS_DATABUF_SIZE; \
229 #define PDQ_OS_DATABUF_RESET(b) ((b)->m_data = (b)->m_ext.ext_buf, (b)->m_len = MCLBYTES)
231 #define PDQ_OS_TX_TRANSMIT 5
233 #define PDQ_OS_DATABUF_ENQUEUE(q, b) do { \
234 PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \
235 if ((q)->q_tail == NULL) \
238 PDQ_OS_DATABUF_NEXTPKT_SET(((PDQ_OS_DATABUF_T *)(q)->q_tail), b); \
242 #define PDQ_OS_DATABUF_DEQUEUE(q, b) do { \
243 if (((b) = (PDQ_OS_DATABUF_T *) (q)->q_head) != NULL) { \
244 if (((q)->q_head = PDQ_OS_DATABUF_NEXTPKT(b)) == NULL) \
245 (q)->q_tail = NULL; \
246 PDQ_OS_DATABUF_NEXTPKT_SET(b, NULL); \
250 #if !defined(PDQ_OS_CONSUMER_PRESYNC)
251 #define PDQ_OS_CONSUMER_PRESYNC(pdq) do { } while(0)
252 #define PDQ_OS_CONSUMER_POSTSYNC(pdq) do { } while(0)
253 #define PDQ_OS_DESC_PRESYNC(pdq, d, s) do { } while(0)
254 #define PDQ_OS_DESC_POSTSYNC(pdq, d, s) do { } while(0)
255 #define PDQ_OS_CMDRQST_PRESYNC(pdq, s) do { } while(0)
256 #define PDQ_OS_CMDRQST_POSTSYNC(pdq, s) do { } while(0)
257 #define PDQ_OS_CMDRSP_PRESYNC(pdq, s) do { } while(0)
258 #define PDQ_OS_CMDRSP_POSTSYNC(pdq, s) do { } while(0)
259 #define PDQ_OS_RXPDU_PRESYNC(pdq, b, o, l) do { } while(0)
260 #define PDQ_OS_RXPDU_POSTSYNC(pdq, b, o, l) do { } while(0)
261 #define PDQ_OS_UNSOL_EVENT_PRESYNC(pdq, e) do { } while(0)
262 #define PDQ_OS_UNSOL_EVENT_POSTSYNC(pdq, e) do { } while(0)
265 #ifndef PDQ_OS_DATABUF_BUSPA
266 #define PDQ_OS_DATABUF_BUSPA(pdq, b) PDQ_OS_VA_TO_BUSPA(pdq, PDQ_OS_DATABUF_PTR(b))
269 #ifndef PDQ_OS_HDR_OFFSET
270 #define PDQ_OS_HDR_OFFSET PDQ_RX_FC_OFFSET
273 extern void pdq_os_addr_fill(pdq_t *pdq, pdq_lanaddr_t *addrs, size_t numaddrs);
274 extern void pdq_os_receive_pdu(pdq_t *, PDQ_OS_DATABUF_T *pdu, size_t pdulen, int drop);
275 extern void pdq_os_restart_transmitter(pdq_t *pdq);
276 extern void pdq_os_transmit_done(pdq_t *pdq, PDQ_OS_DATABUF_T *pdu);
277 #if !defined(pdq_os_update_status)
278 extern void pdq_os_update_status(pdq_t *pdq, const void *rsp);
280 #if !defined(PDQ_OS_MEMALLOC_CONTIG)
281 extern int pdq_os_memalloc_contig(pdq_t *pdq);
283 extern pdq_boolean_t pdq_queue_transmit_data(pdq_t *pdq, PDQ_OS_DATABUF_T *pdu);
284 extern void pdq_flush_transmitter(pdq_t *pdq);
286 extern void pdq_run(pdq_t *pdq);
287 extern pdq_state_t pdq_stop(pdq_t *pdq);
288 extern void pdq_hwreset(pdq_t *pdq);
290 extern int pdq_interrupt(pdq_t *pdq);
291 extern pdq_t *pdq_initialize(pdq_bus_t bus, pdq_bus_memaddr_t csr_va,
292 const char *name, int unit,
293 void *ctx, pdq_type_t type);
294 #endif /* _PDQ_OS_H */