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