Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ixgb.h
Go to the documentation of this file.
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 <[email protected]>
24  e1000-devel Mailing List <[email protected]>
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 /* TX/RX descriptor defines */
79 #define DEFAULT_TXD 256
80 #define MAX_TXD 4096
81 #define MIN_TXD 64
82 
83 /* hardware cannot reliably support more than 512 descriptors owned by
84  * hardware descriptor cache otherwise an unreliable ring under heavy
85  * receive load may result */
86 #define DEFAULT_RXD 512
87 #define MAX_RXD 512
88 #define MIN_RXD 64
89 
90 /* Supported Rx Buffer Sizes */
91 #define IXGB_RXBUFFER_2048 2048
92 #define IXGB_RXBUFFER_4096 4096
93 #define IXGB_RXBUFFER_8192 8192
94 #define IXGB_RXBUFFER_16384 16384
95 
96 /* How many Rx Buffers do we bundle into one write to the hardware ? */
97 #define IXGB_RX_BUFFER_WRITE 8 /* Must be power of 2 */
98 
99 /* wrapper around a pointer to a socket buffer,
100  * so a DMA handle can be stored along with the buffer */
101 struct ixgb_buffer {
102  struct sk_buff *skb;
103  dma_addr_t dma;
104  unsigned long time_stamp;
105  u16 length;
106  u16 next_to_watch;
107  u16 mapped_as_page;
108 };
109 
110 struct ixgb_desc_ring {
111  /* pointer to the descriptor ring memory */
112  void *desc;
113  /* physical address of the descriptor ring */
114  dma_addr_t dma;
115  /* length of descriptor ring in bytes */
116  unsigned int size;
117  /* number of descriptors in the ring */
118  unsigned int count;
119  /* next descriptor to associate a buffer with */
120  unsigned int next_to_use;
121  /* next descriptor to check for DD status bit */
122  unsigned int next_to_clean;
123  /* array of buffer information structs */
124  struct ixgb_buffer *buffer_info;
125 };
126 
127 #define IXGB_DESC_UNUSED(R) \
128  ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
129  (R)->next_to_clean - (R)->next_to_use - 1)
130 
131 #define IXGB_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
132 #define IXGB_RX_DESC(R, i) IXGB_GET_DESC(R, i, ixgb_rx_desc)
133 #define IXGB_TX_DESC(R, i) IXGB_GET_DESC(R, i, ixgb_tx_desc)
134 #define IXGB_CONTEXT_DESC(R, i) IXGB_GET_DESC(R, i, ixgb_context_desc)
135 
136 /* board specific private data structure */
137 
138 struct ixgb_adapter {
139  struct timer_list watchdog_timer;
140  unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
141  u32 bd_number;
142  u32 rx_buffer_len;
143  u32 part_num;
144  u16 link_speed;
145  u16 link_duplex;
146  struct work_struct tx_timeout_task;
147 
148  /* TX */
149  struct ixgb_desc_ring tx_ring ____cacheline_aligned_in_smp;
150  unsigned int restart_queue;
151  unsigned long timeo_start;
152  u32 tx_cmd_type;
153  u64 hw_csum_tx_good;
154  u64 hw_csum_tx_error;
155  u32 tx_int_delay;
156  u32 tx_timeout_count;
157  bool tx_int_delay_enable;
158  bool detect_tx_hung;
159 
160  /* RX */
161  struct ixgb_desc_ring rx_ring;
162  u64 hw_csum_rx_error;
163  u64 hw_csum_rx_good;
164  u32 rx_int_delay;
165  bool rx_csum;
166 
167  /* OS defined structs */
168  struct napi_struct napi;
169  struct net_device *netdev;
170  struct pci_dev *pdev;
171 
172  /* structs defined in ixgb_hw.h */
173  struct ixgb_hw hw;
174  u16 msg_enable;
175  struct ixgb_hw_stats stats;
176  u32 alloc_rx_buff_failed;
177  bool have_msi;
178  unsigned long flags;
179 };
180 
181 enum ixgb_state_t {
182  /* TBD
183  __IXGB_TESTING,
184  __IXGB_RESETTING,
185  */
186  __IXGB_DOWN
187 };
188 
189 /* Exported from other modules */
190 extern void ixgb_check_options(struct ixgb_adapter *adapter);
191 extern void ixgb_set_ethtool_ops(struct net_device *netdev);
192 extern char ixgb_driver_name[];
193 extern const char ixgb_driver_version[];
194 
195 extern void ixgb_set_speed_duplex(struct net_device *netdev);
196 
197 extern int ixgb_up(struct ixgb_adapter *adapter);
198 extern void ixgb_down(struct ixgb_adapter *adapter, bool kill_watchdog);
199 extern void ixgb_reset(struct ixgb_adapter *adapter);
200 extern int ixgb_setup_rx_resources(struct ixgb_adapter *adapter);
201 extern int ixgb_setup_tx_resources(struct ixgb_adapter *adapter);
202 extern void ixgb_free_rx_resources(struct ixgb_adapter *adapter);
203 extern void ixgb_free_tx_resources(struct ixgb_adapter *adapter);
204 extern void ixgb_update_stats(struct ixgb_adapter *adapter);
205 
206 
207 #endif /* _IXGB_H_ */
Generated on Thu Jan 10 2013 14:02:34 for Linux Kernel by   doxygen 1.8.2