alt_reset_manager.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright 2013 Altera 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.
* 
* 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 COPYRIGHT HOLDER "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.
* 
******************************************************************************/

#ifndef __ALT_RESET_MGR_H__
#define __ALT_RESET_MGR_H__

#include "hwlib.h"
#include <stdbool.h>

#ifdef __cplusplus
extern "C"
{
#endif  /* __cplusplus */

/******************************************************************************/
/******************************************************************************/
typedef enum ALT_RESET_EVENT_e
{
    ALT_RESET_EVENT_PORVOLTRST          = 0x00000001,

    ALT_RESET_EVENT_NPORPINRST          = 0x00000002,

    ALT_RESET_EVENT_FPGACOLDRST         = 0x00000004,

    ALT_RESET_EVENT_CONFIGIOCOLDRST     = 0x00000008,

    ALT_RESET_EVENT_SWCOLDRST           = 0x00000010,

    ALT_RESET_EVENT_NRSTPINRST          = 0x00000100,

    ALT_RESET_EVENT_FPGAWARMRST         = 0x00000200,

    ALT_RESET_EVENT_SWWARMRST           = 0x00000400,

    ALT_RESET_EVENT_MPUWD0RST           = 0x00001000,

    ALT_RESET_EVENT_MPUWD1RST           = 0x00002000,

    ALT_RESET_EVENT_L4WD0RST            = 0x00004000,

    ALT_RESET_EVENT_L4WD1RST            = 0x00008000,

    ALT_RESET_EVENT_FPGADBGRST          = 0x00040000,

    ALT_RESET_EVENT_CDBGREQRST          = 0x00080000,

    ALT_RESET_EVENT_SDRSELFREFTIMEOUT   = 0x01000000,

    ALT_RESET_EVENT_FPGAMGRHSTIMEOUT    = 0x02000000,

    ALT_RESET_EVENT_SCANHSTIMEOUT       = 0x04000000,

    ALT_RESET_EVENT_FPGAHSTIMEOUT       = 0x08000000,

    ALT_RESET_EVENT_ETRSTALLTIMEOUT     = 0x10000000
} ALT_RESET_EVENT_t;

/******************************************************************************/
uint32_t alt_reset_event_get(void);

/******************************************************************************/
ALT_STATUS_CODE alt_reset_event_clear(uint32_t event_mask);

/******************************************************************************/
/******************************************************************************/
ALT_STATUS_CODE alt_reset_cold_reset(void);

/******************************************************************************/
ALT_STATUS_CODE alt_reset_warm_reset(uint32_t warm_reset_delay,
                                     uint32_t nRST_pin_clk_assertion,
                                     bool sdram_refresh,
                                     bool fpga_mgr_handshake,
                                     bool scan_mgr_handshake,
                                     bool fpga_handshake,
                                     bool etr_stall);

#if 0

#endif

#ifdef __cplusplus
}
#endif  /* __cplusplus */
#endif  /* __ALT_RESET_MGR_H__ */