/* SPDX-License-Identifier: GPL-2.0-only */ /* Copyright (c) 2013-2022, Intel Corporation. */ #ifndef _VIRTCHNL_H_ #define _VIRTCHNL_H_ #include <linux/bitops.h> #include <linux/bits.h> #include <linux/overflow.h> #include <uapi/linux/if_ether.h> /* Description: * This header file describes the Virtual Function (VF) - Physical Function * (PF) communication protocol used by the drivers for all devices starting * from our 40G product line * * Admin queue buffer usage: * desc->opcode is always aqc_opc_send_msg_to_pf * flags, retval, datalen, and data addr are all used normally. * The Firmware copies the cookie fields when sending messages between the * PF and VF, but uses all other fields internally. Due to this limitation, * we must send all messages as "indirect", i.e. using an external buffer. * * All the VSI indexes are relative to the VF. Each VF can have maximum of * three VSIs. All the queue indexes are relative to the VSI. Each VF can * have a maximum of sixteen queues for all of its VSIs. * * The PF is required to return a status code in v_retval for all messages * except RESET_VF, which does not require any response. The returned value * is of virtchnl_status_code type, defined here. * * In general, VF driver initialization should roughly follow the order of * these opcodes. The VF driver must first validate the API version of the * PF driver, then request a reset, then get resources, then configure * queues and interrupts. After these operations are complete, the VF * driver may start its queues, optionally add MAC and VLAN filters, and * process traffic. */ /* START GENERIC DEFINES * Need to ensure the following enums and defines hold the same meaning and * value in current and future projects */ /* Error Codes */ enum virtchnl_status_code { … }; /* Backward compatibility */ #define VIRTCHNL_ERR_PARAM … #define VIRTCHNL_STATUS_NOT_SUPPORTED … #define VIRTCHNL_LINK_SPEED_2_5GB_SHIFT … #define VIRTCHNL_LINK_SPEED_100MB_SHIFT … #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT … #define VIRTCHNL_LINK_SPEED_10GB_SHIFT … #define VIRTCHNL_LINK_SPEED_40GB_SHIFT … #define VIRTCHNL_LINK_SPEED_20GB_SHIFT … #define VIRTCHNL_LINK_SPEED_25GB_SHIFT … #define VIRTCHNL_LINK_SPEED_5GB_SHIFT … enum virtchnl_link_speed { … }; /* for hsplit_0 field of Rx HMC context */ /* deprecated with AVF 1.0 */ enum virtchnl_rx_hsplit { … }; /* END GENERIC DEFINES */ /* Opcodes for VF-PF communication. These are placed in the v_opcode field * of the virtchnl_msg structure. */ enum virtchnl_ops { … }; /* These macros are used to generate compilation errors if a structure/union * is not exactly the correct length. It gives a divide by zero error if the * structure/union is not of the correct size, otherwise it creates an enum * that is never used. */ #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) … #define VIRTCHNL_CHECK_UNION_LEN(n, X) … /* Message descriptions and data structures. */ /* VIRTCHNL_OP_VERSION * VF posts its version number to the PF. PF responds with its version number * in the same format, along with a return code. * Reply from PF has its major/minor versions also in param0 and param1. * If there is a major version mismatch, then the VF cannot operate. * If there is a minor version mismatch, then the VF can operate but should * add a warning to the system log. * * This enum element MUST always be specified as == 1, regardless of other * changes in the API. The PF must always respond to this message without * error regardless of version mismatch. */ #define VIRTCHNL_VERSION_MAJOR … #define VIRTCHNL_VERSION_MINOR … #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS … struct virtchnl_version_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define VF_IS_V10(_v) … #define VF_IS_V11(_ver) … /* VIRTCHNL_OP_RESET_VF * VF sends this request to PF with no parameters * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register * until reset completion is indicated. The admin queue must be reinitialized * after this operation. * * When reset is complete, PF must ensure that all queues in all VSIs associated * with the VF are stopped, all queue configurations in the HMC are set to 0, * and all MAC and VLAN filters (except the default MAC address) on all VSIs * are cleared. */ /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV * vsi_type should always be 6 for backward compatibility. Add other fields * as needed. */ enum virtchnl_vsi_type { … }; /* VIRTCHNL_OP_GET_VF_RESOURCES * Version 1.0 VF sends this request to PF with no parameters * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities * PF responds with an indirect message containing * virtchnl_vf_resource and one or more * virtchnl_vsi_resource structures. */ struct virtchnl_vsi_resource { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VF capability flags * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including * TX/RX Checksum offloading and TSO for non-tunnelled packets. */ #define VIRTCHNL_VF_OFFLOAD_L2 … #define VIRTCHNL_VF_OFFLOAD_RDMA … #define VIRTCHNL_VF_CAP_RDMA … #define VIRTCHNL_VF_OFFLOAD_RSS_AQ … #define VIRTCHNL_VF_OFFLOAD_RSS_REG … #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR … #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES … /* used to negotiate communicating link speeds in Mbps */ #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED … #define VIRTCHNL_VF_OFFLOAD_CRC … #define VIRTCHNL_VF_OFFLOAD_VLAN_V2 … #define VIRTCHNL_VF_OFFLOAD_VLAN … #define VIRTCHNL_VF_OFFLOAD_RX_POLLING … #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 … #define VIRTCHNL_VF_OFFLOAD_RSS_PF … #define VIRTCHNL_VF_OFFLOAD_ENCAP … #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM … #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM … #define VIRTCHNL_VF_OFFLOAD_ADQ … #define VIRTCHNL_VF_OFFLOAD_USO … #define VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC … #define VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF … #define VIRTCHNL_VF_OFFLOAD_FDIR_PF … #define VF_BASE_MODE_OFFLOADS … struct virtchnl_vf_resource { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_vf_resource_LEGACY_SIZEOF … /* VIRTCHNL_OP_CONFIG_TX_QUEUE * VF sends this message to set up parameters for one TX queue. * External data buffer contains one instance of virtchnl_txq_info. * PF configures requested queue and returns a status code. */ /* Tx queue config info */ struct virtchnl_txq_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_CONFIG_RX_QUEUE * VF sends this message to set up parameters for one RX queue. * External data buffer contains one instance of virtchnl_rxq_info. * PF configures requested queue and returns a status code. The * crc_disable flag disables CRC stripping on the VF. Setting * the crc_disable flag to 1 will disable CRC stripping for each * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC * offload must have been set prior to sending this info or the PF * will ignore the request. This flag should be set the same for * all of the queues for a VF. */ /* Rx queue config info */ struct virtchnl_rxq_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_CONFIG_VSI_QUEUES * VF sends this message to set parameters for all active TX and RX queues * associated with the specified VSI. * PF configures queues and returns status. * If the number of queues specified is greater than the number of queues * associated with the VSI, an error is returned and no queues are configured. * NOTE: The VF is not required to configure all queues in a single request. * It may send multiple messages. PF drivers must correctly handle all VF * requests. */ struct virtchnl_queue_pair_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_vsi_queue_config_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_vsi_queue_config_info_LEGACY_SIZEOF … /* VIRTCHNL_OP_REQUEST_QUEUES * VF sends this message to request the PF to allocate additional queues to * this VF. Each VF gets a guaranteed number of queues on init but asking for * additional queues must be negotiated. This is a best effort request as it * is possible the PF does not have enough queues left to support the request. * If the PF cannot support the number requested it will respond with the * maximum number it is able to support. If the request is successful, PF will * then reset the VF to institute required changes. */ /* VF resource request */ struct virtchnl_vf_res_request { … }; /* VIRTCHNL_OP_CONFIG_IRQ_MAP * VF uses this message to map vectors to queues. * The rxq_map and txq_map fields are bitmaps used to indicate which queues * are to be associated with the specified vector. * The "other" causes are always mapped to vector 0. The VF may not request * that vector 0 be used for traffic. * PF configures interrupt mapping and returns status. * NOTE: due to hardware requirements, all active queues (both TX and RX) * should be mapped to interrupts, even if the driver intends to operate * only in polling mode. In this case the interrupt may be disabled, but * the ITR timer will still run to trigger writebacks. */ struct virtchnl_vector_map { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_irq_map_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_irq_map_info_LEGACY_SIZEOF … /* VIRTCHNL_OP_ENABLE_QUEUES * VIRTCHNL_OP_DISABLE_QUEUES * VF sends these message to enable or disable TX/RX queue pairs. * The queues fields are bitmaps indicating which queues to act upon. * (Currently, we only support 16 queues per VF, but we make the field * u32 to allow for expansion.) * PF performs requested action and returns status. * NOTE: The VF is not required to enable/disable all queues in a single * request. It may send multiple messages. * PF drivers must correctly handle all VF requests. */ struct virtchnl_queue_select { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_ADD_ETH_ADDR * VF sends this message in order to add one or more unicast or multicast * address filters for the specified VSI. * PF adds the filters and returns status. */ /* VIRTCHNL_OP_DEL_ETH_ADDR * VF sends this message in order to remove one or more unicast or multicast * filters for the specified VSI. * PF removes the filters and returns status. */ /* VIRTCHNL_ETHER_ADDR_LEGACY * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad * bytes. Moving forward all VF drivers should not set type to * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy * behavior. The control plane function (i.e. PF) can use a best effort method * of tracking the primary/device unicast in this case, but there is no * guarantee and functionality depends on the implementation of the PF. */ /* VIRTCHNL_ETHER_ADDR_PRIMARY * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane * function (i.e. PF) to accurately track and use this MAC address for * displaying on the host and for VM/function reset. */ /* VIRTCHNL_ETHER_ADDR_EXTRA * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra * unicast and/or multicast filters that are being added/deleted via * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively. */ struct virtchnl_ether_addr { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_ether_addr_list { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_ether_addr_list_LEGACY_SIZEOF … /* VIRTCHNL_OP_ADD_VLAN * VF sends this message to add one or more VLAN tag filters for receives. * PF adds the filters and returns status. * If a port VLAN is configured by the PF, this operation will return an * error to the VF. */ /* VIRTCHNL_OP_DEL_VLAN * VF sends this message to remove one or more VLAN tag filters for receives. * PF removes the filters and returns status. * If a port VLAN is configured by the PF, this operation will return an * error to the VF. */ struct virtchnl_vlan_filter_list { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_vlan_filter_list_LEGACY_SIZEOF … /* This enum is used for all of the VIRTCHNL_VF_OFFLOAD_VLAN_V2_CAPS related * structures and opcodes. * * VIRTCHNL_VLAN_UNSUPPORTED - This field is not supported and if a VF driver * populates it the PF should return VIRTCHNL_STATUS_ERR_NOT_SUPPORTED. * * VIRTCHNL_VLAN_ETHERTYPE_8100 - This field supports 0x8100 ethertype. * VIRTCHNL_VLAN_ETHERTYPE_88A8 - This field supports 0x88A8 ethertype. * VIRTCHNL_VLAN_ETHERTYPE_9100 - This field supports 0x9100 ethertype. * * VIRTCHNL_VLAN_ETHERTYPE_AND - Used when multiple ethertypes can be supported * by the PF concurrently. For example, if the PF can support * VIRTCHNL_VLAN_ETHERTYPE_8100 AND VIRTCHNL_VLAN_ETHERTYPE_88A8 filters it * would OR the following bits: * * VIRTHCNL_VLAN_ETHERTYPE_8100 | * VIRTCHNL_VLAN_ETHERTYPE_88A8 | * VIRTCHNL_VLAN_ETHERTYPE_AND; * * The VF would interpret this as VLAN filtering can be supported on both 0x8100 * and 0x88A8 VLAN ethertypes. * * VIRTCHNL_ETHERTYPE_XOR - Used when only a single ethertype can be supported * by the PF concurrently. For example if the PF can support * VIRTCHNL_VLAN_ETHERTYPE_8100 XOR VIRTCHNL_VLAN_ETHERTYPE_88A8 stripping * offload it would OR the following bits: * * VIRTCHNL_VLAN_ETHERTYPE_8100 | * VIRTCHNL_VLAN_ETHERTYPE_88A8 | * VIRTCHNL_VLAN_ETHERTYPE_XOR; * * The VF would interpret this as VLAN stripping can be supported on either * 0x8100 or 0x88a8 VLAN ethertypes. So when requesting VLAN stripping via * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 the specified ethertype will override * the previously set value. * * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 - Used to tell the VF to insert and/or * strip the VLAN tag using the L2TAG1 field of the Tx/Rx descriptors. * * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to insert hardware * offloaded VLAN tags using the L2TAG2 field of the Tx descriptor. * * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to strip hardware * offloaded VLAN tags using the L2TAG2_2 field of the Rx descriptor. * * VIRTCHNL_VLAN_PRIO - This field supports VLAN priority bits. This is used for * VLAN filtering if the underlying PF supports it. * * VIRTCHNL_VLAN_TOGGLE_ALLOWED - This field is used to say whether a * certain VLAN capability can be toggled. For example if the underlying PF/CP * allows the VF to toggle VLAN filtering, stripping, and/or insertion it should * set this bit along with the supported ethertypes. */ enum virtchnl_vlan_support { … }; /* This structure is used as part of the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS * for filtering, insertion, and stripping capabilities. * * If only outer capabilities are supported (for filtering, insertion, and/or * stripping) then this refers to the outer most or single VLAN from the VF's * perspective. * * If only inner capabilities are supported (for filtering, insertion, and/or * stripping) then this refers to the outer most or single VLAN from the VF's * perspective. Functionally this is the same as if only outer capabilities are * supported. The VF driver is just forced to use the inner fields when * adding/deleting filters and enabling/disabling offloads (if supported). * * If both outer and inner capabilities are supported (for filtering, insertion, * and/or stripping) then outer refers to the outer most or single VLAN and * inner refers to the second VLAN, if it exists, in the packet. * * There is no support for tunneled VLAN offloads, so outer or inner are never * referring to a tunneled packet from the VF's perspective. */ struct virtchnl_vlan_supported_caps { … }; /* The PF populates these fields based on the supported VLAN filtering. If a * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will * reject any VIRTCHNL_OP_ADD_VLAN_V2 or VIRTCHNL_OP_DEL_VLAN_V2 messages using * the unsupported fields. * * Also, a VF is only allowed to toggle its VLAN filtering setting if the * VIRTCHNL_VLAN_TOGGLE bit is set. * * The ethertype(s) specified in the ethertype_init field are the ethertypes * enabled for VLAN filtering. VLAN filtering in this case refers to the outer * most VLAN from the VF's perspective. If both inner and outer filtering are * allowed then ethertype_init only refers to the outer most VLAN as only * VLAN ethertype supported for inner VLAN filtering is * VIRTCHNL_VLAN_ETHERTYPE_8100. By default, inner VLAN filtering is disabled * when both inner and outer filtering are allowed. * * The max_filters field tells the VF how many VLAN filters it's allowed to have * at any one time. If it exceeds this amount and tries to add another filter, * then the request will be rejected by the PF. To prevent failures, the VF * should keep track of how many VLAN filters it has added and not attempt to * add more than max_filters. */ struct virtchnl_vlan_filtering_caps { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* This enum is used for the virtchnl_vlan_offload_caps structure to specify * if the PF supports a different ethertype for stripping and insertion. * * VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION - The ethertype(s) specified * for stripping affect the ethertype(s) specified for insertion and visa versa * as well. If the VF tries to configure VLAN stripping via * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 with VIRTCHNL_VLAN_ETHERTYPE_8100 then * that will be the ethertype for both stripping and insertion. * * VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED - The ethertype(s) specified for * stripping do not affect the ethertype(s) specified for insertion and visa * versa. */ enum virtchnl_vlan_ethertype_match { … }; /* The PF populates these fields based on the supported VLAN offloads. If a * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will * reject any VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 or * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 messages using the unsupported fields. * * Also, a VF is only allowed to toggle its VLAN offload setting if the * VIRTCHNL_VLAN_TOGGLE_ALLOWED bit is set. * * The VF driver needs to be aware of how the tags are stripped by hardware and * inserted by the VF driver based on the level of offload support. The PF will * populate these fields based on where the VLAN tags are expected to be * offloaded via the VIRTHCNL_VLAN_TAG_LOCATION_* bits. The VF will need to * interpret these fields. See the definition of the * VIRTCHNL_VLAN_TAG_LOCATION_* bits above the virtchnl_vlan_support * enumeration. */ struct virtchnl_vlan_offload_caps { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS * VF sends this message to determine its VLAN capabilities. * * PF will mark which capabilities it supports based on hardware support and * current configuration. For example, if a port VLAN is configured the PF will * not allow outer VLAN filtering, stripping, or insertion to be configured so * it will block these features from the VF. * * The VF will need to cross reference its capabilities with the PFs * capabilities in the response message from the PF to determine the VLAN * support. */ struct virtchnl_vlan_caps { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_vlan { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_vlan_filter { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_ADD_VLAN_V2 * VIRTCHNL_OP_DEL_VLAN_V2 * * VF sends these messages to add/del one or more VLAN tag filters for Rx * traffic. * * The PF attempts to add the filters and returns status. * * The VF should only ever attempt to add/del virtchnl_vlan_filter(s) using the * supported fields negotiated via VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS. */ struct virtchnl_vlan_filter_list_v2 { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_vlan_filter_list_v2_LEGACY_SIZEOF … /* VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 * VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2 * * VF sends this message to enable or disable VLAN stripping or insertion. It * also needs to specify an ethertype. The VF knows which VLAN ethertypes are * allowed and whether or not it's allowed to enable/disable the specific * offload via the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to * parse the virtchnl_vlan_caps.offloads fields to determine which offload * messages are allowed. * * For example, if the PF populates the virtchnl_vlan_caps.offloads in the * following manner the VF will be allowed to enable and/or disable 0x8100 inner * VLAN insertion and/or stripping via the opcodes listed above. Inner in this * case means the outer most or single VLAN from the VF's perspective. This is * because no outer offloads are supported. See the comments above the * virtchnl_vlan_supported_caps structure for more details. * * virtchnl_vlan_caps.offloads.stripping_support.inner = * VIRTCHNL_VLAN_TOGGLE | * VIRTCHNL_VLAN_ETHERTYPE_8100; * * virtchnl_vlan_caps.offloads.insertion_support.inner = * VIRTCHNL_VLAN_TOGGLE | * VIRTCHNL_VLAN_ETHERTYPE_8100; * * In order to enable inner (again note that in this case inner is the outer * most or single VLAN from the VF's perspective) VLAN stripping for 0x8100 * VLANs, the VF would populate the virtchnl_vlan_setting structure in the * following manner and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message. * * virtchnl_vlan_setting.inner_ethertype_setting = * VIRTCHNL_VLAN_ETHERTYPE_8100; * * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on * initialization. * * The reason that VLAN TPID(s) are not being used for the * outer_ethertype_setting and inner_ethertype_setting fields is because it's * possible a device could support VLAN insertion and/or stripping offload on * multiple ethertypes concurrently, so this method allows a VF to request * multiple ethertypes in one message using the virtchnl_vlan_support * enumeration. * * For example, if the PF populates the virtchnl_vlan_caps.offloads in the * following manner the VF will be allowed to enable 0x8100 and 0x88a8 outer * VLAN insertion and stripping simultaneously. The * virtchnl_vlan_caps.offloads.ethertype_match field will also have to be * populated based on what the PF can support. * * virtchnl_vlan_caps.offloads.stripping_support.outer = * VIRTCHNL_VLAN_TOGGLE | * VIRTCHNL_VLAN_ETHERTYPE_8100 | * VIRTCHNL_VLAN_ETHERTYPE_88A8 | * VIRTCHNL_VLAN_ETHERTYPE_AND; * * virtchnl_vlan_caps.offloads.insertion_support.outer = * VIRTCHNL_VLAN_TOGGLE | * VIRTCHNL_VLAN_ETHERTYPE_8100 | * VIRTCHNL_VLAN_ETHERTYPE_88A8 | * VIRTCHNL_VLAN_ETHERTYPE_AND; * * In order to enable outer VLAN stripping for 0x8100 and 0x88a8 VLANs, the VF * would populate the virthcnl_vlan_offload_structure in the following manner * and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message. * * virtchnl_vlan_setting.outer_ethertype_setting = * VIRTHCNL_VLAN_ETHERTYPE_8100 | * VIRTHCNL_VLAN_ETHERTYPE_88A8; * * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on * initialization. * * There is also the case where a PF and the underlying hardware can support * VLAN offloads on multiple ethertypes, but not concurrently. For example, if * the PF populates the virtchnl_vlan_caps.offloads in the following manner the * VF will be allowed to enable and/or disable 0x8100 XOR 0x88a8 outer VLAN * offloads. The ethertypes must match for stripping and insertion. * * virtchnl_vlan_caps.offloads.stripping_support.outer = * VIRTCHNL_VLAN_TOGGLE | * VIRTCHNL_VLAN_ETHERTYPE_8100 | * VIRTCHNL_VLAN_ETHERTYPE_88A8 | * VIRTCHNL_VLAN_ETHERTYPE_XOR; * * virtchnl_vlan_caps.offloads.insertion_support.outer = * VIRTCHNL_VLAN_TOGGLE | * VIRTCHNL_VLAN_ETHERTYPE_8100 | * VIRTCHNL_VLAN_ETHERTYPE_88A8 | * VIRTCHNL_VLAN_ETHERTYPE_XOR; * * virtchnl_vlan_caps.offloads.ethertype_match = * VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION; * * In order to enable outer VLAN stripping for 0x88a8 VLANs, the VF would * populate the virtchnl_vlan_setting structure in the following manner and send * the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2. Also, this will change the * ethertype for VLAN insertion if it's enabled. So, for completeness, a * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 with the same ethertype should be sent. * * virtchnl_vlan_setting.outer_ethertype_setting = VIRTHCNL_VLAN_ETHERTYPE_88A8; * * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on * initialization. */ struct virtchnl_vlan_setting { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE * VF sends VSI id and flags. * PF returns status code in retval. * Note: we assume that broadcast accept mode is always enabled. */ struct virtchnl_promisc_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define FLAG_VF_UNICAST_PROMISC … #define FLAG_VF_MULTICAST_PROMISC … /* VIRTCHNL_OP_GET_STATS * VF sends this message to request stats for the selected VSI. VF uses * the virtchnl_queue_select struct to specify the VSI. The queue_id * field is ignored by the PF. * * PF replies with struct eth_stats in an external buffer. */ /* VIRTCHNL_OP_CONFIG_RSS_KEY * VIRTCHNL_OP_CONFIG_RSS_LUT * VF sends these messages to configure RSS. Only supported if both PF * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during * configuration negotiation. If this is the case, then the RSS fields in * the VF resource struct are valid. * Both the key and LUT are initialized to 0 by the PF, meaning that * RSS is effectively disabled until set up by the VF. */ struct virtchnl_rss_key { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_rss_key_LEGACY_SIZEOF … struct virtchnl_rss_lut { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_rss_lut_LEGACY_SIZEOF … /* VIRTCHNL_OP_GET_RSS_HENA_CAPS * VIRTCHNL_OP_SET_RSS_HENA * VF sends these messages to get and set the hash filter enable bits for RSS. * By default, the PF sets these to all possible traffic types that the * hardware supports. The VF can query this value if it wants to change the * traffic types that are hashed by the hardware. */ struct virtchnl_rss_hena { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* Type of RSS algorithm */ enum virtchnl_rss_algorithm { … }; /* VIRTCHNL_OP_CONFIG_RSS_HFUNC * VF sends this message to configure the RSS hash function. Only supported * if both PF and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during * configuration negotiation. * The hash function is initialized to VIRTCHNL_RSS_ALG_TOEPLITZ_ASYMMETRIC * by the PF. */ struct virtchnl_rss_hfunc { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_ENABLE_CHANNELS * VIRTCHNL_OP_DISABLE_CHANNELS * VF sends these messages to enable or disable channels based on * the user specified queue count and queue offset for each traffic class. * This struct encompasses all the information that the PF needs from * VF to create a channel. */ struct virtchnl_channel_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_tc_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_tc_info_LEGACY_SIZEOF … /* VIRTCHNL_ADD_CLOUD_FILTER * VIRTCHNL_DEL_CLOUD_FILTER * VF sends these messages to add or delete a cloud filter based on the * user specified match and action filters. These structures encompass * all the information that the PF needs from the VF to add/delete a * cloud filter. */ struct virtchnl_l4_spec { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); virtchnl_flow_spec; VIRTCHNL_CHECK_UNION_LEN(…); enum virtchnl_action { … }; enum virtchnl_flow_type { … }; struct virtchnl_filter { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_supported_rxdids { … }; /* VIRTCHNL_OP_EVENT * PF sends this message to inform the VF driver of events that may affect it. * No direct response is expected from the VF, though it may generate other * messages in response to this one. */ enum virtchnl_event_codes { … }; #define PF_EVENT_SEVERITY_INFO … #define PF_EVENT_SEVERITY_CERTAIN_DOOM … struct virtchnl_pf_event { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* used to specify if a ceq_idx or aeq_idx is invalid */ #define VIRTCHNL_RDMA_INVALID_QUEUE_IDX … /* VIRTCHNL_OP_CONFIG_RDMA_IRQ_MAP * VF uses this message to request PF to map RDMA vectors to RDMA queues. * The request for this originates from the VF RDMA driver through * a client interface between VF LAN and VF RDMA driver. * A vector could have an AEQ and CEQ attached to it although * there is a single AEQ per VF RDMA instance in which case * most vectors will have an VIRTCHNL_RDMA_INVALID_QUEUE_IDX for aeq and valid * idx for ceqs There will never be a case where there will be multiple CEQs * attached to a single vector. * PF configures interrupt mapping and returns status. */ struct virtchnl_rdma_qv_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_rdma_qvlist_info { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define virtchnl_rdma_qvlist_info_LEGACY_SIZEOF … /* VF reset states - these are written into the RSTAT register: * VFGEN_RSTAT on the VF * When the PF initiates a reset, it writes 0 * When the reset is complete, it writes 1 * When the PF detects that the VF has recovered, it writes 2 * VF checks this register periodically to determine if a reset has occurred, * then polls it to know when the reset is complete. * If either the PF or VF reads the register while the hardware * is in a reset state, it will return DEADBEEF, which, when masked * will result in 3. */ enum virtchnl_vfr_states { … }; #define VIRTCHNL_MAX_NUM_PROTO_HDRS … #define PROTO_HDR_SHIFT … #define PROTO_HDR_FIELD_START(proto_hdr_type) … #define PROTO_HDR_FIELD_MASK … /* VF use these macros to configure each protocol header. * Specify which protocol headers and protocol header fields base on * virtchnl_proto_hdr_type and virtchnl_proto_hdr_field. * @param hdr: a struct of virtchnl_proto_hdr * @param hdr_type: ETH/IPV4/TCP, etc * @param field: SRC/DST/TEID/SPI, etc */ #define VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, field) … #define VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, field) … #define VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val) … #define VIRTCHNL_GET_PROTO_HDR_FIELD(hdr) … #define VIRTCHNL_ADD_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) … #define VIRTCHNL_DEL_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) … #define VIRTCHNL_SET_PROTO_HDR_TYPE(hdr, hdr_type) … #define VIRTCHNL_GET_PROTO_HDR_TYPE(hdr) … #define VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) … #define VIRTCHNL_TEST_PROTO_HDR(hdr, val) … /* Protocol header type within a packet segment. A segment consists of one or * more protocol headers that make up a logical group of protocol headers. Each * logical group of protocol headers encapsulates or is encapsulated using/by * tunneling or encapsulation protocols for network virtualization. */ enum virtchnl_proto_hdr_type { … }; /* Protocol header field within a protocol header. */ enum virtchnl_proto_hdr_field { … }; struct virtchnl_proto_hdr { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_proto_hdrs { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); struct virtchnl_rss_cfg { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* action configuration for FDIR */ struct virtchnl_filter_action { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define VIRTCHNL_MAX_NUM_ACTIONS … struct virtchnl_filter_action_set { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* pattern and action for FDIR rule */ struct virtchnl_fdir_rule { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* Status returned to VF after VF requests FDIR commands * VIRTCHNL_FDIR_SUCCESS * VF FDIR related request is successfully done by PF * The request can be OP_ADD/DEL/QUERY_FDIR_FILTER. * * VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE * OP_ADD_FDIR_FILTER request is failed due to no Hardware resource. * * VIRTCHNL_FDIR_FAILURE_RULE_EXIST * OP_ADD_FDIR_FILTER request is failed due to the rule is already existed. * * VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT * OP_ADD_FDIR_FILTER request is failed due to conflict with existing rule. * * VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST * OP_DEL_FDIR_FILTER request is failed due to this rule doesn't exist. * * VIRTCHNL_FDIR_FAILURE_RULE_INVALID * OP_ADD_FDIR_FILTER request is failed due to parameters validation * or HW doesn't support. * * VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT * OP_ADD/DEL_FDIR_FILTER request is failed due to timing out * for programming. * * VIRTCHNL_FDIR_FAILURE_QUERY_INVALID * OP_QUERY_FDIR_FILTER request is failed due to parameters validation, * for example, VF query counter of a rule who has no counter action. */ enum virtchnl_fdir_prgm_status { … }; /* VIRTCHNL_OP_ADD_FDIR_FILTER * VF sends this request to PF by filling out vsi_id, * validate_only and rule_cfg. PF will return flow_id * if the request is successfully done and return add_status to VF. */ struct virtchnl_fdir_add { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); /* VIRTCHNL_OP_DEL_FDIR_FILTER * VF sends this request to PF by filling out vsi_id * and flow_id. PF will return del_status to VF. */ struct virtchnl_fdir_del { … }; VIRTCHNL_CHECK_STRUCT_LEN(…); #define __vss_byone(p, member, count, old) … #define __vss_byelem(p, member, count, old) … #define __vss_full(p, member, count, old) … #define __vss(type, func, p, member, count) … #define virtchnl_struct_size(p, m, c) … /** * virtchnl_vc_validate_vf_msg * @ver: Virtchnl version info * @v_opcode: Opcode for the message * @msg: pointer to the msg buffer * @msglen: msg length * * validate msg format against struct for each opcode */ static inline int virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode, u8 *msg, u16 msglen) { … } #endif /* _VIRTCHNL_H_ */
Codebase Browser
linux