[prcm] Power Reset Clock Manager

Functions
void	PRCMInfClockConfigureSet (uint32_t ui32ClkDiv, uint32_t ui32PowerMode)
	Configure the infrastructure clock. More...
uint32_t	PRCMInfClockConfigureGet (uint32_t ui32PowerMode)
	Use this function to get the infrastructure clock configuration. More...
static void	PRCMMcuPowerOff (void)
	Request a power off of the MCU voltage domain. More...
static void	PRCMMcuPowerOffCancel (void)
	Cancel a request for a power off of the MCU voltage domain. More...
static void	PRCMMcuUldoConfigure (uint32_t ui32Enable)
	Assert or de-assert a request for the uLDO. More...
static void	PRCMGPTimerClockDivisionSet (uint32_t clkDiv)
	Setup the clock division factor for the GP-Timer domain. More...
static uint32_t	PRCMGPTimerClockDivisionGet (void)
	Get the clock division factor for the GP-Timer domain. More...
static void	PRCMAudioClockEnable (void)
	Enable the audio clock generation. More...
static void	PRCMAudioClockDisable (void)
	Disable the audio clock generation. More...
void	PRCMAudioClockConfigSet (uint32_t ui32ClkConfig, uint32_t ui32SampleRate)
	Configure the audio clock generation. More...
void	PRCMAudioClockConfigSetOverride (uint32_t ui32ClkConfig, uint32_t ui32MstDiv, uint32_t ui32BitDiv, uint32_t ui32WordDiv)
	Configure the audio clock generation with manual setting of clock divider. More...
static void	PRCMLoadSet (void)
	Use this function to synchronize the load settings. More...
static bool	PRCMLoadGet (void)
	Check if any of the load sensitive register has been updated. More...
static void	PRCMDomainEnable (uint32_t ui32Domains)
	Enable clock domains in the MCU voltage domain. More...
static void	PRCMDomainDisable (uint32_t ui32Domains)
	Disable clock domains in the MCU voltage domain. More...
void	PRCMPowerDomainOn (uint32_t ui32Domains)
	Turn power on in power domains in the MCU domain. More...
void	PRCMPowerDomainOff (uint32_t ui32Domains)
	Turn off a specific power domain. More...
static void	PRCMRfPowerDownWhenIdle (void)
	Configure RF core to power down when idle. More...
void	PRCMPeripheralRunEnable (uint32_t ui32Peripheral)
	Enables a peripheral in Run mode. More...
void	PRCMPeripheralRunDisable (uint32_t ui32Peripheral)
	Disables a peripheral in Run mode. More...
void	PRCMPeripheralSleepEnable (uint32_t ui32Peripheral)
	Enables a peripheral in sleep mode. More...
void	PRCMPeripheralSleepDisable (uint32_t ui32Peripheral)
	Disables a peripheral in sleep mode. More...
void	PRCMPeripheralDeepSleepEnable (uint32_t ui32Peripheral)
	Enables a peripheral in deep-sleep mode. More...
void	PRCMPeripheralDeepSleepDisable (uint32_t ui32Peripheral)
	Disables a peripheral in deep-sleep mode. More...
uint32_t	PRCMPowerDomainStatus (uint32_t ui32Domains)
	Get the status for a specific power domain. More...
static bool	PRCMRfReady (void)
	Return the access status of the RF Core. More...
static void	PRCMSleep (void)
	Put the processor into sleep mode. More...
void	PRCMDeepSleep (void)
	Put the processor into deep-sleep mode. More...
static void	PRCMCacheRetentionEnable (void)
	Enable CACHE RAM retention. More...
static void	PRCMCacheRetentionDisable (void)
	Disable CACHE RAM retention. More...

Detailed Description

Function Documentation

void PRCMAudioClockConfigSet	(	uint32_t	ui32ClkConfig,
		uint32_t	ui32SampleRate
	)

Configure the audio clock generation.

Use this function to set the sample rate when using internal audio clock generation for the I2S module.

Note

While other clocks are possible, the stability of the four sample rates defined here are only guaranteed if the clock input to the I2S module is 48MHz.

Parameters

ui32ClkConfig	is the audio clock configuration. The parameter is a bitwise OR'ed value consisting of: Phase PRCM_WCLK_SINGLE_PHASE PRCM_WCLK_DUAL_PHASE Clock polarity PRCM_WCLK_NEG_EDGE PRCM_WCLK_POS_EDGE
ui32SampleRate	is the desired audio clock sample rate. The supported sample rate configurations are: I2S_SAMPLE_RATE_16K I2S_SAMPLE_RATE_24K I2S_SAMPLE_RATE_32K I2S_SAMPLE_RATE_48K

Returns

None

See also

PRCMAudioClockConfigSetOverride()

Definition at line 268 of file prcm.c.

Here is the call graph for this function:

void PRCMAudioClockConfigSetOverride	(	uint32_t	ui32ClkConfig,
		uint32_t	ui32MstDiv,
		uint32_t	ui32BitDiv,
		uint32_t	ui32WordDiv
	)

Configure the audio clock generation with manual setting of clock divider.

Use this function to set the audio clock divider values manually.

Note

See hardware documentation before setting audio clock dividers manually.

Parameters

ui32ClkConfig	is the audio clock configuration. The parameter is a bitwise OR'ed value consisting of: Phase PRCM_WCLK_SINGLE_PHASE PRCM_WCLK_DUAL_PHASE Clock polarity PRCM_WCLK_NEG_EDGE PRCM_WCLK_POS_EDGE
ui32MstDiv	is the desired master clock divider.
ui32WordDiv	is the desired word clock divider.
ui32BitDiv	is the desired bit clock divider.

Returns

None

See also

PRCMAudioClockConfigSet()

Definition at line 350 of file prcm.c.

Here is the call graph for this function:

static void PRCMAudioClockDisable ( void  )

inlinestatic

Disable the audio clock generation.

Use this function to disable the audio clock generation.

Returns

None

Definition at line 458 of file prcm.h.

Referenced by PRCMAudioClockConfigSet(), and PRCMAudioClockConfigSetOverride().

static void PRCMAudioClockEnable ( void  )

inlinestatic

Enable the audio clock generation.

Use this function to enable the audio clock generation.

Returns

None

Definition at line 442 of file prcm.h.

static void PRCMCacheRetentionDisable ( void  )

inlinestatic

Disable CACHE RAM retention.

Disables CACHE RAM retention on both VIMS_TRAM and VIMS_CRAM

Returns

None

Definition at line 1123 of file prcm.h.

static void PRCMCacheRetentionEnable ( void  )

inlinestatic

Enable CACHE RAM retention.

Enables CACHE RAM retention on both VIMS_TRAM and VIMS_CRAM

Returns

None

Definition at line 1108 of file prcm.h.

void PRCMDeepSleep

(

void

)

Put the processor into deep-sleep mode.

This function places the processor into deep-sleep mode; it does not return until the processor returns to run mode. The peripherals that are enabled via PRCMPeripheralDeepSleepEnable() continue to operate and can wake up the processor.

Returns

None

See also

PRCMPeripheralDeepSleepEnable()

Definition at line 648 of file prcm.c.

Here is the call graph for this function:

static void PRCMDomainDisable ( uint32_t  ui32Domains )

inlinestatic

Disable clock domains in the MCU voltage domain.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Clocks will only be running if the domain is powered.

Parameters

ui32Domains

is a bit mask containing the clock domains to disable. The independent clock domains inside the MCU voltage domain are: PRCM_DOMAIN_RFCORE PRCM_DOMAIN_VIMS

Returns

None

See also

PRCMDomainEnable()

Definition at line 647 of file prcm.h.

static void PRCMDomainEnable ( uint32_t  ui32Domains )

inlinestatic

Enable clock domains in the MCU voltage domain.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Clocks will only be running if the domain is powered.

Parameters

ui32Domains

is a bit mask containing the clock domains to enable. The independent clock domains inside the MCU voltage domain which can be configured are: PRCM_DOMAIN_RFCORE PRCM_DOMAIN_VIMS

Returns

None

Definition at line 604 of file prcm.h.

Referenced by SysCtrlPowerEverything().

static uint32_t PRCMGPTimerClockDivisionGet ( void  )

inlinestatic

Get the clock division factor for the GP-Timer domain.

Use this function to get the clock division factor set for the GP-Timer.

Returns

Returns one of the following values:

• PRCM_CLOCK_DIV_1
• PRCM_CLOCK_DIV_2
• PRCM_CLOCK_DIV_4
• PRCM_CLOCK_DIV_8
• PRCM_CLOCK_DIV_16
• PRCM_CLOCK_DIV_32
• PRCM_CLOCK_DIV_64
• PRCM_CLOCK_DIV_128
• PRCM_CLOCK_DIV_256

See also

PRCMGPTimerClockDivisionSet()

Definition at line 426 of file prcm.h.

static void PRCMGPTimerClockDivisionSet ( uint32_t  clkDiv )

inlinestatic

Setup the clock division factor for the GP-Timer domain.

Use this function to set up the clock division factor on the GP-Timer.

The division rate will be constant and ungated for Run / Sleep / DeepSleep mode when it is slower than PRCM_GPTCLKDIV_RATIO setting. When set faster than PRCM_GPTCLKDIV_RATIO setting PRCM_GPTCLKDIV_RATIO will be used. Note that the register will contain the written content even though the setting is faster than PRCM_GPTCLKDIV_RATIO setting.

Note

For change to take effect, PRCMLoadSet() needs to be called

Parameters

clkDiv

is the division factor to set. The argument must be only one of the following values: PRCM_CLOCK_DIV_1 PRCM_CLOCK_DIV_2 PRCM_CLOCK_DIV_4 PRCM_CLOCK_DIV_8 PRCM_CLOCK_DIV_16 PRCM_CLOCK_DIV_32 PRCM_CLOCK_DIV_64 PRCM_CLOCK_DIV_128 PRCM_CLOCK_DIV_256

Returns

None

See also

PRCMGPTimerClockDivisionGet()

Definition at line 398 of file prcm.h.

uint32_t PRCMInfClockConfigureGet

(

uint32_t

ui32PowerMode

)

Use this function to get the infrastructure clock configuration.

Parameters

ui32PowerMode

determines which System CPU power mode to return the infrastructure clock division ratio for. The three allowed power modes are: PRCM_RUN_MODE PRCM_SLEEP_MODE PRCM_DEEP_SLEEP_MODE

Returns

Returns the infrastructure clock division factor for the specified power mode.

• PRCM_CLOCK_DIV_1
• PRCM_CLOCK_DIV_2
• PRCM_CLOCK_DIV_8
• PRCM_CLOCK_DIV_32

See also

PRCMInfClockConfigureSet().

Definition at line 204 of file prcm.c.

void PRCMInfClockConfigureSet	(	uint32_t	ui32ClkDiv,
		uint32_t	ui32PowerMode
	)

Configure the infrastructure clock.

Each System CPU power mode has its own infrastructure clock division factor. This function can be used for setting up the division factor for the infrastructure clock in the available power modes for the System CPU. The infrastructure clock is used for all internal logic in the PRCM, and is always running as long as power is on in the MCU voltage domain. This can be enabled and disabled from the AON Wake Up Controller.

Note

If source clock is 48 MHz, minimum clock divider is PRCM_CLOCK_DIV_2.

Parameters

ui32ClkDiv	determines the division ratio for the infrastructure clock when the device is in the specified mode. Allowed division factors for all three System CPU power modes are: PRCM_CLOCK_DIV_1 PRCM_CLOCK_DIV_2 PRCM_CLOCK_DIV_8 PRCM_CLOCK_DIV_32
ui32PowerMode	determines the System CPU operation mode for which to modify the clock division factor. The three allowed power modes are: PRCM_RUN_MODE PRCM_SLEEP_MODE PRCM_DEEP_SLEEP_MODE

Returns

None

Definition at line 144 of file prcm.c.

static bool PRCMLoadGet ( void  )

inlinestatic

Check if any of the load sensitive register has been updated.

Returns

Returns status of the load sensitive register:

• true : No registers have changed since the last load.
• false : Any register has changed.

See also

PRCMLoadSet()

Definition at line 574 of file prcm.h.

Referenced by SysCtrlPowerEverything().

static void PRCMLoadSet ( void  )

inlinestatic

Use this function to synchronize the load settings.

Most of the clock settings in the PRCM module should be updated synchronously. This is ensured by the implementation of a load registers that, when written to, will let the previous written update values for all the relevant registers propagate through to hardware.

The functions that require a synchronization of the clock settings are:

• PRCMAudioClockConfigSet()
• PRCMAudioClockConfigSetOverride()
• PRCMAudioClockDisable()
• PRCMDomainEnable()
• PRCMDomainDisable()
• PRCMPeripheralRunEnable()
• PRCMPeripheralRunEnable()
• PRCMPeripheralSleepEnable()
• PRCMPeripheralSleepEnable()
• PRCMPeripheralDeepSleepEnable()
• PRCMPeripheralDeepSleepEnable()

Returns

None

See also

PRCMLoadGet()

Definition at line 554 of file prcm.h.

Referenced by SysCtrlPowerEverything().

static void PRCMMcuPowerOff ( void  )

inlinestatic

Request a power off of the MCU voltage domain.

Use this function to request a power off of the entire MCU voltage domain. This request will have no affect until deepsleep mode is requested.

Returns

None

See also

PRCMDeepSleep(), PRCMMcuPowerOffCancel()

Definition at line 306 of file prcm.h.

static void PRCMMcuPowerOffCancel ( void  )

inlinestatic

Cancel a request for a power off of the MCU voltage domain.

Use this function to cancel a request for power off of the entire MCU voltage domain. This could be relevant if a transition to power down is regretted and an application must backtrack.

Returns

None

See also

PRCMDeepSleep(), PRCMMcuPowerOff()

Definition at line 328 of file prcm.h.

static void PRCMMcuUldoConfigure ( uint32_t  ui32Enable )

inlinestatic

Assert or de-assert a request for the uLDO.

Use this function to request to switch to the micro Low Voltage Dropout regulator (uLDO). The uLDO has a much lower capacity for supplying power to the system. It is therefore imperative and solely the programmers responsibility to ensure that a sufficient amount of peripheral modules have been turned of before requesting a switch to the uLDO.

Note

Asserting this bit has no effect until:

1. FLASH has accepted to be powered down
2. Deepsleep must be asserted

Parameters

ui32Enable

0 : Disable uLDO request 1 : Enable uLDO request

Returns

None

See also

PRCMDeepSleep()

Definition at line 360 of file prcm.h.

Referenced by PowerCtrlSourceSet().

void PRCMPeripheralDeepSleepDisable

(

uint32_t

ui32Peripheral

)

Disables a peripheral in deep-sleep mode.

This function causes a peripheral to stop operating when the processor goes into deep-sleep mode. Disabling peripherals while in deep-sleep mode helps to lower the current draw of the device, and can keep peripherals that require a particular clock frequency from operating when the clock changes as a result of entering deep-sleep mode. If enabled (via PRCMPeripheralRunEnable()), the peripheral will automatically resume operation when the processor leaves deep-sleep mode, maintaining its entire state from before deep-sleep mode was entered.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Parameters

ui32Peripheral

is the peripheral to disable in deep-sleep mode. The parameter must be one of the following: PRCM_PERIPH_TIMER0 PRCM_PERIPH_TIMER1 PRCM_PERIPH_TIMER2 PRCM_PERIPH_TIMER3 PRCM_PERIPH_SSI0 PRCM_PERIPH_SSI1 PRCM_PERIPH_UART0 PRCM_PERIPH_UART1 PRCM_PERIPH_I2C0 PRCM_PERIPH_I2C1 PRCM_PERIPH_CRYPTO PRCM_PERIPH_TRNG PRCM_PERIPH_UDMA PRCM_PERIPH_GPIO PRCM_PERIPH_I2S

Returns

None

See also

PRCMLoadSet()

Definition at line 581 of file prcm.c.

void PRCMPeripheralDeepSleepEnable

(

uint32_t

ui32Peripheral

)

Enables a peripheral in deep-sleep mode.

This function allows a peripheral to continue operating when the processor goes into deep-sleep mode. Since the clocking configuration of the device may change, not all peripherals can safely continue operating while the processor is in sleep mode. This in turn depends on the chosen power mode. It is the responsibility of the caller to make sensible choices.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Parameters

ui32Peripheral

is the peripheral to enable in deep-sleep mode. The parameter must be one of the following: PRCM_PERIPH_TIMER0 PRCM_PERIPH_TIMER1 PRCM_PERIPH_TIMER2 PRCM_PERIPH_TIMER3 PRCM_PERIPH_SSI0 PRCM_PERIPH_SSI1 PRCM_PERIPH_UART0 PRCM_PERIPH_UART1 PRCM_PERIPH_I2C0 PRCM_PERIPH_I2C1 PRCM_PERIPH_CRYPTO PRCM_PERIPH_TRNG PRCM_PERIPH_UDMA PRCM_PERIPH_GPIO PRCM_PERIPH_I2S

Returns

None

See also

PRCMLoadSet()

Definition at line 561 of file prcm.c.

Referenced by SysCtrlPowerEverything().

void PRCMPeripheralRunDisable

(

uint32_t

ui32Peripheral

)

Disables a peripheral in Run mode.

Disables a peripheral in Run mode

Peripherals are disabled with this function. Once disabled, they will not operate or respond to register reads/writes.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

The actual disabling of the peripheral may be delayed until some time after this function returns. Care should be taken by the user to ensure that the peripheral is not accessed in this interval as this might cause the system to hang.

Parameters

ui32Peripheral

is the peripheral to disable. The parameter must be one of the following: PRCM_PERIPH_TIMER0 PRCM_PERIPH_TIMER1 PRCM_PERIPH_TIMER2 PRCM_PERIPH_TIMER3 PRCM_PERIPH_SSI0 PRCM_PERIPH_SSI1 PRCM_PERIPH_UART0 PRCM_PERIPH_UART1 PRCM_PERIPH_I2C0 PRCM_PERIPH_I2C1 PRCM_PERIPH_CRYPTO PRCM_PERIPH_TRNG PRCM_PERIPH_UDMA PRCM_PERIPH_GPIO PRCM_PERIPH_I2S

Returns

None

See also

PRCMLoadSet()

Definition at line 501 of file prcm.c.

void PRCMPeripheralRunEnable

(

uint32_t

ui32Peripheral

)

Enables a peripheral in Run mode.

Peripherals are enabled with this function. At power-up, some peripherals are disabled; they must be enabled in order to operate or respond to register reads/writes.

Note

The actual enabling of the peripheral may be delayed until some time after this function returns. Care should be taken to ensure that the peripheral is not accessed until it is enabled. When enabling Timers always make sure that the division factor for the PERBUSCPUCLK is set. This will guarantee that the timers run at a continuous rate even if the SYSBUSCLK is gated.

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Parameters

ui32Peripheral

is the peripheral to enable. The parameter must be one of the following: PRCM_PERIPH_TIMER0 PRCM_PERIPH_TIMER1 PRCM_PERIPH_TIMER2 PRCM_PERIPH_TIMER3 PRCM_PERIPH_SSI0 PRCM_PERIPH_SSI1 PRCM_PERIPH_UART0 PRCM_PERIPH_UART1 PRCM_PERIPH_I2C0 PRCM_PERIPH_I2C1 PRCM_PERIPH_CRYPTO PRCM_PERIPH_TRNG PRCM_PERIPH_UDMA PRCM_PERIPH_GPIO PRCM_PERIPH_I2S

Returns

None

See also

PRCMLoadSet()

Definition at line 481 of file prcm.c.

Referenced by SysCtrlPowerEverything().

void PRCMPeripheralSleepDisable

(

uint32_t

ui32Peripheral

)

Disables a peripheral in sleep mode.

This function causes a peripheral to stop operating when the processor goes into sleep mode. Disabling peripherals while in sleep mode helps to lower the current draw of the device. If enabled (via PRCMPeripheralRunEnable()), the peripheral will automatically resume operation when the processor leaves sleep mode, maintaining its entire state from before sleep mode was entered.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Parameters

ui32Peripheral

is the peripheral to disable in sleep mode. The parameter must be one of the following: PRCM_PERIPH_TIMER0 PRCM_PERIPH_TIMER1 PRCM_PERIPH_TIMER2 PRCM_PERIPH_TIMER3 PRCM_PERIPH_SSI0 PRCM_PERIPH_SSI1 PRCM_PERIPH_UART0 PRCM_PERIPH_UART1 PRCM_PERIPH_I2C0 PRCM_PERIPH_I2C1 PRCM_PERIPH_CRYPTO PRCM_PERIPH_TRNG PRCM_PERIPH_UDMA PRCM_PERIPH_GPIO PRCM_PERIPH_I2S

Returns

None

See also

PRCMLoadSet()

Definition at line 541 of file prcm.c.

void PRCMPeripheralSleepEnable

(

uint32_t

ui32Peripheral

)

Enables a peripheral in sleep mode.

This function allows a peripheral to continue operating when the processor goes into sleep mode. Since the clocking configuration of the device does not change, any peripheral can safely continue operating while the processor is in sleep mode, and can therefore wake the processor from sleep mode.

Note

A call to this function will only setup the shadow registers in the MCU domain for the PRCM module. For the changes to propagate to the system controller in the AON domain a call to this function should always be followed by a call to PRCMLoadSet().

Parameters

ui32Peripheral

is the peripheral to enable in sleep mode. The parameter must be one of the following: PRCM_PERIPH_TIMER0 PRCM_PERIPH_TIMER1 PRCM_PERIPH_TIMER2 PRCM_PERIPH_TIMER3 PRCM_PERIPH_SSI0 PRCM_PERIPH_SSI1 PRCM_PERIPH_UART0 PRCM_PERIPH_UART1 PRCM_PERIPH_I2C0 PRCM_PERIPH_I2C1 PRCM_PERIPH_CRYPTO PRCM_PERIPH_TRNG PRCM_PERIPH_UDMA PRCM_PERIPH_GPIO PRCM_PERIPH_I2S

Returns

None

See also

PRCMLoadSet()

Definition at line 521 of file prcm.c.

Referenced by SysCtrlPowerEverything().

void PRCMPowerDomainOff

(

uint32_t

ui32Domains

)

Turn off a specific power domain.

Use this function to power down domains inside the MCU voltage domain.

Note

For specifics regarding on/off configuration please see PRCMPowerDomainOn().

Parameters

ui32Domains

determines which domain to request a power down for. The domains that can be turned on/off are: PRCM_DOMAIN_RFCORE : RF Core PRCM_DOMAIN_SERIAL : SSI0, UART0, I2C0 PRCM_DOMAIN_PERIPH : GPT0, GPT1, GPT2, GPT3, GPIO, SSI1, I2S, DMA, UART1, I2C1 PRCM_DOMAIN_VIMS : SRAM, FLASH, ROM PRCM_DOMAIN_SYSBUS PRCM_DOMAIN_CPU

Returns

None

Definition at line 438 of file prcm.c.

void PRCMPowerDomainOn

(

uint32_t

ui32Domains

)

Turn power on in power domains in the MCU domain.

Use this function to turn on power domains inside the MCU voltage domain.

Power on and power off request has different implications for the different power domains.

• RF Core power domain:
  • Power On : Domain is on or in the process of turning on.
  • Power Off: Domain is powered down when System CPU is in deep sleep. The third option for the RF Core is to power down when the it is idle. This can be set using PRCMRfPowerDownWhenIdle()
• SERIAL power domain:
  • Power on : Domain is powered on.
  • Power off : Domain is powered off.
• PERIPHERIAL power domain:
  • Power on : Domain is powered on.
  • Power off : Domain is powered off.
• VIMS power domain:
  • Power On: Domain is powered if Bus domain is powered.
  • Power Off: Domain is only powered when CPU domain is on.
• BUS power domain:
  • Power On: Domain is on.
  • Power Off: Domain is on if requested by RF Core or if CPU domain is on.
• CPU power domain:
  • Power On: Domain is on.
  • Power Off: Domain is powering down if System CPU is idle. This will also initiate a power down of the SRAM and BUS power domains, unless RF Core is requesting them to be on.

Note

After a call to this function the status of the power domain should be checked using either PRCMPowerDomainStatus(). Any write operation to a power domain which is still not operational can result in unexpected behavior.

Parameters

ui32Domains

determines which power domains to turn on. The domains that can be turned on/off are: PRCM_DOMAIN_RFCORE : RF Core PRCM_DOMAIN_SERIAL : SSI0, UART0, I2C0 PRCM_DOMAIN_PERIPH : GPT0, GPT1, GPT2, GPT3, GPIO, SSI1, I2S, DMA, UART1, I2C1 PRCM_DOMAIN_VIMS : SRAM, FLASH, ROM PRCM_DOMAIN_SYSBUS PRCM_DOMAIN_CPU

Returns

None

Definition at line 395 of file prcm.c.

Referenced by SysCtrlPowerEverything().

uint32_t PRCMPowerDomainStatus

(

uint32_t

ui32Domains

)

Get the status for a specific power domain.

Use this function to retrieve the current power status of one or more power domains.

Parameters

ui32Domains

determines which domain to get the power status for. The parameter must be an OR'ed combination of one or several of: PRCM_DOMAIN_RFCORE : RF Core. PRCM_DOMAIN_SERIAL : SSI0, UART0, I2C0 PRCM_DOMAIN_PERIPH : GPT0, GPT1, GPT2, GPT3, GPIO, SSI1, I2S, DMA, UART1, I2C1

Returns

Returns status of the requested domains:

• PRCM_DOMAIN_POWER_ON : The specified domains are all powered up. This status is unconditional and the powered up status is guaranteed.
• PRCM_DOMAIN_POWER_OFF : Any of the domains are powered down.

Definition at line 601 of file prcm.c.

Referenced by SysCtrlPowerEverything().

static void PRCMRfPowerDownWhenIdle ( void  )

inlinestatic

Configure RF core to power down when idle.

Use this function to configure the RF core to power down when Idle. This is handled automatically in hardware if the RF Core reports that it is idle.

Returns

None

Definition at line 757 of file prcm.h.

static bool PRCMRfReady ( void  )

inlinestatic

Return the access status of the RF Core.

Use this function to check if the RF Core is on and ready to be accessed. Accessing register or memories that are not powered and clocked will cause a bus fault.

Returns

Returns access status of the RF Core.

• true : RF Core can be accessed.
• false : RF Core domain is not ready for access.

Definition at line 1049 of file prcm.h.

static void PRCMSleep ( void  )

inlinestatic

Put the processor into sleep mode.

This function places the processor into sleep mode; it does not return until the processor returns to run mode. The peripherals that are enabled viaPRCMPeripheralSleepEnable() continue to operate and can wake up the processor.

Returns

None

See also

PRCMPeripheralSleepEnable()

Definition at line 1074 of file prcm.h.

Here is the call graph for this function:

Macro Definition Documentation

#define I2S_SAMPLE_RATE_16K   0x00000001

Definition at line 169 of file prcm.h.

Referenced by PRCMAudioClockConfigSet().

#define I2S_SAMPLE_RATE_24K   0x00000002

Definition at line 170 of file prcm.h.

Referenced by PRCMAudioClockConfigSet().

#define I2S_SAMPLE_RATE_32K   0x00000004

Definition at line 171 of file prcm.h.

Referenced by PRCMAudioClockConfigSet().

#define I2S_SAMPLE_RATE_48K   0x00000008

Definition at line 172 of file prcm.h.

Referenced by PRCMAudioClockConfigSet().

#define PRCM_CLOCK_DIV_1   PRCM_GPTCLKDIV_RATIO_DIV1

Definition at line 118 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_CLOCK_DIV_128   PRCM_GPTCLKDIV_RATIO_DIV128

Definition at line 125 of file prcm.h.

#define PRCM_CLOCK_DIV_16   PRCM_GPTCLKDIV_RATIO_DIV16

Definition at line 122 of file prcm.h.

#define PRCM_CLOCK_DIV_2   PRCM_GPTCLKDIV_RATIO_DIV2

Definition at line 119 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_CLOCK_DIV_256   PRCM_GPTCLKDIV_RATIO_DIV256

Definition at line 126 of file prcm.h.

#define PRCM_CLOCK_DIV_32   PRCM_GPTCLKDIV_RATIO_DIV32

Definition at line 123 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_CLOCK_DIV_4   PRCM_GPTCLKDIV_RATIO_DIV4

Definition at line 120 of file prcm.h.

#define PRCM_CLOCK_DIV_64   PRCM_GPTCLKDIV_RATIO_DIV64

Definition at line 124 of file prcm.h.

#define PRCM_CLOCK_DIV_8   PRCM_GPTCLKDIV_RATIO_DIV8

Definition at line 121 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_DEEP_SLEEP_MODE   0x00000004

Definition at line 111 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_DOMAIN_CLKCTRL   0x00000080

Definition at line 148 of file prcm.h.

#define PRCM_DOMAIN_CPU   0x00000020

Definition at line 144 of file prcm.h.

Referenced by PRCMPowerDomainOff(), and PRCMPowerDomainOn().

#define PRCM_DOMAIN_MCU   0x00000100

Definition at line 150 of file prcm.h.

#define PRCM_DOMAIN_PERIPH   0x00000004

Definition at line 138 of file prcm.h.

Referenced by PRCMPowerDomainOff(), PRCMPowerDomainOn(), PRCMPowerDomainStatus(), and SysCtrlPowerEverything().

#define PRCM_DOMAIN_POWER_DOWN_READY   0x00000000

Definition at line 154 of file prcm.h.

#define PRCM_DOMAIN_POWER_OFF   0x00000002

Definition at line 152 of file prcm.h.

Referenced by PRCMPowerDomainStatus().

#define PRCM_DOMAIN_POWER_ON   0x00000001

Definition at line 153 of file prcm.h.

Referenced by PRCMPowerDomainStatus(), and SysCtrlPowerEverything().

#define PRCM_DOMAIN_RFCORE   0x00000001

Definition at line 134 of file prcm.h.

Referenced by PRCMDomainDisable(), PRCMDomainEnable(), PRCMPowerDomainOff(), PRCMPowerDomainOn(), PRCMPowerDomainStatus(), and SysCtrlPowerEverything().

#define PRCM_DOMAIN_SERIAL   0x00000002

Definition at line 136 of file prcm.h.

Referenced by PRCMPowerDomainOff(), PRCMPowerDomainOn(), PRCMPowerDomainStatus(), and SysCtrlPowerEverything().

#define PRCM_DOMAIN_SYSBUS   0x00000008

Definition at line 140 of file prcm.h.

#define PRCM_DOMAIN_TIMER   0x00000040

Definition at line 146 of file prcm.h.

#define PRCM_DOMAIN_VIMS   0x00000010

Definition at line 142 of file prcm.h.

Referenced by PRCMDomainDisable(), PRCMDomainEnable(), PRCMPowerDomainOff(), PRCMPowerDomainOn(), and SysCtrlPowerEverything().

#define PRCM_PERIPH_CRYPTO   0x00000400

Definition at line 190 of file prcm.h.

#define PRCM_PERIPH_GPIO   0x00000500

Definition at line 193 of file prcm.h.

#define PRCM_PERIPH_I2C0   0x00000300

Definition at line 188 of file prcm.h.

#define PRCM_PERIPH_I2C1   0x00000301

Definition at line 189 of file prcm.h.

#define PRCM_PERIPH_I2S   0x00000600

Definition at line 194 of file prcm.h.

#define PRCM_PERIPH_SSI0   0x00000100

Definition at line 184 of file prcm.h.

#define PRCM_PERIPH_SSI1   0x00000101

Definition at line 185 of file prcm.h.

#define PRCM_PERIPH_TIMER0   0x00000000

Definition at line 180 of file prcm.h.

#define PRCM_PERIPH_TIMER1   0x00000001

Definition at line 181 of file prcm.h.

#define PRCM_PERIPH_TIMER2   0x00000002

Definition at line 182 of file prcm.h.

#define PRCM_PERIPH_TIMER3   0x00000003

Definition at line 183 of file prcm.h.

#define PRCM_PERIPH_TRNG   0x00000401

Definition at line 191 of file prcm.h.

#define PRCM_PERIPH_UART0   0x00000200

Definition at line 186 of file prcm.h.

#define PRCM_PERIPH_UART1   0x00000201

Definition at line 187 of file prcm.h.

#define PRCM_PERIPH_UDMA   0x00000408

Definition at line 192 of file prcm.h.

#define PRCM_RUN_MODE   0x00000001

Definition at line 109 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_SLEEP_MODE   0x00000002

Definition at line 110 of file prcm.h.

Referenced by PRCMInfClockConfigureGet(), and PRCMInfClockConfigureSet().

#define PRCM_WCLK_DUAL_PHASE   0x00000002

Definition at line 166 of file prcm.h.

#define PRCM_WCLK_NEG_EDGE   0x00000008

Definition at line 163 of file prcm.h.

#define PRCM_WCLK_POS_EDGE   0x00000000

Definition at line 164 of file prcm.h.

#define PRCM_WCLK_SINGLE_PHASE   0x00000000

Definition at line 165 of file prcm.h.

Referenced by PRCMAudioClockConfigSet(), and PRCMAudioClockConfigSetOverride().

#define PRCM_WCLK_USER_DEF   0x00000004

Definition at line 167 of file prcm.h.