Benedict Tizzano / LoRaWAN-NAMote72-Application-Demo-good

mQ Branch for NA mote testing

Dependencies:   LoRaWAN-lib SX1272Lib-mQ lib_gps lib_mma8451q lib_mpl3115a2 mbed

Fork of LoRaWAN-NAMote72-Application-Demo by Semtech

system/timer.h@0:69f2e28d12c1, 2016-05-17 (annotated)

Committer:
ubhat
Date:
Tue May 17 00:21:55 2016 +0000
Revision:
0:69f2e28d12c1
Project for LoRa Bootcamp

Who changed what in which revision?

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