pm.h

Go to the documentation of this file.

/* This header file is part of the ATMEL AVR-UC3-SoftwareFramework-1.7.0 Release */

/*This file has been prepared for Doxygen automatic documentation generation.*/
/* Copyright (c) 2009 Atmel Corporation. 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. The name of Atmel may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an Atmel
 * AVR product.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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
 *
 */

#ifndef _PM_H_
#define _PM_H_

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


#define SLEEP(mode)   {__asm__ __volatile__ ("sleep "STRINGZ(mode));}


typedef struct
{
  unsigned long cpu_f;

  unsigned long pba_f;

  unsigned long osc0_f;

  unsigned long osc0_startup;
} pm_freq_param_t;

#define PM_FREQ_STATUS_FAIL   (-1)
#define PM_FREQ_STATUS_OK     (0)


#if (defined __GNUC__)
__attribute__((__always_inline__))
#endif
extern __inline__ unsigned int pm_get_reset_cause(volatile avr32_pm_t *pm)
{
  return pm->rcause;
}


extern void pm_enable_osc0_ext_clock(volatile avr32_pm_t *pm);


extern void pm_enable_osc0_crystal(volatile avr32_pm_t *pm, unsigned int fosc0);


extern void pm_enable_clk0(volatile avr32_pm_t *pm, unsigned int startup);


extern void pm_disable_clk0(volatile avr32_pm_t *pm);


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


extern void pm_wait_for_clk0_ready(volatile avr32_pm_t *pm);


extern void pm_enable_osc1_ext_clock(volatile avr32_pm_t *pm);


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


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


extern void pm_disable_clk1(volatile avr32_pm_t *pm);


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


extern void pm_wait_for_clk1_ready(volatile avr32_pm_t *pm);


extern void pm_enable_osc32_ext_clock(volatile avr32_pm_t *pm);


extern void pm_enable_osc32_crystal(volatile avr32_pm_t *pm);


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


extern void pm_disable_clk32(volatile avr32_pm_t *pm);


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


extern void pm_wait_for_clk32_ready(volatile avr32_pm_t *pm);


extern 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);


extern void pm_gc_setup(volatile avr32_pm_t *pm, unsigned int gc, unsigned int osc_or_pll, unsigned int pll_osc, unsigned int diven, unsigned int div);


extern void pm_gc_enable(volatile avr32_pm_t *pm, unsigned int gc);


extern void pm_gc_disable(volatile avr32_pm_t *pm, unsigned int gc);


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


extern 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);


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


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


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


extern void pm_wait_for_pll0_locked(volatile avr32_pm_t *pm);


extern void pm_wait_for_pll1_locked(volatile avr32_pm_t *pm);


extern void pm_switch_to_clock(volatile avr32_pm_t *pm, unsigned long clock);


extern void pm_switch_to_osc0(volatile avr32_pm_t *pm, unsigned int fosc0, unsigned int startup);


extern void pm_bod_enable_irq(volatile avr32_pm_t *pm);


extern void pm_bod_disable_irq(volatile avr32_pm_t *pm);


extern void pm_bod_clear_irq(volatile avr32_pm_t *pm);


extern unsigned long pm_bod_get_irq_status(volatile avr32_pm_t *pm);


extern unsigned long pm_bod_get_irq_enable_bit(volatile avr32_pm_t *pm);


extern unsigned long pm_bod_get_level(volatile avr32_pm_t *pm);


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


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


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

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



extern int pm_configure_clocks(pm_freq_param_t *param);


extern void pm_configure_usb_clock(void);


#endif  // _PM_H_