<!-- HTML header for doxygen 1.8.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.6.3"/>
<!--BEGIN PROJECT_NAME--><title>avr-libc: avr-libc: xmega.h Source File</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>avr-libc: xmega.h Source File</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td style="padding-left: 0.5em;">
<div id="projectname">avr-libc
<!--BEGIN PROJECT_NUMBER--> <span id="projectnumber">2.0.0</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td style="padding-left: 0.5em;">
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<td>$searchbox</td>
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
</tbody>
</table>
<table>
<tr>
<td align="left"><a href="http://www.nongnu.org/avr-libc/"><h2>AVR Libc Home Page</h2></a></td>
<td align="center" colspan=4><img src="avrs.png" alt="AVRs" align="middle" border="0"></td>
<td align="right"><a href="https://savannah.nongnu.org/projects/avr-libc/"><h2>AVR Libc Development Pages</h2></a></td>
</tr>
<tr>
<td align="center" width="20%"><a href="index.html"><h2>Main Page</h2></a></td>
<td align="center" width="20%"><a href="pages.html"><h2>User Manual</h2></a></td>
<td align="center" width="20%"><a href="modules.html"><h2>Library Reference</h2></a></td>
<td align="center" width="20%"><a href="FAQ.html"><h2>FAQ</h2></a></td>
<td align="center" width="20%"><a href="group__demos.html"><h2>Example Projects</h2></a></td>
</tr>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<h1>xmega.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright (c) 2012 Joerg Wunsch</span>
<a name="l00002"></a>00002 <span class="comment"> All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> Redistribution and use in source and binary forms, with or without</span>
<a name="l00005"></a>00005 <span class="comment"> modification, are permitted provided that the following conditions are met:</span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment"> * Redistributions of source code must retain the above copyright</span>
<a name="l00008"></a>00008 <span class="comment"> notice, this list of conditions and the following disclaimer.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00011"></a>00011 <span class="comment"> notice, this list of conditions and the following disclaimer in</span>
<a name="l00012"></a>00012 <span class="comment"> the documentation and/or other materials provided with the</span>
<a name="l00013"></a>00013 <span class="comment"> distribution.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> * Neither the name of the copyright holders nor the names of</span>
<a name="l00016"></a>00016 <span class="comment"> contributors may be used to endorse or promote products derived</span>
<a name="l00017"></a>00017 <span class="comment"> from this software without specific prior written permission.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span>
<a name="l00020"></a>00020 <span class="comment"> AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00021"></a>00021 <span class="comment"> IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
<a name="l00022"></a>00022 <span class="comment"> ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span>
<a name="l00023"></a>00023 <span class="comment"> LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span>
<a name="l00024"></a>00024 <span class="comment"> CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span>
<a name="l00025"></a>00025 <span class="comment"> SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
<a name="l00026"></a>00026 <span class="comment"> INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span>
<a name="l00027"></a>00027 <span class="comment"> CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
<a name="l00028"></a>00028 <span class="comment"> ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span>
<a name="l00029"></a>00029 <span class="comment"> POSSIBILITY OF SUCH DAMAGE. */</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">/* $Id$ */</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">/*</span>
<a name="l00034"></a>00034 <span class="comment"> * This file is included by <avr/io.h> whenever compiling for an Xmega</span>
<a name="l00035"></a>00035 <span class="comment"> * device. It abstracts certain features common to the Xmega device</span>
<a name="l00036"></a>00036 <span class="comment"> * families.</span>
<a name="l00037"></a>00037 <span class="comment"> */</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#ifndef _AVR_XMEGA_H</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define _AVR_XMEGA_H</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="preprocessor">#ifdef __DOXYGEN__</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00044"></a>00044 <span class="comment"> \def _PROTECTED_WRITE</span>
<a name="l00045"></a>00045 <span class="comment"> \ingroup avr_io</span>
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> Write value \c value to IO register \c reg that is protected through</span>
<a name="l00048"></a>00048 <span class="comment"> the Xmega configuration change protection (CCP) mechanism. This</span>
<a name="l00049"></a>00049 <span class="comment"> implements the timed sequence that is required for CCP.</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> Example to modify the CPU clock:</span>
<a name="l00052"></a>00052 <span class="comment"> \code</span>
<a name="l00053"></a>00053 <span class="comment"> #include <avr/io.h></span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> _PROTECTED_WRITE(CLK_PSCTRL, CLK_PSADIV0_bm);</span>
<a name="l00056"></a>00056 <span class="comment"> _PROTECTED_WRITE(CLK_CTRL, CLK_SCLKSEL0_bm);</span>
<a name="l00057"></a>00057 <span class="comment"> \endcode</span>
<a name="l00058"></a>00058 <span class="comment"> */</span>
<a name="l00059"></a><a class="code" href="group__avr__io.html#gaaaa396e67cc85f68fa0474d70edf3d4c">00059</a> <span class="preprocessor">#define _PROTECTED_WRITE(reg, value)</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">/**</span>
<a name="l00062"></a>00062 <span class="comment"> \def _PROTECTED_WRITE_SPM</span>
<a name="l00063"></a>00063 <span class="comment"> \ingroup avr_io</span>
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> Write value \c value to register \c reg that is protected through</span>
<a name="l00066"></a>00066 <span class="comment"> the Xmega configuration change protection (CCP) key for self</span>
<a name="l00067"></a>00067 <span class="comment"> programming (SPM). This implements the timed sequence that is</span>
<a name="l00068"></a>00068 <span class="comment"> required for CCP.</span>
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> Example to modify the CPU clock:</span>
<a name="l00071"></a>00071 <span class="comment"> \code</span>
<a name="l00072"></a>00072 <span class="comment"> #include <avr/io.h></span>
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> _PROTECTED_WRITE_SPM(NVMCTRL_CTRLA, NVMCTRL_CMD_PAGEERASEWRITE_gc);</span>
<a name="l00075"></a>00075 <span class="comment"> \endcode</span>
<a name="l00076"></a>00076 <span class="comment"> */</span>
<a name="l00077"></a><a class="code" href="group__avr__io.html#gaa908245395513b1c44d76b8feab3c4a4">00077</a> <span class="preprocessor">#define _PROTECTED_WRITE_SPM(reg, value)</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span>
<a name="l00079"></a>00079 <span class="preprocessor">#else </span><span class="comment">/* !__DOXYGEN__ */</span>
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="preprocessor">#define _PROTECTED_WRITE(reg, value) \</span>
<a name="l00082"></a>00082 <span class="preprocessor"> __asm__ __volatile__("out %[ccp], %[ccp_ioreg]" "\n\t" \</span>
<a name="l00083"></a>00083 <span class="preprocessor"> "sts %[ioreg], %[val]" \</span>
<a name="l00084"></a>00084 <span class="preprocessor"> : \</span>
<a name="l00085"></a>00085 <span class="preprocessor"> : [ccp] "I" (_SFR_IO_ADDR(CCP)), \</span>
<a name="l00086"></a>00086 <span class="preprocessor"> [ccp_ioreg] "d" ((uint8_t)CCP_IOREG_gc), \</span>
<a name="l00087"></a>00087 <span class="preprocessor"> [ioreg] "n" (_SFR_MEM_ADDR(reg)), \</span>
<a name="l00088"></a>00088 <span class="preprocessor"> [val] "r" ((uint8_t)value))</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span>
<a name="l00090"></a>00090 <span class="preprocessor">#define _PROTECTED_WRITE_SPM(reg, value) \</span>
<a name="l00091"></a>00091 <span class="preprocessor"> __asm__ __volatile__("out %[ccp], %[ccp_spm_mask]" "\n\t" \</span>
<a name="l00092"></a>00092 <span class="preprocessor"> "sts %[ioreg], %[val]" \</span>
<a name="l00093"></a>00093 <span class="preprocessor"> : \</span>
<a name="l00094"></a>00094 <span class="preprocessor"> : [ccp] "I" (_SFR_IO_ADDR(CCP)), \</span>
<a name="l00095"></a>00095 <span class="preprocessor"> [ccp_spm_mask] "d" ((uint8_t)CCP_SPM_gc), \</span>
<a name="l00096"></a>00096 <span class="preprocessor"> [ioreg] "n" (_SFR_MEM_ADDR(reg)), \</span>
<a name="l00097"></a>00097 <span class="preprocessor"> [val] "r" ((uint8_t)value))</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span>
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="preprocessor">#endif </span><span class="comment">/* _AVR_XMEGA_H */</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<!-- HTML footer for doxygen 1.8.7-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> 1.6.3 </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> 1.6.3
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>