af9741d8906b384d7725bb2a309f89b24f8d19a6
[akaros.git] / kern / drivers / net / e1000 / e1000.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2008 Intel Corporation.
5
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
23   Linux NICS <linux.nics@intel.com>
24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26
27 *******************************************************************************/
28
29 /* Linux PRO/1000 Ethernet Driver main header file */
30
31 #ifndef _E1000_H_
32 #define _E1000_H_
33
34 #include "e1000_api.h"
35
36 #define BAR_0           0
37 #define BAR_1           1
38 #define BAR_5           5
39
40 struct e1000_adapter;
41
42 /* TX/RX descriptor defines */
43 #define E1000_DEFAULT_TXD                  256
44 #define E1000_MAX_TXD                      256
45 #define E1000_MIN_TXD                       80
46 #define E1000_MAX_82544_TXD               4096
47
48 #define E1000_DEFAULT_TXD_PWR               12
49 #define E1000_MAX_TXD_PWR                   12
50 #define E1000_MIN_TXD_PWR                    7
51
52 #define E1000_DEFAULT_RXD                  256
53 #define E1000_MAX_RXD                      256
54
55 #define E1000_MIN_RXD                       80
56 #define E1000_MAX_82544_RXD               4096
57
58 #define E1000_MIN_ITR_USECS                 10  /* 100000 irq/sec */
59 #define E1000_MAX_ITR_USECS              10000  /* 100    irq/sec */
60
61 /* this is the size past which hardware will drop packets when setting LPE=0 */
62 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
63
64 /* Supported Rx Buffer Sizes */
65 #define E1000_RXBUFFER_128   128
66 #define E1000_RXBUFFER_256   256
67 #define E1000_RXBUFFER_512   512
68 #define E1000_RXBUFFER_1024  1024
69 #define E1000_RXBUFFER_2048  2048
70 #define E1000_RXBUFFER_4096  4096
71 #define E1000_RXBUFFER_8192  8192
72 #define E1000_RXBUFFER_16384 16384
73
74 /* SmartSpeed delimiters */
75 #define E1000_SMARTSPEED_DOWNSHIFT 3
76 #define E1000_SMARTSPEED_MAX       15
77
78 /* Packet Buffer allocations */
79 #define E1000_PBA_BYTES_SHIFT 0xA
80 #define E1000_TX_HEAD_ADDR_SHIFT 7
81 #define E1000_PBA_TX_MASK 0xFFFF0000
82
83 /* Early Receive defines */
84 #define E1000_ERT_2048 0x100
85
86 #define E1000_FC_PAUSE_TIME 0x0680      /* 858 usec */
87
88 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
89 #define E1000_TX_QUEUE_WAKE     16
90 /* How many Rx Buffers do we bundle into one write to the hardware ? */
91 #define E1000_RX_BUFFER_WRITE   16      /* Must be power of 2 */
92
93 #define AUTO_ALL_MODES            0
94 #define E1000_EEPROM_82544_APM    0x0004
95 #define E1000_EEPROM_APME         0x0400
96
97 /* wrapper around a pointer to a socket buffer,
98  * so a DMA handle can be stored along with the buffer */
99 struct e1000_buffer {
100         struct sk_buff *skb;
101         dma_addr_t dma;
102         unsigned long time_stamp;
103         uint16_t length;
104         uint16_t next_to_watch;
105 };
106
107 struct e1000_rx_buffer {
108         struct sk_buff *skb;
109         dma_addr_t dma;
110         struct page *page;
111 };
112
113 struct e1000_tx_ring {
114         /* pointer to the descriptor ring memory */
115         void *desc;
116         /* physical address of the descriptor ring */
117         dma_addr_t dma;
118         /* length of descriptor ring in bytes */
119         unsigned int size;
120         /* number of descriptors in the ring */
121         unsigned int count;
122         /* next descriptor to associate a buffer with */
123         unsigned int next_to_use;
124         /* next descriptor to check for DD status bit */
125         unsigned int next_to_clean;
126         /* array of buffer information structs */
127         struct e1000_buffer *buffer_info;
128
129         spinlock_t tx_lock;
130         uint16_t tdh;
131         uint16_t tdt;
132
133         /* TXDdescriptor index increment to be used when advancing
134          * to the next descriptor. This is normally one, but on some
135          * architectures, but on some architectures there are cache
136          * coherency issues that require only the first descriptor in
137          * cache line can be used.
138          */
139         unsigned int step;
140
141         bool last_tx_tso;
142 };
143
144 struct e1000_rx_ring {
145         struct e1000_adapter *adapter;  /* back link */
146         /* pointer to the descriptor ring memory */
147         void *desc;
148         /* physical address of the descriptor ring */
149         dma_addr_t dma;
150         /* length of descriptor ring in bytes */
151         unsigned int size;
152         /* number of descriptors in the ring */
153         unsigned int count;
154         /* next descriptor to associate a buffer with */
155         unsigned int next_to_use;
156         /* next descriptor to check for DD status bit */
157         unsigned int next_to_clean;
158         /* array of buffer information structs */
159         struct e1000_rx_buffer *buffer_info;
160         struct sk_buff *rx_skb_top;
161
162         /* cpu for rx queue */
163         int cpu;
164
165         uint16_t rdh;
166         uint16_t rdt;
167 };
168
169 #define E1000_TX_DESC_INC(R,index) \
170         {index += (R)->step; if (index == (R)->count) index = 0; }
171
172 #define E1000_TX_DESC_DEC(R,index) \
173         { if (index == 0) index = (R)->count - (R)->step; \
174         else index -= (R)->step; }
175
176 #define E1000_DESC_UNUSED(R) \
177         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
178         (R)->next_to_clean - (R)->next_to_use - 1)
179
180 #define E1000_RX_DESC_EXT(R, i)     \
181         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
182 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
183 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
184 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
185 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
186
187 /* board specific private data structure */
188
189 struct e1000_adapter {
190         uint32_t bd_number;
191         uint32_t rx_buffer_len;
192         uint32_t wol;
193         uint32_t smartspeed;
194         uint32_t en_mng_pt;
195         uint16_t link_speed;
196         uint16_t link_duplex;
197         spinlock_t stats_lock;
198         unsigned int total_tx_bytes;
199         unsigned int total_tx_packets;
200         unsigned int total_rx_bytes;
201         unsigned int total_rx_packets;
202         /* Interrupt Throttle Rate */
203         uint32_t itr;
204         uint32_t itr_setting;
205         uint16_t tx_itr;
206         uint16_t rx_itr;
207
208         bool fc_autoneg;
209
210         /* TX */
211         struct e1000_tx_ring *tx_ring;
212         unsigned int restart_queue;
213         unsigned long tx_queue_len;
214         uint32_t txd_cmd;
215         uint32_t tx_int_delay;
216         uint32_t tx_abs_int_delay;
217         uint32_t gotc;
218         u64 gotc_old;
219         u64 tpt_old;
220         u64 colc_old;
221         uint32_t tx_timeout_count;
222         uint32_t tx_fifo_head;
223         uint32_t tx_head_addr;
224         uint32_t tx_fifo_size;
225         uint8_t tx_timeout_factor;
226         bool pcix_82544;
227         bool detect_tx_hung;
228
229         /* RX */
230          bool(*clean_rx) (struct e1000_adapter * adapter,
231                                           struct e1000_rx_ring * rx_ring);
232         void (*alloc_rx_buf) (struct e1000_adapter * adapter,
233                                                   struct e1000_rx_ring * rx_ring, int cleaned_count);
234         struct e1000_rx_ring *rx_ring;
235
236         u64 hw_csum_err;
237         u64 hw_csum_good;
238         uint32_t alloc_rx_buff_failed;
239         uint32_t rx_int_delay;
240         uint32_t rx_abs_int_delay;
241         bool rx_csum;
242         uint32_t gorc;
243         u64 gorc_old;
244         uint32_t max_frame_size;
245         uint32_t min_frame_size;
246
247         /* OS defined structs */
248         struct net_device *netdev;
249         struct pci_device *pdev;
250         struct net_device_stats net_stats;
251
252         /* structs defined in e1000_hw.h */
253         struct e1000_hw hw;
254         struct e1000_hw_stats stats;
255         struct e1000_phy_info phy_info;
256         struct e1000_phy_stats phy_stats;
257
258         int msg_enable;
259         /* to not mess up cache alignment, always add to the bottom */
260         unsigned long state;
261         uint32_t eeprom_wol;
262
263         uint32_t *config_space;
264
265         /* hardware capability, feature, and workaround flags */
266         unsigned int flags;
267
268         /* upper limit parameter for tx desc size */
269         uint32_t tx_desc_pwr;
270
271 #define NUM_TX_DESC     8
272 #define NUM_RX_DESC     8
273
274         struct io_buffer *tx_iobuf[NUM_TX_DESC];
275         struct io_buffer *rx_iobuf[NUM_RX_DESC];
276
277         struct e1000_tx_desc *tx_base;
278         struct e1000_rx_desc *rx_base;
279
280         uint32_t tx_ring_size;
281         uint32_t rx_ring_size;
282
283         uint32_t tx_head;
284         uint32_t tx_tail;
285         uint32_t tx_fill_ctr;
286
287         uint32_t rx_curr;
288
289         uint32_t ioaddr;
290         uint32_t irqno;
291 };
292
293 #define E1000_FLAG_HAS_SMBUS                (1 << 0)
294 #define E1000_FLAG_HAS_INTR_MODERATION      (1 << 4)
295 #define E1000_FLAG_BAD_TX_CARRIER_STATS_FD  (1 << 6)
296 #define E1000_FLAG_QUAD_PORT_A              (1 << 8)
297 #define E1000_FLAG_SMART_POWER_DOWN         (1 << 9)
298
299 extern char e1000_driver_name[];
300 extern const char e1000_driver_version[];
301
302 extern void e1000_power_up_phy(struct e1000_hw *hw);
303
304 extern void e1000_set_ethtool_ops(struct net_device *netdev);
305 extern void e1000_check_options(struct e1000_adapter *adapter);
306
307 extern int e1000_up(struct e1000_adapter *adapter);
308 extern void e1000_down(struct e1000_adapter *adapter);
309 extern void e1000_reinit_locked(struct e1000_adapter *adapter);
310 extern void e1000_reset(struct e1000_adapter *adapter);
311 extern int e1000_set_spd_dplx(struct e1000_adapter *adapter, uint16_t spddplx);
312 extern int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);
313 extern int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);
314 extern void e1000_free_all_rx_resources(struct e1000_adapter *adapter);
315 extern void e1000_free_all_tx_resources(struct e1000_adapter *adapter);
316 extern void e1000_update_stats(struct e1000_adapter *adapter);
317
318 #endif /* _E1000_H_ */