dthe_aes.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022-24 Texas Instruments Incorporated
 *
 *  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 DTHE_AES_H_
#define DTHE_AES_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include <security_common/drivers/crypto/dthe/dthe.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/hw_include/cslr.h>
#include <security_common/drivers/crypto/dthe/hw_include/cslr_aes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define DTHE_AES_ECB_MODE                                       (0x00000000U)
 
#define DTHE_AES_CBC_MODE                                       (0x00000001U)
 
#define DTHE_AES_CTR_MODE                                       (0x00000002U)
 
#define DTHE_AES_ICM_MODE                                       (0x00000004U)
 
#define DTHE_AES_CFB_MODE                                       (0x00000008U)
 
#define DTHE_AES_F8_MODE                                        (0x00000010U)
 
#define DTHE_AES_F9_MODE                                        (0x00000020U)
 
#define DTHE_AES_XTS_MODE                                       (0x00000040U)
 
#define DTHE_AES_CBC_MAC_MODE                                   (0x00000080U)
 
#define DTHE_AES_CMAC_MODE                                      (0x00000100U)
 
#define DTHE_AES_GCM_MODE                                       (0x00000200U)
 
#define DTHE_AES_GHASH_ONLY_MODE                                (0x00000400U)
 
#define DTHE_AES_CCM_MODE                                       (0x00000800U)
 
#define DTHE_AES_KEY_128_SIZE                                   (0x00000001U)
 
#define DTHE_AES_KEY_192_SIZE                                   (0x00000002U)
 
#define DTHE_AES_KEY_256_SIZE                                   (0x00000003U)
 
#define DTHE_AES_ENCRYPT                                        (0x016FE45DU)
 
#define DTHE_AES_DECRYPT                                        (0xDCBA4213U)
 
#define DTHE_AES_CTR_WIDTH_16                                    (0x00000001U)
 
#define DTHE_AES_CTR_WIDTH_32                                    (0x00000002U)
 
#define DTHE_AES_CTR_WIDTH_64                                    (0x00000004U)
 
#define DTHE_AES_CTR_WIDTH_96                                    (0x00000008U)
 
#define DTHE_AES_CTR_WIDTH_128                                   (0x00000010U)
 
#define DTHE_AES_ONE_SHOT_SUPPORT                               (0x00000000U)
 
#define DTHE_AES_STREAM_INIT                                    (0xAA11BB22U)
 
#define DTHE_AES_STREAM_UPDATE                                  (0x33CC44DDU)
 
#define DTHE_AES_STREAM_FINISH                                  (0xEE55FF66U)
 
#define DTHE_AES_NO_MODE                                        (0x0U)
 
#define DTHE_AES_GCM_MODE_1                                     (0x1U)
 
#define DTHE_AES_GCM_MODE_2                                     (0x2U)
 
#define DTHE_AES_GCM_MODE_3                                     (0x3U)
 
#define DTHE_AES_XTS_MODE_1                                     (0x1U)
 
#define DTHE_AES_XTS_MODE_2                                     (0x2U)
 
#define DTHE_AES_XTS_MODE_3                                     (0x3U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef enum DTHE_AES_Return_e
{
    DTHE_AES_RETURN_SUCCESS                  = 0x62E699D9U, 
    DTHE_AES_RETURN_FAILURE                  = 0x904D041AU, 
}DTHE_AES_Return_t;
 
typedef struct DTHE_AES_Params_t
{
    uint32_t            algoType;
 
    uint32_t            opType;
 
    Bool                useKEKMode;
 
    uint32_t*           ptrKey;
 
    uint32_t*           ptrKey1;
 
    uint32_t*           ptrKey2;
 
    uint8_t             keyLen;
 
    uint32_t*           ptrIV;
 
    uint32_t            dataLenBytes;
 
    uint32_t*           ptrEncryptedData;
 
    uint32_t*           ptrPlainTextData;
 
    uint32_t*           ptrTag;
 
    uint32_t            counterWidth;
 
 
    uint32_t            streamState;
 
    uint32_t            streamSize;
 
    uint32_t*           ptrAAD;
 
    uint32_t           aadLength;
 
    uint32_t           ccmL;
 
    uint32_t           ccmM;
 
    uint32_t           modeSelect;
}DTHE_AES_Params;
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
/* ========================================================================== */
/*                              Function Definitions                          */
/* ========================================================================== */
 
DTHE_AES_Return_t DTHE_AES_open(DTHE_Handle handle);
 
DTHE_AES_Return_t DTHE_AES_execute(DTHE_Handle handle, const DTHE_AES_Params* ptrParams);
 
DTHE_AES_Return_t DTHE_AES_close(DTHE_Handle handle);
 
#ifdef __cplusplus
}
#endif
 
#endif