error_handler.h

Go to the documentation of this file.

/* This file has been prepared for Doxygen automatic documentation generation.*/
/**
 * \file
 *
 * \brief Macros and definitions for handling errors and other configurable actions. 
 *              
 * \par Application note:
 *      AVR1610: Guide to IEC60730 Class B compliance with XMEGA
 *
 * \par Documentation
 *      For comprehensive code documentation, supported compilers, compiler 
 *      settings and supported devices see readme.html
 *
 * \author
 *      Atmel Corporation: http://www.atmel.com \n
 *      Support email: avr@atmel.com
 * 
 * Copyright (C) 2012 Atmel Corporation. All rights reserved.
 *
 * \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 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 CLASSB_ERROR_HANDLER_H
#define CLASSB_ERROR_HANDLER_H

#include "avr_compiler.h"


//! \defgroup error_handler Error Handling
//! \brief Definitions related to error handling for Class B tests.
//! 
//! In order to make the library as flexible as possible, the user can configure 
//! the response to the different errors that can appear during the tests. Therefore, 
//! the user is responsible to handle the errors in a way such that the application
//! is safe and reliable.
//@{ 

//! \name Global variables defined in the main application. 
//@{
//! \brief The global error flag in the examples
NO_INIT extern volatile uint8_t classb_error;
//@}

//! \name Functions prototypes
//! \brief Declare functions that are called by the error handlers.
//! Those functions should be defined in an application file.
//@{

//@}

//! \name Error handlers for Class B tests. 
//! These are the statements that should be run if a test fails. 
//! \note The statements need to be declared as: 
//!  - <tt>do{<statements>}while(0)</tt> or similar.
//!  - Example: in order to hang the device it is possible to set <tt>do{}while(1)</tt>.
//! 
//@{
//! Error handler for the ADC, DAC and analog multiplexer test
#define CLASSB_ERROR_HANDLER_ANALOG() do{classb_error = 1;}while(0)
//! Error handler for the CRC test
#define CLASSB_ERROR_HANDLER_CRC() do{classb_error = 1;}while(0)
//! Error handler for the CPU frequency test
#define CLASSB_ERROR_HANDLER_FREQ() do{classb_error = 1;}while(0)
//! Error handler for the interrupt monitor 
#define CLASSB_ERROR_HANDLER_INTERRUPT() do{classb_error = 1;}while(0)
//! Error handler for the CPU registers test 
#define CLASSB_ERROR_HANDLER_REGISTERS() do{classb_error = 1;}while(0)
//! Error handler for the SRAM test     
#define CLASSB_ERROR_HANDLER_SRAM() do{classb_error = 1;}while(0)
//! Error handler for watchdog timer test       
#define CLASSB_ERROR_HANDLER_WDT() do{}while(1)
//@}

//! \name Configurable actions and conditions for Class B tests. 
//! Some test have a configurable behavior. 
//! \note 
//!  - The conditions should be declared as: <tt>(<condition>)</tt>. 
//!  - Statements need to be declared as: <tt>do{<statements>}while(0)</tt> or similar.
//!  - Example: in order to hang the device it is possible to set: <tt>do{}while(1)</tt>.
//@{


//! Condition to assign a new state
#define CLASSB_CONDITION1_INTERRUPT (!classb_error)

//! Condition to stop checking interrupts within the monitor
#define CLASSB_CONDITION2_INTERRUPT (classb_error) 


//! Configurable actions in the RTC interrupt.
#define CLASSB_ACTIONS_RTC() ;  

//! First group of configurable actions in the watchdog timer test.
#define CLASSB_ACTIONS_WDT_RUNTIME_FAILURE() \
                do{\
                        /* In our example application we set the error variable and \
                         re-enable watchdog timer.*/ \
                        classb_error = 1;\
                        /* WDT configuration for the main application: WDT in normal mode */\
                        CCP = CCP_IOREG_gc;\
                        WDT.CTRL =  WDT_ENABLE_bm | CLASSB_WDT_PER | WDT_CEN_bm ;\
                        /* Wait until WDT Synchronized */\
                        while( WDT.STATUS & WDT_SYNCBUSY_bm );\
                        /* Set Closed period (when WDT cannot be reset) */\
                        CCP = CCP_IOREG_gc;\
                        WDT.WINCTRL =  WDT_WEN_bm | CLASSB_WDT_WPER | WDT_WCEN_bm;\
                        /* Wait until WDT Synchronized */\
                        while( WDT.STATUS & WDT_SYNCBUSY_bm );\
                }while(0)

//! \brief Second group of configurable actions in the watchdog timer test.
#define CLASSB_ACTIONS_WDT_OTHER_FAILURE() do{}while(0)         
//@}


//@}

#endif //CLASSB_ERROR_HANDLER_H