0078136643f32b4c39933853a2b8f98d14894dc8
[linux-2.6.git] / drivers / net / ixgb / ixgb.h
1 /*******************************************************************************
2
3   Intel PRO/10GbE Linux driver
4   Copyright(c) 1999 - 2006 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                 __FUNCTION__ , ## 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 descrioptor cache otherwise an unreliable ring under heavy 
98  * recieve load may result */
99 /* #define DEFAULT_RXD     1024 */
100 /* #define MAX_RXD         4096 */
101 #define DEFAULT_RXD     512
102 #define MAX_RXD 512
103 #define MIN_RXD  64
104
105 /* Supported Rx Buffer Sizes */
106 #define IXGB_RXBUFFER_2048  2048
107 #define IXGB_RXBUFFER_4096  4096
108 #define IXGB_RXBUFFER_8192  8192
109 #define IXGB_RXBUFFER_16384 16384
110
111 /* How many Rx Buffers do we bundle into one write to the hardware ? */
112 #define IXGB_RX_BUFFER_WRITE    8       /* Must be power of 2 */
113
114 /* wrapper around a pointer to a socket buffer,
115  * so a DMA handle can be stored along with the buffer */
116 struct ixgb_buffer {
117         struct sk_buff *skb;
118         dma_addr_t dma;
119         unsigned long time_stamp;
120         uint16_t length;
121         uint16_t next_to_watch;
122 };
123
124 struct ixgb_desc_ring {
125         /* pointer to the descriptor ring memory */
126         void *desc;
127         /* physical address of the descriptor ring */
128         dma_addr_t dma;
129         /* length of descriptor ring in bytes */
130         unsigned int size;
131         /* number of descriptors in the ring */
132         unsigned int count;
133         /* next descriptor to associate a buffer with */
134         unsigned int next_to_use;
135         /* next descriptor to check for DD status bit */
136         unsigned int next_to_clean;
137         /* array of buffer information structs */
138         struct ixgb_buffer *buffer_info;
139 };
140
141 #define IXGB_DESC_UNUSED(R) \
142         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
143         (R)->next_to_clean - (R)->next_to_use - 1)
144
145 #define IXGB_GET_DESC(R, i, type)       (&(((struct type *)((R).desc))[i]))
146 #define IXGB_RX_DESC(R, i)              IXGB_GET_DESC(R, i, ixgb_rx_desc)
147 #define IXGB_TX_DESC(R, i)              IXGB_GET_DESC(R, i, ixgb_tx_desc)
148 #define IXGB_CONTEXT_DESC(R, i) IXGB_GET_DESC(R, i, ixgb_context_desc)
149
150 /* board specific private data structure */
151
152 struct ixgb_adapter {
153         struct timer_list watchdog_timer;
154         struct vlan_group *vlgrp;
155         uint32_t bd_number;
156         uint32_t rx_buffer_len;
157         uint32_t part_num;
158         uint16_t link_speed;
159         uint16_t link_duplex;
160         spinlock_t tx_lock;
161         atomic_t irq_sem;
162         struct work_struct tx_timeout_task;
163
164         struct timer_list blink_timer;
165         unsigned long led_status;
166
167         /* TX */
168         struct ixgb_desc_ring tx_ring ____cacheline_aligned_in_smp;
169         unsigned int restart_queue;
170         unsigned long timeo_start;
171         uint32_t tx_cmd_type;
172         uint64_t hw_csum_tx_good;
173         uint64_t hw_csum_tx_error;
174         uint32_t tx_int_delay;
175         uint32_t tx_timeout_count;
176         boolean_t tx_int_delay_enable;
177         boolean_t detect_tx_hung;
178
179         /* RX */
180         struct ixgb_desc_ring rx_ring;
181         uint64_t hw_csum_rx_error;
182         uint64_t hw_csum_rx_good;
183         uint32_t rx_int_delay;
184         boolean_t rx_csum;
185
186         /* OS defined structs */
187         struct napi_struct napi;
188         struct net_device *netdev;
189         struct pci_dev *pdev;
190         struct net_device_stats net_stats;
191
192         /* structs defined in ixgb_hw.h */
193         struct ixgb_hw hw;
194         u16 msg_enable;
195         struct ixgb_hw_stats stats;
196         uint32_t alloc_rx_buff_failed;
197         boolean_t have_msi;
198         unsigned long flags;
199 };
200
201 enum ixgb_state_t {
202         /* TBD
203         __IXGB_TESTING,
204         __IXGB_RESETTING,
205         */
206         __IXGB_DOWN
207 };
208
209 /* Exported from other modules */
210 extern void ixgb_check_options(struct ixgb_adapter *adapter);
211 extern void ixgb_set_ethtool_ops(struct net_device *netdev);
212 extern char ixgb_driver_name[];
213 extern const char ixgb_driver_version[];
214
215 #endif /* _IXGB_H_ */