soc.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022-2023 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 SOC_AM62AX_H_
#define SOC_AM62AX_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#if (ENABLE_SCICLIENT_DIRECT)
#include <drivers/device_manager/sciclient.h>
#else
#include <drivers/sciclient.h>
#endif
 
#define SOC_DOMAIN_ID_MAIN     (0U)
#define SOC_DOMAIN_ID_MCU      (1U)
#define SOC_DOMAIN_ID_WKUP     (2U)
 
/* PSC Instances */
#define SOC_PSC_DOMAIN_ID_MAIN      (0U)
#define SOC_PSC_DOMAIN_ID_MCU       (1U)
 
/* PSC (Power Sleep Controller) Module states */
#define SOC_PSC_SYNCRESETDISABLE        (0x0U)
#define SOC_PSC_SYNCRESET               (0x1U)
#define SOC_PSC_DISABLE                 (0x2U)
#define SOC_PSC_ENABLE                  (0x3U)
 
#define SOC_PSC_DOMAIN_OFF              (0x0U)
#define SOC_PSC_DOMAIN_ON               (0x1U)
 
#define SOC_BOOTMODE_MMCSD      (0X36C3)
 
int32_t SOC_moduleClockEnable(uint32_t moduleId, uint32_t enable);
 
int32_t SOC_moduleSetClockFrequency(uint32_t moduleId, uint32_t clkId, uint64_t clkRate);
 
const char *SOC_getCoreName(uint16_t coreId);
 
uint32_t SOC_getCoreId(const char * coreName);
 
uint64_t SOC_getSelfCpuClk(void);
 
void SOC_setEpwmTbClk(uint32_t epwmInstance, uint32_t enable);
 
 
void SOC_controlModuleLockMMR(uint32_t domainId, uint32_t partition);
 
void SOC_controlModuleUnlockMMR(uint32_t domainId, uint32_t partition);
 
void SOC_unlockAllMMR(void);
 
void SOC_setEpwmTbClk(uint32_t epwmInstance, uint32_t enable);
 
int32_t SOC_moduleGetClockFrequency(uint32_t moduleId, uint32_t clkId, uint64_t *clkRate);
 
void SOC_setDevStat(uint32_t bootMode);
 
void SOC_triggerMcuLpmWakeup(void);
 
void SOC_generateSwWarmResetMainDomain(void);
 
void SOC_generateSwPORResetMainDomain(void);
 
uint32_t SOC_getWarmResetCauseMainDomain(void);
 
void SOC_generateSwWarmResetMcuDomain(void);
 
void SOC_generateSwWarmResetMainDomainFromMcuDomain(void);
 
void SOC_generateSwPORResetMainDomainFromMcuDomain(void);
 
uint32_t SOC_getWarmResetCauseMcuDomain(void);
 
void SOC_clearResetCauseMainMcuDomain(uint32_t resetCause);
 
int32_t SOC_enableResetIsolation(uint32_t main2McuIsolation,
                                uint32_t mcu2MainIsolation,
                                uint32_t mcu2dmIsolation,
                                uint32_t debugIsolationEnable);
void SOC_setMCUResetIsolationDone(uint32_t value);
 
void SOC_waitMainDomainReset(void);
 
int32_t SOC_getPSCState(uint32_t instNum, uint32_t domainNum, uint32_t moduleNum,
                    uint32_t *domainState, uint32_t *moduleState);
 
int32_t SOC_setPSCState(uint32_t instNum, uint32_t domainNum, uint32_t moduleNum, uint32_t pscState);
 
#ifdef __cplusplus
}
#endif
 
#endif