SAMV71 Xplained Ultra Software Package 1.5

timetick.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  *  Methods and definitions for Global time tick and wait functions.
00036  *
00037  *  Defines a common and simplest use of Time Tick, to increase tickCount
00038  *  every 1ms, the application can get this value through GetTickCount().
00039  *
00040  *  \par Usage
00041  *
00042  *  -# Configure the System Tick with TimeTick_Configure() when MCK changed
00043  *     \note
00044  *     Must be done before any invoke of GetTickCount(), Wait() or Sleep().
00045  *  -# Uses GetTickCount to get current tick value.
00046  *  -# Uses Wait to wait several ms.
00047  *  -# Uses Sleep to enter wait for interrupt mode to wait several ms.
00048  *
00049  */
00050 
00051 #ifndef _TIMETICK_
00052 #define _TIMETICK_
00053 
00054 /*----------------------------------------------------------------------------
00055  *         Headers
00056  *----------------------------------------------------------------------------*/
00057 
00058 #include <stdint.h>
00059 
00060 /*----------------------------------------------------------------------------
00061  *         Definitions
00062  *----------------------------------------------------------------------------*/
00063 
00064 typedef struct {
00065     volatile uint32_t *pTimer1;
00066     volatile uint32_t *pTimer2;
00067     volatile uint32_t *pTimer3;
00068     volatile uint32_t *pTimer4;
00069 } SyTickDelayCounter_t;
00070 
00071 /*----------------------------------------------------------------------------
00072  *         Definitions
00073  *----------------------------------------------------------------------------*/
00074 typedef struct _TimeEvent {
00075     uint32_t event;
00076     uint32_t time_tick;
00077     uint32_t time_start;
00078     uint32_t occur;
00079     struct  _TimeEvent *pPreEvent;
00080     struct  _TimeEvent *pNextEvent;
00081 } TimeEvent;
00082 
00083 /*----------------------------------------------------------------------------
00084  *         Global functions
00085  *----------------------------------------------------------------------------*/
00086 
00087 uint32_t TimeTick_Configure(void);
00088 
00089 void TimeTick_Increment(uint32_t dwInc);
00090 
00091 uint32_t GetDelayInTicks(uint32_t startTick, uint32_t endTick);
00092 
00093 uint32_t GetTicks(void);
00094 
00095 void Wait(volatile uint32_t dwMs);
00096 
00097 void Sleep(volatile uint32_t dwMs);
00098 
00099 extern void SetTimeEvent(TimeEvent *pEvent);
00100 
00101 #endif /* _TIMETICK_ */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines