git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained_IAR_Keil/libchip_samv7/include/timetick.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  *  Methods and definitions for Global time tick and wait functions.\r
  36  *\r
  37  *  Defines a common and simpliest use of Time Tick, to increase tickCount\r
  38  *  every 1ms, the application can get this value through GetTickCount().\r
  39  *\r
  40  *  \par Usage\r
  41  *\r
  42  *  -# Configure the System Tick with TimeTick_Configure() when MCK changed\r
  43  *     \note\r
  44  *     Must be done before any invoke of GetTickCount(), Wait() or Sleep().\r
  45  *  -# Uses GetTickCount to get current tick value.\r
  46  *  -# Uses Wait to wait several ms.\r
  47  *  -# Uses Sleep to enter wait for interrupt mode to wait several ms.\r
  48  *\r
  49  */\r
  50 \r
  51 #ifndef _TIMETICK_\r
  52 #define _TIMETICK_\r
  53 \r
  54 /*----------------------------------------------------------------------------\r
  55  *         Headers\r
  56  *----------------------------------------------------------------------------*/\r
  57 \r
  58 #include <stdint.h>\r
  59 \r
  60 /*----------------------------------------------------------------------------\r
  61  *         Definitions\r
  62  *----------------------------------------------------------------------------*/\r
  63 \r
  64 /*----------------------------------------------------------------------------\r
  65  *         Global functions\r
  66  *----------------------------------------------------------------------------*/\r
  67 \r
  68 extern uint32_t TimeTick_Configure( uint32_t dwNew_MCK ) ;\r
  69 \r
  70 extern void TimeTick_Increment( uint32_t dwInc ) ;\r
  71 \r
  72 extern uint32_t GetDelayInTicks(uint32_t startTick,uint32_t endTick);\r
  73 \r
  74 extern uint32_t GetTickCount( void ) ;\r
  75 \r
  76 extern void Wait( volatile uint32_t dwMs ) ;\r
  77 \r
  78 extern void Sleep( volatile uint32_t dwMs ) ;\r
  79 \r
  80 #endif /* _TIMETICK_ */\r