drivers/crypto/aesni_gcm/aesni_gcm_pmd_private.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016-2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_AESNI_GCM_PMD_PRIVATE_H_
   6 #define _RTE_AESNI_GCM_PMD_PRIVATE_H_
   7
   8 #include "aesni_gcm_ops.h"
   9
  10 /*
  11  * IMB_VERSION_NUM macro was introduced in version Multi-buffer 0.50,
  12  * so if macro is not defined, it means that the version is 0.49.
  13  */
  14 #if !defined(IMB_VERSION_NUM)
  15 #define IMB_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
  16 #define IMB_VERSION_NUM IMB_VERSION(0, 49, 0)
  17 #endif
  18
  19 #define CRYPTODEV_NAME_AESNI_GCM_PMD    crypto_aesni_gcm
  20 /**< AES-NI GCM PMD device name */
  21
  22 /** AES-NI GCM PMD  LOGTYPE DRIVER */
  23 int aesni_gcm_logtype_driver;
  24 #define AESNI_GCM_LOG(level, fmt, ...) \
  25         rte_log(RTE_LOG_ ## level, aesni_gcm_logtype_driver,    \
  26                         "%s() line %u: "fmt "\n", __func__, __LINE__,   \
  27                                         ## __VA_ARGS__)
  28
  29 /* Maximum length for digest */
  30 #define DIGEST_LENGTH_MAX 16
  31
  32 /** private data structure for each virtual AESNI GCM device */
  33 struct aesni_gcm_private {
  34         enum aesni_gcm_vector_mode vector_mode;
  35         /**< Vector mode */
  36         unsigned max_nb_queue_pairs;
  37         /**< Max number of queue pairs supported by device */
  38 };
  39
  40 struct aesni_gcm_qp {
  41         const struct aesni_gcm_ops *ops;
  42         /**< Architecture dependent function pointer table of the gcm APIs */
  43         struct rte_ring *processed_pkts;
  44         /**< Ring for placing process packets */
  45         struct gcm_context_data gdata_ctx; /* (16 * 5) + 8 = 88 B */
  46         /**< GCM parameters */
  47         struct rte_cryptodev_stats qp_stats; /* 8 * 4 = 32 B */
  48         /**< Queue pair statistics */
  49         struct rte_mempool *sess_mp;
  50         /**< Session Mempool */
  51         struct rte_mempool *sess_mp_priv;
  52         /**< Session Private Data Mempool */
  53         uint16_t id;
  54         /**< Queue Pair Identifier */
  55         char name[RTE_CRYPTODEV_NAME_MAX_LEN];
  56         /**< Unique Queue Pair Name */
  57         uint8_t temp_digest[DIGEST_LENGTH_MAX];
  58         /**< Buffer used to store the digest generated
  59          * by the driver when verifying a digest provided
  60          * by the user (using authentication verify operation)
  61          */
  62 } __rte_cache_aligned;
  63
  64
  65 enum aesni_gcm_operation {
  66         AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION,
  67         AESNI_GCM_OP_AUTHENTICATED_DECRYPTION,
  68         AESNI_GMAC_OP_GENERATE,
  69         AESNI_GMAC_OP_VERIFY
  70 };
  71
  72 /** AESNI GCM private session structure */
  73 struct aesni_gcm_session {
  74         struct {
  75                 uint16_t length;
  76                 uint16_t offset;
  77         } iv;
  78         /**< IV parameters */
  79         uint16_t aad_length;
  80         /**< AAD length */
  81         uint16_t req_digest_length;
  82         /**< Requested digest length */
  83         uint16_t gen_digest_length;
  84         /**< Generated digest length */
  85         enum aesni_gcm_operation op;
  86         /**< GCM operation type */
  87         enum aesni_gcm_key key;
  88         /**< GCM key type */
  89         struct gcm_key_data gdata_key;
  90         /**< GCM parameters */
  91 };
  92
  93
  94 /**
  95  * Setup GCM session parameters
  96  * @param       sess    aesni gcm session structure
  97  * @param       xform   crypto transform chain
  98  *
  99  * @return
 100  * - On success returns 0
 101  * - On failure returns error code < 0
 102  */
 103 extern int
 104 aesni_gcm_set_session_parameters(const struct aesni_gcm_ops *ops,
 105                 struct aesni_gcm_session *sess,
 106                 const struct rte_crypto_sym_xform *xform);
 107
 108
 109 /**
 110  * Device specific operations function pointer structure */
 111 extern struct rte_cryptodev_ops *rte_aesni_gcm_pmd_ops;
 112
 113
 114 #endif /* _RTE_AESNI_GCM_PMD_PRIVATE_H_ */