Julio Merette / LoRaWAN-SX1276-MachineQ-FieldTest

1

Dependencies:   X_NUCLEO_IKS01A1 LoRaWAN-lib SX1276Lib mbed

system/timer.h@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
SX1276 Shield based Applications

Who changed what in which revision?

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