Power Management Controller (PMC)

Purpose

The Power Management Controller (PMC) optimizes power consumption by controlling all system and user peripheral clocks. The PMC enables/disables the clock inputs to many of the peripherals and the Cortex-M Processor.

Modules
	Related Project(s)
	In this section you can find all the projects related to the Power Management Controller (PMC).
	Quick Start Guide(s)
	In this section you can find a list of all Quick Start guides related to the Power Management Controller (PMC).

Functions
void	pmc_clr_fast_startup_input (uint32_t ul_inputs)
	Clear the wake-up inputs for fast startup mode registers (remove event generation). More...
void	pmc_disable_all_pck (void)
	Disable all programmable clocks. More...
void	pmc_disable_all_periph_clk (void)
	Disable all peripheral clocks. More...
void	pmc_disable_clock_failure_detector (void)
	Disable Clock Failure Detector. More...
void	pmc_disable_interrupt (uint32_t ul_sources)
	Disable PMC interrupts. More...
void	pmc_disable_pck (uint32_t ul_id)
	Disable the specified programmable clock. More...
uint32_t	pmc_disable_periph_clk (uint32_t ul_id)
	Disable the specified peripheral clock. More...
void	pmc_disable_pllack (void)
	Disable PLLA clock. More...
void	pmc_enable_all_pck (void)
	Enable all programmable clocks. More...
void	pmc_enable_all_periph_clk (void)
	Enable all peripheral clocks. More...
void	pmc_enable_backupmode (void)
	Enable Backup Mode. More...
void	pmc_enable_clock_failure_detector (void)
	Enable Clock Failure Detector. More...
void	pmc_enable_interrupt (uint32_t ul_sources)
	Enable PMC interrupts. More...
void	pmc_enable_pck (uint32_t ul_id)
	Enable the specified programmable clock. More...
uint32_t	pmc_enable_periph_clk (uint32_t ul_id)
	Enable the specified peripheral clock. More...
void	pmc_enable_pllack (uint32_t mula, uint32_t pllacount, uint32_t diva)
	Enable PLLA clock. More...
void	pmc_enable_sleepmode (uint8_t uc_type)
	Enable Sleep Mode. More...
void	pmc_enable_waitmode (void)
	Enable Wait Mode. More...
uint32_t	pmc_get_interrupt_mask (void)
	Get PMC interrupt mask. More...
uint32_t	pmc_get_status (void)
	Get current status. More...
uint32_t	pmc_get_writeprotect_status (void)
	Return write protect status. More...
uint32_t	pmc_is_locked_pllack (void)
	Is PLLA locked? More...
uint32_t	pmc_is_pck_enabled (uint32_t ul_id)
	Check if the specified programmable clock is enabled. More...
uint32_t	pmc_is_periph_clk_enabled (uint32_t ul_id)
	Check if the specified peripheral clock is enabled. More...
void	pmc_mainck_osc_select (uint32_t ul_xtal_rc)
	Select Main Crystal or internal RC as main clock source. More...
void	pmc_mck_set_prescaler (uint32_t ul_pres)
	Set the prescaler of the MCK. More...
void	pmc_mck_set_source (uint32_t ul_source)
	Set the source of the MCK. More...
void	pmc_osc_bypass_main_xtal (void)
	Bypass main XTAL. More...
void	pmc_osc_disable_fastrc (void)
	Disable the internal fast RC. More...
void	pmc_osc_disable_main_xtal (void)
	Disable the main Xtal. More...
void	pmc_osc_disable_xtal (uint32_t ul_bypass)
	Disable the external Xtal. More...
void	pmc_osc_enable_fastrc (uint32_t ul_rc)
	Enable fast RC oscillator. More...
void	pmc_osc_enable_main_xtal (uint32_t ul_xtal_startup_time)
	Enable main XTAL oscillator. More...
uint32_t	pmc_osc_is_bypassed_main_xtal (void)
	Check if the main crystal is bypassed. More...
uint32_t	pmc_osc_is_ready_32kxtal (void)
	Check if the external 32k Xtal is ready. More...
uint32_t	pmc_osc_is_ready_fastrc (void)
	Check if the main fastrc is ready. More...
uint32_t	pmc_osc_is_ready_main_xtal (void)
	Check if the main crystal is ready. More...
uint32_t	pmc_osc_is_ready_mainck (void)
	Check if the MAINCK is ready. More...
void	pmc_pck_set_prescaler (uint32_t ul_id, uint32_t ul_pres)
	Set the prescaler for the specified programmable clock. More...
void	pmc_pck_set_source (uint32_t ul_id, uint32_t ul_source)
	Set the source oscillator for the specified programmable clock. More...
void	pmc_set_fast_startup_input (uint32_t ul_inputs)
	Set the wake-up inputs for fast startup mode registers (event generation). More...
void	pmc_set_writeprotect (uint32_t ul_enable)
	Enable or disable write protect of PMC registers. More...
void	pmc_switch_mainck_to_fastrc (uint32_t ul_moscrcf)
	Switch main clock source selection to internal fast RC. More...
void	pmc_switch_mainck_to_xtal (uint32_t ul_bypass, uint32_t ul_xtal_startup_time)
	Switch main clock source selection to external Xtal/Bypass. More...
uint32_t	pmc_switch_mck_to_mainck (uint32_t ul_pres)
	Switch master clock source selection to main clock. More...
uint32_t	pmc_switch_mck_to_pllack (uint32_t ul_pres)
	Switch master clock source selection to PLLA clock. More...
uint32_t	pmc_switch_mck_to_sclk (uint32_t ul_pres)
	Switch master clock source selection to slow clock. More...
uint32_t	pmc_switch_pck_to_mainck (uint32_t ul_id, uint32_t ul_pres)
	Switch programmable clock source selection to main clock. More...
uint32_t	pmc_switch_pck_to_mck (uint32_t ul_id, uint32_t ul_pres)
	Switch programmable clock source selection to mck. More...
uint32_t	pmc_switch_pck_to_pllack (uint32_t ul_id, uint32_t ul_pres)
	Switch programmable clock source selection to PLLA clock. More...
uint32_t	pmc_switch_pck_to_sclk (uint32_t ul_id, uint32_t ul_pres)
	Switch programmable clock source selection to slow clock. More...
void	pmc_switch_sclk_to_32kxtal (uint32_t ul_bypass)
	Switch slow clock source selection to external 32k (Xtal or Bypass). More...

void pmc_clr_fast_startup_input

(

uint32_t

ul_inputs

)

Clear the wake-up inputs for fast startup mode registers (remove event generation).

Parameters

ul_inputs

Wake up inputs to disable.

References PMC_FAST_STARTUP_Msk.

void pmc_disable_all_pck

(

void

)

Disable all programmable clocks.

void pmc_disable_all_periph_clk

(

void

)

Disable all peripheral clocks.

References pmc_disable_periph_clk(), PMC_MASK_STATUS0, and PMC_MASK_STATUS1.

Referenced by init_chip().

void pmc_disable_clock_failure_detector

(

void

)

Disable Clock Failure Detector.

References CKGR_MOR_KEY_PASSWD.

void pmc_disable_interrupt

(

uint32_t

ul_sources

)

Disable PMC interrupts.

Parameters

ul_sources

Interrupt sources bit map.

void pmc_disable_pck

(

uint32_t

ul_id

)

Disable the specified programmable clock.

Parameters

ul_id

Id of the programmable clock.

Referenced by adp_example_tc_init(), config_uart_and_pck(), configure_tc(), genclk_disable(), main(), run_switch_mainck_as_mck_test(), run_switch_pllack_as_mck_test(), run_switch_slck_as_mck_test(), and tc_waveform_initialize().

uint32_t pmc_disable_periph_clk

(

uint32_t

ul_id

)

Disable the specified peripheral clock.

Note

The ID must NOT be shifted (i.e., 1 << ID_xxx).

Parameters

ul_id

Peripheral ID (ID_xxx).

Return values

0	Success.
1	Invalid parameter.

Referenced by pmc_disable_all_periph_clk(), run_periph_clk_cfg_test(), sysclk_disable_peripheral_clock(), and test_sleep_mode().

void pmc_disable_pllack

(

void

)

Disable PLLA clock.

Referenced by app_widget_launch_lpm_backup(), pll_config_write(), pll_disable(), pll_enable(), pmc_enable_pllack(), and sys_enter_wait_mode().

void pmc_enable_all_pck

(

void

)

Enable all programmable clocks.

void pmc_enable_all_periph_clk

(

void

)

Enable all peripheral clocks.

References pmc_enable_periph_clk(), PMC_MASK_STATUS0, and PMC_MASK_STATUS1.

void pmc_enable_backupmode

(

void

)

Enable Backup Mode.

Enter condition: WFE/(VROFF bit = 1) + (SLEEPDEEP bit = 1)

References SUPC_CR_KEY_PASSWD, SUPC_MR_KEY_PASSWD, and UNUSED.

Referenced by app_widget_launch_lpm_backup(), run_gpbr_test(), and test_backup_mode().

void pmc_enable_clock_failure_detector

(

void

)

Enable Clock Failure Detector.

References CKGR_MOR_KEY_PASSWD.

Referenced by main().

void pmc_enable_interrupt

(

uint32_t

ul_sources

)

Enable PMC interrupts.

Parameters

ul_sources

Interrupt sources bit map.

Referenced by main().

void pmc_enable_pck

(

uint32_t

ul_id

)

Enable the specified programmable clock.

Parameters

ul_id

Id of the programmable clock.

Referenced by adp_example_tc_init(), config_uart_and_pck(), configure_tc(), genclk_enable(), main(), run_switch_mainck_as_mck_test(), run_switch_pllack_as_mck_test(), run_switch_slck_as_mck_test(), and tc_waveform_initialize().

uint32_t pmc_enable_periph_clk

(

uint32_t

ul_id

)

Enable the specified peripheral clock.

Note

The ID must NOT be shifted (i.e., 1 << ID_xxx).

Parameters

ul_id

Peripheral ID (ID_xxx).

Return values

0	Success.
1	Invalid parameter.

Referenced by _display_init(), adc_input_init(), adp_example_adc_init(), adp_example_tc_init(), board_configure_sram(), buart_if_open(), busart_if_open(), capture_init(), config_uart_and_pck(), configure_adc(), configure_button(), configure_buttons(), configure_intn(), configure_tc(), configure_tc0(), configure_time_trigger(), configure_timer_for_run_time_stats(), demo_config_adc(), demo_configure_tc0(), display_init(), freertos_twi_master_init(), freertos_uart_serial_init(), freertos_usart_serial_init(), gfx_ili9325_init(), gfx_ili93xx_init(), hsmci_init(), init_system(), initTimer1ms(), main(), memories_initialization(), nand_flash_raw_initialize(), pio_capture_init(), pmc_enable_all_periph_clk(), pplc_if_init(), re200b_motion_detect_init(), reconfigure_console(), run_periph_clk_cfg_test(), run_pwm_test(), run_ssc_test(), spi_master_initialize(), spi_slave_initialize(), start_adc(), sys_init_timing(), sysclk_enable_peripheral_clock(), tc_trigger_init(), and uart_open().

void pmc_enable_pllack	(	uint32_t	mula,
		uint32_t	pllacount,
		uint32_t	diva
	)

Enable PLLA clock.

Parameters

mula	PLLA multiplier.
pllacount	PLLA counter.
diva	Divider.

References pmc_disable_pllack().

Referenced by main(), run_switch_pllack_as_mck_test(), and sys_enter_wait_mode().

void pmc_enable_sleepmode

(

uint8_t

uc_type

)

Enable Sleep Mode.

Enter condition: (WFE or WFI) + (SLEEPDEEP bit = 0) + (LPM bit = 0)

Parameters

uc_type

0 for wait for interrupt, 1 for wait for event.

Note

For SAM4S, SAM4C, SAM4CM, SAM4CP, SAMV71 and SAM4E series, since only WFI is effective, uc_type = 1 will be treated as uc_type = 0.

References UNUSED.

Referenced by app_widget_launch_lpm_sleep(), main(), run_sleep_mode_test(), and test_sleep_mode().

void pmc_enable_waitmode

(

void

)

Enable Wait Mode.

Enter condition: WFE + (SLEEPDEEP bit = 0) + (LPM bit = 1)

Referenced by sys_enter_wait_mode(), and test_wait_mode().

uint32_t pmc_get_interrupt_mask

(

void

)

Get PMC interrupt mask.

Returns

The interrupt mask value.

uint32_t pmc_get_status

(

void

)

Get current status.

Returns

The current PMC status.

Referenced by PMC_Handler().

uint32_t pmc_get_writeprotect_status

(

void

)

Return write protect status.

Returns

Return write protect status.

uint32_t pmc_is_locked_pllack

(

void

)

Is PLLA locked?

Return values

0	Not locked.
1	Locked.

Referenced by pll_is_locked().

uint32_t pmc_is_pck_enabled

(

uint32_t

ul_id

)

Check if the specified programmable clock is enabled.

Parameters

ul_id

Id of the programmable clock.

Return values

0	Programmable clock is disabled or unknown.
1	Programmable clock is enabled.

uint32_t pmc_is_periph_clk_enabled

(

uint32_t

ul_id

)

Check if the specified peripheral clock is enabled.

Note

The ID must NOT be shifted (i.e., 1 << ID_xxx).

Parameters

ul_id

Peripheral ID (ID_xxx).

Return values

0	Peripheral clock is disabled or unknown.
1	Peripheral clock is enabled.

void pmc_mainck_osc_select

(

uint32_t

ul_xtal_rc

)

Select Main Crystal or internal RC as main clock source.

Note

This function will not enable/disable RC or Main Crystal.

Parameters

ul_xtal_rc

0 internal RC is selected, otherwise Main Crystal.

References CKGR_MOR_KEY_PASSWD.

void pmc_mck_set_prescaler

(

uint32_t

ul_pres

)

Set the prescaler of the MCK.

Parameters

ul_pres

Prescaler value.

Referenced by sysclk_set_prescalers().

void pmc_mck_set_source

(

uint32_t

ul_source

)

Set the source of the MCK.

Parameters

ul_source

Source selection value.

Referenced by sysclk_set_source().

void pmc_osc_bypass_main_xtal

(

void

)

Bypass main XTAL.

References CKGR_MOR_KEY_PASSWD.

void pmc_osc_disable_fastrc

(

void

)

Disable the internal fast RC.

References CKGR_MOR_KEY_PASSWD.

Referenced by osc_disable(), set_default_working_clock(), and user_change_clock().

void pmc_osc_disable_main_xtal

(

void

)

Disable the main Xtal.

References CKGR_MOR_KEY_PASSWD.

void pmc_osc_disable_xtal

(

uint32_t

ul_bypass

)

Disable the external Xtal.

Parameters

ul_bypass

0 for Xtal, 1 for bypass.

References CKGR_MOR_KEY_PASSWD.

Referenced by app_widget_launch_lpm_backup(), osc_disable(), sys_enter_wait_mode(), test_backup_mode(), test_wait_mode(), and user_change_clock().

void pmc_osc_enable_fastrc

(

uint32_t

ul_rc

)

Enable fast RC oscillator.

Parameters

ul_rc

Fast RC oscillator(4/8/12Mhz).

References CKGR_MOR_KEY_PASSWD.

Referenced by user_change_clock().

void pmc_osc_enable_main_xtal

(

uint32_t

ul_xtal_startup_time

)

Enable main XTAL oscillator.

Parameters

ul_xtal_startup_time

Xtal start-up time, in number of slow clocks.

References CKGR_MOR_KEY_PASSWD.

uint32_t pmc_osc_is_bypassed_main_xtal

(

void

)

Check if the main crystal is bypassed.

Return values

0	Xtal is bypassed, otherwise not.

uint32_t pmc_osc_is_ready_32kxtal

(

void

)

Check if the external 32k Xtal is ready.

Return values

1	External 32k Xtal is ready.
0	External 32k Xtal is not ready.

Referenced by osc_is_ready().

uint32_t pmc_osc_is_ready_fastrc

(

void

)

Check if the main fastrc is ready.

Return values

0	Xtal is not ready, otherwise ready.

uint32_t pmc_osc_is_ready_main_xtal

(

void

)

Check if the main crystal is ready.

Note

If main crystal is bypassed, it's always ready.

Return values

0	main crystal is not ready, otherwise ready.

uint32_t pmc_osc_is_ready_mainck

(

void

)

Check if the MAINCK is ready.

Depending on MOSCEL, MAINCK can be one of Xtal, bypass or internal RC.

Return values

1	Xtal is ready.
0	Xtal is not ready.

Referenced by osc_is_ready().

void pmc_pck_set_prescaler	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

Set the prescaler for the specified programmable clock.

Parameters

ul_id	Peripheral ID.
ul_pres	Prescaler value.

void pmc_pck_set_source	(	uint32_t	ul_id,
		uint32_t	ul_source
	)

Set the source oscillator for the specified programmable clock.

Parameters

ul_id	Peripheral ID.
ul_source	Source selection value.

void pmc_set_fast_startup_input

(

uint32_t

ul_inputs

)

Set the wake-up inputs for fast startup mode registers (event generation).

Parameters

ul_inputs

Wake up inputs to enable.

References PMC_FAST_STARTUP_Msk.

Referenced by io_pin_init(), sys_enter_wait_mode(), and udd_enable().

void pmc_set_writeprotect

(

uint32_t

ul_enable

)

Enable or disable write protect of PMC registers.

Parameters

ul_enable

1 to enable, 0 to disable.

References PMC_WPMR_WPKEY_PASSWD.

void pmc_switch_mainck_to_fastrc

(

uint32_t

ul_moscrcf

)

Switch main clock source selection to internal fast RC.

Parameters

ul_moscrcf

Fast RC oscillator(4/8/12Mhz).

Return values

0	Success.
1	Timeout error.
2	Invalid frequency.

References CKGR_MOR_KEY_PASSWD.

Referenced by main(), osc_enable(), run_switch_mainck_as_mck_test(), sys_enter_wait_mode(), test_wait_mode(), and user_change_clock().

void pmc_switch_mainck_to_xtal	(	uint32_t	ul_bypass,
		uint32_t	ul_xtal_startup_time
	)

Switch main clock source selection to external Xtal/Bypass.

Note

The function may switch MCK to SCLK if MCK source is MAINCK to avoid any system crash.

If used in Xtal mode, the Xtal is automatically enabled.

Parameters

ul_bypass

0 for Xtal, 1 for bypass.

Return values

0	Success.
1	Timeout error.

References CKGR_MOR_KEY_PASSWD.

Referenced by main(), osc_enable(), run_switch_mainck_as_mck_test(), set_default_working_clock(), sys_enter_wait_mode(), and user_change_clock().

uint32_t pmc_switch_mck_to_mainck

(

uint32_t

ul_pres

)

Switch master clock source selection to main clock.

Parameters

ul_pres

Processor clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by main(), run_switch_mainck_as_mck_test(), run_switch_pllack_as_mck_test(), switch_mck_to_default(), sys_enter_wait_mode(), sysclk_init(), test_wait_mode(), and user_change_clock().

uint32_t pmc_switch_mck_to_pllack

(

uint32_t

ul_pres

)

Switch master clock source selection to PLLA clock.

Parameters

ul_pres

Processor clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by main(), run_switch_pllack_as_mck_test(), sys_enter_wait_mode(), and sysclk_init().

uint32_t pmc_switch_mck_to_sclk

(

uint32_t

ul_pres

)

Switch master clock source selection to slow clock.

Parameters

ul_pres

Processor clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by app_widget_launch_lpm_backup(), main(), run_switch_mainck_as_mck_test(), run_switch_slck_as_mck_test(), set_default_working_clock(), sys_enter_wait_mode(), sysclk_init(), test_backup_mode(), test_wait_mode(), and user_change_clock().

uint32_t pmc_switch_pck_to_mainck	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

Switch programmable clock source selection to main clock.

Parameters

ul_id	Id of the programmable clock.
ul_pres	Programmable clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by config_uart_and_pck(), main(), and run_switch_mainck_as_mck_test().

uint32_t pmc_switch_pck_to_mck	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

Switch programmable clock source selection to mck.

Parameters

ul_id	Id of the programmable clock.
ul_pres	Programmable clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by tc_waveform_initialize().

uint32_t pmc_switch_pck_to_pllack	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

Switch programmable clock source selection to PLLA clock.

Parameters

ul_id	Id of the programmable clock.
ul_pres	Programmable clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by config_uart_and_pck(), and run_switch_pllack_as_mck_test().

uint32_t pmc_switch_pck_to_sclk	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

Switch programmable clock source selection to slow clock.

Parameters

ul_id	Id of the programmable clock.
ul_pres	Programmable clock prescaler.

Return values

0	Success.
1	Timeout error.

References PMC_TIMEOUT.

Referenced by adp_example_tc_init(), config_uart_and_pck(), configure_tc(), and run_switch_slck_as_mck_test().

void pmc_switch_sclk_to_32kxtal

(

uint32_t

ul_bypass

)

Switch slow clock source selection to external 32k (Xtal or Bypass).

Note

Switching SCLK back to 32krc is only possible by shutting down the VDDIO power supply.

Parameters

ul_bypass

0 for Xtal, 1 for bypass.

References SUPC_CR_KEY_PASSWD, and SUPC_MR_KEY_PASSWD.

Referenced by main(), and osc_enable().