git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained/libchip_samv7/include/rtt.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2011, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 /**\r
  31  * \file\r
  32  *\r
  33  * \par Purpose\r
  34  *\r
  35  * Interface for Real Time Timer (RTT) controller.\r
  36  *\r
  37  * \par Usage\r
  38  *\r
  39  * -# Changes the prescaler value of the given RTT and restarts it\r
  40  *    using \ref RTT_SetPrescaler().\r
  41  * -# Get current value of the RTT using \ref RTT_GetTime().\r
  42  * -# Enables the specified RTT interrupt using \ref RTT_EnableIT().\r
  43  * -# Get the status register value of the given RTT using \ref RTT_GetStatus().\r
  44  * -# Configures the RTT to generate an alarm at the given time\r
  45  *    using \ref RTT_SetAlarm().\r
  46  */\r
  47 \r
  48 #ifndef _RTT_\r
  49 #define _RTT_\r
  50 \r
  51 /*----------------------------------------------------------------------------\r
  52  *        Headers\r
  53  *----------------------------------------------------------------------------*/\r
  54 \r
  55 #include "chip.h"\r
  56 \r
  57 #include <stdint.h>\r
  58 \r
  59 /*----------------------------------------------------------------------------\r
  60  *        Exported functions\r
  61  *----------------------------------------------------------------------------*/\r
  62 \r
  63 #ifdef __cplusplus\r
  64  extern "C" {\r
  65 #endif\r
  66 \r
  67 extern void RTT_SetPrescaler( Rtt* pRtt, uint16_t wPrescaler ) ;\r
  68 \r
  69 extern uint32_t RTT_GetTime( Rtt* pRtt ) ;\r
  70 \r
  71 extern void RTT_EnableIT( Rtt* pRtt, uint32_t dwSources ) ;\r
  72 \r
  73 extern uint32_t RTT_GetStatus( Rtt *pRtt ) ;\r
  74 \r
  75 extern void RTT_SetAlarm( Rtt *pRtt, uint32_t dwTime ) ;\r
  76 \r
  77 #ifdef __cplusplus\r
  78 }\r
  79 #endif\r
  80 \r
  81 #endif /* #ifndef RTT_H */\r
  82 \r