soc_rcm.h File Reference

Go to the source code of this file.

Data Structures
struct	SOC_RcmDeviceFreqConfig

Enumerations
enum	SOC_RcmEfusePkgType { SOC_RCM_EFUSE_DEVICE_PKG_TYPE_ETS }
enum	SOC_RcmAppCtrlClock { SOC_RcmAppCtrlClockEnable, SOC_RcmAppCtrlClockDisable }
	APP CTRL Clock Gate Status. More...
enum	SOC_TopssFclk1Source {   SOC_TopssFclk1Source_PLLDIG, SOC_TopssFclk1Source_ADPLL_HSDIV_CLK0, SOC_TopssFclk1Source_APLL_CLK_DIV4, SOC_TopssFclk1Source_APLL_CLK_DIV5,   SOC_TopssFclk1Source_SLOW_CLK, SOC_TopssFclk1Source_MAX_VALUE = 0xFFFFFFFFu }
	Fast Clock 1 Sources. More...
enum	SOC_TopssFclk2Source {   SOC_TopssFclk2Source_PLLDIG, SOC_TopssFclk2Source_ADPLL_HSDIV_CLK1, SOC_TopssFclk2Source_APLL_CLK_DIV2, SOC_TopssFclk2Source_SLOW_CLK,   SOC_TopssFclk2Source_MAX_VALUE = 0xFFFFFFFFu }
	Fast Clock 2 Sources. More...
enum	SOC_RcmR5ClockSource { SOC_RcmR5ClockSource_OSC_CLK, SOC_RcmR5ClockSource_SLOW_CLK, SOC_RcmR5ClockSource_FAST_CLK1, SOC_RcmR5ClockSource_MAX_VALUE = 0xFFFFFFFFu }
	R5 Clock Sources. More...
enum	SOC_RcmDspClockSource { SOC_RcmDspClockSource_OSC_CLK, SOC_RcmDspClockSource_FAST_CLK2, SOC_RcmDspClockSource_SLOW_CLK, SOC_RcmDspClockSource_MAX_VALUE = 0xFFFFFFFFu }
	DSP Clock Sources. More...
enum	SOC_RcmDssClockSource {   SOC_RcmDssClockSource_OSC_CLK, SOC_RcmDssClockSource_FAST_CLK1, SOC_RcmDssClockSource_HSDIVCLKOUT3_CLK, SOC_RcmDssClockSource_SLOW_CLK,   SOC_RcmDssClockSource_MAX_VALUE = 0xFFFFFFFFu }
	DSS Clock Sources. More...
enum	SOC_RcmTopssClockSource { SOC_RcmTopssClockSource_OSC_CLK = 0x000U, SOC_RcmTopssClockSource_SLOW_CLK = 0x111U, SOC_RcmTopssClockSource_FAST_CLK1 = 0x333U, SOC_RcmTopssClockSource_MAX_VALUE = 0xFFFFFFFFu }
	TOPSS Clock Sources. More...
enum	SOC_RcmPeripheralClockGate { SOC_RcmPeripheralClockGateEnable, SOC_RcmPeripheralClockGateDisable }
	Peripheral Clock Gate Status. More...
enum	SOC_RcmPeripheralClockSource {   SOC_RcmPeripheralClockSource_OSC_CLK, SOC_RcmPeripheralClockSource_OSC_CLKX2, SOC_RcmPeripheralClockSource_SLOW_CLK, SOC_RcmPeripheralClockSource_FAST_CLK1,   SOC_RcmPeripheralClockSource_FAST_CLK2, SOC_RcmPeripheralClockSource_CAN_CLK, SOC_RcmPeripheralClockSource_PLL_DIG_CLK }
	Peripheral Clock Sources. More...
enum	SOC_RcmPeripheralId {   SOC_RcmPeripheralId_APPSS_RTI, SOC_RcmPeripheralId_APPSS_WDT, SOC_RcmPeripheralId_APPSS_QSPI, SOC_RcmPeripheralId_APPSS_MCSPIA,   SOC_RcmPeripheralId_APPSS_MCSPIB, SOC_RcmPeripheralId_APPSS_I2C, SOC_RcmPeripheralId_APPSS_LIN, SOC_RcmPeripheralId_APPSS_UARTA,   SOC_RcmPeripheralId_APPSS_UARTB, SOC_RcmPeripheralId_APPSS_MCANA, SOC_RcmPeripheralId_APPSS_MCANB, SOC_RcmPeripheralId_APPSS_ESM,   SOC_RcmPeripheralId_APPSS_EDMA, SOC_RcmPeripheralId_APPSS_CRC, SOC_RcmPeripheralId_APPSS_PWM, SOC_RcmPeripheralId_APPSS_GIO,   SOC_RcmPeripheralId_DSS_HWA, SOC_RcmPeripheralId_DSS_RTIA, SOC_RcmPeripheralId_DSS_WDT, SOC_RcmPeripheralId_DSS_EDMA,   SOC_RcmPeripheralId_DSS_SCIA, SOC_RcmPeripheralId_DSS_ADCBUF }
	Peripheral IDs. More...
enum	SOC_RcmPllFoutFreqId { SOC_RcmPllFoutFreqId_CLK_400MHZ, SOC_RcmPllFoutFreqId_MAX_VALUE = 0xFFFFFFFFu }
	PLL Fout values. More...
enum	SOC_RcmADPllFoutFreqId { SOC_RcmADPllFoutFreqId_CLK_1600MHZ, SOC_RcmADPllFoutFreqId_CLK_1800MHZ, SOC_RcmADPllFoutFreqId_MAX_VALUE = 0xFFFFFFFFu }
enum	SOC_RcmADPllHsDivClkOut { SOC_RcmADPllHsDivClkOut0, SOC_RcmADPllHsDivClkOut1, SOC_RcmADPllHsDivClkOut2, SOC_RcmADPllHsDivClkOut3 }

Functions
static void	SOC_rcmGetClkSrcAndDivReg (SOC_RcmPeripheralId PeriphID, SOC_RcmPeripheralClockSource clkSource, uint16_t *clkSrcVal, volatile uint32_t **clkSrcReg, volatile uint32_t **clkdDivReg)
static int32_t	SOC_rcmGetClkSrcAndDivValue (SOC_RcmPeripheralId PeriphID, SOC_RcmPeripheralClockSource *clkSource, volatile uint32_t *clkDiv)
static void	SOC_rcmProgDigPllCoreDivider (uint8_t inputClockDiv, uint16_t multiplier)
int32_t	SOC_rcmSetPeripheralClock (SOC_RcmPeripheralId periphID, SOC_RcmPeripheralClockSource clkSource, uint32_t freqHz)
void	SOC_rcmCoreDigPllConfig (SOC_RcmPllFoutFreqId, uint8_t)
void	SOC_rcmCoreADPLLConfig (SOC_RcmADPllFoutFreqId outFreqId)
static void	SOC_rcmConfigurePllDsp (uint16_t trimVal)
static uint32_t	SOC_rcmGetR5InFrequency (void)
static uint32_t	SOC_rcmGetModuleClkDivVal (uint32_t inFreq, uint32_t outFreq)
static uint32_t	SOC_rcmGetModuleClkDivRegVal (uint32_t moduleClkDivVal)
static uint32_t	SOC_rcmGetModuleClkDivFromRegVal (uint32_t moduleClkDivRegVal)
int32_t	SOC_rcmSetR5Clock (uint32_t r5FreqHz, uint32_t inpFreqHz, SOC_RcmR5ClockSource clkSrc)
int32_t	SOC_rcmSetDSPClock (uint32_t dspFreqHz, uint32_t inpFreqHz, SOC_RcmDspClockSource clkSrc)
int32_t	SOC_rcmSetDSSClock (uint32_t dssFreqHz, uint32_t inpFreqHz, SOC_RcmDssClockSource clkSrc)
uint32_t	SOC_rcmGetR5Clock (void)
uint32_t	SOC_rcmGetPeripheralClock (SOC_RcmPeripheralId periphID)
static uint32_t	SOC_rcmGetPeripheralClockFrequency (SOC_RcmPeripheralClockSource clkSource)
static uint32_t	SOC_rcmGetCoreFout (uint32_t Finp, uint32_t div2flag)
static uint32_t	SOC_rcmDigPllGetFOut (uint32_t Finp, uint32_t N, uint32_t M, uint32_t div2flag)
void	SOC_rcmGetDeviceFrequency (SOC_RcmDeviceFreqConfig *deviceFreqEfuseCfg)
void	SOC_rcmGetPackageType (SOC_RcmEfusePkgType *deviceTypeEfuse)
void	SOC_rcmCoreDigPllDisable (void)
void	SOC_rcmR5ConfigLockStep (void)
void	SOC_rcmSwitchR5Clock (SOC_RcmR5ClockSource clkSrc, uint32_t divVal)
uint32_t	SOC_rcmGetDspClock (void)
void	SOC_TopssSelFclk1 (SOC_TopssFclk1Source clkSrc)
void	SOC_TopssSelFclk2 (SOC_TopssFclk2Source clkSrc)
int32_t	SOC_rcmEnablePeripheralClock (SOC_RcmPeripheralId periphId, SOC_RcmPeripheralClockGate enable)
void	SOC_rcmConfigureHsDividerClocks (SOC_RcmADPllHsDivClkOut HsDividerClkOutSel, uint32_t foutMHz, uint32_t finMHz)
void	SOC_rcmDisableADPLL ()
void	SOC_rcmEnableOscx2Clk ()
int32_t	SOC_rcmSetAPPCtrlClock (SOC_RcmAppCtrlClock enable)
int32_t	SOC_rcmSetTopssClock (uint32_t topssFreqHz, uint32_t inpFreqHz, SOC_RcmTopssClockSource clkSrc)

Enumeration Type Documentation

SOC_RcmEfusePkgType

enum SOC_RcmEfusePkgType

Enumerator
SOC_RCM_EFUSE_DEVICE_PKG_TYPE_ETS

SOC_RcmAppCtrlClock

enum SOC_RcmAppCtrlClock

APP CTRL Clock Gate Status.

Enumerator
SOC_RcmAppCtrlClockEnable	Peripheral Clock Ungate.
SOC_RcmAppCtrlClockDisable	Peripheral Clock Gate.

SOC_TopssFclk1Source

enum SOC_TopssFclk1Source

Fast Clock 1 Sources.

Enumerator
SOC_TopssFclk1Source_PLLDIG
SOC_TopssFclk1Source_ADPLL_HSDIV_CLK0
SOC_TopssFclk1Source_APLL_CLK_DIV4
SOC_TopssFclk1Source_APLL_CLK_DIV5
SOC_TopssFclk1Source_SLOW_CLK
SOC_TopssFclk1Source_MAX_VALUE

SOC_TopssFclk2Source

enum SOC_TopssFclk2Source

Fast Clock 2 Sources.

Enumerator
SOC_TopssFclk2Source_PLLDIG
SOC_TopssFclk2Source_ADPLL_HSDIV_CLK1
SOC_TopssFclk2Source_APLL_CLK_DIV2
SOC_TopssFclk2Source_SLOW_CLK
SOC_TopssFclk2Source_MAX_VALUE

SOC_RcmR5ClockSource

enum SOC_RcmR5ClockSource

R5 Clock Sources.

Enumerator
SOC_RcmR5ClockSource_OSC_CLK
SOC_RcmR5ClockSource_SLOW_CLK
SOC_RcmR5ClockSource_FAST_CLK1
SOC_RcmR5ClockSource_MAX_VALUE

SOC_RcmDspClockSource

enum SOC_RcmDspClockSource

DSP Clock Sources.

Enumerator
SOC_RcmDspClockSource_OSC_CLK
SOC_RcmDspClockSource_FAST_CLK2
SOC_RcmDspClockSource_SLOW_CLK
SOC_RcmDspClockSource_MAX_VALUE

SOC_RcmDssClockSource

enum SOC_RcmDssClockSource

DSS Clock Sources.

Enumerator
SOC_RcmDssClockSource_OSC_CLK
SOC_RcmDssClockSource_FAST_CLK1
SOC_RcmDssClockSource_HSDIVCLKOUT3_CLK
SOC_RcmDssClockSource_SLOW_CLK
SOC_RcmDssClockSource_MAX_VALUE

SOC_RcmTopssClockSource

enum SOC_RcmTopssClockSource

TOPSS Clock Sources.

Enumerator
SOC_RcmTopssClockSource_OSC_CLK
SOC_RcmTopssClockSource_SLOW_CLK
SOC_RcmTopssClockSource_FAST_CLK1
SOC_RcmTopssClockSource_MAX_VALUE

SOC_RcmPeripheralClockGate

enum SOC_RcmPeripheralClockGate

Peripheral Clock Gate Status.

Enumerator
SOC_RcmPeripheralClockGateEnable	Peripheral Clock Ungate.
SOC_RcmPeripheralClockGateDisable	Peripheral Clock Gate.

SOC_RcmPeripheralClockSource

enum SOC_RcmPeripheralClockSource

Peripheral Clock Sources.

Enumerator
SOC_RcmPeripheralClockSource_OSC_CLK
SOC_RcmPeripheralClockSource_OSC_CLKX2
SOC_RcmPeripheralClockSource_SLOW_CLK
SOC_RcmPeripheralClockSource_FAST_CLK1
SOC_RcmPeripheralClockSource_FAST_CLK2
SOC_RcmPeripheralClockSource_CAN_CLK
SOC_RcmPeripheralClockSource_PLL_DIG_CLK

SOC_RcmPeripheralId

enum SOC_RcmPeripheralId

Peripheral IDs.

Enumerator
SOC_RcmPeripheralId_APPSS_RTI
SOC_RcmPeripheralId_APPSS_WDT
SOC_RcmPeripheralId_APPSS_QSPI
SOC_RcmPeripheralId_APPSS_MCSPIA
SOC_RcmPeripheralId_APPSS_MCSPIB
SOC_RcmPeripheralId_APPSS_I2C
SOC_RcmPeripheralId_APPSS_LIN
SOC_RcmPeripheralId_APPSS_UARTA
SOC_RcmPeripheralId_APPSS_UARTB
SOC_RcmPeripheralId_APPSS_MCANA
SOC_RcmPeripheralId_APPSS_MCANB
SOC_RcmPeripheralId_APPSS_ESM
SOC_RcmPeripheralId_APPSS_EDMA
SOC_RcmPeripheralId_APPSS_CRC
SOC_RcmPeripheralId_APPSS_PWM
SOC_RcmPeripheralId_APPSS_GIO
SOC_RcmPeripheralId_DSS_HWA
SOC_RcmPeripheralId_DSS_RTIA
SOC_RcmPeripheralId_DSS_WDT
SOC_RcmPeripheralId_DSS_EDMA
SOC_RcmPeripheralId_DSS_SCIA
SOC_RcmPeripheralId_DSS_ADCBUF

SOC_RcmPllFoutFreqId

enum SOC_RcmPllFoutFreqId

PLL Fout values.

Enumerator
SOC_RcmPllFoutFreqId_CLK_400MHZ
SOC_RcmPllFoutFreqId_MAX_VALUE	max value

SOC_RcmADPllFoutFreqId

enum SOC_RcmADPllFoutFreqId

Enumerator
SOC_RcmADPllFoutFreqId_CLK_1600MHZ
SOC_RcmADPllFoutFreqId_CLK_1800MHZ
SOC_RcmADPllFoutFreqId_MAX_VALUE	max value

SOC_RcmADPllHsDivClkOut

enum SOC_RcmADPllHsDivClkOut

Enumerator
SOC_RcmADPllHsDivClkOut0
SOC_RcmADPllHsDivClkOut1
SOC_RcmADPllHsDivClkOut2
SOC_RcmADPllHsDivClkOut3

Function Documentation

SOC_rcmGetClkSrcAndDivReg()

static void SOC_rcmGetClkSrcAndDivReg ( SOC_RcmPeripheralId  PeriphID, SOC_RcmPeripheralClockSource  clkSource, uint16_t *  clkSrcVal, volatile uint32_t **  clkSrcReg, volatile uint32_t **  clkdDivReg  )

static

SOC_rcmGetClkSrcAndDivValue()

static int32_t SOC_rcmGetClkSrcAndDivValue ( SOC_RcmPeripheralId  PeriphID, SOC_RcmPeripheralClockSource *  clkSource, volatile uint32_t *  clkDiv  )

static

SOC_rcmProgDigPllCoreDivider()

static void SOC_rcmProgDigPllCoreDivider ( uint8_t  inputClockDiv, uint16_t  multiplier  )

static

SOC_rcmSetPeripheralClock()

int32_t SOC_rcmSetPeripheralClock	(	SOC_RcmPeripheralId	periphID,
		SOC_RcmPeripheralClockSource	clkSource,
		uint32_t	freqHz
	)

SOC_rcmCoreDigPllConfig()

void SOC_rcmCoreDigPllConfig	(	SOC_RcmPllFoutFreqId	,
		uint8_t
	)

SOC_rcmCoreADPLLConfig()

void SOC_rcmCoreADPLLConfig

(

SOC_RcmADPllFoutFreqId

outFreqId

)

SOC_rcmConfigurePllDsp()

static void SOC_rcmConfigurePllDsp ( uint16_t  trimVal )

static

SOC_rcmGetR5InFrequency()

static uint32_t SOC_rcmGetR5InFrequency ( void  )

static

SOC_rcmGetModuleClkDivVal()

static uint32_t SOC_rcmGetModuleClkDivVal ( uint32_t  inFreq, uint32_t  outFreq  )

static

SOC_rcmGetModuleClkDivRegVal()

static uint32_t SOC_rcmGetModuleClkDivRegVal ( uint32_t  moduleClkDivVal )

static

SOC_rcmGetModuleClkDivFromRegVal()

static uint32_t SOC_rcmGetModuleClkDivFromRegVal ( uint32_t  moduleClkDivRegVal )

static

SOC_rcmSetR5Clock()

int32_t SOC_rcmSetR5Clock	(	uint32_t	r5FreqHz,
		uint32_t	inpFreqHz,
		SOC_RcmR5ClockSource	clkSrc
	)

SOC_rcmSetDSPClock()

int32_t SOC_rcmSetDSPClock	(	uint32_t	dspFreqHz,
		uint32_t	inpFreqHz,
		SOC_RcmDspClockSource	clkSrc
	)

SOC_rcmSetDSSClock()

int32_t SOC_rcmSetDSSClock	(	uint32_t	dssFreqHz,
		uint32_t	inpFreqHz,
		SOC_RcmDssClockSource	clkSrc
	)

SOC_rcmGetR5Clock()

uint32_t SOC_rcmGetR5Clock

(

void

)

SOC_rcmGetPeripheralClock()

uint32_t SOC_rcmGetPeripheralClock

(

SOC_RcmPeripheralId

periphID

)

SOC_rcmGetPeripheralClockFrequency()

static uint32_t SOC_rcmGetPeripheralClockFrequency ( SOC_RcmPeripheralClockSource  clkSource )

static

SOC_rcmGetCoreFout()

static uint32_t SOC_rcmGetCoreFout ( uint32_t  Finp, uint32_t  div2flag  )

static

SOC_rcmDigPllGetFOut()

static uint32_t SOC_rcmDigPllGetFOut ( uint32_t  Finp, uint32_t  N, uint32_t  M, uint32_t  div2flag  )

static

SOC_rcmGetDeviceFrequency()

void SOC_rcmGetDeviceFrequency

(

SOC_RcmDeviceFreqConfig *

deviceFreqEfuseCfg

)

SOC_rcmGetPackageType()

void SOC_rcmGetPackageType

(

SOC_RcmEfusePkgType *

deviceTypeEfuse

)

SOC_rcmCoreDigPllDisable()

void SOC_rcmCoreDigPllDisable

(

void

)

SOC_rcmR5ConfigLockStep()

void SOC_rcmR5ConfigLockStep

(

void

)

SOC_rcmSwitchR5Clock()

void SOC_rcmSwitchR5Clock	(	SOC_RcmR5ClockSource	clkSrc,
		uint32_t	divVal
	)

SOC_rcmGetDspClock()

uint32_t SOC_rcmGetDspClock

(

void

)

SOC_TopssSelFclk1()

void SOC_TopssSelFclk1

(

SOC_TopssFclk1Source

clkSrc

)

SOC_TopssSelFclk2()

void SOC_TopssSelFclk2

(

SOC_TopssFclk2Source

clkSrc

)

SOC_rcmEnablePeripheralClock()

int32_t SOC_rcmEnablePeripheralClock	(	SOC_RcmPeripheralId	periphId,
		SOC_RcmPeripheralClockGate	enable
	)

SOC_rcmConfigureHsDividerClocks()

void SOC_rcmConfigureHsDividerClocks	(	SOC_RcmADPllHsDivClkOut	HsDividerClkOutSel,
		uint32_t	foutMHz,
		uint32_t	finMHz
	)

SOC_rcmDisableADPLL()

void SOC_rcmDisableADPLL

(

)

SOC_rcmEnableOscx2Clk()

void SOC_rcmEnableOscx2Clk

(

)

SOC_rcmSetAPPCtrlClock()

int32_t SOC_rcmSetAPPCtrlClock

(

SOC_RcmAppCtrlClock

enable

)

SOC_rcmSetTopssClock()

int32_t SOC_rcmSetTopssClock	(	uint32_t	topssFreqHz,
		uint32_t	inpFreqHz,
		SOC_RcmTopssClockSource	clkSrc
	)