pm.h File Reference

Power Manager driver. More...

#include <arch/avr32.h>
#include <avr32/io.h>
#include "preprocessor.h"

Include dependency graph for pm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	SLEEP(mode)   {__asm__ __volatile__ ("sleep "STRINGZ(mode));}
	Sets the MCU in the specified sleep mode.
Functions
void	pm_enable_osc0_crystal (unsigned int fosc0)
	This function will enable the crystal mode of the oscillator 0.
void	pm_enable_clk0 (unsigned int startup)
	This function will enable the oscillator 0 to be used with a startup time.
void	pm_disable_clk0 (volatile avr32_pm_t *pm)
	This function will disable the oscillator 0.
void	pm_enable_clk0_no_wait (volatile avr32_pm_t *pm, unsigned int startup)
	This function will enable the oscillator 0 to be used with no startup time.
void	pm_wait_for_clk0_ready (volatile avr32_pm_t *pm)
	This function will wait until the Osc0 clock is ready.
void	pm_enable_osc1_ext_clock (volatile avr32_pm_t *pm)
	This function will enable the external clock mode of the oscillator 1.
void	pm_enable_osc1_crystal (volatile avr32_pm_t *pm, unsigned int fosc1)
	This function will enable the crystal mode of the oscillator 1.
void	pm_enable_clk1 (volatile avr32_pm_t *pm, unsigned int startup)
	This function will enable the oscillator 1 to be used with a startup time.
void	pm_disable_clk1 (volatile avr32_pm_t *pm)
	This function will disable the oscillator 1.
void	pm_enable_clk1_no_wait (volatile avr32_pm_t *pm, unsigned int startup)
	This function will enable the oscillator 1 to be used with no startup time.
void	pm_wait_for_clk1_ready (volatile avr32_pm_t *pm)
	This function will wait until the Osc1 clock is ready.
void	pm_enable_osc32_ext_clock (volatile avr32_pm_t *pm)
	This function will enable the external clock mode of the 32-kHz oscillator.
void	pm_enable_osc32_crystal (volatile avr32_pm_t *pm)
	This function will enable the crystal mode of the 32-kHz oscillator.
void	pm_enable_clk32 (volatile avr32_pm_t *pm, unsigned int startup)
	This function will enable the oscillator 32 to be used with a startup time.
void	pm_disable_clk32 (volatile avr32_pm_t *pm)
	This function will disable the oscillator 32.
void	pm_enable_clk32_no_wait (volatile avr32_pm_t *pm, unsigned int startup)
	This function will enable the oscillator 32 to be used with no startup time.
void	pm_wait_for_clk32_ready (volatile avr32_pm_t *pm)
	This function will wait until the osc32 clock is ready.
void	pm_cksel (volatile avr32_pm_t *pm, unsigned int pbadiv, unsigned int pbasel, unsigned int pbbdiv, unsigned int pbbsel, unsigned int hsbdiv, unsigned int hsbsel)
	This function will select all the power manager clocks.
void	pm_pll_setup (volatile avr32_pm_t *pm, unsigned int pll, unsigned int mul, unsigned int div, unsigned int osc, unsigned int lockcount)
	This function will setup a PLL.
void	pm_pll_set_option (volatile avr32_pm_t *pm, unsigned int pll, unsigned int pll_freq, unsigned int pll_div2, unsigned int pll_wbwdisable)
	This function will set a PLL option.
unsigned int	pm_pll_get_option (volatile avr32_pm_t *pm, unsigned int pll)
	This function will get a PLL option.
void	pm_pll_enable (volatile avr32_pm_t *pm, unsigned int pll)
	This function will enable a PLL.
void	pm_pll_disable (volatile avr32_pm_t *pm, unsigned int pll)
	This function will disable a PLL.
void	pm_wait_for_pll0_locked (volatile avr32_pm_t *pm)
	This function will wait for PLL0 locked.
void	pm_wait_for_pll1_locked (volatile avr32_pm_t *pm)
	This function will wait for PLL1 locked.
void	pm_switch_to_clock (unsigned long clock)
	This function will switch the power manager main clock.
void	pm_switch_to_osc0 (unsigned int fosc0, unsigned int startup)
	Switch main clock to clock Osc0 (crystal mode)
void	pm_bod_enable_irq (volatile avr32_pm_t *pm)
	Enables the Brown-Out Detector interrupt.
void	pm_bod_disable_irq (volatile avr32_pm_t *pm)
	Disables the Brown-Out Detector interrupt.
void	pm_bod_clear_irq (volatile avr32_pm_t *pm)
	Clears the Brown-Out Detector interrupt flag.
unsigned long	pm_bod_get_irq_status (volatile avr32_pm_t *pm)
	Gets the Brown-Out Detector interrupt flag.
unsigned long	pm_bod_get_irq_enable_bit (volatile avr32_pm_t *pm)
	Gets the Brown-Out Detector interrupt enable status.
unsigned long	pm_bod_get_level (volatile avr32_pm_t *pm)
	Gets the triggering threshold of the Brown-Out Detector.
unsigned long	pm_read_gplp (volatile avr32_pm_t *pm, unsigned long gplp)
	Read the content of the PM GPLP registers.
void	pm_write_gplp (volatile avr32_pm_t *pm, unsigned long gplp, unsigned long value)
	Write into the PM GPLP registers.
long	pm_enable_module (volatile avr32_pm_t *pm, unsigned long module)
	Enable the clock of a module.
long	pm_disable_module (volatile avr32_pm_t *pm, unsigned long module)
	Disable the clock of a module.
void	pm_configure_usb_clock (void)
	Automatically configure the USB clock.
void	Avr32InitClockTree (void)

---

Detailed Description

Power Manager driver.

Copyright (C) 2001-2010 by egnite Software GmbH

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For additional information see http://www.ethernut.de/

Portions Copyright Atmel Corporation, see the following note.

• Compiler: IAR EWAVR32 and GNU GCC for AVR32
• Supported devices: All AVR32 devices.
• AppNote:

Author:

Atmel Corporation: http://www.atmel.com
Support and FAQ: http://support.atmel.no/

---

Define Documentation

#define SLEEP

(

mode

)

{__asm__ __volatile__ ("sleep "STRINGZ(mode));}

Sets the MCU in the specified sleep mode.

Parameters:

mode	Sleep mode: AVR32_PM_SMODE_IDLE: Idle; AVR32_PM_SMODE_FROZEN: Frozen; AVR32_PM_SMODE_STANDBY: Standby; AVR32_PM_SMODE_STOP: Stop; AVR32_PM_SMODE_DEEP_STOP: DeepStop; AVR32_PM_SMODE_STATIC: Static.

---

Function Documentation

void pm_enable_osc0_crystal

(

unsigned int

fosc0

)

This function will enable the crystal mode of the oscillator 0.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
fosc0	Oscillator 0 crystal frequency (Hz)

Referenced by pm_switch_to_osc0().

void pm_enable_clk0

(

unsigned int

startup

)

This function will enable the oscillator 0 to be used with a startup time.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
startup	Clock 0 startup time. AVR32_PM_OSCCTRL0_STARTUP_x_RCOSC.

References u_avr32_pm_oscctrl0_t::oscctrl0, and u_avr32_pm_oscctrl0_t::OSCCTRL0.

Referenced by pm_switch_to_osc0().

void pm_disable_clk0

(

volatile avr32_pm_t *

pm

)

This function will disable the oscillator 0.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_clk0_no_wait	(	volatile avr32_pm_t *	pm,
		unsigned int	startup
	)

This function will enable the oscillator 0 to be used with no startup time.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
startup	Clock 0 startup time, for which the function does not wait. AVR32_PM_OSCCTRL0_STARTUP_x_RCOSC.

void pm_wait_for_clk0_ready

(

volatile avr32_pm_t *

pm

)

This function will wait until the Osc0 clock is ready.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_osc1_ext_clock

(

volatile avr32_pm_t *

pm

)

This function will enable the external clock mode of the oscillator 1.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_osc1_crystal	(	volatile avr32_pm_t *	pm,
		unsigned int	fosc1
	)

This function will enable the crystal mode of the oscillator 1.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
fosc1	Oscillator 1 crystal frequency (Hz)

void pm_enable_clk1	(	volatile avr32_pm_t *	pm,
		unsigned int	startup
	)

This function will enable the oscillator 1 to be used with a startup time.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
startup	Clock 1 startup time. AVR32_PM_OSCCTRL1_STARTUP_x_RCOSC.

void pm_disable_clk1

(

volatile avr32_pm_t *

pm

)

This function will disable the oscillator 1.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_clk1_no_wait	(	volatile avr32_pm_t *	pm,
		unsigned int	startup
	)

This function will enable the oscillator 1 to be used with no startup time.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
startup	Clock 1 startup time, for which the function does not wait. AVR32_PM_OSCCTRL1_STARTUP_x_RCOSC.

void pm_wait_for_clk1_ready

(

volatile avr32_pm_t *

pm

)

This function will wait until the Osc1 clock is ready.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_osc32_ext_clock

(

volatile avr32_pm_t *

pm

)

This function will enable the external clock mode of the 32-kHz oscillator.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_osc32_crystal

(

volatile avr32_pm_t *

pm

)

This function will enable the crystal mode of the 32-kHz oscillator.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_clk32	(	volatile avr32_pm_t *	pm,
		unsigned int	startup
	)

This function will enable the oscillator 32 to be used with a startup time.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
startup	Clock 32 kHz startup time. AVR32_PM_OSCCTRL32_STARTUP_x_RCOSC.

void pm_disable_clk32

(

volatile avr32_pm_t *

pm

)

This function will disable the oscillator 32.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_enable_clk32_no_wait	(	volatile avr32_pm_t *	pm,
		unsigned int	startup
	)

This function will enable the oscillator 32 to be used with no startup time.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
startup	Clock 32 kHz startup time, for which the function does not wait. AVR32_PM_OSCCTRL32_STARTUP_x_RCOSC.

void pm_wait_for_clk32_ready

(

volatile avr32_pm_t *

pm

)

This function will wait until the osc32 clock is ready.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_cksel	(	volatile avr32_pm_t *	pm,
		unsigned int	pbadiv,
		unsigned int	pbasel,
		unsigned int	pbbdiv,
		unsigned int	pbbsel,
		unsigned int	hsbdiv,
		unsigned int	hsbsel
	)

This function will select all the power manager clocks.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
pbadiv	Peripheral Bus A clock divisor enable
pbasel	Peripheral Bus A select
pbbdiv	Peripheral Bus B clock divisor enable
pbbsel	Peripheral Bus B select
hsbdiv	High Speed Bus clock divisor enable (CPU clock = HSB clock)
hsbsel	High Speed Bus select (CPU clock = HSB clock )

Referenced by Avr32InitClockTree().

void pm_pll_setup	(	volatile avr32_pm_t *	pm,
		unsigned int	pll,
		unsigned int	mul,
		unsigned int	div,
		unsigned int	osc,
		unsigned int	lockcount
	)

This function will setup a PLL.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
pll	PLL number(0 for PLL0, 1 for PLL1)
mul	PLL MUL in the PLL formula
div	PLL DIV in the PLL formula
osc	OSC number (0 for osc0, 1 for osc1)
lockcount	PLL lockount

References u_avr32_pm_pll_t::pll, and u_avr32_pm_pll_t::PLL.

Referenced by Avr32InitClockTree().

void pm_pll_set_option	(	volatile avr32_pm_t *	pm,
		unsigned int	pll,
		unsigned int	pll_freq,
		unsigned int	pll_div2,
		unsigned int	pll_wbwdisable
	)

This function will set a PLL option.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
pll	PLL number(0 for PLL0, 1 for PLL1)
pll_freq	Set to 1 for VCO frequency range 80-180MHz, set to 0 for VCO frequency range 160-240Mhz.
pll_div2	Divide the PLL output frequency by 2 (this settings does not change the FVCO value)
pll_wbwdisable	1 Disable the Wide-Bandith Mode (Wide-Bandwith mode allow a faster startup time and out-of-lock time). 0 to enable the Wide-Bandith Mode.

References u_avr32_pm_pll_t::pll, and u_avr32_pm_pll_t::PLL.

Referenced by Avr32InitClockTree().

unsigned int pm_pll_get_option	(	volatile avr32_pm_t *	pm,
		unsigned int	pll
	)

This function will get a PLL option.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
pll	PLL number(0 for PLL0, 1 for PLL1)

Returns:

Option

void pm_pll_enable	(	volatile avr32_pm_t *	pm,
		unsigned int	pll
	)

This function will enable a PLL.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
pll	PLL number(0 for PLL0, 1 for PLL1)

Referenced by Avr32InitClockTree().

void pm_pll_disable	(	volatile avr32_pm_t *	pm,
		unsigned int	pll
	)

This function will disable a PLL.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
pll	PLL number(0 for PLL0, 1 for PLL1)

void pm_wait_for_pll0_locked

(

volatile avr32_pm_t *

pm

)

This function will wait for PLL0 locked.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

Referenced by Avr32InitClockTree().

void pm_wait_for_pll1_locked

(

volatile avr32_pm_t *

pm

)

This function will wait for PLL1 locked.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)

void pm_switch_to_clock

(

unsigned long

clock

)

This function will switch the power manager main clock.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
clock	Clock to be switched on. AVR32_PM_MCSEL_SLOW for RCOsc, AVR32_PM_MCSEL_OSC0 for Osc0, AVR32_PM_MCSEL_PLL0 for PLL0.

References u_avr32_pm_mcctrl_t::mcctrl, and u_avr32_pm_mcctrl_t::MCCTRL.

Referenced by Avr32InitClockTree(), and pm_switch_to_osc0().

void pm_switch_to_osc0	(	unsigned int	fosc0,
		unsigned int	startup
	)

Switch main clock to clock Osc0 (crystal mode)

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
fosc0	Oscillator 0 crystal frequency (Hz)
startup	Crystal 0 startup time. AVR32_PM_OSCCTRL0_STARTUP_x_RCOSC.

References dfll_enable_closed_loop(), pm_enable_clk0(), pm_enable_osc0_crystal(), pm_switch_to_clock(), sysclk_set_prescalers(), sysclk_set_source(), and SYSCLK_SRC_DFLL.

Referenced by Avr32InitClockTree().

Here is the call graph for this function:

void pm_bod_enable_irq

(

volatile avr32_pm_t *

pm

)

Enables the Brown-Out Detector interrupt.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM).

void pm_bod_disable_irq

(

volatile avr32_pm_t *

pm

)

Disables the Brown-Out Detector interrupt.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM).

void pm_bod_clear_irq

(

volatile avr32_pm_t *

pm

)

Clears the Brown-Out Detector interrupt flag.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM).

unsigned long pm_bod_get_irq_status

(

volatile avr32_pm_t *

pm

)

Gets the Brown-Out Detector interrupt flag.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM).

Return values:

0	No BOD interrupt.
1	BOD interrupt pending.

unsigned long pm_bod_get_irq_enable_bit

(

volatile avr32_pm_t *

pm

)

Gets the Brown-Out Detector interrupt enable status.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM).

Return values:

0	BOD interrupt disabled.
1	BOD interrupt enabled.

unsigned long pm_bod_get_level

(

volatile avr32_pm_t *

pm

)

Gets the triggering threshold of the Brown-Out Detector.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM).

Returns:

Triggering threshold of the BOD. See the electrical characteristics in the part datasheet for actual voltage levels.

unsigned long pm_read_gplp	(	volatile avr32_pm_t *	pm,
		unsigned long	gplp
	)

Read the content of the PM GPLP registers.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
gplp	GPLP register index (0,1,... depending on the number of GPLP registers for a given part)

Returns:

The content of the chosen GPLP register.

void pm_write_gplp	(	volatile avr32_pm_t *	pm,
		unsigned long	gplp,
		unsigned long	value
	)

Write into the PM GPLP registers.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
gplp	GPLP register index (0,1,... depending on the number of GPLP registers for a given part)
value	Value to write

long pm_enable_module	(	volatile avr32_pm_t *	pm,
		unsigned long	module
	)

Enable the clock of a module.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
module	The module to clock (use one of the defines in the part-specific header file under "toolchain folder"/avr32/inc(lude)/avr32/; depending on the clock domain, look for the sections "CPU clocks", "HSB clocks", "PBx clocks")

Returns:

Status.

Return values:

0	Success.
<0	An error occured.

long pm_disable_module	(	volatile avr32_pm_t *	pm,
		unsigned long	module
	)

Disable the clock of a module.

Parameters:

pm	Base address of the Power Manager (i.e. &AVR32_PM)
module	The module to shut down (use one of the defines in the part-specific header file under "toolchain folder"/avr32/inc(lude)/avr32/; depending on the clock domain, look for the sections "CPU clocks", "HSB clocks", "PBx clocks")

Returns:

Status.

Return values:

0	Success.
<0	An error occured.

void pm_configure_usb_clock

(

void

)

Automatically configure the USB clock.

USB clock is configured to 48MHz, using the PLL1 from the Oscillator0, assuming a 12 MHz crystal is connected to it.

void Avr32InitClockTree

(

void

)

References pm_cksel(), pm_pll_enable(), pm_pll_set_option(), pm_pll_setup(), pm_switch_to_clock(), pm_switch_to_osc0(), and pm_wait_for_pll0_locked().

Referenced by NutInit().

Here is the call graph for this function: