3 * 10/100/1000 Base-T Ethernet Driver for the ET1301 and ET131x series MACs
5 * Copyright © 2005 Agere Systems Inc.
9 *------------------------------------------------------------------------------
11 * et1310_rx.h - Defines, structs, enums, prototypes, etc. pertaining to data
14 *------------------------------------------------------------------------------
18 * This software is provided subject to the following terms and conditions,
19 * which you should read carefully before using the software. Using this
20 * software indicates your acceptance of these terms and conditions. If you do
21 * not agree with these terms and conditions, do not use the software.
23 * Copyright © 2005 Agere Systems Inc.
24 * All rights reserved.
26 * Redistribution and use in source or binary forms, with or without
27 * modifications, are permitted provided that the following conditions are met:
29 * . Redistributions of source code must retain the above copyright notice, this
30 * list of conditions and the following Disclaimer as comments in the code as
31 * well as in the documentation and/or other materials provided with the
34 * . Redistributions in binary form must reproduce the above copyright notice,
35 * this list of conditions and the following Disclaimer in the documentation
36 * and/or other materials provided with the distribution.
38 * . Neither the name of Agere Systems Inc. nor the names of the contributors
39 * may be used to endorse or promote products derived from this software
40 * without specific prior written permission.
44 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
45 * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
46 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ANY
47 * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN
48 * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY
49 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
50 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
51 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
52 * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
54 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
59 #ifndef __ET1310_RX_H__
60 #define __ET1310_RX_H__
62 #include "et1310_address_map.h"
67 /* #define FBR0_BUFFER_SIZE 256 */
70 /* #define FBR1_BUFFER_SIZE 2048 */
74 #define MAX_DESC_PER_RING_RX 1024
76 /* number of RFDs - default and min */
78 #define RFD_LOW_WATER_MARK 40
79 #define NIC_MIN_NUM_RFD 64
80 #define NIC_DEFAULT_NUM_RFD 1024
82 #define RFD_LOW_WATER_MARK 20
83 #define NIC_MIN_NUM_RFD 64
84 #define NIC_DEFAULT_NUM_RFD 256
87 #define NUM_PACKETS_HANDLED 256
89 #define ALCATEL_BAD_STATUS 0xe47f0000
90 #define ALCATEL_MULTICAST_PKT 0x01000000
91 #define ALCATEL_BROADCAST_PKT 0x02000000
93 /* typedefs for Free Buffer Descriptors */
98 u32 word2; /* Bits 10-31 reserved, 0-9 descriptor */
101 /* Packet Status Ring Descriptors
105 * top 16 bits are from the Alcatel Status Word as enumerated in
106 * PE-MCXMAC Data Sheet IPD DS54 0210-1 (also IPD-DS80 0205-2)
109 * 1: ipa IP checksum assist
110 * 2: ipp IP checksum pass
111 * 3: tcpa TCP checksum assist
112 * 4: tcpp TCP checksum pass
114 * 6: rxmac_error RXMAC Error Indicator
115 * 7: drop Drop packet
116 * 8: ft Frame Truncated
120 * 16: asw_prev_pkt_dropped e.g. IFG too small on previous
121 * 17: asw_RX_DV_event short receive event detected
122 * 18: asw_false_carrier_event bad carrier since last good packet
123 * 19: asw_code_err one or more nibbles signalled as errors
124 * 20: asw_CRC_err CRC error
125 * 21: asw_len_chk_err frame length field incorrect
126 * 22: asw_too_long frame length > 1518 bytes
127 * 23: asw_OK valid CRC + no code error
128 * 24: asw_multicast has a multicast address
129 * 25: asw_broadcast has a broadcast address
130 * 26: asw_dribble_nibble spurious bits after EOP
131 * 27: asw_control_frame is a control frame
132 * 28: asw_pause_frame is a pause frame
133 * 29: asw_unsupported_op unsupported OP code
134 * 30: asw_VLAN_tag VLAN tag detected
135 * 31: asw_long_evt Rx long event
138 * 0-15: length length in bytes
139 * 16-25: bi Buffer Index
140 * 26-27: ri Ring Index
144 struct pkt_stat_desc {
149 /* Typedefs for the RX DMA status word */
152 * rx status word 0 holds part of the status bits of the Rx DMA engine
153 * that get copied out to memory by the ET-1310. Word 0 is a 32 bit word
154 * which contains the Free Buffer ring 0 and 1 available offset.
156 * bit 0-9 FBR1 offset
157 * bit 10 Wrap flag for FBR1
158 * bit 16-25 FBR0 offset
159 * bit 26 Wrap flag for FBR0
163 * RXSTAT_WORD1_t structure holds part of the status bits of the Rx DMA engine
164 * that get copied out to memory by the ET-1310. Word 3 is a 32 bit word
165 * which contains the Packet Status Ring available offset.
168 * bit 16-27 PSRoffset
174 * struct rx_status_block is a structure representing the status of the Rx
175 * DMA engine it sits in free memory, and is pointed to by 0x101c / 0x1020
177 struct rx_status_block {
183 * Structure for look-up table holding free buffer ring pointers
186 void *virt[MAX_DESC_PER_RING_RX];
187 void *buffer1[MAX_DESC_PER_RING_RX];
188 void *buffer2[MAX_DESC_PER_RING_RX];
189 u32 bus_high[MAX_DESC_PER_RING_RX];
190 u32 bus_low[MAX_DESC_PER_RING_RX];
194 * struct rx_ring is the ssructure representing the adaptor's local
195 * reference(s) to the rings
200 dma_addr_t pFbr0RingPa;
201 void *Fbr0MemVa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
202 dma_addr_t Fbr0MemPa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
210 dma_addr_t pFbr1RingPa;
211 void *Fbr1MemVa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
212 dma_addr_t Fbr1MemPa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
215 struct fbr_lookup *fbr[2]; /* One per ring */
221 dma_addr_t pPSRingPa;
225 struct rx_status_block *rx_status_block;
226 dma_addr_t rx_status_bus;
228 struct list_head RecvBufferPool;
231 struct list_head RecvList;
236 bool UnfinishedReceives;
238 struct list_head RecvPacketPool;
240 /* lookaside lists */
241 struct kmem_cache *RecvLookaside;
244 #endif /* __ET1310_RX_H__ */