SAMV71 Xplained Ultra Software Package 1.4

wdt.h

Go to the documentation of this file.
00001 /* ----------------------------------------------------------------------------
00002  *         SAM Software Package License
00003  * ----------------------------------------------------------------------------
00004  * Copyright (c) 2012, Atmel Corporation
00005  *
00006  * All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *
00011  * - Redistributions of source code must retain the above copyright notice,
00012  * this list of conditions and the disclaimer below.
00013  *
00014  * Atmel's name may not be used to endorse or promote products derived from
00015  * this software without specific prior written permission.
00016  *
00017  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
00020  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00022  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00023  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00024  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  * ----------------------------------------------------------------------------
00028  */
00029 
00030 /**
00031  * \file
00032  *
00033  * \section Purpose
00034  * Interface for Watchdog Timer (WDT) controller.
00035  *
00036  * \section Usage
00037  * -# Enable watchdog with given mode using \ref WDT_Enable().
00038  * -# Disable watchdog using \ref WDT_Disable()
00039  * -# Restart the watchdog using \ref WDT_Restart().
00040  * -# Get watchdog status using \ref  WDT_GetStatus().
00041  * -# Calculate watchdog period value using \ref WDT_GetPeriod().
00042  */
00043 
00044 #ifndef _WDT_
00045 #define _WDT_
00046 
00047 #include "chip.h"
00048 
00049 #include <stdint.h>
00050 
00051 #ifdef __cplusplus
00052  extern "C" {
00053 #endif
00054 
00055 /*----------------------------------------------------------------------------
00056  *        Exported functions
00057  *----------------------------------------------------------------------------*/
00058 
00059 extern void WDT_Enable( Wdt* pWDT, uint32_t dwMode ) ;
00060 
00061 extern void WDT_Disable( Wdt* pWDT ) ;
00062 
00063 extern void WDT_Restart( Wdt* pWDT ) ;
00064 
00065 extern uint32_t WDT_GetStatus( Wdt* pWDT ) ;
00066 
00067 extern uint32_t WDT_GetPeriod( uint32_t dwMs ) ;
00068 
00069 #ifdef __cplusplus
00070 }
00071 #endif
00072 
00073 #endif /* #ifndef _WDT_ */
00074 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines