1 /******************************************************************************* 2 * 3 * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver 4 * Copyright(c) 2013 - 2016 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 16 * with this program. If not, see <http://www.gnu.org/licenses/>. 17 * 18 * The full GNU General Public License is included in this distribution in 19 * the file called "COPYING". 20 * 21 * Contact Information: 22 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net> 23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 24 * 25 ******************************************************************************/ 26 27 #ifndef _I40EVF_H_ 28 #define _I40EVF_H_ 29 30 #include <linux/module.h> 31 #include <linux/pci.h> 32 #include <linux/aer.h> 33 #include <linux/netdevice.h> 34 #include <linux/vmalloc.h> 35 #include <linux/interrupt.h> 36 #include <linux/ethtool.h> 37 #include <linux/if_vlan.h> 38 #include <linux/ip.h> 39 #include <linux/tcp.h> 40 #include <linux/sctp.h> 41 #include <linux/ipv6.h> 42 #include <net/ip6_checksum.h> 43 #include <net/udp.h> 44 45 #include "i40e_type.h" 46 #include "i40e_virtchnl.h" 47 #include "i40e_txrx.h" 48 49 #define DEFAULT_DEBUG_LEVEL_SHIFT 3 50 #define PFX "i40evf: " 51 52 /* dummy struct to make common code less painful */ 53 struct i40e_vsi { 54 struct i40evf_adapter *back; 55 struct net_device *netdev; 56 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; 57 u16 seid; 58 u16 id; 59 unsigned long state; 60 int base_vector; 61 u16 work_limit; 62 u16 qs_handle; 63 }; 64 65 /* How many Rx Buffers do we bundle into one write to the hardware ? */ 66 #define I40EVF_RX_BUFFER_WRITE 16 /* Must be power of 2 */ 67 #define I40EVF_DEFAULT_TXD 512 68 #define I40EVF_DEFAULT_RXD 512 69 #define I40EVF_MAX_TXD 4096 70 #define I40EVF_MIN_TXD 64 71 #define I40EVF_MAX_RXD 4096 72 #define I40EVF_MIN_RXD 64 73 #define I40EVF_REQ_DESCRIPTOR_MULTIPLE 32 74 75 /* Supported Rx Buffer Sizes */ 76 #define I40EVF_RXBUFFER_2048 2048 77 #define I40EVF_MAX_RXBUFFER 16384 /* largest size for single descriptor */ 78 #define I40EVF_MAX_AQ_BUF_SIZE 4096 79 #define I40EVF_AQ_LEN 32 80 #define I40EVF_AQ_MAX_ERR 20 /* times to try before resetting AQ */ 81 82 #define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN) 83 84 #define I40E_RX_DESC(R, i) (&(((union i40e_32byte_rx_desc *)((R)->desc))[i])) 85 #define I40E_TX_DESC(R, i) (&(((struct i40e_tx_desc *)((R)->desc))[i])) 86 #define I40E_TX_CTXTDESC(R, i) \ 87 (&(((struct i40e_tx_context_desc *)((R)->desc))[i])) 88 #define MAX_QUEUES 16 89 90 #define I40EVF_HKEY_ARRAY_SIZE ((I40E_VFQF_HKEY_MAX_INDEX + 1) * 4) 91 #define I40EVF_HLUT_ARRAY_SIZE ((I40E_VFQF_HLUT_MAX_INDEX + 1) * 4) 92 93 /* MAX_MSIX_Q_VECTORS of these are allocated, 94 * but we only use one per queue-specific vector. 95 */ 96 struct i40e_q_vector { 97 struct i40evf_adapter *adapter; 98 struct i40e_vsi *vsi; 99 struct napi_struct napi; 100 unsigned long reg_idx; 101 struct i40e_ring_container rx; 102 struct i40e_ring_container tx; 103 u32 ring_mask; 104 u8 num_ringpairs; /* total number of ring pairs in vector */ 105 #define ITR_COUNTDOWN_START 100 106 u8 itr_countdown; /* when 0 or 1 update ITR */ 107 int v_idx; /* vector index in list */ 108 char name[IFNAMSIZ + 9]; 109 bool arm_wb_state; 110 cpumask_var_t affinity_mask; 111 }; 112 113 /* Helper macros to switch between ints/sec and what the register uses. 114 * And yes, it's the same math going both ways. The lowest value 115 * supported by all of the i40e hardware is 8. 116 */ 117 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \ 118 ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8) 119 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG 120 121 #define I40EVF_DESC_UNUSED(R) \ 122 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \ 123 (R)->next_to_clean - (R)->next_to_use - 1) 124 125 #define I40EVF_RX_DESC_ADV(R, i) \ 126 (&(((union i40e_adv_rx_desc *)((R).desc))[i])) 127 #define I40EVF_TX_DESC_ADV(R, i) \ 128 (&(((union i40e_adv_tx_desc *)((R).desc))[i])) 129 #define I40EVF_TX_CTXTDESC_ADV(R, i) \ 130 (&(((struct i40e_adv_tx_context_desc *)((R).desc))[i])) 131 132 #define OTHER_VECTOR 1 133 #define NONQ_VECS (OTHER_VECTOR) 134 135 #define MIN_MSIX_Q_VECTORS 1 136 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS) 137 138 #define I40EVF_QUEUE_END_OF_LIST 0x7FF 139 #define I40EVF_FREE_VECTOR 0x7FFF 140 struct i40evf_mac_filter { 141 struct list_head list; 142 u8 macaddr[ETH_ALEN]; 143 bool remove; /* filter needs to be removed */ 144 bool add; /* filter needs to be added */ 145 }; 146 147 struct i40evf_vlan_filter { 148 struct list_head list; 149 u16 vlan; 150 bool remove; /* filter needs to be removed */ 151 bool add; /* filter needs to be added */ 152 }; 153 154 /* Driver state. The order of these is important! */ 155 enum i40evf_state_t { 156 __I40EVF_STARTUP, /* driver loaded, probe complete */ 157 __I40EVF_REMOVE, /* driver is being unloaded */ 158 __I40EVF_INIT_VERSION_CHECK, /* aq msg sent, awaiting reply */ 159 __I40EVF_INIT_GET_RESOURCES, /* aq msg sent, awaiting reply */ 160 __I40EVF_INIT_SW, /* got resources, setting up structs */ 161 __I40EVF_RESETTING, /* in reset */ 162 /* Below here, watchdog is running */ 163 __I40EVF_DOWN, /* ready, can be opened */ 164 __I40EVF_DOWN_PENDING, /* descending, waiting for watchdog */ 165 __I40EVF_TESTING, /* in ethtool self-test */ 166 __I40EVF_RUNNING, /* opened, working */ 167 }; 168 169 enum i40evf_critical_section_t { 170 __I40EVF_IN_CRITICAL_TASK, /* cannot be interrupted */ 171 }; 172 /* make common code happy */ 173 #define __I40E_DOWN __I40EVF_DOWN 174 175 /* board specific private data structure */ 176 struct i40evf_adapter { 177 struct timer_list watchdog_timer; 178 struct work_struct reset_task; 179 struct work_struct adminq_task; 180 struct delayed_work init_task; 181 struct i40e_q_vector *q_vectors; 182 struct list_head vlan_filter_list; 183 char misc_vector_name[IFNAMSIZ + 9]; 184 int num_active_queues; 185 186 /* TX */ 187 struct i40e_ring *tx_rings; 188 u32 tx_timeout_count; 189 struct list_head mac_filter_list; 190 u32 tx_desc_count; 191 192 /* RX */ 193 struct i40e_ring *rx_rings; 194 u64 hw_csum_rx_error; 195 u32 rx_desc_count; 196 int num_msix_vectors; 197 struct msix_entry *msix_entries; 198 199 u32 flags; 200 #define I40EVF_FLAG_RX_CSUM_ENABLED BIT(0) 201 #define I40EVF_FLAG_IN_NETPOLL BIT(4) 202 #define I40EVF_FLAG_IMIR_ENABLED BIT(5) 203 #define I40EVF_FLAG_MQ_CAPABLE BIT(6) 204 #define I40EVF_FLAG_NEED_LINK_UPDATE BIT(7) 205 #define I40EVF_FLAG_PF_COMMS_FAILED BIT(8) 206 #define I40EVF_FLAG_RESET_PENDING BIT(9) 207 #define I40EVF_FLAG_RESET_NEEDED BIT(10) 208 #define I40EVF_FLAG_WB_ON_ITR_CAPABLE BIT(11) 209 #define I40EVF_FLAG_OUTER_UDP_CSUM_CAPABLE BIT(12) 210 #define I40EVF_FLAG_ADDR_SET_BY_PF BIT(13) 211 #define I40EVF_FLAG_SERVICE_CLIENT_REQUESTED BIT(14) 212 #define I40EVF_FLAG_PROMISC_ON BIT(15) 213 #define I40EVF_FLAG_ALLMULTI_ON BIT(16) 214 /* duplicates for common code */ 215 #define I40E_FLAG_FDIR_ATR_ENABLED 0 216 #define I40E_FLAG_DCB_ENABLED 0 217 #define I40E_FLAG_IN_NETPOLL I40EVF_FLAG_IN_NETPOLL 218 #define I40E_FLAG_RX_CSUM_ENABLED I40EVF_FLAG_RX_CSUM_ENABLED 219 #define I40E_FLAG_WB_ON_ITR_CAPABLE I40EVF_FLAG_WB_ON_ITR_CAPABLE 220 #define I40E_FLAG_OUTER_UDP_CSUM_CAPABLE I40EVF_FLAG_OUTER_UDP_CSUM_CAPABLE 221 /* flags for admin queue service task */ 222 u32 aq_required; 223 #define I40EVF_FLAG_AQ_ENABLE_QUEUES BIT(0) 224 #define I40EVF_FLAG_AQ_DISABLE_QUEUES BIT(1) 225 #define I40EVF_FLAG_AQ_ADD_MAC_FILTER BIT(2) 226 #define I40EVF_FLAG_AQ_ADD_VLAN_FILTER BIT(3) 227 #define I40EVF_FLAG_AQ_DEL_MAC_FILTER BIT(4) 228 #define I40EVF_FLAG_AQ_DEL_VLAN_FILTER BIT(5) 229 #define I40EVF_FLAG_AQ_CONFIGURE_QUEUES BIT(6) 230 #define I40EVF_FLAG_AQ_MAP_VECTORS BIT(7) 231 #define I40EVF_FLAG_AQ_HANDLE_RESET BIT(8) 232 #define I40EVF_FLAG_AQ_CONFIGURE_RSS BIT(9) /* direct AQ config */ 233 #define I40EVF_FLAG_AQ_GET_CONFIG BIT(10) 234 /* Newer style, RSS done by the PF so we can ignore hardware vagaries. */ 235 #define I40EVF_FLAG_AQ_GET_HENA BIT(11) 236 #define I40EVF_FLAG_AQ_SET_HENA BIT(12) 237 #define I40EVF_FLAG_AQ_SET_RSS_KEY BIT(13) 238 #define I40EVF_FLAG_AQ_SET_RSS_LUT BIT(14) 239 #define I40EVF_FLAG_AQ_REQUEST_PROMISC BIT(15) 240 #define I40EVF_FLAG_AQ_RELEASE_PROMISC BIT(16) 241 #define I40EVF_FLAG_AQ_REQUEST_ALLMULTI BIT(17) 242 #define I40EVF_FLAG_AQ_RELEASE_ALLMULTI BIT(18) 243 244 /* OS defined structs */ 245 struct net_device *netdev; 246 struct pci_dev *pdev; 247 struct net_device_stats net_stats; 248 249 struct i40e_hw hw; /* defined in i40e_type.h */ 250 251 enum i40evf_state_t state; 252 unsigned long crit_section; 253 254 struct work_struct watchdog_task; 255 bool netdev_registered; 256 bool link_up; 257 enum i40e_aq_link_speed link_speed; 258 enum i40e_virtchnl_ops current_op; 259 #define CLIENT_ENABLED(_a) ((_a)->vf_res ? \ 260 (_a)->vf_res->vf_offload_flags & \ 261 I40E_VIRTCHNL_VF_OFFLOAD_IWARP : \ 262 0) 263 /* RSS by the PF should be preferred over RSS via other methods. */ 264 #define RSS_PF(_a) ((_a)->vf_res->vf_offload_flags & \ 265 I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF) 266 #define RSS_AQ(_a) ((_a)->vf_res->vf_offload_flags & \ 267 I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ) 268 #define RSS_REG(_a) (!((_a)->vf_res->vf_offload_flags & \ 269 (I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ | \ 270 I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF))) 271 #define VLAN_ALLOWED(_a) ((_a)->vf_res->vf_offload_flags & \ 272 I40E_VIRTCHNL_VF_OFFLOAD_VLAN) 273 struct i40e_virtchnl_vf_resource *vf_res; /* incl. all VSIs */ 274 struct i40e_virtchnl_vsi_resource *vsi_res; /* our LAN VSI */ 275 struct i40e_virtchnl_version_info pf_version; 276 #define PF_IS_V11(_a) (((_a)->pf_version.major == 1) && \ 277 ((_a)->pf_version.minor == 1)) 278 u16 msg_enable; 279 struct i40e_eth_stats current_stats; 280 struct i40e_vsi vsi; 281 u32 aq_wait_count; 282 /* RSS stuff */ 283 u64 hena; 284 u16 rss_key_size; 285 u16 rss_lut_size; 286 u8 *rss_key; 287 u8 *rss_lut; 288 }; 289 290 291 /* Ethtool Private Flags */ 292 293 /* needed by i40evf_ethtool.c */ 294 extern char i40evf_driver_name[]; 295 extern const char i40evf_driver_version[]; 296 297 int i40evf_up(struct i40evf_adapter *adapter); 298 void i40evf_down(struct i40evf_adapter *adapter); 299 int i40evf_process_config(struct i40evf_adapter *adapter); 300 void i40evf_schedule_reset(struct i40evf_adapter *adapter); 301 void i40evf_reset(struct i40evf_adapter *adapter); 302 void i40evf_set_ethtool_ops(struct net_device *netdev); 303 void i40evf_update_stats(struct i40evf_adapter *adapter); 304 void i40evf_reset_interrupt_capability(struct i40evf_adapter *adapter); 305 int i40evf_init_interrupt_scheme(struct i40evf_adapter *adapter); 306 void i40evf_irq_enable_queues(struct i40evf_adapter *adapter, u32 mask); 307 void i40evf_free_all_tx_resources(struct i40evf_adapter *adapter); 308 void i40evf_free_all_rx_resources(struct i40evf_adapter *adapter); 309 310 void i40e_napi_add_all(struct i40evf_adapter *adapter); 311 void i40e_napi_del_all(struct i40evf_adapter *adapter); 312 313 int i40evf_send_api_ver(struct i40evf_adapter *adapter); 314 int i40evf_verify_api_ver(struct i40evf_adapter *adapter); 315 int i40evf_send_vf_config_msg(struct i40evf_adapter *adapter); 316 int i40evf_get_vf_config(struct i40evf_adapter *adapter); 317 void i40evf_irq_enable(struct i40evf_adapter *adapter, bool flush); 318 void i40evf_configure_queues(struct i40evf_adapter *adapter); 319 void i40evf_deconfigure_queues(struct i40evf_adapter *adapter); 320 void i40evf_enable_queues(struct i40evf_adapter *adapter); 321 void i40evf_disable_queues(struct i40evf_adapter *adapter); 322 void i40evf_map_queues(struct i40evf_adapter *adapter); 323 void i40evf_add_ether_addrs(struct i40evf_adapter *adapter); 324 void i40evf_del_ether_addrs(struct i40evf_adapter *adapter); 325 void i40evf_add_vlans(struct i40evf_adapter *adapter); 326 void i40evf_del_vlans(struct i40evf_adapter *adapter); 327 void i40evf_set_promiscuous(struct i40evf_adapter *adapter, int flags); 328 void i40evf_request_stats(struct i40evf_adapter *adapter); 329 void i40evf_request_reset(struct i40evf_adapter *adapter); 330 void i40evf_get_hena(struct i40evf_adapter *adapter); 331 void i40evf_set_hena(struct i40evf_adapter *adapter); 332 void i40evf_set_rss_key(struct i40evf_adapter *adapter); 333 void i40evf_set_rss_lut(struct i40evf_adapter *adapter); 334 void i40evf_virtchnl_completion(struct i40evf_adapter *adapter, 335 enum i40e_virtchnl_ops v_opcode, 336 i40e_status v_retval, u8 *msg, u16 msglen); 337 int i40evf_config_rss(struct i40evf_adapter *adapter); 338 #endif /* _I40EVF_H_ */ 339