drivers/staging/et131x/et1310_rx.h

   1 /*
   2  * Agere Systems Inc.
   3  * 10/100/1000 Base-T Ethernet Driver for the ET1301 and ET131x series MACs
   4  *
   5  * Copyright © 2005 Agere Systems Inc.
   6  * All rights reserved.
   7  *   http://www.agere.com
   8  *
   9  *------------------------------------------------------------------------------
  10  *
  11  * et1310_rx.h - Defines, structs, enums, prototypes, etc. pertaining to data
  12  *               reception.
  13  *
  14  *------------------------------------------------------------------------------
  15  *
  16  * SOFTWARE LICENSE
  17  *
  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.
  22  *
  23  * Copyright © 2005 Agere Systems Inc.
  24  * All rights reserved.
  25  *
  26  * Redistribution and use in source or binary forms, with or without
  27  * modifications, are permitted provided that the following conditions are met:
  28  *
  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
  32  *    distribution.
  33  *
  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.
  37  *
  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.
  41  *
  42  * Disclaimer
  43  *
  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
  55  * DAMAGE.
  56  *
  57  */
  58
  59 #ifndef __ET1310_RX_H__
  60 #define __ET1310_RX_H__
  61
  62 #include "et1310_address_map.h"
  63
  64 #define USE_FBR0 true
  65
  66 #ifdef USE_FBR0
  67 /* #define FBR0_BUFFER_SIZE 256 */
  68 #endif
  69
  70 /* #define FBR1_BUFFER_SIZE 2048 */
  71
  72 #define FBR_CHUNKS 32
  73
  74 #define MAX_DESC_PER_RING_RX         1024
  75
  76 /* number of RFDs - default and min */
  77 #ifdef USE_FBR0
  78 #define RFD_LOW_WATER_MARK      40
  79 #define NIC_MIN_NUM_RFD         64
  80 #define NIC_DEFAULT_NUM_RFD     1024
  81 #else
  82 #define RFD_LOW_WATER_MARK      20
  83 #define NIC_MIN_NUM_RFD         64
  84 #define NIC_DEFAULT_NUM_RFD     256
  85 #endif
  86
  87 #define NUM_PACKETS_HANDLED     256
  88
  89 #define ALCATEL_BAD_STATUS      0xe47f0000
  90 #define ALCATEL_MULTICAST_PKT   0x01000000
  91 #define ALCATEL_BROADCAST_PKT   0x02000000
  92
  93 /* typedefs for Free Buffer Descriptors */
  94 struct fbr_desc
  95 {
  96         u32 addr_lo;
  97         u32 addr_hi;
  98         u32 word2;              /* Bits 10-31 reserved, 0-9 descriptor */
  99 };
 100
 101 /* Typedefs for Packet Status Ring Descriptors */
 102 typedef union _PKT_STAT_DESC_WORD0_t {
 103         u32 value;
 104         struct {
 105 #ifdef _BIT_FIELDS_HTOL
 106                 /* top 16 bits are from the Alcatel Status Word as enumerated in */
 107                 /* PE-MCXMAC Data Sheet IPD DS54 0210-1 (also IPD-DS80 0205-2) */
 108 #if 0
 109                 u32 asw_trunc:1;                /* bit 31(Rx frame truncated) */
 110 #endif
 111                 u32 asw_long_evt:1;     /* bit 31(Rx long event) */
 112                 u32 asw_VLAN_tag:1;     /* bit 30(VLAN tag detected) */
 113                 u32 asw_unsupported_op:1;       /* bit 29(unsupported OP code) */
 114                 u32 asw_pause_frame:1;  /* bit 28(is a pause frame) */
 115                 u32 asw_control_frame:1;        /* bit 27(is a control frame) */
 116                 u32 asw_dribble_nibble:1;       /* bit 26(spurious bits after EOP) */
 117                 u32 asw_broadcast:1;    /* bit 25(has a broadcast address) */
 118                 u32 asw_multicast:1;    /* bit 24(has a multicast address) */
 119                 u32 asw_OK:1;           /* bit 23(valid CRC + no code error) */
 120                 u32 asw_too_long:1;     /* bit 22(frame length > 1518 bytes) */
 121                 u32 asw_len_chk_err:1;  /* bit 21(frame length field incorrect) */
 122                 u32 asw_CRC_err:1;              /* bit 20(CRC error) */
 123                 u32 asw_code_err:1;     /* bit 19(one or more nibbles signalled as errors) */
 124                 u32 asw_false_carrier_event:1;  /* bit 18(bad carrier since last good packet) */
 125                 u32 asw_RX_DV_event:1;  /* bit 17(short receive event detected) */
 126                 u32 asw_prev_pkt_dropped:1;/* bit 16(e.g. IFG too small on previous) */
 127                 u32 unused:5;           /* bits 11-15 */
 128                 u32 vp:1;                       /* bit 10(VLAN Packet) */
 129                 u32 jp:1;                       /* bit 9(Jumbo Packet) */
 130                 u32 ft:1;                       /* bit 8(Frame Truncated) */
 131                 u32 drop:1;             /* bit 7(Drop packet) */
 132                 u32 rxmac_error:1;              /* bit 6(RXMAC Error Indicator) */
 133                 u32 wol:1;                      /* bit 5(WOL Event) */
 134                 u32 tcpp:1;             /* bit 4(TCP checksum pass) */
 135                 u32 tcpa:1;             /* bit 3(TCP checksum assist) */
 136                 u32 ipp:1;                      /* bit 2(IP checksum pass) */
 137                 u32 ipa:1;                      /* bit 1(IP checksum assist) */
 138                 u32 hp:1;                       /* bit 0(hash pass) */
 139 #else
 140                 u32 hp:1;                       /* bit 0(hash pass) */
 141                 u32 ipa:1;                      /* bit 1(IP checksum assist) */
 142                 u32 ipp:1;                      /* bit 2(IP checksum pass) */
 143                 u32 tcpa:1;             /* bit 3(TCP checksum assist) */
 144                 u32 tcpp:1;             /* bit 4(TCP checksum pass) */
 145                 u32 wol:1;                      /* bit 5(WOL Event) */
 146                 u32 rxmac_error:1;              /* bit 6(RXMAC Error Indicator) */
 147                 u32 drop:1;             /* bit 7(Drop packet) */
 148                 u32 ft:1;                       /* bit 8(Frame Truncated) */
 149                 u32 jp:1;                       /* bit 9(Jumbo Packet) */
 150                 u32 vp:1;                       /* bit 10(VLAN Packet) */
 151                 u32 unused:5;           /* bits 11-15 */
 152                 u32 asw_prev_pkt_dropped:1;/* bit 16(e.g. IFG too small on previous) */
 153                 u32 asw_RX_DV_event:1;  /* bit 17(short receive event detected) */
 154                 u32 asw_false_carrier_event:1;  /* bit 18(bad carrier since last good packet) */
 155                 u32 asw_code_err:1;     /* bit 19(one or more nibbles signalled as errors) */
 156                 u32 asw_CRC_err:1;              /* bit 20(CRC error) */
 157                 u32 asw_len_chk_err:1;  /* bit 21(frame length field incorrect) */
 158                 u32 asw_too_long:1;     /* bit 22(frame length > 1518 bytes) */
 159                 u32 asw_OK:1;           /* bit 23(valid CRC + no code error) */
 160                 u32 asw_multicast:1;    /* bit 24(has a multicast address) */
 161                 u32 asw_broadcast:1;    /* bit 25(has a broadcast address) */
 162                 u32 asw_dribble_nibble:1;       /* bit 26(spurious bits after EOP) */
 163                 u32 asw_control_frame:1;        /* bit 27(is a control frame) */
 164                 u32 asw_pause_frame:1;  /* bit 28(is a pause frame) */
 165                 u32 asw_unsupported_op:1;       /* bit 29(unsupported OP code) */
 166                 u32 asw_VLAN_tag:1;     /* bit 30(VLAN tag detected) */
 167                 u32 asw_long_evt:1;     /* bit 31(Rx long event) */
 168 #if 0
 169                 u32 asw_trunc:1;                /* bit 31(Rx frame truncated) */
 170 #endif
 171 #endif
 172         } bits;
 173 } PKT_STAT_DESC_WORD0_t, *PPKT_STAT_WORD0_t;
 174
 175 typedef union _PKT_STAT_DESC_WORD1_t {
 176         u32 value;
 177         struct {
 178 #ifdef _BIT_FIELDS_HTOL
 179                 u32 unused:4;   /* bits 28-31 */
 180                 u32 ri:2;               /* bits 26-27(Ring Index) */
 181                 u32 bi:10;              /* bits 16-25(Buffer Index) */
 182                 u32 length:16;  /* bit 0-15(length in bytes) */
 183 #else
 184                 u32 length:16;  /* bit 0-15(length in bytes) */
 185                 u32 bi:10;              /* bits 16-25(Buffer Index) */
 186                 u32 ri:2;               /* bits 26-27(Ring Index) */
 187                 u32 unused:4;   /* bits 28-31 */
 188 #endif
 189         } bits;
 190 } PKT_STAT_DESC_WORD1_t, *PPKT_STAT_WORD1_t;
 191
 192 typedef struct _PKT_STAT_DESC_t {
 193         PKT_STAT_DESC_WORD0_t word0;
 194         PKT_STAT_DESC_WORD1_t word1;
 195 } PKT_STAT_DESC_t, *PPKT_STAT_DESC_t;
 196
 197 /* Typedefs for the RX DMA status word */
 198
 199 /*
 200  * rx status word 0 holds part of the status bits of the Rx DMA engine
 201  * that get copied out to memory by the ET-1310.  Word 0 is a 32 bit word
 202  * which contains the Free Buffer ring 0 and 1 available offset.
 203  *
 204  * bit 0-9 FBR1 offset
 205  * bit 10 Wrap flag for FBR1
 206  * bit 16-25 FBR0 offset
 207  * bit 26 Wrap flag for FBR0
 208  */
 209
 210 /*
 211  * RXSTAT_WORD1_t structure holds part of the status bits of the Rx DMA engine
 212  * that get copied out to memory by the ET-1310.  Word 3 is a 32 bit word
 213  * which contains the Packet Status Ring available offset.
 214  *
 215  * bit 0-15 reserved
 216  * bit 16-27 PSRoffset
 217  * bit 28 PSRwrap
 218  * bit 29-31 unused
 219  */
 220
 221 /*
 222  * RX_STATUS_BLOCK_t is sructure representing the status of the Rx DMA engine
 223  * it sits in free memory, and is pointed to by 0x101c / 0x1020
 224  */
 225 typedef struct _rx_status_block_t {
 226         u32 Word0;
 227         u32 Word1;
 228 } RX_STATUS_BLOCK_t, *PRX_STATUS_BLOCK_t;
 229
 230 /*
 231  * Structure for look-up table holding free buffer ring pointers
 232  */
 233 typedef struct _FbrLookupTable {
 234         void *Va[MAX_DESC_PER_RING_RX];
 235         void *Buffer1[MAX_DESC_PER_RING_RX];
 236         void *Buffer2[MAX_DESC_PER_RING_RX];
 237         u32 PAHigh[MAX_DESC_PER_RING_RX];
 238         u32 PALow[MAX_DESC_PER_RING_RX];
 239 } FBRLOOKUPTABLE, *PFBRLOOKUPTABLE;
 240
 241 typedef enum {
 242         ONE_PACKET_INTERRUPT,
 243         FOUR_PACKET_INTERRUPT
 244 } eRX_INTERRUPT_STATE_t, *PeRX_INTERRUPT_STATE_t;
 245
 246 /*
 247  * RX_RING_t is sructure representing the adaptor's local reference(s) to the
 248  * rings
 249  */
 250 typedef struct _rx_ring_t {
 251 #ifdef USE_FBR0
 252         void *pFbr0RingVa;
 253         dma_addr_t pFbr0RingPa;
 254         void *Fbr0MemVa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
 255         dma_addr_t Fbr0MemPa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
 256         uint64_t Fbr0Realpa;
 257         uint64_t Fbr0offset;
 258         u32 local_Fbr0_full;
 259         u32 Fbr0NumEntries;
 260         u32 Fbr0BufferSize;
 261 #endif
 262         void *pFbr1RingVa;
 263         dma_addr_t pFbr1RingPa;
 264         void *Fbr1MemVa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
 265         dma_addr_t Fbr1MemPa[MAX_DESC_PER_RING_RX / FBR_CHUNKS];
 266         uint64_t Fbr1Realpa;
 267         uint64_t Fbr1offset;
 268         FBRLOOKUPTABLE *Fbr[2];
 269         u32 local_Fbr1_full;
 270         u32 Fbr1NumEntries;
 271         u32 Fbr1BufferSize;
 272
 273         void *pPSRingVa;
 274         dma_addr_t pPSRingPa;
 275         u32 local_psr_full;
 276         u32 PsrNumEntries;
 277
 278         void *pRxStatusVa;
 279         dma_addr_t pRxStatusPa;
 280
 281         struct list_head RecvBufferPool;
 282
 283         /* RECV */
 284         struct list_head RecvList;
 285         u32 nReadyRecv;
 286
 287         u32 NumRfd;
 288
 289         bool UnfinishedReceives;
 290
 291         struct list_head RecvPacketPool;
 292
 293         /* lookaside lists */
 294         struct kmem_cache *RecvLookaside;
 295 } RX_RING_t, *PRX_RING_t;
 296
 297 /* Forward reference of RFD */
 298 struct _MP_RFD;
 299
 300 /* Forward declaration of the private adapter structure */
 301 struct et131x_adapter;
 302
 303 /* PROTOTYPES for Initialization */
 304 int et131x_rx_dma_memory_alloc(struct et131x_adapter *adapter);
 305 void et131x_rx_dma_memory_free(struct et131x_adapter *adapter);
 306 int et131x_rfd_resources_alloc(struct et131x_adapter *adapter,
 307                                struct _MP_RFD *pMpRfd);
 308 void et131x_rfd_resources_free(struct et131x_adapter *adapter,
 309                                struct _MP_RFD *pMpRfd);
 310 int et131x_init_recv(struct et131x_adapter *adapter);
 311
 312 void ConfigRxDmaRegs(struct et131x_adapter *adapter);
 313 void SetRxDmaTimer(struct et131x_adapter *adapter);
 314 void et131x_rx_dma_disable(struct et131x_adapter *adapter);
 315 void et131x_rx_dma_enable(struct et131x_adapter *adapter);
 316
 317 void et131x_reset_recv(struct et131x_adapter *adapter);
 318
 319 void et131x_handle_recv_interrupt(struct et131x_adapter *adapter);
 320
 321 #endif /* __ET1310_RX_H__ */