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         /* Link Input/Output stats */
 103         uint64_t ipackets;      /* # of in packets */
 104         uint64_t opackets;      /* # of out packets */
 105
 106         /* MIB II variables
 107          *
 108          * NOTE: atomic_t types are only guaranteed to store 24-bits; if we
 109          * MUST have 32, then we'll need another way to perform atomic
 110          * operations
 111          */
 112         u32 unircv;     /* # multicast packets received */
 113         atomic_t unixmt;        /* # multicast packets for Tx */
 114         u32 multircv;   /* # multicast packets received */
 115         atomic_t multixmt;      /* # multicast packets for Tx */
 116         u32 brdcstrcv;  /* # broadcast packets received */
 117         atomic_t brdcstxmt;     /* # broadcast packets for Tx */
 118         u32 norcvbuf;   /* # Rx packets discarded */
 119         u32 noxmtbuf;   /* # Tx packets discarded */
 120
 121         /* Transciever state informations. */
 122         u8 xcvr_addr;
 123         u32 xcvr_id;
 124
 125         /* Tx Statistics. */
 126         u32 tx_uflo;            /* Tx Underruns */
 127
 128         u32 collisions;
 129         u32 excessive_collisions;
 130         u32 first_collision;
 131         u32 late_collisions;
 132         u32 max_pkt_error;
 133         u32 tx_deferred;
 134
 135         /* Rx Statistics. */
 136         u32 rx_ov_flow; /* Rx Overflow */
 137
 138         u32 length_err;
 139         u32 alignment_err;
 140         u32 crc_err;
 141         u32 code_violations;
 142         u32 other_errors;
 143
 144         u32 SynchrounousIterations;
 145         u32 InterruptStatus;
 146 };
 147
 148
 149 /* The private adapter structure */
 150 struct et131x_adapter {
 151         struct net_device *netdev;
 152         struct pci_dev *pdev;
 153
 154         struct work_struct task;
 155
 156         /* Flags that indicate current state of the adapter */
 157         u32 Flags;
 158         u32 HwErrCount;
 159
 160         /* Configuration  */
 161         u8 rom_addr[ETH_ALEN];
 162         u8 addr[ETH_ALEN];
 163         bool has_eeprom;
 164         u8 eeprom_data[2];
 165
 166         /* Spinlocks */
 167         spinlock_t Lock;
 168
 169         spinlock_t TCBSendQLock;
 170         spinlock_t TCBReadyQLock;
 171         spinlock_t send_hw_lock;
 172
 173         spinlock_t rcv_lock;
 174         spinlock_t RcvPendLock;
 175         spinlock_t FbrLock;
 176
 177         spinlock_t PHYLock;
 178
 179         /* Packet Filter and look ahead size */
 180         u32 PacketFilter;
 181         u32 linkspeed;
 182         u32 duplex_mode;
 183
 184         /* multicast list */
 185         u32 MCAddressCount;
 186         u8 MCList[NIC_MAX_MCAST_LIST][ETH_ALEN];
 187
 188         /* Pointer to the device's PCI register space */
 189         struct address_map __iomem *regs;
 190
 191         /* Registry parameters */
 192         u8 SpeedDuplex;         /* speed/duplex */
 193         u8 wanted_flow;         /* Flow we want for 802.3x flow control */
 194         u8 RegistryPhyComa;     /* Phy Coma mode enable/disable */
 195
 196         u32 RegistryRxMemEnd;   /* Size of internal rx memory */
 197         u32 RegistryJumboPacket;        /* Max supported ethernet packet size */
 198
 199
 200         /* Derived from the registry: */
 201         u8 AiForceDpx;          /* duplex setting */
 202         u16 AiForceSpeed;       /* 'Speed', user over-ride of line speed */
 203         u8 flowcontrol;         /* flow control validated by the far-end */
 204         enum {
 205                 NETIF_STATUS_INVALID = 0,
 206                 NETIF_STATUS_MEDIA_CONNECT,
 207                 NETIF_STATUS_MEDIA_DISCONNECT,
 208                 NETIF_STATUS_MAX
 209         } MediaState;
 210
 211         /* Minimize init-time */
 212         struct timer_list ErrorTimer;
 213
 214         /* variable putting the phy into coma mode when boot up with no cable
 215          * plugged in after 5 seconds
 216          */
 217         u8 boot_coma;
 218
 219         /* Next two used to save power information at power down. This
 220          * information will be used during power up to set up parts of Power
 221          * Management in JAGCore
 222          */
 223         u16 pdown_speed;
 224         u8 pdown_duplex;
 225
 226         u32 CachedMaskValue;
 227
 228         /* Xcvr status at last poll */
 229         MI_BMSR_t Bmsr;
 230
 231         /* Tx Memory Variables */
 232         struct tx_ring tx_ring;
 233
 234         /* Rx Memory Variables */
 235         struct rx_ring rx_ring;
 236
 237         /* Loopback specifics */
 238         u8 ReplicaPhyLoopbk;    /* Replica Enable */
 239         u8 ReplicaPhyLoopbkPF;  /* Replica Enable Pass/Fail */
 240
 241         /* Stats */
 242         struct ce_stats stats;
 243
 244         struct net_device_stats net_stats;
 245         struct net_device_stats net_stats_prev;
 246 };
 247
 248 #endif /* __ET131X_ADAPTER_H__ */