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_dev.h>
#include <rte_pci.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"

struct rte_cryptodev_session {
    RTE_STD_C11
    struct {
        uint8_t dev_id;
        enum rte_cryptodev_type type;
        struct rte_mempool *mp;
    } __rte_aligned(8);

    __extension__ char _private[0];
};

struct rte_cryptodev_driver;

typedef int (*cryptodev_init_t)(struct rte_cryptodev_driver *drv,
        struct rte_cryptodev *dev);

typedef int (*cryptodev_uninit_t)(const struct rte_cryptodev_driver  *drv,
                struct rte_cryptodev *dev);

struct rte_cryptodev_driver {
    struct rte_pci_driver pci_drv;  
    unsigned dev_private_size;  
    cryptodev_init_t cryptodev_init;    
    cryptodev_uninit_t cryptodev_uninit;    
};


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

extern struct rte_cryptodev_global *rte_cryptodev_globals;

static inline struct rte_cryptodev *
rte_cryptodev_pmd_get_dev(uint8_t dev_id)
{
    return &rte_cryptodev_globals->devs[dev_id];
}

static inline struct rte_cryptodev *
rte_cryptodev_pmd_get_named_dev(const char *name)
{
    struct rte_cryptodev *dev;
    unsigned i;

    if (name == NULL)
        return NULL;

    for (i = 0; i < rte_cryptodev_globals->max_devs; i++) {
        dev = &rte_cryptodev_globals->devs[i];

        if ((dev->attached == RTE_CRYPTODEV_ATTACHED) &&
                (strcmp(dev->data->name, name) == 0))
            return dev;
    }

    return NULL;
}

static inline unsigned
rte_cryptodev_pmd_is_valid_dev(uint8_t dev_id)
{
    struct rte_cryptodev *dev = NULL;

    if (dev_id >= rte_cryptodev_globals->nb_devs)
        return 0;

    dev = rte_cryptodev_pmd_get_dev(dev_id);
    if (dev->attached != RTE_CRYPTODEV_ATTACHED)
        return 0;
    else
        return 1;
}

extern struct rte_cryptodev *rte_cryptodevs;


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

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);

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 void (*cryptodev_sym_initialize_session_t)(struct rte_mempool *mempool,
        void *session_private);

typedef void * (*cryptodev_sym_configure_session_t)(struct rte_cryptodev *dev,
        struct rte_crypto_sym_xform *xform, void *session_private);

typedef void (*cryptodev_sym_free_session_t)(struct rte_cryptodev *dev,
        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_initialize_session_t session_initialize;
    cryptodev_sym_configure_session_t session_configure;
    cryptodev_sym_free_session_t session_clear;
};


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

struct rte_cryptodev *
rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
        int socket_id);


extern int
rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev);

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

int rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
                struct rte_pci_device *pci_dev);

int rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_CRYPTODEV_PMD_H_ */