drivers/staging/et131x/et131x_adapter.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  * et131x_adapter.h - Header which includes the private adapter structure, along
  12  *                    with related support structures, macros, definitions, etc.
  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 __ET131X_ADAPTER_H__
  60 #define __ET131X_ADAPTER_H__
  61
  62 #include "et1310_address_map.h"
  63 #include "et1310_tx.h"
  64 #include "et1310_rx.h"
  65
  66 /*
  67  * Do not change these values: if changed, then change also in respective
  68  * TXdma and Rxdma engines
  69  */
  70 #define NUM_DESC_PER_RING_TX         512    /* TX Do not change these values */
  71 #define NUM_TCB                      64
  72
  73 /*
  74  * These values are all superseded by registry entries to facilitate tuning.
  75  * Once the desired performance has been achieved, the optimal registry values
  76  * should be re-populated to these #defines:
  77  */
  78 #define NUM_TRAFFIC_CLASSES          1
  79
  80 #define TX_ERROR_PERIOD             1000
  81
  82 #define LO_MARK_PERCENT_FOR_PSR     15
  83 #define LO_MARK_PERCENT_FOR_RX      15
  84
  85 /* RFD (Receive Frame Descriptor) */
  86 struct rfd {
  87         struct list_head list_node;
  88         struct sk_buff *skb;
  89         u32 len;        /* total size of receive frame */
  90         u16 bufferindex;
  91         u8 ringindex;
  92 };
  93
  94 /* Flow Control */
  95 #define FLOW_BOTH       0
  96 #define FLOW_TXONLY     1
  97 #define FLOW_RXONLY     2
  98 #define FLOW_NONE       3
  99
 100 /* Struct to define some device statistics */
 101 struct ce_stats {
 102         /* MIB II variables
 103          *
 104          * NOTE: atomic_t types are only guaranteed to store 24-bits; if we
 105          * MUST have 32, then we'll need another way to perform atomic
 106          * operations
 107          */
 108         u32 unircv;     /* # multicast packets received */
 109         atomic_t unixmt;        /* # multicast packets for Tx */
 110         u32 multircv;   /* # multicast packets received */
 111         atomic_t multixmt;      /* # multicast packets for Tx */
 112         u32 brdcstrcv;  /* # broadcast packets received */
 113         atomic_t brdcstxmt;     /* # broadcast packets for Tx */
 114         u32 norcvbuf;   /* # Rx packets discarded */
 115         u32 noxmtbuf;   /* # Tx packets discarded */
 116
 117         /* Transceiver state informations. */
 118         u8 xcvr_addr;
 119         u32 xcvr_id;
 120
 121         /* Tx Statistics. */
 122         u32 tx_uflo;            /* Tx Underruns */
 123
 124         u32 collisions;
 125         u32 excessive_collisions;
 126         u32 first_collision;
 127         u32 late_collisions;
 128         u32 max_pkt_error;
 129         u32 tx_deferred;
 130
 131         /* Rx Statistics. */
 132         u32 rx_ov_flow; /* Rx Overflow */
 133
 134         u32 length_err;
 135         u32 alignment_err;
 136         u32 crc_err;
 137         u32 code_violations;
 138         u32 other_errors;
 139
 140         u32 SynchrounousIterations;
 141         u32 InterruptStatus;
 142 };
 143
 144
 145 /* The private adapter structure */
 146 struct et131x_adapter {
 147         struct net_device *netdev;
 148         struct pci_dev *pdev;
 149
 150         struct work_struct task;
 151
 152         /* Flags that indicate current state of the adapter */
 153         u32 flags;
 154         u32 HwErrCount;
 155
 156         /* Configuration  */
 157         u8 rom_addr[ETH_ALEN];
 158         u8 addr[ETH_ALEN];
 159         bool has_eeprom;
 160         u8 eeprom_data[2];
 161
 162         /* Spinlocks */
 163         spinlock_t Lock;
 164
 165         spinlock_t TCBSendQLock;
 166         spinlock_t TCBReadyQLock;
 167         spinlock_t send_hw_lock;
 168
 169         spinlock_t rcv_lock;
 170         spinlock_t RcvPendLock;
 171         spinlock_t FbrLock;
 172
 173         spinlock_t PHYLock;
 174
 175         /* Packet Filter and look ahead size */
 176         u32 PacketFilter;
 177         u32 linkspeed;
 178         u32 duplex_mode;
 179
 180         /* multicast list */
 181         u32 MCAddressCount;
 182         u8 MCList[NIC_MAX_MCAST_LIST][ETH_ALEN];
 183
 184         /* Pointer to the device's PCI register space */
 185         struct address_map __iomem *regs;
 186
 187         /* Registry parameters */
 188         u8 SpeedDuplex;         /* speed/duplex */
 189         u8 wanted_flow;         /* Flow we want for 802.3x flow control */
 190         u8 RegistryPhyComa;     /* Phy Coma mode enable/disable */
 191
 192         u32 RegistryRxMemEnd;   /* Size of internal rx memory */
 193         u32 RegistryJumboPacket;        /* Max supported ethernet packet size */
 194
 195
 196         /* Derived from the registry: */
 197         u8 AiForceDpx;          /* duplex setting */
 198         u16 AiForceSpeed;       /* 'Speed', user over-ride of line speed */
 199         u8 flowcontrol;         /* flow control validated by the far-end */
 200         enum {
 201                 NETIF_STATUS_INVALID = 0,
 202                 NETIF_STATUS_MEDIA_CONNECT,
 203                 NETIF_STATUS_MEDIA_DISCONNECT,
 204                 NETIF_STATUS_MAX
 205         } MediaState;
 206
 207         /* Minimize init-time */
 208         struct timer_list ErrorTimer;
 209
 210         /* variable putting the phy into coma mode when boot up with no cable
 211          * plugged in after 5 seconds
 212          */
 213         u8 boot_coma;
 214
 215         /* Next two used to save power information at power down. This
 216          * information will be used during power up to set up parts of Power
 217          * Management in JAGCore
 218          */
 219         u16 pdown_speed;
 220         u8 pdown_duplex;
 221
 222         u32 CachedMaskValue;
 223
 224         /* Xcvr status at last poll */
 225         u16 bmsr;
 226
 227         /* Tx Memory Variables */
 228         struct tx_ring tx_ring;
 229
 230         /* Rx Memory Variables */
 231         struct rx_ring rx_ring;
 232
 233         /* Loopback specifics */
 234         u8 ReplicaPhyLoopbk;    /* Replica Enable */
 235         u8 ReplicaPhyLoopbkPF;  /* Replica Enable Pass/Fail */
 236
 237         /* Stats */
 238         struct ce_stats stats;
 239
 240         struct net_device_stats net_stats;
 241 };
 242
 243 #endif /* __ET131X_ADAPTER_H__ */