Commit | Line | Data |
---|---|---|
9d5c8243 AK |
1 | /******************************************************************************* |
2 | ||
3 | Intel(R) Gigabit Ethernet Linux driver | |
86d5d38f | 4 | Copyright(c) 2007-2009 Intel Corporation. |
9d5c8243 AK |
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 | ||
38c845c7 | 37 | #include <linux/clocksource.h> |
33af6bcc PO |
38 | #include <linux/timecompare.h> |
39 | #include <linux/net_tstamp.h> | |
38c845c7 | 40 | |
9d5c8243 AK |
41 | struct igb_adapter; |
42 | ||
6eb5a7f1 AD |
43 | /* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */ |
44 | #define IGB_START_ITR 648 | |
9d5c8243 | 45 | |
9d5c8243 AK |
46 | /* TX/RX descriptor defines */ |
47 | #define IGB_DEFAULT_TXD 256 | |
48 | #define IGB_MIN_TXD 80 | |
49 | #define IGB_MAX_TXD 4096 | |
50 | ||
51 | #define IGB_DEFAULT_RXD 256 | |
52 | #define IGB_MIN_RXD 80 | |
53 | #define IGB_MAX_RXD 4096 | |
54 | ||
55 | #define IGB_DEFAULT_ITR 3 /* dynamic */ | |
56 | #define IGB_MAX_ITR_USECS 10000 | |
57 | #define IGB_MIN_ITR_USECS 10 | |
047e0030 AD |
58 | #define NON_Q_VECTORS 1 |
59 | #define MAX_Q_VECTORS 8 | |
9d5c8243 AK |
60 | |
61 | /* Transmit and receive queues */ | |
a99955fc AD |
62 | #define IGB_MAX_RX_QUEUES (adapter->vfs_allocated_count ? 2 : \ |
63 | (hw->mac.type > e1000_82575 ? 8 : 4)) | |
64 | #define IGB_ABS_MAX_TX_QUEUES 8 | |
65 | #define IGB_MAX_TX_QUEUES IGB_MAX_RX_QUEUES | |
9d5c8243 | 66 | |
4ae196df AD |
67 | #define IGB_MAX_VF_MC_ENTRIES 30 |
68 | #define IGB_MAX_VF_FUNCTIONS 8 | |
69 | #define IGB_MAX_VFTA_ENTRIES 128 | |
70 | ||
71 | struct vf_data_storage { | |
72 | unsigned char vf_mac_addresses[ETH_ALEN]; | |
73 | u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES]; | |
74 | u16 num_vf_mc_hashes; | |
ae641bdc | 75 | u16 vlans_enabled; |
f2ca0dbe AD |
76 | u32 flags; |
77 | unsigned long last_nack; | |
4ae196df AD |
78 | }; |
79 | ||
f2ca0dbe | 80 | #define IGB_VF_FLAG_CTS 0x00000001 /* VF is clear to send data */ |
7d5753f0 AD |
81 | #define IGB_VF_FLAG_UNI_PROMISC 0x00000002 /* VF has unicast promisc */ |
82 | #define IGB_VF_FLAG_MULTI_PROMISC 0x00000004 /* VF has multicast promisc */ | |
f2ca0dbe | 83 | |
9d5c8243 AK |
84 | /* RX descriptor control thresholds. |
85 | * PTHRESH - MAC will consider prefetch if it has fewer than this number of | |
86 | * descriptors available in its onboard memory. | |
87 | * Setting this to 0 disables RX descriptor prefetch. | |
88 | * HTHRESH - MAC will only prefetch if there are at least this many descriptors | |
89 | * available in host memory. | |
90 | * If PTHRESH is 0, this should also be 0. | |
91 | * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back | |
92 | * descriptors until either it has this many to write back, or the | |
93 | * ITR timer expires. | |
94 | */ | |
85b430b4 | 95 | #define IGB_RX_PTHRESH (hw->mac.type <= e1000_82576 ? 16 : 8) |
9d5c8243 AK |
96 | #define IGB_RX_HTHRESH 8 |
97 | #define IGB_RX_WTHRESH 1 | |
85b430b4 AD |
98 | #define IGB_TX_PTHRESH 8 |
99 | #define IGB_TX_HTHRESH 1 | |
100 | #define IGB_TX_WTHRESH ((hw->mac.type == e1000_82576 && \ | |
101 | adapter->msix_entries) ? 0 : 16) | |
9d5c8243 AK |
102 | |
103 | /* this is the size past which hardware will drop packets when setting LPE=0 */ | |
104 | #define MAXIMUM_ETHERNET_VLAN_SIZE 1522 | |
105 | ||
106 | /* Supported Rx Buffer Sizes */ | |
107 | #define IGB_RXBUFFER_128 128 /* Used for packet split */ | |
9d5c8243 AK |
108 | #define IGB_RXBUFFER_1024 1024 |
109 | #define IGB_RXBUFFER_2048 2048 | |
9d5c8243 AK |
110 | #define IGB_RXBUFFER_16384 16384 |
111 | ||
e1739522 | 112 | #define MAX_STD_JUMBO_FRAME_SIZE 9234 |
9d5c8243 AK |
113 | |
114 | /* How many Tx Descriptors do we need to call netif_wake_queue ? */ | |
115 | #define IGB_TX_QUEUE_WAKE 16 | |
116 | /* How many Rx Buffers do we bundle into one write to the hardware ? */ | |
117 | #define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */ | |
118 | ||
119 | #define AUTO_ALL_MODES 0 | |
120 | #define IGB_EEPROM_APME 0x0400 | |
121 | ||
122 | #ifndef IGB_MASTER_SLAVE | |
123 | /* Switch to override PHY master/slave setting */ | |
124 | #define IGB_MASTER_SLAVE e1000_ms_hw_default | |
125 | #endif | |
126 | ||
127 | #define IGB_MNG_VLAN_NONE -1 | |
128 | ||
129 | /* wrapper around a pointer to a socket buffer, | |
130 | * so a DMA handle can be stored along with the buffer */ | |
131 | struct igb_buffer { | |
132 | struct sk_buff *skb; | |
133 | dma_addr_t dma; | |
134 | union { | |
135 | /* TX */ | |
136 | struct { | |
137 | unsigned long time_stamp; | |
0e014cb1 AD |
138 | u16 length; |
139 | u16 next_to_watch; | |
6366ad33 | 140 | u16 mapped_as_page; |
9d5c8243 AK |
141 | }; |
142 | /* RX */ | |
143 | struct { | |
144 | struct page *page; | |
6366ad33 AD |
145 | dma_addr_t page_dma; |
146 | u16 page_offset; | |
9d5c8243 AK |
147 | }; |
148 | }; | |
149 | }; | |
150 | ||
8c0ab70a | 151 | struct igb_tx_queue_stats { |
9d5c8243 AK |
152 | u64 packets; |
153 | u64 bytes; | |
04a5fcaa | 154 | u64 restart_queue; |
9d5c8243 AK |
155 | }; |
156 | ||
8c0ab70a JDB |
157 | struct igb_rx_queue_stats { |
158 | u64 packets; | |
159 | u64 bytes; | |
160 | u64 drops; | |
04a5fcaa AD |
161 | u64 csum_err; |
162 | u64 alloc_failed; | |
8c0ab70a JDB |
163 | }; |
164 | ||
047e0030 | 165 | struct igb_q_vector { |
9d5c8243 | 166 | struct igb_adapter *adapter; /* backlink */ |
047e0030 AD |
167 | struct igb_ring *rx_ring; |
168 | struct igb_ring *tx_ring; | |
169 | struct napi_struct napi; | |
170 | ||
171 | u32 eims_value; | |
172 | u16 cpu; | |
173 | ||
174 | u16 itr_val; | |
175 | u8 set_itr; | |
176 | u8 itr_shift; | |
177 | void __iomem *itr_register; | |
178 | ||
179 | char name[IFNAMSIZ + 9]; | |
180 | }; | |
181 | ||
182 | struct igb_ring { | |
183 | struct igb_q_vector *q_vector; /* backlink to q_vector */ | |
e694e964 | 184 | struct net_device *netdev; /* back pointer to net_device */ |
80785298 | 185 | struct pci_dev *pdev; /* pci device for dma mapping */ |
047e0030 | 186 | dma_addr_t dma; /* phys address of the ring */ |
e694e964 | 187 | void *desc; /* descriptor ring memory */ |
047e0030 | 188 | unsigned int size; /* length of desc. ring in bytes */ |
2e5655e7 | 189 | u16 count; /* number of desc. in the ring */ |
9d5c8243 AK |
190 | u16 next_to_use; |
191 | u16 next_to_clean; | |
2e5655e7 AD |
192 | u8 queue_index; |
193 | u8 reg_idx; | |
fce99e34 AD |
194 | void __iomem *head; |
195 | void __iomem *tail; | |
9d5c8243 AK |
196 | struct igb_buffer *buffer_info; /* array of buffer info structs */ |
197 | ||
9d5c8243 AK |
198 | unsigned int total_bytes; |
199 | unsigned int total_packets; | |
200 | ||
85ad76b2 AD |
201 | u32 flags; |
202 | ||
9d5c8243 AK |
203 | union { |
204 | /* TX */ | |
205 | struct { | |
8c0ab70a | 206 | struct igb_tx_queue_stats tx_stats; |
9d5c8243 AK |
207 | bool detect_tx_hung; |
208 | }; | |
209 | /* RX */ | |
210 | struct { | |
8c0ab70a | 211 | struct igb_rx_queue_stats rx_stats; |
4c844851 | 212 | u32 rx_buffer_len; |
9d5c8243 AK |
213 | }; |
214 | }; | |
9d5c8243 AK |
215 | }; |
216 | ||
85ad76b2 AD |
217 | #define IGB_RING_FLAG_RX_CSUM 0x00000001 /* RX CSUM enabled */ |
218 | #define IGB_RING_FLAG_RX_SCTP_CSUM 0x00000002 /* SCTP CSUM offload enabled */ | |
219 | ||
220 | #define IGB_RING_FLAG_TX_CTX_IDX 0x00000001 /* HW requires context index */ | |
221 | ||
222 | #define IGB_ADVTXD_DCMD (E1000_TXD_CMD_EOP | E1000_TXD_CMD_RS) | |
223 | ||
9d5c8243 AK |
224 | #define E1000_RX_DESC_ADV(R, i) \ |
225 | (&(((union e1000_adv_rx_desc *)((R).desc))[i])) | |
226 | #define E1000_TX_DESC_ADV(R, i) \ | |
227 | (&(((union e1000_adv_tx_desc *)((R).desc))[i])) | |
228 | #define E1000_TX_CTXTDESC_ADV(R, i) \ | |
229 | (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i])) | |
9d5c8243 | 230 | |
d7ee5b3a AD |
231 | /* igb_desc_unused - calculate if we have unused descriptors */ |
232 | static inline int igb_desc_unused(struct igb_ring *ring) | |
233 | { | |
234 | if (ring->next_to_clean > ring->next_to_use) | |
235 | return ring->next_to_clean - ring->next_to_use - 1; | |
236 | ||
237 | return ring->count + ring->next_to_clean - ring->next_to_use - 1; | |
238 | } | |
239 | ||
9d5c8243 AK |
240 | /* board specific private data structure */ |
241 | ||
242 | struct igb_adapter { | |
243 | struct timer_list watchdog_timer; | |
244 | struct timer_list phy_info_timer; | |
245 | struct vlan_group *vlgrp; | |
246 | u16 mng_vlan_id; | |
247 | u32 bd_number; | |
9d5c8243 AK |
248 | u32 wol; |
249 | u32 en_mng_pt; | |
250 | u16 link_speed; | |
251 | u16 link_duplex; | |
2e5655e7 | 252 | |
9d5c8243 | 253 | /* Interrupt Throttle Rate */ |
4fc82adf AD |
254 | u32 rx_itr_setting; |
255 | u32 tx_itr_setting; | |
9d5c8243 AK |
256 | u16 tx_itr; |
257 | u16 rx_itr; | |
9d5c8243 AK |
258 | |
259 | struct work_struct reset_task; | |
260 | struct work_struct watchdog_task; | |
261 | bool fc_autoneg; | |
262 | u8 tx_timeout_factor; | |
263 | struct timer_list blink_timer; | |
264 | unsigned long led_status; | |
265 | ||
266 | /* TX */ | |
267 | struct igb_ring *tx_ring; /* One per active queue */ | |
9d5c8243 | 268 | unsigned long tx_queue_len; |
9d5c8243 AK |
269 | u32 tx_timeout_count; |
270 | ||
271 | /* RX */ | |
272 | struct igb_ring *rx_ring; /* One per active queue */ | |
273 | int num_tx_queues; | |
274 | int num_rx_queues; | |
275 | ||
9d5c8243 AK |
276 | u32 max_frame_size; |
277 | u32 min_frame_size; | |
278 | ||
279 | /* OS defined structs */ | |
280 | struct net_device *netdev; | |
9d5c8243 | 281 | struct pci_dev *pdev; |
38c845c7 PO |
282 | struct cyclecounter cycles; |
283 | struct timecounter clock; | |
33af6bcc PO |
284 | struct timecompare compare; |
285 | struct hwtstamp_config hwtstamp_config; | |
9d5c8243 AK |
286 | |
287 | /* structs defined in e1000_hw.h */ | |
288 | struct e1000_hw hw; | |
289 | struct e1000_hw_stats stats; | |
290 | struct e1000_phy_info phy_info; | |
291 | struct e1000_phy_stats phy_stats; | |
292 | ||
293 | u32 test_icr; | |
294 | struct igb_ring test_tx_ring; | |
295 | struct igb_ring test_rx_ring; | |
296 | ||
297 | int msg_enable; | |
047e0030 AD |
298 | |
299 | unsigned int num_q_vectors; | |
300 | struct igb_q_vector *q_vector[MAX_Q_VECTORS]; | |
9d5c8243 AK |
301 | struct msix_entry *msix_entries; |
302 | u32 eims_enable_mask; | |
844290e5 | 303 | u32 eims_other; |
9d5c8243 AK |
304 | |
305 | /* to not mess up cache alignment, always add to the bottom */ | |
306 | unsigned long state; | |
7dfc16fa | 307 | unsigned int flags; |
9d5c8243 | 308 | u32 eeprom_wol; |
42bfd33a | 309 | |
1bfaf07b | 310 | struct igb_ring *multi_tx_table[IGB_ABS_MAX_TX_QUEUES]; |
2e5655e7 AD |
311 | u16 tx_ring_count; |
312 | u16 rx_ring_count; | |
1bfaf07b | 313 | unsigned int vfs_allocated_count; |
4ae196df | 314 | struct vf_data_storage *vf_data; |
a99955fc | 315 | u32 rss_queues; |
9d5c8243 AK |
316 | }; |
317 | ||
7dfc16fa | 318 | #define IGB_FLAG_HAS_MSI (1 << 0) |
cbd347ad AD |
319 | #define IGB_FLAG_DCA_ENABLED (1 << 1) |
320 | #define IGB_FLAG_QUAD_PORT_A (1 << 2) | |
4fc82adf | 321 | #define IGB_FLAG_QUEUE_PAIRS (1 << 3) |
7dfc16fa | 322 | |
c5b9bd5e | 323 | #define IGB_82576_TSYNC_SHIFT 19 |
55cac248 | 324 | #define IGB_82580_TSYNC_SHIFT 24 |
9d5c8243 AK |
325 | enum e1000_state_t { |
326 | __IGB_TESTING, | |
327 | __IGB_RESETTING, | |
328 | __IGB_DOWN | |
329 | }; | |
330 | ||
331 | enum igb_boards { | |
332 | board_82575, | |
333 | }; | |
334 | ||
335 | extern char igb_driver_name[]; | |
336 | extern char igb_driver_version[]; | |
337 | ||
338 | extern char *igb_get_hw_dev_name(struct e1000_hw *hw); | |
339 | extern int igb_up(struct igb_adapter *); | |
340 | extern void igb_down(struct igb_adapter *); | |
341 | extern void igb_reinit_locked(struct igb_adapter *); | |
342 | extern void igb_reset(struct igb_adapter *); | |
343 | extern int igb_set_spd_dplx(struct igb_adapter *, u16); | |
80785298 AD |
344 | extern int igb_setup_tx_resources(struct igb_ring *); |
345 | extern int igb_setup_rx_resources(struct igb_ring *); | |
68fd9910 AD |
346 | extern void igb_free_tx_resources(struct igb_ring *); |
347 | extern void igb_free_rx_resources(struct igb_ring *); | |
d7ee5b3a AD |
348 | extern void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *); |
349 | extern void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *); | |
350 | extern void igb_setup_tctl(struct igb_adapter *); | |
351 | extern void igb_setup_rctl(struct igb_adapter *); | |
b1a436c3 AD |
352 | extern netdev_tx_t igb_xmit_frame_ring_adv(struct sk_buff *, struct igb_ring *); |
353 | extern void igb_unmap_and_free_tx_resource(struct igb_ring *, | |
354 | struct igb_buffer *); | |
d7ee5b3a | 355 | extern void igb_alloc_rx_buffers_adv(struct igb_ring *, int); |
9d5c8243 AK |
356 | extern void igb_update_stats(struct igb_adapter *); |
357 | extern void igb_set_ethtool_ops(struct net_device *); | |
358 | ||
f5f4cf08 AD |
359 | static inline s32 igb_reset_phy(struct e1000_hw *hw) |
360 | { | |
a8d2a0c2 AD |
361 | if (hw->phy.ops.reset) |
362 | return hw->phy.ops.reset(hw); | |
f5f4cf08 AD |
363 | |
364 | return 0; | |
365 | } | |
366 | ||
367 | static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data) | |
368 | { | |
a8d2a0c2 AD |
369 | if (hw->phy.ops.read_reg) |
370 | return hw->phy.ops.read_reg(hw, offset, data); | |
f5f4cf08 AD |
371 | |
372 | return 0; | |
373 | } | |
374 | ||
375 | static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data) | |
376 | { | |
a8d2a0c2 AD |
377 | if (hw->phy.ops.write_reg) |
378 | return hw->phy.ops.write_reg(hw, offset, data); | |
f5f4cf08 AD |
379 | |
380 | return 0; | |
381 | } | |
382 | ||
383 | static inline s32 igb_get_phy_info(struct e1000_hw *hw) | |
384 | { | |
385 | if (hw->phy.ops.get_phy_info) | |
386 | return hw->phy.ops.get_phy_info(hw); | |
387 | ||
388 | return 0; | |
389 | } | |
390 | ||
9d5c8243 | 391 | #endif /* _IGB_H_ */ |