clksys_driver.h File Reference

XMEGA Clock System driver header file. More...

#include "avr_compiler.h"

Go to the source code of this file.

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

Functions
void	CCPWrite (volatile uint8_t *address, uint8_t value)
	CCP write helper function written in assembly.

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:

1665

Date:

2008-06-05 09:21:50 +0200 (to, 05 jun 2008)

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

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

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

Macro Definition Documentation

#define CLKSYS_AutoCalibration_Disable

(

_clk

)

( (_clk).CTRL &= ~DFLL_ENABLE_bm )

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

Parameters

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

#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_RC32MEN_bm, OSC_RC32KEN_bm, OSC_XOSCEN_bm, OSC_PLLEN_bm.

#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_RC32MEN_bm, OSC_RC32KEN_bm, OSC_XOSCEN_bm, OSC_PLLEN_bm.

Returns

Non-zero if oscillator is ready and running.

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

Function Documentation

void CCPWrite	(	volatile uint8_t *	address,
		uint8_t	value
	)

CCP write helper function written in assembly.

This function is written in assembly because of the timecritial operation of writing to the registers.

Parameters

address	A pointer to the address to write to.
value	The value to put in to the register.