For more details and example usage, see SOC
Sub Modules | |
APIs for SOC Reset and Clock Functions | |
APIs for SOC Xbars | |
Functions | |
int32_t | SOC_moduleClockEnable (uint32_t moduleId, uint32_t enable) |
Enable clock to specified module. 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... | |
uint64_t | SOC_getSelfCpuClk (void) |
Get the clock frequency in Hz of the CPU on which the driver is running. 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_setEpwmTbClk (uint32_t epwmInstance, uint32_t enable) |
Enable or disable ePWM time base clock from Control MMR. More... | |
void | SOC_enableAdcReference (uint32_t adcInstance) |
Enable ADC references by writing to Control MMR. More... | |
void | SOC_setEpwmGroup (uint32_t epwmInstance, uint32_t group) |
Configure the ePWM group. More... | |
void | SOC_gateEpwmClock (uint32_t epwmInstance) |
Gate the ePWM clock. More... | |
void | SOC_gateFsitxClock (uint32_t fsitxInstance) |
Gate the FSI-TX clock. More... | |
void | SOC_gateFsirxClock (uint32_t fsirxInstance) |
Gate the FSI-RX clock. More... | |
void | SOC_gateCmpssaClock (uint32_t cmpssaInstance) |
Gate the CMPSS-A clock. More... | |
void | SOC_gateCmpssbClock (uint32_t cmpssbInstance) |
Gate the CMPSS-B clock. More... | |
void | SOC_gateEcapClock (uint32_t ecapInstance) |
Gate the ECAP clock. More... | |
void | SOC_gateEqepClock (uint32_t eqepInstance) |
Gate the EQEP clock. More... | |
void | SOC_gateSdfmClock (uint32_t sdfmInstance) |
Gate the SDFM clock. More... | |
void | SOC_gateDacClock () |
Gate the DAC clock. More... | |
void | SOC_gateAdcClock (uint32_t adcInstance) |
Gate the ADC clock. More... | |
void | SOC_gateOttoClock (uint32_t ottoInstance) |
Gate the OTTO clock. More... | |
void | SOC_gateSdfmPllClock (uint32_t sdfmInstance) |
Gate the SDFM PLL clock. More... | |
void | SOC_gateFsiPllClock (uint32_t fsiInstance) |
Gate the FSI-TX PLL clock. More... | |
void | SOC_generateEpwmReset (uint32_t ePWMInstance) |
Generate ePWM reset. More... | |
void | SOC_generateFsiTxReset (uint32_t fsitxInstance) |
Generate FSI-TX reset. More... | |
void | SOC_generateFsiRxReset (uint32_t fsirxInstance) |
Generate FSI-RX reset. More... | |
void | SOC_generateCmpssaReset (uint32_t cmpssaInstance) |
Generate CMPSS-A reset. More... | |
void | SOC_generateCmpssbReset (uint32_t cmpssbInstance) |
Generate CMPSS-B reset. More... | |
void | SOC_generateEcapReset (uint32_t ecapInstance) |
Generate ECAP reset. More... | |
void | SOC_generateEqepReset (uint32_t eqepInstance) |
Generate EQEP reset. More... | |
void | SOC_generateSdfmReset (uint32_t sdfmInstance) |
Generate SDFM reset. More... | |
void | SOC_generateDacReset () |
Generate DAC reset. More... | |
void | SOC_generateAdcReset (uint32_t adcInstance) |
Generate ADC reset. More... | |
void | SOC_generateOttoReset (uint32_t ottoInstance) |
Generate OTTO reset. More... | |
uint64_t | SOC_virtToPhy (void *virtAddr) |
SOC Virtual (CPU) to Physical address translation function. More... | |
void * | SOC_phyToVirt (uint64_t phyAddr) |
Physical to Virtual (CPU) address translation function. More... | |
Macros | |
#define | MSS_CTRL_PARTITION0 (1) |
#define | TOP_CTRL_PARTITION0 (2) |
#define | CONTROLSS_CTRL_PARTITION0 (3) |
#define | MSS_RCM_PARTITION0 (4) |
#define | TOP_RCM_PARTITION0 (5) |
#define | KICK_LOCK_VAL (0x00000000U) |
#define | KICK0_UNLOCK_VAL (0x01234567U) |
#define | KICK1_UNLOCK_VAL (0x0FEDCBA8U) |
SOC Domain ID | |
#define | SOC_DOMAIN_ID_MAIN (0U) |
#define SOC_DOMAIN_ID_MAIN (0U) |
#define MSS_CTRL_PARTITION0 (1) |
#define TOP_CTRL_PARTITION0 (2) |
#define CONTROLSS_CTRL_PARTITION0 (3) |
#define MSS_RCM_PARTITION0 (4) |
#define TOP_RCM_PARTITION0 (5) |
#define KICK_LOCK_VAL (0x00000000U) |
#define KICK0_UNLOCK_VAL (0x01234567U) |
#define KICK1_UNLOCK_VAL (0x0FEDCBA8U) |
int32_t SOC_moduleClockEnable | ( | uint32_t | moduleId, |
uint32_t | enable | ||
) |
Enable clock to specified module.
moduleId | [in] see SOC_RcmPeripheralId for list of module ID's |
enable | [in] 1: enable clock to the module, 0: disable clock to the module |
int32_t SOC_moduleSetClockFrequency | ( | uint32_t | moduleId, |
uint32_t | clkId, | ||
uint64_t | clkRate | ||
) |
Set module clock to specified frequency.
moduleId | [in] see SOC_RcmPeripheralId for list of module ID's |
clkId | [in] see SOC_RcmPeripheralClockSource for list of clocks |
clkRate | [in] Frequency to set in Hz |
const char* SOC_getCoreName | ( | uint16_t | coreId | ) |
Convert a core ID to a user readable name.
coreId | [in] see CSL_CoreID |
uint64_t SOC_getSelfCpuClk | ( | void | ) |
Get the clock frequency in Hz of the CPU on which the driver is running.
void SOC_controlModuleLockMMR | ( | uint32_t | domainId, |
uint32_t | partition | ||
) |
Lock control module partition to prevent writes into control MMRs.
domainId | [in] See SOC_DomainId_t |
partition | [in] Partition number to unlock |
void SOC_controlModuleUnlockMMR | ( | uint32_t | domainId, |
uint32_t | partition | ||
) |
Unlock control module partition to allow writes into control MMRs.
domainId | [in] See SOC_DomainId_t |
partition | [in] Partition number to unlock |
void SOC_setEpwmTbClk | ( | uint32_t | epwmInstance, |
uint32_t | enable | ||
) |
Enable or disable ePWM time base clock from Control MMR.
epwmInstance | [in] ePWM instance number [0 - (CSL_EPWM_PER_CNT-1)] |
enable | [in] TRUE to enable and FALSE to disable |
void SOC_enableAdcReference | ( | uint32_t | adcInstance | ) |
Enable ADC references by writing to Control MMR.
adcInstance | [in] ADC instance number [0 - (CSL_ADC_PER_CNT-1)] |
void SOC_setEpwmGroup | ( | uint32_t | epwmInstance, |
uint32_t | group | ||
) |
Configure the ePWM group.
epwmInstance | [in] ePWM instance number [0 - (CSL_EPWM_PER_CNT-1)] |
group | [in] The group for this ePWM instance [0 - 3] |
void SOC_gateEpwmClock | ( | uint32_t | epwmInstance | ) |
Gate the ePWM clock.
epwmInstance | [in] ePWM instance number [0 - (CSL_EPWM_PER_CNT-1)] |
void SOC_gateFsitxClock | ( | uint32_t | fsitxInstance | ) |
Gate the FSI-TX clock.
fsitxInstance | [in] FSITX instance number [0 - 3] |
void SOC_gateFsirxClock | ( | uint32_t | fsirxInstance | ) |
Gate the FSI-RX clock.
fsirxInstance | [in] FSIRX instance number [0 - 3] |
void SOC_gateCmpssaClock | ( | uint32_t | cmpssaInstance | ) |
Gate the CMPSS-A clock.
cmpssaInstance | [in] CMPSS-A instance number [0 - 9] |
void SOC_gateCmpssbClock | ( | uint32_t | cmpssbInstance | ) |
Gate the CMPSS-B clock.
cmpssbInstance | [in] CMPSS-B instance number [0 - 9] |
void SOC_gateEcapClock | ( | uint32_t | ecapInstance | ) |
Gate the ECAP clock.
ecapInstance | [in] ECAP instance number [0 - 9] |
void SOC_gateEqepClock | ( | uint32_t | eqepInstance | ) |
Gate the EQEP clock.
eqepInstance | [in] EQEP instance number [0 - 2] |
void SOC_gateSdfmClock | ( | uint32_t | sdfmInstance | ) |
Gate the SDFM clock.
sdfmInstance | [in] SDFM instance number [0 - 1] |
void SOC_gateDacClock | ( | ) |
Gate the DAC clock.
void SOC_gateAdcClock | ( | uint32_t | adcInstance | ) |
Gate the ADC clock.
adcInstance | [in] ADC instance number [0 - 4] |
void SOC_gateOttoClock | ( | uint32_t | ottoInstance | ) |
Gate the OTTO clock.
ottoInstance | [in] OTTO instance number [0 - 3] |
void SOC_gateSdfmPllClock | ( | uint32_t | sdfmInstance | ) |
Gate the SDFM PLL clock.
sdfmInstance | [in] SDFM instance number [0 - 1] |
void SOC_gateFsiPllClock | ( | uint32_t | fsiInstance | ) |
Gate the FSI-TX PLL clock.
fsiInstance | [in] FSI instance number [0 - 3] |
void SOC_generateEpwmReset | ( | uint32_t | ePWMInstance | ) |
Generate ePWM reset.
ePWMInstance | [in] ePWM instance number [0 - 31] |
void SOC_generateFsiTxReset | ( | uint32_t | fsitxInstance | ) |
Generate FSI-TX reset.
fsitxInstance | [in] FSI instance number [0 - 3] |
void SOC_generateFsiRxReset | ( | uint32_t | fsirxInstance | ) |
Generate FSI-RX reset.
fsirxInstance | [in] FSI instance number [0 - 3] |
void SOC_generateCmpssaReset | ( | uint32_t | cmpssaInstance | ) |
Generate CMPSS-A reset.
cmpssaInstance | [in] CMPSS-A instance number [0 - 9] |
void SOC_generateCmpssbReset | ( | uint32_t | cmpssbInstance | ) |
Generate CMPSS-B reset.
cmpssbInstance | [in] CMPSS-B instance number [0 - 9] |
void SOC_generateEcapReset | ( | uint32_t | ecapInstance | ) |
Generate ECAP reset.
ecapInstance | [in] ECAP instance number [0 - 9] |
void SOC_generateEqepReset | ( | uint32_t | eqepInstance | ) |
Generate EQEP reset.
eqepInstance | [in] EQEP instance number [0 - 2] |
void SOC_generateSdfmReset | ( | uint32_t | sdfmInstance | ) |
Generate SDFM reset.
sdfmInstance | [in] SDFM instance number [0 - 1] |
void SOC_generateDacReset | ( | ) |
Generate DAC reset.
void SOC_generateAdcReset | ( | uint32_t | adcInstance | ) |
Generate ADC reset.
adcInstance | [in] ADC instance number [0 - 4] |
void SOC_generateOttoReset | ( | uint32_t | ottoInstance | ) |
Generate OTTO reset.
ottoInstance | [in] OTTO instance number [0 - 3] |
uint64_t SOC_virtToPhy | ( | void * | virtAddr | ) |
SOC Virtual (CPU) to Physical address translation function.
virtAddr | [IN] Virtual/CPU address |
void* SOC_phyToVirt | ( | uint64_t | phyAddr | ) |
Physical to Virtual (CPU) address translation function.
phyAddr | [IN] Physical address |