/* SPDX-License-Identifier: GPL-2.0-only */ /* Copyright (C) 2023 Intel Corporation */ #ifndef _IDPF_H_ #define _IDPF_H_ /* Forward declaration */ struct idpf_adapter; struct idpf_vport; struct idpf_vport_max_q; #include <net/pkt_sched.h> #include <linux/aer.h> #include <linux/etherdevice.h> #include <linux/pci.h> #include <linux/bitfield.h> #include <linux/sctp.h> #include <linux/ethtool_netlink.h> #include <net/gro.h> #include "virtchnl2.h" #include "idpf_txrx.h" #include "idpf_controlq.h" #define GETMAXVAL(num_bits) … #define IDPF_NO_FREE_SLOT … /* Default Mailbox settings */ #define IDPF_NUM_FILTERS_PER_MSG … #define IDPF_NUM_DFLT_MBX_Q … #define IDPF_DFLT_MBX_Q_LEN … #define IDPF_DFLT_MBX_ID … /* maximum number of times to try before resetting mailbox */ #define IDPF_MB_MAX_ERR … #define IDPF_NUM_CHUNKS_PER_MSG(struct_sz, chunk_sz) … #define IDPF_MAX_WAIT … /* available message levels */ #define IDPF_AVAIL_NETIF_M … #define IDPF_DIM_PROFILE_SLOTS … #define IDPF_VIRTCHNL_VERSION_MAJOR … #define IDPF_VIRTCHNL_VERSION_MINOR … /** * struct idpf_mac_filter * @list: list member field * @macaddr: MAC address * @remove: filter should be removed (virtchnl) * @add: filter should be added (virtchnl) */ struct idpf_mac_filter { … }; /** * enum idpf_state - State machine to handle bring up * @__IDPF_VER_CHECK: Negotiate virtchnl version * @__IDPF_GET_CAPS: Negotiate capabilities * @__IDPF_INIT_SW: Init based on given capabilities * @__IDPF_STATE_LAST: Must be last, used to determine size */ enum idpf_state { … }; /** * enum idpf_flags - Hard reset causes. * @IDPF_HR_FUNC_RESET: Hard reset when TxRx timeout * @IDPF_HR_DRV_LOAD: Set on driver load for a clean HW * @IDPF_HR_RESET_IN_PROG: Reset in progress * @IDPF_REMOVE_IN_PROG: Driver remove in progress * @IDPF_MB_INTR_MODE: Mailbox in interrupt mode * @IDPF_VC_CORE_INIT: virtchnl core has been init * @IDPF_FLAGS_NBITS: Must be last */ enum idpf_flags { … }; /** * enum idpf_cap_field - Offsets into capabilities struct for specific caps * @IDPF_BASE_CAPS: generic base capabilities * @IDPF_CSUM_CAPS: checksum offload capabilities * @IDPF_SEG_CAPS: segmentation offload capabilities * @IDPF_RSS_CAPS: RSS offload capabilities * @IDPF_HSPLIT_CAPS: Header split capabilities * @IDPF_RSC_CAPS: RSC offload capabilities * @IDPF_OTHER_CAPS: miscellaneous offloads * * Used when checking for a specific capability flag since different capability * sets are not mutually exclusive numerically, the caller must specify which * type of capability they are checking for. */ enum idpf_cap_field { … }; /** * enum idpf_vport_state - Current vport state * @__IDPF_VPORT_DOWN: Vport is down * @__IDPF_VPORT_UP: Vport is up * @__IDPF_VPORT_STATE_LAST: Must be last, number of states */ enum idpf_vport_state { … }; /** * struct idpf_netdev_priv - Struct to store vport back pointer * @adapter: Adapter back pointer * @vport: Vport back pointer * @vport_id: Vport identifier * @vport_idx: Relative vport index * @state: See enum idpf_vport_state * @netstats: Packet and byte stats * @stats_lock: Lock to protect stats update */ struct idpf_netdev_priv { … }; /** * struct idpf_reset_reg - Reset register offsets/masks * @rstat: Reset status register * @rstat_m: Reset status mask */ struct idpf_reset_reg { … }; /** * struct idpf_vport_max_q - Queue limits * @max_rxq: Maximum number of RX queues supported * @max_txq: Maixmum number of TX queues supported * @max_bufq: In splitq, maximum number of buffer queues supported * @max_complq: In splitq, maximum number of completion queues supported */ struct idpf_vport_max_q { … }; /** * struct idpf_reg_ops - Device specific register operation function pointers * @ctlq_reg_init: Mailbox control queue register initialization * @intr_reg_init: Traffic interrupt register initialization * @mb_intr_reg_init: Mailbox interrupt register initialization * @reset_reg_init: Reset register initialization * @trigger_reset: Trigger a reset to occur */ struct idpf_reg_ops { … }; /** * struct idpf_dev_ops - Device specific operations * @reg_ops: Register operations */ struct idpf_dev_ops { … }; /** * enum idpf_vport_reset_cause - Vport soft reset causes * @IDPF_SR_Q_CHANGE: Soft reset queue change * @IDPF_SR_Q_DESC_CHANGE: Soft reset descriptor change * @IDPF_SR_MTU_CHANGE: Soft reset MTU change * @IDPF_SR_RSC_CHANGE: Soft reset RSC change */ enum idpf_vport_reset_cause { … }; /** * enum idpf_vport_flags - Vport flags * @IDPF_VPORT_DEL_QUEUES: To send delete queues message * @IDPF_VPORT_SW_MARKER: Indicate TX pipe drain software marker packets * processing is done * @IDPF_VPORT_FLAGS_NBITS: Must be last */ enum idpf_vport_flags { … }; struct idpf_port_stats { … }; /** * struct idpf_vport - Handle for netdevices and queue resources * @num_txq: Number of allocated TX queues * @num_complq: Number of allocated completion queues * @txq_desc_count: TX queue descriptor count * @complq_desc_count: Completion queue descriptor count * @compln_clean_budget: Work budget for completion clean * @num_txq_grp: Number of TX queue groups * @txq_grps: Array of TX queue groups * @txq_model: Split queue or single queue queuing model * @txqs: Used only in hotpath to get to the right queue very fast * @crc_enable: Enable CRC insertion offload * @num_rxq: Number of allocated RX queues * @num_bufq: Number of allocated buffer queues * @rxq_desc_count: RX queue descriptor count. *MUST* have enough descriptors * to complete all buffer descriptors for all buffer queues in * the worst case. * @num_bufqs_per_qgrp: Buffer queues per RX queue in a given grouping * @bufq_desc_count: Buffer queue descriptor count * @num_rxq_grp: Number of RX queues in a group * @rxq_grps: Total number of RX groups. Number of groups * number of RX per * group will yield total number of RX queues. * @rxq_model: Splitq queue or single queue queuing model * @rx_ptype_lkup: Lookup table for ptypes on RX * @adapter: back pointer to associated adapter * @netdev: Associated net_device. Each vport should have one and only one * associated netdev. * @flags: See enum idpf_vport_flags * @vport_type: Default SRIOV, SIOV, etc. * @vport_id: Device given vport identifier * @idx: Software index in adapter vports struct * @default_vport: Use this vport if one isn't specified * @base_rxd: True if the driver should use base descriptors instead of flex * @num_q_vectors: Number of IRQ vectors allocated * @q_vectors: Array of queue vectors * @q_vector_idxs: Starting index of queue vectors * @max_mtu: device given max possible MTU * @default_mac_addr: device will give a default MAC to use * @rx_itr_profile: RX profiles for Dynamic Interrupt Moderation * @tx_itr_profile: TX profiles for Dynamic Interrupt Moderation * @port_stats: per port csum, header split, and other offload stats * @link_up: True if link is up * @link_speed_mbps: Link speed in mbps * @sw_marker_wq: workqueue for marker packets */ struct idpf_vport { … }; /** * enum idpf_user_flags * @__IDPF_USER_FLAG_HSPLIT: header split state * @__IDPF_PROMISC_UC: Unicast promiscuous mode * @__IDPF_PROMISC_MC: Multicast promiscuous mode * @__IDPF_USER_FLAGS_NBITS: Must be last */ enum idpf_user_flags { … }; /** * struct idpf_rss_data - Associated RSS data * @rss_key_size: Size of RSS hash key * @rss_key: RSS hash key * @rss_lut_size: Size of RSS lookup table * @rss_lut: RSS lookup table * @cached_lut: Used to restore previously init RSS lut */ struct idpf_rss_data { … }; /** * struct idpf_vport_user_config_data - User defined configuration values for * each vport. * @rss_data: See struct idpf_rss_data * @num_req_tx_qs: Number of user requested TX queues through ethtool * @num_req_rx_qs: Number of user requested RX queues through ethtool * @num_req_txq_desc: Number of user requested TX queue descriptors through * ethtool * @num_req_rxq_desc: Number of user requested RX queue descriptors through * ethtool * @user_flags: User toggled config flags * @mac_filter_list: List of MAC filters * * Used to restore configuration after a reset as the vport will get wiped. */ struct idpf_vport_user_config_data { … }; /** * enum idpf_vport_config_flags - Vport config flags * @IDPF_VPORT_REG_NETDEV: Register netdev * @IDPF_VPORT_UP_REQUESTED: Set if interface up is requested on core reset * @IDPF_VPORT_CONFIG_FLAGS_NBITS: Must be last */ enum idpf_vport_config_flags { … }; /** * struct idpf_avail_queue_info * @avail_rxq: Available RX queues * @avail_txq: Available TX queues * @avail_bufq: Available buffer queues * @avail_complq: Available completion queues * * Maintain total queues available after allocating max queues to each vport. */ struct idpf_avail_queue_info { … }; /** * struct idpf_vector_info - Utility structure to pass function arguments as a * structure * @num_req_vecs: Vectors required based on the number of queues updated by the * user via ethtool * @num_curr_vecs: Current number of vectors, must be >= @num_req_vecs * @index: Relative starting index for vectors * @default_vport: Vectors are for default vport */ struct idpf_vector_info { … }; /** * struct idpf_vector_lifo - Stack to maintain vector indexes used for vector * distribution algorithm * @top: Points to stack top i.e. next available vector index * @base: Always points to start of the free pool * @size: Total size of the vector stack * @vec_idx: Array to store all the vector indexes * * Vector stack maintains all the relative vector indexes at the *adapter* * level. This stack is divided into 2 parts, first one is called as 'default * pool' and other one is called 'free pool'. Vector distribution algorithm * gives priority to default vports in a way that at least IDPF_MIN_Q_VEC * vectors are allocated per default vport and the relative vector indexes for * those are maintained in default pool. Free pool contains all the unallocated * vector indexes which can be allocated on-demand basis. Mailbox vector index * is maintained in the default pool of the stack. */ struct idpf_vector_lifo { … }; /** * struct idpf_vport_config - Vport configuration data * @user_config: see struct idpf_vport_user_config_data * @max_q: Maximum possible queues * @req_qs_chunks: Queue chunk data for requested queues * @mac_filter_list_lock: Lock to protect mac filters * @flags: See enum idpf_vport_config_flags */ struct idpf_vport_config { … }; struct idpf_vc_xn_manager; /** * struct idpf_adapter - Device data struct generated on probe * @pdev: PCI device struct given on probe * @virt_ver_maj: Virtchnl version major * @virt_ver_min: Virtchnl version minor * @msg_enable: Debug message level enabled * @mb_wait_count: Number of times mailbox was attempted initialization * @state: Init state machine * @flags: See enum idpf_flags * @reset_reg: See struct idpf_reset_reg * @hw: Device access data * @num_req_msix: Requested number of MSIX vectors * @num_avail_msix: Available number of MSIX vectors * @num_msix_entries: Number of entries in MSIX table * @msix_entries: MSIX table * @req_vec_chunks: Requested vector chunk data * @mb_vector: Mailbox vector data * @vector_stack: Stack to store the msix vector indexes * @irq_mb_handler: Handler for hard interrupt for mailbox * @tx_timeout_count: Number of TX timeouts that have occurred * @avail_queues: Device given queue limits * @vports: Array to store vports created by the driver * @netdevs: Associated Vport netdevs * @vport_params_reqd: Vport params requested * @vport_params_recvd: Vport params received * @vport_ids: Array of device given vport identifiers * @vport_config: Vport config parameters * @max_vports: Maximum vports that can be allocated * @num_alloc_vports: Current number of vports allocated * @next_vport: Next free slot in pf->vport[] - 0-based! * @init_task: Initialization task * @init_wq: Workqueue for initialization task * @serv_task: Periodically recurring maintenance task * @serv_wq: Workqueue for service task * @mbx_task: Task to handle mailbox interrupts * @mbx_wq: Workqueue for mailbox responses * @vc_event_task: Task to handle out of band virtchnl event notifications * @vc_event_wq: Workqueue for virtchnl events * @stats_task: Periodic statistics retrieval task * @stats_wq: Workqueue for statistics task * @caps: Negotiated capabilities with device * @vcxn_mngr: Virtchnl transaction manager * @dev_ops: See idpf_dev_ops * @num_vfs: Number of allocated VFs through sysfs. PF does not directly talk * to VFs but is used to initialize them * @crc_enable: Enable CRC insertion offload * @req_tx_splitq: TX split or single queue model to request * @req_rx_splitq: RX split or single queue model to request * @vport_ctrl_lock: Lock to protect the vport control flow * @vector_lock: Lock to protect vector distribution * @queue_lock: Lock to protect queue distribution * @vc_buf_lock: Lock to protect virtchnl buffer */ struct idpf_adapter { … }; /** * idpf_is_queue_model_split - check if queue model is split * @q_model: queue model single or split * * Returns true if queue model is split else false */ static inline int idpf_is_queue_model_split(u16 q_model) { … } #define idpf_is_cap_ena(adapter, field, flag) … #define idpf_is_cap_ena_all(adapter, field, flag) … bool idpf_is_capability_ena(struct idpf_adapter *adapter, bool all, enum idpf_cap_field field, u64 flag); #define IDPF_CAP_RSS … #define IDPF_CAP_RSC … #define IDPF_CAP_HSPLIT … #define IDPF_CAP_RX_CSUM_L4V4 … #define IDPF_CAP_RX_CSUM_L4V6 … #define IDPF_CAP_RX_CSUM … #define IDPF_CAP_SCTP_CSUM … #define IDPF_CAP_TUNNEL_TX_CSUM … /** * idpf_get_reserved_vecs - Get reserved vectors * @adapter: private data struct */ static inline u16 idpf_get_reserved_vecs(struct idpf_adapter *adapter) { … } /** * idpf_get_default_vports - Get default number of vports * @adapter: private data struct */ static inline u16 idpf_get_default_vports(struct idpf_adapter *adapter) { … } /** * idpf_get_max_vports - Get max number of vports * @adapter: private data struct */ static inline u16 idpf_get_max_vports(struct idpf_adapter *adapter) { … } /** * idpf_get_max_tx_bufs - Get max scatter-gather buffers supported by the device * @adapter: private data struct */ static inline unsigned int idpf_get_max_tx_bufs(struct idpf_adapter *adapter) { … } /** * idpf_get_min_tx_pkt_len - Get min packet length supported by the device * @adapter: private data struct */ static inline u8 idpf_get_min_tx_pkt_len(struct idpf_adapter *adapter) { … } /** * idpf_get_reg_addr - Get BAR0 register address * @adapter: private data struct * @reg_offset: register offset value * * Based on the register offset, return the actual BAR0 register address */ static inline void __iomem *idpf_get_reg_addr(struct idpf_adapter *adapter, resource_size_t reg_offset) { … } /** * idpf_is_reset_detected - check if we were reset at some point * @adapter: driver specific private structure * * Returns true if we are either in reset currently or were previously reset. */ static inline bool idpf_is_reset_detected(struct idpf_adapter *adapter) { … } /** * idpf_is_reset_in_prog - check if reset is in progress * @adapter: driver specific private structure * * Returns true if hard reset is in progress, false otherwise */ static inline bool idpf_is_reset_in_prog(struct idpf_adapter *adapter) { … } /** * idpf_netdev_to_vport - get a vport handle from a netdev * @netdev: network interface device structure */ static inline struct idpf_vport *idpf_netdev_to_vport(struct net_device *netdev) { … } /** * idpf_netdev_to_adapter - Get adapter handle from a netdev * @netdev: Network interface device structure */ static inline struct idpf_adapter *idpf_netdev_to_adapter(struct net_device *netdev) { … } /** * idpf_is_feature_ena - Determine if a particular feature is enabled * @vport: Vport to check * @feature: Netdev flag to check * * Returns true or false if a particular feature is enabled. */ static inline bool idpf_is_feature_ena(const struct idpf_vport *vport, netdev_features_t feature) { … } /** * idpf_get_max_tx_hdr_size -- get the size of tx header * @adapter: Driver specific private structure */ static inline u16 idpf_get_max_tx_hdr_size(struct idpf_adapter *adapter) { … } /** * idpf_vport_ctrl_lock - Acquire the vport control lock * @netdev: Network interface device structure * * This lock should be used by non-datapath code to protect against vport * destruction. */ static inline void idpf_vport_ctrl_lock(struct net_device *netdev) { … } /** * idpf_vport_ctrl_unlock - Release the vport control lock * @netdev: Network interface device structure */ static inline void idpf_vport_ctrl_unlock(struct net_device *netdev) { … } void idpf_statistics_task(struct work_struct *work); void idpf_init_task(struct work_struct *work); void idpf_service_task(struct work_struct *work); void idpf_mbx_task(struct work_struct *work); void idpf_vc_event_task(struct work_struct *work); void idpf_dev_ops_init(struct idpf_adapter *adapter); void idpf_vf_dev_ops_init(struct idpf_adapter *adapter); int idpf_intr_req(struct idpf_adapter *adapter); void idpf_intr_rel(struct idpf_adapter *adapter); u16 idpf_get_max_tx_hdr_size(struct idpf_adapter *adapter); int idpf_initiate_soft_reset(struct idpf_vport *vport, enum idpf_vport_reset_cause reset_cause); void idpf_deinit_task(struct idpf_adapter *adapter); int idpf_req_rel_vector_indexes(struct idpf_adapter *adapter, u16 *q_vector_idxs, struct idpf_vector_info *vec_info); void idpf_set_ethtool_ops(struct net_device *netdev); void idpf_vport_intr_write_itr(struct idpf_q_vector *q_vector, u16 itr, bool tx); int idpf_sriov_configure(struct pci_dev *pdev, int num_vfs); u8 idpf_vport_get_hsplit(const struct idpf_vport *vport); bool idpf_vport_set_hsplit(const struct idpf_vport *vport, u8 val); #endif /* !_IDPF_H_ */
Codebase Browser
linux