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