AESGCMXXF3HSM.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023-2025, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_aesgcm_AESGCMXXF3HSM__include
#define ti_drivers_aesgcm_AESGCMXXF3HSM__include

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/drivers/AESGCM.h>
#include <ti/drivers/cryptoutils/aes/AESCommonXXF3.h>

#include <ti/devices/DeviceFamily.h>
#if (DeviceFamily_PARENT != DeviceFamily_PARENT_CC35XX)
    #include DeviceFamily_constructPath(driverlib/aes.h)
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef AESCommonXXF3_HWAttrs AESGCMXXF3HSM_HWAttrs;

typedef struct
{
    /* Common member first to allow struct to be cast to the common type */
    AESCommonXXF3_Object common;
    const uint8_t *aad;
    const uint8_t *input;
    uint8_t *output;
    const uint8_t *iv;
    uint8_t *mac;
    uint32_t counter[AES_BLOCK_SIZE_WORDS];
    volatile uint32_t intermediateTag[AES_BLOCK_SIZE_WORDS];
    uint32_t hashKey[AES_BLOCK_SIZE_WORDS];
    uint32_t tagOTP[AES_BLOCK_SIZE_WORDS];
    AESGCM_CallbackFxn callbackFxn;
    AESGCM_OperationUnion *operation;
    size_t inputLength;
    size_t aadLength;
    uint8_t bufferedAADLength;
    size_t totalAADLength;
    size_t totalDataLength;
    volatile size_t totalDataLengthRemaining;
    volatile size_t totalAADLengthRemaining;
    AESGCM_OperationType operationType;
    uint8_t macLength;
    uint8_t ivLength;
    uint8_t KeyStore_keyingMaterial[AESCommonXXF3_256_KEY_LENGTH_BYTES];
    uint8_t inputFinalBlock[AES_BLOCK_SIZE];
    uint8_t aadFinalBlock[AES_BLOCK_SIZE];
    uint8_t outputFinalBlock[AES_BLOCK_SIZE] __attribute__((aligned(4)));
    int_fast16_t hsmStatus;
    uint32_t keyAssetID;
    uint32_t tempAssetID;
    /* Intentionally use implementation-independent uint32_t datatype for
     * keyLocation to avoid user dependencies on any implementation-specific
     * headers (e.g. mbedTLS). This data type must be large enough to hold any
     * implementation-specific keyLocation data.
     */
    uint32_t keyLocation;
    /* To indicate whether a segmented operation is in progress */
    bool segmentedOperationInProgress;
} AESGCMXXF3HSM_Object;

int_fast16_t AESGCMXXF3HSM_setMac(AESGCM_Handle handle, const uint8_t *mac, size_t macLength);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_aesgcm_AESGCMXXF3HSM__include */