1 //*****************************************************************************
2 //
3 // aes.h - Defines and Macros for the AES module.
4 //
5 // Copyright (c) 2012-2017 Texas Instruments Incorporated.  All rights reserved.
6 // Software License Agreement
7 //
8 //   Redistribution and use in source and binary forms, with or without
9 //   modification, are permitted provided that the following conditions
10 //   are met:
11 //
12 //   Redistributions of source code must retain the above copyright
13 //   notice, this list of conditions and the following disclaimer.
14 //
15 //   Redistributions in binary form must reproduce the above copyright
16 //   notice, this list of conditions and the following disclaimer in the
17 //   documentation and/or other materials provided with the
18 //   distribution.
19 //
20 //   Neither the name of Texas Instruments Incorporated nor the names of
21 //   its contributors may be used to endorse or promote products derived
22 //   from this software without specific prior written permission.
23 //
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 //
36 //*****************************************************************************
37 
38 #ifndef __DRIVERLIB_AES_H__
39 #define __DRIVERLIB_AES_H__
40 
41 #include <stdint.h>
42 #include <stdbool.h>
43 
44 //*****************************************************************************
45 //
46 // If building with a C++ compiler, make all of the definitions in this header
47 // have a C binding.
48 //
49 //*****************************************************************************
50 #ifdef __cplusplus
51 extern "C"
52 {
53 #endif
54 
55 //*****************************************************************************
56 //
57 // The following defines are used to specify the operation direction in the
58 // ui32Config argument in the AESConfig function.  Only one is permitted.
59 //
60 //*****************************************************************************
61 #define AES_CFG_DIR_ENCRYPT     0x00000004
62 #define AES_CFG_DIR_DECRYPT     0x00000000
63 
64 //*****************************************************************************
65 //
66 // The following defines are used to specify the key size in the ui32Config
67 // argument in the AESConfig function.  Only one is permitted.
68 //
69 //*****************************************************************************
70 #define AES_CFG_KEY_SIZE_128BIT 0x00000008
71 #define AES_CFG_KEY_SIZE_192BIT 0x00000010
72 #define AES_CFG_KEY_SIZE_256BIT 0x00000018
73 
74 //*****************************************************************************
75 //
76 // The following defines are used to specify the mode of operation in the
77 // ui32Config argument in the AESConfig function.  Only one is permitted.
78 //
79 //*****************************************************************************
80 #define AES_CFG_MODE_M          0x2007fe60
81 #define AES_CFG_MODE_ECB        0x00000000
82 #define AES_CFG_MODE_CBC        0x00000020
83 #define AES_CFG_MODE_CTR        0x00000040
84 #define AES_CFG_MODE_ICM        0x00000200
85 #define AES_CFG_MODE_CFB        0x00000400
86 #define AES_CFG_MODE_XTS_TWEAKJL \
87                                 0x00000800
88 #define AES_CFG_MODE_XTS_K2IJL \
89                                 0x00001000
90 #define AES_CFG_MODE_XTS_K2ILJ0 \
91                                 0x00001800
92 #define AES_CFG_MODE_F8         0x00002000
93 #define AES_CFG_MODE_F9         0x20004000
94 #define AES_CFG_MODE_CBCMAC     0x20008000
95 #define AES_CFG_MODE_GCM_HLY0ZERO \
96                                 0x20010000
97 #define AES_CFG_MODE_GCM_HLY0CALC \
98                                 0x20020040
99 #define AES_CFG_MODE_GCM_HY0CALC \
100                                 0x20030040
101 #define AES_CFG_MODE_CCM        0x20040040
102 
103 //*****************************************************************************
104 //
105 // The following defines are used to specify the counter width in the
106 // ui32Config argument in the AESConfig function.  It is only required to
107 // be defined when using CTR, CCM, or GCM modes.  Only one length is permitted.
108 //
109 //*****************************************************************************
110 #define AES_CFG_CTR_WIDTH_32    0x00000000
111 #define AES_CFG_CTR_WIDTH_64    0x00000080
112 #define AES_CFG_CTR_WIDTH_96    0x00000100
113 #define AES_CFG_CTR_WIDTH_128   0x00000180
114 
115 //*****************************************************************************
116 //
117 // The following defines are used to define the width of the length field for
118 // CCM operation through the ui32Config argument in the AESConfig function.
119 // This value is also known as L.  Only one is permitted.
120 //
121 //*****************************************************************************
122 #define AES_CFG_CCM_L_1         0x00000000
123 #define AES_CFG_CCM_L_2         0x00080000
124 #define AES_CFG_CCM_L_3         0x00100000
125 #define AES_CFG_CCM_L_4         0x00180000
126 #define AES_CFG_CCM_L_5         0x00200000
127 #define AES_CFG_CCM_L_6         0x00280000
128 #define AES_CFG_CCM_L_7         0x00300000
129 #define AES_CFG_CCM_L_8         0x00380000
130 
131 //*****************************************************************************
132 //
133 // The following defines are used to define the length of the authentication
134 // field for CCM operations through the ui32Config argument in the AESConfig
135 // function.  This value is also known as M.  Only one is permitted.
136 //
137 //*****************************************************************************
138 #define AES_CFG_CCM_M_4         0x00400000
139 #define AES_CFG_CCM_M_6         0x00800000
140 #define AES_CFG_CCM_M_8         0x00c00000
141 #define AES_CFG_CCM_M_10        0x01000000
142 #define AES_CFG_CCM_M_12        0x01400000
143 #define AES_CFG_CCM_M_14        0x01800000
144 #define AES_CFG_CCM_M_16        0x01c00000
145 
146 //*****************************************************************************
147 //
148 // Interrupt flags for use with the AESIntEnable, AESIntDisable, and
149 // AESIntStatus functions.
150 //
151 //*****************************************************************************
152 #define AES_INT_CONTEXT_IN      0x00000001
153 #define AES_INT_CONTEXT_OUT     0x00000008
154 #define AES_INT_DATA_IN         0x00000002
155 #define AES_INT_DATA_OUT        0x00000004
156 #define AES_INT_DMA_CONTEXT_IN  0x00010000
157 #define AES_INT_DMA_CONTEXT_OUT 0x00080000
158 #define AES_INT_DMA_DATA_IN     0x00020000
159 #define AES_INT_DMA_DATA_OUT    0x00040000
160 
161 //*****************************************************************************
162 //
163 // Defines used when enabling and disabling DMA requests in the
164 // AESEnableDMA and AESDisableDMA functions.
165 //
166 //*****************************************************************************
167 #define AES_DMA_DATA_IN         0x00000020
168 #define AES_DMA_DATA_OUT        0x00000040
169 #define AES_DMA_CONTEXT_IN      0x00000080
170 #define AES_DMA_CONTEXT_OUT     0x00000100
171 
172 //*****************************************************************************
173 //
174 // Function prototypes.
175 //
176 //*****************************************************************************
177 extern void AESAuthLengthSet(uint32_t ui32Base, uint32_t ui32Length);
178 extern void AESConfigSet(uint32_t ui32Base, uint32_t ui32Config);
179 extern void AESDataRead(uint32_t ui32Base, uint32_t *pui32Dest);
180 extern bool AESDataReadNonBlocking(uint32_t ui32Base, uint32_t *pui32Dest);
181 extern bool AESDataProcess(uint32_t ui32Base, uint32_t *pui32Src,
182                            uint32_t *pui32Dest, uint32_t ui32Length);
183 extern bool AESDataAuth(uint32_t ui32Base, uint32_t *pui32Src,
184                         uint32_t ui32Length, uint32_t *pui32Tag);
185 extern bool AESDataProcessAuth(uint32_t ui32Base, uint32_t *pui32Src,
186                                uint32_t *pui32Dest, uint32_t ui32Length,
187                                uint32_t *pui32AuthSrc,
188                                uint32_t ui32AuthLength, uint32_t *pui32Tag);
189 extern void AESDataWrite(uint32_t ui32Base, uint32_t *pui32Src);
190 extern bool AESDataWriteNonBlocking(uint32_t ui32Base, uint32_t *pui32Src);
191 extern void AESDMADisable(uint32_t ui32Base, uint32_t ui32Flags);
192 extern void AESDMAEnable(uint32_t ui32Base, uint32_t ui32Flags);
193 extern void AESIntClear(uint32_t ui32Base, uint32_t ui32IntFlags);
194 extern void AESIntDisable(uint32_t ui32Base, uint32_t ui32IntFlags);
195 extern void AESIntEnable(uint32_t ui32Base, uint32_t ui32IntFlags);
196 extern void AESIntRegister(uint32_t ui32Base, void (*pfnHandler)(void));
197 extern uint32_t AESIntStatus(uint32_t ui32Base, bool bMasked);
198 extern void AESIntUnregister(uint32_t ui32Base);
199 extern void AESIVSet(uint32_t ui32Base, uint32_t *pui32IVdata);
200 extern void AESIVRead(uint32_t ui32Base, uint32_t *pui32IVdata);
201 extern void AESKey1Set(uint32_t ui32Base, uint32_t *pui32Key,
202                        uint32_t ui32Keysize);
203 extern void AESKey2Set(uint32_t ui32Base, uint32_t *pui32Key,
204                        uint32_t ui32Keysize);
205 extern void AESKey3Set(uint32_t ui32Base, uint32_t *pui32Key);
206 extern void AESLengthSet(uint32_t ui32Base, uint64_t ui64Length);
207 extern void AESReset(uint32_t ui32Base);
208 extern void AESTagRead(uint32_t ui32Base, uint32_t *pui32TagData);
209 
210 //*****************************************************************************
211 //
212 // Mark the end of the C bindings section for C++ compilers.
213 //
214 //*****************************************************************************
215 #ifdef __cplusplus
216 }
217 #endif
218 
219 #endif // __DRIVERLIB_AES_H__
220