intel/idpf/idpf.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
25 #define GETMAXVAL(num_bits)		GENMASK((num_bits) - 1, 0)
31 #define IDPF_NUM_DFLT_MBX_Q		2	/* includes both TX and RX */
33 #define IDPF_DFLT_MBX_ID		-1
34 /* maximum number of times to try before resetting mailbox */
37 	((IDPF_CTLQ_MAX_BUF_LEN - (struct_sz)) / (chunk_sz))
64  * enum idpf_state - State machine to handle bring up
68  * @__IDPF_STATE_LAST: Must be last, used to determine size
78  * enum idpf_flags - Hard reset causes.
98  * enum idpf_cap_field - Offsets into capabilities struct for specific caps
112 	IDPF_BASE_CAPS		= -1,
128  * enum idpf_vport_state - Current vport state
140  * struct idpf_netdev_priv - Struct to store vport back pointer
149  * @stats_lock: Lock to protect stats update
164  * struct idpf_reset_reg - Reset register offsets/masks
174  * struct idpf_vport_max_q - Queue limits
175  * @max_rxq: Maximum number of RX queues supported
176  * @max_txq: Maixmum number of TX queues supported
177  * @max_bufq: In splitq, maximum number of buffer queues supported
178  * @max_complq: In splitq, maximum number of completion queues supported
188  * struct idpf_reg_ops - Device specific register operation function pointers
193  * @trigger_reset: Trigger a reset to occur
205  * struct idpf_dev_ops - Device specific operations
213  * enum idpf_vport_reset_cause - Vport soft reset causes
227  * enum idpf_vport_flags - Vport flags
228  * @IDPF_VPORT_DEL_QUEUES: To send delete queues message
253  * struct idpf_vport - Handle for netdevices and queue resources
254  * @num_txq: Number of allocated TX queues
255  * @num_complq: Number of allocated completion queues
262  * @txqs: Used only in hotpath to get to the right queue very fast
264  * @num_rxq: Number of allocated RX queues
265  * @num_bufq: Number of allocated buffer queues
266  * @rxq_desc_count: RX queue descriptor count. *MUST* have enough descriptors
267  *		    to complete all buffer descriptors for all buffer queues in
269  * @num_bufqs_per_qgrp: Buffer queues per RX queue in a given grouping
271  * @num_rxq_grp: Number of RX queues in a group
272  * @rxq_grps: Total number of RX groups. Number of groups * number of RX per
273  *	      group will yield total number of RX queues.
275  * @rx_ptype_lkup: Lookup table for ptypes on RX
276  * @adapter: back pointer to associated adapter
283  * @default_vport: Use this vport if one isn't specified
284  * @base_rxd: True if the driver should use base descriptors instead of flex
289  * @default_mac_addr: device will give a default MAC to use
290  * @rx_itr_profile: RX profiles for Dynamic Interrupt Moderation
357  * struct idpf_rss_data - Associated RSS data
362  * @cached_lut: Used to restore previously init RSS lut
373  * struct idpf_vport_user_config_data - User defined configuration values for
376  * @num_req_tx_qs: Number of user requested TX queues through ethtool
377  * @num_req_rx_qs: Number of user requested RX queues through ethtool
380  * @num_req_rxq_desc: Number of user requested RX queue descriptors through
385  * Used to restore configuration after a reset as the vport will get wiped.
398  * enum idpf_vport_config_flags - Vport config flags
411  * @avail_rxq: Available RX queues
412  * @avail_txq: Available TX queues
413  * @avail_bufq: Available buffer queues
414  * @avail_complq: Available completion queues
416  * Maintain total queues available after allocating max queues to each vport.
426  * struct idpf_vector_info - Utility structure to pass function arguments as a
428  * @num_req_vecs: Vectors required based on the number of queues updated by the
442  * struct idpf_vector_lifo - Stack to maintain vector indexes used for vector
444  * @top: Points to stack top i.e. next available vector index
445  * @base: Always points to start of the free pool
447  * @vec_idx: Array to store all the vector indexes
452  * gives priority to default vports in a way that at least IDPF_MIN_Q_VEC
455  * vector indexes which can be allocated on-demand basis. Mailbox vector index
466  * struct idpf_vport_config - Vport configuration data
468  * @max_q: Maximum possible queues
469  * @req_qs_chunks: Queue chunk data for requested queues
470  * @mac_filter_list_lock: Lock to protect mac filters
484  * struct idpf_adapter - Device data struct generated on probe
500  * @vector_stack: Stack to store the msix vector indexes
504  * @vports: Array to store vports created by the driver
512  * @next_vport: Next free slot in pf->vport[] - 0-based!
517  * @mbx_task: Task to handle mailbox interrupts
519  * @vc_event_task: Task to handle out of band virtchnl event notifications
527  *	     to VFs but is used to initialize them
529  * @req_tx_splitq: TX split or single queue model to request
530  * @req_rx_splitq: RX split or single queue model to request
531  * @vport_ctrl_lock: Lock to protect the vport control flow
532  * @vector_lock: Lock to protect vector distribution
533  * @queue_lock: Lock to protect queue distribution
534  * @vc_buf_lock: Lock to protect virtchnl buffer
595  * idpf_is_queue_model_split - check if queue model is split
658  * idpf_get_reserved_vecs - Get reserved vectors
663 	return le16_to_cpu(adapter->caps.num_allocated_vectors);  in idpf_get_reserved_vecs()
667  * idpf_get_default_vports - Get default number of vports
672 	return le16_to_cpu(adapter->caps.default_num_vports);  in idpf_get_default_vports()
676  * idpf_get_max_vports - Get max number of vports
681 	return le16_to_cpu(adapter->caps.max_vports);  in idpf_get_max_vports()
685  * idpf_get_max_tx_bufs - Get max scatter-gather buffers supported by the device
690 	return adapter->caps.max_sg_bufs_per_tx_pkt;  in idpf_get_max_tx_bufs()
694  * idpf_get_min_tx_pkt_len - Get min packet length supported by the device
699 	u8 pkt_len = adapter->caps.min_sso_packet_len;  in idpf_get_min_tx_pkt_len()
705  * idpf_get_reg_addr - Get BAR0 register address
714 	return (void __iomem *)(adapter->hw.hw_addr + reg_offset);  in idpf_get_reg_addr()
718  * idpf_is_reset_detected - check if we were reset at some point
725 	if (!adapter->hw.arq)  in idpf_is_reset_detected()
728 	return !(readl(idpf_get_reg_addr(adapter, adapter->hw.arq->reg.len)) &  in idpf_is_reset_detected()
729 		 adapter->hw.arq->reg.len_mask);  in idpf_is_reset_detected()
733  * idpf_is_reset_in_prog - check if reset is in progress
740 	return (test_bit(IDPF_HR_RESET_IN_PROG, adapter->flags) ||  in idpf_is_reset_in_prog()
741 		test_bit(IDPF_HR_FUNC_RESET, adapter->flags) ||  in idpf_is_reset_in_prog()
742 		test_bit(IDPF_HR_DRV_LOAD, adapter->flags));  in idpf_is_reset_in_prog()
746  * idpf_netdev_to_vport - get a vport handle from a netdev
753 	return np->vport;  in idpf_netdev_to_vport()
757  * idpf_netdev_to_adapter - Get adapter handle from a netdev
764 	return np->adapter;  in idpf_netdev_to_adapter()
768  * idpf_is_feature_ena - Determine if a particular feature is enabled
769  * @vport: Vport to check
770  * @feature: Netdev flag to check
777 	return vport->netdev->features & feature;  in idpf_is_feature_ena()
781  * idpf_get_max_tx_hdr_size -- get the size of tx header
786 	return le16_to_cpu(adapter->caps.max_tx_hdr_size);  in idpf_get_max_tx_hdr_size()
790  * idpf_vport_ctrl_lock - Acquire the vport control lock
793  * This lock should be used by non-datapath code to protect against vport
800 	mutex_lock(&np->adapter->vport_ctrl_lock);  in idpf_vport_ctrl_lock()
804  * idpf_vport_ctrl_unlock - Release the vport control lock
811 	mutex_unlock(&np->adapter->vport_ctrl_lock);  in idpf_vport_ctrl_unlock()