Steve Karg
121 lines
3.6 KiB
C
121 lines
3.6 KiB
C
/**
|
|
* \file
|
|
*
|
|
* \brief Configuration Change Protection write functions
|
|
*
|
|
* Copyright (c) 2010-2012 Atmel Corporation. All rights reserved.
|
|
*
|
|
* \asf_license_start
|
|
*
|
|
* \page License
|
|
*
|
|
* 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 microcontroller 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.
|
|
*
|
|
* \asf_license_stop
|
|
*
|
|
*/
|
|
#ifndef CPU_CCP_H
|
|
#define CPU_CCP_H
|
|
#include <compiler.h>
|
|
|
|
/**
|
|
* \defgroup ccp_group Configuration Change Protection
|
|
*
|
|
* See \ref xmega_ccp_quickstart.
|
|
*
|
|
* Function for writing to protected IO registers.
|
|
* @{
|
|
*/
|
|
|
|
#if defined(__DOXYGEN__)
|
|
//! \name IAR Memory Model defines.
|
|
//@{
|
|
|
|
/**
|
|
* \def CONFIG_MEMORY_MODEL_TINY
|
|
* \brief Configuration symbol to enable 8 bit pointers.
|
|
*
|
|
*/
|
|
# define CONFIG_MEMORY_MODEL_TINY
|
|
|
|
/**
|
|
* \def CONFIG_MEMORY_MODEL_SMALL
|
|
* \brief Configuration symbol to enable 16 bit pointers.
|
|
* \note If no memory model is defined, SMALL is default.
|
|
*
|
|
*/
|
|
# define CONFIG_MEMORY_MODEL_SMALL
|
|
|
|
|
|
/**
|
|
* \def CONFIG_MEMORY_MODEL_LARGE
|
|
* \brief Configuration symbol to enable 24 bit pointers.
|
|
*
|
|
*/
|
|
# define CONFIG_MEMORY_MODEL_LARGE
|
|
|
|
//@}
|
|
#endif
|
|
|
|
|
|
/**
|
|
* \brief Write to a CCP-protected 8-bit I/O register
|
|
*
|
|
* \param addr Address of the I/O register
|
|
* \param value Value to be written
|
|
*
|
|
* \note Using IAR Embedded workbench, the choice of memory model has an impact
|
|
* on calling convention. The memory model is not visible to the
|
|
* preprocessor, so it must be defined in the Assembler preprocessor directives.
|
|
*/
|
|
extern void ccp_write_io (void *addr, uint8_t value);
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* \page xmega_ccp_quickstart Quick start guide for CCP driver
|
|
*
|
|
* This is the quick start guide for the \ref ccp_group
|
|
* "Configuration Change Protection (CCP) driver", with step-by-step
|
|
* instructions on how to use the driver.
|
|
*
|
|
* The use case contains a code fragment, and this can be copied into, e.g.,
|
|
* the main application function.
|
|
*
|
|
* \section ccp_basic_use_case Basic use case
|
|
* In this use case, the CCP is used to write to the protected XMEGA Clock
|
|
* Control register.
|
|
*
|
|
* \subsection ccp_basic_use_case_setup_flow Workflow
|
|
* -# call CCP write io to change system clock selection:
|
|
* - \code ccp_write_io((uint8_t *)&CLK.CTRL, CLK_SCLKSEL_RC32M_gc); \endcode
|
|
*/
|
|
|
|
#endif /* CPU_CCP_H */
|