3 * 10/100/1000 Base-T Ethernet Driver for the ET1301 and ET131x series MACs
5 * Copyright © 2005 Agere Systems Inc.
9 *------------------------------------------------------------------------------
11 * et131x_adapter.h - Header which includes the private adapter structure, along
12 * with related support structures, macros, definitions, etc.
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 __ET131X_ADAPTER_H__
60 #define __ET131X_ADAPTER_H__
62 #include "et1310_address_map.h"
63 #include "et1310_tx.h"
64 #include "et1310_rx.h"
67 * Do not change these values: if changed, then change also in respective
68 * TXdma and Rxdma engines
70 #define NUM_DESC_PER_RING_TX 512 /* TX Do not change these values */
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:
78 #define NUM_TRAFFIC_CLASSES 1
80 #define TX_ERROR_PERIOD 1000
82 #define LO_MARK_PERCENT_FOR_PSR 15
83 #define LO_MARK_PERCENT_FOR_RX 15
85 /* RFD (Receive Frame Descriptor) */
87 struct list_head list_node;
89 u32 len; /* total size of receive frame */
100 /* Struct to define some device statistics */
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
108 u32 unicast_pkts_rcvd;
109 atomic_t unicast_pkts_xmtd;
110 u32 multicast_pkts_rcvd;
111 atomic_t multicast_pkts_xmtd;
112 u32 broadcast_pkts_rcvd;
113 atomic_t broadcast_pkts_xmtd;
114 u32 rcvd_pkts_dropped;
120 u32 tx_excessive_collisions;
121 u32 tx_first_collisions;
122 u32 tx_late_collisions;
132 u32 rx_code_violations;
135 u32 synchronous_iterations;
136 u32 interrupt_status;
140 /* The private adapter structure */
141 struct et131x_adapter {
142 struct net_device *netdev;
143 struct pci_dev *pdev;
144 struct mii_bus *mii_bus;
145 struct phy_device *phydev;
146 struct work_struct task;
148 /* Flags that indicate current state of the adapter */
153 u8 rom_addr[ETH_ALEN];
161 spinlock_t tcb_send_qlock;
162 spinlock_t tcb_ready_qlock;
163 spinlock_t send_hw_lock;
166 spinlock_t rcv_pend_lock;
171 /* Packet Filter and look ahead size */
177 u32 multicast_addr_count;
178 u8 multicast_list[NIC_MAX_MCAST_LIST][ETH_ALEN];
180 /* Pointer to the device's PCI register space */
181 struct address_map __iomem *regs;
183 /* Registry parameters */
184 u8 speed_duplex; /* speed/duplex */
185 u8 wanted_flow; /* Flow we want for 802.3x flow control */
186 u8 registry_phy_coma; /* Phy Coma mode enable/disable */
188 u32 registry_rx_mem_end; /* Size of internal rx memory */
189 u32 registry_jumbo_packet; /* Max supported ethernet packet size */
192 /* Derived from the registry: */
193 u8 ai_force_duplex; /* duplex setting */
194 u16 ai_force_speed; /* 'Speed', user over-ride of line speed */
195 u8 flowcontrol; /* flow control validated by the far-end */
197 /* Minimize init-time */
198 struct timer_list error_timer;
200 /* variable putting the phy into coma mode when boot up with no cable
201 * plugged in after 5 seconds
205 /* Next two used to save power information at power down. This
206 * information will be used during power up to set up parts of Power
207 * Management in JAGCore
212 u32 cached_mask_value;
214 /* Xcvr status at last poll */
217 /* Tx Memory Variables */
218 struct tx_ring tx_ring;
220 /* Rx Memory Variables */
221 struct rx_ring rx_ring;
224 struct ce_stats stats;
226 struct net_device_stats net_stats;
229 #endif /* __ET131X_ADAPTER_H__ */