]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/net/igb/igb.h
Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6-omap-h63xx.git] / drivers / net / igb / igb.h
1 /*******************************************************************************
2
3   Intel(R) Gigabit Ethernet Linux driver
4   Copyright(c) 2007 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   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25
26 *******************************************************************************/
27
28
29 /* Linux PRO/1000 Ethernet Driver main header file */
30
31 #ifndef _IGB_H_
32 #define _IGB_H_
33
34 #include "e1000_mac.h"
35 #include "e1000_82575.h"
36
37 struct igb_adapter;
38
39 /* Interrupt defines */
40 #define IGB_MAX_TX_CLEAN 72
41
42 #define IGB_MIN_DYN_ITR 3000
43 #define IGB_MAX_DYN_ITR 96000
44 #define IGB_START_ITR 6000
45
46 #define IGB_DYN_ITR_PACKET_THRESHOLD 2
47 #define IGB_DYN_ITR_LENGTH_LOW 200
48 #define IGB_DYN_ITR_LENGTH_HIGH 1000
49
50 /* TX/RX descriptor defines */
51 #define IGB_DEFAULT_TXD                  256
52 #define IGB_MIN_TXD                       80
53 #define IGB_MAX_TXD                     4096
54
55 #define IGB_DEFAULT_RXD                  256
56 #define IGB_MIN_RXD                       80
57 #define IGB_MAX_RXD                     4096
58
59 #define IGB_DEFAULT_ITR                    3 /* dynamic */
60 #define IGB_MAX_ITR_USECS              10000
61 #define IGB_MIN_ITR_USECS                 10
62
63 /* Transmit and receive queues */
64 #define IGB_MAX_RX_QUEUES                  4
65
66 /* RX descriptor control thresholds.
67  * PTHRESH - MAC will consider prefetch if it has fewer than this number of
68  *           descriptors available in its onboard memory.
69  *           Setting this to 0 disables RX descriptor prefetch.
70  * HTHRESH - MAC will only prefetch if there are at least this many descriptors
71  *           available in host memory.
72  *           If PTHRESH is 0, this should also be 0.
73  * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
74  *           descriptors until either it has this many to write back, or the
75  *           ITR timer expires.
76  */
77 #define IGB_RX_PTHRESH                    16
78 #define IGB_RX_HTHRESH                     8
79 #define IGB_RX_WTHRESH                     1
80
81 /* this is the size past which hardware will drop packets when setting LPE=0 */
82 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
83
84 /* Supported Rx Buffer Sizes */
85 #define IGB_RXBUFFER_128   128    /* Used for packet split */
86 #define IGB_RXBUFFER_256   256    /* Used for packet split */
87 #define IGB_RXBUFFER_512   512
88 #define IGB_RXBUFFER_1024  1024
89 #define IGB_RXBUFFER_2048  2048
90 #define IGB_RXBUFFER_4096  4096
91 #define IGB_RXBUFFER_8192  8192
92 #define IGB_RXBUFFER_16384 16384
93
94 /* Packet Buffer allocations */
95
96
97 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
98 #define IGB_TX_QUEUE_WAKE       16
99 /* How many Rx Buffers do we bundle into one write to the hardware ? */
100 #define IGB_RX_BUFFER_WRITE     16      /* Must be power of 2 */
101
102 #define AUTO_ALL_MODES            0
103 #define IGB_EEPROM_APME         0x0400
104
105 #ifndef IGB_MASTER_SLAVE
106 /* Switch to override PHY master/slave setting */
107 #define IGB_MASTER_SLAVE        e1000_ms_hw_default
108 #endif
109
110 #define IGB_MNG_VLAN_NONE -1
111
112 /* wrapper around a pointer to a socket buffer,
113  * so a DMA handle can be stored along with the buffer */
114 struct igb_buffer {
115         struct sk_buff *skb;
116         dma_addr_t dma;
117         union {
118                 /* TX */
119                 struct {
120                         unsigned long time_stamp;
121                         u32 length;
122                 };
123                 /* RX */
124                 struct {
125                         struct page *page;
126                         u64 page_dma;
127                 };
128         };
129 };
130
131 struct igb_queue_stats {
132         u64 packets;
133         u64 bytes;
134 };
135
136 struct igb_ring {
137         struct igb_adapter *adapter; /* backlink */
138         void *desc;                  /* descriptor ring memory */
139         dma_addr_t dma;              /* phys address of the ring */
140         unsigned int size;           /* length of desc. ring in bytes */
141         unsigned int count;          /* number of desc. in the ring */
142         u16 next_to_use;
143         u16 next_to_clean;
144         u16 head;
145         u16 tail;
146         struct igb_buffer *buffer_info; /* array of buffer info structs */
147
148         u32 eims_value;
149         u32 itr_val;
150         u16 itr_register;
151         u16 cpu;
152
153         int queue_index;
154         unsigned int total_bytes;
155         unsigned int total_packets;
156
157         union {
158                 /* TX */
159                 struct {
160                         spinlock_t tx_clean_lock;
161                         spinlock_t tx_lock;
162                         bool detect_tx_hung;
163                 };
164                 /* RX */
165                 struct {
166                         /* arrays of page information for packet split */
167                         struct sk_buff *pending_skb;
168                         int pending_skb_page;
169                         int no_itr_adjust;
170                         struct igb_queue_stats rx_stats;
171                         struct napi_struct napi;
172                 };
173         };
174
175         char name[IFNAMSIZ + 5];
176 };
177
178 #define IGB_DESC_UNUSED(R) \
179         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
180         (R)->next_to_clean - (R)->next_to_use - 1)
181
182 #define E1000_RX_DESC_ADV(R, i)     \
183         (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
184 #define E1000_TX_DESC_ADV(R, i)     \
185         (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
186 #define E1000_TX_CTXTDESC_ADV(R, i)         \
187         (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
188 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
189 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
190 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
191
192 /* board specific private data structure */
193
194 struct igb_adapter {
195         struct timer_list watchdog_timer;
196         struct timer_list phy_info_timer;
197         struct vlan_group *vlgrp;
198         u16 mng_vlan_id;
199         u32 bd_number;
200         u32 rx_buffer_len;
201         u32 wol;
202         u32 en_mng_pt;
203         u16 link_speed;
204         u16 link_duplex;
205         unsigned int total_tx_bytes;
206         unsigned int total_tx_packets;
207         unsigned int total_rx_bytes;
208         unsigned int total_rx_packets;
209         /* Interrupt Throttle Rate */
210         u32 itr;
211         u32 itr_setting;
212         u16 tx_itr;
213         u16 rx_itr;
214         int set_itr;
215
216         struct work_struct reset_task;
217         struct work_struct watchdog_task;
218         bool fc_autoneg;
219         u8  tx_timeout_factor;
220         struct timer_list blink_timer;
221         unsigned long led_status;
222
223         /* TX */
224         struct igb_ring *tx_ring;      /* One per active queue */
225         unsigned int restart_queue;
226         unsigned long tx_queue_len;
227         u32 txd_cmd;
228         u32 gotc;
229         u64 gotc_old;
230         u64 tpt_old;
231         u64 colc_old;
232         u32 tx_timeout_count;
233
234         /* RX */
235         struct igb_ring *rx_ring;      /* One per active queue */
236         int num_tx_queues;
237         int num_rx_queues;
238
239         u64 hw_csum_err;
240         u64 hw_csum_good;
241         u64 rx_hdr_split;
242         u32 alloc_rx_buff_failed;
243         bool rx_csum;
244         u32 gorc;
245         u64 gorc_old;
246         u16 rx_ps_hdr_size;
247         u32 max_frame_size;
248         u32 min_frame_size;
249
250         /* OS defined structs */
251         struct net_device *netdev;
252         struct napi_struct napi;
253         struct pci_dev *pdev;
254         struct net_device_stats net_stats;
255
256         /* structs defined in e1000_hw.h */
257         struct e1000_hw hw;
258         struct e1000_hw_stats stats;
259         struct e1000_phy_info phy_info;
260         struct e1000_phy_stats phy_stats;
261
262         u32 test_icr;
263         struct igb_ring test_tx_ring;
264         struct igb_ring test_rx_ring;
265
266         int msg_enable;
267         struct msix_entry *msix_entries;
268         u32 eims_enable_mask;
269         u32 eims_other;
270
271         /* to not mess up cache alignment, always add to the bottom */
272         unsigned long state;
273         unsigned int msi_enabled;
274
275         u32 eeprom_wol;
276
277         /* for ioport free */
278         int bars;
279         int need_ioport;
280 };
281
282 enum e1000_state_t {
283         __IGB_TESTING,
284         __IGB_RESETTING,
285         __IGB_DOWN
286 };
287
288 enum igb_boards {
289         board_82575,
290 };
291
292 extern char igb_driver_name[];
293 extern char igb_driver_version[];
294
295 extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
296 extern int igb_up(struct igb_adapter *);
297 extern void igb_down(struct igb_adapter *);
298 extern void igb_reinit_locked(struct igb_adapter *);
299 extern void igb_reset(struct igb_adapter *);
300 extern int igb_set_spd_dplx(struct igb_adapter *, u16);
301 extern int igb_setup_tx_resources(struct igb_adapter *, struct igb_ring *);
302 extern int igb_setup_rx_resources(struct igb_adapter *, struct igb_ring *);
303 extern void igb_update_stats(struct igb_adapter *);
304 extern void igb_set_ethtool_ops(struct net_device *);
305
306 #endif /* _IGB_H_ */