1 /******************************************************************************* 2 3 Intel 82599 Virtual Function driver 4 Copyright(c) 1999 - 2014 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 #ifndef _IXGBEVF_H_ 29 #define _IXGBEVF_H_ 30 31 #include <linux/types.h> 32 #include <linux/bitops.h> 33 #include <linux/timer.h> 34 #include <linux/io.h> 35 #include <linux/netdevice.h> 36 #include <linux/if_vlan.h> 37 #include <linux/u64_stats_sync.h> 38 39 #include "vf.h" 40 41 #ifdef CONFIG_NET_RX_BUSY_POLL 42 #include <net/busy_poll.h> 43 #define BP_EXTENDED_STATS 44 #endif 45 46 /* wrapper around a pointer to a socket buffer, 47 * so a DMA handle can be stored along with the buffer */ 48 struct ixgbevf_tx_buffer { 49 union ixgbe_adv_tx_desc *next_to_watch; 50 unsigned long time_stamp; 51 struct sk_buff *skb; 52 unsigned int bytecount; 53 unsigned short gso_segs; 54 __be16 protocol; 55 DEFINE_DMA_UNMAP_ADDR(dma); 56 DEFINE_DMA_UNMAP_LEN(len); 57 u32 tx_flags; 58 }; 59 60 struct ixgbevf_rx_buffer { 61 dma_addr_t dma; 62 struct page *page; 63 unsigned int page_offset; 64 }; 65 66 struct ixgbevf_stats { 67 u64 packets; 68 u64 bytes; 69 #ifdef BP_EXTENDED_STATS 70 u64 yields; 71 u64 misses; 72 u64 cleaned; 73 #endif 74 }; 75 76 struct ixgbevf_tx_queue_stats { 77 u64 restart_queue; 78 u64 tx_busy; 79 u64 tx_done_old; 80 }; 81 82 struct ixgbevf_rx_queue_stats { 83 u64 alloc_rx_page_failed; 84 u64 alloc_rx_buff_failed; 85 u64 csum_err; 86 }; 87 88 struct ixgbevf_ring { 89 struct ixgbevf_ring *next; 90 struct net_device *netdev; 91 struct device *dev; 92 void *desc; /* descriptor ring memory */ 93 dma_addr_t dma; /* phys. address of descriptor ring */ 94 unsigned int size; /* length in bytes */ 95 u16 count; /* amount of descriptors */ 96 u16 next_to_use; 97 u16 next_to_clean; 98 u16 next_to_alloc; 99 100 union { 101 struct ixgbevf_tx_buffer *tx_buffer_info; 102 struct ixgbevf_rx_buffer *rx_buffer_info; 103 }; 104 105 struct ixgbevf_stats stats; 106 struct u64_stats_sync syncp; 107 union { 108 struct ixgbevf_tx_queue_stats tx_stats; 109 struct ixgbevf_rx_queue_stats rx_stats; 110 }; 111 112 u64 hw_csum_rx_error; 113 u8 __iomem *tail; 114 struct sk_buff *skb; 115 116 u16 reg_idx; /* holds the special value that gets the hardware register 117 * offset associated with this ring, which is different 118 * for DCB and RSS modes */ 119 int queue_index; /* needed for multiqueue queue management */ 120 }; 121 122 /* How many Rx Buffers do we bundle into one write to the hardware ? */ 123 #define IXGBEVF_RX_BUFFER_WRITE 16 /* Must be power of 2 */ 124 125 #define MAX_RX_QUEUES IXGBE_VF_MAX_RX_QUEUES 126 #define MAX_TX_QUEUES IXGBE_VF_MAX_TX_QUEUES 127 128 #define IXGBEVF_DEFAULT_TXD 1024 129 #define IXGBEVF_DEFAULT_RXD 512 130 #define IXGBEVF_MAX_TXD 4096 131 #define IXGBEVF_MIN_TXD 64 132 #define IXGBEVF_MAX_RXD 4096 133 #define IXGBEVF_MIN_RXD 64 134 135 /* Supported Rx Buffer Sizes */ 136 #define IXGBEVF_RXBUFFER_256 256 /* Used for packet split */ 137 #define IXGBEVF_RXBUFFER_2048 2048 138 139 #define IXGBEVF_RX_HDR_SIZE IXGBEVF_RXBUFFER_256 140 #define IXGBEVF_RX_BUFSZ IXGBEVF_RXBUFFER_2048 141 142 #define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN) 143 144 #define IXGBE_TX_FLAGS_CSUM (u32)(1) 145 #define IXGBE_TX_FLAGS_VLAN (u32)(1 << 1) 146 #define IXGBE_TX_FLAGS_TSO (u32)(1 << 2) 147 #define IXGBE_TX_FLAGS_IPV4 (u32)(1 << 3) 148 #define IXGBE_TX_FLAGS_VLAN_MASK 0xffff0000 149 #define IXGBE_TX_FLAGS_VLAN_PRIO_MASK 0x0000e000 150 #define IXGBE_TX_FLAGS_VLAN_SHIFT 16 151 152 struct ixgbevf_ring_container { 153 struct ixgbevf_ring *ring; /* pointer to linked list of rings */ 154 unsigned int total_bytes; /* total bytes processed this int */ 155 unsigned int total_packets; /* total packets processed this int */ 156 u8 count; /* total number of rings in vector */ 157 u8 itr; /* current ITR setting for ring */ 158 }; 159 160 /* iterator for handling rings in ring container */ 161 #define ixgbevf_for_each_ring(pos, head) \ 162 for (pos = (head).ring; pos != NULL; pos = pos->next) 163 164 /* MAX_MSIX_Q_VECTORS of these are allocated, 165 * but we only use one per queue-specific vector. 166 */ 167 struct ixgbevf_q_vector { 168 struct ixgbevf_adapter *adapter; 169 u16 v_idx; /* index of q_vector within array, also used for 170 * finding the bit in EICR and friends that 171 * represents the vector for this ring */ 172 u16 itr; /* Interrupt throttle rate written to EITR */ 173 struct napi_struct napi; 174 struct ixgbevf_ring_container rx, tx; 175 char name[IFNAMSIZ + 9]; 176 #ifdef CONFIG_NET_RX_BUSY_POLL 177 unsigned int state; 178 #define IXGBEVF_QV_STATE_IDLE 0 179 #define IXGBEVF_QV_STATE_NAPI 1 /* NAPI owns this QV */ 180 #define IXGBEVF_QV_STATE_POLL 2 /* poll owns this QV */ 181 #define IXGBEVF_QV_STATE_DISABLED 4 /* QV is disabled */ 182 #define IXGBEVF_QV_OWNED (IXGBEVF_QV_STATE_NAPI | IXGBEVF_QV_STATE_POLL) 183 #define IXGBEVF_QV_LOCKED (IXGBEVF_QV_OWNED | IXGBEVF_QV_STATE_DISABLED) 184 #define IXGBEVF_QV_STATE_NAPI_YIELD 8 /* NAPI yielded this QV */ 185 #define IXGBEVF_QV_STATE_POLL_YIELD 16 /* poll yielded this QV */ 186 #define IXGBEVF_QV_YIELD (IXGBEVF_QV_STATE_NAPI_YIELD | IXGBEVF_QV_STATE_POLL_YIELD) 187 #define IXGBEVF_QV_USER_PEND (IXGBEVF_QV_STATE_POLL | IXGBEVF_QV_STATE_POLL_YIELD) 188 spinlock_t lock; 189 #endif /* CONFIG_NET_RX_BUSY_POLL */ 190 }; 191 #ifdef CONFIG_NET_RX_BUSY_POLL 192 static inline void ixgbevf_qv_init_lock(struct ixgbevf_q_vector *q_vector) 193 { 194 195 spin_lock_init(&q_vector->lock); 196 q_vector->state = IXGBEVF_QV_STATE_IDLE; 197 } 198 199 /* called from the device poll routine to get ownership of a q_vector */ 200 static inline bool ixgbevf_qv_lock_napi(struct ixgbevf_q_vector *q_vector) 201 { 202 int rc = true; 203 spin_lock_bh(&q_vector->lock); 204 if (q_vector->state & IXGBEVF_QV_LOCKED) { 205 WARN_ON(q_vector->state & IXGBEVF_QV_STATE_NAPI); 206 q_vector->state |= IXGBEVF_QV_STATE_NAPI_YIELD; 207 rc = false; 208 #ifdef BP_EXTENDED_STATS 209 q_vector->tx.ring->stats.yields++; 210 #endif 211 } else { 212 /* we don't care if someone yielded */ 213 q_vector->state = IXGBEVF_QV_STATE_NAPI; 214 } 215 spin_unlock_bh(&q_vector->lock); 216 return rc; 217 } 218 219 /* returns true is someone tried to get the qv while napi had it */ 220 static inline bool ixgbevf_qv_unlock_napi(struct ixgbevf_q_vector *q_vector) 221 { 222 int rc = false; 223 spin_lock_bh(&q_vector->lock); 224 WARN_ON(q_vector->state & (IXGBEVF_QV_STATE_POLL | 225 IXGBEVF_QV_STATE_NAPI_YIELD)); 226 227 if (q_vector->state & IXGBEVF_QV_STATE_POLL_YIELD) 228 rc = true; 229 /* reset state to idle, unless QV is disabled */ 230 q_vector->state &= IXGBEVF_QV_STATE_DISABLED; 231 spin_unlock_bh(&q_vector->lock); 232 return rc; 233 } 234 235 /* called from ixgbevf_low_latency_poll() */ 236 static inline bool ixgbevf_qv_lock_poll(struct ixgbevf_q_vector *q_vector) 237 { 238 int rc = true; 239 spin_lock_bh(&q_vector->lock); 240 if ((q_vector->state & IXGBEVF_QV_LOCKED)) { 241 q_vector->state |= IXGBEVF_QV_STATE_POLL_YIELD; 242 rc = false; 243 #ifdef BP_EXTENDED_STATS 244 q_vector->rx.ring->stats.yields++; 245 #endif 246 } else { 247 /* preserve yield marks */ 248 q_vector->state |= IXGBEVF_QV_STATE_POLL; 249 } 250 spin_unlock_bh(&q_vector->lock); 251 return rc; 252 } 253 254 /* returns true if someone tried to get the qv while it was locked */ 255 static inline bool ixgbevf_qv_unlock_poll(struct ixgbevf_q_vector *q_vector) 256 { 257 int rc = false; 258 spin_lock_bh(&q_vector->lock); 259 WARN_ON(q_vector->state & (IXGBEVF_QV_STATE_NAPI)); 260 261 if (q_vector->state & IXGBEVF_QV_STATE_POLL_YIELD) 262 rc = true; 263 /* reset state to idle, unless QV is disabled */ 264 q_vector->state &= IXGBEVF_QV_STATE_DISABLED; 265 spin_unlock_bh(&q_vector->lock); 266 return rc; 267 } 268 269 /* true if a socket is polling, even if it did not get the lock */ 270 static inline bool ixgbevf_qv_busy_polling(struct ixgbevf_q_vector *q_vector) 271 { 272 WARN_ON(!(q_vector->state & IXGBEVF_QV_OWNED)); 273 return q_vector->state & IXGBEVF_QV_USER_PEND; 274 } 275 276 /* false if QV is currently owned */ 277 static inline bool ixgbevf_qv_disable(struct ixgbevf_q_vector *q_vector) 278 { 279 int rc = true; 280 spin_lock_bh(&q_vector->lock); 281 if (q_vector->state & IXGBEVF_QV_OWNED) 282 rc = false; 283 q_vector->state |= IXGBEVF_QV_STATE_DISABLED; 284 spin_unlock_bh(&q_vector->lock); 285 return rc; 286 } 287 288 #endif /* CONFIG_NET_RX_BUSY_POLL */ 289 290 /* 291 * microsecond values for various ITR rates shifted by 2 to fit itr register 292 * with the first 3 bits reserved 0 293 */ 294 #define IXGBE_MIN_RSC_ITR 24 295 #define IXGBE_100K_ITR 40 296 #define IXGBE_20K_ITR 200 297 #define IXGBE_10K_ITR 400 298 #define IXGBE_8K_ITR 500 299 300 /* Helper macros to switch between ints/sec and what the register uses. 301 * And yes, it's the same math going both ways. The lowest value 302 * supported by all of the ixgbe hardware is 8. 303 */ 304 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \ 305 ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8) 306 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG 307 308 /* ixgbevf_test_staterr - tests bits in Rx descriptor status and error fields */ 309 static inline __le32 ixgbevf_test_staterr(union ixgbe_adv_rx_desc *rx_desc, 310 const u32 stat_err_bits) 311 { 312 return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits); 313 } 314 315 static inline u16 ixgbevf_desc_unused(struct ixgbevf_ring *ring) 316 { 317 u16 ntc = ring->next_to_clean; 318 u16 ntu = ring->next_to_use; 319 320 return ((ntc > ntu) ? 0 : ring->count) + ntc - ntu - 1; 321 } 322 323 static inline void ixgbevf_write_tail(struct ixgbevf_ring *ring, u32 value) 324 { 325 writel(value, ring->tail); 326 } 327 328 #define IXGBEVF_RX_DESC(R, i) \ 329 (&(((union ixgbe_adv_rx_desc *)((R)->desc))[i])) 330 #define IXGBEVF_TX_DESC(R, i) \ 331 (&(((union ixgbe_adv_tx_desc *)((R)->desc))[i])) 332 #define IXGBEVF_TX_CTXTDESC(R, i) \ 333 (&(((struct ixgbe_adv_tx_context_desc *)((R)->desc))[i])) 334 335 #define IXGBE_MAX_JUMBO_FRAME_SIZE 9728 /* Maximum Supported Size 9.5KB */ 336 337 #define OTHER_VECTOR 1 338 #define NON_Q_VECTORS (OTHER_VECTOR) 339 340 #define MAX_MSIX_Q_VECTORS 2 341 342 #define MIN_MSIX_Q_VECTORS 1 343 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS) 344 345 /* board specific private data structure */ 346 struct ixgbevf_adapter { 347 /* this field must be first, see ixgbevf_process_skb_fields */ 348 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; 349 350 struct timer_list watchdog_timer; 351 struct work_struct reset_task; 352 struct ixgbevf_q_vector *q_vector[MAX_MSIX_Q_VECTORS]; 353 354 /* Interrupt Throttle Rate */ 355 u16 rx_itr_setting; 356 u16 tx_itr_setting; 357 358 /* interrupt masks */ 359 u32 eims_enable_mask; 360 u32 eims_other; 361 362 /* TX */ 363 int num_tx_queues; 364 struct ixgbevf_ring *tx_ring[MAX_TX_QUEUES]; /* One per active queue */ 365 u64 restart_queue; 366 u32 tx_timeout_count; 367 368 /* RX */ 369 int num_rx_queues; 370 struct ixgbevf_ring *rx_ring[MAX_TX_QUEUES]; /* One per active queue */ 371 u64 hw_csum_rx_error; 372 u64 hw_rx_no_dma_resources; 373 int num_msix_vectors; 374 u32 alloc_rx_page_failed; 375 u32 alloc_rx_buff_failed; 376 377 /* Some features need tri-state capability, 378 * thus the additional *_CAPABLE flags. 379 */ 380 u32 flags; 381 #define IXGBE_FLAG_IN_WATCHDOG_TASK (u32)(1) 382 383 #define IXGBEVF_FLAG_QUEUE_RESET_REQUESTED (u32)(1 << 2) 384 385 struct msix_entry *msix_entries; 386 387 /* OS defined structs */ 388 struct net_device *netdev; 389 struct pci_dev *pdev; 390 391 /* structs defined in ixgbe_vf.h */ 392 struct ixgbe_hw hw; 393 u16 msg_enable; 394 /* Interrupt Throttle Rate */ 395 u32 eitr_param; 396 397 struct ixgbevf_hw_stats stats; 398 399 unsigned long state; 400 u64 tx_busy; 401 unsigned int tx_ring_count; 402 unsigned int rx_ring_count; 403 404 #ifdef BP_EXTENDED_STATS 405 u64 bp_rx_yields; 406 u64 bp_rx_cleaned; 407 u64 bp_rx_missed; 408 409 u64 bp_tx_yields; 410 u64 bp_tx_cleaned; 411 u64 bp_tx_missed; 412 #endif 413 414 u8 __iomem *io_addr; /* Mainly for iounmap use */ 415 u32 link_speed; 416 bool link_up; 417 418 spinlock_t mbx_lock; 419 420 struct work_struct watchdog_task; 421 }; 422 423 enum ixbgevf_state_t { 424 __IXGBEVF_TESTING, 425 __IXGBEVF_RESETTING, 426 __IXGBEVF_DOWN, 427 __IXGBEVF_DISABLED, 428 __IXGBEVF_REMOVING, 429 __IXGBEVF_WORK_INIT, 430 }; 431 432 enum ixgbevf_boards { 433 board_82599_vf, 434 board_X540_vf, 435 board_X550_vf, 436 board_X550EM_x_vf, 437 }; 438 439 extern const struct ixgbevf_info ixgbevf_82599_vf_info; 440 extern const struct ixgbevf_info ixgbevf_X540_vf_info; 441 extern const struct ixgbevf_info ixgbevf_X550_vf_info; 442 extern const struct ixgbevf_info ixgbevf_X550EM_x_vf_info; 443 extern const struct ixgbe_mbx_operations ixgbevf_mbx_ops; 444 445 /* needed by ethtool.c */ 446 extern const char ixgbevf_driver_name[]; 447 extern const char ixgbevf_driver_version[]; 448 449 void ixgbevf_up(struct ixgbevf_adapter *adapter); 450 void ixgbevf_down(struct ixgbevf_adapter *adapter); 451 void ixgbevf_reinit_locked(struct ixgbevf_adapter *adapter); 452 void ixgbevf_reset(struct ixgbevf_adapter *adapter); 453 void ixgbevf_set_ethtool_ops(struct net_device *netdev); 454 int ixgbevf_setup_rx_resources(struct ixgbevf_ring *); 455 int ixgbevf_setup_tx_resources(struct ixgbevf_ring *); 456 void ixgbevf_free_rx_resources(struct ixgbevf_ring *); 457 void ixgbevf_free_tx_resources(struct ixgbevf_ring *); 458 void ixgbevf_update_stats(struct ixgbevf_adapter *adapter); 459 int ethtool_ioctl(struct ifreq *ifr); 460 461 extern void ixgbevf_write_eitr(struct ixgbevf_q_vector *q_vector); 462 463 void ixgbe_napi_add_all(struct ixgbevf_adapter *adapter); 464 void ixgbe_napi_del_all(struct ixgbevf_adapter *adapter); 465 466 #ifdef DEBUG 467 char *ixgbevf_get_hw_dev_name(struct ixgbe_hw *hw); 468 #define hw_dbg(hw, format, arg...) \ 469 printk(KERN_DEBUG "%s: " format, ixgbevf_get_hw_dev_name(hw), ##arg) 470 #else 471 #define hw_dbg(hw, format, arg...) do {} while (0) 472 #endif 473 474 #endif /* _IXGBEVF_H_ */ 475