api/spec/packet_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2021-2023 Nokia
 */
 
#ifndef ODP_API_SPEC_PACKET_TYPES_H_
#define ODP_API_SPEC_PACKET_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/deprecated.h>
#include <odp/api/proto_stats_types.h>
#include <odp/api/queue_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ODP_NUM_PACKET_COLORS 3
 
typedef uint8_t odp_proto_l2_type_t;
 
#define ODP_PROTO_L2_TYPE_NONE      0
 
#define ODP_PROTO_L2_TYPE_ETH       1
 
typedef uint16_t odp_proto_l3_type_t;
 
#define ODP_PROTO_L3_TYPE_NONE      0xFFFF
 
/* Types from IEEE EtherType assignments list */
 
#define ODP_PROTO_L3_TYPE_ARP       0x0806
 
#define ODP_PROTO_L3_TYPE_RARP      0x8035
 
#define ODP_PROTO_L3_TYPE_MPLS      0x8847
 
#define ODP_PROTO_L3_TYPE_IPV4      0x0800
 
#define ODP_PROTO_L3_TYPE_IPV6      0x86DD
 
typedef uint8_t odp_proto_l4_type_t;
 
 #define ODP_PROTO_L4_TYPE_NONE     255
 
/* Types from IANA assigned Internet protocol numbers list */
 
 #define ODP_PROTO_L4_TYPE_ICMPV4   1
 
#define ODP_PROTO_L4_TYPE_IGMP      2
 
#define ODP_PROTO_L4_TYPE_IPV4      4
 
 #define ODP_PROTO_L4_TYPE_TCP      6
 
#define ODP_PROTO_L4_TYPE_UDP       17
 
#define ODP_PROTO_L4_TYPE_IPV6      41
 
#define ODP_PROTO_L4_TYPE_GRE       47
 
#define ODP_PROTO_L4_TYPE_ESP       50
 
#define ODP_PROTO_L4_TYPE_AH        51
 
#define ODP_PROTO_L4_TYPE_ICMPV6    58
 
#define ODP_PROTO_L4_TYPE_NO_NEXT   59
 
#define ODP_PROTO_L4_TYPE_IPCOMP    108
 
#define ODP_PROTO_L4_TYPE_SCTP      132
 
#define ODP_PROTO_L4_TYPE_ROHC      142
 
typedef enum odp_proto_t {
    ODP_PROTO_NONE = 0,
 
    ODP_PROTO_ETH,
 
    ODP_PROTO_IPV4,
 
    ODP_PROTO_IPV6
 
} odp_proto_t;
 
typedef enum odp_proto_layer_t {
    ODP_PROTO_LAYER_NONE = 0,
 
    ODP_PROTO_LAYER_L2,
 
    ODP_PROTO_LAYER_L3,
 
    ODP_PROTO_LAYER_L4,
 
    ODP_PROTO_LAYER_ALL
 
} odp_proto_layer_t;
 
typedef struct odp_packet_data_range {
    uint32_t offset;
 
    uint32_t length;
 
} odp_packet_data_range_t;
 
typedef enum odp_packet_reass_status_t {
    ODP_PACKET_REASS_NONE = 0,
 
    ODP_PACKET_REASS_INCOMPLETE,
 
    ODP_PACKET_REASS_COMPLETE,
} odp_packet_reass_status_t;
 
typedef struct odp_packet_reass_info_t {
    uint16_t num_frags;
} odp_packet_reass_info_t;
 
typedef struct odp_packet_reass_partial_state_t {
    uint16_t num_frags;
 
    uint64_t elapsed_time;
} odp_packet_reass_partial_state_t;
 
typedef union odp_proto_chksums_t {
    struct {
        uint32_t ipv4   : 1;
 
        uint32_t udp    : 1;
 
        uint32_t tcp    : 1;
 
        uint32_t sctp   : 1;
 
    } chksum;
 
    uint32_t all_chksum;
 
} odp_proto_chksums_t;
 
typedef struct odp_packet_parse_param_t {
    odp_proto_t proto;
 
    odp_proto_layer_t last_layer;
 
    odp_proto_chksums_t chksums;
 
} odp_packet_parse_param_t;
 
typedef struct odp_packet_parse_result_flag_t {
    union {
        uint64_t all;
 
        struct {
            uint64_t has_error    : 1;
            uint64_t has_l2_error : 1;
            uint64_t has_l3_error : 1;
            uint64_t has_l4_error : 1;
            uint64_t has_l2 : 1;
            uint64_t has_l3 : 1;
            uint64_t has_l4 : 1;
            uint64_t has_eth : 1;
            uint64_t has_eth_bcast : 1;
            uint64_t has_eth_mcast : 1;
            uint64_t has_jumbo : 1;
            uint64_t has_vlan : 1;
            uint64_t has_vlan_qinq : 1;
            uint64_t has_arp : 1;
            uint64_t has_ipv4 : 1;
            uint64_t has_ipv6 : 1;
            uint64_t has_ip_bcast : 1;
            uint64_t has_ip_mcast : 1;
            uint64_t has_ipfrag : 1;
            uint64_t has_ipopt : 1;
            uint64_t has_ipsec : 1;
            uint64_t has_udp : 1;
            uint64_t has_tcp : 1;
            uint64_t has_sctp : 1;
            uint64_t has_icmp : 1;
        };
    };
} odp_packet_parse_result_flag_t;
 
typedef struct odp_packet_parse_result_t {
    odp_packet_parse_result_flag_t flag;
 
    uint32_t packet_len;
 
    uint32_t l2_offset;
    uint32_t l3_offset;
    uint32_t l4_offset;
 
    odp_packet_chksum_status_t l3_chksum_status;
    odp_packet_chksum_status_t l4_chksum_status;
 
    odp_proto_l2_type_t l2_type;
    odp_proto_l3_type_t l3_type;
    odp_proto_l4_type_t l4_type;
 
} odp_packet_parse_result_t;
 
typedef struct odp_packet_lso_opt_t {
    odp_lso_profile_t lso_profile;
 
    uint32_t payload_offset;
 
    uint32_t max_payload_len;
 
} odp_packet_lso_opt_t;
 
typedef enum odp_packet_tx_compl_mode_t {
    ODP_PACKET_TX_COMPL_DISABLED = 0,
 
    ODP_PACKET_TX_COMPL_EVENT,
 
    ODP_PACKET_TX_COMPL_POLL,
 
} odp_packet_tx_compl_mode_t;
 
#if ODP_DEPRECATED_API
#define ODP_PACKET_TX_COMPL_ALL ODP_PACKET_TX_COMPL_EVENT
#endif
 
typedef struct odp_packet_tx_compl_opt_t {
    odp_packet_tx_compl_mode_t mode;
 
    union {
        odp_queue_t queue;
 
        uint32_t compl_id;
    };
 
} odp_packet_tx_compl_opt_t;
 
typedef enum odp_packet_free_ctrl_t {
    ODP_PACKET_FREE_CTRL_DISABLED = 0,
 
    ODP_PACKET_FREE_CTRL_DONT_FREE,
 
} odp_packet_free_ctrl_t;
 
typedef struct odp_packet_proto_stats_opt_t {
    odp_proto_stats_t stat;
 
    int32_t oct_count0_adj;
 
    int32_t oct_count1_adj;
} odp_packet_proto_stats_opt_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif