rte_pdcp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(C) 2023 Marvell.
 */

#ifndef RTE_PDCP_H
#define RTE_PDCP_H

#include <rte_compat.h>
#include <rte_common.h>
#include <rte_mempool.h>
#include <rte_pdcp_hdr.h>
#include <rte_security.h>

/* Forward declarations. */
struct rte_pdcp_entity;

/* PDCP pre-process function based on entity configuration. */
typedef uint16_t (*rte_pdcp_pre_p_t)(const struct rte_pdcp_entity *entity,
                     struct rte_mbuf *mb[],
                     struct rte_crypto_op *cop[],
                     uint16_t num, uint16_t *nb_err);

/* PDCP post-process function based on entity configuration. */
typedef uint16_t (*rte_pdcp_post_p_t)(const struct rte_pdcp_entity *entity,
                      struct rte_mbuf *in_mb[],
                      struct rte_mbuf *out_mb[],
                      uint16_t num, uint16_t *nb_err);

struct __rte_cache_aligned rte_pdcp_entity {
    rte_pdcp_pre_p_t pre_process;
    rte_pdcp_post_p_t post_process;
    uint32_t max_pkt_cache;
};

typedef void (*rte_pdcp_t_reordering_start_cb_t)(void *timer, void *args);

typedef void (*rte_pdcp_t_reordering_stop_cb_t)(void *timer, void *args);

/* Structure rte_pdcp_t_reordering 8< */
struct rte_pdcp_t_reordering {
    void *timer;
    void *args;
    rte_pdcp_t_reordering_start_cb_t start;
    rte_pdcp_t_reordering_stop_cb_t stop;
};
/* >8 End of structure rte_pdcp_t_reordering. */

/* Structure rte_pdcp_entity_conf 8< */
struct rte_pdcp_entity_conf {
    struct rte_security_pdcp_xform pdcp_xfrm;
    struct rte_crypto_sym_xform *crypto_xfrm;
    struct rte_mempool *sess_mpool;
    struct rte_mempool *cop_pool;
    struct rte_mempool *ctrl_pdu_pool;
    uint32_t sn;
    bool is_slrb;
    bool en_sec_offload;
    uint8_t dev_id;
    bool reverse_iv_direction;
    bool status_report_required;
    bool out_of_order_delivery;
    struct rte_pdcp_t_reordering t_reordering;
};
/* >8 End of structure rte_pdcp_entity_conf. */

__rte_experimental
struct rte_pdcp_entity *
rte_pdcp_entity_establish(const struct rte_pdcp_entity_conf *conf);

__rte_experimental
int
rte_pdcp_entity_release(struct rte_pdcp_entity *pdcp_entity,
            struct rte_mbuf *out_mb[]);

__rte_experimental
int
rte_pdcp_entity_suspend(struct rte_pdcp_entity *pdcp_entity,
            struct rte_mbuf *out_mb[]);

__rte_experimental
struct rte_mbuf *
rte_pdcp_control_pdu_create(struct rte_pdcp_entity *pdcp_entity,
                enum rte_pdcp_ctrl_pdu_type type);

__rte_experimental
static inline uint16_t
rte_pdcp_pkt_pre_process(const struct rte_pdcp_entity *entity,
             struct rte_mbuf *mb[], struct rte_crypto_op *cop[],
             uint16_t num, uint16_t *nb_err)
{
    return entity->pre_process(entity, mb, cop, num, nb_err);
}

__rte_experimental
static inline uint16_t
rte_pdcp_pkt_post_process(const struct rte_pdcp_entity *entity,
              struct rte_mbuf *in_mb[],
              struct rte_mbuf *out_mb[],
              uint16_t num, uint16_t *nb_err)
{
    return entity->post_process(entity, in_mb, out_mb, num, nb_err);
}

__rte_experimental
uint16_t
rte_pdcp_t_reordering_expiry_handle(const struct rte_pdcp_entity *entity,
                    struct rte_mbuf *out_mb[]);

#include <rte_pdcp_group.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __cplusplus
}
#endif

#endif /* RTE_PDCP_H */