Julio Merette / LoRaWAN-SX1272-Application-24-31-9sec

LoRaWAN-SX1272-Application-24-31-9sec

Dependencies:   X_NUCLEO_IKS01A1 driver_mbed_TH02 LoRaWAN-lib-v1_0_1 SX1272Lib mbed

Fork of LoRaWAN-SX1272-Application-24-31-9sec by Oleh Zvonarov

system/timer.h@8:89039f83e9fc, 2018-01-22 (annotated)

Committer:
emerette
Date:
Mon Jan 22 15:55:52 2018 +0000
Revision:
8:89039f83e9fc
Parent:
0:6cc76d70e2a1 
1-22-2018

Who changed what in which revision?

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