SAMV71 Xplained Ultra Software Package 1.4

timetick.h

Go to the documentation of this file.
00001 /* ----------------------------------------------------------------------------
00002  *         SAM Software Package License 
00003  * ----------------------------------------------------------------------------
00004  * Copyright (c) 2011, Atmel Corporation
00005  *
00006  * All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *
00011  * - Redistributions of source code must retain the above copyright notice,
00012  * this list of conditions and the disclaimer below.
00013  *
00014  * Atmel's name may not be used to endorse or promote products derived from
00015  * this software without specific prior written permission.
00016  *
00017  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
00020  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00022  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00023  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00024  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  * ----------------------------------------------------------------------------
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 {
00066     volatile uint32_t *pTimer1;
00067     volatile uint32_t *pTimer2;
00068     volatile uint32_t *pTimer3;
00069     volatile uint32_t *pTimer4;
00070 }SyTickDelayCounter_t;
00071 
00072 /*----------------------------------------------------------------------------
00073  *         Definitions
00074  *----------------------------------------------------------------------------*/
00075 typedef struct _TimeEvent
00076 {
00077     uint32_t event;
00078     uint32_t time_tick;
00079     uint32_t time_start;
00080     uint32_t occur;
00081     struct  _TimeEvent *pPreEvent;
00082     struct  _TimeEvent *pNextEvent;
00083 }TimeEvent;
00084 
00085 /*----------------------------------------------------------------------------
00086  *         Global functions
00087  *----------------------------------------------------------------------------*/
00088 
00089 uint32_t TimeTick_Configure( void ) ;
00090 
00091 void TimeTick_Increment( uint32_t dwInc ) ;
00092 
00093 uint32_t GetDelayInTicks(uint32_t startTick,uint32_t endTick);
00094 
00095 uint32_t GetTicks(void);
00096 
00097 void Wait( volatile uint32_t dwMs ) ;
00098 
00099 void Sleep( volatile uint32_t dwMs ) ;
00100 
00101 extern void SetTimeEvent(TimeEvent* pEvent);
00102 
00103 #endif /* _TIMETICK_ */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines