Diff: timer1.h

Revision:

0:98fcd1266df0

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/timer1.h	Thu Nov 14 14:36:52 2019 +0000
@@ -0,0 +1,128 @@
+/******************************************************************************
+  * @attention
+  *
+  * <h2><center>&copy; COPYRIGHT 2016 STMicroelectronics</center></h2>
+  *
+  * Licensed under ST MYLIBERTY SOFTWARE LICENSE AGREEMENT (the "License");
+  * You may not use this file except in compliance with the License.
+  * You may obtain a copy of the License at:
+  *
+  *        http://www.st.com/myliberty
+  *
+  * Unless required by applicable law or agreed to in writing, software
+  * distributed under the License is distributed on an "AS IS" BASIS,
+  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+  * AND SPECIFICALLY DISCLAIMING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+  * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+  * See the License for the specific language governing permissions and
+  * limitations under the License.
+  *
+******************************************************************************/
+/*
+ *      PROJECT:   ST25R391x firmware
+ *      $Revision: $
+ *      LANGUAGE:  ANSI C
+ */
+
+/*! \file timer.h
+ *
+ *  \brief SW Timer implementation header file
+ *
+ *   This module makes use of a System Tick in millisconds and provides
+ *   an abstraction for SW timers
+ *
+ */
+
+
+ /*
+******************************************************************************
+* INCLUDES
+******************************************************************************
+*/
+#include "platform1.h"
+
+/*
+******************************************************************************
+* GLOBAL MACROS
+******************************************************************************
+*/
+#define timerIsRunning(t)            (!timerIsExpired(t))
+
+/*
+******************************************************************************
+* GLOBAL DEFINES
+******************************************************************************
+*/
+
+ /*!
+ *****************************************************************************
+ * \brief  Calculate Timer
+ *
+ * This method calculates when the timer will be expired given the amount
+ * time in milliseconds /a tOut.
+ * Once the timer has been calculated it will then be used to check when
+ * it expires.
+ *
+ * \see timersIsExpired
+ *
+ * \param[in]  time : time/duration in Milliseconds for the timer
+ *
+ * \return u32 : The new timer calculated based on the given time
+ *****************************************************************************
+ */
+uint32_t timerCalculateTimer( uint16_t time );
+
+
+/*!
+ *****************************************************************************
+ * \brief  Checks if a Timer is Expired
+ *
+ * This method checks if a timer has already expired.
+ * Based on the given timer previously calculated it checks if this timer
+ * has already elapsed
+ *
+ * \see timersCalculateTimer
+ *
+ * \param[in]  timer : the timer to check
+ *
+ * \return true  : timer has already expired
+ * \return false : timer is still running
+ *****************************************************************************
+ */
+bool timerIsExpired( uint32_t timer );
+
+
+ /*!
+ *****************************************************************************
+ * \brief  Performs a Delay
+ *
+ * This method performs a delay for the given amount of time in Milliseconds
+ *
+ * \param[in]  time : time/duration in Milliseconds of the delay
+ *
+ *****************************************************************************
+ */
+void timerDelay( uint16_t time );
+
+
+/*!
+ *****************************************************************************
+ * \brief  Stopwatch start
+ *
+ * This method initiates the stopwatch to later measure the time in ms
+ *
+ *****************************************************************************
+ */
+void timerStopwatchStart( void );
+
+
+/*!
+ *****************************************************************************
+ * \brief  Stopwatch Measure
+ *
+ * This method returns the elapsed time in ms since the stopwatch was initiated
+ *
+ * \return The time in ms since the stopwatch was started
+ *****************************************************************************
+ */
+uint32_t timerStopwatchMeasure( void );