drivers/crypto/dpaa2_sec/dpaa2_sec_priv.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved.
   5  *   Copyright (c) 2016 NXP. 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  Freescale Semiconductor, Inc 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_DPAA2_SEC_PMD_PRIVATE_H_
  35 #define _RTE_DPAA2_SEC_PMD_PRIVATE_H_
  36
  37 #define MAX_QUEUES              64
  38 #define MAX_DESC_SIZE           64
  39 /** private data structure for each DPAA2_SEC device */
  40 struct dpaa2_sec_dev_private {
  41         void *mc_portal; /**< MC Portal for configuring this device */
  42         void *hw; /**< Hardware handle for this device.Used by NADK framework */
  43         int32_t hw_id; /**< An unique ID of this device instance */
  44         int32_t vfio_fd; /**< File descriptor received via VFIO */
  45         uint16_t token; /**< Token required by DPxxx objects */
  46         unsigned int max_nb_queue_pairs;
  47         /**< Max number of queue pairs supported by device */
  48         unsigned int max_nb_sessions;
  49         /**< Max number of sessions supported by device */
  50 };
  51
  52 struct dpaa2_sec_qp {
  53         struct dpaa2_queue rx_vq;
  54         struct dpaa2_queue tx_vq;
  55 };
  56
  57 enum shr_desc_type {
  58         DESC_UPDATE,
  59         DESC_FINAL,
  60         DESC_INITFINAL,
  61 };
  62
  63 #define DIR_ENC                 1
  64 #define DIR_DEC                 0
  65
  66 /* SEC Flow Context Descriptor */
  67 struct sec_flow_context {
  68         /* word 0 */
  69         uint16_t word0_sdid;            /* 11-0  SDID */
  70         uint16_t word0_res;             /* 31-12 reserved */
  71
  72         /* word 1 */
  73         uint8_t word1_sdl;              /* 5-0 SDL */
  74                                         /* 7-6 reserved */
  75
  76         uint8_t word1_bits_15_8;        /* 11-8 CRID */
  77                                         /* 14-12 reserved */
  78                                         /* 15 CRJD */
  79
  80         uint8_t word1_bits23_16;        /* 16  EWS */
  81                                         /* 17 DAC */
  82                                         /* 18,19,20 ? */
  83                                         /* 23-21 reserved */
  84
  85         uint8_t word1_bits31_24;        /* 24 RSC */
  86                                         /* 25 RBMT */
  87                                         /* 31-26 reserved */
  88
  89         /* word 2  RFLC[31-0] */
  90         uint32_t word2_rflc_31_0;
  91
  92         /* word 3  RFLC[63-32] */
  93         uint32_t word3_rflc_63_32;
  94
  95         /* word 4 */
  96         uint16_t word4_iicid;           /* 15-0  IICID */
  97         uint16_t word4_oicid;           /* 31-16 OICID */
  98
  99         /* word 5 */
 100         uint32_t word5_ofqid:24;                /* 23-0 OFQID */
 101         uint32_t word5_31_24:8;
 102                                         /* 24 OSC */
 103                                         /* 25 OBMT */
 104                                         /* 29-26 reserved */
 105                                         /* 31-30 ICR */
 106
 107         /* word 6 */
 108         uint32_t word6_oflc_31_0;
 109
 110         /* word 7 */
 111         uint32_t word7_oflc_63_32;
 112
 113         /* Word 8-15 storage profiles */
 114         uint16_t dl;                    /**<  DataLength(correction) */
 115         uint16_t reserved;              /**< reserved */
 116         uint16_t dhr;                   /**< DataHeadRoom(correction) */
 117         uint16_t mode_bits;             /**< mode bits */
 118         uint16_t bpv0;                  /**< buffer pool0 valid */
 119         uint16_t bpid0;                 /**< Bypass Memory Translation */
 120         uint16_t bpv1;                  /**< buffer pool1 valid */
 121         uint16_t bpid1;                 /**< Bypass Memory Translation */
 122         uint64_t word_12_15[2];         /**< word 12-15 are reserved */
 123 };
 124
 125 struct sec_flc_desc {
 126         struct sec_flow_context flc;
 127         uint32_t desc[MAX_DESC_SIZE];
 128 };
 129
 130 struct ctxt_priv {
 131         struct sec_flc_desc flc_desc[0];
 132 };
 133
 134 enum dpaa2_sec_op_type {
 135         DPAA2_SEC_NONE,  /*!< No Cipher operations*/
 136         DPAA2_SEC_CIPHER,/*!< CIPHER operations */
 137         DPAA2_SEC_AUTH,  /*!< Authentication Operations */
 138         DPAA2_SEC_CIPHER_HASH,  /*!< Authenticated Encryption with
 139                                  * associated data
 140                                  */
 141         DPAA2_SEC_HASH_CIPHER,  /*!< Encryption with Authenticated
 142                                  * associated data
 143                                  */
 144         DPAA2_SEC_IPSEC, /*!< IPSEC protocol operations*/
 145         DPAA2_SEC_PDCP,  /*!< PDCP protocol operations*/
 146         DPAA2_SEC_PKC,   /*!< Public Key Cryptographic Operations */
 147         DPAA2_SEC_MAX
 148 };
 149
 150 struct dpaa2_sec_cipher_ctxt {
 151         struct {
 152                 uint8_t *data;
 153                 uint16_t length;
 154         } iv;   /**< Initialisation vector parameters */
 155         uint8_t *init_counter;  /*!< Set initial counter for CTR mode */
 156 };
 157
 158 struct dpaa2_sec_auth_ctxt {
 159         uint8_t trunc_len;              /*!< Length for output ICV, should
 160                                          * be 0 if no truncation required
 161                                          */
 162 };
 163
 164 struct dpaa2_sec_aead_ctxt {
 165         struct {
 166                 uint8_t *data;
 167                 uint16_t length;
 168         } iv;   /**< Initialisation vector parameters */
 169         uint16_t auth_only_len; /*!< Length of data for Auth only */
 170         uint8_t auth_cipher_text;       /**< Authenticate/cipher ordering */
 171         uint8_t trunc_len;              /*!< Length for output ICV, should
 172                                          * be 0 if no truncation required
 173                                          */
 174 };
 175
 176 typedef struct dpaa2_sec_session_entry {
 177         void *ctxt;
 178         uint8_t ctxt_type;
 179         uint8_t dir;         /*!< Operation Direction */
 180         enum rte_crypto_cipher_algorithm cipher_alg; /*!< Cipher Algorithm*/
 181         enum rte_crypto_auth_algorithm auth_alg; /*!< Authentication Algorithm*/
 182         struct {
 183                 uint8_t *data;  /**< pointer to key data */
 184                 size_t length;  /**< key length in bytes */
 185         } cipher_key;
 186         struct {
 187                 uint8_t *data;  /**< pointer to key data */
 188                 size_t length;  /**< key length in bytes */
 189         } auth_key;
 190         struct {
 191                 uint16_t length; /**< IV length in bytes */
 192                 uint16_t offset; /**< IV offset in bytes */
 193         } iv;
 194         uint8_t status;
 195         union {
 196                 struct dpaa2_sec_cipher_ctxt cipher_ctxt;
 197                 struct dpaa2_sec_auth_ctxt auth_ctxt;
 198                 struct dpaa2_sec_aead_ctxt aead_ctxt;
 199         } ext_params;
 200 } dpaa2_sec_session;
 201
 202 static const struct rte_cryptodev_capabilities dpaa2_sec_capabilities[] = {
 203         {       /* MD5 HMAC */
 204                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 205                 {.sym = {
 206                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 207                         {.auth = {
 208                                 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
 209                                 .block_size = 64,
 210                                 .key_size = {
 211                                         .min = 64,
 212                                         .max = 64,
 213                                         .increment = 0
 214                                 },
 215                                 .digest_size = {
 216                                         .min = 16,
 217                                         .max = 16,
 218                                         .increment = 0
 219                                 },
 220                                 .aad_size = { 0 }
 221                         }, }
 222                 }, }
 223         },
 224         {       /* SHA1 HMAC */
 225                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 226                 {.sym = {
 227                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 228                         {.auth = {
 229                                 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
 230                                 .block_size = 64,
 231                                 .key_size = {
 232                                         .min = 64,
 233                                         .max = 64,
 234                                         .increment = 0
 235                                 },
 236                                 .digest_size = {
 237                                         .min = 20,
 238                                         .max = 20,
 239                                         .increment = 0
 240                                 },
 241                                 .aad_size = { 0 }
 242                         }, }
 243                 }, }
 244         },
 245         {       /* SHA224 HMAC */
 246                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 247                 {.sym = {
 248                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 249                         {.auth = {
 250                                 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
 251                                 .block_size = 64,
 252                                 .key_size = {
 253                                         .min = 64,
 254                                         .max = 64,
 255                                         .increment = 0
 256                                 },
 257                                 .digest_size = {
 258                                         .min = 28,
 259                                         .max = 28,
 260                                         .increment = 0
 261                                 },
 262                                 .aad_size = { 0 }
 263                         }, }
 264                 }, }
 265         },
 266         {       /* SHA256 HMAC */
 267                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 268                 {.sym = {
 269                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 270                         {.auth = {
 271                                 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
 272                                 .block_size = 64,
 273                                 .key_size = {
 274                                         .min = 64,
 275                                         .max = 64,
 276                                         .increment = 0
 277                                 },
 278                                 .digest_size = {
 279                                                 .min = 32,
 280                                                 .max = 32,
 281                                                 .increment = 0
 282                                 },
 283                                 .aad_size = { 0 }
 284                                 }, }
 285                         }, }
 286                 },
 287         {       /* SHA384 HMAC */
 288                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 289                 {.sym = {
 290                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 291                         {.auth = {
 292                                 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
 293                                 .block_size = 128,
 294                                 .key_size = {
 295                                         .min = 128,
 296                                         .max = 128,
 297                                         .increment = 0
 298                                 },
 299                                 .digest_size = {
 300                                         .min = 48,
 301                                         .max = 48,
 302                                         .increment = 0
 303                                 },
 304                                 .aad_size = { 0 }
 305                         }, }
 306                 }, }
 307         },
 308         {       /* SHA512 HMAC */
 309                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 310                 {.sym = {
 311                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
 312                         {.auth = {
 313                                 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
 314                                 .block_size = 128,
 315                                 .key_size = {
 316                                         .min = 128,
 317                                         .max = 128,
 318                                         .increment = 0
 319                                 },
 320                                 .digest_size = {
 321                                         .min = 64,
 322                                         .max = 64,
 323                                         .increment = 0
 324                                 },
 325                                 .aad_size = { 0 }
 326                         }, }
 327                 }, }
 328         },
 329         {       /* AES CBC */
 330                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 331                 {.sym = {
 332                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 333                         {.cipher = {
 334                                 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
 335                                 .block_size = 16,
 336                                 .key_size = {
 337                                         .min = 16,
 338                                         .max = 32,
 339                                         .increment = 8
 340                                 },
 341                                 .iv_size = {
 342                                         .min = 16,
 343                                         .max = 16,
 344                                         .increment = 0
 345                                 }
 346                         }, }
 347                 }, }
 348         },
 349         {       /* 3DES CBC */
 350                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
 351                 {.sym = {
 352                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
 353                         {.cipher = {
 354                                 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
 355                                 .block_size = 8,
 356                                 .key_size = {
 357                                         .min = 16,
 358                                         .max = 24,
 359                                         .increment = 8
 360                                 },
 361                                 .iv_size = {
 362                                         .min = 8,
 363                                         .max = 8,
 364                                         .increment = 0
 365                                 }
 366                         }, }
 367                 }, }
 368         },
 369
 370         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
 371 };
 372 #endif /* _RTE_DPAA2_SEC_PMD_PRIVATE_H_ */