drivers/crypto/scheduler/rte_cryptodev_scheduler.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_CRYPTO_SCHEDULER_H
  35 #define _RTE_CRYPTO_SCHEDULER_H
  36
  37 #include "rte_cryptodev_scheduler_operations.h"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /**
  44  * Crypto scheduler PMD operation modes
  45  */
  46 enum rte_cryptodev_scheduler_mode {
  47         CDEV_SCHED_MODE_NOT_SET = 0,
  48         CDEV_SCHED_MODE_USERDEFINED,
  49         CDEV_SCHED_MODE_ROUNDROBIN,
  50         /** packet-size based distribution mode */
  51         CDEV_SCHED_MODE_PKT_SIZE_DISTR,
  52
  53         CDEV_SCHED_MODE_COUNT /* number of modes */
  54 };
  55
  56 #define RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN    (64)
  57 #define RTE_CRYPTODEV_SCHEDULER_DESC_MAX_LEN    (256)
  58
  59 struct rte_cryptodev_scheduler;
  60
  61 /**
  62  * Load a user defined scheduler
  63  *
  64  * @param       scheduler_id    The target scheduler device ID
  65  *              scheduler       Pointer to the user defined scheduler
  66  *
  67  * @return
  68  *      0 if loading successful, negative integer if otherwise.
  69  */
  70 int
  71 rte_cryptodev_scheduler_load_user_scheduler(uint8_t scheduler_id,
  72                 struct rte_cryptodev_scheduler *scheduler);
  73
  74 /**
  75  * Attach a pre-configured crypto device to the scheduler
  76  *
  77  * @param       scheduler_id    The target scheduler device ID
  78  *              slave_id        crypto device ID to be attached
  79  *
  80  * @return
  81  *      0 if attaching successful, negative int if otherwise.
  82  */
  83 int
  84 rte_cryptodev_scheduler_slave_attach(uint8_t scheduler_id, uint8_t slave_id);
  85
  86 /**
  87  * Detach a attached crypto device to the scheduler
  88  *
  89  * @param       scheduler_id    The target scheduler device ID
  90  *              slave_id        crypto device ID to be detached
  91  *
  92  * @return
  93  *      0 if detaching successful, negative int if otherwise.
  94  */
  95 int
  96 rte_cryptodev_scheduler_slave_detach(uint8_t scheduler_id, uint8_t slave_id);
  97
  98 /**
  99  * Set the scheduling mode
 100  *
 101  * @param       scheduler_id    The target scheduler device ID
 102  *              mode            The scheduling mode
 103  *
 104  * @return
 105  *      0 if attaching successful, negative integer if otherwise.
 106  */
 107 int
 108 rte_crpytodev_scheduler_mode_set(uint8_t scheduler_id,
 109                 enum rte_cryptodev_scheduler_mode mode);
 110
 111 /**
 112  * Get the current scheduling mode
 113  *
 114  * @param       scheduler_id    The target scheduler device ID
 115  *              mode            Pointer to write the scheduling mode
 116  */
 117 enum rte_cryptodev_scheduler_mode
 118 rte_crpytodev_scheduler_mode_get(uint8_t scheduler_id);
 119
 120 /**
 121  * Set the crypto ops reordering feature on/off
 122  *
 123  * @param       dev_id          The target scheduler device ID
 124  *              enable_reorder  set the crypto op reordering feature
 125  *                              0: disable reordering
 126  *                              1: enable reordering
 127  *
 128  * @return
 129  *      0 if setting successful, negative integer if otherwise.
 130  */
 131 int
 132 rte_cryptodev_scheduler_ordering_set(uint8_t scheduler_id,
 133                 uint32_t enable_reorder);
 134
 135 /**
 136  * Get the current crypto ops reordering feature
 137  *
 138  * @param       dev_id          The target scheduler device ID
 139  *
 140  * @return
 141  *      0 if reordering is disabled
 142  *      1 if reordering is enabled
 143  *      negative integer if otherwise.
 144  */
 145 int
 146 rte_cryptodev_scheduler_ordering_get(uint8_t scheduler_id);
 147
 148 typedef uint16_t (*rte_cryptodev_scheduler_burst_enqueue_t)(void *qp_ctx,
 149                 struct rte_crypto_op **ops, uint16_t nb_ops);
 150
 151 typedef uint16_t (*rte_cryptodev_scheduler_burst_dequeue_t)(void *qp_ctx,
 152                 struct rte_crypto_op **ops, uint16_t nb_ops);
 153
 154 struct rte_cryptodev_scheduler {
 155         const char *name;
 156         const char *description;
 157         enum rte_cryptodev_scheduler_mode mode;
 158
 159         struct rte_cryptodev_scheduler_ops *ops;
 160 };
 161
 162 extern struct rte_cryptodev_scheduler *roundrobin_scheduler;
 163 extern struct rte_cryptodev_scheduler *pkt_size_based_distr_scheduler;
 164
 165 #ifdef __cplusplus
 166 }
 167 #endif
 168 #endif /* _RTE_CRYPTO_SCHEDULER_H */