xWRL6432 MMWAVE-L-SDK  05.01.00.04
APIs for SOC Specific Functions

Introduction

For more details and example usage, see SOC

Sub Modules

 APIs for SOC Reset and Clock Functions
 

Functions

int32_t SOC_moduleClockEnable (uint32_t moduleId, uint32_t enable)
 Enable clock to specified module. More...
 
int32_t SOC_clocksEnable (void)
 Enables ADPLL. More...
 
int32_t SOC_moduleSetClockFrequency (uint32_t moduleId, uint32_t clkId, uint64_t clkRate)
 Set module clock to specified frequency. More...
 
const char * SOC_getCoreName (uint16_t coreId)
 Convert a core ID to a user readable name. More...
 
void SOC_controlModuleLockMMR (uint32_t domainId, uint32_t partition)
 Lock control module partition to prevent writes into control MMRs. More...
 
void SOC_controlModuleUnlockMMR (uint32_t domainId, uint32_t partition)
 Unlock control module partition to allow writes into control MMRs. More...
 
void SOC_logAllClockHz (void)
 Print's module clock info to the console. More...
 
uint64_t SOC_virtToPhy (void *virtAddr)
 SOC Virtual (CPU) to Physical address translation function. More...
 
void SOC_memoryInit (void)
 Initializes HWA shared RAM0, RAM1. More...
 
void SOC_enableMDLLClock (void)
 Enables MDLL Clock. More...
 

SOC Domain ID

#define SOC_DOMAIN_ID_TOPSS_CTRL   (0U)
 
#define SOC_DOMAIN_ID_APP_RCM   (1U)
 
#define SOC_DOMAIN_ID_APP_CTRL   (2U)
 
#define SOC_DOMAIN_ID_TOP_IO_MUX   (3U)
 

Macro Definition Documentation

◆ SOC_DOMAIN_ID_TOPSS_CTRL

#define SOC_DOMAIN_ID_TOPSS_CTRL   (0U)

◆ SOC_DOMAIN_ID_APP_RCM

#define SOC_DOMAIN_ID_APP_RCM   (1U)

◆ SOC_DOMAIN_ID_APP_CTRL

#define SOC_DOMAIN_ID_APP_CTRL   (2U)

◆ SOC_DOMAIN_ID_TOP_IO_MUX

#define SOC_DOMAIN_ID_TOP_IO_MUX   (3U)

Function Documentation

◆ SOC_moduleClockEnable()

int32_t SOC_moduleClockEnable ( uint32_t  moduleId,
uint32_t  enable 
)

Enable clock to specified module.

Parameters
moduleId[in] module ID's
enable[in] 1: enable clock to the module, 0: disable clock to the module
Returns
SystemP_SUCCESS Module clock is enabled
SystemP_FAILURE Module clock could not be enabled

◆ SOC_clocksEnable()

int32_t SOC_clocksEnable ( void  )

Enables ADPLL.

Returns
SystemP_SUCCESS Module clock is enabled
SystemP_FAILURE Module clock could not be enabled

◆ SOC_moduleSetClockFrequency()

int32_t SOC_moduleSetClockFrequency ( uint32_t  moduleId,
uint32_t  clkId,
uint64_t  clkRate 
)

Set module clock to specified frequency.

Parameters
moduleId[in] module ID's
clkId[in] clocks associated with the specified module ID
clkRate[in] Frequency to set in Hz
Returns
SystemP_SUCCESS Module clock is enabled
SystemP_FAILURE Module clock could not be enabled

◆ SOC_getCoreName()

const char* SOC_getCoreName ( uint16_t  coreId)

Convert a core ID to a user readable name.

Parameters
coreId[in] see CSL_CoreID
Returns
name as a string

◆ SOC_controlModuleLockMMR()

void SOC_controlModuleLockMMR ( uint32_t  domainId,
uint32_t  partition 
)

Lock control module partition to prevent writes into control MMRs.

Parameters
domainId[in] See SOC_DomainId_t
partition[in] Partition number to unlock

◆ SOC_controlModuleUnlockMMR()

void SOC_controlModuleUnlockMMR ( uint32_t  domainId,
uint32_t  partition 
)

Unlock control module partition to allow writes into control MMRs.

Parameters
domainId[in] See SOC_DomainId_t
partition[in] Partition number to unlock

◆ SOC_logAllClockHz()

void SOC_logAllClockHz ( void  )

Print's module clock info to the console.

◆ SOC_virtToPhy()

uint64_t SOC_virtToPhy ( void *  virtAddr)

SOC Virtual (CPU) to Physical address translation function.

Parameters
virtAddr[IN] Virtual/CPU address
Returns
Corresponding SOC physical address

◆ SOC_memoryInit()

void SOC_memoryInit ( void  )

Initializes HWA shared RAM0, RAM1.

◆ SOC_enableMDLLClock()

void SOC_enableMDLLClock ( void  )

Enables MDLL Clock.