AM263x MCU+ SDK  09.01.00
dthe_aes.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022 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_KEY_128_SIZE (0x00000001U)
73 
74 #define DTHE_AES_KEY_192_SIZE (0x00000002U)
75 
76 #define DTHE_AES_KEY_256_SIZE (0x00000003U)
77 
78 #define DTHE_AES_ENCRYPT (0x016FE45DU)
79 
80 #define DTHE_AES_DECRYPT (0xDCBA4213U)
81 
82 /* ========================================================================== */
83 /* Structure Declarations */
84 /* ========================================================================== */
85 
94 typedef enum DTHE_AES_Return_e
95 {
96  DTHE_AES_RETURN_SUCCESS = 0x62E699D9U,
97  DTHE_AES_RETURN_FAILURE = 0x904D041AU,
99 
105 typedef struct DTHE_AES_Params_t
106 {
108  uint32_t algoType;
109 
111  uint32_t opType;
112 
118 
123  uint32_t* ptrKey;
124 
128  uint8_t keyLen;
129 
133  uint32_t* ptrIV;
134 
138  uint32_t dataLenBytes;
139 
149  uint32_t* ptrEncryptedData;
150 
160  uint32_t* ptrPlainTextData;
162 /* ========================================================================== */
163 /* Global Variables */
164 /* ========================================================================== */
165 
166 /* ========================================================================== */
167 /* Function Definitions */
168 /* ========================================================================== */
169 
179 
191 
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 
206 #endif
207 
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:106
DTHE_AES_Params::keyLen
uint8_t keyLen
Length of the Key.
Definition: dthe_aes.h:128
dthe.h
This file contains the prototype of DTHE driver APIs.
SystemP.h
DTHE_AES_Params::ptrIV
uint32_t * ptrIV
Definition: dthe_aes.h:133
DTHE_AES_Params::algoType
uint32_t algoType
Definition: dthe_aes.h:108
DTHE_AES_Params::dataLenBytes
uint32_t dataLenBytes
Definition: dthe_aes.h:138
DTHE_AES_Params::opType
uint32_t opType
Operation to be performed by the AES Driver.
Definition: dthe_aes.h:111
DTHE_AES_Params::ptrPlainTextData
uint32_t * ptrPlainTextData
Definition: dthe_aes.h:160
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:95
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:123
DTHE_AES_RETURN_SUCCESS
@ DTHE_AES_RETURN_SUCCESS
Definition: dthe_aes.h:96
DTHE_AES_Params::ptrEncryptedData
uint32_t * ptrEncryptedData
Definition: dthe_aes.h:149
DTHE_AES_Params::useKEKMode
Bool useKEKMode
Definition: dthe_aes.h:117
DTHE_AES_RETURN_FAILURE
@ DTHE_AES_RETURN_FAILURE
Definition: dthe_aes.h:97
DTHE_AES_open
DTHE_AES_Return_t DTHE_AES_open(DTHE_Handle handle)
Function to Open DTHE AES Driver.