sdl_ip_hwa.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022-23 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 SDL_IP_HWA_H_
#define SDL_IP_HWA_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stddef.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct Sdl_HWA_Status_t
{
    /* Clock status for hwa memory block */
    uint8_t SDL_HWA_enableHwaClkSTS;
    /* HWA accelerator status for memory block */
    uint8_t SDL_HWA_enableHwaSTS;
}SDL_HWA_Status_s;
 
typedef enum {
    SDL_HWA_DMEM0 = 0,
    SDL_HWA_DMEM1 = 1,
    SDL_HWA_DMEM2 = 2,
    SDL_HWA_DMEM3 = 3,
    SDL_HWA_DMEM4 = 4,
    SDL_HWA_DMEM5 = 5,
    SDL_HWA_DMEM6 = 6,
    SDL_HWA_DMEM7 = 7,
    SDL_HWA_WINDOW_RAM = 8,
    SDL_HWA_FSM_LOCKSTEP = 9,
    SDL_HWA_INVALID = 10,
} SDL_HWA_MemBlock;
 
typedef enum {
    SDL_HWA_DMA0_MEM_ID = 0,
    SDL_HWA_DMA1_MEM_ID = 1,
    SDL_HWA_WINDOW_RAM_MEM_ID = 2,
    SDL_HWA_INVALID_ID = 3,
} SDL_HWA_MemID;
 
/* ========================================================================== */
/*                            Macros & Typedefs                               */
/* ========================================================================== */
 
/* Enable HWA */
#define SDL_HWA_ENABLE_STS                      (1U)
/* Disable HWA */
#define SDL_HWA_DISABLE_STS                     (0U)
/* Parity for HWA Data memories */
#define SDL_HWA_DMEM_PARITY                     (1U)
/* Parity for  Window RAM memories */
#define SDL_HWA_DMEM_WINDOW_RAM_PARITY          (2U)
/* HWA FSM Lockstep  Enable Inverted */
#define SDL_HWA_DMEM_FSM_LOCKSTEP_INV_EN        (3U)
/* HWA FSM Lockstep  Enable */
#define SDL_HWA_DMEM_FSM_LOCKSTEP_EN            (4U)
 
/* ========================================================================== */
/*                         Function Declarations                              */
/* ========================================================================== */
void SDL_HWA_setParityEnableDisable(uint8_t memBlockParity,uint8_t enableSts);
uint8_t SDL_HWA_getParityStatus(uint8_t memBlockParity);
 
void SDL_HWA_setHwaEnableDisable(uint8_t enableSts);
 
int32_t SDL_HWA_getHwaEnableDisable(SDL_HWA_Status_s *pHWAStats);
 
void SDL_HWA_memoryInitStart(SDL_HWA_MemBlock memBlock);
 
uint8_t SDL_HWA_memoryInitDone(SDL_HWA_MemBlock memBlock);
 
uint8_t SDL_HWA_memoryInitStatus(SDL_HWA_MemBlock memBlock);
 
void SDL_HWA_setParityErrMaskUnmask(SDL_HWA_MemBlock memBlock, uint8_t enableSts);
 
uint8_t SDL_HWA_getParityErrMaskUnmask(SDL_HWA_MemBlock memBlock);
 
uint8_t SDL_HWA_getErrStatus(SDL_HWA_MemBlock memBlock);
void SDL_HWA_clearErrStatus(SDL_HWA_MemBlock memBlock);
 
int32_t SDL_HWA_getMemblockBaseaddr(SDL_HWA_MemID memID, SDL_HWA_MemBlock memBlock,
                             uint32_t *baseAddr);
 
#ifdef __cplusplus
}
#endif
#endif /* SDL_IP_HWA_H_ */