1/*	$NetBSD: if_devar.h,v 1.32 1999/04/01 14:55:25 tsubai Exp $	*/
2
3/* $FreeBSD: releng/12.0/sys/dev/de/if_devar.h 331737 2018-03-29 15:58:49Z brooks $ */
4
5/*-
6 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
7 *
8 * Copyright (c) 1994-1997 Matt Thomas (matt@3am-software.com)
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. The name of the author may not be used to endorse or promote products
17 *    derived from this software without specific prior written permission
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Id: if_devar.h,v 1.28 1997/07/03 16:55:07 thomas Exp
31 */
32
33#ifndef DEV_DE_IF_DEVAR_H
34#define DEV_DE_IF_DEVAR_H
35
36typedef bus_addr_t tulip_csrptr_t;
37
38#define	TULIP_PCI_CSRSIZE	8
39#define	TULIP_PCI_CSROFFSET	0
40
41#define TULIP_CSR_READ(sc, csr)			\
42	bus_space_read_4((sc)->tulip_csrs_bst,	\
43			 (sc)->tulip_csrs_bsh,	\
44			 (sc)->tulip_csrs.csr)
45#define TULIP_CSR_WRITE(sc, csr, val)			\
46	bus_space_write_4((sc)->tulip_csrs_bst,		\
47			  (sc)->tulip_csrs_bsh,		\
48			  (sc)->tulip_csrs.csr, val)
49
50/*
51 * This structure contains "pointers" for the registers on
52 * the various 21x4x chips.  CSR0 through CSR8 are common
53 * to all chips.  After that, it gets messy...
54 */
55typedef struct {
56	tulip_csrptr_t	csr_busmode;	/* CSR0 */
57	tulip_csrptr_t	csr_txpoll;	/* CSR1 */
58	tulip_csrptr_t	csr_rxpoll;	/* CSR2 */
59	tulip_csrptr_t	csr_rxlist;	/* CSR3 */
60	tulip_csrptr_t	csr_txlist;	/* CSR4 */
61	tulip_csrptr_t	csr_status;	/* CSR5 */
62	tulip_csrptr_t	csr_command;	/* CSR6 */
63	tulip_csrptr_t	csr_intr;	/* CSR7 */
64	tulip_csrptr_t	csr_missed_frames;	/* CSR8 */
65	tulip_csrptr_t	csr_9;		/* CSR9 */
66	tulip_csrptr_t	csr_10;		/* CSR10 */
67	tulip_csrptr_t	csr_11;		/* CSR11 */
68	tulip_csrptr_t	csr_12;		/* CSR12 */
69	tulip_csrptr_t	csr_13;		/* CSR13 */
70	tulip_csrptr_t	csr_14;		/* CSR14 */
71	tulip_csrptr_t	csr_15;		/* CSR15 */
72} tulip_regfile_t;
73
74#define	csr_enetrom		csr_9	/* 21040 */
75#define	csr_reserved		csr_10	/* 21040 */
76#define	csr_full_duplex		csr_11	/* 21040 */
77#define	csr_bootrom		csr_10	/* 21041/21140A/?? */
78#define	csr_gp			csr_12	/* 21140* */
79#define	csr_watchdog		csr_15	/* 21140* */
80#define	csr_gp_timer		csr_11	/* 21041/21140* */
81#define	csr_srom_mii		csr_9	/* 21041/21140* */
82#define	csr_sia_status		csr_12	/* 2104x */
83#define csr_sia_connectivity	csr_13	/* 2104x */
84#define csr_sia_tx_rx		csr_14	/* 2104x */
85#define csr_sia_general		csr_15	/* 2104x */
86
87/*
88 * While 21x4x allows chaining of its descriptors, this driver
89 * doesn't take advantage of it.  We keep the descriptors in a
90 * traditional FIFO ring.
91 */
92typedef struct {
93	tulip_desc_t	*di_desc;
94	struct mbuf	*di_mbuf;
95	bus_dmamap_t	*di_map;
96} tulip_descinfo_t;
97
98typedef struct {
99	tulip_descinfo_t *ri_first;	/* first entry in ring */
100	tulip_descinfo_t *ri_last;	/* one after last entry */
101	tulip_descinfo_t *ri_nextin;	/* next to processed by host */
102	tulip_descinfo_t *ri_nextout;	/* next to processed by adapter */
103	int		ri_max;
104	int		ri_free;
105	tulip_desc_t	*ri_descs;
106	tulip_descinfo_t *ri_descinfo;
107	bus_dma_tag_t	ri_ring_tag;
108	bus_dmamap_t	ri_ring_map;
109	bus_addr_t	ri_dma_addr;
110	bus_dma_tag_t	ri_data_tag;
111	bus_dmamap_t	*ri_data_maps;
112} tulip_ringinfo_t;
113
114/*
115 * The 21040 has a stupid restriction in that the receive
116 * buffers must be longword aligned.  But since Ethernet
117 * headers are not a multiple of longwords in size this forces
118 * the data to non-longword aligned.  Since IP requires the
119 * data to be longword aligned, we need to copy it after it has
120 * been DMA'ed in our memory.
121 *
122 * Since we have to copy it anyways, we might as well as allocate
123 * dedicated receive space for the input.  This allows to use a
124 * small receive buffer size and more ring entries to be able to
125 * better keep with a flood of tiny Ethernet packets.
126 *
127 * The receive space MUST ALWAYS be a multiple of the page size.
128 * And the number of receive descriptors multiplied by the size
129 * of the receive buffers must equal the receive space.  This
130 * is so that we can manipulate the page tables so that even if a
131 * packet wraps around the end of the receive space, we can
132 * treat it as virtually contiguous.
133 *
134 * The above used to be true (the stupid restriction is still true)
135 * but we gone to directly DMA'ing into MBUFs (unless it's on an
136 * architecture which can't handle unaligned accesses) because with
137 * 100Mb/s cards the copying is just too much of a hit.
138 */
139
140#define	TULIP_TXTIMER		4
141#define	TULIP_RXDESCS		48
142#define	TULIP_TXDESCS		128
143#define	TULIP_RXQ_TARGET	32
144#if TULIP_RXQ_TARGET >= TULIP_RXDESCS
145#error	TULIP_RXQ_TARGET must be less than TULIP_RXDESCS
146#endif
147#define	TULIP_RX_BUFLEN		((MCLBYTES < 2048 ? MCLBYTES : 2048) - 16)
148
149/*
150 * Forward reference to make C happy.
151 */
152typedef struct tulip_softc	tulip_softc_t;
153
154/*
155 * Enumeration of the various controllers supported.
156 */
157typedef enum {
158	TULIP_21040,
159	TULIP_21041,
160	TULIP_21140,
161	TULIP_21140A,
162	TULIP_21142,
163	TULIP_21143,
164	TULIP_CHIPID_UNKNOWN
165} tulip_chipid_t;
166
167/*
168 * Various physical media types supported.
169 * BNCAUI is BNC or AUI since on the 21040 you can't really tell
170 * which is in use.
171 */
172typedef enum {
173	TULIP_MEDIA_UNKNOWN,
174	TULIP_MEDIA_10BASET,
175	TULIP_MEDIA_10BASET_FD,
176	TULIP_MEDIA_BNC,
177	TULIP_MEDIA_AUI,
178	TULIP_MEDIA_EXTSIA,
179	TULIP_MEDIA_AUIBNC,
180	TULIP_MEDIA_100BASETX,
181	TULIP_MEDIA_100BASETX_FD,
182	TULIP_MEDIA_100BASET4,
183	TULIP_MEDIA_100BASEFX,
184	TULIP_MEDIA_100BASEFX_FD,
185	TULIP_MEDIA_MAX
186} tulip_media_t;
187
188#define	TULIP_BIT(b)		(1L << ((int)(b)))
189#define	TULIP_FDBIT(m)		(1L << ((int)TULIP_MEDIA_ ## m ## _FD))
190#define	TULIP_MBIT(m)		(1L << ((int)TULIP_MEDIA_ ## m ))
191#define	TULIP_IS_MEDIA_FD(m)	(TULIP_BIT(m) & \
192				 (TULIP_FDBIT(10BASET) | \
193				  TULIP_FDBIT(100BASETX) | \
194				  TULIP_FDBIT(100BASEFX)))
195#define	TULIP_CAN_MEDIA_FD(m)	(TULIP_BIT(m) & \
196				 (TULIP_MBIT(10BASET) | \
197				  TULIP_MBIT(100BASETX) | \
198				  TULIP_MBIT(100BASEFX)))
199#define	TULIP_FD_MEDIA_OF(m)	((tulip_media_t)((m) + 1))
200#define	TULIP_HD_MEDIA_OF(m)	((tulip_media_t)((m) - 1))
201#define	TULIP_IS_MEDIA_100MB(m)	((m) >= TULIP_MEDIA_100BASETX)
202#define	TULIP_IS_MEDIA_TP(m)	((TULIP_BIT(m) & \
203				  (TULIP_MBIT(BNC) | \
204				   TULIP_MBIT(AUI) | \
205				   TULIP_MBIT(AUIBNC) | \
206				   TULIP_MBIT(EXTSIA))) == 0)
207
208#define	TULIP_SROM_ATTR_MII		0x0100
209#define	TULIP_SROM_ATTR_NWAY		0x0200
210#define	TULIP_SROM_ATTR_AUTOSENSE	0x0400
211#define	TULIP_SROM_ATTR_POWERUP		0x0800
212#define	TULIP_SROM_ATTR_NOLINKPASS	0x1000
213
214typedef struct {
215	enum {
216		TULIP_MEDIAINFO_NONE,
217		TULIP_MEDIAINFO_SIA,
218		TULIP_MEDIAINFO_GPR,
219		TULIP_MEDIAINFO_MII,
220		TULIP_MEDIAINFO_RESET,
221		TULIP_MEDIAINFO_SYM
222	} mi_type;
223	union {
224		struct {
225			u_int16_t sia_connectivity;
226			u_int16_t sia_tx_rx;
227			u_int16_t sia_general;
228			u_int32_t sia_gp_control;	/* 21142/21143 */
229			u_int32_t sia_gp_data;		/* 21142/21143 */
230		} un_sia;
231		struct {
232			u_int32_t gpr_cmdmode;
233			u_int32_t gpr_gpcontrol;	/* 21142/21143 */
234			u_int32_t gpr_gpdata;
235			u_int8_t gpr_actmask;
236			u_int8_t gpr_actdata;
237			u_int gpr_default:1;
238		} un_gpr;
239		struct {
240			u_int32_t mii_mediamask;
241			u_int16_t mii_capabilities;
242			u_int16_t mii_advertisement;
243			u_int16_t mii_full_duplex;
244			u_int16_t mii_tx_threshold;
245			u_int16_t mii_interrupt;	/* 21142/21143 */
246			u_int8_t mii_phyaddr;
247			u_int8_t mii_gpr_length;
248			u_int8_t mii_gpr_offset;
249			u_int8_t mii_reset_length;
250			u_int8_t mii_reset_offset;
251			u_int32_t mii_phyid;
252		} un_mii;
253	} mi_un;
254} tulip_media_info_t;
255
256#define	mi_sia_connectivity	mi_un.un_sia.sia_connectivity
257#define	mi_sia_tx_rx		mi_un.un_sia.sia_tx_rx
258#define mi_sia_general		mi_un.un_sia.sia_general
259#define	mi_sia_gp_control	mi_un.un_sia.sia_gp_control
260#define	mi_sia_gp_data		mi_un.un_sia.sia_gp_data
261
262#define	mi_gpcontrol		mi_un.un_gpr.gpr_gpcontrol
263#define	mi_gpdata		mi_un.un_gpr.gpr_gpdata
264#define	mi_actmask		mi_un.un_gpr.gpr_actmask
265#define	mi_actdata		mi_un.un_gpr.gpr_actdata
266#define	mi_default		mi_un.un_gpr.gpr_default
267#define	mi_cmdmode		mi_un.un_gpr.gpr_cmdmode
268
269#define	mi_phyaddr		mi_un.un_mii.mii_phyaddr
270#define	mi_gpr_length		mi_un.un_mii.mii_gpr_length
271#define	mi_gpr_offset		mi_un.un_mii.mii_gpr_offset
272#define	mi_reset_length		mi_un.un_mii.mii_reset_length
273#define	mi_reset_offset		mi_un.un_mii.mii_reset_offset
274#define	mi_capabilities		mi_un.un_mii.mii_capabilities
275#define	mi_advertisement	mi_un.un_mii.mii_advertisement
276#define	mi_full_duplex		mi_un.un_mii.mii_full_duplex
277#define	mi_tx_threshold		mi_un.un_mii.mii_tx_threshold
278#define	mi_mediamask		mi_un.un_mii.mii_mediamask
279#define	mi_mii_interrupt	mi_un.un_mii.mii_interrupt
280#define	mi_phyid		mi_un.un_mii.mii_phyid
281
282#define	TULIP_MEDIAINFO_SIA_INIT(sc, mi, chipid, media) do {		\
283	(mi)->mi_type = TULIP_MEDIAINFO_SIA;				\
284	sc->tulip_mediums[TULIP_MEDIA_ ## media] = (mi);		\
285	(mi)->mi_sia_connectivity = TULIP_ ## chipid ## _SIACONN_ ## media; \
286	(mi)->mi_sia_tx_rx = TULIP_ ## chipid ## _SIATXRX_ ## media;	\
287	(mi)->mi_sia_general = TULIP_ ## chipid ## _SIAGEN_ ## media;	\
288} while (0)
289
290#define TULIP_MEDIAINFO_ADD_CAPABILITY(sc, mi, media) do {		\
291	if ((sc)->tulip_mediums[TULIP_MEDIA_ ## media] == NULL		\
292	    && ((mi)->mi_capabilities & PHYSTS_ ## media)) {		\
293		(sc)->tulip_mediums[TULIP_MEDIA_ ## media] = (mi);	\
294		(mi)->mi_mediamask |= TULIP_BIT(TULIP_MEDIA_ ## media);	\
295	}								\
296} while (0)
297
298#define	TULIP_MII_NOPHY		32
299/*
300 * Some boards need to treated specially.  The following enumeration
301 * identifies the cards with quirks (or those we just want to single
302 * out for special merit or scorn).
303 */
304typedef enum {
305	TULIP_21040_GENERIC,	/* Generic 21040 (works with most any board) */
306	TULIP_21140_ISV,	/* Digital Semicondutor 21140 ISV SROM Format */
307	TULIP_21142_ISV,	/* Digital Semicondutor 21142 ISV SROM Format */
308	TULIP_21143_ISV,	/* Digital Semicondutor 21143 ISV SROM Format */
309	TULIP_21140_DEC_EB,	/* Digital Semicondutor 21140 Eval. Board */
310	TULIP_21140_MII,	/* 21140[A] with MII */
311	TULIP_21140_DEC_DE500,	/* Digital DE500-?? 10/100 */
312	TULIP_21140_SMC_9332,	/* SMC 9332 */
313	TULIP_21140_COGENT_EM100,	/* Cogent EM100 100 only */
314	TULIP_21140_ZNYX_ZX34X,	/* ZNYX ZX342 10/100 */
315	TULIP_21140_ASANTE,	/* AsanteFast 10/100 */
316	TULIP_21140_EN1207,	/* Accton EN2107 10/100 BNC */
317	TULIP_21041_GENERIC	/* Generic 21041 card */
318} tulip_board_t;
319
320typedef enum {
321	TULIP_MEDIAPOLL_TIMER,		/* 100ms timer fired */
322	TULIP_MEDIAPOLL_FASTTIMER,	/* <100ms timer fired */
323	TULIP_MEDIAPOLL_LINKFAIL,	/* called from interrupt routine */
324	TULIP_MEDIAPOLL_LINKPASS,	/* called from interrupt routine */
325	TULIP_MEDIAPOLL_START,		/* start a media probe (from reset) */
326	TULIP_MEDIAPOLL_TXPROBE_OK,	/* txprobe succeeded */
327	TULIP_MEDIAPOLL_TXPROBE_FAILED,	/* txprobe failed */
328	TULIP_MEDIAPOLL_MAX
329} tulip_mediapoll_event_t;
330
331typedef enum {
332	TULIP_LINK_DOWN,	/* Link is down */
333	TULIP_LINK_UP,		/* link is ok */
334	TULIP_LINK_UNKNOWN	/* we can't tell either way */
335} tulip_link_status_t;
336
337/*
338 * This data structure is used to abstract out the quirks.
339 * media_probe  = tries to determine the media type.
340 * media_select = enables the current media (or autosenses)
341 * media_poll	= autosenses media
342 * media_preset = 21140, etal requires bit to set before the
343 *		  the software reset; hence pre-set.  Should be
344 *		  pre-reset but that's ugly.
345 */
346typedef struct {
347	tulip_board_t bd_type;
348	void (*bd_media_probe)(tulip_softc_t * const sc);
349	void (*bd_media_select)(tulip_softc_t * const sc);
350	void (*bd_media_poll)(tulip_softc_t * const sc,
351    tulip_mediapoll_event_t event);
352	void (*bd_media_preset) (tulip_softc_t * const sc);
353} tulip_boardsw_t;
354
355/*
356 * The next few declarations are for MII/PHY based boards.
357 *
358 *    The first enumeration identifies a superset of various datums
359 * that can be obtained from various PHY chips.  Not all PHYs will
360 * support all datums.
361 *    The modedata structure indicates what register contains
362 * a datum, what mask is applied the register contents, and what the
363 * result should be.
364 *    The attr structure records information about a supported PHY.
365 *    The phy structure records information about a PHY instance.
366 */
367typedef enum {
368	PHY_MODE_10T,
369	PHY_MODE_100TX,
370	PHY_MODE_100T4,
371	PHY_MODE_FULLDUPLEX,
372	PHY_MODE_MAX
373} tulip_phy_mode_t;
374
375typedef struct {
376	u_int16_t	pm_regno;
377	u_int16_t	pm_mask;
378	u_int16_t	pm_value;
379} tulip_phy_modedata_t;
380
381typedef struct {
382	u_int32_t	attr_id;
383	u_int16_t	attr_flags;
384	tulip_phy_modedata_t	attr_modes[PHY_MODE_MAX];
385#ifdef TULIP_DEBUG
386	const char	*attr_name;
387#endif
388} tulip_phy_attr_t;
389
390/* Definitions for tulip_phy_attr_t.attr_flags */
391#define	PHY_NEED_HARD_RESET	0x0001
392#define	PHY_DUAL_CYCLE_TA	0x0002
393
394/*
395 * Various probe states used when trying to autosense the media.
396 */
397typedef enum {
398	TULIP_PROBE_INACTIVE,
399	TULIP_PROBE_PHYRESET,
400	TULIP_PROBE_PHYAUTONEG,
401	TULIP_PROBE_GPRTEST,
402	TULIP_PROBE_MEDIATEST,
403	TULIP_PROBE_FAILED
404} tulip_probe_state_t;
405
406typedef struct {
407	/*
408	 * Transmit Statistics
409	 */
410	u_int32_t	dot3StatsSingleCollisionFrames;
411	u_int32_t	dot3StatsMultipleCollisionFrames;
412	u_int32_t	dot3StatsSQETestErrors;
413	u_int32_t	dot3StatsDeferredTransmissions;
414	u_int32_t	dot3StatsLateCollisions;
415	u_int32_t	dot3StatsExcessiveCollisions;
416	u_int32_t	dot3StatsCarrierSenseErrors;
417	u_int32_t	dot3StatsInternalMacTransmitErrors;
418	/* not in rfc1650! */
419	u_int32_t	dot3StatsInternalTransmitUnderflows;
420	/* not in rfc1650! */
421	u_int32_t	dot3StatsInternalTransmitBabbles;
422	/*
423	 * Receive Statistics
424	 */
425	u_int32_t	dot3StatsMissedFrames;	/* not in rfc1650! */
426	u_int32_t	dot3StatsAlignmentErrors;
427	u_int32_t	dot3StatsFCSErrors;
428	u_int32_t	dot3StatsFrameTooLongs;
429	u_int32_t	dot3StatsInternalMacReceiveErrors;
430} tulip_dot3_stats_t;
431
432/*
433 * Probe information.
434 */
435struct tulip_probe_info {
436	u_int8_t	probe_count;		/* count of probe operations */
437	int32_t		probe_timeout;		/* time (ms) of probe timeout */
438	tulip_probe_state_t	probe_state;	/* current media probe state */
439	tulip_media_t	probe_media;		/* current media being probed */
440	u_int32_t	probe_mediamask;	/* medias checked */
441	u_int32_t	probe_passes;		/* times autosense failed */
442	u_int32_t	probe_txprobes;		/* txprobes attempted */
443};
444
445/*
446 * Debugging/Statistical information.
447 */
448struct tulip_dbg_info {
449	tulip_media_t	dbg_last_media;
450	u_int32_t	dbg_intrs;
451	u_int32_t	dbg_media_probes;
452	u_int32_t	dbg_txprobe_nocarr;
453	u_int32_t	dbg_txprobe_exccoll;
454	u_int32_t	dbg_link_downed;
455	u_int32_t	dbg_link_suspected;
456	u_int32_t	dbg_link_intrs;
457	u_int32_t	dbg_link_pollintrs;
458	u_int32_t	dbg_link_failures;
459	u_int32_t	dbg_nway_starts;
460	u_int32_t	dbg_nway_failures;
461	u_int16_t	dbg_phyregs[32][4];
462	u_int32_t	dbg_rxlowbufs;
463	u_int32_t	dbg_rxintrs;
464	u_int32_t	dbg_last_rxintrs;
465	u_int32_t	dbg_high_rxintrs_hz;
466	u_int32_t	dbg_no_txmaps;
467	u_int32_t	dbg_txput_finishes[8];
468	u_int32_t	dbg_txprobes_ok[TULIP_MEDIA_MAX];
469	u_int32_t	dbg_txprobes_failed[TULIP_MEDIA_MAX];
470	u_int32_t	dbg_events[TULIP_MEDIAPOLL_MAX];
471	u_int32_t	dbg_rxpktsperintr[TULIP_RXDESCS];
472};
473
474/*
475 * Performance statistics.
476 */
477struct tulip_perfstat {
478	u_quad_t	perf_intr_cycles;
479	u_quad_t	perf_ifstart_cycles;
480	u_quad_t	perf_ifstart_one_cycles;
481	u_quad_t	perf_ifioctl_cycles;
482	u_quad_t	perf_stat_cycles;
483	u_quad_t	perf_timeout_cycles;
484	u_quad_t	perf_txput_cycles;
485	u_quad_t	perf_txintr_cycles;
486	u_quad_t	perf_rxintr_cycles;
487	u_quad_t	perf_rxget_cycles;
488	unsigned int	perf_intr;
489	unsigned int	perf_ifstart;
490	unsigned int	perf_ifstart_one;
491	unsigned int	perf_ifioctl;
492	unsigned int	perf_stat;
493	unsigned int	perf_timeout;
494	unsigned int	perf_txput;
495	unsigned int	perf_txintr;
496	unsigned int	perf_rxintr;
497	unsigned int	perf_rxget;
498};
499#define	TULIP_PERF_CURRENT	0
500#define	TULIP_PERF_PREVIOUS	1
501#define	TULIP_PERF_TOTAL	2
502#define	TULIP_PERF_MAX		3
503
504/*
505 * Per-driver-instance state.
506 */
507struct tulip_softc {
508	device_t		tulip_dev;
509	struct ifmedia		tulip_ifmedia;
510	int			tulip_unit;
511	struct ifnet		*tulip_ifp;
512	u_char			tulip_enaddr[ETHER_ADDR_LEN];
513	bus_space_tag_t		tulip_csrs_bst;
514	bus_space_handle_t	tulip_csrs_bsh;
515	tulip_regfile_t		tulip_csrs;
516
517	u_int32_t		tulip_flags;
518	u_int32_t		tulip_features;
519	u_int32_t		tulip_intrmask;
520	u_int32_t		tulip_cmdmode;
521	u_int32_t		tulip_last_system_error:3;
522	u_int32_t		tulip_txtimer:3;	/* transmission timer */
523	u_int32_t		tulip_system_errors;
524	u_int32_t		tulip_statusbits;	/* status bits from
525							 * CSR5 that may need
526							 * to be printed
527							 */
528	tulip_media_info_t	*tulip_mediums[TULIP_MEDIA_MAX];
529	tulip_media_t		tulip_media;		/* current media type */
530	u_int32_t		tulip_abilities;	/* remote system's
531							 * abilities (as
532							 * defined in IEEE
533							 * 802.3u)
534							 */
535	u_int8_t		tulip_revinfo;		/* chip revision */
536	u_int8_t		tulip_phyaddr;		/* current phy */
537	u_int8_t		tulip_gpinit;		/* active pins on
538							 * 21140
539							 */
540	u_int8_t		tulip_gpdata;	/* default gpdata for 21140 */
541	struct tulip_probe_info	tulip_probe;
542	tulip_chipid_t		tulip_chipid;	/* type of chip we are using */
543	const tulip_boardsw_t	*tulip_boardsw;	/* board/chip characteristics */
544	tulip_softc_t		*tulip_slaves;	/* slaved devices (ZX3xx) */
545#if defined(TULIP_DEBUG)
546	struct tulip_dbg_info	tulip_dbg;
547#endif
548#if defined(TULIP_PERFSTATS)
549	struct tulip_perfstat	tulip_perfstats[TULIP_PERF_MAX];
550#endif
551	tulip_dot3_stats_t	tulip_dot3stats;
552	tulip_ringinfo_t	tulip_rxinfo;
553	tulip_ringinfo_t	tulip_txinfo;
554	tulip_media_info_t	tulip_mediainfo[10];
555	/*
556	 * The setup buffers for sending the setup frame to the chip. one is
557	 * the one being sent while the other is the one being filled.
558	 */
559	bus_dma_tag_t		tulip_setup_tag;
560	bus_dmamap_t		tulip_setup_map;
561	bus_addr_t		tulip_setup_dma_addr;
562	u_int32_t		*tulip_setupbuf;
563	u_int32_t		tulip_setupdata[192 / sizeof(u_int32_t)];
564	char			tulip_boardid[24];
565	u_int8_t		tulip_rombuf[128];	/* must be aligned */
566
567	/* needed for multiport boards */
568	u_int8_t		tulip_pci_busno;
569	u_int8_t		tulip_pci_devno;
570
571	u_int8_t		tulip_connidx;
572	tulip_srom_connection_t	tulip_conntype;
573	struct callout		tulip_callout;
574	struct mtx		tulip_mutex;
575	struct callout	tulip_stat_timer;
576};
577
578#define	tulip_curperfstats	tulip_perfstats[TULIP_PERF_CURRENT]
579#define	tulip_probe_count	tulip_probe.probe_count
580#define	tulip_probe_timeout	tulip_probe.probe_timeout
581#define	tulip_probe_state	tulip_probe.probe_state
582#define	tulip_probe_media	tulip_probe.probe_media
583#define	tulip_probe_mediamask	tulip_probe.probe_mediamask
584#define	tulip_probe_passes	tulip_probe.probe_passes
585
586/* Definitions for tulip_flags. */
587#define	TULIP_WANTSETUP		0x00000001
588#define	TULIP_WANTHASHPERFECT	0x00000002
589#define	TULIP_WANTHASHONLY	0x00000004
590#define	TULIP_DOINGSETUP	0x00000008
591#define	TULIP_PRINTMEDIA	0x00000010
592#define	TULIP_TXPROBE_ACTIVE	0x00000020
593#define	TULIP_ALLMULTI		0x00000040
594#define	TULIP_WANTRXACT		0x00000080
595#define	TULIP_RXACT		0x00000100
596#define	TULIP_INRESET		0x00000200
597#define	TULIP_NEEDRESET		0x00000400
598#define	TULIP_SQETEST		0x00000800
599#define	TULIP_xxxxxx0		0x00001000
600#define	TULIP_xxxxxx1		0x00002000
601#define	TULIP_WANTTXSTART	0x00004000
602#define	TULIP_NEWTXTHRESH	0x00008000
603#define	TULIP_NOAUTOSENSE	0x00010000
604#define	TULIP_PRINTLINKUP	0x00020000
605#define	TULIP_LINKUP		0x00040000
606#define	TULIP_RXBUFSLOW		0x00080000
607#define	TULIP_NOMESSAGES	0x00100000
608#define	TULIP_SYSTEMERROR	0x00200000
609#define	TULIP_TIMEOUTPENDING	0x00400000
610#define	TULIP_xxxxxx2		0x00800000
611#define	TULIP_TRYNWAY		0x01000000
612#define	TULIP_DIDNWAY		0x02000000
613#define	TULIP_RXIGNORE		0x04000000
614#define	TULIP_PROBE1STPASS	0x08000000
615#define	TULIP_DEVICEPROBE	0x10000000
616#define	TULIP_PROMISC		0x20000000
617#define	TULIP_HASHONLY		0x40000000
618#define	TULIP_xxxxxx3		0x80000000
619
620/* Definitions for tulip_features. */
621#define	TULIP_HAVE_GPR		0x00000001	/* have gp register (140[A]) */
622#define	TULIP_HAVE_RXBADOVRFLW	0x00000002	/* RX corrupts on overflow */
623#define	TULIP_HAVE_POWERMGMT	0x00000004	/* Snooze/sleep modes */
624#define	TULIP_HAVE_MII		0x00000008	/* Some medium on MII */
625#define	TULIP_HAVE_SIANWAY	0x00000010	/* SIA does NWAY */
626#define	TULIP_HAVE_DUALSENSE	0x00000020	/* SIA senses both AUI & TP */
627#define	TULIP_HAVE_SIAGP	0x00000040	/* SIA has a GP port */
628#define	TULIP_HAVE_BROKEN_HASH	0x00000080	/* Broken Multicast Hash */
629#define	TULIP_HAVE_ISVSROM	0x00000100	/* uses ISV SROM Format */
630#define	TULIP_HAVE_BASEROM	0x00000200	/* Board ROM can be cloned */
631#define	TULIP_HAVE_SLAVEDROM	0x00000400	/* Board ROM cloned */
632#define	TULIP_HAVE_SLAVEDINTR	0x00000800	/* Board slaved interrupt */
633#define	TULIP_HAVE_SHAREDINTR	0x00001000	/* Board shares interrupts */
634#define	TULIP_HAVE_OKROM	0x00002000	/* ROM was recognized */
635#define	TULIP_HAVE_NOMEDIA	0x00004000	/* did not detect any media */
636#define	TULIP_HAVE_STOREFWD	0x00008000	/* have CMD_STOREFWD */
637#define	TULIP_HAVE_SIA100	0x00010000	/* has LS100 in SIA status */
638#define	TULIP_HAVE_OKSROM	0x00020000	/* SROM CRC is OK */
639
640#define	TULIP_DO_AUTOSENSE(sc)	\
641	(IFM_SUBTYPE((sc)->tulip_ifmedia.ifm_media) == IFM_AUTO)
642
643#if defined(TULIP_HDR_DATA)
644static const char *const tulip_chipdescs[] = {
645	"21040 [10Mb/s]",
646	"21041 [10Mb/s]",
647	"21140 [10-100Mb/s]",
648	"21140A [10-100Mb/s]",
649	"21142 [10-100Mb/s]",
650	"21143 [10-100Mb/s]",
651};
652
653static const char *const tulip_mediums[] = {
654	"unknown",		/* TULIP_MEDIA_UNKNOWN */
655	"10baseT",		/* TULIP_MEDIA_10BASET */
656	"Full Duplex 10baseT",	/* TULIP_MEDIA_10BASET_FD */
657	"BNC",			/* TULIP_MEDIA_BNC */
658	"AUI",			/* TULIP_MEDIA_AUI */
659	"External SIA",		/* TULIP_MEDIA_EXTSIA */
660	"AUI/BNC",		/* TULIP_MEDIA_AUIBNC */
661	"100baseTX",		/* TULIP_MEDIA_100BASET */
662	"Full Duplex 100baseTX",/* TULIP_MEDIA_100BASET_FD */
663	"100baseT4",		/* TULIP_MEDIA_100BASET4 */
664	"100baseFX",		/* TULIP_MEDIA_100BASEFX */
665	"Full Duplex 100baseFX",/* TULIP_MEDIA_100BASEFX_FD */
666};
667
668static const int tulip_media_to_ifmedia[] = {
669	IFM_ETHER | IFM_NONE,		/* TULIP_MEDIA_UNKNOWN */
670	IFM_ETHER | IFM_10_T,		/* TULIP_MEDIA_10BASET */
671	IFM_ETHER | IFM_10_T | IFM_FDX,	/* TULIP_MEDIA_10BASET_FD */
672	IFM_ETHER | IFM_10_2,		/* TULIP_MEDIA_BNC */
673	IFM_ETHER | IFM_10_5,		/* TULIP_MEDIA_AUI */
674	IFM_ETHER | IFM_MANUAL,		/* TULIP_MEDIA_EXTSIA */
675	IFM_ETHER | IFM_10_5,		/* TULIP_MEDIA_AUIBNC */
676	IFM_ETHER | IFM_100_TX,		/* TULIP_MEDIA_100BASET */
677	IFM_ETHER | IFM_100_TX | IFM_FDX,	/* TULIP_MEDIA_100BASET_FD */
678	IFM_ETHER | IFM_100_T4,		/* TULIP_MEDIA_100BASET4 */
679	IFM_ETHER | IFM_100_FX,		/* TULIP_MEDIA_100BASEFX */
680	IFM_ETHER | IFM_100_FX | IFM_FDX,	/* TULIP_MEDIA_100BASEFX_FD */
681};
682
683static const char *const tulip_system_errors[] = {
684	"parity error",
685	"master abort",
686	"target abort",
687	"reserved #3",
688	"reserved #4",
689	"reserved #5",
690	"reserved #6",
691	"reserved #7",
692};
693
694static const char *const tulip_status_bits[] = {
695	NULL,
696	"transmit process stopped",
697	NULL,
698	"transmit jabber timeout",
699
700	NULL,
701	"transmit underflow",
702	NULL,
703	"receive underflow",
704
705	"receive process stopped",
706	"receive watchdog timeout",
707	NULL,
708	NULL,
709
710	"link failure",
711	NULL,
712	NULL,
713};
714
715static const struct {
716	tulip_srom_connection_t sc_type;
717	tulip_media_t sc_media;
718	u_int32_t sc_attrs;
719} tulip_srom_conninfo[] = {
720	{
721		TULIP_SROM_CONNTYPE_10BASET, TULIP_MEDIA_10BASET
722	},
723	{
724		TULIP_SROM_CONNTYPE_BNC, TULIP_MEDIA_BNC
725	},
726	{
727		TULIP_SROM_CONNTYPE_AUI, TULIP_MEDIA_AUI
728	},
729	{
730		TULIP_SROM_CONNTYPE_100BASETX, TULIP_MEDIA_100BASETX
731	},
732	{
733		TULIP_SROM_CONNTYPE_100BASET4, TULIP_MEDIA_100BASET4
734	},
735	{
736		TULIP_SROM_CONNTYPE_100BASEFX, TULIP_MEDIA_100BASEFX
737	},
738	{
739		TULIP_SROM_CONNTYPE_MII_10BASET, TULIP_MEDIA_10BASET,
740		TULIP_SROM_ATTR_MII
741	},
742	{
743		TULIP_SROM_CONNTYPE_MII_100BASETX, TULIP_MEDIA_100BASETX,
744		TULIP_SROM_ATTR_MII
745	},
746	{
747		TULIP_SROM_CONNTYPE_MII_100BASET4, TULIP_MEDIA_100BASET4,
748		TULIP_SROM_ATTR_MII
749	},
750	{
751		TULIP_SROM_CONNTYPE_MII_100BASEFX, TULIP_MEDIA_100BASEFX,
752		TULIP_SROM_ATTR_MII
753	},
754	{
755		TULIP_SROM_CONNTYPE_10BASET_NWAY, TULIP_MEDIA_10BASET,
756		TULIP_SROM_ATTR_NWAY
757	},
758	{
759		TULIP_SROM_CONNTYPE_10BASET_FD, TULIP_MEDIA_10BASET_FD
760	},
761	{
762		TULIP_SROM_CONNTYPE_MII_10BASET_FD, TULIP_MEDIA_10BASET_FD,
763		TULIP_SROM_ATTR_MII
764	},
765	{
766		TULIP_SROM_CONNTYPE_100BASETX_FD, TULIP_MEDIA_100BASETX_FD
767	},
768	{
769		TULIP_SROM_CONNTYPE_MII_100BASETX_FD, TULIP_MEDIA_100BASETX_FD,
770		TULIP_SROM_ATTR_MII
771	},
772	{
773		TULIP_SROM_CONNTYPE_10BASET_NOLINKPASS, TULIP_MEDIA_10BASET,
774		TULIP_SROM_ATTR_NOLINKPASS
775	},
776	{
777		TULIP_SROM_CONNTYPE_AUTOSENSE, TULIP_MEDIA_UNKNOWN,
778		TULIP_SROM_ATTR_AUTOSENSE
779	},
780	{
781		TULIP_SROM_CONNTYPE_AUTOSENSE_POWERUP, TULIP_MEDIA_UNKNOWN,
782		TULIP_SROM_ATTR_AUTOSENSE | TULIP_SROM_ATTR_POWERUP
783	},
784	{
785		TULIP_SROM_CONNTYPE_AUTOSENSE_NWAY, TULIP_MEDIA_UNKNOWN,
786		TULIP_SROM_ATTR_AUTOSENSE | TULIP_SROM_ATTR_NWAY
787	},
788	{
789		TULIP_SROM_CONNTYPE_NOT_USED, TULIP_MEDIA_UNKNOWN
790	}
791};
792#define	TULIP_SROM_LASTCONNIDX	\
793		(sizeof(tulip_srom_conninfo)/sizeof(tulip_srom_conninfo[0]) - 1)
794
795static const struct {
796	tulip_media_t sm_type;
797	tulip_srom_media_t sm_srom_type;
798} tulip_srom_mediums[] = {
799	{
800		TULIP_MEDIA_100BASEFX_FD, TULIP_SROM_MEDIA_100BASEFX_FD
801	},
802	{
803		TULIP_MEDIA_100BASEFX, TULIP_SROM_MEDIA_100BASEFX
804	},
805	{
806		TULIP_MEDIA_100BASET4, TULIP_SROM_MEDIA_100BASET4
807	},
808	{
809		TULIP_MEDIA_100BASETX_FD, TULIP_SROM_MEDIA_100BASETX_FD
810	},
811	{
812		TULIP_MEDIA_100BASETX, TULIP_SROM_MEDIA_100BASETX
813	},
814	{
815		TULIP_MEDIA_10BASET_FD, TULIP_SROM_MEDIA_10BASET_FD
816	},
817	{
818		TULIP_MEDIA_AUI, TULIP_SROM_MEDIA_AUI
819	},
820	{
821		TULIP_MEDIA_BNC, TULIP_SROM_MEDIA_BNC
822	},
823	{
824		TULIP_MEDIA_10BASET, TULIP_SROM_MEDIA_10BASET
825	},
826	{
827		TULIP_MEDIA_UNKNOWN
828	}
829};
830
831#endif				/* TULIP_HDR_DATA */
832
833/*
834 * Macro to encode 16 bits of a MAC address into the setup buffer.  Since
835 * we are casting the two bytes in the char array to a uint16 and then
836 * handing them to this macro, we don't need to swap the bytes in the big
837 * endian case, just shift them left 16.
838 */
839#if BYTE_ORDER == BIG_ENDIAN
840#define	TULIP_SP_MAC(x)		((x) << 16)
841#else
842#define	TULIP_SP_MAC(x)		(x)
843#endif
844
845/*
846 * This driver supports a maximum of 32 tulip boards.
847 * This should be enough for the foreseeable future.
848 */
849#define	TULIP_MAX_DEVICES	32
850
851#define	_TULIP_DESC_SYNC(ri, op)					\
852	bus_dmamap_sync((ri)->ri_ring_tag, (ri)->ri_ring_map, (op))
853#define	_TULIP_MAP_SYNC(ri, di, op)					\
854	bus_dmamap_sync((ri)->ri_data_tag, *(di)->di_map, (op))
855
856/*
857 * Descriptors are both read from and written to by the card (corresponding
858 * to DMA WRITE and READ operations in bus-dma speak).  Receive maps are
859 * written to by the card (a DMA READ operation in bus-dma) and transmit
860 * buffers are read from by the card (a DMA WRITE operation in bus-dma).
861 */
862#define TULIP_RXDESC_PRESYNC(ri)					\
863	_TULIP_DESC_SYNC(ri, BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE)
864#define TULIP_RXDESC_POSTSYNC(ri)					\
865	_TULIP_DESC_SYNC(ri, BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE)
866#define	TULIP_RXMAP_PRESYNC(ri, di)					\
867	_TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_PREREAD)
868#define	TULIP_RXMAP_POSTSYNC(ri, di)					\
869	_TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_POSTREAD)
870#define TULIP_TXDESC_PRESYNC(ri)					\
871	_TULIP_DESC_SYNC(ri, BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE)
872#define TULIP_TXDESC_POSTSYNC(ri)					\
873	_TULIP_DESC_SYNC(ri, BUS_DMASYNC_POSTREAD|BUS_DMASYNC_POSTWRITE)
874#define	TULIP_TXMAP_PRESYNC(ri, di)					\
875	_TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_PREWRITE)
876#define	TULIP_TXMAP_POSTSYNC(ri, di)					\
877	_TULIP_MAP_SYNC(ri, di, BUS_DMASYNC_POSTWRITE)
878
879#if defined(TULIP_HDR_DATA)
880static tulip_softc_t	*tulips[TULIP_MAX_DEVICES];
881#endif
882
883#define	loudprintf			if (bootverbose) printf
884
885#if defined(TULIP_PERFSTATS)
886#define	TULIP_PERFMERGE(sc, member) \
887	do { (sc)->tulip_perfstats[TULIP_PERF_TOTAL].member \
888	     += (sc)->tulip_perfstats[TULIP_PERF_CURRENT].member; \
889	 (sc)->tulip_perfstats[TULIP_PERF_PREVIOUS].member \
890	      = (sc)->tulip_perfstats[TULIP_PERF_CURRENT].member; \
891	    (sc)->tulip_perfstats[TULIP_PERF_CURRENT].member = 0; } while (0)
892#define	TULIP_PERFSTART(name) const tulip_cycle_t perfstart_ ## name = TULIP_PERFREAD();
893#define	TULIP_PERFEND(name)	do { \
894	    (sc)->tulip_curperfstats.perf_ ## name ## _cycles += TULIP_PERFDIFF(perfstart_ ## name, TULIP_PERFREAD()); \
895	    (sc)->tulip_curperfstats.perf_ ## name ++; \
896	} while (0)
897
898typedef u_long tulip_cycle_t;
899
900static __inline tulip_cycle_t
901TULIP_PERFREAD(void)
902{
903	return (get_cyclecount());
904}
905
906#define	TULIP_PERFDIFF(s, f)	((f) - (s))
907#else
908#define	TULIP_PERFSTART(name)
909#define	TULIP_PERFEND(name)	do { } while (0)
910#define	TULIP_PERFMERGE(s,n)	do { } while (0)
911#endif	/* TULIP_PERFSTATS */
912
913#define	TULIP_CRC32_POLY	0xEDB88320UL	/* CRC-32 Poly -- Little
914						 * Endian */
915#define	TULIP_MAX_TXSEG		30
916#define	TULIP_MAX_FRAGS		2
917
918#define	TULIP_ADDREQUAL(a1, a2) \
919	(((u_int16_t *)a1)[0] == ((u_int16_t *)a2)[0] \
920	 && ((u_int16_t *)a1)[1] == ((u_int16_t *)a2)[1] \
921	 && ((u_int16_t *)a1)[2] == ((u_int16_t *)a2)[2])
922#define	TULIP_ADDRBRDCST(a1) \
923	(((u_int16_t *)a1)[0] == 0xFFFFU \
924	 && ((u_int16_t *)a1)[1] == 0xFFFFU \
925	 && ((u_int16_t *)a1)[2] == 0xFFFFU)
926
927#define	TULIP_MUTEX(sc)		(&(sc)->tulip_mutex)
928#define	TULIP_LOCK(sc)		mtx_lock(TULIP_MUTEX(sc))
929#define	TULIP_UNLOCK(sc)	mtx_unlock(TULIP_MUTEX(sc))
930#define	TULIP_LOCK_ASSERT(sc)	mtx_assert(TULIP_MUTEX(sc), MA_OWNED)
931
932#endif	/* DEV_DE_IF_DEVAR_H */
933