X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=drivers%2Fcrypto%2Fscheduler%2Frte_cryptodev_scheduler.h;h=88da8368ec41559247851020a33caa6b7d2eabe0;hb=cdea571becb4dabf9962455f671af0c99594e380;hp=e8d3c454bb4f999a044ad9fc3c28723471bd8437;hpb=4c07e0552f0a08ebc5eab61ee26cd4318fde8db0;p=dpdk.git diff --git a/drivers/crypto/scheduler/rte_cryptodev_scheduler.h b/drivers/crypto/scheduler/rte_cryptodev_scheduler.h index e8d3c454bb..88da8368ec 100644 --- a/drivers/crypto/scheduler/rte_cryptodev_scheduler.h +++ b/drivers/crypto/scheduler/rte_cryptodev_scheduler.h @@ -1,34 +1,5 @@ -/*- - * BSD LICENSE - * - * Copyright(c) 2017 Intel Corporation. All rights reserved. - * 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. +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2017 Intel Corporation */ #ifndef _RTE_CRYPTO_SCHEDULER_H @@ -39,9 +10,9 @@ * * RTE Cryptodev Scheduler Device * - * The RTE Cryptodev Scheduler Device allows the aggregation of multiple (slave) + * The RTE Cryptodev Scheduler Device allows the aggregation of multiple worker * Cryptodevs into a single logical crypto device, and the scheduling the - * crypto operations to the slaves based on the mode of the specified mode of + * crypto operations to the workers based on the mode of the specified mode of * operation specified and supported. This implementation supports 3 modes of * operation: round robin, packet-size based, and fail-over. */ @@ -54,12 +25,12 @@ extern "C" { #endif /** Maximum number of bonded devices per device */ -#ifndef RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES -#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES (8) +#ifndef RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS +#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS (8) #endif /** Maximum number of multi-core worker cores */ -#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKER_CORES (64) +#define RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKER_CORES (RTE_MAX_LCORE - 1) /** Round-robin scheduling mode string */ #define SCHEDULER_MODE_NAME_ROUND_ROBIN round-robin @@ -105,6 +76,7 @@ enum rte_cryptodev_schedule_option_type { /** * Threshold option structure */ +#define RTE_CRYPTODEV_SCHEDULER_PARAM_THRES "threshold" struct rte_cryptodev_scheduler_threshold_option { uint32_t threshold; /**< Threshold for packet-size mode */ }; @@ -123,6 +95,7 @@ struct rte_cryptodev_scheduler; * - 0 if the scheduler is successfully loaded * - -ENOTSUP if the operation is not supported. * - -EBUSY if device is started. + * - -EINVAL if input values are invalid. */ int rte_cryptodev_scheduler_load_user_scheduler(uint8_t scheduler_id, @@ -133,34 +106,33 @@ rte_cryptodev_scheduler_load_user_scheduler(uint8_t scheduler_id, * * @param scheduler_id * The target scheduler device ID - * @param slave_id + * @param worker_id * Crypto device ID to be attached * * @return - * - 0 if the slave is attached. + * - 0 if the worker is attached. * - -ENOTSUP if the operation is not supported. * - -EBUSY if device is started. - * - -ENOMEM if the scheduler's slave list is full. + * - -ENOMEM if the scheduler's worker list is full. */ int -rte_cryptodev_scheduler_slave_attach(uint8_t scheduler_id, uint8_t slave_id); +rte_cryptodev_scheduler_worker_attach(uint8_t scheduler_id, uint8_t worker_id); /** * Detach a crypto device from the scheduler * * @param scheduler_id * The target scheduler device ID - * @param slave_id + * @param worker_id * Crypto device ID to be detached * * @return - * - 0 if the slave is detached. + * - 0 if the worker is detached. * - -ENOTSUP if the operation is not supported. * - -EBUSY if device is started. */ int -rte_cryptodev_scheduler_slave_detach(uint8_t scheduler_id, uint8_t slave_id); - +rte_cryptodev_scheduler_worker_detach(uint8_t scheduler_id, uint8_t worker_id); /** * Set the scheduling mode @@ -226,21 +198,21 @@ int rte_cryptodev_scheduler_ordering_get(uint8_t scheduler_id); /** - * Get the the attached slaves' count and/or ID + * Get the attached workers' count and/or ID * * @param scheduler_id * The target scheduler device ID - * @param slaves - * If successful, the function will write back all slaves' device IDs to it. + * @param workers + * If successful, the function will write back all workers' device IDs to it. * This parameter will either be an uint8_t array of - * RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES elements or NULL. + * RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS elements or NULL. * * @return - * - non-negative number: the number of slaves attached + * - non-negative number: the number of workers attached * - -ENOTSUP if the operation is not supported. */ int -rte_cryptodev_scheduler_slaves_get(uint8_t scheduler_id, uint8_t *slaves); +rte_cryptodev_scheduler_workers_get(uint8_t scheduler_id, uint8_t *workers); /** * Set the mode specific option @@ -297,13 +269,13 @@ struct rte_cryptodev_scheduler { }; /** Round-robin mode scheduler */ -extern struct rte_cryptodev_scheduler *roundrobin_scheduler; +extern struct rte_cryptodev_scheduler *crypto_scheduler_roundrobin; /** Packet-size based distribution mode scheduler */ -extern struct rte_cryptodev_scheduler *pkt_size_based_distr_scheduler; +extern struct rte_cryptodev_scheduler *crypto_scheduler_pkt_size_based_distr; /** Fail-over mode scheduler */ -extern struct rte_cryptodev_scheduler *failover_scheduler; +extern struct rte_cryptodev_scheduler *crypto_scheduler_failover; /** multi-core mode scheduler */ -extern struct rte_cryptodev_scheduler *multicore_scheduler; +extern struct rte_cryptodev_scheduler *crypto_scheduler_multicore; #ifdef __cplusplus }