sdl_mcu_armss_ccmr5.h

Go to the documentation of this file.

/*
 *   Copyright (c) Texas Instruments Incorporated 2022-2024
 *
 *  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_MCU_ARMSS_CCMR5_H
#define SDL_MCU_ARMSS_CCMR5_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include "sdlr_mcu_armss_ccmr5.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* ========================================================================== */
/*                            Enums & Typedefs                               */
/* ========================================================================== */
 
typedef enum SDL_McuArmssCcmR5RegId_e
{
    SDL_MCU_ARMSS_CCMR5_CCMSR1_REGID = (0u),
    SDL_MCU_ARMSS_CCMR5_CCMKEYR1_REGID = (1u),
    SDL_MCU_ARMSS_CCMR5_CCMSR2_REGID = (2u),
    SDL_MCU_ARMSS_CCMR5_CCMKEYR2_REGID = (3u),
    SDL_MCU_ARMSS_CCMR5_CCMSR3_REGID = (4u),
    SDL_MCU_ARMSS_CCMR5_CCMKEYR3_REGID = (5u),
    SDL_MCU_ARMSS_CCMR5_POLCNTRL_REGID = (6u),
#ifdef SOC_AM263PX
    SDL_MCU_ARMSS_CCMR5_CCMKEYR5_REGID = (7u),
    SDL_MCU_ARMSS_CCMR5_CCMSR5_REGID = (8u),
    SDL_MCU_ARMSS_CCMR5_CCMKEYR6_REGID = (9u),
    SDL_MCU_ARMSS_CCMR5_CCMSR6_REGID = (10u),
#endif
    SDL_MCU_ARMSS_CCMR5_INVALID_REGID = (11u)
} SDL_McuArmssCcmR5RegId;
typedef enum SDL_McuArmssCcmR5ModuleId_e
{
    SDL_MCU_ARMSS_CCMR5_CPU_MODULE_ID = (0u),
    SDL_MCU_ARMSS_CCMR5_VIM_MODULE_ID = (1u),
    SDL_MCU_ARMSS_CCMR5_INACTIVITY_MONITOR_MODULE_ID = (2u),
#ifdef SOC_AM263PX
    SDL_MCU_ARMSS_CCMR5_TMU_MODULE_ID = (3u),
    SDL_MCU_ARMSS_CCMR5_RL2_MODULE_ID = (4u),
#endif
    SDL_MCU_ARMSS_CCMR5_INVALID_MODULE_ID = (255u)
} SDL_McuArmssCcmR5ModuleId;
typedef enum SDL_McuArmssCcmR5OpModeKey_e
{
    SDL_MCU_ARMSS_CCMR5_MKEY_CMP_MODE_ACTIVE = (0u),
    SDL_MCU_ARMSS_CCMR5_MKEY_SELF_TEST_MODE = (6u),
    SDL_MCU_ARMSS_CCMR5_MKEY_ERR_FORCE_MODE = (9u),
    SDL_MCU_ARMSS_CCMR5_MKEY_SELF_TEST_ERR_FORCE_MODE = (15u)
} SDL_McuArmssCcmR5OpModeKey;
 
/* ========================================================================== */
/*                         Function Declarations                              */
/* ========================================================================== */
 
int32_t SDL_armR5ReadCCMRegister (
                   uintptr_t                baseAddress,
                   SDL_McuArmssCcmR5RegId   regId,
                   uint32_t                 *pValToBeRead,
                   int32_t                  *pMetaInfo
);
 
int32_t SDL_armR5ConfigureCCMRegister (
                   uintptr_t                baseAddress,
                   SDL_McuArmssCcmR5RegId   regId,
                   uint32_t                 valToBeWritten,
                   int32_t                  *pMetaInfo
);
 
int32_t SDL_armR5CCMSetOperationModeKey (
                   uintptr_t                    baseAddress,
                   SDL_McuArmssCcmR5ModuleId    moduleId,
                   SDL_McuArmssCcmR5OpModeKey   opModeKey,
                   int32_t                     *pMetaInfo
);
 
int32_t SDL_armR5CCMGetCompareError (
                   uintptr_t                      baseAddress,
                   SDL_McuArmssCcmR5ModuleId      moduleId,
                   uint32_t                      *pCmpError,
                   int32_t                       *pMetaInfo
);
 
int32_t SDL_armR5CCMGetOperationModeKey (
                   uintptr_t                      baseAddress,
                   SDL_McuArmssCcmR5ModuleId      moduleId,
                   SDL_McuArmssCcmR5OpModeKey    *pOpModeKey,
                   int32_t                       *pMetaInfo
);
 
int32_t SDL_armR5CCMClearCompareError (
                   uintptr_t                      baseAddress,
                   SDL_McuArmssCcmR5ModuleId      moduleId,
                   int32_t                       *pMetaInfo
);
 
#ifdef __cplusplus
}
#endif
#endif /* SDL_MCU_ARMSS_CCMR5_H */