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.

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_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...

Master clock (MCK) Source and Prescaler configuration
Note The following functions may be used to select the clock source and prescaler for the master clock.
void	pmc_mck_set_division (uint32_t ul_div)

uint32_t	pmc_switch_mck_to_pllbck (uint32_t ul_pres)

uint32_t	pmc_switch_mck_to_upllck (uint32_t ul_pres)

void	pmc_set_flash_in_wait_mode (uint32_t ul_flash_state)

PLL oscillator and configuration
void	pmc_enable_pllbck (uint32_t mulb, uint32_t pllbcount, uint32_t divb)

void	pmc_disable_pllbck (void)

uint32_t	pmc_is_locked_pllbck (void)

void	pmc_enable_upll_clock (void)

void	pmc_disable_upll_clock (void)

uint32_t	pmc_is_locked_upll (void)

Programmable clock Source and Prescaler configuration
The following functions may be used to select the clock source and prescaler for the specified programmable clock.
uint32_t	pmc_get_slck_config (void)

uint32_t	pmc_get_mainck_config (void)

uint32_t	pmc_get_pllack_config (void)

uint32_t	pmc_get_upllckdiv_config (void)

void	pmc_enable_cpck (void)

void	pmc_disable_cpck (void)

bool	pmc_is_cpck_enabled (void)

void	pmc_enable_cpbmck (void)

void	pmc_disable_cpbmck (void)

bool	pmc_is_cpbmck_enabled (void)

void	pmc_cpck_set_prescaler (uint32_t ul_pres)

void	pmc_cpck_set_source (uint32_t ul_source)

uint32_t	pmc_switch_pck_to_pllbck (uint32_t ul_id, uint32_t ul_pres)

uint32_t	pmc_switch_pck_to_upllck (uint32_t ul_id, uint32_t ul_pres)

Power management
The following functions are used to configure sleep mode and additional wake up inputs.
void	pmc_cp_set_fast_startup_input (uint32_t ul_inputs)

void	pmc_cp_clr_fast_startup_input (uint32_t ul_inputs)

void	pmc_enable_backupmode (void)

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_cp_clr_fast_startup_input ( uint32_t ul_inputs )

void pmc_cp_set_fast_startup_input ( uint32_t ul_inputs )

void pmc_cpck_set_prescaler ( uint32_t ul_pres )

void pmc_cpck_set_source ( uint32_t ul_source )

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.

void pmc_disable_clock_failure_detector ( void )

Disable Clock Failure Detector.

References CKGR_MOR_KEY_PASSWD.

void pmc_disable_cpbmck ( void )

void pmc_disable_cpck ( void )

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 genclk_disable().

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(), and sysclk_disable_peripheral_clock().

void pmc_disable_pllack ( void )

Disable PLLA clock.

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

void pmc_disable_pllbck ( void )

void pmc_disable_upll_clock ( void )

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 )

void pmc_enable_clock_failure_detector ( void )

Enable Clock Failure Detector.

References CKGR_MOR_KEY_PASSWD.

void pmc_enable_cpbmck ( void )

void pmc_enable_cpck ( void )

void pmc_enable_interrupt ( uint32_t ul_sources )

Enable PMC interrupts.

Parameters

ul_sources Interrupt sources bit map.

void pmc_enable_pck ( uint32_t ul_id )

Enable the specified programmable clock.

Parameters

ul_id Id of the programmable clock.

Referenced by genclk_enable().

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 pmc_enable_all_periph_clk(), prepare_dma_channel(), and sysclk_enable_peripheral_clock().

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().

void pmc_enable_pllbck	(	uint32_t	mulb,
		uint32_t	pllbcount,
		uint32_t	divb
	)

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.

void pmc_enable_upll_clock ( void )

Referenced by sysclk_enable_usb().

void pmc_enable_waitmode ( void )

Enable Wait Mode.

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

uint32_t pmc_get_interrupt_mask ( void )

Get PMC interrupt mask.

Returns: The interrupt mask value.

uint32_t pmc_get_mainck_config ( void )

Referenced by genclk_get_frequency_hz().

uint32_t pmc_get_pllack_config ( void )

Referenced by genclk_get_frequency_hz().

uint32_t pmc_get_slck_config ( void )

Referenced by genclk_get_frequency_hz().

uint32_t pmc_get_status ( void )

Get current status.

Returns: The current PMC status.

uint32_t pmc_get_upllckdiv_config ( void )

Referenced by genclk_get_frequency_hz().

uint32_t pmc_get_writeprotect_status ( void )

Return write protect status.

Returns: Return write protect status.

bool pmc_is_cpbmck_enabled ( void )

bool pmc_is_cpck_enabled ( void )

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_locked_pllbck ( void )

uint32_t pmc_is_locked_upll ( void )

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.

Referenced by prepare_dma_channel().

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_division ( uint32_t ul_div )

Referenced by sysclk_init().

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().

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 osc_disable().

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.

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.

void pmc_set_flash_in_wait_mode ( uint32_t ul_flash_state )

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 osc_enable().

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 osc_enable().

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 sysclk_init().

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 sysclk_init().

uint32_t pmc_switch_mck_to_pllbck ( uint32_t ul_pres )

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 sysclk_init().

uint32_t pmc_switch_mck_to_upllck ( uint32_t ul_pres )

Referenced by sysclk_init().

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.

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.

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.

uint32_t pmc_switch_pck_to_pllbck	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

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.

uint32_t pmc_switch_pck_to_upllck	(	uint32_t	ul_id,
		uint32_t	ul_pres
	)

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 osc_enable().

Microchip® Advanced Software Framework

Functions

Master clock (MCK) Source and Prescaler configuration

PLL oscillator and configuration

Programmable clock Source and Prescaler configuration

Power management