Home | History | Annotate | Line # | Download | only in pci
if_stgereg.h revision 1.8
      1 /*	$NetBSD: if_stgereg.h,v 1.8 2020/01/09 10:54:16 msaitoh Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Jason R. Thorpe.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _DEV_PCI_IF_STGEREG_H_
     33 #define	_DEV_PCI_IF_STGEREG_H_
     34 
     35 
     36 #include <net/if_ether.h>
     37 #include <sys/bus.h>
     38 
     39 /*
     40  * Register description for the Sundance Tech. TC9021 10/100/1000
     41  * Ethernet controller.
     42  *
     43  * Note that while DMA addresses are all in 64-bit fields, only
     44  * the lower 40 bits of a DMA address are valid.
     45  */
     46 
     47 /*
     48  * Register access macros
     49  */
     50 #define CSR_WRITE_4(_sc, reg, val)	\
     51 	bus_space_write_4((_sc)->sc_st, (_sc)->sc_sh, (reg), (val))
     52 #define CSR_WRITE_2(_sc, reg, val)	\
     53 	bus_space_write_2((_sc)->sc_st, (_sc)->sc_sh, (reg), (val))
     54 #define CSR_WRITE_1(_sc, reg, val)	\
     55 	bus_space_write_1((_sc)->sc_st, (_sc)->sc_sh, (reg), (val))
     56 
     57 #define CSR_READ_4(_sc, reg)		\
     58 	bus_space_read_4((_sc)->sc_st, (_sc)->sc_sh, (reg))
     59 #define CSR_READ_2(_sc, reg)		\
     60 	bus_space_read_2((_sc)->sc_st, (_sc)->sc_sh, (reg))
     61 #define CSR_READ_1(_sc, reg)		\
     62 	bus_space_read_1((_sc)->sc_st, (_sc)->sc_sh, (reg))
     63 
     64 /*
     65  * TC9021 buffer fragment descriptor.
     66  */
     67 struct stge_frag {
     68 	uint64_t	frag_word0;	/* address, length */
     69 } __packed;
     70 
     71 #define	FRAG_ADDR(x)	(((uint64_t)(x)) << 0)
     72 #define	FRAG_ADDR_MASK	FRAG_ADDR(0xfffffffffULL)
     73 #define	FRAG_LEN(x)	(((uint64_t)(x)) << 48)
     74 #define	FRAG_LEN_MASK	FRAG_LEN(0xffffULL)
     75 
     76 /*
     77  * TC9021 Transmit Frame Descriptor.  Note the number of fragments
     78  * here is arbitrary, but we can't have any more than 15.
     79  */
     80 #define	STGE_NTXFRAGS	12
     81 struct stge_tfd {
     82 	uint64_t	tfd_next;	/* next TFD in list */
     83 	uint64_t	tfd_control;	/* control bits */
     84 					/* the buffer fragments */
     85 	struct stge_frag tfd_frags[STGE_NTXFRAGS];
     86 } __packed;
     87 
     88 #define	TFD_FrameId(x)		((x) << 0)
     89 #define	TFD_FrameId_MAX		0xffff
     90 #define	TFD_WordAlign(x)	((x) << 16)
     91 #define	TFD_WordAlign_dword	0		/* align to dword in TxFIFO */
     92 #define	TFD_WordAlign_word	2		/* align to word in TxFIFO */
     93 #define	TFD_WordAlign_disable	1		/* disable alignment */
     94 #define	TFD_TCPChecksumEnable	(1ULL << 18)
     95 #define	TFD_UDPChecksumEnable	(1ULL << 19)
     96 #define	TFD_IPChecksumEnable	(1ULL << 20)
     97 #define	TFD_FcsAppendDisable	(1ULL << 21)
     98 #define	TFD_TxIndicate		(1ULL << 22)
     99 #define	TFD_TxDMAIndicate	(1ULL << 23)
    100 #define	TFD_FragCount(x)	((x) << 24)
    101 #define	TFD_VLANTagInsert	(1ULL << 28)
    102 #define	TFD_TFDDone		(1ULL << 31)
    103 #define	TFD_VID(x)		(((uint64_t)(x)) << 32)
    104 #define	TFD_CFI			(1ULL << 44)
    105 #define	TFD_UserPriority(x)	(((uint64_t)(x)) << 45)
    106 
    107 /*
    108  * TC9021 Receive Frame Descriptor.  Each RFD has a single fragment
    109  * in it, and the chip tells us the beginning and end of the frame.
    110  */
    111 struct stge_rfd {
    112 	uint64_t	rfd_next;	/* next RFD in list */
    113 	uint64_t	rfd_status;	/* status bits */
    114 	struct stge_frag rfd_frag;	/* the buffer */
    115 } __packed;
    116 
    117 #define	RFD_RxDMAFrameLen(x)	((x) & 0xffff)
    118 #define	RFD_RxFIFOOverrun	(1ULL << 16)
    119 #define	RFD_RxRuntFrame		(1ULL << 17)
    120 #define	RFD_RxAlignmentError	(1ULL << 18)
    121 #define	RFD_RxFCSError		(1ULL << 19)
    122 #define	RFD_RxOversizedFrame	(1ULL << 20)
    123 #define	RFD_RxLengthError	(1ULL << 21)
    124 #define	RFD_VLANDetected	(1ULL << 22)
    125 #define	RFD_TCPDetected		(1ULL << 23)
    126 #define	RFD_TCPError		(1ULL << 24)
    127 #define	RFD_UDPDetected		(1ULL << 25)
    128 #define	RFD_UDPError		(1ULL << 26)
    129 #define	RFD_IPDetected		(1ULL << 27)
    130 #define	RFD_IPError		(1ULL << 28)
    131 #define	RFD_FrameStart		(1ULL << 29)
    132 #define	RFD_FrameEnd		(1ULL << 30)
    133 #define	RFD_RFDDone		(1ULL << 31)
    134 #define	RFD_TCI(x)		((((uint64_t)(x)) >> 32) & 0xffff)
    135 
    136 /*
    137  * PCI configuration registers used by the TC9021.
    138  */
    139 
    140 #define	STGE_PCI_IOBA		(PCI_MAPREG_START + 0x00)
    141 #define	STGE_PCI_MMBA		(PCI_MAPREG_START + 0x04)
    142 
    143 /*
    144  * EEPROM offsets.
    145  */
    146 #define	STGE_EEPROM_ConfigParam		0x00
    147 #define	STGE_EEPROM_AsicCtrl		0x01
    148 #define	STGE_EEPROM_SubSystemVendorId	0x02
    149 #define	STGE_EEPROM_SubSystemId		0x03
    150 #define	STGE_EEPROM_StationAddress0	0x10
    151 #define	STGE_EEPROM_StationAddress1	0x11
    152 #define	STGE_EEPROM_StationAddress2	0x12
    153 
    154 /*
    155  * The TC9021 register space.
    156  */
    157 
    158 #define	STGE_DMACtrl			0x00
    159 #define	DMAC_RxDMAComplete		(1U << 3)
    160 #define	DMAC_RxDMAPollNow		(1U << 4)
    161 #define	DMAC_TxDMAComplete		(1U << 11)
    162 #define	DMAC_TxDMAPollNow		(1U << 12)
    163 #define	DMAC_TxDMAInProg		(1U << 15)
    164 #define	DMAC_RxEarlyDisable		(1U << 16)
    165 #define	DMAC_MWIDisable			(1U << 18)
    166 #define	DMAC_TxWiteBackDisable		(1U << 19)
    167 #define	DMAC_TxBurstLimit(x)		((x) << 20)
    168 #define	DMAC_TargetAbort		(1U << 30)
    169 #define	DMAC_MasterAbort		(1U << 31)
    170 
    171 #define	STGE_RxDMAStatus		0x08
    172 
    173 #define	STGE_TFDListPtrLo		0x10
    174 
    175 #define	STGE_TFDListPtrHi		0x14
    176 
    177 #define	STGE_TxDMABurstThresh		0x18	/* 8-bit */
    178 
    179 #define	STGE_TxDMAUrgentThresh		0x19	/* 8-bit */
    180 
    181 #define	STGE_TxDMAPollPeriod		0x1a	/* 8-bit */
    182 
    183 #define	STGE_RFDListPtrLo		0x1c
    184 
    185 #define	STGE_RFDListPtrHi		0x20
    186 
    187 #define	STGE_RxDMABurstThresh		0x24	/* 8-bit */
    188 
    189 #define	STGE_RxDMAUrgentThresh		0x25	/* 8-bit */
    190 
    191 #define	STGE_RxDMAPollPeriod		0x26	/* 8-bit */
    192 
    193 #define	STGE_RxDMAIntCtrl		0x28
    194 #define	RDIC_RxFrameCount(x)		((x) & 0xff)
    195 #define	RDIC_PriorityThresh(x)		((x) << 10)
    196 #define	RDIC_RxDMAWaitTime(x)		((x) << 16)
    197 
    198 #define	STGE_DebugCtrl			0x2c	/* 16-bit */
    199 #define	DC_GPIO0Ctrl			(1U << 0)
    200 #define	DC_GPIO1Ctrl			(1U << 1)
    201 #define	DC_GPIO0			(1U << 2)
    202 #define	DC_GPIO1			(1U << 3)
    203 
    204 #define	STGE_AsicCtrl			0x30
    205 #define	AC_ExpRomDisable		(1U << 0)
    206 #define	AC_ExpRomSize			(1U << 1)
    207 #define	AC_PhySpeed10			(1U << 4)
    208 #define	AC_PhySpeed100			(1U << 5)
    209 #define	AC_PhySpeed1000			(1U << 6)
    210 #define	AC_PhyMedia			(1U << 7)
    211 #define	AC_ForcedConfig(x)		((x) << 8)
    212 #define	AC_ForcedConfig_MASK		AC_ForcedConfig(7)
    213 #define	AC_D3ResetDisable		(1U << 11)
    214 #define	AC_SpeedupMode			(1U << 13)
    215 #define	AC_LEDMode			(1U << 14)
    216 #define	AC_RstOutPolarity		(1U << 15)
    217 #define	AC_GlobalReset			(1U << 16)
    218 #define	AC_RxReset			(1U << 17)
    219 #define	AC_TxReset			(1U << 18)
    220 #define	AC_DMA				(1U << 19)
    221 #define	AC_FIFO				(1U << 20)
    222 #define	AC_Network			(1U << 21)
    223 #define	AC_Host				(1U << 22)
    224 #define	AC_AutoInit			(1U << 23)
    225 #define	AC_RstOut			(1U << 24)
    226 #define	AC_InterruptRequest		(1U << 25)
    227 #define	AC_ResetBusy			(1U << 26)
    228 
    229 #define	STGE_FIFOCtrl			0x38	/* 16-bit */
    230 #define	FC_RAMTestMode			(1U << 0)
    231 #define	FC_Transmitting			(1U << 14)
    232 #define	FC_Receiving			(1U << 15)
    233 
    234 #define	STGE_RxEarlyThresh		0x3a	/* 16-bit */
    235 
    236 #define	STGE_FlowOffThresh		0x3c	/* 16-bit */
    237 
    238 #define	STGE_FlowOnTresh		0x3e	/* 16-bit */
    239 
    240 #define	STGE_TxStartThresh		0x44	/* 16-bit */
    241 
    242 #define	STGE_EepromData			0x48	/* 16-bit */
    243 
    244 #define	STGE_EepromCtrl			0x4a	/* 16-bit */
    245 #define	EC_EepromAddress(x)		((x) & 0xff)
    246 #define	EC_EepromOpcode(x)		((x) << 8)
    247 #define	EC_OP_WE			0
    248 #define	EC_OP_WR			1
    249 #define	EC_OP_RR			2
    250 #define	EC_OP_ER			3
    251 #define	EC_EepromBusy			(1U << 15)
    252 
    253 #define	STGE_ExpRomAddr			0x4c
    254 
    255 #define	STGE_ExpRomData			0x50	/* 8-bit */
    256 
    257 #define	STGE_WakeEvent			0x51	/* 8-bit */
    258 
    259 #define	STGE_Countdown			0x54
    260 #define	CD_Count(x)			((x) & 0xffff)
    261 #define	CD_CountdownSpeed		(1U << 24)
    262 #define	CD_CountdownMode		(1U << 25)
    263 #define	CD_CountdownIntEnabled		(1U << 26)
    264 
    265 #define	STGE_IntStatusAck		0x5a	/* 16-bit */
    266 
    267 #define	STGE_IntStatus			0x5e	/* 16-bit */
    268 
    269 #define	STGE_IntEnable			0x5c	/* 16-bit */
    270 
    271 #define	IS_InterruptStatus		(1U << 0)
    272 #define	IS_HostError			(1U << 1)
    273 #define	IS_TxComplete			(1U << 2)
    274 #define	IS_MACControlFrame		(1U << 3)
    275 #define	IS_RxComplete			(1U << 4)
    276 #define	IS_RxEarly			(1U << 5)
    277 #define	IS_InRequested			(1U << 6)
    278 #define	IS_UpdateStats			(1U << 7)
    279 #define	IS_LinkEvent			(1U << 8)
    280 #define	IS_TxDMAComplete		(1U << 9)
    281 #define	IS_RxDMAComplete		(1U << 10)
    282 #define	IS_RFDListEnd			(1U << 11)
    283 #define	IS_RxDMAPriority		(1U << 12)
    284 
    285 #define	STGE_TxStatus			0x60
    286 #define	TS_TxError			(1U << 0)
    287 #define	TS_LateCollision		(1U << 2)
    288 #define	TS_MaxCollisions		(1U << 3)
    289 #define	TS_TxUnderrun			(1U << 4)
    290 #define	TS_TxIndicateReqd		(1U << 6)
    291 #define	TS_TxComplete			(1U << 7)
    292 #define	TS_TxFrameId_get(x)		((x) >> 16)
    293 
    294 #define	STGE_MACCtrl			0x6c
    295 #define	MC_IFSSelect(x)			((x) & 3)
    296 #define	MC_DuplexSelect			(1U << 5)
    297 #define	MC_RcvLargeFrames		(1U << 6)
    298 #define	MC_TxFlowControlEnable		(1U << 7)
    299 #define	MC_RxFlowControlEnable		(1U << 8)
    300 #define	MC_RcvFCS			(1U << 9)
    301 #define	MC_FIFOLoopback			(1U << 10)
    302 #define	MC_MACLoopback			(1U << 11)
    303 #define	MC_AutoVLANtagging		(1U << 12)
    304 #define	MC_AutoVLANuntagging		(1U << 13)
    305 #define	MC_CollisionDetect		(1U << 16)
    306 #define	MC_CarrierSense			(1U << 17)
    307 #define	MC_StatisticsEnable		(1U << 21)
    308 #define	MC_StatisticsDisable		(1U << 22)
    309 #define	MC_StatisticsEnabled		(1U << 23)
    310 #define	MC_TxEnable			(1U << 24)
    311 #define	MC_TxDisable			(1U << 25)
    312 #define	MC_TxEnabled			(1U << 26)
    313 #define	MC_RxEnable			(1U << 27)
    314 #define	MC_RxDisable			(1U << 28)
    315 #define	MC_RxEnabled			(1U << 29)
    316 #define	MC_Paused			(1U << 30)
    317 
    318 #define	STGE_VLANTag			0x70
    319 
    320 #define	STGE_PhyCtrl			0x76	/* 8-bit */
    321 #define	PC_MgmtClk			(1U << 0)
    322 #define	PC_MgmtData			(1U << 1)
    323 #define	PC_MgmtDir			(1U << 2)	/* MAC->PHY */
    324 #define	PC_PhyDuplexPolarity		(1U << 3)
    325 #define	PC_PhyDuplexStatus		(1U << 4)
    326 #define	PC_PhyLnkPolarity		(1U << 5)
    327 #define	PC_LinkSpeed(x)			(((x) >> 6) & 3)
    328 #define	PC_LinkSpeed_Down		0
    329 #define	PC_LinkSpeed_10			1
    330 #define	PC_LinkSpeed_100		2
    331 #define	PC_LinkSpeed_1000		3
    332 
    333 #define	STGE_StationAddress0		0x78	/* 16-bit */
    334 
    335 #define	STGE_StationAddress1		0x7a	/* 16-bit */
    336 
    337 #define	STGE_StationAddress2		0x7c	/* 16-bit */
    338 
    339 #define	STGE_VLANHashTable		0x7e	/* 16-bit */
    340 
    341 #define	STGE_VLANId			0x80
    342 
    343 #define	STGE_MaxFrameSize		0x86
    344 
    345 #define	STGE_ReceiveMode		0x88	/* 16-bit */
    346 #define	RM_ReceiveUnicast		(1U << 0)
    347 #define	RM_ReceiveMulticast		(1U << 1)
    348 #define	RM_ReceiveBroadcast		(1U << 2)
    349 #define	RM_ReceiveAllFrames		(1U << 3)
    350 #define	RM_ReceiveMulticastHash		(1U << 4)
    351 #define	RM_ReceiveIPMulticast		(1U << 5)
    352 #define	RM_ReceiveVLANMatch		(1U << 8)
    353 #define	RM_ReceiveVLANHash		(1U << 9)
    354 
    355 #define	STGE_HashTable0			0x8c
    356 
    357 #define	STGE_HashTable1			0x90
    358 
    359 #define	STGE_RMONStatisticsMask		0x98	/* set to disable */
    360 
    361 #define	STGE_StatisticsMask		0x9c	/* set to disable */
    362 
    363 #define	STGE_RxJumboFrames		0xbc	/* 16-bit */
    364 
    365 #define	STGE_TCPCheckSumErrors		0xc0	/* 16-bit */
    366 
    367 #define	STGE_IPCheckSumErrors		0xc2	/* 16-bit */
    368 
    369 #define	STGE_UDPCheckSumErrors		0xc4	/* 16-bit */
    370 
    371 #define	STGE_TxJumboFrames		0xf4	/* 16-bit */
    372 
    373 /*
    374  * TC9021 statistics.  Available memory and I/O mapped.
    375  */
    376 
    377 #define	STGE_OctetRcvOk			0xa8
    378 
    379 #define	STGE_McstOctetRcvdOk		0xac
    380 
    381 #define	STGE_BcstOctetRcvdOk		0xb0
    382 
    383 #define	STGE_FramesRcvdOk		0xb4
    384 
    385 #define	STGE_McstFramesRcvdOk		0xb8
    386 
    387 #define	STGE_BcstFramesRcvdOk		0xbe	/* 16-bit */
    388 
    389 #define	STGE_MacControlFramesRcvd	0xc6	/* 16-bit */
    390 
    391 #define	STGE_FrameTooLongErrors		0xc8	/* 16-bit */
    392 
    393 #define	STGE_InRangeLengthErrors	0xca	/* 16-bit */
    394 
    395 #define	STGE_FramesCheckSeqErrors	0xcc	/* 16-bit */
    396 
    397 #define	STGE_FramesLostRxErrors		0xce	/* 16-bit */
    398 
    399 #define	STGE_OctetXmtdOk		0xd0
    400 
    401 #define	STGE_McstOctetXmtdOk		0xd4
    402 
    403 #define	STGE_BcstOctetXmtdOk		0xd8
    404 
    405 #define	STGE_FramesXmtdOk		0xdc
    406 
    407 #define	STGE_McstFramesXmtdOk		0xe0
    408 
    409 #define	STGE_FramesWDeferredXmt		0xe4
    410 
    411 #define	STGE_LateCollisions		0xe8
    412 
    413 #define	STGE_MultiColFrames		0xec
    414 
    415 #define	STGE_SingleColFrames		0xf0
    416 
    417 #define	STGE_BcstFramesXmtdOk		0xf6	/* 16-bit */
    418 
    419 #define	STGE_CarrierSenseErrors		0xf8	/* 16-bit */
    420 
    421 #define	STGE_MacControlFramesXmtd	0xfa	/* 16-bit */
    422 
    423 #define	STGE_FramesAbortXSColls		0xfc	/* 16-bit */
    424 
    425 #define	STGE_FramesWEXDeferal		0xfe	/* 16-bit */
    426 
    427 /*
    428  * RMON-compatible statistics.  Only accessible if memory-mapped.
    429  */
    430 
    431 #define	STGE_EtherStatsCollisions			0x100
    432 
    433 #define	STGE_EtherStatsOctetsTransmit			0x104
    434 
    435 #define	STGE_EtherStatsPktsTransmit			0x108
    436 
    437 #define	STGE_EtherStatsPkts64OctetsTransmit		0x10c
    438 
    439 #define	STGE_EtherStatsPkts64to127OctetsTransmit	0x110
    440 
    441 #define	STGE_EtherStatsPkts128to255OctetsTransmit	0x114
    442 
    443 #define	STGE_EtherStatsPkts256to511OctetsTransmit	0x118
    444 
    445 #define	STGE_EtherStatsPkts512to1023OctetsTransmit	0x11c
    446 
    447 #define	STGE_EtherStatsPkts1024to1518OctetsTransmit	0x120
    448 
    449 #define	STGE_EtherStatsCRCAlignErrors			0x124
    450 
    451 #define	STGE_EtherStatsUndersizePkts			0x128
    452 
    453 #define	STGE_EtherStatsFragments			0x12c
    454 
    455 #define	STGE_EtherStatsJabbers				0x130
    456 
    457 #define	STGE_EtherStatsOctets				0x134
    458 
    459 #define	STGE_EtherStatsPkts				0x138
    460 
    461 #define	STGE_EtherStatsPkts64Octets			0x13c
    462 
    463 #define	STGE_EtherStatsPkts65to127Octets		0x140
    464 
    465 #define	STGE_EtherStatsPkts128to255Octets		0x144
    466 
    467 #define	STGE_EtherStatsPkts256to511Octets		0x148
    468 
    469 #define	STGE_EtherStatsPkts512to1023Octets		0x14c
    470 
    471 #define	STGE_EtherStatsPkts1024to1518Octets		0x150
    472 
    473 /*
    474  * Transmit descriptor list size.
    475  */
    476 #define	STGE_NTXDESC		256
    477 #define	STGE_NTXDESC_MASK	(STGE_NTXDESC - 1)
    478 #define	STGE_NEXTTX(x)		(((x) + 1) & STGE_NTXDESC_MASK)
    479 
    480 /*
    481  * Receive descriptor list size.
    482  */
    483 #define	STGE_NRXDESC		256
    484 #define	STGE_NRXDESC_MASK	(STGE_NRXDESC - 1)
    485 #define	STGE_NEXTRX(x)		(((x) + 1) & STGE_NRXDESC_MASK)
    486 
    487 /*
    488  * Only interrupt every N frames.  Must be a power-of-two.
    489  */
    490 #define	STGE_TXINTR_SPACING	16
    491 #define	STGE_TXINTR_SPACING_MASK (STGE_TXINTR_SPACING - 1)
    492 
    493 /*
    494  * Control structures are DMA'd to the TC9021 chip.  We allocate them in
    495  * a single clump that maps to a single DMA segment to make several things
    496  * easier.
    497  */
    498 struct stge_control_data {
    499 	/*
    500 	 * The transmit descriptors.
    501 	 */
    502 	struct stge_tfd scd_txdescs[STGE_NTXDESC];
    503 
    504 	/*
    505 	 * The receive descriptors.
    506 	 */
    507 	struct stge_rfd scd_rxdescs[STGE_NRXDESC];
    508 };
    509 
    510 #define	STGE_CDOFF(x)	offsetof(struct stge_control_data, x)
    511 #define	STGE_CDTXOFF(x)	STGE_CDOFF(scd_txdescs[(x)])
    512 #define	STGE_CDRXOFF(x)	STGE_CDOFF(scd_rxdescs[(x)])
    513 
    514 /*
    515  * Software state for transmit and receive jobs.
    516  */
    517 struct stge_descsoft {
    518 	struct mbuf *ds_mbuf;		/* head of our mbuf chain */
    519 	bus_dmamap_t ds_dmamap;		/* our DMA map */
    520 };
    521 
    522 /*
    523  * Software state per device.
    524  */
    525 struct stge_softc {
    526 	device_t sc_dev;		/* generic device information */
    527 	bus_space_tag_t sc_st;		/* bus space tag */
    528 	bus_space_handle_t sc_sh;	/* bus space handle */
    529 	bus_dma_tag_t sc_dmat;		/* bus DMA tag */
    530 	struct ethercom sc_ethercom;	/* ethernet common data */
    531 	int sc_rev;			/* silicon revision */
    532 
    533 	void *sc_ih;			/* interrupt cookie */
    534 
    535 	struct mii_data sc_mii;		/* MII/media information */
    536 
    537 	callout_t sc_tick_ch;		/* tick callout */
    538 
    539 	bus_dmamap_t sc_cddmamap;	/* control data DMA map */
    540 #define	sc_cddma	sc_cddmamap->dm_segs[0].ds_addr
    541 
    542 	/*
    543 	 * Software state for transmit and receive descriptors.
    544 	 */
    545 	struct stge_descsoft sc_txsoft[STGE_NTXDESC];
    546 	struct stge_descsoft sc_rxsoft[STGE_NRXDESC];
    547 
    548 	/*
    549 	 * Control data structures.
    550 	 */
    551 	struct stge_control_data *sc_control_data;
    552 #define	sc_txdescs	sc_control_data->scd_txdescs
    553 #define	sc_rxdescs	sc_control_data->scd_rxdescs
    554 
    555 #ifdef STGE_EVENT_COUNTERS
    556 	/*
    557 	 * Event counters.
    558 	 */
    559 	struct evcnt sc_ev_txstall;	/* Tx stalled */
    560 	struct evcnt sc_ev_txdmaintr;	/* Tx DMA interrupts */
    561 	struct evcnt sc_ev_txindintr;	/* Tx Indicate interrupts */
    562 	struct evcnt sc_ev_rxintr;	/* Rx interrupts */
    563 
    564 	struct evcnt sc_ev_txseg1;	/* Tx packets w/ 1 segment */
    565 	struct evcnt sc_ev_txseg2;	/* Tx packets w/ 2 segments */
    566 	struct evcnt sc_ev_txseg3;	/* Tx packets w/ 3 segments */
    567 	struct evcnt sc_ev_txseg4;	/* Tx packets w/ 4 segments */
    568 	struct evcnt sc_ev_txseg5;	/* Tx packets w/ 5 segments */
    569 	struct evcnt sc_ev_txsegmore;	/* Tx packets w/ more than 5 segments */
    570 	struct evcnt sc_ev_txcopy;	/* Tx packets that we had to copy */
    571 
    572 	struct evcnt sc_ev_rxipsum;	/* IP checksums checked in-bound */
    573 	struct evcnt sc_ev_rxtcpsum;	/* TCP checksums checked in-bound */
    574 	struct evcnt sc_ev_rxudpsum;	/* UDP checksums checked in-bound */
    575 
    576 	struct evcnt sc_ev_txipsum;	/* IP checksums comp. out-bound */
    577 	struct evcnt sc_ev_txtcpsum;	/* TCP checksums comp. out-bound */
    578 	struct evcnt sc_ev_txudpsum;	/* UDP checksums comp. out-bound */
    579 #endif /* STGE_EVENT_COUNTERS */
    580 
    581 	int	sc_txpending;		/* number of Tx requests pending */
    582 	int	sc_txdirty;		/* first dirty Tx descriptor */
    583 	int	sc_txlast;		/* last used Tx descriptor */
    584 
    585 	int	sc_rxptr;		/* next ready Rx descriptor/descsoft */
    586 	int	sc_rxdiscard;
    587 	int	sc_rxlen;
    588 	struct mbuf *sc_rxhead;
    589 	struct mbuf *sc_rxtail;
    590 	struct mbuf **sc_rxtailp;
    591 
    592 	int	sc_txthresh;		/* Tx threshold */
    593 	uint32_t sc_usefiber:1;		/* if we're fiber */
    594 	uint32_t sc_stge1023:1;		/* are we a 1023 */
    595 	uint32_t sc_DMACtrl;		/* prototype DMACtrl register */
    596 	uint32_t sc_MACCtrl;		/* prototype MacCtrl register */
    597 	uint16_t sc_IntEnable;		/* prototype IntEnable register */
    598 	uint16_t sc_ReceiveMode;	/* prototype ReceiveMode register */
    599 	uint8_t sc_PhyCtrl;		/* prototype PhyCtrl register */
    600 };
    601 
    602 #define	STGE_RXCHAIN_RESET(sc)						\
    603 do {									\
    604 	(sc)->sc_rxtailp = &(sc)->sc_rxhead;				\
    605 	*(sc)->sc_rxtailp = NULL;					\
    606 	(sc)->sc_rxlen = 0;						\
    607 } while (/*CONSTCOND*/0)
    608 
    609 #define	STGE_RXCHAIN_LINK(sc, m)					\
    610 do {									\
    611 	*(sc)->sc_rxtailp = (sc)->sc_rxtail = (m);			\
    612 	(sc)->sc_rxtailp = &(m)->m_next;				\
    613 } while (/*CONSTCOND*/0)
    614 
    615 #define STGE_TIMEOUT	1000
    616 
    617 #endif /* _DEV_PCI_IF_STGEREG_H_ */
    618