rte_pmd_iavf.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2019 Intel Corporation
 */

#ifndef _RTE_PMD_IAVF_H_
#define _RTE_PMD_IAVF_H_

#include <stdio.h>

#include <rte_compat.h>
#include <rte_mbuf.h>
#include <rte_mbuf_dyn.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef void (*iavf_pre_reset_cb_t)(uint16_t port_id, void *arg);
typedef void (*iavf_post_reset_cb_t)(uint16_t port_id, int reset_state, void *arg);

union rte_pmd_ifd_proto_xtr_metadata {
    uint32_t metadata;

    struct {
        uint16_t data0;
        uint16_t data1;
    } raw;

    struct {
        uint16_t stag_vid:12,
             stag_dei:1,
             stag_pcp:3;
        uint16_t ctag_vid:12,
             ctag_dei:1,
             ctag_pcp:3;
    } vlan;

    struct {
        uint16_t protocol:8,
             ttl:8;
        uint16_t tos:8,
             ihl:4,
             version:4;
    } ipv4;

    struct {
        uint16_t hoplimit:8,
             nexthdr:8;
        uint16_t flowhi4:4,
             tc:8,
             version:4;
    } ipv6;

    struct {
        uint16_t flowlo16;
        uint16_t flowhi4:4,
             tc:8,
             version:4;
    } ipv6_flow;

    struct {
        uint16_t fin:1,
             syn:1,
             rst:1,
             psh:1,
             ack:1,
             urg:1,
             ece:1,
             cwr:1,
             res1:4,
             doff:4;
        uint16_t rsvd;
    } tcp;

    uint32_t ip_ofs;
};

/* Offset of mbuf dynamic field for flexible descriptor's extraction data */
extern int rte_pmd_ifd_dynfield_proto_xtr_metadata_offs;

/* Mask of mbuf dynamic flags for flexible descriptor's extraction type */
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_vlan_mask;
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipv4_mask;
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipv6_mask;
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipv6_flow_mask;
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_tcp_mask;
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ip_offset_mask;
extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipsec_crypto_said_mask;

__rte_experimental
int rte_pmd_iavf_reinit(uint16_t port);

__rte_experimental
int rte_pmd_iavf_register_pre_reset_cb(uint16_t port,
                    iavf_pre_reset_cb_t pre_reset_cb,
                    void *pre_reset_cb_arg);

__rte_experimental
int rte_pmd_iavf_register_post_reset_cb(uint16_t port,
                    iavf_post_reset_cb_t post_reset_cb,
                    void *post_reset_cb_arg);

#define RTE_PMD_IFD_DYNF_PROTO_XTR_METADATA(m) \
    RTE_MBUF_DYNFIELD((m), \
              rte_pmd_ifd_dynfield_proto_xtr_metadata_offs, \
              uint32_t *)

#define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_VLAN \
    (rte_pmd_ifd_dynflag_proto_xtr_vlan_mask)

#define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV4 \
    (rte_pmd_ifd_dynflag_proto_xtr_ipv4_mask)

#define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6 \
    (rte_pmd_ifd_dynflag_proto_xtr_ipv6_mask)

#define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6_FLOW \
    (rte_pmd_ifd_dynflag_proto_xtr_ipv6_flow_mask)

#define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_TCP \
    (rte_pmd_ifd_dynflag_proto_xtr_tcp_mask)

#define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IP_OFFSET \
    (rte_pmd_ifd_dynflag_proto_xtr_ip_offset_mask)

__rte_experimental
static __rte_always_inline int
rte_pmd_ifd_dynf_proto_xtr_metadata_avail(void)
{
    return rte_pmd_ifd_dynfield_proto_xtr_metadata_offs != -1;
}

__rte_experimental
static __rte_always_inline uint32_t
rte_pmd_ifd_dynf_proto_xtr_metadata_get(struct rte_mbuf *m)
{
    return *RTE_PMD_IFD_DYNF_PROTO_XTR_METADATA(m);
}

__rte_experimental
static inline void
rte_pmd_ifd_dump_proto_xtr_metadata(struct rte_mbuf *m)
{
#ifdef ALLOW_EXPERIMENTAL_API
    union rte_pmd_ifd_proto_xtr_metadata data;

    if (!rte_pmd_ifd_dynf_proto_xtr_metadata_avail())
        return;

    data.metadata = rte_pmd_ifd_dynf_proto_xtr_metadata_get(m);

    if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_VLAN)
        printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
               "vlan,stag=%u:%u:%u,ctag=%u:%u:%u",
               data.raw.data0, data.raw.data1,
               data.vlan.stag_pcp,
               data.vlan.stag_dei,
               data.vlan.stag_vid,
               data.vlan.ctag_pcp,
               data.vlan.ctag_dei,
               data.vlan.ctag_vid);
    else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV4)
        printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
               "ipv4,ver=%u,hdrlen=%u,tos=%u,ttl=%u,proto=%u",
               data.raw.data0, data.raw.data1,
               data.ipv4.version,
               data.ipv4.ihl,
               data.ipv4.tos,
               data.ipv4.ttl,
               data.ipv4.protocol);
    else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6)
        printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
               "ipv6,ver=%u,tc=%u,flow_hi4=0x%x,nexthdr=%u,hoplimit=%u",
               data.raw.data0, data.raw.data1,
               data.ipv6.version,
               data.ipv6.tc,
               data.ipv6.flowhi4,
               data.ipv6.nexthdr,
               data.ipv6.hoplimit);
    else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6_FLOW)
        printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
               "ipv6_flow,ver=%u,tc=%u,flow=0x%x%04x",
               data.raw.data0, data.raw.data1,
               data.ipv6_flow.version,
               data.ipv6_flow.tc,
               data.ipv6_flow.flowhi4,
               data.ipv6_flow.flowlo16);
    else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_TCP)
        printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
               "tcp,doff=%u,flags=%s%s%s%s%s%s%s%s",
               data.raw.data0, data.raw.data1,
               data.tcp.doff,
               data.tcp.cwr ? "C" : "",
               data.tcp.ece ? "E" : "",
               data.tcp.urg ? "U" : "",
               data.tcp.ack ? "A" : "",
               data.tcp.psh ? "P" : "",
               data.tcp.rst ? "R" : "",
               data.tcp.syn ? "S" : "",
               data.tcp.fin ? "F" : "");
    else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IP_OFFSET)
        printf(" - Flexible descriptor's Extraction: ip_offset=%u",
               data.ip_ofs);
#else
    RTE_SET_USED(m);
    RTE_VERIFY(false);
#endif
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_PMD_IAVF_H_ */