reset.h

Go to the documentation of this file.

#ifndef RESET_H_INCLUDED
#define RESET_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2013-2015, Jetro AS
 * 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 the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Reset cause primitive.
 *
 * @author DT, Jetro as
 */ /******************************************************************/

/**
 * This module provides functionality to set and get system reset cause
 */

/**
 * \defgroup reset Reset cause primitive
 * \ingroup abstract
 * \{
 */


/***********************************************************************
 * Global defines
 ***********************************************************************/

/**
 * Reset cause
 */
enum reset_cause_t
{
  RESET_CAUSE_UNKNOWN,            /**< Unknown reset cause, power-on reset */
  RESET_CAUSE_WATCHDOG,           /**< Watchdog reset */
  RESET_CAUSE_SOFT,               /**< Software reset */
  RESET_CAUSE_OFF_GPIO,           /**< Reset from system off by GPIO sense detect */
  RESET_CAUSE_OFF_LPCOMP,         /**< Reset from system off by LPCOMP */
  RESET_CAUSE_OFF_DEBUG,          /**< Reset from system off by debug interface */
  RESET_CAUSE_OFF_NFC,            /**< Reset from system off by NFC field sense */
  RESET_CAUSE__FIRST_USER,        /**< First user-defined software reset cause */
  /* ... */
  RESET_CAUSE__LAST_USER = 0xFF,  /**< Last user-defined software reset cause */
};


/**********************************************************************/
/**
 * @brief Name:     get_reset_cause\n
 * Returns reset cause for the last system reset.
 *
 * @return          Reset cause
 ***********************************************************************/
enum reset_cause_t get_reset_cause(void);

/**********************************************************************/
/**
 * @brief Name:     set_reset_cause\n
 * Sets (resets) reset cause.
 *
 * @param reset_cause Reset cause. Allowed values: RESET_CAUSE_UNKNOWN, [RESET_CAUSE__FIRST_USER..RESET_CAUSE__LAST_USER]
 ***********************************************************************/
void set_reset_cause(enum reset_cause_t reset_cause);

/** \} reset */

#endif /* RESET_H_INCLUDED */