api/spec/packet_io_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2020-2025 Nokia
 */
 
#ifndef ODP_API_SPEC_PACKET_IO_TYPES_H_
#define ODP_API_SPEC_PACKET_IO_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/deprecated.h>
#include <odp/api/packet_types.h>
#include <odp/api/packet_io_stats.h>
#include <odp/api/pool_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/reassembly.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum odp_pktin_mode_t {
    ODP_PKTIN_MODE_DIRECT = 0,
    ODP_PKTIN_MODE_SCHED,
    ODP_PKTIN_MODE_QUEUE,
    ODP_PKTIN_MODE_DISABLED
} odp_pktin_mode_t;
 
typedef enum odp_pktout_mode_t {
    ODP_PKTOUT_MODE_DIRECT = 0,
    ODP_PKTOUT_MODE_QUEUE,
    ODP_PKTOUT_MODE_TM,
    ODP_PKTOUT_MODE_DISABLED
} odp_pktout_mode_t;
 
typedef union odp_pktin_hash_proto_t {
    struct {
        uint32_t ipv4_udp : 1;
        uint32_t ipv4_tcp : 1;
        uint32_t ipv4     : 1;
        uint32_t ipv6_udp : 1;
        uint32_t ipv6_tcp : 1;
        uint32_t ipv6     : 1;
    } proto;
 
    uint32_t all_bits;
} odp_pktin_hash_proto_t;
 
typedef enum odp_pktio_op_mode_t {
    ODP_PKTIO_OP_MT = 0,
 
    ODP_PKTIO_OP_MT_UNSAFE
 
} odp_pktio_op_mode_t;
 
typedef struct odp_pktin_queue_param_ovr_t {
    odp_schedule_group_t group;
} odp_pktin_queue_param_ovr_t;
 
typedef struct odp_pktin_vector_config_t {
    odp_bool_t enable;
 
    odp_pool_t pool;
 
    uint64_t max_tmo_ns;
 
    uint32_t max_size;
 
} odp_pktin_vector_config_t;
 
typedef struct odp_pktin_queue_param_t {
    odp_pktio_op_mode_t op_mode;
 
    odp_bool_t classifier_enable;
 
    odp_bool_t hash_enable;
 
    odp_pktin_hash_proto_t hash_proto;
 
    uint32_t num_queues;
 
    uint32_t queue_size[ODP_PKTIN_MAX_QUEUES];
 
    odp_queue_param_t queue_param;
 
    odp_pktin_queue_param_ovr_t *queue_param_ovr;
 
    odp_pktin_vector_config_t vector;
 
} odp_pktin_queue_param_t;
 
typedef struct odp_pktout_queue_param_t {
    odp_pktio_op_mode_t op_mode;
 
    uint32_t num_queues;
 
    uint32_t queue_size[ODP_PKTOUT_MAX_QUEUES];
 
} odp_pktout_queue_param_t;
 
typedef struct odp_pktio_param_t {
    odp_pktin_mode_t in_mode;
 
    odp_pktout_mode_t out_mode;
 
} odp_pktio_param_t;
 
typedef union odp_pktin_config_opt_t {
    struct {
        uint64_t ts_all        : 1;
 
        uint64_t ts_ptp        : 1;
 
        uint64_t ipv4_chksum   : 1;
 
        uint64_t udp_chksum    : 1;
 
        uint64_t tcp_chksum    : 1;
 
        uint64_t sctp_chksum   : 1;
 
        uint64_t drop_ipv4_err : 1;
 
        uint64_t drop_ipv6_err : 1;
 
        uint64_t drop_udp_err  : 1;
 
        uint64_t drop_tcp_err  : 1;
 
        uint64_t drop_sctp_err : 1;
 
    } bit;
 
    uint64_t all_bits;
} odp_pktin_config_opt_t;
 
typedef union odp_pktout_config_opt_t {
    struct {
        uint64_t ts_ena : 1;
 
        uint64_t ipv4_chksum_ena : 1;
 
        uint64_t udp_chksum_ena  : 1;
 
        uint64_t tcp_chksum_ena  : 1;
 
        uint64_t sctp_chksum_ena : 1;
 
        uint64_t ipv4_chksum     : 1;
 
        uint64_t udp_chksum      : 1;
 
        uint64_t tcp_chksum      : 1;
 
        uint64_t sctp_chksum     : 1;
 
        uint64_t no_packet_refs  : 1;
 
        uint64_t aging_ena  : 1;
 
        uint64_t ODP_DEPRECATE(tx_compl_ena) : 1;
 
        uint64_t proto_stats_ena : 1;
 
    } bit;
 
    uint64_t all_bits;
} odp_pktout_config_opt_t;
 
typedef struct odp_pktio_parser_config_t {
    odp_proto_layer_t layer;
 
} odp_pktio_parser_config_t;
 
typedef enum odp_pktio_link_pause_t {
    ODP_PKTIO_LINK_PAUSE_UNKNOWN = -1,
    ODP_PKTIO_LINK_PAUSE_OFF = 0,
    ODP_PKTIO_LINK_PAUSE_ON = 1,
    ODP_PKTIO_LINK_PFC_ON = 2
 
} odp_pktio_link_pause_t;
 
typedef struct odp_pktio_config_t {
    odp_pktin_config_opt_t pktin;
 
    odp_pktout_config_opt_t pktout;
 
    odp_pktio_parser_config_t parser;
 
    odp_bool_t enable_loop;
 
    odp_bool_t inbound_ipsec;
 
    odp_bool_t outbound_ipsec;
 
    odp_bool_t enable_lso;
 
    odp_reass_config_t reassembly;
 
    struct {
        odp_pktio_link_pause_t pause_rx;
 
        odp_pktio_link_pause_t pause_tx;
 
    } flow_control;
 
    struct {
        uint32_t mode_event : 1;
 
        uint32_t mode_poll : 1;
 
        uint32_t max_compl_id;
 
    } tx_compl;
 
} odp_pktio_config_t;
 
typedef union odp_pktio_set_op_t {
    struct {
        uint32_t promisc_mode : 1;
        uint32_t mac_addr : 1;
        uint32_t skip_offset : 1;
        uint32_t maxlen : 1;
    } op;
    uint32_t all_bits;
} odp_pktio_set_op_t;
 
#define ODP_LSO_MAX_CUSTOM 8
 
typedef enum odp_lso_modify_t {
    ODP_LSO_ADD_SEGMENT_NUM = 0x1,
 
    ODP_LSO_ADD_PAYLOAD_LEN = 0x2,
 
    ODP_LSO_ADD_PAYLOAD_OFFSET = 0x4,
 
    ODP_LSO_WRITE_BITS,
 
} odp_lso_modify_t;
 
typedef enum odp_lso_protocol_t {
    ODP_LSO_PROTO_NONE = 0,
 
    ODP_LSO_PROTO_CUSTOM,
 
    ODP_LSO_PROTO_IPV4,
 
    ODP_LSO_PROTO_IPV6,
 
    ODP_LSO_PROTO_TCP_IPV4,
 
    ODP_LSO_PROTO_TCP_IPV6,
 
    ODP_LSO_PROTO_SCTP_IPV4,
 
    ODP_LSO_PROTO_SCTP_IPV6
 
} odp_lso_protocol_t;
 
typedef struct odp_lso_capability_t {
    uint32_t max_profiles;
 
    uint32_t max_profiles_per_pktio;
 
    uint32_t max_packet_segments;
 
    uint32_t max_segments;
 
    uint32_t max_payload_len;
 
    uint32_t max_payload_offset;
 
    struct {
        uint16_t add_segment_num:1;
 
        uint16_t add_payload_len:1;
 
        uint16_t add_payload_offset:1;
 
        uint16_t write_bits:1;
 
    } mod_op;
 
    uint8_t max_num_custom;
 
    struct {
        uint32_t custom:1;
 
        uint32_t ipv4:1;
 
        uint32_t ipv6:1;
 
        uint32_t tcp_ipv4:1;
 
        uint32_t tcp_ipv6:1;
 
        uint32_t sctp_ipv4:1;
 
        uint32_t sctp_ipv6:1;
 
    } proto;
 
} odp_lso_capability_t;
 
typedef struct odp_pktin_vector_capability_t {
    odp_support_t supported;
 
    uint32_t max_size;
 
    uint32_t min_size;
 
    uint64_t max_tmo_ns;
 
    uint64_t min_tmo_ns;
 
} odp_pktin_vector_capability_t;
 
typedef struct odp_pktio_capability_t {
    uint32_t max_input_queues;
 
    uint32_t min_input_queue_size;
 
    uint32_t max_input_queue_size;
 
    uint32_t max_output_queues;
 
    uint32_t min_output_queue_size;
 
    uint32_t max_output_queue_size;
 
    odp_pktio_config_t config;
 
    odp_pktio_set_op_t set_op;
 
    odp_pktin_vector_capability_t vector;
 
    odp_lso_capability_t lso;
 
    struct {
        odp_bool_t equal;
        uint32_t min_input;
        uint32_t max_input;
        uint32_t min_output;
        uint32_t max_output;
    } maxlen;
 
    uint64_t max_tx_aging_tmo_ns;
 
    struct {
        odp_bool_t queue_type_sched;
 
        odp_bool_t queue_type_plain;
 
        uint32_t ODP_DEPRECATE(mode_all)   : 1;
 
        uint32_t mode_event : 1;
 
        uint32_t mode_poll  : 1;
 
        uint32_t max_compl_id;
 
    } tx_compl;
 
    struct {
        uint32_t dont_free : 1;
 
    } free_ctrl;
 
    odp_reass_capability_t reassembly;
 
    odp_pktio_stats_capability_t stats;
 
    struct {
        uint32_t pause_rx: 1;
 
        uint32_t pfc_rx: 1;
 
        uint32_t pause_tx: 1;
 
        uint32_t pfc_tx: 1;
 
    } flow_control;
 
} odp_pktio_capability_t;
 
typedef struct odp_lso_write_bits_t {
    uint8_t mask[1];
 
    uint8_t value[1];
 
} odp_lso_write_bits_t;
 
typedef struct odp_lso_profile_param_t {
    odp_lso_protocol_t lso_proto;
 
    struct {
        struct {
            odp_lso_modify_t mod_op;
 
            uint32_t offset;
 
            uint8_t size;
 
            union {
                struct {
                    odp_lso_write_bits_t first_seg;
                    odp_lso_write_bits_t middle_seg;
                    odp_lso_write_bits_t last_seg;
                } write_bits;
            };
        } field[ODP_LSO_MAX_CUSTOM];
 
        uint8_t num_custom;
 
    } custom;
 
} odp_lso_profile_param_t;
 
typedef enum odp_pktio_link_status_t {
    ODP_PKTIO_LINK_STATUS_UNKNOWN = -1,
    ODP_PKTIO_LINK_STATUS_DOWN = 0,
    ODP_PKTIO_LINK_STATUS_UP = 1
 
} odp_pktio_link_status_t;
 
typedef struct odp_pktio_info_t {
    const char       *name;
 
    const char       *drv_name;
 
    odp_pool_t        pool;
 
    odp_pktio_param_t param;
 
} odp_pktio_info_t;
 
#define ODP_PKTIO_LINK_SPEED_UNKNOWN 0
#define ODP_PKTIO_LINK_SPEED_10M     10
#define ODP_PKTIO_LINK_SPEED_100M    100
#define ODP_PKTIO_LINK_SPEED_1G      1000
#define ODP_PKTIO_LINK_SPEED_2_5G    2500
#define ODP_PKTIO_LINK_SPEED_5G      5000
#define ODP_PKTIO_LINK_SPEED_10G     10000
#define ODP_PKTIO_LINK_SPEED_20G     20000
#define ODP_PKTIO_LINK_SPEED_25G     25000
#define ODP_PKTIO_LINK_SPEED_40G     40000
#define ODP_PKTIO_LINK_SPEED_50G     50000
#define ODP_PKTIO_LINK_SPEED_56G     56000
#define ODP_PKTIO_LINK_SPEED_100G    100000
#define ODP_PKTIO_LINK_SPEED_200G    200000
#define ODP_PKTIO_LINK_SPEED_400G    400000
 
typedef enum odp_pktio_link_autoneg_t {
    ODP_PKTIO_LINK_AUTONEG_UNKNOWN = -1,
    ODP_PKTIO_LINK_AUTONEG_OFF = 0,
    ODP_PKTIO_LINK_AUTONEG_ON  = 1
 
} odp_pktio_link_autoneg_t;
 
typedef enum odp_pktio_link_duplex_t {
    ODP_PKTIO_LINK_DUPLEX_UNKNOWN = -1,
    ODP_PKTIO_LINK_DUPLEX_HALF = 0,
    ODP_PKTIO_LINK_DUPLEX_FULL = 1
 
} odp_pktio_link_duplex_t;
 
typedef struct odp_pktio_link_info_t {
    odp_pktio_link_autoneg_t autoneg;
    odp_pktio_link_duplex_t duplex;
    const char *media;
    odp_pktio_link_pause_t pause_rx;
    odp_pktio_link_pause_t pause_tx;
    uint32_t speed;
    odp_pktio_link_status_t status;
} odp_pktio_link_info_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif