Campbell Scientific Australia / Mbed 2 deprecated mDot_Semtech_LoRaWAN_Stack

This code uses Semtech's open source LoRaWAN stack ported to mbed environment.

Dependencies:   mbed LoRaWAN-lib SX1272Lib

system/timer.h@1:7da3f0db0d82, 2016-06-10 (annotated)

Committer:
Mehrad
Date:
Fri Jun 10 00:01:00 2016 +0000
Revision:
1:7da3f0db0d82
Parent:
0:6155544d38b1 
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mehrad 0:6155544d38b1 1 /*
Mehrad 0:6155544d38b1 2 / _____) _ | |
Mehrad 0:6155544d38b1 3 ( (____ _____ ____ _| |_ _____ ____| |__
Mehrad 0:6155544d38b1 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
Mehrad 0:6155544d38b1 5 _____) ) ____| | | || |_| ____( (___| | | |
Mehrad 0:6155544d38b1 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
Mehrad 0:6155544d38b1 7 (C)2013 Semtech
Mehrad 0:6155544d38b1 8
Mehrad 0:6155544d38b1 9 Description: Timer objects and scheduling management
Mehrad 0:6155544d38b1 10
Mehrad 0:6155544d38b1 11 License: Revised BSD License, see LICENSE.TXT file include in the project
Mehrad 0:6155544d38b1 12
Mehrad 0:6155544d38b1 13 Maintainer: Miguel Luis and Gregory Cristian
Mehrad 0:6155544d38b1 14 */
Mehrad 0:6155544d38b1 15 #ifndef __TIMER_H__
Mehrad 0:6155544d38b1 16 #define __TIMER_H__
Mehrad 0:6155544d38b1 17
Mehrad 0:6155544d38b1 18 #include "mbed.h"
Mehrad 0:6155544d38b1 19
Mehrad 0:6155544d38b1 20 /*!
Mehrad 0:6155544d38b1 21 * \brief Timer object description
Mehrad 0:6155544d38b1 22 */
Mehrad 0:6155544d38b1 23 typedef struct TimerEvent_s
Mehrad 0:6155544d38b1 24 {
Mehrad 0:6155544d38b1 25 uint32_t value;
Mehrad 0:6155544d38b1 26 void ( *Callback )( void );
Mehrad 0:6155544d38b1 27 Ticker Timer;
Mehrad 0:6155544d38b1 28 }TimerEvent_t;
Mehrad 0:6155544d38b1 29
Mehrad 0:6155544d38b1 30 /*!
Mehrad 0:6155544d38b1 31 * \brief Timer time variable definition
Mehrad 0:6155544d38b1 32 */
Mehrad 0:6155544d38b1 33 #ifndef TimerTime_t
Mehrad 0:6155544d38b1 34 typedef uint32_t TimerTime_t;
Mehrad 0:6155544d38b1 35 #endif
Mehrad 0:6155544d38b1 36
Mehrad 0:6155544d38b1 37 /*!
Mehrad 0:6155544d38b1 38 * \brief Inializes the timer used to get current time.
Mehrad 0:6155544d38b1 39 *
Mehrad 0:6155544d38b1 40 * \remark Current time corresponds to the time since system startup
Mehrad 0:6155544d38b1 41 */
Mehrad 0:6155544d38b1 42 void TimerTimeCounterInit( void );
Mehrad 0:6155544d38b1 43
Mehrad 0:6155544d38b1 44 /*!
Mehrad 0:6155544d38b1 45 * \brief Initializes the timer object
Mehrad 0:6155544d38b1 46 *
Mehrad 0:6155544d38b1 47 * \remark TimerSetValue function must be called before starting the timer.
Mehrad 0:6155544d38b1 48 * this function initializes timestamp and reload value at 0.
Mehrad 0:6155544d38b1 49 *
Mehrad 0:6155544d38b1 50 * \param [IN] obj Structure containing the timer object parameters
Mehrad 0:6155544d38b1 51 * \param [IN] callback Function callback called at the end of the timeout
Mehrad 0:6155544d38b1 52 */
Mehrad 0:6155544d38b1 53 void TimerInit( TimerEvent_t *obj, void ( *callback )( void ) );
Mehrad 0:6155544d38b1 54
Mehrad 0:6155544d38b1 55 /*!
Mehrad 0:6155544d38b1 56 * \brief Starts and adds the timer object to the list of timer events
Mehrad 0:6155544d38b1 57 *
Mehrad 0:6155544d38b1 58 * \param [IN] obj Structure containing the timer object parameters
Mehrad 0:6155544d38b1 59 */
Mehrad 0:6155544d38b1 60 void TimerStart( TimerEvent_t *obj );
Mehrad 0:6155544d38b1 61
Mehrad 0:6155544d38b1 62 /*!
Mehrad 0:6155544d38b1 63 * \brief Stops and removes the timer object from the list of timer events
Mehrad 0:6155544d38b1 64 *
Mehrad 0:6155544d38b1 65 * \param [IN] obj Structure containing the timer object parameters
Mehrad 0:6155544d38b1 66 */
Mehrad 0:6155544d38b1 67 void TimerStop( TimerEvent_t *obj );
Mehrad 0:6155544d38b1 68
Mehrad 0:6155544d38b1 69 /*!
Mehrad 0:6155544d38b1 70 * \brief Resets the timer object
Mehrad 0:6155544d38b1 71 *
Mehrad 0:6155544d38b1 72 * \param [IN] obj Structure containing the timer object parameters
Mehrad 0:6155544d38b1 73 */
Mehrad 0:6155544d38b1 74 void TimerReset( TimerEvent_t *obj );
Mehrad 0:6155544d38b1 75
Mehrad 0:6155544d38b1 76 /*!
Mehrad 0:6155544d38b1 77 * \brief Set timer new timeout value
Mehrad 0:6155544d38b1 78 *
Mehrad 0:6155544d38b1 79 * \param [IN] obj Structure containing the timer object parameters
Mehrad 0:6155544d38b1 80 * \param [IN] value New timer timeout value
Mehrad 0:6155544d38b1 81 */
Mehrad 0:6155544d38b1 82 void TimerSetValue( TimerEvent_t *obj, uint32_t value );
Mehrad 0:6155544d38b1 83
Mehrad 0:6155544d38b1 84 /*!
Mehrad 0:6155544d38b1 85 * \brief Read the current time
Mehrad 0:6155544d38b1 86 *
Mehrad 0:6155544d38b1 87 * \retval time returns current time
Mehrad 0:6155544d38b1 88 */
Mehrad 0:6155544d38b1 89 TimerTime_t TimerGetCurrentTime( void );
Mehrad 0:6155544d38b1 90
Mehrad 0:6155544d38b1 91 /*!
Mehrad 0:6155544d38b1 92 * \brief Return the Time elapsed since a fix moment in Time
Mehrad 0:6155544d38b1 93 *
Mehrad 0:6155544d38b1 94 * \param [IN] savedTime fix moment in Time
Mehrad 0:6155544d38b1 95 * \retval time returns elapsed time
Mehrad 0:6155544d38b1 96 */
Mehrad 0:6155544d38b1 97 TimerTime_t TimerGetElapsedTime( TimerTime_t savedTime );
Mehrad 0:6155544d38b1 98
Mehrad 0:6155544d38b1 99 /*!
Mehrad 0:6155544d38b1 100 * \brief Return the Time elapsed since a fix moment in Time
Mehrad 0:6155544d38b1 101 *
Mehrad 0:6155544d38b1 102 * \param [IN] eventInFuture fix moment in the future
Mehrad 0:6155544d38b1 103 * \retval time returns difference between now and future event
Mehrad 0:6155544d38b1 104 */
Mehrad 0:6155544d38b1 105 TimerTime_t TimerGetFutureTime( TimerTime_t eventInFuture );
Mehrad 0:6155544d38b1 106
Mehrad 0:6155544d38b1 107 #endif // __TIMER_H__