2 * Copyright (c) 2017-2018 Cavium, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
31 #ifndef __ECORE_VF_PF_IF_H__
32 #define __ECORE_VF_PF_IF_H__
34 #define T_ETH_INDIRECTION_TABLE_SIZE 128 /* @@@ TBD MichalK this should be HSI? */
35 #define T_ETH_RSS_KEY_SIZE 10 /* @@@ TBD this should be HSI? */
38 #define ETH_ALEN 6 /* @@@ TBD MichalK - should this be defined here?*/
42 /***********************************************
44 * Common definitions for all HVs
47 struct vf_pf_resc_request {
53 u8 num_mc_filters; /* No limit so superfluous */
59 u16 hw_sb_id; /* aka absolute igu id, used to ack the sb */
60 u8 sb_qid; /* used to update DHC for sb */
64 /***********************************************
66 * HW VF-PF channel definitions
71 #define TLV_BUFFER_SIZE 1024
73 /* vf pf channel tlvs */
74 /* general tlv header (used for both vf->pf request and pf->vf response) */
80 /* header of first vf->pf tlv carries the offset used to calculate reponse
83 struct vfpf_first_tlv {
84 struct channel_tlv tl;
89 /* header of pf->vf tlvs, carries the status of handling the request */
91 struct channel_tlv tl;
96 /* response tlv used for most tlvs */
97 struct pfvf_def_resp_tlv {
101 /* used to terminate and pad a tlv list */
102 struct channel_list_end_tlv {
103 struct channel_tlv tl;
108 struct vfpf_acquire_tlv {
109 struct vfpf_first_tlv first_tlv;
111 struct vf_pf_vfdev_info {
113 /* First bit was used on 8.7.x and 8.8.x versions, which had different
114 * FWs used but with the same faspath HSI. As this was prior to the
115 * fastpath versioning, wanted to have ability to override fw matching
116 * and allow them to interact.
119 #define VFPF_ACQUIRE_CAP_PRE_FP_HSI (1 << 0) /* VF pre-FP hsi version */
120 #define VFPF_ACQUIRE_CAP_100G (1 << 1) /* VF can support 100g */
122 /* A requirement for supporting multi-Tx queues on a single queue-zone,
123 * VF would pass qids as additional information whenever passing queue
125 * TODO - due to the CID limitations in Bar0, VFs currently don't pass
126 * this, and use the legacy CID scheme.
128 #define VFPF_ACQUIRE_CAP_QUEUE_QIDS (1 << 2)
130 /* The VF is using the physical bar. While this is mostly internal
131 * to the VF, might affect the number of CIDs supported assuming
134 #define VFPF_ACQUIRE_CAP_PHYSICAL_BAR (1 << 3)
141 u16 opaque_fid; /* ME register value */
142 u8 os_type; /* VFPF_ACQUIRE_OS_* value */
148 struct vf_pf_resc_request resc_request;
155 /* receive side scaling tlv */
156 struct vfpf_vport_update_rss_tlv {
157 struct channel_tlv tl;
160 #define VFPF_UPDATE_RSS_CONFIG_FLAG (1 << 0)
161 #define VFPF_UPDATE_RSS_CAPS_FLAG (1 << 1)
162 #define VFPF_UPDATE_RSS_IND_TABLE_FLAG (1 << 2)
163 #define VFPF_UPDATE_RSS_KEY_FLAG (1 << 3)
167 u8 rss_table_size_log; /* The table size is 2 ^ rss_table_size_log */
168 u16 rss_ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
169 u32 rss_key[T_ETH_RSS_KEY_SIZE];
172 struct pfvf_storm_stats {
177 struct pfvf_stats_info {
178 struct pfvf_storm_stats mstats;
179 struct pfvf_storm_stats pstats;
180 struct pfvf_storm_stats tstats;
181 struct pfvf_storm_stats ustats;
184 /* acquire response tlv - carries the allocated resources */
185 struct pfvf_acquire_resp_tlv {
188 struct pf_vf_pfdev_info {
198 #define PFVF_ACQUIRE_CAP_DEFAULT_UNTAGGED (1 << 0)
199 #define PFVF_ACQUIRE_CAP_100G (1 << 1) /* If set, 100g PF */
200 /* There are old PF versions where the PF might mistakenly override the sanity
201 * mechanism [version-based] and allow a VF that can't be supported to pass
202 * the acquisition phase.
203 * To overcome this, PFs now indicate that they're past that point and the new
204 * VFs would fail probe on the older PFs that fail to do so.
207 /* Said bug was in quest/serpens; Can't be certain no official release included
208 * the bug since the fix arrived very late in the programs.
211 #define PFVF_ACQUIRE_CAP_POST_FW_OVERRIDE (1 << 2)
213 /* PF expects queues to be received with additional qids */
214 #define PFVF_ACQUIRE_CAP_QUEUE_QIDS (1 << 3)
220 /* These should match the PF's ecore_dev values */
224 /* Doorbell bar size configured in HW: log(size) or 0 */
227 struct pfvf_stats_info stats_info;
229 u8 port_mac[ETH_ALEN];
231 /* It's possible PF had to configure an older fastpath HSI
232 * [in case VF is newer than PF]. This is communicated back
233 * to the VF. It can also be used in case of error due to
234 * non-matching versions to shed light in VF about failure.
241 /* in case of status NO_RESOURCE in message hdr, pf will fill
242 * this struct with suggested amount of resources for next
245 #define PFVF_MAX_QUEUES_PER_VF 16
246 #define PFVF_MAX_SBS_PER_VF 16
247 struct hw_sb_info hw_sbs[PFVF_MAX_SBS_PER_VF];
248 u8 hw_qid[PFVF_MAX_QUEUES_PER_VF];
249 u8 cid[PFVF_MAX_QUEUES_PER_VF];
265 struct pfvf_start_queue_resp_tlv {
267 u32 offset; /* offset to consumer/producer of queue */
271 /* Extended queue information - additional index for reference inside qzone.
272 * If commmunicated between VF/PF, each TLV relating to queues should be
273 * extended by one such [or have a future base TLV that already contains info].
275 struct vfpf_qid_tlv {
276 struct channel_tlv tl;
282 struct vfpf_start_rxq_tlv {
283 struct vfpf_first_tlv first_tlv;
285 /* physical addresses */
287 u64 deprecated_sge_addr;
293 u16 hc_rate; /* desired interrupts per sec. */
302 struct vfpf_start_txq_tlv {
303 struct vfpf_first_tlv first_tlv;
305 /* physical addresses */
312 u32 flags; /* VFPF_QUEUE_FLG_X flags */
313 u16 hc_rate; /* desired interrupts per sec. */
319 struct vfpf_stop_rxqs_tlv {
320 struct vfpf_first_tlv first_tlv;
324 /* While the API supports multiple Rx-queues on a single TLV
325 * message, in practice older VFs always used it as one [ecore].
326 * And there are PFs [starting with the CHANNEL_TLV_QID] which
327 * would start assuming this is always a '1'. So in practice this
328 * field should be considered deprecated and *Always* set to '1'.
337 struct vfpf_stop_txqs_tlv {
338 struct vfpf_first_tlv first_tlv;
342 /* While the API supports multiple Tx-queues on a single TLV
343 * message, in practice older VFs always used it as one [ecore].
344 * And there are PFs [starting with the CHANNEL_TLV_QID] which
345 * would start assuming this is always a '1'. So in practice this
346 * field should be considered deprecated and *Always* set to '1'.
352 struct vfpf_update_rxq_tlv {
353 struct vfpf_first_tlv first_tlv;
355 u64 deprecated_sge_addr[PFVF_MAX_QUEUES_PER_VF];
360 #define VFPF_RXQ_UPD_INIT_SGE_DEPRECATE_FLAG (1 << 0)
361 #define VFPF_RXQ_UPD_COMPLETE_CQE_FLAG (1 << 1)
362 #define VFPF_RXQ_UPD_COMPLETE_EVENT_FLAG (1 << 2)
367 /* Set Queue Filters */
368 struct vfpf_q_mac_vlan_filter {
370 #define VFPF_Q_FILTER_DEST_MAC_VALID 0x01
371 #define VFPF_Q_FILTER_VLAN_TAG_VALID 0x02
372 #define VFPF_Q_FILTER_SET_MAC 0x100 /* set/clear */
381 struct vfpf_vport_start_tlv {
382 struct vfpf_first_tlv first_tlv;
384 u64 sb_addr[PFVF_MAX_SBS_PER_VF];
391 u8 inner_vlan_removal;
394 u8 max_buffers_per_cqe;
396 u8 zero_placement_offset;
400 /* Extended tlvs - need to add rss, mcast, accept mode tlvs */
401 struct vfpf_vport_update_activate_tlv {
402 struct channel_tlv tl;
409 struct vfpf_vport_update_tx_switch_tlv {
410 struct channel_tlv tl;
415 struct vfpf_vport_update_vlan_strip_tlv {
416 struct channel_tlv tl;
421 struct vfpf_vport_update_mcast_bin_tlv {
422 struct channel_tlv tl;
425 /* This was a mistake; There are only 256 approx bins,
426 * and in HSI they're divided into 32-bit values.
427 * As old VFs used to set-bit to the values on its side,
428 * the upper half of the array is never expected to contain any data.
431 u64 obsolete_bins[4];
434 struct vfpf_vport_update_accept_param_tlv {
435 struct channel_tlv tl;
442 struct vfpf_vport_update_accept_any_vlan_tlv {
443 struct channel_tlv tl;
444 u8 update_accept_any_vlan_flg;
450 struct vfpf_vport_update_sge_tpa_tlv {
451 struct channel_tlv tl;
454 #define VFPF_TPA_IPV4_EN_FLAG (1 << 0)
455 #define VFPF_TPA_IPV6_EN_FLAG (1 << 1)
456 #define VFPF_TPA_PKT_SPLIT_FLAG (1 << 2)
457 #define VFPF_TPA_HDR_DATA_SPLIT_FLAG (1 << 3)
458 #define VFPF_TPA_GRO_CONSIST_FLAG (1 << 4)
460 u8 update_sge_tpa_flags;
461 #define VFPF_UPDATE_SGE_DEPRECATED_FLAG (1 << 0)
462 #define VFPF_UPDATE_TPA_EN_FLAG (1 << 1)
463 #define VFPF_UPDATE_TPA_PARAM_FLAG (1 << 2)
465 u8 max_buffers_per_cqe;
467 u16 deprecated_sge_buff_size;
469 u16 tpa_min_size_to_start;
470 u16 tpa_min_size_to_cont;
477 /* Primary tlv as a header for various extended tlvs for
478 * various functionalities in vport update ramrod.
480 struct vfpf_vport_update_tlv {
481 struct vfpf_first_tlv first_tlv;
484 struct vfpf_ucast_filter_tlv {
485 struct vfpf_first_tlv first_tlv;
496 /* tunnel update param tlv */
497 struct vfpf_update_tunn_param_tlv {
498 struct vfpf_first_tlv first_tlv;
500 u8 tun_mode_update_mask;
508 u8 update_geneve_port;
509 u8 update_vxlan_port;
515 struct pfvf_update_tunn_param_tlv {
518 u16 tunn_feature_mask;
533 struct tlv_buffer_size {
534 u8 tlv_buffer[TLV_BUFFER_SIZE];
537 struct vfpf_update_coalesce {
538 struct vfpf_first_tlv first_tlv;
545 struct vfpf_read_coal_req_tlv {
546 struct vfpf_first_tlv first_tlv;
552 struct pfvf_read_coal_resp_tlv {
559 struct vfpf_first_tlv first_tlv;
560 struct vfpf_acquire_tlv acquire;
561 struct vfpf_start_rxq_tlv start_rxq;
562 struct vfpf_start_txq_tlv start_txq;
563 struct vfpf_stop_rxqs_tlv stop_rxqs;
564 struct vfpf_stop_txqs_tlv stop_txqs;
565 struct vfpf_update_rxq_tlv update_rxq;
566 struct vfpf_vport_start_tlv start_vport;
567 struct vfpf_vport_update_tlv vport_update;
568 struct vfpf_ucast_filter_tlv ucast_filter;
569 struct vfpf_update_tunn_param_tlv tunn_param_update;
570 struct vfpf_update_coalesce update_coalesce;
571 struct vfpf_read_coal_req_tlv read_coal_req;
572 struct tlv_buffer_size tlv_buf_size;
576 struct pfvf_def_resp_tlv default_resp;
577 struct pfvf_acquire_resp_tlv acquire_resp;
578 struct tlv_buffer_size tlv_buf_size;
579 struct pfvf_start_queue_resp_tlv queue_start;
580 struct pfvf_update_tunn_param_tlv tunn_param_resp;
581 struct pfvf_read_coal_resp_tlv read_coal_resp;
584 /* This is a structure which is allocated in the VF, which the PF may update
585 * when it deems it necessary to do so. The bulletin board is sampled
586 * periodically by the VF. A copy per VF is maintained in the PF (to prevent
587 * loss of data upon multiple updates (or the need for read modify write)).
589 enum ecore_bulletin_bit {
590 /* Alert the VF that a forced MAC was set by the PF */
593 /* The VF should not access the vfpf channel */
594 VFPF_CHANNEL_INVALID = 1,
596 /* Alert the VF that a forced VLAN was set by the PF */
597 VLAN_ADDR_FORCED = 2,
599 /* Indicate that `default_only_untagged' contains actual data */
600 VFPF_BULLETIN_UNTAGGED_DEFAULT = 3,
601 VFPF_BULLETIN_UNTAGGED_DEFAULT_FORCED = 4,
603 /* Alert the VF that suggested mac was sent by the PF.
604 * MAC_ADDR will be disabled in case MAC_ADDR_FORCED is set
606 VFPF_BULLETIN_MAC_ADDR = 5
609 struct ecore_bulletin_content {
610 /* crc of structure to ensure is not in mid-update */
615 /* bitmap indicating which fields hold valid values */
618 /* used for MAC_ADDR or MAC_ADDR_FORCED */
621 /* If valid, 1 => only untagged Rx if no vlan is configured */
622 u8 default_only_untagged;
625 /* The following is a 'copy' of ecore_mcp_link_state,
626 * ecore_mcp_link_params and ecore_mcp_link_capabilities. Since it's
627 * possible the structs will increase further along the road we cannot
628 * have it here; Instead we need to have all of its fields.
631 u8 req_autoneg_pause;
637 u32 req_forced_speed;
645 u8 parallel_detection;
647 u8 partner_tx_flow_ctrl_en;
648 u8 partner_rx_flow_ctrl_en;
650 u8 partner_adv_pause;
657 u32 partner_adv_speed;
659 u32 capability_speed;
666 struct ecore_bulletin {
668 struct ecore_bulletin_content *p_virt;
673 /*!!!!! Make sure to update STRINGS structure accordingly !!!!!*/
675 CHANNEL_TLV_NONE, /* ends tlv sequence */
677 CHANNEL_TLV_VPORT_START,
678 CHANNEL_TLV_VPORT_UPDATE,
679 CHANNEL_TLV_VPORT_TEARDOWN,
680 CHANNEL_TLV_START_RXQ,
681 CHANNEL_TLV_START_TXQ,
682 CHANNEL_TLV_STOP_RXQS,
683 CHANNEL_TLV_STOP_TXQS,
684 CHANNEL_TLV_UPDATE_RXQ,
685 CHANNEL_TLV_INT_CLEANUP,
688 CHANNEL_TLV_LIST_END,
689 CHANNEL_TLV_UCAST_FILTER,
690 CHANNEL_TLV_VPORT_UPDATE_ACTIVATE,
691 CHANNEL_TLV_VPORT_UPDATE_TX_SWITCH,
692 CHANNEL_TLV_VPORT_UPDATE_VLAN_STRIP,
693 CHANNEL_TLV_VPORT_UPDATE_MCAST,
694 CHANNEL_TLV_VPORT_UPDATE_ACCEPT_PARAM,
695 CHANNEL_TLV_VPORT_UPDATE_RSS,
696 CHANNEL_TLV_VPORT_UPDATE_ACCEPT_ANY_VLAN,
697 CHANNEL_TLV_VPORT_UPDATE_SGE_TPA,
698 CHANNEL_TLV_UPDATE_TUNN_PARAM,
699 CHANNEL_TLV_COALESCE_UPDATE,
701 CHANNEL_TLV_COALESCE_READ,
704 /* Required for iterating over vport-update tlvs.
705 * Will break in case non-sequential vport-update tlvs.
707 CHANNEL_TLV_VPORT_UPDATE_MAX = CHANNEL_TLV_VPORT_UPDATE_SGE_TPA + 1,
709 /*!!!!! Make sure to update STRINGS structure accordingly !!!!!*/
711 extern const char *ecore_channel_tlvs_string[];
713 #endif /* __ECORE_VF_PF_IF_H__ */