AESGCMLPF3HSM.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023-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  */
65 #ifndef ti_drivers_aesgcm_AESGCMLPF3HSM__include
66 #define ti_drivers_aesgcm_AESGCMLPF3HSM__include
67 
68 #include <stdbool.h>
69 #include <stddef.h>
70 #include <stdint.h>
71 
72 #include <ti/drivers/AESGCM.h>
74 
75 #include <ti/devices/DeviceFamily.h>
76 #include DeviceFamily_constructPath(driverlib/aes.h)
77 
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81 
89 
95 typedef struct
96 {
97  /* Common member first to allow struct to be cast to the common type */
99  const uint8_t *aad;
100  const uint8_t *input;
101  uint8_t *output;
102  const uint8_t *iv;
103  uint8_t *mac;
104  uint32_t counter[AES_BLOCK_SIZE_WORDS];
105  uint32_t intermediateTag[AES_BLOCK_SIZE_WORDS];
106  uint32_t hashKey[AES_BLOCK_SIZE_WORDS];
107  uint32_t tagOTP[AES_BLOCK_SIZE_WORDS];
110  size_t inputLength;
111  size_t aadLength;
114  volatile size_t totalDataLengthRemaining;
115  volatile size_t totalAADLengthRemaining;
117  uint8_t macLength;
118  uint8_t ivLength;
124  int_fast16_t hsmStatus;
125  uint32_t tempAssetID;
126  /* To indicate whether a segmented operation is in progress
127  */
130 
154 int_fast16_t AESGCMLPF3HSM_setMac(AESGCM_Handle handle, const uint8_t *mac, size_t macLength);
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif /* ti_drivers_aesgcm_AESGCMLPF3HSM__include */
volatile size_t totalAADLengthRemaining
Definition: AESGCMLPF3HSM.h:115
AESGCM_OperationType
Enum for the operation types supported by the driver.
Definition: AESGCM.h:926
AESGCM_OperationUnion * operation
Definition: AESGCMLPF3HSM.h:109
size_t totalDataLength
Definition: AESGCMLPF3HSM.h:113
uint8_t * output
Definition: AESGCMLPF3HSM.h:101
size_t totalAADLength
Definition: AESGCMLPF3HSM.h:112
const uint8_t * iv
Definition: AESGCMLPF3HSM.h:102
uint8_t ivLength
Definition: AESGCMLPF3HSM.h:118
AES Global configuration.
Definition: AESCommon.h:154
AESGCM driver header.
size_t inputLength
Definition: AESGCMLPF3HSM.h:110
size_t aadLength
Definition: AESGCMLPF3HSM.h:111
volatile size_t totalDataLengthRemaining
Definition: AESGCMLPF3HSM.h:114
const uint8_t * input
Definition: AESGCMLPF3HSM.h:100
AESCommonLPF3_Object common
Definition: AESGCMLPF3HSM.h:98
bool segmentedOperationInProgress
Definition: AESGCMLPF3HSM.h:128
void(* AESGCM_CallbackFxn)(AESGCM_Handle handle, int_fast16_t returnValue, AESGCM_OperationUnion *operation, AESGCM_OperationType operationType)
The definition of a callback function used by the AESGCM driver when used in AESGCM_RETURN_BEHAVIOR_C...
Definition: AESGCM.h:956
int_fast16_t AESGCMLPF3HSM_setMac(AESGCM_Handle handle, const uint8_t *mac, size_t macLength)
Function to set the mac for an AES CCM segmented operation. This API needs to be called only when the...
AESCommonLPF3 Hardware Attributes.
Definition: AESCommonLPF3.h:80
uint32_t tempAssetID
Definition: AESGCMLPF3HSM.h:125
AESGCM_CallbackFxn callbackFxn
Definition: AESGCMLPF3HSM.h:108
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: AESGCMLPF3HSM.h:124
AESCommon driver implementation for the Low Power F3 family.
AESCommonLPF3_HWAttrs AESGCMLPF3HSM_HWAttrs
AESGCMLPF3 Hardware Attributes.
Definition: AESGCMLPF3HSM.h:88
AESGCMLPF3HSM Object.
Definition: AESGCMLPF3HSM.h:95
AESGCM_OperationType operationType
Definition: AESGCMLPF3HSM.h:116
uint8_t macLength
Definition: AESGCMLPF3HSM.h:117
Union containing a reference to a one step, segmented AAD, segmented data, or segmented finalize oper...
Definition: AESGCM.h:914
const uint8_t * aad
Definition: AESGCMLPF3HSM.h:99
uint8_t * mac
Definition: AESGCMLPF3HSM.h:103
AESCommonLPF3 Object.
Definition: AESCommonLPF3.h:102
© Copyright 1995-2024, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale