Home | History | Annotate | Line # | Download | only in ic
tulipvar.h revision 1.39
      1  1.39    enami /*	$NetBSD: tulipvar.h,v 1.39 2000/10/09 12:54:28 enami Exp $	*/
      2   1.1  thorpej 
      3   1.1  thorpej /*-
      4  1.24  thorpej  * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
      5   1.1  thorpej  * All rights reserved.
      6   1.1  thorpej  *
      7   1.1  thorpej  * This code is derived from software contributed to The NetBSD Foundation
      8   1.1  thorpej  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
      9   1.1  thorpej  * NASA Ames Research Center.
     10   1.1  thorpej  *
     11   1.1  thorpej  * Redistribution and use in source and binary forms, with or without
     12   1.1  thorpej  * modification, are permitted provided that the following conditions
     13   1.1  thorpej  * are met:
     14   1.1  thorpej  * 1. Redistributions of source code must retain the above copyright
     15   1.1  thorpej  *    notice, this list of conditions and the following disclaimer.
     16   1.1  thorpej  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.1  thorpej  *    notice, this list of conditions and the following disclaimer in the
     18   1.1  thorpej  *    documentation and/or other materials provided with the distribution.
     19   1.1  thorpej  * 3. All advertising materials mentioning features or use of this software
     20   1.1  thorpej  *    must display the following acknowledgement:
     21   1.1  thorpej  *	This product includes software developed by the NetBSD
     22   1.1  thorpej  *	Foundation, Inc. and its contributors.
     23   1.1  thorpej  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24   1.1  thorpej  *    contributors may be used to endorse or promote products derived
     25   1.1  thorpej  *    from this software without specific prior written permission.
     26   1.1  thorpej  *
     27   1.1  thorpej  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28   1.1  thorpej  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29   1.1  thorpej  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30   1.1  thorpej  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31   1.1  thorpej  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32   1.1  thorpej  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33   1.1  thorpej  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34   1.1  thorpej  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35   1.1  thorpej  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36   1.1  thorpej  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37   1.1  thorpej  * POSSIBILITY OF SUCH DAMAGE.
     38   1.1  thorpej  */
     39   1.1  thorpej 
     40   1.1  thorpej #ifndef _DEV_IC_TULIPVAR_H_
     41  1.15    enami #define	_DEV_IC_TULIPVAR_H_
     42   1.1  thorpej 
     43   1.1  thorpej #include <sys/queue.h>
     44  1.32  thorpej #include <sys/callout.h>
     45   1.1  thorpej 
     46   1.1  thorpej /*
     47   1.1  thorpej  * Misc. definitions for the Digital Semiconductor ``Tulip'' (21x4x)
     48   1.1  thorpej  * Ethernet controller family driver.
     49   1.1  thorpej  */
     50   1.1  thorpej 
     51   1.1  thorpej /*
     52   1.1  thorpej  * Transmit descriptor list size.  This is arbitrary, but allocate
     53   1.1  thorpej  * enough descriptors for 64 pending transmissions and 16 segments
     54   1.1  thorpej  * per packet.  Since a descriptor holds 2 buffer addresses, that's
     55   1.1  thorpej  * 8 descriptors per packet.  This MUST work out to a power of 2.
     56   1.1  thorpej  */
     57   1.1  thorpej #define	TULIP_NTXSEGS		16
     58   1.1  thorpej 
     59   1.1  thorpej #define	TULIP_TXQUEUELEN	64
     60   1.1  thorpej #define	TULIP_NTXDESC		(TULIP_TXQUEUELEN * TULIP_NTXSEGS)
     61   1.1  thorpej #define	TULIP_NTXDESC_MASK	(TULIP_NTXDESC - 1)
     62   1.1  thorpej #define	TULIP_NEXTTX(x)		((x + 1) & TULIP_NTXDESC_MASK)
     63   1.1  thorpej 
     64   1.1  thorpej /*
     65   1.1  thorpej  * Receive descriptor list size.  We have one Rx buffer per incoming
     66   1.1  thorpej  * packet, so this logic is a little simpler.
     67   1.1  thorpej  */
     68   1.1  thorpej #define	TULIP_NRXDESC		64
     69   1.1  thorpej #define	TULIP_NRXDESC_MASK	(TULIP_NRXDESC - 1)
     70   1.1  thorpej #define	TULIP_NEXTRX(x)		((x + 1) & TULIP_NRXDESC_MASK)
     71   1.1  thorpej 
     72   1.1  thorpej /*
     73   1.1  thorpej  * Control structures are DMA'd to the TULIP chip.  We allocate them in
     74   1.1  thorpej  * a single clump that maps to a single DMA segment to make several things
     75   1.1  thorpej  * easier.
     76   1.1  thorpej  */
     77   1.1  thorpej struct tulip_control_data {
     78   1.1  thorpej 	/*
     79   1.1  thorpej 	 * The transmit descriptors.
     80   1.1  thorpej 	 */
     81   1.1  thorpej 	struct tulip_desc tcd_txdescs[TULIP_NTXDESC];
     82   1.1  thorpej 
     83   1.1  thorpej 	/*
     84   1.1  thorpej 	 * The receive descriptors.
     85   1.1  thorpej 	 */
     86   1.1  thorpej 	struct tulip_desc tcd_rxdescs[TULIP_NRXDESC];
     87   1.1  thorpej 
     88   1.1  thorpej 	/*
     89   1.1  thorpej 	 * The setup packet.
     90   1.1  thorpej 	 */
     91   1.1  thorpej 	u_int32_t tcd_setup_packet[TULIP_SETUP_PACKET_LEN / sizeof(u_int32_t)];
     92   1.1  thorpej };
     93   1.1  thorpej 
     94   1.1  thorpej #define	TULIP_CDOFF(x)		offsetof(struct tulip_control_data, x)
     95   1.1  thorpej #define	TULIP_CDTXOFF(x)	TULIP_CDOFF(tcd_txdescs[(x)])
     96   1.1  thorpej #define	TULIP_CDRXOFF(x)	TULIP_CDOFF(tcd_rxdescs[(x)])
     97   1.1  thorpej #define	TULIP_CDSPOFF		TULIP_CDOFF(tcd_setup_packet)
     98   1.1  thorpej 
     99   1.1  thorpej /*
    100   1.1  thorpej  * Software state for transmit jobs.
    101   1.1  thorpej  */
    102   1.1  thorpej struct tulip_txsoft {
    103   1.1  thorpej 	struct mbuf *txs_mbuf;		/* head of our mbuf chain */
    104   1.1  thorpej 	bus_dmamap_t txs_dmamap;	/* our DMA map */
    105   1.1  thorpej 	int txs_firstdesc;		/* first descriptor in packet */
    106   1.1  thorpej 	int txs_lastdesc;		/* last descriptor in packet */
    107  1.26  thorpej 	int txs_ndescs;			/* number of descriptors */
    108   1.1  thorpej 	SIMPLEQ_ENTRY(tulip_txsoft) txs_q;
    109   1.1  thorpej };
    110   1.1  thorpej 
    111   1.1  thorpej SIMPLEQ_HEAD(tulip_txsq, tulip_txsoft);
    112   1.1  thorpej 
    113   1.1  thorpej /*
    114   1.1  thorpej  * Software state for receive jobs.
    115   1.1  thorpej  */
    116   1.1  thorpej struct tulip_rxsoft {
    117   1.1  thorpej 	struct mbuf *rxs_mbuf;		/* head of our mbuf chain */
    118   1.1  thorpej 	bus_dmamap_t rxs_dmamap;	/* our DMA map */
    119   1.1  thorpej };
    120   1.1  thorpej 
    121   1.1  thorpej /*
    122   1.1  thorpej  * Type of Tulip chip we're dealing with.
    123   1.1  thorpej  */
    124   1.1  thorpej typedef enum {
    125   1.1  thorpej 	TULIP_CHIP_INVALID   = 0,	/* invalid chip type */
    126   1.1  thorpej 	TULIP_CHIP_DE425     = 1,	/* DE-425 EISA */
    127   1.1  thorpej 	TULIP_CHIP_21040     = 2,	/* DECchip 21040 */
    128   1.1  thorpej 	TULIP_CHIP_21041     = 3,	/* DECchip 21041 */
    129   1.1  thorpej 	TULIP_CHIP_21140     = 4,	/* DECchip 21140 */
    130   1.1  thorpej 	TULIP_CHIP_21140A    = 5,	/* DECchip 21140A */
    131   1.1  thorpej 	TULIP_CHIP_21142     = 6,	/* DECchip 21142 */
    132   1.1  thorpej 	TULIP_CHIP_21143     = 7,	/* DECchip 21143 */
    133   1.1  thorpej 	TULIP_CHIP_82C168    = 8,	/* Lite-On 82C168 PNIC */
    134   1.1  thorpej 	TULIP_CHIP_82C169    = 9,	/* Lite-On 82C169 PNIC */
    135   1.5  thorpej 	TULIP_CHIP_82C115    = 10,	/* Lite-On 82C115 PNIC II */
    136   1.5  thorpej 	TULIP_CHIP_MX98713   = 11,	/* Macronix 98713 PMAC */
    137   1.5  thorpej 	TULIP_CHIP_MX98713A  = 12,	/* Macronix 98713A PMAC */
    138  1.18  thorpej 	TULIP_CHIP_MX98715   = 13,	/* Macronix 98715 PMAC */
    139  1.18  thorpej 	TULIP_CHIP_MX98715A  = 14,	/* Macronix 98715A PMAC */
    140  1.37   castor 	TULIP_CHIP_MX98715AEC_X = 15,	/* Macronix 98715AEC-C, -E PMAC */
    141  1.37   castor 	TULIP_CHIP_MX98725   = 16,	/* Macronix 98725 PMAC */
    142  1.37   castor 	TULIP_CHIP_WB89C840F = 17,	/* Winbond 89C840F */
    143  1.37   castor 	TULIP_CHIP_DM9102    = 18,	/* Davicom DM9102 */
    144  1.37   castor 	TULIP_CHIP_DM9102A   = 19,	/* Davicom DM9102A */
    145  1.37   castor 	TULIP_CHIP_AL981     = 20,	/* ADMtek AL981 */
    146  1.38  thorpej 	TULIP_CHIP_AN983     = 21,	/* ADMtek AN983 */
    147  1.38  thorpej 	TULIP_CHIP_AN985     = 22,	/* ADMtek AN985 */
    148  1.38  thorpej 	TULIP_CHIP_AX88140   = 23,	/* ASIX AX88140 */
    149  1.38  thorpej 	TULIP_CHIP_AX88141   = 24,	/* ASIX AX88141 */
    150  1.38  thorpej 	TULIP_CHIP_X3201_3   = 25,	/* Xircom X3201-3 */
    151   1.1  thorpej } tulip_chip_t;
    152   1.1  thorpej 
    153   1.1  thorpej #define	TULIP_CHIP_NAMES						\
    154   1.1  thorpej {									\
    155   1.1  thorpej 	NULL,								\
    156   1.1  thorpej 	"DE-425",							\
    157   1.1  thorpej 	"DECchip 21040",						\
    158   1.1  thorpej 	"DECchip 21041",						\
    159   1.1  thorpej 	"DECchip 21140",						\
    160   1.1  thorpej 	"DECchip 21140A",						\
    161   1.1  thorpej 	"DECchip 21142",						\
    162   1.1  thorpej 	"DECchip 21143",						\
    163   1.1  thorpej 	"Lite-On 82C168",						\
    164   1.1  thorpej 	"Lite-On 82C169",						\
    165   1.5  thorpej 	"Lite-On 82C115",						\
    166   1.1  thorpej 	"Macronix MX98713",						\
    167   1.1  thorpej 	"Macronix MX98713A",						\
    168   1.1  thorpej 	"Macronix MX98715",						\
    169  1.18  thorpej 	"Macronix MX98715A",						\
    170  1.37   castor 	"Macronix MX98715AEC-x",					\
    171   1.1  thorpej 	"Macronix MX98725",						\
    172   1.1  thorpej 	"Winbond 89C840F",						\
    173   1.5  thorpej 	"Davicom DM9102",						\
    174  1.36  thorpej 	"Davicom DM9102A",						\
    175   1.5  thorpej 	"ADMtek AL981",							\
    176  1.38  thorpej 	"ADMtek AN983",							\
    177  1.38  thorpej 	"ADMtek AN985",							\
    178   1.5  thorpej 	"ASIX AX88140",							\
    179   1.5  thorpej 	"ASIX AX88141",							\
    180  1.24  thorpej 	"Xircom X3201-3",						\
    181   1.1  thorpej }
    182   1.1  thorpej 
    183   1.1  thorpej struct tulip_softc;
    184   1.1  thorpej 
    185   1.1  thorpej /*
    186   1.1  thorpej  * Media init, change, status function pointers.
    187   1.1  thorpej  */
    188   1.1  thorpej struct tulip_mediasw {
    189   1.1  thorpej 	void	(*tmsw_init) __P((struct tulip_softc *));
    190   1.1  thorpej 	void	(*tmsw_get) __P((struct tulip_softc *, struct ifmediareq *));
    191   1.1  thorpej 	int	(*tmsw_set) __P((struct tulip_softc *));
    192   1.1  thorpej };
    193   1.1  thorpej 
    194   1.1  thorpej /*
    195  1.33  thorpej  * Table which describes the transmit threshold mode.  We generally
    196  1.33  thorpej  * start at index 0.  Whenever we get a transmit underrun, we increment
    197  1.33  thorpej  * our index, falling back if we encounter the NULL terminator.
    198   1.1  thorpej  */
    199   1.1  thorpej struct tulip_txthresh_tab {
    200   1.1  thorpej 	u_int32_t txth_opmode;		/* OPMODE bits */
    201   1.1  thorpej 	const char *txth_name;		/* name of mode */
    202   1.1  thorpej };
    203   1.1  thorpej 
    204  1.33  thorpej #define	TLP_TXTHRESH_TAB_10 {						\
    205  1.33  thorpej 	{ OPMODE_TR_72,		"72 bytes" },				\
    206  1.33  thorpej 	{ OPMODE_TR_96,		"96 bytes" },				\
    207  1.33  thorpej 	{ OPMODE_TR_128,	"128 bytes" },				\
    208  1.33  thorpej 	{ OPMODE_TR_160,	"160 bytes" },				\
    209  1.33  thorpej 	{ 0,			NULL },					\
    210  1.33  thorpej }
    211  1.33  thorpej 
    212  1.33  thorpej #define	TLP_TXTHRESH_TAB_10_100 {					\
    213  1.33  thorpej 	{ OPMODE_TR_72,		"72/128 bytes" },			\
    214  1.33  thorpej 	{ OPMODE_TR_96,		"96/256 bytes" },			\
    215  1.33  thorpej 	{ OPMODE_TR_128,	"128/512 bytes" },			\
    216  1.33  thorpej 	{ OPMODE_TR_160,	"160/1024 bytes" },			\
    217  1.33  thorpej 	{ OPMODE_SF,		"store and forward mode" },		\
    218  1.33  thorpej 	{ 0,			NULL },					\
    219  1.33  thorpej }
    220  1.33  thorpej 
    221  1.33  thorpej #define	TXTH_72			0
    222  1.33  thorpej #define	TXTH_96			1
    223  1.33  thorpej #define	TXTH_128		2
    224  1.33  thorpej #define	TXTH_160		3
    225  1.33  thorpej #define	TXTH_SF			4
    226  1.33  thorpej 
    227  1.36  thorpej #define	TLP_TXTHRESH_TAB_DM9102 {					\
    228  1.36  thorpej 	{ OPMODE_TR_72,		"72/128 bytes" },			\
    229  1.36  thorpej 	{ OPMODE_TR_96,		"96/256 bytes" },			\
    230  1.36  thorpej 	{ OPMODE_TR_128,	"128/512 bytes" },			\
    231  1.36  thorpej 	{ OPMODE_SF,		"store and forward mode" },		\
    232  1.36  thorpej 	{ 0,			NULL },					\
    233  1.36  thorpej }
    234  1.36  thorpej 
    235  1.36  thorpej #define	TXTH_DM9102_72		0
    236  1.36  thorpej #define	TXTH_DM9102_96		1
    237  1.36  thorpej #define	TXTH_DM9102_128		2
    238  1.36  thorpej #define	TXTH_DM9102_SF		3
    239  1.36  thorpej 
    240  1.33  thorpej /*
    241  1.33  thorpej  * The Winbond 89C840F does transmit threshold control totally
    242  1.33  thorpej  * differently.  It simply has a 7-bit field which indicates
    243  1.33  thorpej  * the threshold:
    244  1.33  thorpej  *
    245  1.33  thorpej  *	txth = ((OPMODE & OPMODE_WINB_TTH) >> OPMODE_WINB_TTH_SHIFT) * 16;
    246  1.33  thorpej  *
    247  1.33  thorpej  * However, we just do Store-and-Forward mode on these chips, since
    248  1.33  thorpej  * the DMA engines seem to be flaky.
    249  1.33  thorpej  */
    250  1.33  thorpej #define	TLP_TXTHRESH_TAB_WINB {						\
    251  1.33  thorpej 	{ 0,			"store and forward mode" },		\
    252  1.33  thorpej 	{ 0,			NULL },					\
    253  1.33  thorpej }
    254  1.33  thorpej 
    255  1.33  thorpej #define	TXTH_WINB_SF		0
    256  1.33  thorpej 
    257   1.1  thorpej /*
    258  1.19  thorpej  * Settings for Tulip SIA media.
    259   1.7  thorpej  */
    260  1.19  thorpej struct tulip_sia_media {
    261   1.7  thorpej 	u_int32_t	tsm_siaconn;	/* CSR13 value */
    262   1.7  thorpej 	u_int32_t	tsm_siatxrx;	/* CSR14 value */
    263   1.7  thorpej 	u_int32_t	tsm_siagen;	/* CSR15 value */
    264   1.7  thorpej };
    265   1.7  thorpej 
    266   1.7  thorpej /*
    267  1.19  thorpej  * Description of 2x14x media.
    268  1.12  thorpej  */
    269  1.19  thorpej struct tulip_21x4x_media {
    270  1.12  thorpej 	int		tm_type;	/* type of media; see tulipreg.h */
    271  1.14  thorpej 	const char	*tm_name;	/* name of media */
    272  1.12  thorpej 
    273  1.12  thorpej 	void		(*tm_get) __P((struct tulip_softc *,
    274  1.12  thorpej 			    struct ifmediareq *));
    275  1.12  thorpej 	int		(*tm_set) __P((struct tulip_softc *));
    276  1.12  thorpej 
    277  1.12  thorpej 	int		tm_phyno;	/* PHY # on MII */
    278  1.12  thorpej 
    279  1.12  thorpej 	int		tm_gp_length;	/* MII select sequence length */
    280  1.12  thorpej 	int		tm_gp_offset;	/* MII select sequence offset */
    281  1.12  thorpej 
    282  1.12  thorpej 	int		tm_reset_length;/* MII reset sequence length */
    283  1.12  thorpej 	int		tm_reset_offset;/* MII reset sequence offset */
    284  1.12  thorpej 
    285  1.12  thorpej 	u_int32_t	tm_opmode;	/* OPMODE bits for this media */
    286  1.19  thorpej 	u_int32_t	tm_gpctl;	/* GPIO control bits for this media */
    287  1.14  thorpej 	u_int32_t	tm_gpdata;	/* GPIO bits for this media */
    288  1.14  thorpej 	u_int32_t	tm_actmask;	/* `active' bits for this data */
    289  1.14  thorpej 	u_int32_t	tm_actdata;	/* active high/low info */
    290  1.19  thorpej 
    291  1.19  thorpej 	struct tulip_sia_media tm_sia;	/* SIA settings */
    292  1.19  thorpej #define	tm_siaconn	tm_sia.tsm_siaconn
    293  1.19  thorpej #define	tm_siatxrx	tm_sia.tsm_siatxrx
    294  1.19  thorpej #define	tm_siagen	tm_sia.tsm_siagen
    295  1.14  thorpej };
    296  1.14  thorpej 
    297  1.14  thorpej /*
    298  1.14  thorpej  * Table for converting Tulip SROM media info into ifmedia data.
    299  1.14  thorpej  */
    300  1.14  thorpej struct tulip_srom_to_ifmedia {
    301  1.14  thorpej 	u_int8_t	tsti_srom;	/* SROM media type */
    302  1.14  thorpej 	int		tsti_subtype;	/* ifmedia subtype */
    303  1.14  thorpej 	int		tsti_options;	/* ifmedia options */
    304  1.14  thorpej 	const char	*tsti_name;	/* media name */
    305  1.14  thorpej 
    306  1.19  thorpej 	u_int32_t	tsti_opmode;	/* OPMODE bits for this media */
    307  1.19  thorpej 
    308  1.14  thorpej 	/*
    309  1.19  thorpej 	 * Settings for 21040, 21041, and 21142/21143 SIA, in the event
    310  1.14  thorpej 	 * the SROM doesn't have them.
    311  1.14  thorpej 	 */
    312  1.19  thorpej 	struct tulip_sia_media tsti_21040;
    313  1.19  thorpej 	struct tulip_sia_media tsti_21041;
    314  1.19  thorpej 	struct tulip_sia_media tsti_21142;
    315  1.12  thorpej };
    316  1.12  thorpej 
    317  1.12  thorpej /*
    318  1.17  thorpej  * Some misc. statics, useful for debugging.
    319  1.17  thorpej  */
    320  1.17  thorpej struct tulip_stats {
    321  1.17  thorpej 	u_long		ts_tx_uf;	/* transmit underflow errors */
    322  1.17  thorpej 	u_long		ts_tx_to;	/* transmit jabber timeouts */
    323  1.17  thorpej 	u_long		ts_tx_ec;	/* excessve collision count */
    324  1.17  thorpej 	u_long		ts_tx_lc;	/* late collision count */
    325  1.17  thorpej };
    326  1.17  thorpej 
    327  1.37   castor #ifndef _STANDALONE
    328  1.17  thorpej /*
    329   1.1  thorpej  * Software state per device.
    330   1.1  thorpej  */
    331   1.1  thorpej struct tulip_softc {
    332   1.1  thorpej 	struct device sc_dev;		/* generic device information */
    333   1.1  thorpej 	bus_space_tag_t sc_st;		/* bus space tag */
    334   1.1  thorpej 	bus_space_handle_t sc_sh;	/* bus space handle */
    335   1.1  thorpej 	bus_dma_tag_t sc_dmat;		/* bus DMA tag */
    336   1.1  thorpej 	struct ethercom sc_ethercom;	/* ethernet common data */
    337   1.1  thorpej 	void *sc_sdhook;		/* shutdown hook */
    338  1.31  thorpej 	void *sc_powerhook;		/* power management hook */
    339  1.17  thorpej 
    340  1.17  thorpej 	struct tulip_stats sc_stats;	/* debugging stats */
    341   1.1  thorpej 
    342   1.1  thorpej 	/*
    343   1.7  thorpej 	 * Contents of the SROM.
    344   1.7  thorpej 	 */
    345  1.29  mycroft 	u_int8_t *sc_srom;
    346  1.21  thorpej 	int sc_srom_addrbits;
    347   1.7  thorpej 
    348   1.7  thorpej 	/*
    349   1.1  thorpej 	 * Media access functions for this chip.
    350   1.1  thorpej 	 */
    351   1.1  thorpej 	const struct tulip_mediasw *sc_mediasw;
    352  1.21  thorpej 	mii_bitbang_ops_t sc_bitbang_ops;
    353   1.1  thorpej 
    354   1.6  thorpej 	/*
    355   1.6  thorpej 	 * For chips with built-in NWay blocks, these are state
    356   1.6  thorpej 	 * variables required for autonegotiation.
    357   1.6  thorpej 	 */
    358   1.6  thorpej 	int		sc_nway_ticks;	/* tick counter */
    359  1.19  thorpej 	struct ifmedia_entry *sc_nway_active; /* the active media */
    360  1.32  thorpej 	struct callout	sc_nway_callout;
    361   1.6  thorpej 
    362   1.1  thorpej 	tulip_chip_t	sc_chip;	/* chip type */
    363   1.1  thorpej 	int		sc_rev;		/* chip revision */
    364   1.1  thorpej 	int		sc_flags;	/* misc flags. */
    365   1.9  thorpej 	char		sc_name[16];	/* board name */
    366   1.1  thorpej 	u_int32_t	sc_cacheline;	/* cache line size */
    367  1.10  thorpej 	int		sc_devno;	/* PCI device # */
    368   1.1  thorpej 
    369   1.1  thorpej 	struct mii_data sc_mii;		/* MII/media information */
    370   1.1  thorpej 
    371   1.1  thorpej 	const struct tulip_txthresh_tab *sc_txth;
    372   1.1  thorpej 	int		sc_txthresh;	/* current transmit threshold */
    373   1.1  thorpej 
    374  1.19  thorpej 	u_int8_t	sc_gp_dir;	/* GPIO pin direction bits (21140) */
    375  1.19  thorpej 	int		sc_media_seen;	/* ISV media block types seen */
    376  1.19  thorpej 	int		sc_tlp_minst;	/* Tulip internal media instance */
    377  1.12  thorpej 
    378  1.12  thorpej 	/* Reset function. */
    379  1.12  thorpej 	void		(*sc_reset) __P((struct tulip_softc *));
    380  1.12  thorpej 
    381  1.11  thorpej 	/* Pre-init function. */
    382  1.11  thorpej 	void		(*sc_preinit) __P((struct tulip_softc *));
    383  1.11  thorpej 
    384   1.1  thorpej 	/* Filter setup function. */
    385   1.1  thorpej 	void		(*sc_filter_setup) __P((struct tulip_softc *));
    386   1.1  thorpej 
    387   1.6  thorpej 	/* Media status update function. */
    388   1.4  thorpej 	void		(*sc_statchg) __P((struct device *));
    389   1.4  thorpej 
    390   1.6  thorpej 	/* Media tick function. */
    391   1.6  thorpej 	void		(*sc_tick) __P((void *));
    392  1.32  thorpej 	struct callout sc_tick_callout;
    393   1.6  thorpej 
    394  1.30  thorpej 	/* Power management hooks. */
    395  1.30  thorpej 	int		(*sc_enable) __P((struct tulip_softc *));
    396  1.30  thorpej 	void		(*sc_disable) __P((struct tulip_softc *));
    397  1.31  thorpej 	void		(*sc_power) __P((struct tulip_softc *, int));
    398  1.30  thorpej 
    399   1.1  thorpej 	/*
    400   1.1  thorpej 	 * The Winbond 89C840F places registers 4 bytes apart, instead
    401   1.1  thorpej 	 * of 8.
    402   1.1  thorpej 	 */
    403   1.1  thorpej 	int		sc_regshift;
    404   1.1  thorpej 
    405   1.1  thorpej 	u_int32_t	sc_busmode;	/* copy of CSR_BUSMODE */
    406   1.1  thorpej 	u_int32_t	sc_opmode;	/* copy of CSR_OPMODE */
    407   1.1  thorpej 	u_int32_t	sc_inten;	/* copy of CSR_INTEN */
    408   1.4  thorpej 
    409   1.4  thorpej 	u_int32_t	sc_rxint_mask;	/* mask of Rx interrupts we want */
    410   1.4  thorpej 	u_int32_t	sc_txint_mask;	/* mask of Tx interrupts we want */
    411   1.1  thorpej 
    412   1.1  thorpej 	u_int32_t	sc_filtmode;	/* filter mode we're using */
    413   1.1  thorpej 
    414  1.28  thorpej 	bus_dma_segment_t sc_cdseg;	/* control data memory */
    415  1.28  thorpej 	int		sc_cdnseg;	/* number of segments */
    416   1.1  thorpej 	bus_dmamap_t sc_cddmamap;	/* control data DMA map */
    417   1.1  thorpej #define	sc_cddma	sc_cddmamap->dm_segs[0].ds_addr
    418   1.1  thorpej 
    419   1.1  thorpej 	/*
    420   1.1  thorpej 	 * Software state for transmit and receive descriptors.
    421   1.1  thorpej 	 */
    422   1.1  thorpej 	struct tulip_txsoft sc_txsoft[TULIP_TXQUEUELEN];
    423   1.1  thorpej 	struct tulip_rxsoft sc_rxsoft[TULIP_NRXDESC];
    424   1.1  thorpej 
    425   1.1  thorpej 	/*
    426   1.1  thorpej 	 * Control data structures.
    427   1.1  thorpej 	 */
    428   1.1  thorpej 	struct tulip_control_data *sc_control_data;
    429   1.1  thorpej #define	sc_txdescs	sc_control_data->tcd_txdescs
    430   1.1  thorpej #define	sc_rxdescs	sc_control_data->tcd_rxdescs
    431   1.1  thorpej #define	sc_setup_desc	sc_control_data->tcd_setup_desc
    432   1.1  thorpej 
    433   1.1  thorpej 	int	sc_txfree;		/* number of free Tx descriptors */
    434   1.1  thorpej 	int	sc_txnext;		/* next ready Tx descriptor */
    435  1.25  thorpej 	int	sc_ntxsegs;		/* number of transmit segs per pkt */
    436   1.1  thorpej 
    437  1.27  thorpej 	u_int32_t sc_tdctl_ch;		/* conditional desc chaining */
    438  1.27  thorpej 	u_int32_t sc_tdctl_er;		/* conditional desc end-of-ring */
    439  1.35  thorpej 
    440  1.35  thorpej 	u_int32_t sc_setup_fsls;	/* FS|LS on setup descriptor */
    441  1.27  thorpej 
    442   1.1  thorpej 	struct tulip_txsq sc_txfreeq;	/* free Tx descsofts */
    443   1.1  thorpej 	struct tulip_txsq sc_txdirtyq;	/* dirty Tx descsofts */
    444   1.1  thorpej 
    445   1.1  thorpej 	int	sc_rxptr;		/* next ready RX descriptor/descsoft */
    446  1.39    enami 
    447  1.39    enami #if NRND > 0
    448  1.39    enami 	rndsource_element_t sc_rnd_source; /* random source */
    449  1.39    enami #endif
    450   1.1  thorpej };
    451  1.37   castor #endif
    452   1.1  thorpej 
    453   1.1  thorpej /* sc_flags */
    454   1.1  thorpej #define	TULIPF_WANT_SETUP	0x00000001	/* want filter setup */
    455   1.3  thorpej #define	TULIPF_DOING_SETUP	0x00000002	/* doing multicast setup */
    456   1.3  thorpej #define	TULIPF_HAS_MII		0x00000004	/* has media on MII */
    457   1.3  thorpej #define	TULIPF_IC_FS		0x00000008	/* IC bit on first tx seg */
    458  1.20  thorpej #define	TULIPF_MRL		0x00000010	/* memory read line okay */
    459  1.20  thorpej #define	TULIPF_MRM		0x00000020	/* memory read multi okay */
    460  1.20  thorpej #define	TULIPF_MWI		0x00000040	/* memory write inval okay */
    461  1.33  thorpej #define	TULIPF_AUTOPOLL		0x00000080	/* chip supports auto-poll */
    462  1.20  thorpej #define	TULIPF_LINK_UP		0x00000100	/* link is up (non-MII) */
    463  1.20  thorpej #define	TULIPF_LINK_VALID	0x00000200	/* link state valid */
    464  1.20  thorpej #define	TULIPF_DOINGAUTO	0x00000400	/* doing autoneg (non-MII) */
    465  1.30  thorpej #define	TULIPF_ATTACHED		0x00000800	/* attach has succeeded */
    466  1.30  thorpej #define	TULIPF_ENABLED		0x00001000	/* chip is enabled */
    467  1.30  thorpej 
    468  1.30  thorpej #define	TULIP_IS_ENABLED(sc)	((sc)->sc_flags & TULIPF_ENABLED)
    469  1.19  thorpej 
    470  1.19  thorpej /*
    471  1.19  thorpej  * This macro returns the current media entry for *non-MII* media.
    472  1.19  thorpej  */
    473  1.19  thorpej #define	TULIP_CURRENT_MEDIA(sc)						\
    474  1.19  thorpej 	(IFM_SUBTYPE((sc)->sc_mii.mii_media.ifm_cur->ifm_media) != IFM_AUTO ? \
    475  1.19  thorpej 	 (sc)->sc_mii.mii_media.ifm_cur : (sc)->sc_nway_active)
    476  1.19  thorpej 
    477  1.19  thorpej /*
    478  1.19  thorpej  * This macro determines if a change to media-related OPMODE bits requires
    479  1.19  thorpej  * a chip reset.
    480  1.19  thorpej  */
    481  1.19  thorpej #define	TULIP_MEDIA_NEEDSRESET(sc, newbits)				\
    482  1.19  thorpej 	(((sc)->sc_opmode & OPMODE_MEDIA_BITS) !=			\
    483  1.19  thorpej 	 ((newbits) & OPMODE_MEDIA_BITS))
    484   1.1  thorpej 
    485   1.1  thorpej #define	TULIP_CDTXADDR(sc, x)	((sc)->sc_cddma + TULIP_CDTXOFF((x)))
    486   1.1  thorpej #define	TULIP_CDRXADDR(sc, x)	((sc)->sc_cddma + TULIP_CDRXOFF((x)))
    487   1.1  thorpej 
    488   1.1  thorpej #define	TULIP_CDSPADDR(sc)	((sc)->sc_cddma + TULIP_CDSPOFF)
    489   1.1  thorpej 
    490   1.1  thorpej #define	TULIP_CDSP(sc)		((sc)->sc_control_data->tcd_setup_packet)
    491   1.1  thorpej 
    492   1.1  thorpej #define	TULIP_CDTXSYNC(sc, x, n, ops)					\
    493   1.1  thorpej do {									\
    494   1.1  thorpej 	int __x, __n;							\
    495   1.1  thorpej 									\
    496   1.1  thorpej 	__x = (x);							\
    497   1.1  thorpej 	__n = (n);							\
    498   1.1  thorpej 									\
    499   1.1  thorpej 	/* If it will wrap around, sync to the end of the ring. */	\
    500   1.1  thorpej 	if ((__x + __n) > TULIP_NTXDESC) {				\
    501   1.1  thorpej 		bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,	\
    502   1.1  thorpej 		    TULIP_CDTXOFF(__x), sizeof(struct tulip_desc) *	\
    503   1.1  thorpej 		    (TULIP_NTXDESC - __x), (ops));			\
    504   1.1  thorpej 		__n -= (TULIP_NTXDESC - __x);				\
    505   1.1  thorpej 		__x = 0;						\
    506   1.1  thorpej 	}								\
    507   1.1  thorpej 									\
    508   1.1  thorpej 	/* Now sync whatever is left. */				\
    509   1.1  thorpej 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    510   1.1  thorpej 	    TULIP_CDTXOFF(__x), sizeof(struct tulip_desc) * __n, (ops)); \
    511   1.1  thorpej } while (0)
    512   1.1  thorpej 
    513   1.1  thorpej #define	TULIP_CDRXSYNC(sc, x, ops)					\
    514   1.1  thorpej 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    515   1.1  thorpej 	    TULIP_CDRXOFF((x)), sizeof(struct tulip_desc), (ops))
    516   1.1  thorpej 
    517   1.1  thorpej #define	TULIP_CDSPSYNC(sc, ops)						\
    518   1.1  thorpej 	bus_dmamap_sync((sc)->sc_dmat, (sc)->sc_cddmamap,		\
    519   1.1  thorpej 	    TULIP_CDSPOFF, TULIP_SETUP_PACKET_LEN, (ops))
    520   1.1  thorpej 
    521   1.1  thorpej /*
    522   1.1  thorpej  * Note we rely on MCLBYTES being a power of two.  Because the `length'
    523   1.1  thorpej  * field is only 11 bits, we must subtract 1 from the length to avoid
    524   1.1  thorpej  * having it truncated to 0!
    525   1.1  thorpej  */
    526   1.1  thorpej #define	TULIP_INIT_RXDESC(sc, x)					\
    527   1.1  thorpej do {									\
    528   1.1  thorpej 	struct tulip_rxsoft *__rxs = &sc->sc_rxsoft[(x)];		\
    529   1.1  thorpej 	struct tulip_desc *__rxd = &sc->sc_rxdescs[(x)];		\
    530   1.1  thorpej 	struct mbuf *__m = __rxs->rxs_mbuf;				\
    531   1.1  thorpej 									\
    532   1.1  thorpej 	__m->m_data = __m->m_ext.ext_buf;				\
    533  1.23  thorpej 	__rxd->td_bufaddr1 =						\
    534  1.23  thorpej 	    htole32(__rxs->rxs_dmamap->dm_segs[0].ds_addr);		\
    535  1.23  thorpej 	__rxd->td_bufaddr2 =						\
    536  1.23  thorpej 	    htole32(TULIP_CDRXADDR((sc), TULIP_NEXTRX((x))));		\
    537   1.1  thorpej 	__rxd->td_ctl =							\
    538  1.34  thorpej 	    htole32((((__m->m_ext.ext_size - 1) & ~0x3U)		\
    539  1.34  thorpej 	    << TDCTL_SIZE1_SHIFT) | (sc)->sc_tdctl_ch |			\
    540  1.27  thorpej 	    ((x) == (TULIP_NRXDESC - 1) ? sc->sc_tdctl_er : 0));	\
    541  1.23  thorpej 	__rxd->td_status = htole32(TDSTAT_OWN|TDSTAT_Rx_FS|TDSTAT_Rx_LS); \
    542   1.1  thorpej 	TULIP_CDRXSYNC((sc), (x), BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE); \
    543   1.1  thorpej } while (0)
    544   1.1  thorpej 
    545   1.1  thorpej /* CSR access */
    546   1.8  thorpej #define	TULIP_CSR_OFFSET(sc, csr)					\
    547   1.8  thorpej 	(TULIP_CSR_INDEX(csr) << (sc)->sc_regshift)
    548   1.8  thorpej 
    549   1.1  thorpej #define	TULIP_READ(sc, reg)						\
    550   1.1  thorpej 	bus_space_read_4((sc)->sc_st, (sc)->sc_sh,			\
    551   1.8  thorpej 	    TULIP_CSR_OFFSET((sc), (reg)))
    552   1.1  thorpej 
    553   1.1  thorpej #define	TULIP_WRITE(sc, reg, val)					\
    554   1.1  thorpej 	bus_space_write_4((sc)->sc_st, (sc)->sc_sh,			\
    555   1.8  thorpej 	    TULIP_CSR_OFFSET((sc), (reg)), (val))
    556   1.1  thorpej 
    557   1.1  thorpej #define	TULIP_SET(sc, reg, mask)					\
    558   1.1  thorpej 	TULIP_WRITE((sc), (reg), TULIP_READ((sc), (reg)) | (mask))
    559   1.1  thorpej 
    560   1.1  thorpej #define	TULIP_CLR(sc, reg, mask)					\
    561   1.1  thorpej 	TULIP_WRITE((sc), (reg), TULIP_READ((sc), (reg)) & ~(mask))
    562   1.1  thorpej 
    563   1.1  thorpej #define	TULIP_ISSET(sc, reg, mask)					\
    564   1.1  thorpej 	(TULIP_READ((sc), (reg)) & (mask))
    565  1.22  thorpej 
    566  1.22  thorpej #if BYTE_ORDER == BIG_ENDIAN
    567  1.22  thorpej #define	TULIP_SP_FIELD_C(x)	((x) << 16)
    568  1.22  thorpej #else
    569  1.22  thorpej #define	TULIP_SP_FIELD_C(x)	(x)
    570  1.22  thorpej #endif
    571  1.22  thorpej #define	TULIP_SP_FIELD(x, f)	TULIP_SP_FIELD_C(((u_int16_t *)(x))[(f)])
    572   1.1  thorpej 
    573   1.1  thorpej #ifdef _KERNEL
    574  1.24  thorpej extern const char *tlp_chip_names[];
    575  1.24  thorpej 
    576   1.7  thorpej extern const struct tulip_mediasw tlp_21040_mediasw;
    577   1.7  thorpej extern const struct tulip_mediasw tlp_21040_tp_mediasw;
    578   1.7  thorpej extern const struct tulip_mediasw tlp_21040_auibnc_mediasw;
    579  1.11  thorpej extern const struct tulip_mediasw tlp_21041_mediasw;
    580  1.12  thorpej extern const struct tulip_mediasw tlp_2114x_isv_mediasw;
    581   1.1  thorpej extern const struct tulip_mediasw tlp_sio_mii_mediasw;
    582   1.1  thorpej extern const struct tulip_mediasw tlp_pnic_mediasw;
    583  1.16  thorpej extern const struct tulip_mediasw tlp_pmac_mediasw;
    584  1.16  thorpej extern const struct tulip_mediasw tlp_al981_mediasw;
    585  1.36  thorpej extern const struct tulip_mediasw tlp_dm9102_mediasw;
    586   1.1  thorpej 
    587   1.9  thorpej void	tlp_attach __P((struct tulip_softc *, const u_int8_t *));
    588  1.28  thorpej int	tlp_activate __P((struct device *, enum devact));
    589  1.28  thorpej int	tlp_detach __P((struct tulip_softc *));
    590   1.1  thorpej int	tlp_intr __P((void *));
    591  1.29  mycroft int	tlp_read_srom __P((struct tulip_softc *));
    592  1.11  thorpej int	tlp_srom_crcok __P((const u_int8_t *));
    593  1.11  thorpej int	tlp_isv_srom __P((const u_int8_t *));
    594  1.11  thorpej int	tlp_isv_srom_enaddr __P((struct tulip_softc *, u_int8_t *));
    595   1.7  thorpej int	tlp_parse_old_srom __P((struct tulip_softc *, u_int8_t *));
    596   1.1  thorpej 
    597   1.1  thorpej int	tlp_mediachange __P((struct ifnet *));
    598   1.1  thorpej void	tlp_mediastatus __P((struct ifnet *, struct ifmediareq *));
    599   1.1  thorpej #endif /* _KERNEL */
    600   1.1  thorpej 
    601   1.1  thorpej #endif /* _DEV_IC_TULIPVAR_H_ */
    602