libchip/include/rtt.h

0001 /* ---------------------------------------------------------------------------- */
0002 /*                  Atmel Microcontroller Software Support                      */
0003 /*                       SAM Software Package License                           */
0004 /* ---------------------------------------------------------------------------- */
0005 /* Copyright (c) 2015, Atmel Corporation                                        */
0006 /*                                                                              */
0007 /* All rights reserved.                                                         */
0008 /*                                                                              */
0009 /* Redistribution and use in source and binary forms, with or without           */
0010 /* modification, are permitted provided that the following condition is met:    */
0011 /*                                                                              */
0012 /* - Redistributions of source code must retain the above copyright notice,     */
0013 /* this list of conditions and the disclaimer below.                            */
0014 /*                                                                              */
0015 /* Atmel's name may not be used to endorse or promote products derived from     */
0016 /* this software without specific prior written permission.                     */
0017 /*                                                                              */
0018 /* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
0019 /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
0020 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
0021 /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
0022 /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
0023 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
0024 /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
0025 /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
0026 /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
0027 /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
0028 /* ---------------------------------------------------------------------------- */
0029
0030 /**
0031  * \file
0032  *
0033  * \par Purpose
0034  *
0035  * Interface for Real Time Timer (RTT) controller.
0036  *
0037  * \par Usage
0038  *
0039  * -# Changes the prescaler value of the given RTT and restarts it
0040  *    using \ref RTT_SetPrescaler().
0041  * -# Get current value of the RTT using \ref RTT_GetTime().
0042  * -# Enables the specified RTT interrupt using \ref RTT_EnableIT().
0043  * -# Get the status register value of the given RTT using \ref RTT_GetStatus().
0044  * -# Configures the RTT to generate an alarm at the given time
0045  *    using \ref RTT_SetAlarm().
0046  */
0047
0048 #ifndef _RTT_
0049 #define _RTT_
0050
0051 /*----------------------------------------------------------------------------
0052  *        Headers
0053  *----------------------------------------------------------------------------*/
0054
0055 #include "chip.h"
0056
0057 #include <stdint.h>
0058
0059 /*----------------------------------------------------------------------------
0060  *        Exported functions
0061  *----------------------------------------------------------------------------*/
0062
0063 #ifdef __cplusplus
0064 extern "C" {
0065 #endif
0066
0067 extern void RTT_SetPrescaler(Rtt *pRtt, uint16_t wPrescaler);
0068
0069 extern uint32_t RTT_GetTime(Rtt *pRtt);
0070
0071 extern void RTT_EnableIT(Rtt *pRtt, uint32_t dwSources);
0072
0073 extern uint32_t RTT_GetStatus(Rtt *pRtt);
0074
0075 extern void RTT_SetAlarm(Rtt *pRtt, uint32_t dwTime);
0076
0077 #ifdef __cplusplus
0078 }
0079 #endif
0080
0081 #endif /* #ifndef RTT_H */
0082