1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2015-2020 Intel Corporation. 3 */ 4 5 #ifndef _RTE_CRYPTODEV_H_ 6 #define _RTE_CRYPTODEV_H_ 7 8 /** 9 * @file rte_cryptodev.h 10 * 11 * RTE Cryptographic Device APIs 12 * 13 * Defines RTE Crypto Device APIs for the provisioning of cipher and 14 * authentication operations. 15 */ 16 17 #ifdef __cplusplus 18 extern "C" { 19 #endif 20 21 #include "rte_kvargs.h" 22 #include "rte_crypto.h" 23 #include "rte_dev.h" 24 #include <rte_common.h> 25 #include <rte_config.h> 26 #include <rte_rcu_qsbr.h> 27 28 #include "rte_cryptodev_trace_fp.h" 29 30 extern const char **rte_cyptodev_names; 31 32 /* Logging Macros */ 33 34 #define CDEV_LOG_ERR(...) \ 35 RTE_LOG(ERR, CRYPTODEV, \ 36 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ 37 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,))) 38 39 #define CDEV_LOG_INFO(...) \ 40 RTE_LOG(INFO, CRYPTODEV, \ 41 RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ 42 RTE_FMT_TAIL(__VA_ARGS__,))) 43 44 #define CDEV_LOG_DEBUG(...) \ 45 RTE_LOG(DEBUG, CRYPTODEV, \ 46 RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ 47 __func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,))) 48 49 #define CDEV_PMD_TRACE(...) \ 50 RTE_LOG(DEBUG, CRYPTODEV, \ 51 RTE_FMT("[%s] %s: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ 52 dev, __func__, RTE_FMT_TAIL(__VA_ARGS__,))) 53 54 /** 55 * A macro that points to an offset from the start 56 * of the crypto operation structure (rte_crypto_op) 57 * 58 * The returned pointer is cast to type t. 59 * 60 * @param c 61 * The crypto operation. 62 * @param o 63 * The offset from the start of the crypto operation. 64 * @param t 65 * The type to cast the result into. 66 */ 67 #define rte_crypto_op_ctod_offset(c, t, o) \ 68 ((t)((char *)(c) + (o))) 69 70 /** 71 * A macro that returns the physical address that points 72 * to an offset from the start of the crypto operation 73 * (rte_crypto_op) 74 * 75 * @param c 76 * The crypto operation. 77 * @param o 78 * The offset from the start of the crypto operation 79 * to calculate address from. 80 */ 81 #define rte_crypto_op_ctophys_offset(c, o) \ 82 (rte_iova_t)((c)->phys_addr + (o)) 83 84 /** 85 * Crypto parameters range description 86 */ 87 struct rte_crypto_param_range { 88 uint16_t min; /**< minimum size */ 89 uint16_t max; /**< maximum size */ 90 uint16_t increment; 91 /**< if a range of sizes are supported, 92 * this parameter is used to indicate 93 * increments in byte size that are supported 94 * between the minimum and maximum 95 */ 96 }; 97 98 /** 99 * Data-unit supported lengths of cipher algorithms. 100 * A bit can represent any set of data-unit sizes 101 * (single size, multiple size, range, etc). 102 */ 103 #define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_512_BYTES RTE_BIT32(0) 104 #define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_4096_BYTES RTE_BIT32(1) 105 #define RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_1_MEGABYTES RTE_BIT32(2) 106 107 /** 108 * Symmetric Crypto Capability 109 */ 110 struct rte_cryptodev_symmetric_capability { 111 enum rte_crypto_sym_xform_type xform_type; 112 /**< Transform type : Authentication / Cipher / AEAD */ 113 RTE_STD_C11 114 union { 115 struct { 116 enum rte_crypto_auth_algorithm algo; 117 /**< authentication algorithm */ 118 uint16_t block_size; 119 /**< algorithm block size */ 120 struct rte_crypto_param_range key_size; 121 /**< auth key size range */ 122 struct rte_crypto_param_range digest_size; 123 /**< digest size range */ 124 struct rte_crypto_param_range aad_size; 125 /**< Additional authentication data size range */ 126 struct rte_crypto_param_range iv_size; 127 /**< Initialisation vector data size range */ 128 } auth; 129 /**< Symmetric Authentication transform capabilities */ 130 struct { 131 enum rte_crypto_cipher_algorithm algo; 132 /**< cipher algorithm */ 133 uint16_t block_size; 134 /**< algorithm block size */ 135 struct rte_crypto_param_range key_size; 136 /**< cipher key size range */ 137 struct rte_crypto_param_range iv_size; 138 /**< Initialisation vector data size range */ 139 uint32_t dataunit_set; 140 /**< 141 * Supported data-unit lengths: 142 * RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_* bits 143 * or 0 for lengths defined in the algorithm standard. 144 */ 145 } cipher; 146 /**< Symmetric Cipher transform capabilities */ 147 struct { 148 enum rte_crypto_aead_algorithm algo; 149 /**< AEAD algorithm */ 150 uint16_t block_size; 151 /**< algorithm block size */ 152 struct rte_crypto_param_range key_size; 153 /**< AEAD key size range */ 154 struct rte_crypto_param_range digest_size; 155 /**< digest size range */ 156 struct rte_crypto_param_range aad_size; 157 /**< Additional authentication data size range */ 158 struct rte_crypto_param_range iv_size; 159 /**< Initialisation vector data size range */ 160 } aead; 161 }; 162 }; 163 164 /** 165 * Asymmetric Xform Crypto Capability 166 * 167 */ 168 struct rte_cryptodev_asymmetric_xform_capability { 169 enum rte_crypto_asym_xform_type xform_type; 170 /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */ 171 172 uint32_t op_types; 173 /**< bitmask for supported rte_crypto_asym_op_type */ 174 175 __extension__ 176 union { 177 struct rte_crypto_param_range modlen; 178 /**< Range of modulus length supported by modulus based xform. 179 * Value 0 mean implementation default 180 */ 181 }; 182 }; 183 184 /** 185 * Asymmetric Crypto Capability 186 * 187 */ 188 struct rte_cryptodev_asymmetric_capability { 189 struct rte_cryptodev_asymmetric_xform_capability xform_capa; 190 }; 191 192 193 /** Structure used to capture a capability of a crypto device */ 194 struct rte_cryptodev_capabilities { 195 enum rte_crypto_op_type op; 196 /**< Operation type */ 197 198 RTE_STD_C11 199 union { 200 struct rte_cryptodev_symmetric_capability sym; 201 /**< Symmetric operation capability parameters */ 202 struct rte_cryptodev_asymmetric_capability asym; 203 /**< Asymmetric operation capability parameters */ 204 }; 205 }; 206 207 /** Structure used to describe crypto algorithms */ 208 struct rte_cryptodev_sym_capability_idx { 209 enum rte_crypto_sym_xform_type type; 210 union { 211 enum rte_crypto_cipher_algorithm cipher; 212 enum rte_crypto_auth_algorithm auth; 213 enum rte_crypto_aead_algorithm aead; 214 } algo; 215 }; 216 217 /** 218 * Structure used to describe asymmetric crypto xforms 219 * Each xform maps to one asym algorithm. 220 * 221 */ 222 struct rte_cryptodev_asym_capability_idx { 223 enum rte_crypto_asym_xform_type type; 224 /**< Asymmetric xform (algo) type */ 225 }; 226 227 /** 228 * Provide capabilities available for defined device and algorithm 229 * 230 * @param dev_id The identifier of the device. 231 * @param idx Description of crypto algorithms. 232 * 233 * @return 234 * - Return description of the symmetric crypto capability if exist. 235 * - Return NULL if the capability not exist. 236 */ 237 const struct rte_cryptodev_symmetric_capability * 238 rte_cryptodev_sym_capability_get(uint8_t dev_id, 239 const struct rte_cryptodev_sym_capability_idx *idx); 240 241 /** 242 * Provide capabilities available for defined device and xform 243 * 244 * @param dev_id The identifier of the device. 245 * @param idx Description of asym crypto xform. 246 * 247 * @return 248 * - Return description of the asymmetric crypto capability if exist. 249 * - Return NULL if the capability not exist. 250 */ 251 __rte_experimental 252 const struct rte_cryptodev_asymmetric_xform_capability * 253 rte_cryptodev_asym_capability_get(uint8_t dev_id, 254 const struct rte_cryptodev_asym_capability_idx *idx); 255 256 /** 257 * Check if key size and initial vector are supported 258 * in crypto cipher capability 259 * 260 * @param capability Description of the symmetric crypto capability. 261 * @param key_size Cipher key size. 262 * @param iv_size Cipher initial vector size. 263 * 264 * @return 265 * - Return 0 if the parameters are in range of the capability. 266 * - Return -1 if the parameters are out of range of the capability. 267 */ 268 int 269 rte_cryptodev_sym_capability_check_cipher( 270 const struct rte_cryptodev_symmetric_capability *capability, 271 uint16_t key_size, uint16_t iv_size); 272 273 /** 274 * Check if key size and initial vector are supported 275 * in crypto auth capability 276 * 277 * @param capability Description of the symmetric crypto capability. 278 * @param key_size Auth key size. 279 * @param digest_size Auth digest size. 280 * @param iv_size Auth initial vector size. 281 * 282 * @return 283 * - Return 0 if the parameters are in range of the capability. 284 * - Return -1 if the parameters are out of range of the capability. 285 */ 286 int 287 rte_cryptodev_sym_capability_check_auth( 288 const struct rte_cryptodev_symmetric_capability *capability, 289 uint16_t key_size, uint16_t digest_size, uint16_t iv_size); 290 291 /** 292 * Check if key, digest, AAD and initial vector sizes are supported 293 * in crypto AEAD capability 294 * 295 * @param capability Description of the symmetric crypto capability. 296 * @param key_size AEAD key size. 297 * @param digest_size AEAD digest size. 298 * @param aad_size AEAD AAD size. 299 * @param iv_size AEAD IV size. 300 * 301 * @return 302 * - Return 0 if the parameters are in range of the capability. 303 * - Return -1 if the parameters are out of range of the capability. 304 */ 305 int 306 rte_cryptodev_sym_capability_check_aead( 307 const struct rte_cryptodev_symmetric_capability *capability, 308 uint16_t key_size, uint16_t digest_size, uint16_t aad_size, 309 uint16_t iv_size); 310 311 /** 312 * Check if op type is supported 313 * 314 * @param capability Description of the asymmetric crypto capability. 315 * @param op_type op type 316 * 317 * @return 318 * - Return 1 if the op type is supported 319 * - Return 0 if unsupported 320 */ 321 __rte_experimental 322 int 323 rte_cryptodev_asym_xform_capability_check_optype( 324 const struct rte_cryptodev_asymmetric_xform_capability *capability, 325 enum rte_crypto_asym_op_type op_type); 326 327 /** 328 * Check if modulus length is in supported range 329 * 330 * @param capability Description of the asymmetric crypto capability. 331 * @param modlen modulus length. 332 * 333 * @return 334 * - Return 0 if the parameters are in range of the capability. 335 * - Return -1 if the parameters are out of range of the capability. 336 */ 337 __rte_experimental 338 int 339 rte_cryptodev_asym_xform_capability_check_modlen( 340 const struct rte_cryptodev_asymmetric_xform_capability *capability, 341 uint16_t modlen); 342 343 /** 344 * Provide the cipher algorithm enum, given an algorithm string 345 * 346 * @param algo_enum A pointer to the cipher algorithm 347 * enum to be filled 348 * @param algo_string Authentication algo string 349 * 350 * @return 351 * - Return -1 if string is not valid 352 * - Return 0 is the string is valid 353 */ 354 int 355 rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum, 356 const char *algo_string); 357 358 /** 359 * Provide the authentication algorithm enum, given an algorithm string 360 * 361 * @param algo_enum A pointer to the authentication algorithm 362 * enum to be filled 363 * @param algo_string Authentication algo string 364 * 365 * @return 366 * - Return -1 if string is not valid 367 * - Return 0 is the string is valid 368 */ 369 int 370 rte_cryptodev_get_auth_algo_enum(enum rte_crypto_auth_algorithm *algo_enum, 371 const char *algo_string); 372 373 /** 374 * Provide the AEAD algorithm enum, given an algorithm string 375 * 376 * @param algo_enum A pointer to the AEAD algorithm 377 * enum to be filled 378 * @param algo_string AEAD algorithm string 379 * 380 * @return 381 * - Return -1 if string is not valid 382 * - Return 0 is the string is valid 383 */ 384 int 385 rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum, 386 const char *algo_string); 387 388 /** 389 * Provide the Asymmetric xform enum, given an xform string 390 * 391 * @param xform_enum A pointer to the xform type 392 * enum to be filled 393 * @param xform_string xform string 394 * 395 * @return 396 * - Return -1 if string is not valid 397 * - Return 0 if the string is valid 398 */ 399 __rte_experimental 400 int 401 rte_cryptodev_asym_get_xform_enum(enum rte_crypto_asym_xform_type *xform_enum, 402 const char *xform_string); 403 404 405 /** Macro used at end of crypto PMD list */ 406 #define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \ 407 { RTE_CRYPTO_OP_TYPE_UNDEFINED } 408 409 410 /** 411 * Crypto device supported feature flags 412 * 413 * Note: 414 * New features flags should be added to the end of the list 415 * 416 * Keep these flags synchronised with rte_cryptodev_get_feature_name() 417 */ 418 #define RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO (1ULL << 0) 419 /**< Symmetric crypto operations are supported */ 420 #define RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO (1ULL << 1) 421 /**< Asymmetric crypto operations are supported */ 422 #define RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING (1ULL << 2) 423 /**< Chaining symmetric crypto operations are supported */ 424 #define RTE_CRYPTODEV_FF_CPU_SSE (1ULL << 3) 425 /**< Utilises CPU SIMD SSE instructions */ 426 #define RTE_CRYPTODEV_FF_CPU_AVX (1ULL << 4) 427 /**< Utilises CPU SIMD AVX instructions */ 428 #define RTE_CRYPTODEV_FF_CPU_AVX2 (1ULL << 5) 429 /**< Utilises CPU SIMD AVX2 instructions */ 430 #define RTE_CRYPTODEV_FF_CPU_AESNI (1ULL << 6) 431 /**< Utilises CPU AES-NI instructions */ 432 #define RTE_CRYPTODEV_FF_HW_ACCELERATED (1ULL << 7) 433 /**< Operations are off-loaded to an 434 * external hardware accelerator 435 */ 436 #define RTE_CRYPTODEV_FF_CPU_AVX512 (1ULL << 8) 437 /**< Utilises CPU SIMD AVX512 instructions */ 438 #define RTE_CRYPTODEV_FF_IN_PLACE_SGL (1ULL << 9) 439 /**< In-place Scatter-gather (SGL) buffers, with multiple segments, 440 * are supported 441 */ 442 #define RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT (1ULL << 10) 443 /**< Out-of-place Scatter-gather (SGL) buffers are 444 * supported in input and output 445 */ 446 #define RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT (1ULL << 11) 447 /**< Out-of-place Scatter-gather (SGL) buffers are supported 448 * in input, combined with linear buffers (LB), with a 449 * single segment in output 450 */ 451 #define RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT (1ULL << 12) 452 /**< Out-of-place Scatter-gather (SGL) buffers are supported 453 * in output, combined with linear buffers (LB) in input 454 */ 455 #define RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT (1ULL << 13) 456 /**< Out-of-place linear buffers (LB) are supported in input and output */ 457 #define RTE_CRYPTODEV_FF_CPU_NEON (1ULL << 14) 458 /**< Utilises CPU NEON instructions */ 459 #define RTE_CRYPTODEV_FF_CPU_ARM_CE (1ULL << 15) 460 /**< Utilises ARM CPU Cryptographic Extensions */ 461 #define RTE_CRYPTODEV_FF_SECURITY (1ULL << 16) 462 /**< Support Security Protocol Processing */ 463 #define RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_EXP (1ULL << 17) 464 /**< Support RSA Private Key OP with exponent */ 465 #define RTE_CRYPTODEV_FF_RSA_PRIV_OP_KEY_QT (1ULL << 18) 466 /**< Support RSA Private Key OP with CRT (quintuple) Keys */ 467 #define RTE_CRYPTODEV_FF_DIGEST_ENCRYPTED (1ULL << 19) 468 /**< Support encrypted-digest operations where digest is appended to data */ 469 #define RTE_CRYPTODEV_FF_ASYM_SESSIONLESS (1ULL << 20) 470 /**< Support asymmetric session-less operations */ 471 #define RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO (1ULL << 21) 472 /**< Support symmetric cpu-crypto processing */ 473 #define RTE_CRYPTODEV_FF_SYM_SESSIONLESS (1ULL << 22) 474 /**< Support symmetric session-less operations */ 475 #define RTE_CRYPTODEV_FF_NON_BYTE_ALIGNED_DATA (1ULL << 23) 476 /**< Support operations on data which is not byte aligned */ 477 #define RTE_CRYPTODEV_FF_SYM_RAW_DP (1ULL << 24) 478 /**< Support accelerator specific symmetric raw data-path APIs */ 479 #define RTE_CRYPTODEV_FF_CIPHER_MULTIPLE_DATA_UNITS (1ULL << 25) 480 /**< Support operations on multiple data-units message */ 481 #define RTE_CRYPTODEV_FF_CIPHER_WRAPPED_KEY (1ULL << 26) 482 /**< Support wrapped key in cipher xform */ 483 #define RTE_CRYPTODEV_FF_SECURITY_INNER_CSUM (1ULL << 27) 484 /**< Support inner checksum computation/verification */ 485 486 /** 487 * Get the name of a crypto device feature flag 488 * 489 * @param flag The mask describing the flag. 490 * 491 * @return 492 * The name of this flag, or NULL if it's not a valid feature flag. 493 */ 494 495 extern const char * 496 rte_cryptodev_get_feature_name(uint64_t flag); 497 498 /** Crypto device information */ 499 struct rte_cryptodev_info { 500 const char *driver_name; /**< Driver name. */ 501 uint8_t driver_id; /**< Driver identifier */ 502 struct rte_device *device; /**< Generic device information. */ 503 504 uint64_t feature_flags; 505 /**< Feature flags exposes HW/SW features for the given device */ 506 507 const struct rte_cryptodev_capabilities *capabilities; 508 /**< Array of devices supported capabilities */ 509 510 unsigned max_nb_queue_pairs; 511 /**< Maximum number of queues pairs supported by device. */ 512 513 uint16_t min_mbuf_headroom_req; 514 /**< Minimum mbuf headroom required by device */ 515 516 uint16_t min_mbuf_tailroom_req; 517 /**< Minimum mbuf tailroom required by device */ 518 519 struct { 520 unsigned max_nb_sessions; 521 /**< Maximum number of sessions supported by device. 522 * If 0, the device does not have any limitation in 523 * number of sessions that can be used. 524 */ 525 } sym; 526 }; 527 528 #define RTE_CRYPTODEV_DETACHED (0) 529 #define RTE_CRYPTODEV_ATTACHED (1) 530 531 /** Definitions of Crypto device event types */ 532 enum rte_cryptodev_event_type { 533 RTE_CRYPTODEV_EVENT_UNKNOWN, /**< unknown event type */ 534 RTE_CRYPTODEV_EVENT_ERROR, /**< error interrupt event */ 535 RTE_CRYPTODEV_EVENT_MAX /**< max value of this enum */ 536 }; 537 538 /** Crypto device queue pair configuration structure. */ 539 struct rte_cryptodev_qp_conf { 540 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */ 541 struct rte_mempool *mp_session; 542 /**< The mempool for creating session in sessionless mode */ 543 struct rte_mempool *mp_session_private; 544 /**< The mempool for creating sess private data in sessionless mode */ 545 }; 546 547 /** 548 * Function type used for processing crypto ops when enqueue/dequeue burst is 549 * called. 550 * 551 * The callback function is called on enqueue/dequeue burst immediately. 552 * 553 * @param dev_id The identifier of the device. 554 * @param qp_id The index of the queue pair on which ops are 555 * enqueued/dequeued. The value must be in the 556 * range [0, nb_queue_pairs - 1] previously 557 * supplied to *rte_cryptodev_configure*. 558 * @param ops The address of an array of *nb_ops* pointers 559 * to *rte_crypto_op* structures which contain 560 * the crypto operations to be processed. 561 * @param nb_ops The number of operations to process. 562 * @param user_param The arbitrary user parameter passed in by the 563 * application when the callback was originally 564 * registered. 565 * @return The number of ops to be enqueued to the 566 * crypto device. 567 */ 568 typedef uint16_t (*rte_cryptodev_callback_fn)(uint16_t dev_id, uint16_t qp_id, 569 struct rte_crypto_op **ops, uint16_t nb_ops, void *user_param); 570 571 /** 572 * Typedef for application callback function to be registered by application 573 * software for notification of device events 574 * 575 * @param dev_id Crypto device identifier 576 * @param event Crypto device event to register for notification of. 577 * @param cb_arg User specified parameter to be passed as to passed to 578 * users callback function. 579 */ 580 typedef void (*rte_cryptodev_cb_fn)(uint8_t dev_id, 581 enum rte_cryptodev_event_type event, void *cb_arg); 582 583 584 /** Crypto Device statistics */ 585 struct rte_cryptodev_stats { 586 uint64_t enqueued_count; 587 /**< Count of all operations enqueued */ 588 uint64_t dequeued_count; 589 /**< Count of all operations dequeued */ 590 591 uint64_t enqueue_err_count; 592 /**< Total error count on operations enqueued */ 593 uint64_t dequeue_err_count; 594 /**< Total error count on operations dequeued */ 595 }; 596 597 #define RTE_CRYPTODEV_NAME_MAX_LEN (64) 598 /**< Max length of name of crypto PMD */ 599 600 /** 601 * Get the device identifier for the named crypto device. 602 * 603 * @param name device name to select the device structure. 604 * 605 * @return 606 * - Returns crypto device identifier on success. 607 * - Return -1 on failure to find named crypto device. 608 */ 609 extern int 610 rte_cryptodev_get_dev_id(const char *name); 611 612 /** 613 * Get the crypto device name given a device identifier. 614 * 615 * @param dev_id 616 * The identifier of the device 617 * 618 * @return 619 * - Returns crypto device name. 620 * - Returns NULL if crypto device is not present. 621 */ 622 extern const char * 623 rte_cryptodev_name_get(uint8_t dev_id); 624 625 /** 626 * Get the total number of crypto devices that have been successfully 627 * initialised. 628 * 629 * @return 630 * - The total number of usable crypto devices. 631 */ 632 extern uint8_t 633 rte_cryptodev_count(void); 634 635 /** 636 * Get number of crypto device defined type. 637 * 638 * @param driver_id driver identifier. 639 * 640 * @return 641 * Returns number of crypto device. 642 */ 643 extern uint8_t 644 rte_cryptodev_device_count_by_driver(uint8_t driver_id); 645 646 /** 647 * Get number and identifiers of attached crypto devices that 648 * use the same crypto driver. 649 * 650 * @param driver_name driver name. 651 * @param devices output devices identifiers. 652 * @param nb_devices maximal number of devices. 653 * 654 * @return 655 * Returns number of attached crypto device. 656 */ 657 uint8_t 658 rte_cryptodev_devices_get(const char *driver_name, uint8_t *devices, 659 uint8_t nb_devices); 660 /* 661 * Return the NUMA socket to which a device is connected 662 * 663 * @param dev_id 664 * The identifier of the device 665 * @return 666 * The NUMA socket id to which the device is connected or 667 * a default of zero if the socket could not be determined. 668 * -1 if returned is the dev_id value is out of range. 669 */ 670 extern int 671 rte_cryptodev_socket_id(uint8_t dev_id); 672 673 /** Crypto device configuration structure */ 674 struct rte_cryptodev_config { 675 int socket_id; /**< Socket to allocate resources on */ 676 uint16_t nb_queue_pairs; 677 /**< Number of queue pairs to configure on device */ 678 uint64_t ff_disable; 679 /**< Feature flags to be disabled. Only the following features are 680 * allowed to be disabled, 681 * - RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO 682 * - RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO 683 * - RTE_CRYTPODEV_FF_SECURITY 684 */ 685 }; 686 687 /** 688 * Configure a device. 689 * 690 * This function must be invoked first before any other function in the 691 * API. This function can also be re-invoked when a device is in the 692 * stopped state. 693 * 694 * @param dev_id The identifier of the device to configure. 695 * @param config The crypto device configuration structure. 696 * 697 * @return 698 * - 0: Success, device configured. 699 * - <0: Error code returned by the driver configuration function. 700 */ 701 extern int 702 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config); 703 704 /** 705 * Start an device. 706 * 707 * The device start step is the last one and consists of setting the configured 708 * offload features and in starting the transmit and the receive units of the 709 * device. 710 * On success, all basic functions exported by the API (link status, 711 * receive/transmit, and so on) can be invoked. 712 * 713 * @param dev_id 714 * The identifier of the device. 715 * @return 716 * - 0: Success, device started. 717 * - <0: Error code of the driver device start function. 718 */ 719 extern int 720 rte_cryptodev_start(uint8_t dev_id); 721 722 /** 723 * Stop an device. The device can be restarted with a call to 724 * rte_cryptodev_start() 725 * 726 * @param dev_id The identifier of the device. 727 */ 728 extern void 729 rte_cryptodev_stop(uint8_t dev_id); 730 731 /** 732 * Close an device. The device cannot be restarted! 733 * 734 * @param dev_id The identifier of the device. 735 * 736 * @return 737 * - 0 on successfully closing device 738 * - <0 on failure to close device 739 */ 740 extern int 741 rte_cryptodev_close(uint8_t dev_id); 742 743 /** 744 * Allocate and set up a receive queue pair for a device. 745 * 746 * 747 * @param dev_id The identifier of the device. 748 * @param queue_pair_id The index of the queue pairs to set up. The 749 * value must be in the range [0, nb_queue_pair 750 * - 1] previously supplied to 751 * rte_cryptodev_configure(). 752 * @param qp_conf The pointer to the configuration data to be 753 * used for the queue pair. 754 * @param socket_id The *socket_id* argument is the socket 755 * identifier in case of NUMA. The value can be 756 * *SOCKET_ID_ANY* if there is no NUMA constraint 757 * for the DMA memory allocated for the receive 758 * queue pair. 759 * 760 * @return 761 * - 0: Success, queue pair correctly set up. 762 * - <0: Queue pair configuration failed 763 */ 764 extern int 765 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id, 766 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id); 767 768 /** 769 * Get the status of queue pairs setup on a specific crypto device 770 * 771 * @param dev_id Crypto device identifier. 772 * @param queue_pair_id The index of the queue pairs to set up. The 773 * value must be in the range [0, nb_queue_pair 774 * - 1] previously supplied to 775 * rte_cryptodev_configure(). 776 * @return 777 * - 0: qp was not configured 778 * - 1: qp was configured 779 * - -EINVAL: device was not configured 780 */ 781 __rte_experimental 782 int 783 rte_cryptodev_get_qp_status(uint8_t dev_id, uint16_t queue_pair_id); 784 785 /** 786 * Get the number of queue pairs on a specific crypto device 787 * 788 * @param dev_id Crypto device identifier. 789 * @return 790 * - The number of configured queue pairs. 791 */ 792 extern uint16_t 793 rte_cryptodev_queue_pair_count(uint8_t dev_id); 794 795 796 /** 797 * Retrieve the general I/O statistics of a device. 798 * 799 * @param dev_id The identifier of the device. 800 * @param stats A pointer to a structure of type 801 * *rte_cryptodev_stats* to be filled with the 802 * values of device counters. 803 * @return 804 * - Zero if successful. 805 * - Non-zero otherwise. 806 */ 807 extern int 808 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats); 809 810 /** 811 * Reset the general I/O statistics of a device. 812 * 813 * @param dev_id The identifier of the device. 814 */ 815 extern void 816 rte_cryptodev_stats_reset(uint8_t dev_id); 817 818 /** 819 * Retrieve the contextual information of a device. 820 * 821 * @param dev_id The identifier of the device. 822 * @param dev_info A pointer to a structure of type 823 * *rte_cryptodev_info* to be filled with the 824 * contextual information of the device. 825 * 826 * @note The capabilities field of dev_info is set to point to the first 827 * element of an array of struct rte_cryptodev_capabilities. The element after 828 * the last valid element has it's op field set to 829 * RTE_CRYPTO_OP_TYPE_UNDEFINED. 830 */ 831 extern void 832 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info); 833 834 835 /** 836 * Register a callback function for specific device id. 837 * 838 * @param dev_id Device id. 839 * @param event Event interested. 840 * @param cb_fn User supplied callback function to be called. 841 * @param cb_arg Pointer to the parameters for the registered 842 * callback. 843 * 844 * @return 845 * - On success, zero. 846 * - On failure, a negative value. 847 */ 848 extern int 849 rte_cryptodev_callback_register(uint8_t dev_id, 850 enum rte_cryptodev_event_type event, 851 rte_cryptodev_cb_fn cb_fn, void *cb_arg); 852 853 /** 854 * Unregister a callback function for specific device id. 855 * 856 * @param dev_id The device identifier. 857 * @param event Event interested. 858 * @param cb_fn User supplied callback function to be called. 859 * @param cb_arg Pointer to the parameters for the registered 860 * callback. 861 * 862 * @return 863 * - On success, zero. 864 * - On failure, a negative value. 865 */ 866 extern int 867 rte_cryptodev_callback_unregister(uint8_t dev_id, 868 enum rte_cryptodev_event_type event, 869 rte_cryptodev_cb_fn cb_fn, void *cb_arg); 870 871 struct rte_cryptodev_callback; 872 873 /** Structure to keep track of registered callbacks */ 874 RTE_TAILQ_HEAD(rte_cryptodev_cb_list, rte_cryptodev_callback); 875 876 /** 877 * Structure used to hold information about the callbacks to be called for a 878 * queue pair on enqueue/dequeue. 879 */ 880 struct rte_cryptodev_cb { 881 struct rte_cryptodev_cb *next; 882 /**< Pointer to next callback */ 883 rte_cryptodev_callback_fn fn; 884 /**< Pointer to callback function */ 885 void *arg; 886 /**< Pointer to argument */ 887 }; 888 889 /** 890 * @internal 891 * Structure used to hold information about the RCU for a queue pair. 892 */ 893 struct rte_cryptodev_cb_rcu { 894 struct rte_cryptodev_cb *next; 895 /**< Pointer to next callback */ 896 struct rte_rcu_qsbr *qsbr; 897 /**< RCU QSBR variable per queue pair */ 898 }; 899 900 void * 901 rte_cryptodev_get_sec_ctx(uint8_t dev_id); 902 903 /** Cryptodev symmetric crypto session 904 * Each session is derived from a fixed xform chain. Therefore each session 905 * has a fixed algo, key, op-type, digest_len etc. 906 */ 907 struct rte_cryptodev_sym_session { 908 uint64_t opaque_data; 909 /**< Can be used for external metadata */ 910 uint16_t nb_drivers; 911 /**< number of elements in sess_data array */ 912 uint16_t user_data_sz; 913 /**< session user data will be placed after sess_data */ 914 __extension__ struct { 915 void *data; 916 uint16_t refcnt; 917 } sess_data[0]; 918 /**< Driver specific session material, variable size */ 919 }; 920 921 /** 922 * Create a symmetric session mempool. 923 * 924 * @param name 925 * The unique mempool name. 926 * @param nb_elts 927 * The number of elements in the mempool. 928 * @param elt_size 929 * The size of the element. This value will be ignored if it is smaller than 930 * the minimum session header size required for the system. For the user who 931 * want to use the same mempool for sym session and session private data it 932 * can be the maximum value of all existing devices' private data and session 933 * header sizes. 934 * @param cache_size 935 * The number of per-lcore cache elements 936 * @param priv_size 937 * The private data size of each session. 938 * @param socket_id 939 * The *socket_id* argument is the socket identifier in the case of 940 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA 941 * constraint for the reserved zone. 942 * 943 * @return 944 * - On success return size of the session 945 * - On failure returns 0 946 */ 947 __rte_experimental 948 struct rte_mempool * 949 rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts, 950 uint32_t elt_size, uint32_t cache_size, uint16_t priv_size, 951 int socket_id); 952 953 /** 954 * Create an asymmetric session mempool. 955 * 956 * @param name 957 * The unique mempool name. 958 * @param nb_elts 959 * The number of elements in the mempool. 960 * @param cache_size 961 * The number of per-lcore cache elements 962 * @param socket_id 963 * The *socket_id* argument is the socket identifier in the case of 964 * NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA 965 * constraint for the reserved zone. 966 * 967 * @return 968 * - On success return mempool 969 * - On failure returns NULL 970 */ 971 __rte_experimental 972 struct rte_mempool * 973 rte_cryptodev_asym_session_pool_create(const char *name, uint32_t nb_elts, 974 uint32_t cache_size, int socket_id); 975 976 /** 977 * Create symmetric crypto session header (generic with no private data) 978 * 979 * @param mempool Symmetric session mempool to allocate session 980 * objects from 981 * @return 982 * - On success return pointer to sym-session 983 * - On failure returns NULL 984 */ 985 struct rte_cryptodev_sym_session * 986 rte_cryptodev_sym_session_create(struct rte_mempool *mempool); 987 988 /** 989 * Create and initialise an asymmetric crypto session structure. 990 * Calls the PMD to configure the private session data. 991 * 992 * @param dev_id ID of device that we want the session to be used on 993 * @param xforms Asymmetric crypto transform operations to apply on flow 994 * processed with this session 995 * @param mp mempool to allocate asymmetric session 996 * objects from 997 * @return 998 * - On success return pointer to asym-session 999 * - On failure returns NULL 1000 */ 1001 __rte_experimental 1002 void * 1003 rte_cryptodev_asym_session_create(uint8_t dev_id, 1004 struct rte_crypto_asym_xform *xforms, struct rte_mempool *mp); 1005 1006 /** 1007 * Frees symmetric crypto session header, after checking that all 1008 * the device private data has been freed, returning it 1009 * to its original mempool. 1010 * 1011 * @param sess Session header to be freed. 1012 * 1013 * @return 1014 * - 0 if successful. 1015 * - -EINVAL if session is NULL. 1016 * - -EBUSY if not all device private data has been freed. 1017 */ 1018 int 1019 rte_cryptodev_sym_session_free(struct rte_cryptodev_sym_session *sess); 1020 1021 /** 1022 * Clears and frees asymmetric crypto session header and private data, 1023 * returning it to its original mempool. 1024 * 1025 * @param dev_id ID of device that uses the asymmetric session. 1026 * @param sess Session header to be freed. 1027 * 1028 * @return 1029 * - 0 if successful. 1030 * - -EINVAL if device is invalid or session is NULL. 1031 */ 1032 __rte_experimental 1033 int 1034 rte_cryptodev_asym_session_free(uint8_t dev_id, void *sess); 1035 1036 /** 1037 * Fill out private data for the device id, based on its device type. 1038 * 1039 * @param dev_id ID of device that we want the session to be used on 1040 * @param sess Session where the private data will be attached to 1041 * @param xforms Symmetric crypto transform operations to apply on flow 1042 * processed with this session 1043 * @param mempool Mempool where the private data is allocated. 1044 * 1045 * @return 1046 * - On success, zero. 1047 * - -EINVAL if input parameters are invalid. 1048 * - -ENOTSUP if crypto device does not support the crypto transform or 1049 * does not support symmetric operations. 1050 * - -ENOMEM if the private session could not be allocated. 1051 */ 1052 int 1053 rte_cryptodev_sym_session_init(uint8_t dev_id, 1054 struct rte_cryptodev_sym_session *sess, 1055 struct rte_crypto_sym_xform *xforms, 1056 struct rte_mempool *mempool); 1057 1058 /** 1059 * Frees private data for the device id, based on its device type, 1060 * returning it to its mempool. It is the application's responsibility 1061 * to ensure that private session data is not cleared while there are 1062 * still in-flight operations using it. 1063 * 1064 * @param dev_id ID of device that uses the session. 1065 * @param sess Session containing the reference to the private data 1066 * 1067 * @return 1068 * - 0 if successful. 1069 * - -EINVAL if device is invalid or session is NULL. 1070 * - -ENOTSUP if crypto device does not support symmetric operations. 1071 */ 1072 int 1073 rte_cryptodev_sym_session_clear(uint8_t dev_id, 1074 struct rte_cryptodev_sym_session *sess); 1075 1076 /** 1077 * Get the size of the header session, for all registered drivers excluding 1078 * the user data size. 1079 * 1080 * @return 1081 * Size of the symmetric header session. 1082 */ 1083 unsigned int 1084 rte_cryptodev_sym_get_header_session_size(void); 1085 1086 /** 1087 * Get the size of the header session from created session. 1088 * 1089 * @param sess 1090 * The sym cryptodev session pointer 1091 * 1092 * @return 1093 * - If sess is not NULL, return the size of the header session including 1094 * the private data size defined within sess. 1095 * - If sess is NULL, return 0. 1096 */ 1097 __rte_experimental 1098 unsigned int 1099 rte_cryptodev_sym_get_existing_header_session_size( 1100 struct rte_cryptodev_sym_session *sess); 1101 1102 /** 1103 * Get the size of the asymmetric session header. 1104 * 1105 * @return 1106 * Size of the asymmetric header session. 1107 */ 1108 __rte_experimental 1109 unsigned int 1110 rte_cryptodev_asym_get_header_session_size(void); 1111 1112 /** 1113 * Get the size of the private symmetric session data 1114 * for a device. 1115 * 1116 * @param dev_id The device identifier. 1117 * 1118 * @return 1119 * - Size of the private data, if successful 1120 * - 0 if device is invalid or does not have private 1121 * symmetric session 1122 */ 1123 unsigned int 1124 rte_cryptodev_sym_get_private_session_size(uint8_t dev_id); 1125 1126 /** 1127 * Get the size of the private data for asymmetric session 1128 * on device 1129 * 1130 * @param dev_id The device identifier. 1131 * 1132 * @return 1133 * - Size of the asymmetric private data, if successful 1134 * - 0 if device is invalid or does not have private session 1135 */ 1136 __rte_experimental 1137 unsigned int 1138 rte_cryptodev_asym_get_private_session_size(uint8_t dev_id); 1139 1140 /** 1141 * Validate if the crypto device index is valid attached crypto device. 1142 * 1143 * @param dev_id Crypto device index. 1144 * 1145 * @return 1146 * - If the device index is valid (1) or not (0). 1147 */ 1148 unsigned int 1149 rte_cryptodev_is_valid_dev(uint8_t dev_id); 1150 1151 /** 1152 * Provide driver identifier. 1153 * 1154 * @param name 1155 * The pointer to a driver name. 1156 * @return 1157 * The driver type identifier or -1 if no driver found 1158 */ 1159 int rte_cryptodev_driver_id_get(const char *name); 1160 1161 /** 1162 * Provide driver name. 1163 * 1164 * @param driver_id 1165 * The driver identifier. 1166 * @return 1167 * The driver name or null if no driver found 1168 */ 1169 const char *rte_cryptodev_driver_name_get(uint8_t driver_id); 1170 1171 /** 1172 * Store user data in a session. 1173 * 1174 * @param sess Session pointer allocated by 1175 * *rte_cryptodev_sym_session_create*. 1176 * @param data Pointer to the user data. 1177 * @param size Size of the user data. 1178 * 1179 * @return 1180 * - On success, zero. 1181 * - On failure, a negative value. 1182 */ 1183 __rte_experimental 1184 int 1185 rte_cryptodev_sym_session_set_user_data( 1186 struct rte_cryptodev_sym_session *sess, 1187 void *data, 1188 uint16_t size); 1189 1190 /** 1191 * Get user data stored in a session. 1192 * 1193 * @param sess Session pointer allocated by 1194 * *rte_cryptodev_sym_session_create*. 1195 * 1196 * @return 1197 * - On success return pointer to user data. 1198 * - On failure returns NULL. 1199 */ 1200 __rte_experimental 1201 void * 1202 rte_cryptodev_sym_session_get_user_data( 1203 struct rte_cryptodev_sym_session *sess); 1204 1205 /** 1206 * Perform actual crypto processing (encrypt/digest or auth/decrypt) 1207 * on user provided data. 1208 * 1209 * @param dev_id The device identifier. 1210 * @param sess Cryptodev session structure 1211 * @param ofs Start and stop offsets for auth and cipher operations 1212 * @param vec Vectorized operation descriptor 1213 * 1214 * @return 1215 * - Returns number of successfully processed packets. 1216 */ 1217 __rte_experimental 1218 uint32_t 1219 rte_cryptodev_sym_cpu_crypto_process(uint8_t dev_id, 1220 struct rte_cryptodev_sym_session *sess, union rte_crypto_sym_ofs ofs, 1221 struct rte_crypto_sym_vec *vec); 1222 1223 /** 1224 * Get the size of the raw data-path context buffer. 1225 * 1226 * @param dev_id The device identifier. 1227 * 1228 * @return 1229 * - If the device supports raw data-path APIs, return the context size. 1230 * - If the device does not support the APIs, return -1. 1231 */ 1232 __rte_experimental 1233 int 1234 rte_cryptodev_get_raw_dp_ctx_size(uint8_t dev_id); 1235 1236 /** 1237 * Union of different crypto session types, including session-less xform 1238 * pointer. 1239 */ 1240 union rte_cryptodev_session_ctx { 1241 struct rte_cryptodev_sym_session *crypto_sess; 1242 struct rte_crypto_sym_xform *xform; 1243 struct rte_security_session *sec_sess; 1244 }; 1245 1246 /** 1247 * Enqueue a vectorized operation descriptor into the device queue but the 1248 * driver may or may not start processing until rte_cryptodev_raw_enqueue_done() 1249 * is called. 1250 * 1251 * @param qp Driver specific queue pair data. 1252 * @param drv_ctx Driver specific context data. 1253 * @param vec Vectorized operation descriptor. 1254 * @param ofs Start and stop offsets for auth and cipher 1255 * operations. 1256 * @param user_data The array of user data for dequeue later. 1257 * @param enqueue_status Driver written value to specify the 1258 * enqueue status. Possible values: 1259 * - 1: The number of operations returned are 1260 * enqueued successfully. 1261 * - 0: The number of operations returned are 1262 * cached into the queue but are not processed 1263 * until rte_cryptodev_raw_enqueue_done() is 1264 * called. 1265 * - negative integer: Error occurred. 1266 * @return 1267 * - The number of operations in the descriptor successfully enqueued or 1268 * cached into the queue but not enqueued yet, depends on the 1269 * "enqueue_status" value. 1270 */ 1271 typedef uint32_t (*cryptodev_sym_raw_enqueue_burst_t)( 1272 void *qp, uint8_t *drv_ctx, struct rte_crypto_sym_vec *vec, 1273 union rte_crypto_sym_ofs ofs, void *user_data[], int *enqueue_status); 1274 1275 /** 1276 * Enqueue single raw data vector into the device queue but the driver may or 1277 * may not start processing until rte_cryptodev_raw_enqueue_done() is called. 1278 * 1279 * @param qp Driver specific queue pair data. 1280 * @param drv_ctx Driver specific context data. 1281 * @param data_vec The buffer data vector. 1282 * @param n_data_vecs Number of buffer data vectors. 1283 * @param ofs Start and stop offsets for auth and cipher 1284 * operations. 1285 * @param iv IV virtual and IOVA addresses 1286 * @param digest digest virtual and IOVA addresses 1287 * @param aad_or_auth_iv AAD or auth IV virtual and IOVA addresses, 1288 * depends on the algorithm used. 1289 * @param user_data The user data. 1290 * @return 1291 * - 1: The data vector is enqueued successfully. 1292 * - 0: The data vector is cached into the queue but is not processed 1293 * until rte_cryptodev_raw_enqueue_done() is called. 1294 * - negative integer: failure. 1295 */ 1296 typedef int (*cryptodev_sym_raw_enqueue_t)( 1297 void *qp, uint8_t *drv_ctx, struct rte_crypto_vec *data_vec, 1298 uint16_t n_data_vecs, union rte_crypto_sym_ofs ofs, 1299 struct rte_crypto_va_iova_ptr *iv, 1300 struct rte_crypto_va_iova_ptr *digest, 1301 struct rte_crypto_va_iova_ptr *aad_or_auth_iv, 1302 void *user_data); 1303 1304 /** 1305 * Inform the cryptodev queue pair to start processing or finish dequeuing all 1306 * enqueued/dequeued operations. 1307 * 1308 * @param qp Driver specific queue pair data. 1309 * @param drv_ctx Driver specific context data. 1310 * @param n The total number of processed operations. 1311 * @return 1312 * - On success return 0. 1313 * - On failure return negative integer. 1314 */ 1315 typedef int (*cryptodev_sym_raw_operation_done_t)(void *qp, uint8_t *drv_ctx, 1316 uint32_t n); 1317 1318 /** 1319 * Typedef that the user provided for the driver to get the dequeue count. 1320 * The function may return a fixed number or the number parsed from the user 1321 * data stored in the first processed operation. 1322 * 1323 * @param user_data Dequeued user data. 1324 * @return 1325 * - The number of operations to be dequeued. 1326 **/ 1327 typedef uint32_t (*rte_cryptodev_raw_get_dequeue_count_t)(void *user_data); 1328 1329 /** 1330 * Typedef that the user provided to deal with post dequeue operation, such 1331 * as filling status. 1332 * 1333 * @param user_data Dequeued user data. 1334 * @param index Index number of the processed descriptor. 1335 * @param is_op_success Operation status provided by the driver. 1336 **/ 1337 typedef void (*rte_cryptodev_raw_post_dequeue_t)(void *user_data, 1338 uint32_t index, uint8_t is_op_success); 1339 1340 /** 1341 * Dequeue a burst of symmetric crypto processing. 1342 * 1343 * @param qp Driver specific queue pair data. 1344 * @param drv_ctx Driver specific context data. 1345 * @param get_dequeue_count User provided callback function to 1346 * obtain dequeue operation count. 1347 * @param max_nb_to_dequeue When get_dequeue_count is NULL this 1348 * value is used to pass the maximum 1349 * number of operations to be dequeued. 1350 * @param post_dequeue User provided callback function to 1351 * post-process a dequeued operation. 1352 * @param out_user_data User data pointer array to be retrieve 1353 * from device queue. In case of 1354 * *is_user_data_array* is set there 1355 * should be enough room to store all 1356 * user data. 1357 * @param is_user_data_array Set 1 if every dequeued user data will 1358 * be written into out_user_data array. 1359 * Set 0 if only the first user data will 1360 * be written into out_user_data array. 1361 * @param n_success Driver written value to specific the 1362 * total successful operations count. 1363 * @param dequeue_status Driver written value to specify the 1364 * dequeue status. Possible values: 1365 * - 1: Successfully dequeued the number 1366 * of operations returned. The user 1367 * data previously set during enqueue 1368 * is stored in the "out_user_data". 1369 * - 0: The number of operations returned 1370 * are completed and the user data is 1371 * stored in the "out_user_data", but 1372 * they are not freed from the queue 1373 * until 1374 * rte_cryptodev_raw_dequeue_done() 1375 * is called. 1376 * - negative integer: Error occurred. 1377 * @return 1378 * - The number of operations dequeued or completed but not freed from the 1379 * queue, depends on "dequeue_status" value. 1380 */ 1381 typedef uint32_t (*cryptodev_sym_raw_dequeue_burst_t)(void *qp, 1382 uint8_t *drv_ctx, 1383 rte_cryptodev_raw_get_dequeue_count_t get_dequeue_count, 1384 uint32_t max_nb_to_dequeue, 1385 rte_cryptodev_raw_post_dequeue_t post_dequeue, 1386 void **out_user_data, uint8_t is_user_data_array, 1387 uint32_t *n_success, int *dequeue_status); 1388 1389 /** 1390 * Dequeue a symmetric crypto processing. 1391 * 1392 * @param qp Driver specific queue pair data. 1393 * @param drv_ctx Driver specific context data. 1394 * @param dequeue_status Driver written value to specify the 1395 * dequeue status. Possible values: 1396 * - 1: Successfully dequeued a operation. 1397 * The user data is returned. 1398 * - 0: The first operation in the queue 1399 * is completed and the user data 1400 * previously set during enqueue is 1401 * returned, but it is not freed from 1402 * the queue until 1403 * rte_cryptodev_raw_dequeue_done() is 1404 * called. 1405 * - negative integer: Error occurred. 1406 * @param op_status Driver written value to specify 1407 * operation status. 1408 * @return 1409 * - The user data pointer retrieved from device queue or NULL if no 1410 * operation is ready for dequeue. 1411 */ 1412 typedef void * (*cryptodev_sym_raw_dequeue_t)( 1413 void *qp, uint8_t *drv_ctx, int *dequeue_status, 1414 enum rte_crypto_op_status *op_status); 1415 1416 /** 1417 * Context data for raw data-path API crypto process. The buffer of this 1418 * structure is to be allocated by the user application with the size equal 1419 * or bigger than rte_cryptodev_get_raw_dp_ctx_size() returned value. 1420 */ 1421 struct rte_crypto_raw_dp_ctx { 1422 void *qp_data; 1423 1424 cryptodev_sym_raw_enqueue_t enqueue; 1425 cryptodev_sym_raw_enqueue_burst_t enqueue_burst; 1426 cryptodev_sym_raw_operation_done_t enqueue_done; 1427 cryptodev_sym_raw_dequeue_t dequeue; 1428 cryptodev_sym_raw_dequeue_burst_t dequeue_burst; 1429 cryptodev_sym_raw_operation_done_t dequeue_done; 1430 1431 /* Driver specific context data */ 1432 __extension__ uint8_t drv_ctx_data[]; 1433 }; 1434 1435 /** 1436 * Configure raw data-path context data. 1437 * 1438 * NOTE: 1439 * After the context data is configured, the user should call 1440 * rte_cryptodev_raw_attach_session() before using it in 1441 * rte_cryptodev_raw_enqueue/dequeue function call. 1442 * 1443 * @param dev_id The device identifier. 1444 * @param qp_id The index of the queue pair from which to 1445 * retrieve processed packets. The value must be 1446 * in the range [0, nb_queue_pair - 1] previously 1447 * supplied to rte_cryptodev_configure(). 1448 * @param ctx The raw data-path context data. 1449 * @param sess_type session type. 1450 * @param session_ctx Session context data. 1451 * @param is_update Set 0 if it is to initialize the ctx. 1452 * Set 1 if ctx is initialized and only to update 1453 * session context data. 1454 * @return 1455 * - On success return 0. 1456 * - On failure return negative integer. 1457 */ 1458 __rte_experimental 1459 int 1460 rte_cryptodev_configure_raw_dp_ctx(uint8_t dev_id, uint16_t qp_id, 1461 struct rte_crypto_raw_dp_ctx *ctx, 1462 enum rte_crypto_op_sess_type sess_type, 1463 union rte_cryptodev_session_ctx session_ctx, 1464 uint8_t is_update); 1465 1466 /** 1467 * Enqueue a vectorized operation descriptor into the device queue but the 1468 * driver may or may not start processing until rte_cryptodev_raw_enqueue_done() 1469 * is called. 1470 * 1471 * @param ctx The initialized raw data-path context data. 1472 * @param vec Vectorized operation descriptor. 1473 * @param ofs Start and stop offsets for auth and cipher 1474 * operations. 1475 * @param user_data The array of user data for dequeue later. 1476 * @param enqueue_status Driver written value to specify the 1477 * enqueue status. Possible values: 1478 * - 1: The number of operations returned are 1479 * enqueued successfully. 1480 * - 0: The number of operations returned are 1481 * cached into the queue but are not processed 1482 * until rte_cryptodev_raw_enqueue_done() is 1483 * called. 1484 * - negative integer: Error occurred. 1485 * @return 1486 * - The number of operations in the descriptor successfully enqueued or 1487 * cached into the queue but not enqueued yet, depends on the 1488 * "enqueue_status" value. 1489 */ 1490 __rte_experimental 1491 uint32_t 1492 rte_cryptodev_raw_enqueue_burst(struct rte_crypto_raw_dp_ctx *ctx, 1493 struct rte_crypto_sym_vec *vec, union rte_crypto_sym_ofs ofs, 1494 void **user_data, int *enqueue_status); 1495 1496 /** 1497 * Enqueue single raw data vector into the device queue but the driver may or 1498 * may not start processing until rte_cryptodev_raw_enqueue_done() is called. 1499 * 1500 * @param ctx The initialized raw data-path context data. 1501 * @param data_vec The buffer data vector. 1502 * @param n_data_vecs Number of buffer data vectors. 1503 * @param ofs Start and stop offsets for auth and cipher 1504 * operations. 1505 * @param iv IV virtual and IOVA addresses 1506 * @param digest digest virtual and IOVA addresses 1507 * @param aad_or_auth_iv AAD or auth IV virtual and IOVA addresses, 1508 * depends on the algorithm used. 1509 * @param user_data The user data. 1510 * @return 1511 * - 1: The data vector is enqueued successfully. 1512 * - 0: The data vector is cached into the queue but is not processed 1513 * until rte_cryptodev_raw_enqueue_done() is called. 1514 * - negative integer: failure. 1515 */ 1516 __rte_experimental 1517 static __rte_always_inline int 1518 rte_cryptodev_raw_enqueue(struct rte_crypto_raw_dp_ctx *ctx, 1519 struct rte_crypto_vec *data_vec, uint16_t n_data_vecs, 1520 union rte_crypto_sym_ofs ofs, 1521 struct rte_crypto_va_iova_ptr *iv, 1522 struct rte_crypto_va_iova_ptr *digest, 1523 struct rte_crypto_va_iova_ptr *aad_or_auth_iv, 1524 void *user_data) 1525 { 1526 return (*ctx->enqueue)(ctx->qp_data, ctx->drv_ctx_data, data_vec, 1527 n_data_vecs, ofs, iv, digest, aad_or_auth_iv, user_data); 1528 } 1529 1530 /** 1531 * Start processing all enqueued operations from last 1532 * rte_cryptodev_configure_raw_dp_ctx() call. 1533 * 1534 * @param ctx The initialized raw data-path context data. 1535 * @param n The number of operations cached. 1536 * @return 1537 * - On success return 0. 1538 * - On failure return negative integer. 1539 */ 1540 __rte_experimental 1541 int 1542 rte_cryptodev_raw_enqueue_done(struct rte_crypto_raw_dp_ctx *ctx, 1543 uint32_t n); 1544 1545 /** 1546 * Dequeue a burst of symmetric crypto processing. 1547 * 1548 * @param ctx The initialized raw data-path context 1549 * data. 1550 * @param get_dequeue_count User provided callback function to 1551 * obtain dequeue operation count. 1552 * @param max_nb_to_dequeue When get_dequeue_count is NULL this 1553 * value is used to pass the maximum 1554 * number of operations to be dequeued. 1555 * @param post_dequeue User provided callback function to 1556 * post-process a dequeued operation. 1557 * @param out_user_data User data pointer array to be retrieve 1558 * from device queue. In case of 1559 * *is_user_data_array* is set there 1560 * should be enough room to store all 1561 * user data. 1562 * @param is_user_data_array Set 1 if every dequeued user data will 1563 * be written into out_user_data array. 1564 * Set 0 if only the first user data will 1565 * be written into out_user_data array. 1566 * @param n_success Driver written value to specific the 1567 * total successful operations count. 1568 * @param dequeue_status Driver written value to specify the 1569 * dequeue status. Possible values: 1570 * - 1: Successfully dequeued the number 1571 * of operations returned. The user 1572 * data previously set during enqueue 1573 * is stored in the "out_user_data". 1574 * - 0: The number of operations returned 1575 * are completed and the user data is 1576 * stored in the "out_user_data", but 1577 * they are not freed from the queue 1578 * until 1579 * rte_cryptodev_raw_dequeue_done() 1580 * is called. 1581 * - negative integer: Error occurred. 1582 * @return 1583 * - The number of operations dequeued or completed but not freed from the 1584 * queue, depends on "dequeue_status" value. 1585 */ 1586 __rte_experimental 1587 uint32_t 1588 rte_cryptodev_raw_dequeue_burst(struct rte_crypto_raw_dp_ctx *ctx, 1589 rte_cryptodev_raw_get_dequeue_count_t get_dequeue_count, 1590 uint32_t max_nb_to_dequeue, 1591 rte_cryptodev_raw_post_dequeue_t post_dequeue, 1592 void **out_user_data, uint8_t is_user_data_array, 1593 uint32_t *n_success, int *dequeue_status); 1594 1595 /** 1596 * Dequeue a symmetric crypto processing. 1597 * 1598 * @param ctx The initialized raw data-path context 1599 * data. 1600 * @param dequeue_status Driver written value to specify the 1601 * dequeue status. Possible values: 1602 * - 1: Successfully dequeued a operation. 1603 * The user data is returned. 1604 * - 0: The first operation in the queue 1605 * is completed and the user data 1606 * previously set during enqueue is 1607 * returned, but it is not freed from 1608 * the queue until 1609 * rte_cryptodev_raw_dequeue_done() is 1610 * called. 1611 * - negative integer: Error occurred. 1612 * @param op_status Driver written value to specify 1613 * operation status. 1614 * @return 1615 * - The user data pointer retrieved from device queue or NULL if no 1616 * operation is ready for dequeue. 1617 */ 1618 __rte_experimental 1619 static __rte_always_inline void * 1620 rte_cryptodev_raw_dequeue(struct rte_crypto_raw_dp_ctx *ctx, 1621 int *dequeue_status, enum rte_crypto_op_status *op_status) 1622 { 1623 return (*ctx->dequeue)(ctx->qp_data, ctx->drv_ctx_data, dequeue_status, 1624 op_status); 1625 } 1626 1627 /** 1628 * Inform the queue pair dequeue operations is finished. 1629 * 1630 * @param ctx The initialized raw data-path context data. 1631 * @param n The number of operations. 1632 * @return 1633 * - On success return 0. 1634 * - On failure return negative integer. 1635 */ 1636 __rte_experimental 1637 int 1638 rte_cryptodev_raw_dequeue_done(struct rte_crypto_raw_dp_ctx *ctx, 1639 uint32_t n); 1640 1641 /** 1642 * Add a user callback for a given crypto device and queue pair which will be 1643 * called on crypto ops enqueue. 1644 * 1645 * This API configures a function to be called for each burst of crypto ops 1646 * received on a given crypto device queue pair. The return value is a pointer 1647 * that can be used later to remove the callback using 1648 * rte_cryptodev_remove_enq_callback(). 1649 * 1650 * Callbacks registered by application would not survive 1651 * rte_cryptodev_configure() as it reinitializes the callback list. 1652 * It is user responsibility to remove all installed callbacks before 1653 * calling rte_cryptodev_configure() to avoid possible memory leakage. 1654 * Application is expected to call add API after rte_cryptodev_configure(). 1655 * 1656 * Multiple functions can be registered per queue pair & they are called 1657 * in the order they were added. The API does not restrict on maximum number 1658 * of callbacks. 1659 * 1660 * @param dev_id The identifier of the device. 1661 * @param qp_id The index of the queue pair on which ops are 1662 * to be enqueued for processing. The value 1663 * must be in the range [0, nb_queue_pairs - 1] 1664 * previously supplied to 1665 * *rte_cryptodev_configure*. 1666 * @param cb_fn The callback function 1667 * @param cb_arg A generic pointer parameter which will be passed 1668 * to each invocation of the callback function on 1669 * this crypto device and queue pair. 1670 * 1671 * @return 1672 * - NULL on error & rte_errno will contain the error code. 1673 * - On success, a pointer value which can later be used to remove the 1674 * callback. 1675 */ 1676 1677 __rte_experimental 1678 struct rte_cryptodev_cb * 1679 rte_cryptodev_add_enq_callback(uint8_t dev_id, 1680 uint16_t qp_id, 1681 rte_cryptodev_callback_fn cb_fn, 1682 void *cb_arg); 1683 1684 /** 1685 * Remove a user callback function for given crypto device and queue pair. 1686 * 1687 * This function is used to remove enqueue callbacks that were added to a 1688 * crypto device queue pair using rte_cryptodev_add_enq_callback(). 1689 * 1690 * 1691 * 1692 * @param dev_id The identifier of the device. 1693 * @param qp_id The index of the queue pair on which ops are 1694 * to be enqueued. The value must be in the 1695 * range [0, nb_queue_pairs - 1] previously 1696 * supplied to *rte_cryptodev_configure*. 1697 * @param cb Pointer to user supplied callback created via 1698 * rte_cryptodev_add_enq_callback(). 1699 * 1700 * @return 1701 * - 0: Success. Callback was removed. 1702 * - <0: The dev_id or the qp_id is out of range, or the callback 1703 * is NULL or not found for the crypto device queue pair. 1704 */ 1705 1706 __rte_experimental 1707 int rte_cryptodev_remove_enq_callback(uint8_t dev_id, 1708 uint16_t qp_id, 1709 struct rte_cryptodev_cb *cb); 1710 1711 /** 1712 * Add a user callback for a given crypto device and queue pair which will be 1713 * called on crypto ops dequeue. 1714 * 1715 * This API configures a function to be called for each burst of crypto ops 1716 * received on a given crypto device queue pair. The return value is a pointer 1717 * that can be used later to remove the callback using 1718 * rte_cryptodev_remove_deq_callback(). 1719 * 1720 * Callbacks registered by application would not survive 1721 * rte_cryptodev_configure() as it reinitializes the callback list. 1722 * It is user responsibility to remove all installed callbacks before 1723 * calling rte_cryptodev_configure() to avoid possible memory leakage. 1724 * Application is expected to call add API after rte_cryptodev_configure(). 1725 * 1726 * Multiple functions can be registered per queue pair & they are called 1727 * in the order they were added. The API does not restrict on maximum number 1728 * of callbacks. 1729 * 1730 * @param dev_id The identifier of the device. 1731 * @param qp_id The index of the queue pair on which ops are 1732 * to be dequeued. The value must be in the 1733 * range [0, nb_queue_pairs - 1] previously 1734 * supplied to *rte_cryptodev_configure*. 1735 * @param cb_fn The callback function 1736 * @param cb_arg A generic pointer parameter which will be passed 1737 * to each invocation of the callback function on 1738 * this crypto device and queue pair. 1739 * 1740 * @return 1741 * - NULL on error & rte_errno will contain the error code. 1742 * - On success, a pointer value which can later be used to remove the 1743 * callback. 1744 */ 1745 1746 __rte_experimental 1747 struct rte_cryptodev_cb * 1748 rte_cryptodev_add_deq_callback(uint8_t dev_id, 1749 uint16_t qp_id, 1750 rte_cryptodev_callback_fn cb_fn, 1751 void *cb_arg); 1752 1753 /** 1754 * Remove a user callback function for given crypto device and queue pair. 1755 * 1756 * This function is used to remove dequeue callbacks that were added to a 1757 * crypto device queue pair using rte_cryptodev_add_deq_callback(). 1758 * 1759 * 1760 * 1761 * @param dev_id The identifier of the device. 1762 * @param qp_id The index of the queue pair on which ops are 1763 * to be dequeued. The value must be in the 1764 * range [0, nb_queue_pairs - 1] previously 1765 * supplied to *rte_cryptodev_configure*. 1766 * @param cb Pointer to user supplied callback created via 1767 * rte_cryptodev_add_deq_callback(). 1768 * 1769 * @return 1770 * - 0: Success. Callback was removed. 1771 * - <0: The dev_id or the qp_id is out of range, or the callback 1772 * is NULL or not found for the crypto device queue pair. 1773 */ 1774 __rte_experimental 1775 int rte_cryptodev_remove_deq_callback(uint8_t dev_id, 1776 uint16_t qp_id, 1777 struct rte_cryptodev_cb *cb); 1778 1779 #include <rte_cryptodev_core.h> 1780 /** 1781 * 1782 * Dequeue a burst of processed crypto operations from a queue on the crypto 1783 * device. The dequeued operation are stored in *rte_crypto_op* structures 1784 * whose pointers are supplied in the *ops* array. 1785 * 1786 * The rte_cryptodev_dequeue_burst() function returns the number of ops 1787 * actually dequeued, which is the number of *rte_crypto_op* data structures 1788 * effectively supplied into the *ops* array. 1789 * 1790 * A return value equal to *nb_ops* indicates that the queue contained 1791 * at least *nb_ops* operations, and this is likely to signify that other 1792 * processed operations remain in the devices output queue. Applications 1793 * implementing a "retrieve as many processed operations as possible" policy 1794 * can check this specific case and keep invoking the 1795 * rte_cryptodev_dequeue_burst() function until a value less than 1796 * *nb_ops* is returned. 1797 * 1798 * The rte_cryptodev_dequeue_burst() function does not provide any error 1799 * notification to avoid the corresponding overhead. 1800 * 1801 * @param dev_id The symmetric crypto device identifier 1802 * @param qp_id The index of the queue pair from which to 1803 * retrieve processed packets. The value must be 1804 * in the range [0, nb_queue_pair - 1] previously 1805 * supplied to rte_cryptodev_configure(). 1806 * @param ops The address of an array of pointers to 1807 * *rte_crypto_op* structures that must be 1808 * large enough to store *nb_ops* pointers in it. 1809 * @param nb_ops The maximum number of operations to dequeue. 1810 * 1811 * @return 1812 * - The number of operations actually dequeued, which is the number 1813 * of pointers to *rte_crypto_op* structures effectively supplied to the 1814 * *ops* array. 1815 */ 1816 static inline uint16_t 1817 rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id, 1818 struct rte_crypto_op **ops, uint16_t nb_ops) 1819 { 1820 const struct rte_crypto_fp_ops *fp_ops; 1821 void *qp; 1822 1823 rte_cryptodev_trace_dequeue_burst(dev_id, qp_id, (void **)ops, nb_ops); 1824 1825 fp_ops = &rte_crypto_fp_ops[dev_id]; 1826 qp = fp_ops->qp.data[qp_id]; 1827 1828 nb_ops = fp_ops->dequeue_burst(qp, ops, nb_ops); 1829 1830 #ifdef RTE_CRYPTO_CALLBACKS 1831 if (unlikely(fp_ops->qp.deq_cb != NULL)) { 1832 struct rte_cryptodev_cb_rcu *list; 1833 struct rte_cryptodev_cb *cb; 1834 1835 /* __ATOMIC_RELEASE memory order was used when the 1836 * call back was inserted into the list. 1837 * Since there is a clear dependency between loading 1838 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is 1839 * not required. 1840 */ 1841 list = &fp_ops->qp.deq_cb[qp_id]; 1842 rte_rcu_qsbr_thread_online(list->qsbr, 0); 1843 cb = __atomic_load_n(&list->next, __ATOMIC_RELAXED); 1844 1845 while (cb != NULL) { 1846 nb_ops = cb->fn(dev_id, qp_id, ops, nb_ops, 1847 cb->arg); 1848 cb = cb->next; 1849 }; 1850 1851 rte_rcu_qsbr_thread_offline(list->qsbr, 0); 1852 } 1853 #endif 1854 return nb_ops; 1855 } 1856 1857 /** 1858 * Enqueue a burst of operations for processing on a crypto device. 1859 * 1860 * The rte_cryptodev_enqueue_burst() function is invoked to place 1861 * crypto operations on the queue *qp_id* of the device designated by 1862 * its *dev_id*. 1863 * 1864 * The *nb_ops* parameter is the number of operations to process which are 1865 * supplied in the *ops* array of *rte_crypto_op* structures. 1866 * 1867 * The rte_cryptodev_enqueue_burst() function returns the number of 1868 * operations it actually enqueued for processing. A return value equal to 1869 * *nb_ops* means that all packets have been enqueued. 1870 * 1871 * @param dev_id The identifier of the device. 1872 * @param qp_id The index of the queue pair which packets are 1873 * to be enqueued for processing. The value 1874 * must be in the range [0, nb_queue_pairs - 1] 1875 * previously supplied to 1876 * *rte_cryptodev_configure*. 1877 * @param ops The address of an array of *nb_ops* pointers 1878 * to *rte_crypto_op* structures which contain 1879 * the crypto operations to be processed. 1880 * @param nb_ops The number of operations to process. 1881 * 1882 * @return 1883 * The number of operations actually enqueued on the crypto device. The return 1884 * value can be less than the value of the *nb_ops* parameter when the 1885 * crypto devices queue is full or if invalid parameters are specified in 1886 * a *rte_crypto_op*. 1887 */ 1888 static inline uint16_t 1889 rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id, 1890 struct rte_crypto_op **ops, uint16_t nb_ops) 1891 { 1892 const struct rte_crypto_fp_ops *fp_ops; 1893 void *qp; 1894 1895 fp_ops = &rte_crypto_fp_ops[dev_id]; 1896 qp = fp_ops->qp.data[qp_id]; 1897 #ifdef RTE_CRYPTO_CALLBACKS 1898 if (unlikely(fp_ops->qp.enq_cb != NULL)) { 1899 struct rte_cryptodev_cb_rcu *list; 1900 struct rte_cryptodev_cb *cb; 1901 1902 /* __ATOMIC_RELEASE memory order was used when the 1903 * call back was inserted into the list. 1904 * Since there is a clear dependency between loading 1905 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is 1906 * not required. 1907 */ 1908 list = &fp_ops->qp.enq_cb[qp_id]; 1909 rte_rcu_qsbr_thread_online(list->qsbr, 0); 1910 cb = __atomic_load_n(&list->next, __ATOMIC_RELAXED); 1911 1912 while (cb != NULL) { 1913 nb_ops = cb->fn(dev_id, qp_id, ops, nb_ops, 1914 cb->arg); 1915 cb = cb->next; 1916 }; 1917 1918 rte_rcu_qsbr_thread_offline(list->qsbr, 0); 1919 } 1920 #endif 1921 1922 rte_cryptodev_trace_enqueue_burst(dev_id, qp_id, (void **)ops, nb_ops); 1923 return fp_ops->enqueue_burst(qp, ops, nb_ops); 1924 } 1925 1926 1927 1928 #ifdef __cplusplus 1929 } 1930 #endif 1931 1932 #endif /* _RTE_CRYPTODEV_H_ */ 1933