rte_pmd_cnxk_crypto.h(3)

📦
version 25.11.3 · 11 versions
, in ubuntu resolute, ubuntu stonking

💖 NAME 💖

rte_pmd_cnxk_crypto.h — bestie, this is the manual page for it, page 3 of the Library Functions Manual, and it's all about the Marvell CNXK Crypto PMD. ✨

🌸 SYNOPSIS 🌸

#include <stdbool.h>
#include <stdint.h>
#include <rte_compat.h>
#include <rte_crypto.h>
#include <rte_security.h>

🎀 Data Structures 🎀

  • struct rte_pmd_cnxk_crypto_qp_stats — Crypto CNXK queue pair stats. 📊
  • struct rte_pmd_cnxk_crypto_sess — Crypto CNXK PMD session structure. 🗂️
  • struct rte_pmd_cnxk_crypto_ae_ec_group_params — AE EC (Elliptic Curve) group parameters structure. 🌀

🌈 Enumerations 🌈

  • enum rte_pmd_cnxk_ae_ec_id

👑 Functions 👑

__rte_experimental struct rte_pmd_cnxk_crypto_qptr *
    rte_pmd_cnxk_crypto_qptr_get (uint8_t dev_id, uint16_t qp_id)
__rte_experimental void rte_pmd_cnxk_crypto_submit (struct
    rte_pmd_cnxk_crypto_qptr *qptr, void *inst, uint16_t nb_inst)
__rte_experimental int rte_pmd_cnxk_crypto_cptr_flush (struct
    rte_pmd_cnxk_crypto_qptr *qptr, struct rte_pmd_cnxk_crypto_cptr
    *cptr, bool invalidate)
__rte_experimental struct rte_pmd_cnxk_crypto_cptr *
    rte_pmd_cnxk_crypto_cptr_get (struct rte_pmd_cnxk_crypto_sess
    *rte_sess)
__rte_experimental int rte_pmd_cnxk_crypto_cptr_read (struct
    rte_pmd_cnxk_crypto_qptr *qptr, struct rte_pmd_cnxk_crypto_cptr
    *cptr, void *data, uint32_t len)
__rte_experimental int rte_pmd_cnxk_crypto_cptr_write (struct
    rte_pmd_cnxk_crypto_qptr *qptr, struct rte_pmd_cnxk_crypto_cptr
    *cptr, void *data, uint32_t len)
__rte_experimental int rte_pmd_cnxk_crypto_qp_stats_get (struct
    rte_pmd_cnxk_crypto_qptr *qptr, struct rte_pmd_cnxk_crypto_qp_stats
    *stats)
__rte_experimental const uint64_t * rte_pmd_cnxk_ae_fpm_table_get
    (uint8_t dev_id)
__rte_experimental const struct rte_pmd_cnxk_crypto_ae_ec_group_params
    ** rte_pmd_cnxk_ae_ec_grp_table_get (uint8_t dev_id, uint16_t
    *nb_max_entries)

💅 Detailed Description 💅

Marvell CNXK Crypto PMD specific functions. That's the whole vibe of this header, fr fr.

Definition in file rte_pmd_cnxk_crypto.h. 📄

🦋 Enumeration Type Documentation 🦋

enum rte_pmd_cnxk_ae_ec_id

Enumerates supported elliptic curves. 🌈

Definition at line 26 of file rte_pmd_cnxk_crypto.h.

✨ Function Documentation ✨

🫶 __rte_experimental struct rte_pmd_cnxk_crypto_qptr * rte_pmd_cnxk_crypto_qptr_get (uint8_t dev_id, uint16_t qp_id)

Get queue pointer of a specific queue in a cryptodev. like, the pointer you need to do anything. 🔑

Parameters

  • dev_id — Device identifier of cryptodev device.
  • qp_id — Index of the queue pair.

Returns

  • On success, pointer to queue pair structure that would be the input to submit APIs. 🎉
  • NULL on error. 😭

💜 __rte_experimental void rte_pmd_cnxk_crypto_submit (struct rte_pmd_cnxk_crypto_qptr * qptr, void * inst, uint16_t nb_inst)

Submit CPT instruction (cpt_inst_s) to hardware (CPT). 🚀

The qp is a pointer obtained from rte_pmd_cnxk_crypto_qp_get. Application should make sure it doesn't overflow the internal hardware queues. It may do so by making sure the inflight packets are not more than the number of descriptors configured.

This API may be called only after the cryptodev and queue pair is configured and is started. ⚠️

Parameters

  • qptr — Pointer obtained with rte_pmd_cnxk_crypto_qptr_get.
  • inst — Pointer to an array of instructions prepared by application.
  • nb_inst — Number of instructions.

🌸 __rte_experimental int rte_pmd_cnxk_crypto_cptr_flush (struct rte_pmd_cnxk_crypto_qptr * qptr, struct rte_pmd_cnxk_crypto_cptr * cptr, bool invalidate)

Flush the CPTR from CPT CTX cache. 🧹

This API must be called only after the cryptodev and queue pair is configured and is started.

Parameters

  • qptr — Pointer obtained with rte_pmd_cnxk_crypto_qptr_get.
  • cptr — Pointer obtained with rte_pmd_cnxk_crypto_cptr_get or any valid CPTR address that can be used with CPT CTX cache.
  • invalidate — If true, invalidate the CTX cache entry. If false, flush the CTX cache entry.

Returns

  • 0 on success. ✅
  • Negative value on error. 💀
    • -EINVAL if the input parameters are invalid.
    • -ENOTSUP if the operation is not supported.
    • -EAGAIN if the operation is not successful.
    • -EFAULT if the operation failed.

🧚 __rte_experimental struct rte_pmd_cnxk_crypto_cptr * rte_pmd_cnxk_crypto_cptr_get (struct rte_pmd_cnxk_crypto_sess * rte_sess)

Get the HW CPTR pointer from the rte_crypto/rte_security session. 🎟️

Parameters

  • rte_sess — Pointer to the structure holding rte_cryptodev or rte_security session.

Returns

  • On success, pointer to the HW CPTR. 🌟
  • NULL on error. 😭

🍓 __rte_experimental int rte_pmd_cnxk_crypto_cptr_read (struct rte_pmd_cnxk_crypto_qptr * qptr, struct rte_pmd_cnxk_crypto_cptr * cptr, void * data, uint32_t len)

Read HW context (CPTR). 📖

Parameters

  • qptr — Pointer obtained with rte_pmd_cnxk_crypto_qptr_get.
  • cptr — Pointer obtained with rte_pmd_cnxk_crypto_cptr_get or any valid CPTR address that can be used with CPT CTX cache.
  • data — Destination pointer to copy CPTR context for application.
  • len — Length of CPTR context to copy into data parameter.

Returns

  • 0 On success. ✅
  • Negative value on error. 💀
    • -EINVAL if the input parameters are invalid.
    • -ENOTSUP if the operation is not supported.
    • -EAGAIN if the operation is not successful.
    • -EFAULT if the operation failed.

🌟 __rte_experimental int rte_pmd_cnxk_crypto_cptr_write (struct rte_pmd_cnxk_crypto_qptr * qptr, struct rte_pmd_cnxk_crypto_cptr * cptr, void * data, uint32_t len)

Write HW context (CPTR). ✍️

Parameters

  • qptr — Pointer obtained with rte_pmd_cnxk_crypto_qptr_get.
  • cptr — Pointer obtained with rte_pmd_cnxk_crypto_cptr_get or any valid CPTR address that can be used with CPT CTX cache.
  • data — Source pointer to copy CPTR context from application.
  • len — Length of CPTR context to copy from data parameter.

Returns

  • 0 On success. ✅
  • Negative value on error. 💀
    • -EINVAL if the input parameters are invalid.
    • -ENOTSUP if the operation is not supported.
    • -EAGAIN if the operation is not successful.
    • -EFAULT if the operation failed.

📊 __rte_experimental int rte_pmd_cnxk_crypto_qp_stats_get (struct rte_pmd_cnxk_crypto_qptr * qptr, struct rte_pmd_cnxk_crypto_qp_stats * stats)

Get the HW Queue Pair (LF) stats. 👀

Parameters

  • qptr — Pointer obtained with rte_pmd_cnxk_crypto_qptr_get.
  • stats — Pointer to the structure where stats will be copied.

Returns

  • 0 On success. ✅
  • Negative value on error. 💀
    • -EINVAL if the input parameters are invalid.

🌀 __rte_experimental const uint64_t * rte_pmd_cnxk_ae_fpm_table_get (uint8_t dev_id)

Retrieves the addresses of the AE FPM (Finite Precision Math) tables. 🧮

This API should be called only after the cryptodev device has been successfully configured. The returned pointer reference memory that is valid as long as the device remains configured and is not destroyed or reconfigured. If the device is reconfigured or destroyed, the memory referenced by the returned pointer becomes invalid and must not be used. 💀⚠️

bestie, that last sentence is not a drill — that pointer goes stale the second the device gets reconfigured or destroyed.

Parameters

  • dev_id — Device identifier of cryptodev device.

Returns

  • On success pointer to the AE FPM table addresses. 🎉
  • NULL on error. 😭

🧸 __rte_experimental const struct rte_pmd_cnxk_crypto_ae_ec_group_params ** rte_pmd_cnxk_ae_ec_grp_table_get (uint8_t dev_id, uint16_t * nb_max_entries)

Retrieves the addresses of the AE EC group table. 🗺️

This API should be called only after the cryptodev device has been successfully configured. The returned pointer reference memory that is valid as long as the device remains configured and is not destroyed or reconfigured. If the device is reconfigured or destroyed, the memory referenced by the returned pointer becomes invalid and must not be used. 💀⚠️

same energy as above, no cap — stale pointer, do not touch.

Parameters

  • dev_id — Device identifier of cryptodev device.
  • nb_max_entries — Pointer to store the maximum number of entries in the EC group table. This value is set by the function to indicate how many entries can be retrieved from the table.

Returns

  • On success, pointer to the AE EC group table structure address. 🌟
  • NULL on error. 😭

🎀 Author 🎀

Generated automatically by Doxygen for DPDK from the source code. 🤖✨

okay that's the whole page, bestie, you ate it 💅 this was DPDK, Version 25.11.3, for the rte_pmd_cnxk_crypto.h(3) page — go be the main character of your own cryptodev now 🦋👑💖

📦 where this page comes from