1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* Copyright(c) 2013 - 2018 Intel Corporation. */ 3 4 #ifndef _IAVF_H_ 5 #define _IAVF_H_ 6 7 #include <linux/module.h> 8 #include <linux/pci.h> 9 #include <linux/aer.h> 10 #include <linux/netdevice.h> 11 #include <linux/vmalloc.h> 12 #include <linux/interrupt.h> 13 #include <linux/ethtool.h> 14 #include <linux/if_vlan.h> 15 #include <linux/ip.h> 16 #include <linux/tcp.h> 17 #include <linux/sctp.h> 18 #include <linux/ipv6.h> 19 #include <linux/kernel.h> 20 #include <linux/bitops.h> 21 #include <linux/timer.h> 22 #include <linux/workqueue.h> 23 #include <linux/wait.h> 24 #include <linux/delay.h> 25 #include <linux/gfp.h> 26 #include <linux/skbuff.h> 27 #include <linux/dma-mapping.h> 28 #include <linux/etherdevice.h> 29 #include <linux/socket.h> 30 #include <linux/jiffies.h> 31 #include <net/ip6_checksum.h> 32 #include <net/pkt_cls.h> 33 #include <net/udp.h> 34 #include <net/tc_act/tc_gact.h> 35 #include <net/tc_act/tc_mirred.h> 36 37 #include "iavf_type.h" 38 #include <linux/avf/virtchnl.h> 39 #include "iavf_txrx.h" 40 41 #define DEFAULT_DEBUG_LEVEL_SHIFT 3 42 #define PFX "iavf: " 43 44 /* VSI state flags shared with common code */ 45 enum iavf_vsi_state_t { 46 __IAVF_VSI_DOWN, 47 /* This must be last as it determines the size of the BITMAP */ 48 __IAVF_VSI_STATE_SIZE__, 49 }; 50 51 /* dummy struct to make common code less painful */ 52 struct iavf_vsi { 53 struct iavf_adapter *back; 54 struct net_device *netdev; 55 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; 56 u16 seid; 57 u16 id; 58 DECLARE_BITMAP(state, __IAVF_VSI_STATE_SIZE__); 59 int base_vector; 60 u16 work_limit; 61 u16 qs_handle; 62 void *priv; /* client driver data reference. */ 63 }; 64 65 /* How many Rx Buffers do we bundle into one write to the hardware ? */ 66 #define IAVF_RX_BUFFER_WRITE 16 /* Must be power of 2 */ 67 #define IAVF_DEFAULT_TXD 512 68 #define IAVF_DEFAULT_RXD 512 69 #define IAVF_MAX_TXD 4096 70 #define IAVF_MIN_TXD 64 71 #define IAVF_MAX_RXD 4096 72 #define IAVF_MIN_RXD 64 73 #define IAVF_REQ_DESCRIPTOR_MULTIPLE 32 74 #define IAVF_MAX_AQ_BUF_SIZE 4096 75 #define IAVF_AQ_LEN 32 76 #define IAVF_AQ_MAX_ERR 20 /* times to try before resetting AQ */ 77 78 #define MAXIMUM_ETHERNET_VLAN_SIZE (VLAN_ETH_FRAME_LEN + ETH_FCS_LEN) 79 80 #define IAVF_RX_DESC(R, i) (&(((union iavf_32byte_rx_desc *)((R)->desc))[i])) 81 #define IAVF_TX_DESC(R, i) (&(((struct iavf_tx_desc *)((R)->desc))[i])) 82 #define IAVF_TX_CTXTDESC(R, i) \ 83 (&(((struct iavf_tx_context_desc *)((R)->desc))[i])) 84 #define IAVF_MAX_REQ_QUEUES 16 85 86 #define IAVF_HKEY_ARRAY_SIZE ((IAVF_VFQF_HKEY_MAX_INDEX + 1) * 4) 87 #define IAVF_HLUT_ARRAY_SIZE ((IAVF_VFQF_HLUT_MAX_INDEX + 1) * 4) 88 #define IAVF_MBPS_DIVISOR 125000 /* divisor to convert to Mbps */ 89 90 #define IAVF_VIRTCHNL_VF_RESOURCE_SIZE (sizeof(struct virtchnl_vf_resource) + \ 91 (IAVF_MAX_VF_VSI * \ 92 sizeof(struct virtchnl_vsi_resource))) 93 94 /* MAX_MSIX_Q_VECTORS of these are allocated, 95 * but we only use one per queue-specific vector. 96 */ 97 struct iavf_q_vector { 98 struct iavf_adapter *adapter; 99 struct iavf_vsi *vsi; 100 struct napi_struct napi; 101 struct iavf_ring_container rx; 102 struct iavf_ring_container tx; 103 u32 ring_mask; 104 u8 itr_countdown; /* when 0 should adjust adaptive ITR */ 105 u8 num_ringpairs; /* total number of ring pairs in vector */ 106 u16 v_idx; /* index in the vsi->q_vector array. */ 107 u16 reg_idx; /* register index of the interrupt */ 108 char name[IFNAMSIZ + 15]; 109 bool arm_wb_state; 110 cpumask_t affinity_mask; 111 struct irq_affinity_notify affinity_notify; 112 }; 113 114 /* Helper macros to switch between ints/sec and what the register uses. 115 * And yes, it's the same math going both ways. The lowest value 116 * supported by all of the iavf hardware is 8. 117 */ 118 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \ 119 ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8) 120 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG 121 122 #define IAVF_DESC_UNUSED(R) \ 123 ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \ 124 (R)->next_to_clean - (R)->next_to_use - 1) 125 126 #define OTHER_VECTOR 1 127 #define NONQ_VECS (OTHER_VECTOR) 128 129 #define MIN_MSIX_Q_VECTORS 1 130 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NONQ_VECS) 131 132 #define IAVF_QUEUE_END_OF_LIST 0x7FF 133 #define IAVF_FREE_VECTOR 0x7FFF 134 struct iavf_mac_filter { 135 struct list_head list; 136 u8 macaddr[ETH_ALEN]; 137 bool remove; /* filter needs to be removed */ 138 bool add; /* filter needs to be added */ 139 }; 140 141 struct iavf_vlan_filter { 142 struct list_head list; 143 u16 vlan; 144 bool remove; /* filter needs to be removed */ 145 bool add; /* filter needs to be added */ 146 }; 147 148 #define IAVF_MAX_TRAFFIC_CLASS 4 149 /* State of traffic class creation */ 150 enum iavf_tc_state_t { 151 __IAVF_TC_INVALID, /* no traffic class, default state */ 152 __IAVF_TC_RUNNING, /* traffic classes have been created */ 153 }; 154 155 /* channel info */ 156 struct iavf_channel_config { 157 struct virtchnl_channel_info ch_info[IAVF_MAX_TRAFFIC_CLASS]; 158 enum iavf_tc_state_t state; 159 u8 total_qps; 160 }; 161 162 /* State of cloud filter */ 163 enum iavf_cloud_filter_state_t { 164 __IAVF_CF_INVALID, /* cloud filter not added */ 165 __IAVF_CF_ADD_PENDING, /* cloud filter pending add by the PF */ 166 __IAVF_CF_DEL_PENDING, /* cloud filter pending del by the PF */ 167 __IAVF_CF_ACTIVE, /* cloud filter is active */ 168 }; 169 170 /* Driver state. The order of these is important! */ 171 enum iavf_state_t { 172 __IAVF_STARTUP, /* driver loaded, probe complete */ 173 __IAVF_REMOVE, /* driver is being unloaded */ 174 __IAVF_INIT_VERSION_CHECK, /* aq msg sent, awaiting reply */ 175 __IAVF_INIT_GET_RESOURCES, /* aq msg sent, awaiting reply */ 176 __IAVF_INIT_SW, /* got resources, setting up structs */ 177 __IAVF_RESETTING, /* in reset */ 178 __IAVF_COMM_FAILED, /* communication with PF failed */ 179 /* Below here, watchdog is running */ 180 __IAVF_DOWN, /* ready, can be opened */ 181 __IAVF_DOWN_PENDING, /* descending, waiting for watchdog */ 182 __IAVF_TESTING, /* in ethtool self-test */ 183 __IAVF_RUNNING, /* opened, working */ 184 }; 185 186 enum iavf_critical_section_t { 187 __IAVF_IN_CRITICAL_TASK, /* cannot be interrupted */ 188 __IAVF_IN_CLIENT_TASK, 189 __IAVF_IN_REMOVE_TASK, /* device being removed */ 190 }; 191 192 #define IAVF_CLOUD_FIELD_OMAC 0x01 193 #define IAVF_CLOUD_FIELD_IMAC 0x02 194 #define IAVF_CLOUD_FIELD_IVLAN 0x04 195 #define IAVF_CLOUD_FIELD_TEN_ID 0x08 196 #define IAVF_CLOUD_FIELD_IIP 0x10 197 198 #define IAVF_CF_FLAGS_OMAC IAVF_CLOUD_FIELD_OMAC 199 #define IAVF_CF_FLAGS_IMAC IAVF_CLOUD_FIELD_IMAC 200 #define IAVF_CF_FLAGS_IMAC_IVLAN (IAVF_CLOUD_FIELD_IMAC |\ 201 IAVF_CLOUD_FIELD_IVLAN) 202 #define IAVF_CF_FLAGS_IMAC_TEN_ID (IAVF_CLOUD_FIELD_IMAC |\ 203 IAVF_CLOUD_FIELD_TEN_ID) 204 #define IAVF_CF_FLAGS_OMAC_TEN_ID_IMAC (IAVF_CLOUD_FIELD_OMAC |\ 205 IAVF_CLOUD_FIELD_IMAC |\ 206 IAVF_CLOUD_FIELD_TEN_ID) 207 #define IAVF_CF_FLAGS_IMAC_IVLAN_TEN_ID (IAVF_CLOUD_FIELD_IMAC |\ 208 IAVF_CLOUD_FIELD_IVLAN |\ 209 IAVF_CLOUD_FIELD_TEN_ID) 210 #define IAVF_CF_FLAGS_IIP IAVF_CLOUD_FIELD_IIP 211 212 /* bookkeeping of cloud filters */ 213 struct iavf_cloud_filter { 214 enum iavf_cloud_filter_state_t state; 215 struct list_head list; 216 struct virtchnl_filter f; 217 unsigned long cookie; 218 bool del; /* filter needs to be deleted */ 219 bool add; /* filter needs to be added */ 220 }; 221 222 #define IAVF_RESET_WAIT_MS 10 223 #define IAVF_RESET_WAIT_DETECTED_COUNT 500 224 #define IAVF_RESET_WAIT_COMPLETE_COUNT 2000 225 226 /* board specific private data structure */ 227 struct iavf_adapter { 228 struct work_struct reset_task; 229 struct work_struct adminq_task; 230 struct delayed_work client_task; 231 struct delayed_work init_task; 232 wait_queue_head_t down_waitqueue; 233 struct iavf_q_vector *q_vectors; 234 struct list_head vlan_filter_list; 235 struct list_head mac_filter_list; 236 /* Lock to protect accesses to MAC and VLAN lists */ 237 spinlock_t mac_vlan_list_lock; 238 char misc_vector_name[IFNAMSIZ + 9]; 239 int num_active_queues; 240 int num_req_queues; 241 242 /* TX */ 243 struct iavf_ring *tx_rings; 244 u32 tx_timeout_count; 245 u32 tx_desc_count; 246 247 /* RX */ 248 struct iavf_ring *rx_rings; 249 u64 hw_csum_rx_error; 250 u32 rx_desc_count; 251 int num_msix_vectors; 252 int num_iwarp_msix; 253 int iwarp_base_vector; 254 u32 client_pending; 255 struct iavf_client_instance *cinst; 256 struct msix_entry *msix_entries; 257 258 u32 flags; 259 #define IAVF_FLAG_RX_CSUM_ENABLED BIT(0) 260 #define IAVF_FLAG_PF_COMMS_FAILED BIT(3) 261 #define IAVF_FLAG_RESET_PENDING BIT(4) 262 #define IAVF_FLAG_RESET_NEEDED BIT(5) 263 #define IAVF_FLAG_WB_ON_ITR_CAPABLE BIT(6) 264 #define IAVF_FLAG_SERVICE_CLIENT_REQUESTED BIT(9) 265 #define IAVF_FLAG_CLIENT_NEEDS_OPEN BIT(10) 266 #define IAVF_FLAG_CLIENT_NEEDS_CLOSE BIT(11) 267 #define IAVF_FLAG_CLIENT_NEEDS_L2_PARAMS BIT(12) 268 #define IAVF_FLAG_PROMISC_ON BIT(13) 269 #define IAVF_FLAG_ALLMULTI_ON BIT(14) 270 #define IAVF_FLAG_LEGACY_RX BIT(15) 271 #define IAVF_FLAG_REINIT_ITR_NEEDED BIT(16) 272 #define IAVF_FLAG_QUEUES_DISABLED BIT(17) 273 /* duplicates for common code */ 274 #define IAVF_FLAG_DCB_ENABLED 0 275 /* flags for admin queue service task */ 276 u32 aq_required; 277 #define IAVF_FLAG_AQ_ENABLE_QUEUES BIT(0) 278 #define IAVF_FLAG_AQ_DISABLE_QUEUES BIT(1) 279 #define IAVF_FLAG_AQ_ADD_MAC_FILTER BIT(2) 280 #define IAVF_FLAG_AQ_ADD_VLAN_FILTER BIT(3) 281 #define IAVF_FLAG_AQ_DEL_MAC_FILTER BIT(4) 282 #define IAVF_FLAG_AQ_DEL_VLAN_FILTER BIT(5) 283 #define IAVF_FLAG_AQ_CONFIGURE_QUEUES BIT(6) 284 #define IAVF_FLAG_AQ_MAP_VECTORS BIT(7) 285 #define IAVF_FLAG_AQ_HANDLE_RESET BIT(8) 286 #define IAVF_FLAG_AQ_CONFIGURE_RSS BIT(9) /* direct AQ config */ 287 #define IAVF_FLAG_AQ_GET_CONFIG BIT(10) 288 /* Newer style, RSS done by the PF so we can ignore hardware vagaries. */ 289 #define IAVF_FLAG_AQ_GET_HENA BIT(11) 290 #define IAVF_FLAG_AQ_SET_HENA BIT(12) 291 #define IAVF_FLAG_AQ_SET_RSS_KEY BIT(13) 292 #define IAVF_FLAG_AQ_SET_RSS_LUT BIT(14) 293 #define IAVF_FLAG_AQ_REQUEST_PROMISC BIT(15) 294 #define IAVF_FLAG_AQ_RELEASE_PROMISC BIT(16) 295 #define IAVF_FLAG_AQ_REQUEST_ALLMULTI BIT(17) 296 #define IAVF_FLAG_AQ_RELEASE_ALLMULTI BIT(18) 297 #define IAVF_FLAG_AQ_ENABLE_VLAN_STRIPPING BIT(19) 298 #define IAVF_FLAG_AQ_DISABLE_VLAN_STRIPPING BIT(20) 299 #define IAVF_FLAG_AQ_ENABLE_CHANNELS BIT(21) 300 #define IAVF_FLAG_AQ_DISABLE_CHANNELS BIT(22) 301 #define IAVF_FLAG_AQ_ADD_CLOUD_FILTER BIT(23) 302 #define IAVF_FLAG_AQ_DEL_CLOUD_FILTER BIT(24) 303 304 /* OS defined structs */ 305 struct net_device *netdev; 306 struct pci_dev *pdev; 307 308 struct iavf_hw hw; /* defined in iavf_type.h */ 309 310 enum iavf_state_t state; 311 unsigned long crit_section; 312 313 struct delayed_work watchdog_task; 314 bool netdev_registered; 315 bool link_up; 316 enum virtchnl_link_speed link_speed; 317 /* This is only populated if the VIRTCHNL_VF_CAP_ADV_LINK_SPEED is set 318 * in vf_res->vf_cap_flags. Use ADV_LINK_SUPPORT macro to determine if 319 * this field is valid. This field should be used going forward and the 320 * enum virtchnl_link_speed above should be considered the legacy way of 321 * storing/communicating link speeds. 322 */ 323 u32 link_speed_mbps; 324 325 enum virtchnl_ops current_op; 326 #define CLIENT_ALLOWED(_a) ((_a)->vf_res ? \ 327 (_a)->vf_res->vf_cap_flags & \ 328 VIRTCHNL_VF_OFFLOAD_IWARP : \ 329 0) 330 #define CLIENT_ENABLED(_a) ((_a)->cinst) 331 /* RSS by the PF should be preferred over RSS via other methods. */ 332 #define RSS_PF(_a) ((_a)->vf_res->vf_cap_flags & \ 333 VIRTCHNL_VF_OFFLOAD_RSS_PF) 334 #define RSS_AQ(_a) ((_a)->vf_res->vf_cap_flags & \ 335 VIRTCHNL_VF_OFFLOAD_RSS_AQ) 336 #define RSS_REG(_a) (!((_a)->vf_res->vf_cap_flags & \ 337 (VIRTCHNL_VF_OFFLOAD_RSS_AQ | \ 338 VIRTCHNL_VF_OFFLOAD_RSS_PF))) 339 #define VLAN_ALLOWED(_a) ((_a)->vf_res->vf_cap_flags & \ 340 VIRTCHNL_VF_OFFLOAD_VLAN) 341 #define ADV_LINK_SUPPORT(_a) ((_a)->vf_res->vf_cap_flags & \ 342 VIRTCHNL_VF_CAP_ADV_LINK_SPEED) 343 struct virtchnl_vf_resource *vf_res; /* incl. all VSIs */ 344 struct virtchnl_vsi_resource *vsi_res; /* our LAN VSI */ 345 struct virtchnl_version_info pf_version; 346 #define PF_IS_V11(_a) (((_a)->pf_version.major == 1) && \ 347 ((_a)->pf_version.minor == 1)) 348 u16 msg_enable; 349 struct iavf_eth_stats current_stats; 350 struct iavf_vsi vsi; 351 u32 aq_wait_count; 352 /* RSS stuff */ 353 u64 hena; 354 u16 rss_key_size; 355 u16 rss_lut_size; 356 u8 *rss_key; 357 u8 *rss_lut; 358 /* ADQ related members */ 359 struct iavf_channel_config ch_config; 360 u8 num_tc; 361 struct list_head cloud_filter_list; 362 /* lock to protect access to the cloud filter list */ 363 spinlock_t cloud_filter_list_lock; 364 u16 num_cloud_filters; 365 }; 366 367 368 /* Ethtool Private Flags */ 369 370 /* lan device, used by client interface */ 371 struct iavf_device { 372 struct list_head list; 373 struct iavf_adapter *vf; 374 }; 375 376 /* needed by iavf_ethtool.c */ 377 extern char iavf_driver_name[]; 378 extern struct workqueue_struct *iavf_wq; 379 380 int iavf_up(struct iavf_adapter *adapter); 381 void iavf_down(struct iavf_adapter *adapter); 382 int iavf_process_config(struct iavf_adapter *adapter); 383 void iavf_schedule_reset(struct iavf_adapter *adapter); 384 void iavf_reset(struct iavf_adapter *adapter); 385 void iavf_set_ethtool_ops(struct net_device *netdev); 386 void iavf_update_stats(struct iavf_adapter *adapter); 387 void iavf_reset_interrupt_capability(struct iavf_adapter *adapter); 388 int iavf_init_interrupt_scheme(struct iavf_adapter *adapter); 389 void iavf_irq_enable_queues(struct iavf_adapter *adapter, u32 mask); 390 void iavf_free_all_tx_resources(struct iavf_adapter *adapter); 391 void iavf_free_all_rx_resources(struct iavf_adapter *adapter); 392 393 void iavf_napi_add_all(struct iavf_adapter *adapter); 394 void iavf_napi_del_all(struct iavf_adapter *adapter); 395 396 int iavf_send_api_ver(struct iavf_adapter *adapter); 397 int iavf_verify_api_ver(struct iavf_adapter *adapter); 398 int iavf_send_vf_config_msg(struct iavf_adapter *adapter); 399 int iavf_get_vf_config(struct iavf_adapter *adapter); 400 void iavf_irq_enable(struct iavf_adapter *adapter, bool flush); 401 void iavf_configure_queues(struct iavf_adapter *adapter); 402 void iavf_deconfigure_queues(struct iavf_adapter *adapter); 403 void iavf_enable_queues(struct iavf_adapter *adapter); 404 void iavf_disable_queues(struct iavf_adapter *adapter); 405 void iavf_map_queues(struct iavf_adapter *adapter); 406 int iavf_request_queues(struct iavf_adapter *adapter, int num); 407 void iavf_add_ether_addrs(struct iavf_adapter *adapter); 408 void iavf_del_ether_addrs(struct iavf_adapter *adapter); 409 void iavf_add_vlans(struct iavf_adapter *adapter); 410 void iavf_del_vlans(struct iavf_adapter *adapter); 411 void iavf_set_promiscuous(struct iavf_adapter *adapter, int flags); 412 void iavf_request_stats(struct iavf_adapter *adapter); 413 void iavf_request_reset(struct iavf_adapter *adapter); 414 void iavf_get_hena(struct iavf_adapter *adapter); 415 void iavf_set_hena(struct iavf_adapter *adapter); 416 void iavf_set_rss_key(struct iavf_adapter *adapter); 417 void iavf_set_rss_lut(struct iavf_adapter *adapter); 418 void iavf_enable_vlan_stripping(struct iavf_adapter *adapter); 419 void iavf_disable_vlan_stripping(struct iavf_adapter *adapter); 420 void iavf_virtchnl_completion(struct iavf_adapter *adapter, 421 enum virtchnl_ops v_opcode, 422 enum iavf_status v_retval, u8 *msg, u16 msglen); 423 int iavf_config_rss(struct iavf_adapter *adapter); 424 int iavf_lan_add_device(struct iavf_adapter *adapter); 425 int iavf_lan_del_device(struct iavf_adapter *adapter); 426 void iavf_client_subtask(struct iavf_adapter *adapter); 427 void iavf_notify_client_message(struct iavf_vsi *vsi, u8 *msg, u16 len); 428 void iavf_notify_client_l2_params(struct iavf_vsi *vsi); 429 void iavf_notify_client_open(struct iavf_vsi *vsi); 430 void iavf_notify_client_close(struct iavf_vsi *vsi, bool reset); 431 void iavf_enable_channels(struct iavf_adapter *adapter); 432 void iavf_disable_channels(struct iavf_adapter *adapter); 433 void iavf_add_cloud_filter(struct iavf_adapter *adapter); 434 void iavf_del_cloud_filter(struct iavf_adapter *adapter); 435 struct iavf_mac_filter *iavf_add_filter(struct iavf_adapter *adapter, 436 const u8 *macaddr); 437 #endif /* _IAVF_H_ */ 438