clksys_driver.h File Reference

XMEGA Clock System driver header file. More...

#include <stdint.h>
#include <stdbool.h>
#include <ioavr.h>

Include dependency graph for clksys_driver.h:

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

Go to the source code of this file.

Macros
#define	CLKSYS_AutoCalibration_Disable(_clk)   ( (_clk).CALA &= ~DFLL_ENABLE_bm )
	This macro disables the automatic calibration of the selected internal oscillator. More...
#define	CLKSYS_Enable(_oscSel)   ( OSC.CTRL |= (_oscSel) )
	This macro enables the selected oscillator. More...
#define	CLKSYS_IsReady(_oscSel)   ( OSC.STATUS & (_oscSel) )
	This macro check if selected oscillator is ready. More...
#define	CLKSYS_RTC_ClockSource_Disable()   ( CLK.RTCCTRL &= ~CLK_RTCEN_bm )
	This macro disables routing of clock signals to the Real-Time Counter (RTC). More...

Functions
void	CLKSYS_AutoCalibration_Enable (uint8_t clkSource, bool extReference)
	This function enables automatic calibration of the selected internal oscillator. More...
void	CLKSYS_Configuration_Lock (void)
	This function lock the entire clock system configuration. More...
uint8_t	CLKSYS_Disable (uint8_t oscSel)
	This function disables the selected oscillator. More...
uint8_t	CLKSYS_Main_ClockSource_Select (CLK_SCLKSEL_t clockSource)
	This function selects the main system clock source. More...
void	CLKSYS_PLL_Config (OSC_PLLSRC_t clockSource, uint8_t factor)
	This function configures the internal high-frequency PLL. More...
void	CLKSYS_Prescalers_Config (CLK_PSADIV_t PSAfactor, CLK_PSBCDIV_t PSBCfactor)
	This function changes the prescaler configuration. More...
void	CLKSYS_RTC_ClockSource_Enable (CLK_RTCSRC_t clockSource)
	This function selects a Real-Time Counter clock source. More...
void	CLKSYS_XOSC_Config (OSC_FRQRANGE_t freqRange, bool lowPower32kHz, OSC_XOSCSEL_t xoscModeSelection)
	This function configures the external oscillator. More...
void	CLKSYS_XOSC_FailureDetection_Enable (void)
	This function enables the External Oscillator Failure Detection (XOSCFD) feature. More...

Detailed Description

XMEGA Clock System driver header file.

This file contains the function prototypes and enumerator definitions for various configuration parameters for the XMEGA Clock System driver.

The driver is not intended for size and/or speed critical code, since most functions are just a few lines of code, and the function call overhead would decrease code performance. The driver is intended for rapid prototyping and documentation purposes for getting started with the XMEGA Clock System.

For size and/or speed critical code, it is recommended to copy the function contents directly into your application instead of making a function call.

Application note:

AVR1003: Using the XMEGA Clock System

Documentation

For comprehensive code documentation, supported compilers, compiler settings and supported devices see readme.html

Author

Atmel Corporation: http://www.atmel.com
Support email: avr@a.nosp@m.tmel.nosp@m..com

Revision

786

URL

http://svn.norway.atmel.com/AppsXmega/avr1003_XMEGA_Clock_System/trunk/code/clksys_driver.h

Date

2007-11-07 10:27:22 +0100 (on, 07 nov 2007)

Copyright (c) 2007, 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.

THIS SOFTWARE IS PROVIDED BY ATMEL ``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 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.

Definition in file clksys_driver.h.

Macro Definition Documentation

CLKSYS_AutoCalibration_Disable

#define CLKSYS_AutoCalibration_Disable

(

_clk

)

( (_clk).CALA &= ~DFLL_ENABLE_bm )

This macro disables the automatic calibration of the selected internal oscillator.

Parameters

_clk	Clock source calibration to disable, either DFLLRC2M or DFLLR32M.

Definition at line 108 of file clksys_driver.h.

CLKSYS_Enable

#define CLKSYS_Enable

(

_oscSel

)

( OSC.CTRL |= (_oscSel) )

This macro enables the selected oscillator.

Note

Note that the oscillator cannot be used as a main system clock source without being enabled and stable first. Check the ready flag before using the clock. The function CLKSYS_IsReady( _oscSel ) can be used to check this.

Parameters

_oscSel

Bitmask of selected clock. Can be one of the following OSC_RC2MEN_bm, OSC_R32MEN_bm, OSC_RC32KEN_bm, OSC_XOSCEN_bm, OSC_PLLEN_bm.

Definition at line 81 of file clksys_driver.h.

Referenced by clock_init().

CLKSYS_IsReady

#define CLKSYS_IsReady

(

_oscSel

)

( OSC.STATUS & (_oscSel) )

This macro check if selected oscillator is ready.

This macro will return non-zero if is is running, regardless if it is used as a main clock source or not.

Parameters

_oscSel

Bitmask of selected clock. Can be one of the following OSC_RC2MEN_bm, OSC_R32MEN_bm, OSC_RC32KEN_bm, OSC_XOSCEN_bm, OSC_PLLEN_bm.

Returns

Non-zero if oscillator is ready and running.

Definition at line 94 of file clksys_driver.h.

Referenced by clock_init().

CLKSYS_RTC_ClockSource_Disable

#define CLKSYS_RTC_ClockSource_Disable

(

)

( CLK.RTCCTRL &= ~CLK_RTCEN_bm )

This macro disables routing of clock signals to the Real-Time Counter (RTC).

Disabling the RTC saves power if the RTC is not in use.

Definition at line 101 of file clksys_driver.h.

Function Documentation

CLKSYS_AutoCalibration_Enable()

void CLKSYS_AutoCalibration_Enable	(	uint8_t	clkSource,
		bool	extReference
	)

This function enables automatic calibration of the selected internal oscillator.

Either the internal 32kHz RC oscillator or an external 32kHz crystal can be used as a calibration reference. The user must make sure that the selected reference is ready and running.

Parameters

clkSource	Clock source to calibrate, either OSC_RC2MCREF_bm or OSC_R32MCREF_bm.
extReference	True if external crystal should be used as reference.

Definition at line 244 of file clksys_driver.c.

{
    OSC.DFLLCTRL = ( OSC.DFLLCTRL & ~clkSource ) |
                   ( extReference ? clkSource : 0 );
    if (clkSource == OSC_RC2MCREF_bm) {
        DFLLRC2M.CALA |= DFLL_ENABLE_bm;
    } else if (clkSource == OSC_RC2MCREF_bm) {
        DFLLRC32M.CALA |= DFLL_ENABLE_bm;
    }
}

CLKSYS_Configuration_Lock()

void CLKSYS_Configuration_Lock

(

void

)

This function lock the entire clock system configuration.

This will lock the configuration until the next reset, or until the External Oscillator Failure Detections (XOSCFD) feature detects a failure and switches to internal 2MHz RC oscillator.

Definition at line 276 of file clksys_driver.c.

References CCPWrite().

{
    CCPWrite( &CLK.LOCK, CLK_LOCK_bm );
}

Here is the call graph for this function:

CLKSYS_Disable()

uint8_t CLKSYS_Disable

(

uint8_t

oscSel

)

This function disables the selected oscillator.

This function will disable the selected oscillator if possible. If it is currently used as a main system clock source, hardware will disregard the disable attempt, and this function will return zero. If it fails, change to another main system clock source and try again.

Parameters

oscSel

Bitmask of selected clock. Can be one of the following OSC_RC2MEN_bm, OSC_R32MEN_bm, OSC_RC32KEN_bm, OSC_XOSCEN_bm, OSC_PLLEN_bm.

Returns

Non-zero if oscillator was disabled successfully.

Definition at line 171 of file clksys_driver.c.

{
    OSC.CTRL &= ~oscSel;
    uint8_t clkEnabled = OSC.CTRL & oscSel;
    return clkEnabled;
}

CLKSYS_Main_ClockSource_Select()

uint8_t CLKSYS_Main_ClockSource_Select

(

CLK_SCLKSEL_t

clockSource

)

This function selects the main system clock source.

Hardware will disregard any attempts to select a clock source that is not enabled or not stable. If the change fails, make sure the source is ready and running and try again.

Parameters

clockSource

Clock source to use as input for the system clock prescaler block.

Returns

Non-zero if change was successful.

Definition at line 209 of file clksys_driver.c.

References CCPWrite().

Referenced by clock_init().

{
    uint8_t clkCtrl = ( CLK.CTRL & ~CLK_SCLKSEL_gm ) | clockSource;
    CCPWrite( &CLK.CTRL, clkCtrl );
    clkCtrl = ( CLK.CTRL & clockSource );
    return clkCtrl;
}

Here is the call graph for this function:

CLKSYS_PLL_Config()

void CLKSYS_PLL_Config	(	OSC_PLLSRC_t	clockSource,
		uint8_t	factor
	)

This function configures the internal high-frequency PLL.

Configuration of the internal high-frequency PLL to the correct values. It is used to define the input of the PLL and the factor of multiplication of the input clock source.

Note

Note that the oscillator cannot be used as a main system clock source without being enabled and stable first. Check the ready flag before using the clock. The macro CLKSYS_IsReady( _oscSel ) can be used to check this.

Parameters

clockSource	Reference clock source for the PLL, must be above 0.4MHz.
factor	PLL multiplication factor, must be from 1 to 31, inclusive.

Definition at line 151 of file clksys_driver.c.

Referenced by clock_init().

{
    factor &= OSC_PLLFAC_gm;
    OSC.PLLCTRL = (uint8_t) clockSource | ( factor << OSC_PLLFAC_gp );
}

CLKSYS_Prescalers_Config()

void CLKSYS_Prescalers_Config	(	CLK_PSADIV_t	PSAfactor,
		CLK_PSBCDIV_t	PSBCfactor
	)

This function changes the prescaler configuration.

Change the configuration of the three system clock prescaler is one single operation. The user must make sure that the main CPU clock does not exceed recommended limits.

Parameters

PSAfactor	Prescaler A division factor, OFF or 2 to 512 in powers of two.
PSBCfactor	Prescaler B and C division factor, in the combination of (1,1), (1,2), (4,1) or (2,2).

Definition at line 190 of file clksys_driver.c.

References CCPWrite().

Referenced by clock_init().

{
    uint8_t PSconfig = (uint8_t) PSAfactor | PSBCfactor;
    CCPWrite( &CLK.PSCTRL, PSconfig );
}

Here is the call graph for this function:

CLKSYS_RTC_ClockSource_Enable()

void CLKSYS_RTC_ClockSource_Enable

(

CLK_RTCSRC_t

clockSource

)

This function selects a Real-Time Counter clock source.

Selects the clock source for use by the Real-Time Counter (RTC) and enables clock signal routing to the RTC module.

Parameters

clockSource

Clock source to use for the RTC.

Definition at line 225 of file clksys_driver.c.

{
    CLK.RTCCTRL = ( CLK.RTCCTRL & ~CLK_RTCSRC_gm ) |
                  clockSource |
                  CLK_RTCEN_bm;
}

CLKSYS_XOSC_Config()

void CLKSYS_XOSC_Config	(	OSC_FRQRANGE_t	freqRange,
		bool	lowPower32kHz,
		OSC_XOSCSEL_t	xoscModeSelection
	)

This function configures the external oscillator.

Note

Note that the oscillator cannot be used as a main system clock source without being enabled and stable first. Check the ready flag before using the clock. The macro CLKSYS_IsReady( _oscSel ) can be used to check this.

Parameters

freqRange	Frequency range for high-frequency crystal, does not apply for external clock or 32kHz crystals.
lowPower32kHz	True of high-quality watch crystals are used and low-power oscillator is desired.
xoscModeSelection	Combined selection of oscillator type (or external clock) and startup times.

Definition at line 125 of file clksys_driver.c.

{
    OSC.XOSCCTRL = (uint8_t) freqRange |
                   ( lowPower32kHz ? OSC_X32KLPM_bm : 0 ) |
                   xoscModeSelection;
}

CLKSYS_XOSC_FailureDetection_Enable()

void CLKSYS_XOSC_FailureDetection_Enable

(

void

)

This function enables the External Oscillator Failure Detection (XOSCFD) feature.

The feature will stay enabled until next reset. Note that the XOSCFD will issue the XOSCF Non-maskable Interrupt (NMI) regardless of any interrupt priorities and settings. Therefore, make sure that a handler is implemented for the XOSCF NMI when you enable it.

Definition at line 264 of file clksys_driver.c.

References CCPWrite().

{
    CCPWrite( &OSC.XOSCFAIL, ( OSC_XOSCFDIF_bm | OSC_XOSCFDEN_bm ) );
}

Here is the call graph for this function: