third_party/mbedtls/repo/include/mbedtls/aesni.h

   1 /**
   2  * \file aesni.h
   3  *
   4  * \brief AES-NI for hardware AES acceleration on some Intel processors
   5  *
   6  * \warning These functions are only for internal use by other library
   7  *          functions; you must not call them directly.
   8  */
   9 /*
  10  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  11  *  SPDX-License-Identifier: Apache-2.0
  12  *
  13  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  14  *  not use this file except in compliance with the License.
  15  *  You may obtain a copy of the License at
  16  *
  17  *  http://www.apache.org/licenses/LICENSE-2.0
  18  *
  19  *  Unless required by applicable law or agreed to in writing, software
  20  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  21  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22  *  See the License for the specific language governing permissions and
  23  *  limitations under the License.
  24  *
  25  *  This file is part of mbed TLS (https://tls.mbed.org)
  26  */
  27 #ifndef MBEDTLS_AESNI_H
  28 #define MBEDTLS_AESNI_H
  29
  30 #if !defined(MBEDTLS_CONFIG_FILE)
  31 #include "config.h"
  32 #else
  33 #include MBEDTLS_CONFIG_FILE
  34 #endif
  35
  36 #include "aes.h"
  37
  38 #define MBEDTLS_AESNI_AES      0x02000000u
  39 #define MBEDTLS_AESNI_CLMUL    0x00000002u
  40
  41 #if defined(MBEDTLS_HAVE_ASM) && defined(__GNUC__) &&  \
  42     ( defined(__amd64__) || defined(__x86_64__) )   &&  \
  43     ! defined(MBEDTLS_HAVE_X86_64)
  44 #define MBEDTLS_HAVE_X86_64
  45 #endif
  46
  47 #if defined(MBEDTLS_HAVE_X86_64)
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /**
  54  * \brief          Internal function to detect the AES-NI feature in CPUs.
  55  *
  56  * \note           This function is only for internal use by other library
  57  *                 functions; you must not call it directly.
  58  *
  59  * \param what     The feature to detect
  60  *                 (MBEDTLS_AESNI_AES or MBEDTLS_AESNI_CLMUL)
  61  *
  62  * \return         1 if CPU has support for the feature, 0 otherwise
  63  */
  64 int mbedtls_aesni_has_support( unsigned int what );
  65
  66 /**
  67  * \brief          Internal AES-NI AES-ECB block encryption and decryption
  68  *
  69  * \note           This function is only for internal use by other library
  70  *                 functions; you must not call it directly.
  71  *
  72  * \param ctx      AES context
  73  * \param mode     MBEDTLS_AES_ENCRYPT or MBEDTLS_AES_DECRYPT
  74  * \param input    16-byte input block
  75  * \param output   16-byte output block
  76  *
  77  * \return         0 on success (cannot fail)
  78  */
  79 int mbedtls_aesni_crypt_ecb( mbedtls_aes_context *ctx,
  80                              int mode,
  81                              const unsigned char input[16],
  82                              unsigned char output[16] );
  83
  84 /**
  85  * \brief          Internal GCM multiplication: c = a * b in GF(2^128)
  86  *
  87  * \note           This function is only for internal use by other library
  88  *                 functions; you must not call it directly.
  89  *
  90  * \param c        Result
  91  * \param a        First operand
  92  * \param b        Second operand
  93  *
  94  * \note           Both operands and result are bit strings interpreted as
  95  *                 elements of GF(2^128) as per the GCM spec.
  96  */
  97 void mbedtls_aesni_gcm_mult( unsigned char c[16],
  98                              const unsigned char a[16],
  99                              const unsigned char b[16] );
 100
 101 /**
 102  * \brief           Internal round key inversion. This function computes
 103  *                  decryption round keys from the encryption round keys.
 104  *
 105  * \note            This function is only for internal use by other library
 106  *                  functions; you must not call it directly.
 107  *
 108  * \param invkey    Round keys for the equivalent inverse cipher
 109  * \param fwdkey    Original round keys (for encryption)
 110  * \param nr        Number of rounds (that is, number of round keys minus one)
 111  */
 112 void mbedtls_aesni_inverse_key( unsigned char *invkey,
 113                                 const unsigned char *fwdkey,
 114                                 int nr );
 115
 116 /**
 117  * \brief           Internal key expansion for encryption
 118  *
 119  * \note            This function is only for internal use by other library
 120  *                  functions; you must not call it directly.
 121  *
 122  * \param rk        Destination buffer where the round keys are written
 123  * \param key       Encryption key
 124  * \param bits      Key size in bits (must be 128, 192 or 256)
 125  *
 126  * \return          0 if successful, or MBEDTLS_ERR_AES_INVALID_KEY_LENGTH
 127  */
 128 int mbedtls_aesni_setkey_enc( unsigned char *rk,
 129                               const unsigned char *key,
 130                               size_t bits );
 131
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135
 136 #endif /* MBEDTLS_HAVE_X86_64 */
 137
 138 #endif /* MBEDTLS_AESNI_H */