xref: /dragonfly/sys/dev/netif/de/if_devar.h (revision 25a2db75)
1 /*	$NetBSD: if_devar.h,v 1.32 1999/04/01 14:55:25 tsubai Exp $	*/
2 
3 /* $FreeBSD: src/sys/pci/if_devar.h,v 1.23.2.1 2000/08/04 23:25:10 peter Exp $ */
4 
5 /*-
6  * Copyright (c) 1994-1997 Matt Thomas (matt@3am-software.com)
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
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
16  *
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.
27  *
28  * Id: if_devar.h,v 1.28 1997/07/03 16:55:07 thomas Exp
29  */
30 
31 #if !defined(_DEVAR_H)
32 #define _DEVAR_H
33 
34 typedef bus_addr_t tulip_csrptr_t;
35 
36 #define	TULIP_PCI_CSRSIZE	8
37 #define	TULIP_PCI_CSROFFSET	0
38 
39 #define TULIP_CSR_READ(sc, csr)			\
40 	bus_space_read_4((sc)->tulip_csrs_bst,	\
41 			 (sc)->tulip_csrs_bsh,	\
42 			 (sc)->tulip_csrs.csr)
43 #define TULIP_CSR_WRITE(sc, csr, val)			\
44 	bus_space_write_4((sc)->tulip_csrs_bst,		\
45 			  (sc)->tulip_csrs_bsh,		\
46 			  (sc)->tulip_csrs.csr, val)
47 
48 #define TULIP_CSR_READBYTE(sc, csr)		\
49 	bus_space_read_1((sc)->tulip_csrs_bst,	\
50 			 (sc)->tulip_csrs_bsh,	\
51 			 (sc)->tulip_csrs.csr)
52 #define TULIP_CSR_WRITEBYTE(sc, csr, val)		\
53 	bus_space_write_1((sc)->tulip_csrs_bst,		\
54 			  (sc)->tulip_csrs_bsh,		\
55 			  (sc)->tulip_csrs.csr, val)
56 
57 /*
58  * This structure contains "pointers" for the registers on
59  * the various 21x4x chips.  CSR0 through CSR8 are common
60  * to all chips.  After that, it gets messy...
61  */
62 typedef struct {
63     tulip_csrptr_t csr_busmode;			/* CSR0 */
64     tulip_csrptr_t csr_txpoll;			/* CSR1 */
65     tulip_csrptr_t csr_rxpoll;			/* CSR2 */
66     tulip_csrptr_t csr_rxlist;			/* CSR3 */
67     tulip_csrptr_t csr_txlist;			/* CSR4 */
68     tulip_csrptr_t csr_status;			/* CSR5 */
69     tulip_csrptr_t csr_command;			/* CSR6 */
70     tulip_csrptr_t csr_intr;			/* CSR7 */
71     tulip_csrptr_t csr_missed_frames;		/* CSR8 */
72     tulip_csrptr_t csr_9;			/* CSR9 */
73     tulip_csrptr_t csr_10;			/* CSR10 */
74     tulip_csrptr_t csr_11;			/* CSR11 */
75     tulip_csrptr_t csr_12;			/* CSR12 */
76     tulip_csrptr_t csr_13;			/* CSR13 */
77     tulip_csrptr_t csr_14;			/* CSR14 */
78     tulip_csrptr_t csr_15;			/* CSR15 */
79 } tulip_regfile_t;
80 
81 #define	csr_enetrom		csr_9	/* 21040 */
82 #define	csr_reserved		csr_10	/* 21040 */
83 #define	csr_full_duplex		csr_11	/* 21040 */
84 #define	csr_bootrom		csr_10	/* 21041/21140A/?? */
85 #define	csr_gp			csr_12	/* 21140* */
86 #define	csr_watchdog		csr_15	/* 21140* */
87 #define	csr_gp_timer		csr_11	/* 21041/21140* */
88 #define	csr_srom_mii		csr_9	/* 21041/21140* */
89 #define	csr_sia_status		csr_12	/* 2104x */
90 #define csr_sia_connectivity	csr_13	/* 2104x */
91 #define csr_sia_tx_rx		csr_14	/* 2104x */
92 #define csr_sia_general		csr_15	/* 2104x */
93 
94 /*
95  * While 21x4x allows chaining of its descriptors, this driver
96  * doesn't take advantage of it.  We keep the descriptors in a
97  * traditional FIFO ring.
98  */
99 typedef struct {
100     tulip_desc_t *ri_first;	/* first entry in ring */
101     tulip_desc_t *ri_last;	/* one after last entry */
102     tulip_desc_t *ri_nextin;	/* next to processed by host */
103     tulip_desc_t *ri_nextout;	/* next to processed by adapter */
104     int ri_max;
105     int ri_free;
106 } tulip_ringinfo_t;
107 
108 /*
109  * The 21040 has a stupid restriction in that the receive
110  * buffers must be longword aligned.  But since Ethernet
111  * headers are not a multiple of longwords in size this forces
112  * the data to non-longword aligned.  Since IP requires the
113  * data to be longword aligned, we need to copy it after it has
114  * been DMA'ed in our memory.
115  *
116  * Since we have to copy it anyways, we might as well as allocate
117  * dedicated receive space for the input.  This allows to use a
118  * small receive buffer size and more ring entries to be able to
119  * better keep with a flood of tiny Ethernet packets.
120  *
121  * The receive space MUST ALWAYS be a multiple of the page size.
122  * And the number of receive descriptors multiplied by the size
123  * of the receive buffers must equal the recevive space.  This
124  * is so that we can manipulate the page tables so that even if a
125  * packet wraps around the end of the receive space, we can
126  * treat it as virtually contiguous.
127  *
128  * The above used to be true (the stupid restriction is still true)
129  * but we gone to directly DMA'ing into MBUFs (unless it's on an
130  * architecture which can't handle unaligned accesses) because with
131  * 100Mb/s cards the copying is just too much of a hit.
132  */
133 #if !defined(__i386__)
134 #define	TULIP_COPY_RXDATA	1
135 #endif
136 
137 #define	TULIP_DATA_PER_DESC	2032
138 #define	TULIP_TXTIMER		4
139 #define	TULIP_RXDESCS		48
140 #define	TULIP_TXDESCS		128
141 #define	TULIP_RXQ_TARGET	32
142 #if TULIP_RXQ_TARGET >= TULIP_RXDESCS
143 #error TULIP_RXQ_TARGET must be less than TULIP_RXDESCS
144 #endif
145 #define	TULIP_RX_BUFLEN		((MCLBYTES < 2048 ? MCLBYTES : 2048) - 16)
146 
147 /*
148  * Forward reference to make C happy.
149  */
150 typedef struct _tulip_softc_t tulip_softc_t;
151 
152 /*
153  * The various controllers support.
154  */
155 
156 typedef enum {
157     TULIP_21040,
158     TULIP_21041,
159     TULIP_21140, TULIP_21140A, TULIP_21142,
160     TULIP_21143,
161     TULIP_CHIPID_UNKNOWN
162 } tulip_chipid_t;
163 
164 /*
165  * Various physical media types supported.
166  * BNCAUI is BNC or AUI since on the 21040 you can't really tell
167  * which is in use.
168  */
169 typedef enum {
170     TULIP_MEDIA_UNKNOWN,
171     TULIP_MEDIA_10BASET,
172     TULIP_MEDIA_10BASET_FD,
173     TULIP_MEDIA_BNC,
174     TULIP_MEDIA_AUI,
175     TULIP_MEDIA_EXTSIA,
176     TULIP_MEDIA_AUIBNC,
177     TULIP_MEDIA_100BASETX,
178     TULIP_MEDIA_100BASETX_FD,
179     TULIP_MEDIA_100BASET4,
180     TULIP_MEDIA_100BASEFX,
181     TULIP_MEDIA_100BASEFX_FD,
182     TULIP_MEDIA_MAX
183 } tulip_media_t;
184 
185 #define	TULIP_BIT(b)		(1L << ((int)(b)))
186 #define	TULIP_FDBIT(m)		(1L << ((int)TULIP_MEDIA_ ## m ## _FD))
187 #define	TULIP_MBIT(m)		(1L << ((int)TULIP_MEDIA_ ## m ))
188 #define	TULIP_IS_MEDIA_FD(m)	(TULIP_BIT(m) & \
189 				 (TULIP_FDBIT(10BASET) \
190 				  |TULIP_FDBIT(100BASETX) \
191 				  |TULIP_FDBIT(100BASEFX)))
192 #define	TULIP_CAN_MEDIA_FD(m)	(TULIP_BIT(m) & \
193 				 (TULIP_MBIT(10BASET) \
194 				  |TULIP_MBIT(100BASETX) \
195 				  |TULIP_MBIT(100BASEFX)))
196 #define	TULIP_FD_MEDIA_OF(m)	((tulip_media_t)((m) + 1))
197 #define	TULIP_HD_MEDIA_OF(m)	((tulip_media_t)((m) - 1))
198 #define	TULIP_IS_MEDIA_100MB(m)	((m) >= TULIP_MEDIA_100BASETX)
199 #define	TULIP_IS_MEDIA_TP(m)	((TULIP_BIT(m) & \
200 				  (TULIP_MBIT(BNC) \
201 				   |TULIP_MBIT(AUI) \
202 				   |TULIP_MBIT(AUIBNC) \
203 				   |TULIP_MBIT(EXTSIA))) == 0)
204 
205 #define	TULIP_SROM_ATTR_MII		0x0100
206 #define	TULIP_SROM_ATTR_NWAY		0x0200
207 #define	TULIP_SROM_ATTR_AUTOSENSE	0x0400
208 #define	TULIP_SROM_ATTR_POWERUP		0x0800
209 #define	TULIP_SROM_ATTR_NOLINKPASS	0x1000
210 
211 typedef struct {
212     enum {
213 	TULIP_MEDIAINFO_NONE,
214 	TULIP_MEDIAINFO_SIA,
215 	TULIP_MEDIAINFO_GPR,
216 	TULIP_MEDIAINFO_MII,
217 	TULIP_MEDIAINFO_RESET,
218 	TULIP_MEDIAINFO_SYM
219     } mi_type;
220     union {
221 	struct {
222 	    u_int16_t sia_connectivity;
223 	    u_int16_t sia_tx_rx;
224 	    u_int16_t sia_general;
225 	    u_int32_t sia_gp_control;	/* 21142/21143 */
226 	    u_int32_t sia_gp_data;	/* 21142/21143 */
227 	} un_sia;
228 	struct {
229 	    u_int32_t gpr_cmdmode;
230 	    u_int32_t gpr_gpcontrol;	/* 21142/21143 */
231 	    u_int32_t gpr_gpdata;
232 	    u_int8_t gpr_actmask;
233 	    u_int8_t gpr_actdata;
234 	    u_int    gpr_default : 1;
235 	} un_gpr;
236 	struct {
237 	    u_int32_t mii_mediamask;
238 	    u_int16_t mii_capabilities;
239 	    u_int16_t mii_advertisement;
240 	    u_int16_t mii_full_duplex;
241 	    u_int16_t mii_tx_threshold;
242 	    u_int16_t mii_interrupt;	/* 21142/21143 */
243 	    u_int8_t mii_phyaddr;
244 	    u_int8_t mii_gpr_length;
245 	    u_int8_t mii_gpr_offset;
246 	    u_int8_t mii_reset_length;
247 	    u_int8_t mii_reset_offset;
248 	    u_int32_t mii_phyid;
249 	} un_mii;
250     } mi_un;
251 } tulip_media_info_t;
252 
253 #define	mi_sia_connectivity	mi_un.un_sia.sia_connectivity
254 #define	mi_sia_tx_rx		mi_un.un_sia.sia_tx_rx
255 #define mi_sia_general		mi_un.un_sia.sia_general
256 #define	mi_sia_gp_control	mi_un.un_sia.sia_gp_control
257 #define	mi_sia_gp_data		mi_un.un_sia.sia_gp_data
258 
259 #define	mi_gpcontrol		mi_un.un_gpr.gpr_gpcontrol
260 #define	mi_gpdata		mi_un.un_gpr.gpr_gpdata
261 #define	mi_actmask		mi_un.un_gpr.gpr_actmask
262 #define	mi_actdata		mi_un.un_gpr.gpr_actdata
263 #define	mi_default		mi_un.un_gpr.gpr_default
264 #define	mi_cmdmode		mi_un.un_gpr.gpr_cmdmode
265 
266 #define	mi_phyaddr		mi_un.un_mii.mii_phyaddr
267 #define	mi_gpr_length		mi_un.un_mii.mii_gpr_length
268 #define	mi_gpr_offset		mi_un.un_mii.mii_gpr_offset
269 #define	mi_reset_length		mi_un.un_mii.mii_reset_length
270 #define	mi_reset_offset		mi_un.un_mii.mii_reset_offset
271 #define	mi_capabilities		mi_un.un_mii.mii_capabilities
272 #define	mi_advertisement	mi_un.un_mii.mii_advertisement
273 #define	mi_full_duplex		mi_un.un_mii.mii_full_duplex
274 #define	mi_tx_threshold		mi_un.un_mii.mii_tx_threshold
275 #define	mi_mediamask		mi_un.un_mii.mii_mediamask
276 #define	mi_mii_interrupt	mi_un.un_mii.mii_interrupt
277 #define	mi_phyid		mi_un.un_mii.mii_phyid
278 
279 #define	TULIP_MEDIAINFO_SIA_INIT(sc, mi, chipid, media) do { \
280     (mi)->mi_type = TULIP_MEDIAINFO_SIA; \
281     sc->tulip_mediums[TULIP_MEDIA_ ## media] = (mi); \
282     (mi)->mi_sia_connectivity = TULIP_ ## chipid ## _SIACONN_ ## media; \
283     (mi)->mi_sia_tx_rx        = TULIP_ ## chipid ## _SIATXRX_ ## media; \
284     (mi)->mi_sia_general      = TULIP_ ## chipid ## _SIAGEN_ ## media; \
285 } while (0)
286 
287 #define TULIP_MEDIAINFO_ADD_CAPABILITY(sc, mi, media) do {	\
288     if ((sc)->tulip_mediums[TULIP_MEDIA_ ## media] == NULL	\
289 	    && ((mi)->mi_capabilities & PHYSTS_ ## media)) {	\
290 	(sc)->tulip_mediums[TULIP_MEDIA_ ## media] = (mi);	\
291 	(mi)->mi_mediamask |= TULIP_BIT(TULIP_MEDIA_ ## media);	\
292     } \
293 } while (0)
294 
295 #define	TULIP_MII_NOPHY		32
296 /*
297  * Some boards need to treated specially.  The following enumeration
298  * identifies the cards with quirks (or those we just want to single
299  * out for special merit or scorn).
300  */
301 typedef enum {
302     TULIP_21040_GENERIC,		/* Generic 21040 (works with most any board) */
303     TULIP_21140_ISV,			/* Digital Semicondutor 21140 ISV SROM Format */
304     TULIP_21142_ISV,			/* Digital Semicondutor 21142 ISV SROM Format */
305     TULIP_21143_ISV,			/* Digital Semicondutor 21143 ISV SROM Format */
306     TULIP_21140_DEC_EB,			/* Digital Semicondutor 21140 Evaluation Board */
307     TULIP_21140_MII,			/* 21140[A] with MII */
308     TULIP_21140_DEC_DE500,		/* Digital DE500-?? 10/100 */
309     TULIP_21140_SMC_9332,		/* SMC 9332 */
310     TULIP_21140_COGENT_EM100,		/* Cogent EM100 100 only */
311     TULIP_21140_ZNYX_ZX34X,		/* ZNYX ZX342 10/100 */
312     TULIP_21140_ASANTE,			/* AsanteFast 10/100 */
313     TULIP_21140_EN1207,			/* Accton EN2107 10/100 BNC */
314     TULIP_21041_GENERIC			/* Generic 21041 card */
315 } tulip_board_t;
316 
317 typedef enum {
318     TULIP_MEDIAPOLL_TIMER,		/* 100ms timer fired */
319     TULIP_MEDIAPOLL_FASTTIMER,		/* <100ms timer fired */
320     TULIP_MEDIAPOLL_LINKFAIL,		/* called from interrupt routine */
321     TULIP_MEDIAPOLL_LINKPASS,		/* called from interrupt routine */
322     TULIP_MEDIAPOLL_START,		/* start a media probe (called from reset) */
323     TULIP_MEDIAPOLL_TXPROBE_OK,		/* txprobe succeeded */
324     TULIP_MEDIAPOLL_TXPROBE_FAILED,	/* txprobe failed */
325     TULIP_MEDIAPOLL_MAX
326 } tulip_mediapoll_event_t;
327 
328 typedef enum {
329     TULIP_LINK_DOWN,			/* Link is down */
330     TULIP_LINK_UP,			/* link is ok */
331     TULIP_LINK_UNKNOWN			/* we can't tell either way */
332 } tulip_link_status_t;
333 
334 
335 /*
336  * This data structure is used to abstract out the quirks.
337  * media_probe  = tries to determine the media type.
338  * media_select = enables the current media (or autosenses)
339  * media_poll	= autosenses media
340  * media_preset = 21140, etal requires bit to set before the
341  *		  the software reset; hence pre-set.  Should be
342  *		  pre-reset but that's ugly.
343  */
344 
345 typedef struct {
346     tulip_board_t bd_type;
347     void (*bd_media_probe)(tulip_softc_t * const sc);
348     void (*bd_media_select)(tulip_softc_t * const sc);
349     void (*bd_media_poll)(tulip_softc_t * const sc, tulip_mediapoll_event_t event);
350     void (*bd_media_preset)(tulip_softc_t * const sc);
351 } tulip_boardsw_t;
352 
353 /*
354  * The next few declarations are for MII/PHY based board.
355  *
356  *    The first enumeration identifies a superset of various datums
357  * that can be obtained from various PHY chips.  Not all PHYs will
358  * support all datums.
359  *    The modedata structure indicates what register contains
360  * a datum, what mask is applied the register contents, and what the
361  * result should be.
362  *    The attr structure records information about a supported PHY.
363  *    The phy structure records information about a PHY instance.
364  */
365 
366 typedef enum {
367     PHY_MODE_10T,
368     PHY_MODE_100TX,
369     PHY_MODE_100T4,
370     PHY_MODE_FULLDUPLEX,
371     PHY_MODE_MAX
372 } tulip_phy_mode_t;
373 
374 typedef struct {
375     u_int16_t pm_regno;
376     u_int16_t pm_mask;
377     u_int16_t pm_value;
378 } tulip_phy_modedata_t;
379 
380 typedef struct {
381     u_int32_t attr_id;
382     u_int16_t attr_flags;
383 #define	PHY_NEED_HARD_RESET	0x0001
384 #define	PHY_DUAL_CYCLE_TA	0x0002
385     tulip_phy_modedata_t attr_modes[PHY_MODE_MAX];
386 } tulip_phy_attr_t;
387 
388 /*
389  * Various probe states used when trying to autosense the media.
390  */
391 
392 typedef enum {
393     TULIP_PROBE_INACTIVE,
394     TULIP_PROBE_PHYRESET,
395     TULIP_PROBE_PHYAUTONEG,
396     TULIP_PROBE_GPRTEST,
397     TULIP_PROBE_MEDIATEST,
398     TULIP_PROBE_FAILED
399 } tulip_probe_state_t;
400 
401 typedef struct {
402     /*
403      * Transmit Statistics
404      */
405     u_int32_t dot3StatsSingleCollisionFrames;
406     u_int32_t dot3StatsMultipleCollisionFrames;
407     u_int32_t dot3StatsSQETestErrors;
408     u_int32_t dot3StatsDeferredTransmissions;
409     u_int32_t dot3StatsLateCollisions;
410     u_int32_t dot3StatsExcessiveCollisions;
411     u_int32_t dot3StatsCarrierSenseErrors;
412     u_int32_t dot3StatsInternalMacTransmitErrors;
413     u_int32_t dot3StatsInternalTransmitUnderflows;	/* not in rfc1650! */
414     u_int32_t dot3StatsInternalTransmitBabbles;		/* not in rfc1650! */
415     /*
416      * Receive Statistics
417      */
418     u_int32_t dot3StatsMissedFrames;	/* not in rfc1650! */
419     u_int32_t dot3StatsAlignmentErrors;
420     u_int32_t dot3StatsFCSErrors;
421     u_int32_t dot3StatsFrameTooLongs;
422     u_int32_t dot3StatsInternalMacReceiveErrors;
423 } tulip_dot3_stats_t;
424 
425 /*
426  * Now to important stuff.  This is softc structure (where does softc
427  * come from??? No idea) for the tulip device.
428  */
429 struct _tulip_softc_t {
430     struct arpcom tulip_ac;
431     struct ifmedia tulip_ifmedia;
432     struct callout tulip_timer;
433     struct callout tulip_fast_timer;
434     bus_space_tag_t tulip_csrs_bst;
435     bus_space_handle_t tulip_csrs_bsh;
436     tulip_regfile_t tulip_csrs;
437     u_int32_t tulip_flags;
438 #define	TULIP_WANTSETUP		0x00000001
439 #define	TULIP_WANTHASHPERFECT	0x00000002
440 #define	TULIP_WANTHASHONLY	0x00000004
441 #define	TULIP_DOINGSETUP	0x00000008
442 #define	TULIP_PRINTMEDIA	0x00000010
443 #define	TULIP_TXPROBE_ACTIVE	0x00000020
444 #define	TULIP_ALLMULTI		0x00000040
445 #define	TULIP_WANTRXACT		0x00000080
446 #define	TULIP_RXACT		0x00000100
447 #define	TULIP_INRESET		0x00000200
448 #define	TULIP_NEEDRESET		0x00000400
449 #define	TULIP_SQETEST		0x00000800
450 #define	TULIP_xxxxxx0		0x00001000
451 #define	TULIP_xxxxxx1		0x00002000
452 #define	TULIP_WANTTXSTART	0x00004000
453 #define	TULIP_NEWTXTHRESH	0x00008000
454 #define	TULIP_NOAUTOSENSE	0x00010000
455 #define	TULIP_PRINTLINKUP	0x00020000
456 #define	TULIP_LINKUP		0x00040000
457 #define	TULIP_RXBUFSLOW		0x00080000
458 #define	TULIP_NOMESSAGES	0x00100000
459 #define	TULIP_SYSTEMERROR	0x00200000
460 #define	TULIP_TIMEOUTPENDING	0x00400000
461 #define	TULIP_xxxxxx2		0x00800000
462 #define	TULIP_TRYNWAY		0x01000000
463 #define	TULIP_DIDNWAY		0x02000000
464 #define	TULIP_RXIGNORE		0x04000000
465 #define	TULIP_PROBE1STPASS	0x08000000
466 #define	TULIP_DEVICEPROBE	0x10000000
467 #define	TULIP_PROMISC		0x20000000
468 #define	TULIP_HASHONLY		0x40000000
469 #define	TULIP_xxxxxx3		0x80000000
470     /* only 4 bits left! */
471     u_int32_t tulip_features;	/* static bits indicating features of chip */
472 #define	TULIP_HAVE_GPR		0x00000001	/* have gp register (140[A]) */
473 #define	TULIP_HAVE_RXBADOVRFLW	0x00000002	/* RX corrupts on overflow */
474 #define	TULIP_HAVE_POWERMGMT	0x00000004	/* Snooze/sleep modes */
475 #define	TULIP_HAVE_MII		0x00000008	/* Some medium on MII */
476 #define	TULIP_HAVE_SIANWAY	0x00000010	/* SIA does NWAY */
477 #define	TULIP_HAVE_DUALSENSE	0x00000020	/* SIA senses both AUI & TP */
478 #define	TULIP_HAVE_SIAGP	0x00000040	/* SIA has a GP port */
479 #define	TULIP_HAVE_BROKEN_HASH	0x00000080	/* Broken Multicast Hash */
480 #define	TULIP_HAVE_ISVSROM	0x00000100	/* uses ISV SROM Format */
481 #define	TULIP_HAVE_BASEROM	0x00000200	/* Board ROM can be cloned */
482 #define	TULIP_HAVE_SLAVEDROM	0x00000400	/* Board ROM cloned */
483 #define	TULIP_HAVE_SLAVEDINTR	0x00000800	/* Board slaved interrupt */
484 #define	TULIP_HAVE_SHAREDINTR	0x00001000	/* Board shares interrupts */
485 #define	TULIP_HAVE_OKROM	0x00002000	/* ROM was recognized */
486 #define	TULIP_HAVE_NOMEDIA	0x00004000	/* did not detect any media */
487 #define	TULIP_HAVE_STOREFWD	0x00008000	/* have CMD_STOREFWD */
488 #define	TULIP_HAVE_SIA100	0x00010000	/* has LS100 in SIA status */
489 #define	TULIP_HAVE_OKSROM	0x00020000	/* SROM CRC is OK */
490     u_int32_t tulip_intrmask;	/* our copy of csr_intr */
491     u_int32_t tulip_cmdmode;	/* our copy of csr_cmdmode */
492     u_int32_t tulip_last_system_error : 3;	/* last system error (only value is TULIP_SYSTEMERROR is also set) */
493     u_int32_t tulip_txtimer : 2;	/* transmission timer */
494     u_int32_t tulip_system_errors;	/* number of system errors encountered */
495     u_int32_t tulip_statusbits;	/* status bits from CSR5 that may need to be printed */
496 
497     tulip_media_info_t *tulip_mediums[TULIP_MEDIA_MAX];	/* indexes into mediainfo */
498     tulip_media_t tulip_media;			/* current media type */
499     u_int32_t tulip_abilities;	/* remote system's abiltities (as defined in IEEE 802.3u) */
500 
501     u_int8_t tulip_revinfo;			/* revision of chip */
502     u_int8_t tulip_phyaddr;			/* 0..31 -- address of current phy */
503     u_int8_t tulip_gpinit;			/* active pins on 21140 */
504     u_int8_t tulip_gpdata;			/* default gpdata for 21140 */
505 
506     struct {
507 	u_int8_t probe_count;			/* count of probe operations */
508 	int32_t probe_timeout;			/* time in ms of probe timeout */
509 	tulip_probe_state_t probe_state;	/* current media probe state */
510 	tulip_media_t probe_media;		/* current media being probed */
511 	u_int32_t probe_mediamask;		/* medias checked */
512 	u_int32_t probe_passes;			/* times autosense failed */
513 	u_int32_t probe_txprobes;		/* txprobes attempted */
514     } tulip_probe;
515 #define	tulip_probe_count	tulip_probe.probe_count
516 #define	tulip_probe_timeout	tulip_probe.probe_timeout
517 #define	tulip_probe_state	tulip_probe.probe_state
518 #define	tulip_probe_media	tulip_probe.probe_media
519 #define	tulip_probe_mediamask	tulip_probe.probe_mediamask
520 #define	tulip_probe_passes	tulip_probe.probe_passes
521 
522     tulip_chipid_t tulip_chipid;		/* type of chip we are using */
523     const tulip_boardsw_t *tulip_boardsw;	/* board/chip characteristics */
524     tulip_softc_t *tulip_slaves;		/* slaved devices (ZX3xx) */
525     struct ifqueue tulip_txq;
526     struct ifqueue tulip_rxq;
527     tulip_dot3_stats_t tulip_dot3stats;
528     tulip_ringinfo_t tulip_rxinfo;
529     tulip_ringinfo_t tulip_txinfo;
530     tulip_media_info_t tulip_mediainfo[10];
531     /*
532      * The setup buffers for sending the setup frame to the chip.
533      * one is the one being sent while the other is the one being
534      * filled.
535      */
536     u_int32_t tulip_setupbuf[192/sizeof(u_int32_t)];
537     u_int32_t tulip_setupdata[192/sizeof(u_int32_t)];
538     char tulip_boardid[16];		/* buffer for board ID */
539     u_int8_t tulip_rombuf[128];
540     u_int8_t tulip_pci_busno;		/* needed for multiport boards */
541     u_int8_t tulip_pci_devno;		/* needed for multiport boards */
542     u_int8_t tulip_connidx;
543     tulip_srom_connection_t tulip_conntype;
544     tulip_desc_t *tulip_rxdescs;
545     tulip_desc_t *tulip_txdescs;
546     device_t tulip_dev;
547 };
548 
549 #define	TULIP_DO_AUTOSENSE(sc)	(IFM_SUBTYPE((sc)->tulip_ifmedia.ifm_media) == IFM_AUTO)
550 
551 
552 static const char * const tulip_chipdescs[] = {
553     "21040 [10Mb/s]",
554     "21041 [10Mb/s]",
555     "21140 [10-100Mb/s]",
556     "21140A [10-100Mb/s]",
557     "21142 [10-100Mb/s]",
558     "21143 [10-100Mb/s]",
559 };
560 
561 static const char * const tulip_mediums[] = {
562     "unknown",			/* TULIP_MEDIA_UNKNOWN */
563     "10baseT",			/* TULIP_MEDIA_10BASET */
564     "Full Duplex 10baseT",	/* TULIP_MEDIA_10BASET_FD */
565     "BNC",			/* TULIP_MEDIA_BNC */
566     "AUI",			/* TULIP_MEDIA_AUI */
567     "External SIA",		/* TULIP_MEDIA_EXTSIA */
568     "AUI/BNC",			/* TULIP_MEDIA_AUIBNC */
569     "100baseTX",		/* TULIP_MEDIA_100BASET */
570     "Full Duplex 100baseTX",	/* TULIP_MEDIA_100BASET_FD */
571     "100baseT4",		/* TULIP_MEDIA_100BASET4 */
572     "100baseFX",		/* TULIP_MEDIA_100BASEFX */
573     "Full Duplex 100baseFX",	/* TULIP_MEDIA_100BASEFX_FD */
574 };
575 
576 static const int tulip_media_to_ifmedia[] = {
577     IFM_ETHER | IFM_NONE,		/* TULIP_MEDIA_UNKNOWN */
578     IFM_ETHER | IFM_10_T,		/* TULIP_MEDIA_10BASET */
579     IFM_ETHER | IFM_10_T | IFM_FDX,	/* TULIP_MEDIA_10BASET_FD */
580     IFM_ETHER | IFM_10_2,		/* TULIP_MEDIA_BNC */
581     IFM_ETHER | IFM_10_5,		/* TULIP_MEDIA_AUI */
582     IFM_ETHER | IFM_MANUAL,		/* TULIP_MEDIA_EXTSIA */
583     IFM_ETHER | IFM_10_5,		/* TULIP_MEDIA_AUIBNC */
584     IFM_ETHER | IFM_100_TX,		/* TULIP_MEDIA_100BASET */
585     IFM_ETHER | IFM_100_TX | IFM_FDX,	/* TULIP_MEDIA_100BASET_FD */
586     IFM_ETHER | IFM_100_T4,		/* TULIP_MEDIA_100BASET4 */
587     IFM_ETHER | IFM_100_FX,		/* TULIP_MEDIA_100BASEFX */
588     IFM_ETHER | IFM_100_FX | IFM_FDX,	/* TULIP_MEDIA_100BASEFX_FD */
589 };
590 
591 static const char * const tulip_system_errors[] = {
592     "parity error",
593     "master abort",
594     "target abort",
595     "reserved #3",
596     "reserved #4",
597     "reserved #5",
598     "reserved #6",
599     "reserved #7",
600 };
601 
602 static const char * const tulip_status_bits[] = {
603     NULL,
604     "transmit process stopped",
605     NULL,
606     "transmit jabber timeout",
607 
608     NULL,
609     "transmit underflow",
610     NULL,
611     "receive underflow",
612 
613     "receive process stopped",
614     "receive watchdog timeout",
615     NULL,
616     NULL,
617 
618     "link failure",
619     NULL,
620     NULL,
621 };
622 
623 static const struct {
624     tulip_srom_connection_t sc_type;
625     tulip_media_t sc_media;
626     u_int32_t sc_attrs;
627 } tulip_srom_conninfo[] = {
628     { TULIP_SROM_CONNTYPE_10BASET,		TULIP_MEDIA_10BASET },
629     { TULIP_SROM_CONNTYPE_BNC,			TULIP_MEDIA_BNC },
630     { TULIP_SROM_CONNTYPE_AUI,			TULIP_MEDIA_AUI },
631     { TULIP_SROM_CONNTYPE_100BASETX,		TULIP_MEDIA_100BASETX },
632     { TULIP_SROM_CONNTYPE_100BASET4,		TULIP_MEDIA_100BASET4 },
633     { TULIP_SROM_CONNTYPE_100BASEFX,		TULIP_MEDIA_100BASEFX },
634     { TULIP_SROM_CONNTYPE_MII_10BASET,		TULIP_MEDIA_10BASET,
635 		TULIP_SROM_ATTR_MII },
636     { TULIP_SROM_CONNTYPE_MII_100BASETX,	TULIP_MEDIA_100BASETX,
637 		TULIP_SROM_ATTR_MII },
638     { TULIP_SROM_CONNTYPE_MII_100BASET4,	TULIP_MEDIA_100BASET4,
639 		TULIP_SROM_ATTR_MII },
640     { TULIP_SROM_CONNTYPE_MII_100BASEFX,	TULIP_MEDIA_100BASEFX,
641 		TULIP_SROM_ATTR_MII },
642     { TULIP_SROM_CONNTYPE_10BASET_NWAY,		TULIP_MEDIA_10BASET,
643 		TULIP_SROM_ATTR_NWAY },
644     { TULIP_SROM_CONNTYPE_10BASET_FD,		TULIP_MEDIA_10BASET_FD },
645     { TULIP_SROM_CONNTYPE_MII_10BASET_FD,	TULIP_MEDIA_10BASET_FD,
646 		TULIP_SROM_ATTR_MII },
647     { TULIP_SROM_CONNTYPE_100BASETX_FD,		TULIP_MEDIA_100BASETX_FD },
648     { TULIP_SROM_CONNTYPE_MII_100BASETX_FD,	TULIP_MEDIA_100BASETX_FD,
649 		TULIP_SROM_ATTR_MII },
650     { TULIP_SROM_CONNTYPE_10BASET_NOLINKPASS,	TULIP_MEDIA_10BASET,
651 		TULIP_SROM_ATTR_NOLINKPASS },
652     { TULIP_SROM_CONNTYPE_AUTOSENSE,		TULIP_MEDIA_UNKNOWN,
653 		TULIP_SROM_ATTR_AUTOSENSE },
654     { TULIP_SROM_CONNTYPE_AUTOSENSE_POWERUP,	TULIP_MEDIA_UNKNOWN,
655 		TULIP_SROM_ATTR_AUTOSENSE|TULIP_SROM_ATTR_POWERUP },
656     { TULIP_SROM_CONNTYPE_AUTOSENSE_NWAY,	TULIP_MEDIA_UNKNOWN,
657 		TULIP_SROM_ATTR_AUTOSENSE|TULIP_SROM_ATTR_NWAY },
658     { TULIP_SROM_CONNTYPE_NOT_USED,		TULIP_MEDIA_UNKNOWN }
659 };
660 #define	TULIP_SROM_LASTCONNIDX	(NELEM(tulip_srom_conninfo) - 1)
661 
662 static const struct {
663     tulip_media_t sm_type;
664     tulip_srom_media_t sm_srom_type;
665 } tulip_srom_mediums[] = {
666     { 	TULIP_MEDIA_100BASEFX_FD,	TULIP_SROM_MEDIA_100BASEFX_FD	},
667     {	TULIP_MEDIA_100BASEFX,		TULIP_SROM_MEDIA_100BASEFX	},
668     {	TULIP_MEDIA_100BASET4,		TULIP_SROM_MEDIA_100BASET4	},
669     {	TULIP_MEDIA_100BASETX_FD,	TULIP_SROM_MEDIA_100BASETX_FD	},
670     {	TULIP_MEDIA_100BASETX,		TULIP_SROM_MEDIA_100BASETX	},
671     {	TULIP_MEDIA_10BASET_FD,		TULIP_SROM_MEDIA_10BASET_FD	},
672     {	TULIP_MEDIA_AUI,		TULIP_SROM_MEDIA_AUI		},
673     {	TULIP_MEDIA_BNC,		TULIP_SROM_MEDIA_BNC		},
674     {	TULIP_MEDIA_10BASET,		TULIP_SROM_MEDIA_10BASET	},
675     {	TULIP_MEDIA_UNKNOWN						}
676 };
677 
678 /*
679  * This driver supports a maximum of 32 tulip boards.
680  * This should be enough for the forseeable future.
681  */
682 #define	TULIP_MAX_DEVICES	32
683 
684 #define TULIP_RXDESC_PRESYNC(sc, di, s)		do { } while (0)
685 #define TULIP_RXDESC_POSTSYNC(sc, di, s)	do { } while (0)
686 #define TULIP_RXMAP_PRESYNC(sc, map)		do { } while (0)
687 #define TULIP_RXMAP_POSTSYNC(sc, map)		do { } while (0)
688 #define TULIP_RXMAP_CREATE(sc, mapp)		do { } while (0)
689 
690 #define TULIP_TXDESC_PRESYNC(sc, di, s)		do { } while (0)
691 #define TULIP_TXDESC_POSTSYNC(sc, di, s)	do { } while (0)
692 #define TULIP_TXMAP_PRESYNC(sc, map)		do { } while (0)
693 #define TULIP_TXMAP_POSTSYNC(sc, map)		do { } while (0)
694 #define TULIP_TXMAP_CREATE(sc, mapp)		do { } while (0)
695 
696 #ifdef notyet
697 #define	SIOCGADDRROM		_IOW('i', 240, struct ifreq)	/* get 128 bytes of ROM */
698 #define	SIOCGCHIPID		_IOWR('i', 241, struct ifreq)	/* get chipid */
699 #endif
700 
701 #define	loudprintf			if (bootverbose) kprintf
702 
703 #ifndef	tulip_if
704 #define	tulip_if	tulip_ac.ac_if
705 #endif
706 #ifndef tulip_enaddr
707 #define	tulip_enaddr	tulip_ac.ac_enaddr
708 #endif
709 
710 #if !defined(TULIP_KVATOPHYS)
711 #define	TULIP_KVATOPHYS(sc, va)		vtophys(va)
712 #endif
713 
714 #define	TULIP_MAX_TXSEG		30
715 
716 #endif /* !defined(_DEVAR_H) */
717