Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/kaber/nf-next-2.6
[linux-2.6.git] / drivers / net / ixgb / ixgb.h
1 /*******************************************************************************
2
3   Intel PRO/10GbE 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 #ifndef _IXGB_H_
30 #define _IXGB_H_
31
32 #include <linux/stddef.h>
33 #include <linux/module.h>
34 #include <linux/types.h>
35 #include <asm/byteorder.h>
36 #include <linux/init.h>
37 #include <linux/mm.h>
38 #include <linux/errno.h>
39 #include <linux/ioport.h>
40 #include <linux/pci.h>
41 #include <linux/kernel.h>
42 #include <linux/netdevice.h>
43 #include <linux/etherdevice.h>
44 #include <linux/skbuff.h>
45 #include <linux/delay.h>
46 #include <linux/timer.h>
47 #include <linux/slab.h>
48 #include <linux/vmalloc.h>
49 #include <linux/interrupt.h>
50 #include <linux/string.h>
51 #include <linux/pagemap.h>
52 #include <linux/dma-mapping.h>
53 #include <linux/bitops.h>
54 #include <asm/io.h>
55 #include <asm/irq.h>
56 #include <linux/capability.h>
57 #include <linux/in.h>
58 #include <linux/ip.h>
59 #include <linux/tcp.h>
60 #include <linux/udp.h>
61 #include <net/pkt_sched.h>
62 #include <linux/list.h>
63 #include <linux/reboot.h>
64 #include <net/checksum.h>
65
66 #include <linux/ethtool.h>
67 #include <linux/if_vlan.h>
68
69 #define BAR_0           0
70 #define BAR_1           1
71 #define BAR_5           5
72
73 struct ixgb_adapter;
74 #include "ixgb_hw.h"
75 #include "ixgb_ee.h"
76 #include "ixgb_ids.h"
77
78 #ifdef _DEBUG_DRIVER_
79 #define IXGB_DBG(args...) printk(KERN_DEBUG "ixgb: " args)
80 #else
81 #define IXGB_DBG(args...)
82 #endif
83
84 #define PFX "ixgb: "
85 #define DPRINTK(nlevel, klevel, fmt, args...) \
86         (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
87         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
88                 __func__ , ## args))
89
90
91 /* TX/RX descriptor defines */
92 #define DEFAULT_TXD      256
93 #define MAX_TXD         4096
94 #define MIN_TXD           64
95
96 /* hardware cannot reliably support more than 512 descriptors owned by
97  * hardware descriptor cache otherwise an unreliable ring under heavy
98  * receive load may result */
99 #define DEFAULT_RXD      512
100 #define MAX_RXD          512
101 #define MIN_RXD           64
102
103 /* Supported Rx Buffer Sizes */
104 #define IXGB_RXBUFFER_2048  2048
105 #define IXGB_RXBUFFER_4096  4096
106 #define IXGB_RXBUFFER_8192  8192
107 #define IXGB_RXBUFFER_16384 16384
108
109 /* How many Rx Buffers do we bundle into one write to the hardware ? */
110 #define IXGB_RX_BUFFER_WRITE    8       /* Must be power of 2 */
111
112 /* wrapper around a pointer to a socket buffer,
113  * so a DMA handle can be stored along with the buffer */
114 struct ixgb_buffer {
115         struct sk_buff *skb;
116         dma_addr_t dma;
117         unsigned long time_stamp;
118         u16 length;
119         u16 next_to_watch;
120         u16 mapped_as_page;
121 };
122
123 struct ixgb_desc_ring {
124         /* pointer to the descriptor ring memory */
125         void *desc;
126         /* physical address of the descriptor ring */
127         dma_addr_t dma;
128         /* length of descriptor ring in bytes */
129         unsigned int size;
130         /* number of descriptors in the ring */
131         unsigned int count;
132         /* next descriptor to associate a buffer with */
133         unsigned int next_to_use;
134         /* next descriptor to check for DD status bit */
135         unsigned int next_to_clean;
136         /* array of buffer information structs */
137         struct ixgb_buffer *buffer_info;
138 };
139
140 #define IXGB_DESC_UNUSED(R) \
141         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
142         (R)->next_to_clean - (R)->next_to_use - 1)
143
144 #define IXGB_GET_DESC(R, i, type)       (&(((struct type *)((R).desc))[i]))
145 #define IXGB_RX_DESC(R, i)              IXGB_GET_DESC(R, i, ixgb_rx_desc)
146 #define IXGB_TX_DESC(R, i)              IXGB_GET_DESC(R, i, ixgb_tx_desc)
147 #define IXGB_CONTEXT_DESC(R, i) IXGB_GET_DESC(R, i, ixgb_context_desc)
148
149 /* board specific private data structure */
150
151 struct ixgb_adapter {
152         struct timer_list watchdog_timer;
153         struct vlan_group *vlgrp;
154         u32 bd_number;
155         u32 rx_buffer_len;
156         u32 part_num;
157         u16 link_speed;
158         u16 link_duplex;
159         struct work_struct tx_timeout_task;
160
161         struct timer_list blink_timer;
162         unsigned long led_status;
163
164         /* TX */
165         struct ixgb_desc_ring tx_ring ____cacheline_aligned_in_smp;
166         unsigned int restart_queue;
167         unsigned long timeo_start;
168         u32 tx_cmd_type;
169         u64 hw_csum_tx_good;
170         u64 hw_csum_tx_error;
171         u32 tx_int_delay;
172         u32 tx_timeout_count;
173         bool tx_int_delay_enable;
174         bool detect_tx_hung;
175
176         /* RX */
177         struct ixgb_desc_ring rx_ring;
178         u64 hw_csum_rx_error;
179         u64 hw_csum_rx_good;
180         u32 rx_int_delay;
181         bool rx_csum;
182
183         /* OS defined structs */
184         struct napi_struct napi;
185         struct net_device *netdev;
186         struct pci_dev *pdev;
187
188         /* structs defined in ixgb_hw.h */
189         struct ixgb_hw hw;
190         u16 msg_enable;
191         struct ixgb_hw_stats stats;
192         u32 alloc_rx_buff_failed;
193         bool have_msi;
194         unsigned long flags;
195 };
196
197 enum ixgb_state_t {
198         /* TBD
199         __IXGB_TESTING,
200         __IXGB_RESETTING,
201         */
202         __IXGB_DOWN
203 };
204
205 /* Exported from other modules */
206 extern void ixgb_check_options(struct ixgb_adapter *adapter);
207 extern void ixgb_set_ethtool_ops(struct net_device *netdev);
208 extern char ixgb_driver_name[];
209 extern const char ixgb_driver_version[];
210
211 extern int ixgb_up(struct ixgb_adapter *adapter);
212 extern void ixgb_down(struct ixgb_adapter *adapter, bool kill_watchdog);
213 extern void ixgb_reset(struct ixgb_adapter *adapter);
214 extern int ixgb_setup_rx_resources(struct ixgb_adapter *adapter);
215 extern int ixgb_setup_tx_resources(struct ixgb_adapter *adapter);
216 extern void ixgb_free_rx_resources(struct ixgb_adapter *adapter);
217 extern void ixgb_free_tx_resources(struct ixgb_adapter *adapter);
218 extern void ixgb_update_stats(struct ixgb_adapter *adapter);
219
220
221 #endif /* _IXGB_H_ */