dthe.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_H_
#define DTHE_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <security_common/drivers/crypto/dthe/hw_include/cslr_dthe.h>
#include <drivers/hw_include/cslr_soc.h>
#include <security_common/drivers/crypto/dthe/dma/device_includes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
 
typedef enum DTHE_Return_e
{
    DTHE_RETURN_SUCCESS                  = 0xCE50311AU, 
    DTHE_RETURN_FAILURE                  = 0x924FC5E7U, 
}DTHE_Return_t;
 
typedef void *DTHE_Handle;
 
typedef struct
{
    /*
     * SOC configuration
     */
    uint32_t                caBaseAddr;
    uint32_t                aesBaseAddr;
    uint32_t                shaBaseAddr;
    uint32_t                isOpen;
    uint32_t                faultStatus;
} DTHE_Attrs;
 
typedef struct
{
    DTHE_Attrs             *attrs;
    uint32_t                dmaEnable;
} DTHE_Config;
 
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
extern DTHE_Config          gDtheConfig[];
extern uint32_t             gDtheConfigNum;
 
/* ========================================================================== */
/*                              Function Definitions                          */
/* ========================================================================== */
void DTHE_init(void);
 
void DTHE_deinit(void);
 
DTHE_Handle DTHE_open(uint32_t index);
 
DTHE_Return_t DTHE_close(DTHE_Handle handle);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DTHE_H_ */