esp32_s2_crypto_cipher.h
Go to the documentation of this file.
1 /**
2  * @file esp32_s2_crypto_cipher.h
3  * @brief ESP32-S2 cipher hardware accelerator
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _ESP32_S2_CRYPTO_CIPHER_H
32 #define _ESP32_S2_CRYPTO_CIPHER_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Cipher hardware accelerator
38 #ifndef ESP32_S2_CRYPTO_CIPHER_SUPPORT
39  #define ESP32_S2_CRYPTO_CIPHER_SUPPORT DISABLED
40 #elif (ESP32_S2_CRYPTO_CIPHER_SUPPORT != ENABLED && ESP32_S2_CRYPTO_CIPHER_SUPPORT != DISABLED)
41  #error ESP32_S2_CRYPTO_CIPHER_SUPPORT parameter is not valid
42 #endif
43 
44 //AES Operation Mode register
45 #define AES_MODE_ENC 0x00000000
46 #define AES_MODE_DEC 0x00000004
47 #define AES_MODE_128_BITS 0x00000000
48 #define AES_MODE_192_BITS 0x00000001
49 #define AES_MODE_256_BITS 0x00000002
50 
51 //AES Block Mode register
52 #define AES_BLOCK_MODE_ECB 0x00000000
53 #define AES_BLOCK_MODE_CBC 0x00000001
54 #define AES_BLOCK_MODE_OFB 0x00000002
55 #define AES_BLOCK_MODE_CTR 0x00000003
56 #define AES_BLOCK_MODE_CFB8 0x00000004
57 #define AES_BLOCK_MODE_CFB128 0x00000005
58 #define AES_BLOCK_MODE_GCM 0x00000006
59 
60 //Endianness Configuration register
61 #define AES_ENDIAN_DEFAULT 0x0000003F
62 
63 //C++ guard
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67 
68 //Cipher related functions
69 void esp32s2AesInit(void);
70 
71 //C++ guard
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif
void esp32s2AesInit(void)
AES module initialization.
General definitions for cryptographic algorithms.