rte_security_driver.h

Go to the documentation of this file.

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

#ifndef _RTE_SECURITY_DRIVER_H_
#define _RTE_SECURITY_DRIVER_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <rte_compat.h>
#include "rte_security.h"

struct rte_security_session {
    RTE_MARKER cacheline0;
    uint64_t opaque_data;
    uint64_t fast_mdata;
    rte_iova_t driver_priv_data_iova;
    alignas(RTE_CACHE_LINE_MIN_SIZE) RTE_MARKER cacheline1;
    uint8_t driver_priv_data[];
};

struct rte_security_ctx {
    void *device;
    const struct rte_security_ops *ops;
    uint32_t flags;
    uint16_t sess_cnt;
    uint16_t macsec_sc_cnt;
    uint16_t macsec_sa_cnt;
};

#define SECURITY_GET_SESS_PRIV(s) \
    ((void *)(((struct rte_security_session *)s)->driver_priv_data))
#define SECURITY_GET_SESS_PRIV_IOVA(s) \
    (((struct rte_security_session *)s)->driver_priv_data_iova)

typedef int (*security_session_create_t)(void *device,
        struct rte_security_session_conf *conf,
        struct rte_security_session *sess);

typedef int (*security_session_destroy_t)(void *device,
        struct rte_security_session *sess);

typedef int (*security_session_update_t)(void *device,
        struct rte_security_session *sess,
        struct rte_security_session_conf *conf);

typedef int (*security_macsec_sc_create_t)(void *device, struct rte_security_macsec_sc *conf);

typedef int (*security_macsec_sc_destroy_t)(void *device, uint16_t sc_id,
        enum rte_security_macsec_direction dir);

typedef int (*security_macsec_sa_create_t)(void *device, struct rte_security_macsec_sa *conf);

typedef int (*security_macsec_sa_destroy_t)(void *device, uint16_t sa_id,
        enum rte_security_macsec_direction dir);

typedef unsigned int (*security_session_get_size)(void *device);

typedef int (*security_session_stats_get_t)(void *device,
        struct rte_security_session *sess,
        struct rte_security_stats *stats);

typedef int (*security_macsec_sc_stats_get_t)(void *device, uint16_t sc_id,
        enum rte_security_macsec_direction dir,
        struct rte_security_macsec_sc_stats *stats);

typedef int (*security_macsec_sa_stats_get_t)(void *device, uint16_t sa_id,
        enum rte_security_macsec_direction dir,
        struct rte_security_macsec_sa_stats *stats);



__rte_internal
int rte_security_dynfield_register(void);

__rte_internal
int rte_security_oop_dynfield_register(void);

typedef int (*security_set_pkt_metadata_t)(void *device,
        struct rte_security_session *sess, struct rte_mbuf *mb,
        void *params);

typedef const struct rte_security_capability *(*security_capabilities_get_t)(
        void *device);

typedef int (*security_rx_inject_configure)(void *device, uint16_t port_id, bool enable);

typedef uint16_t (*security_inb_pkt_rx_inject)(void *device,
        struct rte_mbuf **pkts, struct rte_security_session **sess,
        uint16_t nb_pkts);

struct rte_security_ops {
    security_session_create_t session_create;
    security_session_update_t session_update;
    security_session_get_size session_get_size;
    security_session_stats_get_t session_stats_get;
    security_session_destroy_t session_destroy;
    security_set_pkt_metadata_t set_pkt_metadata;
    security_capabilities_get_t capabilities_get;
    security_macsec_sc_create_t macsec_sc_create;
    security_macsec_sc_destroy_t macsec_sc_destroy;
    security_macsec_sa_create_t macsec_sa_create;
    security_macsec_sa_destroy_t macsec_sa_destroy;
    security_macsec_sc_stats_get_t macsec_sc_stats_get;
    security_macsec_sa_stats_get_t macsec_sa_stats_get;
    security_rx_inject_configure rx_inject_configure;
    security_inb_pkt_rx_inject inb_pkt_rx_inject;
};

#ifdef __cplusplus
}
#endif

#endif /* _RTE_SECURITY_DRIVER_H_ */