rte_cryptodev_pmd.h

Go to the documentation of this file.

/*-
 *
 *   Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_CRYPTODEV_PMD_H_
#define _RTE_CRYPTODEV_PMD_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <string.h>

#include <rte_config.h>
#include <rte_dev.h>
#include <rte_malloc.h>
#include <rte_mbuf.h>
#include <rte_mempool.h>
#include <rte_log.h>
#include <rte_common.h>

#include "rte_crypto.h"
#include "rte_cryptodev.h"


#define RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS    8
#define RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS   2048

#define RTE_CRYPTODEV_PMD_NAME_ARG          ("name")
#define RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG         ("max_nb_queue_pairs")
#define RTE_CRYPTODEV_PMD_MAX_NB_SESS_ARG       ("max_nb_sessions")
#define RTE_CRYPTODEV_PMD_SOCKET_ID_ARG         ("socket_id")


static const char * const cryptodev_pmd_valid_params[] = {
    RTE_CRYPTODEV_PMD_NAME_ARG,
    RTE_CRYPTODEV_PMD_MAX_NB_QP_ARG,
    RTE_CRYPTODEV_PMD_MAX_NB_SESS_ARG,
    RTE_CRYPTODEV_PMD_SOCKET_ID_ARG
};

struct rte_cryptodev_pmd_init_params {
    char name[RTE_CRYPTODEV_NAME_MAX_LEN];
    size_t private_data_size;
    int socket_id;
    unsigned int max_nb_queue_pairs;
    unsigned int max_nb_sessions;
};

struct rte_cryptodev_global {
    struct rte_cryptodev *devs; 
    struct rte_cryptodev_data *data[RTE_CRYPTO_MAX_DEVS];
    uint8_t nb_devs;        
};

/* Cryptodev driver, containing the driver ID */
struct cryptodev_driver {
    TAILQ_ENTRY(cryptodev_driver) next; 
    const struct rte_driver *driver;
    uint8_t id;
};

extern struct rte_cryptodev_global *rte_cryptodev_globals;

struct rte_cryptodev *
rte_cryptodev_pmd_get_dev(uint8_t dev_id);

struct rte_cryptodev *
rte_cryptodev_pmd_get_named_dev(const char *name);

unsigned int
rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id);

extern struct rte_cryptodev *rte_cryptodevs;


typedef int (*cryptodev_configure_t)(struct rte_cryptodev *dev,
        struct rte_cryptodev_config *config);

typedef int (*cryptodev_start_t)(struct rte_cryptodev *dev);

typedef void (*cryptodev_stop_t)(struct rte_cryptodev *dev);

typedef int (*cryptodev_close_t)(struct rte_cryptodev *dev);


typedef void (*cryptodev_stats_get_t)(struct rte_cryptodev *dev,
                struct rte_cryptodev_stats *stats);


typedef void (*cryptodev_stats_reset_t)(struct rte_cryptodev *dev);


typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
                struct rte_cryptodev_info *dev_info);

typedef int (*cryptodev_queue_pair_start_t)(struct rte_cryptodev *dev,
                uint16_t qp_id);

typedef int (*cryptodev_queue_pair_stop_t)(struct rte_cryptodev *dev,
                uint16_t qp_id);

typedef int (*cryptodev_queue_pair_setup_t)(struct rte_cryptodev *dev,
        uint16_t qp_id, const struct rte_cryptodev_qp_conf *qp_conf,
        int socket_id, struct rte_mempool *session_pool);

typedef int (*cryptodev_queue_pair_release_t)(struct rte_cryptodev *dev,
        uint16_t qp_id);

typedef uint32_t (*cryptodev_queue_pair_count_t)(struct rte_cryptodev *dev);

typedef int (*cryptodev_sym_create_session_pool_t)(
        struct rte_cryptodev *dev, unsigned nb_objs,
        unsigned obj_cache_size, int socket_id);


typedef unsigned (*cryptodev_sym_get_session_private_size_t)(
        struct rte_cryptodev *dev);

typedef int (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
        struct rte_crypto_sym_xform *xform,
        struct rte_cryptodev_sym_session *session,
        struct rte_mempool *mp);

typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
        struct rte_cryptodev_sym_session *sess);

typedef int (*cryptodev_sym_queue_pair_attach_session_t)(
          struct rte_cryptodev *dev,
          uint16_t qp_id,
          void *session_private);

typedef int (*cryptodev_sym_queue_pair_detach_session_t)(
          struct rte_cryptodev *dev,
          uint16_t qp_id,
          void *session_private);

struct rte_cryptodev_ops {
    cryptodev_configure_t dev_configure;    
    cryptodev_start_t dev_start;        
    cryptodev_stop_t dev_stop;      
    cryptodev_close_t dev_close;        
    cryptodev_info_get_t dev_infos_get; 
    cryptodev_stats_get_t stats_get;
    cryptodev_stats_reset_t stats_reset;
    cryptodev_queue_pair_setup_t queue_pair_setup;
    cryptodev_queue_pair_release_t queue_pair_release;
    cryptodev_queue_pair_start_t queue_pair_start;
    cryptodev_queue_pair_stop_t queue_pair_stop;
    cryptodev_queue_pair_count_t queue_pair_count;
    cryptodev_sym_get_session_private_size_t session_get_size;
    cryptodev_sym_configure_session_t session_configure;
    cryptodev_sym_free_session_t session_clear;
    cryptodev_sym_queue_pair_attach_session_t qp_attach_session;
    cryptodev_sym_queue_pair_detach_session_t qp_detach_session;
};


struct rte_cryptodev *
rte_cryptodev_pmd_allocate(const char *name, int socket_id);

extern int
rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev);


int
rte_cryptodev_pmd_parse_input_args(
        struct rte_cryptodev_pmd_init_params *params,
        const char *args);

struct rte_cryptodev *
rte_cryptodev_pmd_create(const char *name,
        struct rte_device *device,
        struct rte_cryptodev_pmd_init_params *params);

int
rte_cryptodev_pmd_destroy(struct rte_cryptodev *cryptodev);

void rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
                enum rte_cryptodev_event_type event);

int
rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix);

uint8_t rte_cryptodev_allocate_driver(struct cryptodev_driver *crypto_drv,
        const struct rte_driver *drv);


#define RTE_PMD_REGISTER_CRYPTO_DRIVER(crypto_drv, drv, driver_id)\
RTE_INIT(init_ ##driver_id);\
static void init_ ##driver_id(void)\
{\
    driver_id = rte_cryptodev_allocate_driver(&crypto_drv, &(drv).driver);\
}

static inline void *
get_session_private_data(const struct rte_cryptodev_sym_session *sess,
        uint8_t driver_id) {
    return sess->sess_private_data[driver_id];
}

static inline void
set_session_private_data(struct rte_cryptodev_sym_session *sess,
        uint8_t driver_id, void *private_data)
{
    sess->sess_private_data[driver_id] = private_data;
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_CRYPTODEV_PMD_H_ */