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         /** fail-over mode */
  53         CDEV_SCHED_MODE_FAILOVER,
  54
  55         CDEV_SCHED_MODE_COUNT /* number of modes */
  56 };
  57
  58 #define RTE_CRYPTODEV_SCHEDULER_NAME_MAX_LEN    (64)
  59 #define RTE_CRYPTODEV_SCHEDULER_DESC_MAX_LEN    (256)
  60
  61 struct rte_cryptodev_scheduler;
  62
  63 /**
  64  * Load a user defined scheduler
  65  *
  66  * @param       scheduler_id    The target scheduler device ID
  67  *              scheduler       Pointer to the user defined scheduler
  68  *
  69  * @return
  70  *      0 if loading successful, negative integer if otherwise.
  71  */
  72 int
  73 rte_cryptodev_scheduler_load_user_scheduler(uint8_t scheduler_id,
  74                 struct rte_cryptodev_scheduler *scheduler);
  75
  76 /**
  77  * Attach a pre-configured crypto device to the scheduler
  78  *
  79  * @param       scheduler_id    The target scheduler device ID
  80  *              slave_id        crypto device ID to be attached
  81  *
  82  * @return
  83  *      0 if attaching successful, negative int if otherwise.
  84  */
  85 int
  86 rte_cryptodev_scheduler_slave_attach(uint8_t scheduler_id, uint8_t slave_id);
  87
  88 /**
  89  * Detach a attached crypto device to the scheduler
  90  *
  91  * @param       scheduler_id    The target scheduler device ID
  92  *              slave_id        crypto device ID to be detached
  93  *
  94  * @return
  95  *      0 if detaching successful, negative int if otherwise.
  96  */
  97 int
  98 rte_cryptodev_scheduler_slave_detach(uint8_t scheduler_id, uint8_t slave_id);
  99
 100 /**
 101  * Set the scheduling mode
 102  *
 103  * @param       scheduler_id    The target scheduler device ID
 104  *              mode            The scheduling mode
 105  *
 106  * @return
 107  *      0 if attaching successful, negative integer if otherwise.
 108  */
 109 int
 110 rte_crpytodev_scheduler_mode_set(uint8_t scheduler_id,
 111                 enum rte_cryptodev_scheduler_mode mode);
 112
 113 /**
 114  * Get the current scheduling mode
 115  *
 116  * @param       scheduler_id    The target scheduler device ID
 117  *              mode            Pointer to write the scheduling mode
 118  */
 119 enum rte_cryptodev_scheduler_mode
 120 rte_crpytodev_scheduler_mode_get(uint8_t scheduler_id);
 121
 122 /**
 123  * Set the crypto ops reordering feature on/off
 124  *
 125  * @param       dev_id          The target scheduler device ID
 126  *              enable_reorder  set the crypto op reordering feature
 127  *                              0: disable reordering
 128  *                              1: enable reordering
 129  *
 130  * @return
 131  *      0 if setting successful, negative integer if otherwise.
 132  */
 133 int
 134 rte_cryptodev_scheduler_ordering_set(uint8_t scheduler_id,
 135                 uint32_t enable_reorder);
 136
 137 /**
 138  * Get the current crypto ops reordering feature
 139  *
 140  * @param       dev_id          The target scheduler device ID
 141  *
 142  * @return
 143  *      0 if reordering is disabled
 144  *      1 if reordering is enabled
 145  *      negative integer if otherwise.
 146  */
 147 int
 148 rte_cryptodev_scheduler_ordering_get(uint8_t scheduler_id);
 149
 150 typedef uint16_t (*rte_cryptodev_scheduler_burst_enqueue_t)(void *qp_ctx,
 151                 struct rte_crypto_op **ops, uint16_t nb_ops);
 152
 153 typedef uint16_t (*rte_cryptodev_scheduler_burst_dequeue_t)(void *qp_ctx,
 154                 struct rte_crypto_op **ops, uint16_t nb_ops);
 155
 156 struct rte_cryptodev_scheduler {
 157         const char *name;
 158         const char *description;
 159         enum rte_cryptodev_scheduler_mode mode;
 160
 161         struct rte_cryptodev_scheduler_ops *ops;
 162 };
 163
 164 extern struct rte_cryptodev_scheduler *roundrobin_scheduler;
 165 extern struct rte_cryptodev_scheduler *pkt_size_based_distr_scheduler;
 166 extern struct rte_cryptodev_scheduler *failover_scheduler;
 167
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171 #endif /* _RTE_CRYPTO_SCHEDULER_H */