AM263x MCU+ SDK  09.02.00
dthe_aes.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022-24 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
48 #ifndef DTHE_AES_H_
49 #define DTHE_AES_H_
50 
51 /* ========================================================================== */
52 /* Include Files */
53 /* ========================================================================== */
54 #include <stdint.h>
56 #include <kernel/dpl/SystemP.h>
57 #include <drivers/hw_include/cslr.h>
58 #include <security/crypto/dthe/hw_include/cslr_aes.h>
59 
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
64 /* ========================================================================== */
65 /* Macros & Typedefs */
66 /* ========================================================================== */
68 #define DTHE_AES_ECB_MODE (0x00000000U)
69 
70 #define DTHE_AES_CBC_MODE (0x00000001U)
71 
72 #define DTHE_AES_CTR_MODE (0x00000002U)
73 
74 #define DTHE_AES_ICM_MODE (0x00000004U)
75 
76 #define DTHE_AES_CFB_MODE (0x00000008U)
77 
78 #define DTHE_AES_F8_MODE (0x00000010U)
79 
80 #define DTHE_AES_F9_MODE (0x00000020U)
81 
82 #define DTHE_AES_XTS_MODE (0x00000040U)
83 
84 #define DTHE_AES_CBC_MAC_MODE (0x00000080U)
85 
86 #define DTHE_AES_CMAC_MODE (0x00000100U)
87 
89 #define DTHE_AES_KEY_128_SIZE (0x00000001U)
90 
91 #define DTHE_AES_KEY_192_SIZE (0x00000002U)
92 
93 #define DTHE_AES_KEY_256_SIZE (0x00000003U)
94 
96 #define DTHE_AES_ENCRYPT (0x016FE45DU)
97 
98 #define DTHE_AES_DECRYPT (0xDCBA4213U)
99 
101 #define DTHE_AES_CTR_WIDTH_16 (0x00000001U)
102 
103 #define DTHE_AES_CTR_WIDTH_32 (0x00000002U)
104 
105 #define DTHE_AES_CTR_WIDTH_64 (0x00000004U)
106 
107 #define DTHE_AES_CTR_WIDTH_96 (0x00000008U)
108 
109 #define DTHE_AES_CTR_WIDTH_128 (0x00000010U)
110 
112 #define DTHE_AES_ONE_SHOT_SUPPORT (0x00000000U)
113 
114 #define DTHE_AES_STREAM_INIT (0xAA11BB22U)
115 
116 #define DTHE_AES_STREAM_UPDATE (0x33CC44DDU)
117 
118 #define DTHE_AES_STREAM_FINISH (0xEE55FF66U)
119 
120 
121 
122 /* ========================================================================== */
123 /* Structure Declarations */
124 /* ========================================================================== */
125 
134 typedef enum DTHE_AES_Return_e
135 {
136  DTHE_AES_RETURN_SUCCESS = 0x62E699D9U,
137  DTHE_AES_RETURN_FAILURE = 0x904D041AU,
139 
164 typedef struct DTHE_AES_Params_t
165 {
167  uint32_t algoType;
168 
170  uint32_t opType;
171 
177 
182  uint32_t* ptrKey;
183 
187  uint32_t* ptrKey1;
188 
192  uint32_t* ptrKey2;
193 
197  uint8_t keyLen;
198 
202  uint32_t* ptrIV;
203 
209  uint32_t dataLenBytes;
210 
222  uint32_t* ptrEncryptedData;
223 
233  uint32_t* ptrPlainTextData;
234 
238  uint32_t* ptrTag;
239 
243  uint32_t counterWidth;
244 
245 
249  uint32_t streamState;
250 
260  uint32_t streamSize;
262 /* ========================================================================== */
263 /* Global Variables */
264 /* ========================================================================== */
265 
266 /* ========================================================================== */
267 /* Function Definitions */
268 /* ========================================================================== */
269 
279 
291 
301 
302 #ifdef __cplusplus
303 }
304 #endif
305 
306 #endif
307 
DTHE_AES_Params::counterWidth
uint32_t counterWidth
Definition: dthe_aes.h:243
DTHE_AES_Params
AES Driver Parameters This structure has all the parameters which are need by the AES Driver to perfo...
Definition: dthe_aes.h:165
DTHE_AES_Params::streamState
uint32_t streamState
Definition: dthe_aes.h:249
DTHE_AES_Params::keyLen
uint8_t keyLen
Length of the Key.
Definition: dthe_aes.h:197
dthe.h
This file contains the prototype of DTHE driver APIs.
SystemP.h
DTHE_AES_Params::ptrIV
uint32_t * ptrIV
Definition: dthe_aes.h:202
DTHE_AES_Params::algoType
uint32_t algoType
Definition: dthe_aes.h:167
DTHE_AES_Params::streamSize
uint32_t streamSize
Definition: dthe_aes.h:260
DTHE_AES_Params::dataLenBytes
uint32_t dataLenBytes
Definition: dthe_aes.h:209
DTHE_AES_Params::opType
uint32_t opType
Operation to be performed by the AES Driver.
Definition: dthe_aes.h:170
DTHE_AES_Params::ptrPlainTextData
uint32_t * ptrPlainTextData
Definition: dthe_aes.h:233
DTHE_AES_Params::ptrTag
uint32_t * ptrTag
Definition: dthe_aes.h:238
DTHE_AES_execute
DTHE_AES_Return_t DTHE_AES_execute(DTHE_Handle handle, const DTHE_AES_Params *ptrParams)
The function is used to execute the AES Driver with the specified parameters.
DTHE_AES_close
DTHE_AES_Return_t DTHE_AES_close(DTHE_Handle handle)
Function to close DTHE AES Driver.
DTHE_AES_Return_t
DTHE_AES_Return_t
DTHE AES Driver Error code.
Definition: dthe_aes.h:135
DTHE_AES_Params::ptrKey2
uint32_t * ptrKey2
Definition: dthe_aes.h:192
DTHE_AES_Params::ptrKey1
uint32_t * ptrKey1
Definition: dthe_aes.h:187
DTHE_Handle
void * DTHE_Handle
Handle to the DTHE driver.
Definition: dthe.h:84
DTHE_AES_Params::ptrKey
uint32_t * ptrKey
Definition: dthe_aes.h:182
DTHE_AES_RETURN_SUCCESS
@ DTHE_AES_RETURN_SUCCESS
Definition: dthe_aes.h:136
DTHE_AES_Params::ptrEncryptedData
uint32_t * ptrEncryptedData
Definition: dthe_aes.h:222
DTHE_AES_Params::useKEKMode
Bool useKEKMode
Definition: dthe_aes.h:176
DTHE_AES_RETURN_FAILURE
@ DTHE_AES_RETURN_FAILURE
Definition: dthe_aes.h:137
DTHE_AES_open
DTHE_AES_Return_t DTHE_AES_open(DTHE_Handle handle)
Function to Open DTHE AES Driver.