lib/librte_cryptodev/rte_cryptodev_vdev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Intel Corporation. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of the copyright holder nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef _RTE_CRYPTODEV_VDEV_H_
  34 #define _RTE_CRYPTODEV_VDEV_H_
  35
  36 #include <rte_vdev.h>
  37 #include <inttypes.h>
  38
  39 #include "rte_cryptodev.h"
  40
  41 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS   8
  42 #define RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS      2048
  43
  44 #define RTE_CRYPTODEV_VDEV_NAME                         ("name")
  45 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG                ("max_nb_queue_pairs")
  46 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG              ("max_nb_sessions")
  47 #define RTE_CRYPTODEV_VDEV_SOCKET_ID                    ("socket_id")
  48
  49 static const char * const cryptodev_vdev_valid_params[] = {
  50         RTE_CRYPTODEV_VDEV_NAME,
  51         RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
  52         RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
  53         RTE_CRYPTODEV_VDEV_SOCKET_ID
  54 };
  55
  56 /**
  57  * @internal
  58  * Initialisation parameters for virtual crypto devices
  59  */
  60 struct rte_crypto_vdev_init_params {
  61         unsigned int max_nb_queue_pairs;
  62         unsigned int max_nb_sessions;
  63         uint8_t socket_id;
  64         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
  65 };
  66
  67 /**
  68  * @internal
  69  * Creates a new virtual crypto device and returns the pointer
  70  * to that device.
  71  *
  72  * @param       name                    PMD type name
  73  * @param       dev_private_size        Size of crypto PMDs private data
  74  * @param       socket_id               Socket to allocate resources on.
  75  * @param       vdev                    Pointer to virtual device structure.
  76  *
  77  * @return
  78  *   - Cryptodev pointer if device is successfully created.
  79  *   - NULL if device cannot be created.
  80  */
  81 struct rte_cryptodev *
  82 rte_cryptodev_vdev_pmd_init(const char *name, size_t dev_private_size,
  83                 int socket_id, struct rte_vdev_device *vdev);
  84
  85 /**
  86  * @internal
  87  * Parse virtual device initialisation parameters input arguments
  88  *
  89  * @params      params          Initialisation parameters with defaults set.
  90  * @params      input_args      Command line arguments
  91  *
  92  * @return
  93  * 0 on successful parse
  94  * <0 on failure to parse
  95  */
  96 int
  97 rte_cryptodev_vdev_parse_init_params(struct rte_crypto_vdev_init_params *params,
  98                 const char *input_args);
  99
 100 #endif /* _RTE_CRYPTODEV_VDEV_H_ */