api/spec/packet_io.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2020-2023 Nokia
 */
 
#ifndef ODP_API_SPEC_PACKET_IO_H_
#define ODP_API_SPEC_PACKET_IO_H_
#include <odp/visibility_begin.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <odp/api/classification.h>
#include <odp/api/packet_types.h>
#include <odp/api/packet_io_stats.h>
#include <odp/api/packet_io_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/reassembly.h>
#include <odp/api/time_types.h>
 
odp_pktio_t odp_pktio_open(const char *name, odp_pool_t pool,
               const odp_pktio_param_t *param);
 
int odp_pktio_capability(odp_pktio_t pktio, odp_pktio_capability_t *capa);
 
unsigned int odp_pktio_max_index(void);
 
int odp_pktio_config(odp_pktio_t pktio, const odp_pktio_config_t *config);
 
int odp_pktin_queue_config(odp_pktio_t pktio,
               const odp_pktin_queue_param_t *param);
 
int odp_pktout_queue_config(odp_pktio_t pktio,
                const odp_pktout_queue_param_t *param);
 
int odp_pktin_event_queue(odp_pktio_t pktio, odp_queue_t queues[], int num);
 
int odp_pktin_queue(odp_pktio_t pktio, odp_pktin_queue_t queues[], int num);
 
int odp_pktout_event_queue(odp_pktio_t pktio, odp_queue_t queues[], int num);
 
int odp_pktout_queue(odp_pktio_t pktio, odp_pktout_queue_t queues[], int num);
 
int odp_pktio_start(odp_pktio_t pktio);
 
int odp_pktio_stop(odp_pktio_t pktio);
 
int odp_pktio_close(odp_pktio_t pktio);
 
odp_pktio_t odp_pktio_lookup(const char *name);
 
int odp_pktin_recv(odp_pktin_queue_t queue, odp_packet_t packets[], int num);
 
int odp_pktin_recv_tmo(odp_pktin_queue_t queue, odp_packet_t packets[],
               int num, uint64_t wait);
 
int odp_pktin_recv_mq_tmo(const odp_pktin_queue_t queues[], uint32_t num_q, uint32_t *from,
              odp_packet_t packets[], int num, uint64_t wait);
 
uint64_t odp_pktin_wait_time(uint64_t nsec);
 
int odp_pktout_send(odp_pktout_queue_t queue, const odp_packet_t packets[],
            int num);
 
void odp_lso_profile_param_init(odp_lso_profile_param_t *param);
 
odp_lso_profile_t odp_lso_profile_create(odp_pktio_t pktio, const odp_lso_profile_param_t *param);
 
int odp_lso_profile_destroy(odp_lso_profile_t lso_profile);
 
int odp_pktout_send_lso(odp_pktout_queue_t queue, const odp_packet_t packet[], int num,
            const odp_packet_lso_opt_t *lso_opt);
 
int odp_pktio_promisc_mode_set(odp_pktio_t pktio, odp_bool_t enable);
 
int odp_pktio_promisc_mode(odp_pktio_t pktio);
 
uint32_t odp_pktin_maxlen(odp_pktio_t pktio);
 
uint32_t odp_pktout_maxlen(odp_pktio_t pktio);
 
int odp_pktio_maxlen_set(odp_pktio_t pktio, uint32_t maxlen_input,
             uint32_t maxlen_output);
 
int odp_pktio_mac_addr(odp_pktio_t pktio, void *mac_addr, int size);
 
int odp_pktio_mac_addr_set(odp_pktio_t pktio, const void *mac_addr,
               int size);
 
int odp_pktio_default_cos_set(odp_pktio_t pktio, odp_cos_t default_cos);
 
int odp_pktio_error_cos_set(odp_pktio_t pktio, odp_cos_t error_cos);
 
int odp_pktio_skip_set(odp_pktio_t pktio, uint32_t offset);
 
int odp_pktio_headroom_set(odp_pktio_t pktio, uint32_t headroom);
 
int odp_pktio_index(odp_pktio_t pktio);
 
uint64_t odp_pktio_to_u64(odp_pktio_t pktio);
 
void odp_pktio_param_init(odp_pktio_param_t *param);
 
void odp_pktin_queue_param_init(odp_pktin_queue_param_t *param);
 
void odp_pktout_queue_param_init(odp_pktout_queue_param_t *param);
 
void odp_pktio_config_init(odp_pktio_config_t *config);
 
void odp_pktio_print(odp_pktio_t pktio);
 
odp_pktio_link_status_t odp_pktio_link_status(odp_pktio_t pktio);
 
int odp_pktio_info(odp_pktio_t pktio, odp_pktio_info_t *info);
 
int odp_pktio_link_info(odp_pktio_t pktio, odp_pktio_link_info_t *info);
 
uint64_t odp_pktio_ts_res(odp_pktio_t pktio);
 
odp_time_t odp_pktio_ts_from_ns(odp_pktio_t pktio, uint64_t ns);
 
odp_time_t odp_pktio_time(odp_pktio_t pktio, odp_time_t *ts_global);
 
int odp_pktout_ts_read(odp_pktio_t pktio, odp_time_t *ts);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif