AESCMACXXF3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2026, 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_aescmac_AESCMACXXF3__include
#define ti_drivers_aescmac_AESCMACXXF3__include

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

#include <ti/drivers/AESCMAC.h>
#include <ti/drivers/cryptoutils/aes/AESCommonXXF3.h>
#include <ti/drivers/cryptoutils/sharedresources/CryptoResourceXXF3.h>

#include <ti/devices/DeviceFamily.h>

#if (DeviceFamily_PARENT != DeviceFamily_PARENT_CC35XX)
    #include DeviceFamily_constructPath(inc/hw_types.h)
    #include DeviceFamily_constructPath(driverlib/aes.h)
#endif

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Default AES CMAC & CBC-MAC auto config:
 *  AES SRC as TXTXBUF
 *  Trigger point for auto AES as WRBUF3 (encryption starts by writing BUF3)
 *  BUSHALT enabled
 */
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX)
    #define AESCMACXXF3_DEFAULT_AUTOCFG \
        ((uint32_t)AES_AUTOCFG_AESSRC_TXTXBUF | (uint32_t)AES_AUTOCFG_TRGAES_WRBUF3 | (uint32_t)AES_AUTOCFG_BUSHALT_EN)
#elif (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX)
    /* Not used for CC35XX */
#else
    #error "Unsupported DeviceFamily_Parent for AESCMACXXF3!"
#endif

/*
 * AES CMAC DMA config:
 *  - ADRCHA = BUF0
 *  - TRGCHA = AESSTART
 */
#if (DeviceFamily_PARENT == DeviceFamily_PARENT_CC23X0) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX)
    #define AESCMACXXF3_DMA_CONFIG ((uint32_t)AES_DMA_ADRCHA_BUF0 | (uint32_t)AES_DMA_TRGCHA_AESSTART)
#elif (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX)
    /* Not used for CC35XX */
#else
    #error "Unsupported DeviceFamily_Parent for AESCMACXXF3!"
#endif

#define AESCBCMACLPF3_DMA_CONFIG AESCMACXXF3_DMA_CONFIG

typedef AESCommonXXF3_HWAttrs AESCMACXXF3_HWAttrs;

typedef struct
{
    /* Common member first to allow struct to be cast to the common type */
    AESCommonXXF3_Object common;
    volatile uint32_t intermediateTag[AES_TAG_LENGTH_BYTES / 4U];
    uint32_t finalInputBlock[AES_BLOCK_SIZE_WORDS];
    AESCMAC_CallbackFxn callbackFxn;
    AESCMAC_Operation *operation;
    AESCMAC_OperationType operationType;
    AESCMAC_OperationalMode operationalMode;
#if ((DeviceFamily_PARENT == DeviceFamily_PARENT_CC27XX) || (DeviceFamily_PARENT == DeviceFamily_PARENT_CC35XX))
    uint8_t *input;
    size_t inputLength;
    uint32_t tempAssetID;
    uint32_t keyAssetID;
    int_fast16_t hsmStatus;
    /* To indicate whether a segmented operation is in progress */
    bool segmentedOperationInProgress;
    bool driverCreatedKeyAsset;
#endif
    bool threadSafe;
} AESCMACXXF3_Object;

void AESCMACXXF3_processBlocks(const uint8_t *input, size_t transactionLength);

void AESCMACXXF3_readTag(uint32_t tagOut[AES_TAG_LENGTH_BYTES / 4U]);

__STATIC_INLINE bool AESCMAC_acquireLock(AESCMAC_Handle handle, uint32_t timeout)
{
    return CryptoResourceXXF3_acquireLock(timeout);
}
__STATIC_INLINE void AESCMAC_releaseLock(AESCMAC_Handle handle)
{
    CryptoResourceXXF3_releaseLock();
}
__STATIC_INLINE void AESCMAC_enableThreadSafety(AESCMAC_Handle handle)
{
    AESCMACXXF3_Object *object = (AESCMACXXF3_Object *)handle->object;
    object->threadSafe         = true;
}
__STATIC_INLINE void AESCMAC_disableThreadSafety(AESCMAC_Handle handle)
{
    AESCMACXXF3_Object *object = (AESCMACXXF3_Object *)handle->object;
    object->threadSafe         = false;
}
#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_aescmac_AESCMACXXF3__include */