i82586var.h revision 1.19
1/* $NetBSD: i82586var.h,v 1.19 2005/02/04 02:10:36 perry Exp $ */ 2 3/*- 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Paul Kranenburg and Charles M. Hannum. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39/*- 40 * Copyright (c) 1992, 1993, University of Vermont and State 41 * Agricultural College. 42 * Copyright (c) 1992, 1993, Garrett A. Wollman. 43 * 44 * Portions: 45 * Copyright (c) 1994, 1995, Rafal K. Boni 46 * Copyright (c) 1990, 1991, William F. Jolitz 47 * Copyright (c) 1990, The Regents of the University of California 48 * 49 * All rights reserved. 50 * 51 * Redistribution and use in source and binary forms, with or without 52 * modification, are permitted provided that the following conditions 53 * are met: 54 * 1. Redistributions of source code must retain the above copyright 55 * notice, this list of conditions and the following disclaimer. 56 * 2. Redistributions in binary form must reproduce the above copyright 57 * notice, this list of conditions and the following disclaimer in the 58 * documentation and/or other materials provided with the distribution. 59 * 3. All advertising materials mentioning features or use of this software 60 * must display the following acknowledgement: 61 * This product includes software developed by the University of Vermont 62 * and State Agricultural College and Garrett A. Wollman, by William F. 63 * Jolitz, and by the University of California, Berkeley, Lawrence 64 * Berkeley Laboratory, and its contributors. 65 * 4. Neither the names of the Universities nor the names of the authors 66 * may be used to endorse or promote products derived from this software 67 * without specific prior written permission. 68 * 69 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 70 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 71 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 72 * ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OR AUTHORS BE LIABLE 73 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 74 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 75 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 76 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 77 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 78 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 79 * SUCH DAMAGE. 80 */ 81 82/* 83 * Intel 82586 Ethernet chip 84 * Register, bit, and structure definitions. 85 * 86 * Original StarLAN driver written by Garrett Wollman with reference to the 87 * Clarkson Packet Driver code for this chip written by Russ Nelson and others. 88 * 89 * BPF support code taken from hpdev/if_le.c, supplied with tcpdump. 90 * 91 * 3C507 support is loosely based on code donated to NetBSD by Rafal Boni. 92 * 93 * Majorly cleaned up and 3C507 code merged by Charles Hannum. 94 * 95 * Converted to SUN ie driver by Charles D. Cranor, 96 * October 1994, January 1995. 97 * This sun version based on i386 version 1.30. 98 */ 99 100#ifndef I82586_DEBUG 101#define I82586_DEBUG 0 102#endif 103 104/* Debug elements */ 105#define IED_RINT 0x01 106#define IED_TINT 0x02 107#define IED_RNR 0x04 108#define IED_CNA 0x08 109#define IED_READFRAME 0x10 110#define IED_ENQ 0x20 111#define IED_XMIT 0x40 112#define IED_ALL 0x7f 113 114#define B_PER_F 3 /* recv buffers per frame */ 115#define IE_RBUF_SIZE 256 /* size of each receive buffer; 116 MUST BE POWER OF TWO */ 117#define NTXBUF 2 /* number of transmit commands */ 118#define IE_TBUF_SIZE ETHER_MAX_LEN /* length of transmit buffer */ 119 120#define IE_MAXMCAST (IE_TBUF_SIZE/6)/* must fit in transmit buffer */ 121 122 123#define INTR_ENTER 0 /* intr hook called on ISR entry */ 124#define INTR_EXIT 1 /* intr hook called on ISR exit */ 125#define INTR_LOOP 2 /* intr hook called on ISR loop */ 126#define INTR_ACK 3 /* intr hook called on ie_ack */ 127 128#define CHIP_PROBE 0 /* reset called from chip probe */ 129#define CARD_RESET 1 /* reset called from card reset */ 130 131/* 132 * Ethernet status, per interface. 133 * 134 * The chip uses two types of pointers: 16 bit and 24 bit 135 * 24 bit pointers cover the board's memory. 136 * 16 bit pointers are offsets from the ISCP's `ie_base' 137 * 138 * The board's memory is represented by the bus handle `bh'. The MI 139 * i82586 driver deals exclusively with offsets relative to the 140 * board memory bus handle. The `ie_softc' fields below that are marked 141 * `MD' are in the domain of the front-end driver; they opaque to the 142 * MI driver part. 143 * 144 * The front-end is required to manage the SCP and ISCP structures. i.e. 145 * allocate room for them on the board's memory, and arrange to point the 146 * chip at the SCB structure, the offset of which is passed to the MI 147 * driver in `sc_scb'. 148 * 149 * The following functions provide the glue necessary to deal with 150 * host and bus idiosyncracies: 151 * 152 * hwreset - board reset 153 * hwinit - board initialization 154 * chan_attn - get chip to look at prepared commands 155 * intrhook - board dependent interrupt processing 156 * 157 * All of the following shared-memory access function use an offset 158 * relative to the bus handle to indicate the shared memory location. 159 * The bus_{read/write}N function take or return offset into the 160 * shared memory in the host's byte-order. 161 * 162 * memcopyin - copy device memory: board to KVA 163 * memcopyout - copy device memory: KVA to board 164 * bus_read16 - read a 16-bit i82586 pointer 165 `offset' argument will be 16-bit aligned 166 * bus_write16 - write a 16-bit i82586 pointer 167 `offset' argument will be 16-bit aligned 168 * bus_write24 - write a 24-bit i82586 pointer 169 `offset' argument will be 32-bit aligned 170 * bus_barrier - perform a bus barrier operation, forcing 171 all outstanding reads/writes to complete 172 * 173 */ 174 175struct ie_softc { 176 struct device sc_dev; /* device structure */ 177 178 bus_space_tag_t bt; /* bus-space tag of card memory */ 179 bus_space_handle_t bh; /* bus-space handle of card memory */ 180 181 bus_dmamap_t sc_dmamap; /* bus dma handle */ 182 183 void *sc_iobase; /* (MD) KVA of base of 24 bit addr space */ 184 void *sc_maddr; /* (MD) KVA of base of chip's RAM 185 (16bit addr space) */ 186 u_int sc_msize; /* (MD) how much RAM we have/use */ 187 void *sc_reg; /* (MD) KVA of car's register */ 188 189 struct ethercom sc_ethercom; /* system ethercom structure */ 190 struct ifmedia sc_media; /* supported media information */ 191 192 /* Bus glue */ 193 void (*hwreset)(struct ie_softc *, int); 194 void (*hwinit)(struct ie_softc *); 195 void (*chan_attn)(struct ie_softc *, int); 196 int (*intrhook)(struct ie_softc *, int); 197 198 void (*memcopyin)(struct ie_softc *, void *, int, size_t); 199 void (*memcopyout)(struct ie_softc *, const void *, int, size_t); 200 u_int16_t (*ie_bus_read16)(struct ie_softc *, int); 201 void (*ie_bus_write16)(struct ie_softc *, int, u_int16_t); 202 void (*ie_bus_write24)(struct ie_softc *, int, int); 203 void (*ie_bus_barrier)(struct ie_softc *, int, int, int); 204 205 /* Media management */ 206 int (*sc_mediachange)(struct ie_softc *); 207 /* card dependent media change */ 208 void (*sc_mediastatus)(struct ie_softc *, struct ifmediareq *); 209 /* card dependent media status */ 210 211 212 /* 213 * Offsets (relative to bus handle) of the i82586 SYSTEM structures. 214 */ 215 int scp; /* Offset to the SCP (set by front-end) */ 216 int iscp; /* Offset to the ISCP (set by front-end) */ 217 int scb; /* Offset to SCB (set by front-end) */ 218 219 /* 220 * Offset and size of a block of board memory where the buffers 221 * are to be allocated from (initialized by front-end). 222 */ 223 int buf_area; /* Start of descriptors and buffers */ 224 int buf_area_sz; /* Size of above */ 225 226 /* 227 * The buffers & descriptors (recv and xmit) 228 */ 229 int rframes; /* Offset to `nrxbuf' frame descriptors */ 230 int rbds; /* Offset to `nrxbuf' buffer descriptors */ 231 int rbufs; /* Offset to `nrxbuf' receive buffers */ 232#define IE_RBUF_ADDR(sc, i) (sc->rbufs + ((i) * IE_RBUF_SIZE)) 233 int rfhead, rftail; 234 int rbhead, rbtail; 235 int nframes; /* number of frames in use */ 236 int nrxbuf; /* number of recv buffs in use */ 237 int rnr_expect; /* XXX - expect a RCVR not ready interrupt */ 238 239 int nop_cmds; /* Offset to NTXBUF no-op commands */ 240 int xmit_cmds; /* Offset to NTXBUF transmit commands */ 241 int xbds; /* Offset to NTXBUF buffer descriptors */ 242 int xbufs; /* Offset to NTXBUF transmit buffers */ 243#define IE_XBUF_ADDR(sc, i) (sc->xbufs + ((i) * IE_TBUF_SIZE)) 244 245 int xchead, xctail; 246 int xmit_busy; 247 int do_xmitnopchain; /* Controls use of xmit NOP chains */ 248 249 /* Multicast addresses */ 250 char *mcast_addrs; /* Current MC filter addresses */ 251 int mcast_addrs_size; /* Current size of MC buffer */ 252 int mcast_count; /* Current # of addrs in buffer */ 253 int want_mcsetup; /* run mcsetup at next opportunity */ 254 255 int promisc; /* are we in promisc mode? */ 256 int async_cmd_inprogress; /* we didn't wait for 586 to accept 257 a command */ 258 259#if I82586_DEBUG 260 int sc_debug; 261#endif 262}; 263 264/* Exported functions */ 265int i82586_intr(void *); 266int i82586_proberam(struct ie_softc *); 267void i82586_attach(struct ie_softc *, char *, u_int8_t *, int*, int, int); 268 269/* Shortcut macros to optional (driver uses default if unspecified) callbacks */ 270#define IE_BUS_BARRIER(sc, offset, length, flags) \ 271do { \ 272 if ((sc)->ie_bus_barrier) \ 273 ((sc)->ie_bus_barrier)((sc), (offset), (length), (flags));\ 274 else \ 275 bus_space_barrier((sc)->bt, (sc)->bh, (offset), (length), \ 276 (flags)); \ 277} while (0) 278 279