SAMV71 Xplained Ultra Software Package 1.5

rtt.h

Go to the documentation of this file.
00001 /* ---------------------------------------------------------------------------- */
00002 /*                  Atmel Microcontroller Software Support                      */
00003 /*                       SAM Software Package License                           */
00004 /* ---------------------------------------------------------------------------- */
00005 /* Copyright (c) 2015, Atmel Corporation                                        */
00006 /*                                                                              */
00007 /* All rights reserved.                                                         */
00008 /*                                                                              */
00009 /* Redistribution and use in source and binary forms, with or without           */
00010 /* modification, are permitted provided that the following condition is met:    */
00011 /*                                                                              */
00012 /* - Redistributions of source code must retain the above copyright notice,     */
00013 /* this list of conditions and the disclaimer below.                            */
00014 /*                                                                              */
00015 /* Atmel's name may not be used to endorse or promote products derived from     */
00016 /* this software without specific prior written permission.                     */
00017 /*                                                                              */
00018 /* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
00019 /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
00020 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
00021 /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
00022 /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
00023 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
00024 /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
00025 /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
00026 /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
00027 /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
00028 /* ---------------------------------------------------------------------------- */
00029 
00030 /**
00031  * \file
00032  *
00033  * \par Purpose
00034  *
00035  * Interface for Real Time Timer (RTT) controller.
00036  *
00037  * \par Usage
00038  *
00039  * -# Changes the prescaler value of the given RTT and restarts it
00040  *    using \ref RTT_SetPrescaler().
00041  * -# Get current value of the RTT using \ref RTT_GetTime().
00042  * -# Enables the specified RTT interrupt using \ref RTT_EnableIT().
00043  * -# Get the status register value of the given RTT using \ref RTT_GetStatus().
00044  * -# Configures the RTT to generate an alarm at the given time
00045  *    using \ref RTT_SetAlarm().
00046  */
00047 
00048 #ifndef _RTT_
00049 #define _RTT_
00050 
00051 /*----------------------------------------------------------------------------
00052  *        Headers
00053  *----------------------------------------------------------------------------*/
00054 
00055 #include "chip.h"
00056 
00057 #include <stdint.h>
00058 
00059 /*----------------------------------------------------------------------------
00060  *        Exported functions
00061  *----------------------------------------------------------------------------*/
00062 
00063 #ifdef __cplusplus
00064 extern "C" {
00065 #endif
00066 
00067 extern void RTT_SetPrescaler(Rtt *pRtt, uint16_t wPrescaler);
00068 
00069 extern uint32_t RTT_GetTime(Rtt *pRtt);
00070 
00071 extern void RTT_EnableIT(Rtt *pRtt, uint32_t dwSources);
00072 
00073 extern uint32_t RTT_GetStatus(Rtt *pRtt);
00074 
00075 extern void RTT_SetAlarm(Rtt *pRtt, uint32_t dwTime);
00076 
00077 #ifdef __cplusplus
00078 }
00079 #endif
00080 
00081 #endif /* #ifndef RTT_H */
00082 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines