AESCBCLPF3.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2024, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the 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 "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
58 #ifndef ti_drivers_aescbc_AESCBCLPF3__include
59 #define ti_drivers_aescbc_AESCBCLPF3__include
60 
61 #include <stdbool.h>
62 #include <stdint.h>
63 
64 #include <ti/drivers/AESCBC.h>
67 
68 #include <ti/devices/DeviceFamily.h>
69 #include DeviceFamily_constructPath(driverlib/aes.h)
70 
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 
82 
88 typedef struct
89 {
90  /* Common member first to allow struct to be cast to the common type */
92  volatile uint32_t iv[AES_IV_LENGTH_BYTES / 4];
93  const uint8_t *input;
94  uint8_t *output;
98  bool threadSafe;
99 #if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX)
100  size_t inputLength;
106  int_fast16_t hsmStatus;
107  /* To indicate whether a segmented operation is in progress
108  */
110 #endif
112 
127 __STATIC_INLINE bool AESCBC_acquireLock(AESCBC_Handle handle, uint32_t timeout)
128 {
129  return CryptoResourceLPF3_acquireLock(timeout);
130 }
141 __STATIC_INLINE void AESCBC_releaseLock(AESCBC_Handle handle)
142 {
144 }
155 __STATIC_INLINE void AESCBC_enableThreadSafety(AESCBC_Handle handle)
156 {
157  AESCBCLPF3_Object *object = handle->object;
158  object->threadSafe = true;
159 }
173 __STATIC_INLINE void AESCBC_disableThreadSafety(AESCBC_Handle handle)
174 {
175  AESCBCLPF3_Object *object = handle->object;
176  object->threadSafe = false;
177 }
180 #ifdef __cplusplus
181 }
182 #endif
183 
184 #endif /* ti_drivers_aesmode_AESCBCLPF3__include */
AESCBC_OperationUnion * operation
Definition: AESCBCLPF3.h:96
AESCBC driver header.
AESCommonLPF3_HWAttrs AESCBCLPF3_HWAttrs
AESCBCLPF3 Hardware Attributes.
Definition: AESCBCLPF3.h:81
bool CryptoResourceLPF3_acquireLock(uint32_t timeout)
bool threadSafe
Definition: AESCBCLPF3.h:98
const uint8_t * input
Definition: AESCBCLPF3.h:93
AES Global configuration.
Definition: AESCommon.h:154
AESCBC_CallbackFxn callbackFxn
Definition: AESCBCLPF3.h:95
int_fast16_t hsmStatus
The staus of the HSM Boot up process if HSMLPF3_STATUS_SUCCESS, the HSM booted properly. if HSMLPF3_STATUS_ERROR, the HSM did not boot properly.
Definition: AESCBCLPF3.h:106
AESCBC_OperationType operationType
Definition: AESCBCLPF3.h:97
size_t inputLength
Definition: AESCBCLPF3.h:100
AESCommonLPF3 Hardware Attributes.
Definition: AESCommonLPF3.h:80
bool segmentedOperationInProgress
Definition: AESCBCLPF3.h:109
void CryptoResourceLPF3_releaseLock(void)
AESCommon driver implementation for the Low Power F3 family.
Shared resources to arbitrate access to the AES engine.
AESCBC_OperationType
Enum for the operation types supported by the driver.
Definition: AESCBC.h:872
void * object
Definition: AESCommon.h:157
Union containing a reference to a one step or segmented operation.
Definition: AESCBC.h:863
AESCommonLPF3_Object common
Definition: AESCBCLPF3.h:91
AESCBCLPF3 Object.
Definition: AESCBCLPF3.h:88
uint8_t * output
Definition: AESCBCLPF3.h:94
void(* AESCBC_CallbackFxn)(AESCBC_Handle handle, int_fast16_t returnValue, AESCBC_OperationUnion *operation, AESCBC_OperationType operationType)
The definition of a callback function used by the AESCBC driver when used in AESCBC_RETURN_BEHAVIOR_C...
Definition: AESCBC.h:900
AESCommonLPF3 Object.
Definition: AESCommonLPF3.h:102
© Copyright 1995-2024, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale