Fahad Mirza / Mbed 2 deprecated Nucleo_HXC900

A demo application for HXC900 LoRaWAN module using Nucleo-L053R8.

Dependencies:   mbed

Utilities/time_server.h@32:2d0678039a09, 2019-01-24 (annotated)

Committer:
fahadmirza
Date:
Thu Jan 24 21:57:23 2019 +0000
Revision:
32:2d0678039a09
Parent:
5:53302861bfea 
Updated code;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
fahadmirza 0:a0c5877bd360 1 /*
fahadmirza 0:a0c5877bd360 2 / _____) _ | |
fahadmirza 0:a0c5877bd360 3 ( (____ _____ ____ _| |_ _____ ____| |__
fahadmirza 0:a0c5877bd360 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
fahadmirza 0:a0c5877bd360 5 _____) ) ____| | | || |_| ____( (___| | | |
fahadmirza 0:a0c5877bd360 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
fahadmirza 0:a0c5877bd360 7 (C)2013 Semtech
fahadmirza 0:a0c5877bd360 8
fahadmirza 0:a0c5877bd360 9 Description: Timer objects and scheduling management
fahadmirza 0:a0c5877bd360 10
fahadmirza 0:a0c5877bd360 11 License: Revised BSD License, see LICENSE.TXT file include in the project
fahadmirza 0:a0c5877bd360 12
fahadmirza 0:a0c5877bd360 13 Maintainer: Miguel Luis and Gregory Cristian
fahadmirza 0:a0c5877bd360 14 */
fahadmirza 0:a0c5877bd360 15 /******************************************************************************
fahadmirza 0:a0c5877bd360 16 * @file time_server.h
fahadmirza 0:a0c5877bd360 17 * @author MCD Application Team
fahadmirza 0:a0c5877bd360 18 * @version V1.1.4
fahadmirza 0:a0c5877bd360 19 * @date 08-January-2018
fahadmirza 0:a0c5877bd360 20 * @brief is the timer server driver
fahadmirza 0:a0c5877bd360 21 ******************************************************************************
fahadmirza 0:a0c5877bd360 22 * @attention
fahadmirza 0:a0c5877bd360 23 *
fahadmirza 0:a0c5877bd360 24 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics International N.V.
fahadmirza 0:a0c5877bd360 25 * All rights reserved.</center></h2>
fahadmirza 0:a0c5877bd360 26 *
fahadmirza 0:a0c5877bd360 27 * Redistribution and use in source and binary forms, with or without
fahadmirza 0:a0c5877bd360 28 * modification, are permitted, provided that the following conditions are met:
fahadmirza 0:a0c5877bd360 29 *
fahadmirza 0:a0c5877bd360 30 * 1. Redistribution of source code must retain the above copyright notice,
fahadmirza 0:a0c5877bd360 31 * this list of conditions and the following disclaimer.
fahadmirza 0:a0c5877bd360 32 * 2. Redistributions in binary form must reproduce the above copyright notice,
fahadmirza 0:a0c5877bd360 33 * this list of conditions and the following disclaimer in the documentation
fahadmirza 0:a0c5877bd360 34 * and/or other materials provided with the distribution.
fahadmirza 0:a0c5877bd360 35 * 3. Neither the name of STMicroelectronics nor the names of other
fahadmirza 0:a0c5877bd360 36 * contributors to this software may be used to endorse or promote products
fahadmirza 0:a0c5877bd360 37 * derived from this software without specific written permission.
fahadmirza 0:a0c5877bd360 38 * 4. This software, including modifications and/or derivative works of this
fahadmirza 0:a0c5877bd360 39 * software, must execute solely and exclusively on microcontroller or
fahadmirza 0:a0c5877bd360 40 * microprocessor devices manufactured by or for STMicroelectronics.
fahadmirza 0:a0c5877bd360 41 * 5. Redistribution and use of this software other than as permitted under
fahadmirza 0:a0c5877bd360 42 * this license is void and will automatically terminate your rights under
fahadmirza 0:a0c5877bd360 43 * this license.
fahadmirza 0:a0c5877bd360 44 *
fahadmirza 0:a0c5877bd360 45 * THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
fahadmirza 0:a0c5877bd360 46 * AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
fahadmirza 0:a0c5877bd360 47 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
fahadmirza 0:a0c5877bd360 48 * PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
fahadmirza 0:a0c5877bd360 49 * RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
fahadmirza 0:a0c5877bd360 50 * SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
fahadmirza 0:a0c5877bd360 51 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
fahadmirza 0:a0c5877bd360 52 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
fahadmirza 0:a0c5877bd360 53 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
fahadmirza 0:a0c5877bd360 54 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
fahadmirza 0:a0c5877bd360 55 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
fahadmirza 0:a0c5877bd360 56 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
fahadmirza 0:a0c5877bd360 57 *
fahadmirza 0:a0c5877bd360 58 ******************************************************************************
fahadmirza 0:a0c5877bd360 59 */
fahadmirza 0:a0c5877bd360 60
fahadmirza 0:a0c5877bd360 61 /* Define to prevent recursive inclusion -------------------------------------*/
fahadmirza 0:a0c5877bd360 62 #ifndef __TIME_SERVER_H__
fahadmirza 0:a0c5877bd360 63 #define __TIME_SERVER_H__
fahadmirza 0:a0c5877bd360 64
fahadmirza 0:a0c5877bd360 65 #ifdef __cplusplus
fahadmirza 0:a0c5877bd360 66 extern "C" {
fahadmirza 0:a0c5877bd360 67 #endif
fahadmirza 0:a0c5877bd360 68
fahadmirza 0:a0c5877bd360 69 /* Includes ------------------------------------------------------------------*/
fahadmirza 0:a0c5877bd360 70 #include <stdbool.h>
fahadmirza 0:a0c5877bd360 71
fahadmirza 0:a0c5877bd360 72 /* Exported types ------------------------------------------------------------*/
fahadmirza 0:a0c5877bd360 73
fahadmirza 0:a0c5877bd360 74 /*!
fahadmirza 0:a0c5877bd360 75 * \brief Timer object description
fahadmirza 0:a0c5877bd360 76 */
fahadmirza 0:a0c5877bd360 77 typedef struct TimerEvent_s
fahadmirza 0:a0c5877bd360 78 {
fahadmirza 0:a0c5877bd360 79 uint32_t Timestamp; //! Expiring timer value in ticks from TimerContext
fahadmirza 0:a0c5877bd360 80 uint32_t ReloadValue; //! Reload Value when Timer is restarted
fahadmirza 0:a0c5877bd360 81 bool IsRunning; //! Is the timer currently running
fahadmirza 0:a0c5877bd360 82 void ( *Callback )( void ); //! Timer IRQ callback function
fahadmirza 0:a0c5877bd360 83 struct TimerEvent_s *Next; //! Pointer to the next Timer object.
fahadmirza 0:a0c5877bd360 84 } TimerEvent_t;
fahadmirza 0:a0c5877bd360 85
fahadmirza 0:a0c5877bd360 86
fahadmirza 0:a0c5877bd360 87 /* Exported constants --------------------------------------------------------*/
fahadmirza 0:a0c5877bd360 88 /* External variables --------------------------------------------------------*/
fahadmirza 0:a0c5877bd360 89 /* Exported macros -----------------------------------------------------------*/
fahadmirza 0:a0c5877bd360 90 /* Exported functions ------------------------------------------------------- */
fahadmirza 0:a0c5877bd360 91
fahadmirza 0:a0c5877bd360 92 /*!
fahadmirza 0:a0c5877bd360 93 * \brief Initializes the timer object
fahadmirza 0:a0c5877bd360 94 *
fahadmirza 0:a0c5877bd360 95 * \remark TimerSetValue function must be called before starting the timer.
fahadmirza 0:a0c5877bd360 96 * this function initializes timestamp and reload value at 0.
fahadmirza 0:a0c5877bd360 97 *
fahadmirza 0:a0c5877bd360 98 * \param [IN] obj Structure containing the timer object parameters
fahadmirza 0:a0c5877bd360 99 * \param [IN] callback Function callback called at the end of the timeout
fahadmirza 0:a0c5877bd360 100 */
fahadmirza 32:2d0678039a09 101 void TimerInit(TimerEvent_t *obj, void ( *callback )( void ));
fahadmirza 0:a0c5877bd360 102
fahadmirza 32:2d0678039a09 103 /*!
fahadmirza 32:2d0678039a09 104 * \brief Set timer new timeout value
fahadmirza 32:2d0678039a09 105 *
fahadmirza 32:2d0678039a09 106 * \param [IN] obj Structure containing the timer object parameters
fahadmirza 32:2d0678039a09 107 * \param [IN] value New timer timeout value
fahadmirza 32:2d0678039a09 108 */
fahadmirza 32:2d0678039a09 109 void TimerSetValue( TimerEvent_t *obj, uint32_t value );
fahadmirza 0:a0c5877bd360 110
fahadmirza 0:a0c5877bd360 111 /*!
fahadmirza 0:a0c5877bd360 112 * \brief Starts and adds the timer object to the list of timer events
fahadmirza 0:a0c5877bd360 113 *
fahadmirza 0:a0c5877bd360 114 * \param [IN] obj Structure containing the timer object parameters
fahadmirza 0:a0c5877bd360 115 */
fahadmirza 32:2d0678039a09 116 void TimerStart(TimerEvent_t *obj);
fahadmirza 0:a0c5877bd360 117
fahadmirza 0:a0c5877bd360 118 /*!
fahadmirza 0:a0c5877bd360 119 * \brief Stops and removes the timer object from the list of timer events
fahadmirza 0:a0c5877bd360 120 *
fahadmirza 0:a0c5877bd360 121 * \param [IN] obj Structure containing the timer object parameters
fahadmirza 0:a0c5877bd360 122 */
fahadmirza 32:2d0678039a09 123 void TimerStop(TimerEvent_t *obj);
fahadmirza 0:a0c5877bd360 124
fahadmirza 0:a0c5877bd360 125 /*!
fahadmirza 0:a0c5877bd360 126 * \brief Resets the timer object
fahadmirza 0:a0c5877bd360 127 *
fahadmirza 0:a0c5877bd360 128 * \param [IN] obj Structure containing the timer object parameters
fahadmirza 0:a0c5877bd360 129 */
fahadmirza 32:2d0678039a09 130 void TimerReset( TimerEvent_t *obj );
fahadmirza 0:a0c5877bd360 131
fahadmirza 0:a0c5877bd360 132 /*!
fahadmirza 0:a0c5877bd360 133 * \brief Read the current time
fahadmirza 0:a0c5877bd360 134 *
fahadmirza 0:a0c5877bd360 135 * \retval returns current time in ms
fahadmirza 0:a0c5877bd360 136 */
fahadmirza 0:a0c5877bd360 137 uint32_t TimerGetCurrentTime( void );
fahadmirza 0:a0c5877bd360 138
fahadmirza 0:a0c5877bd360 139 /*!
fahadmirza 0:a0c5877bd360 140 * \brief Return the Time elapsed since a fix moment in Time
fahadmirza 0:a0c5877bd360 141 *
fahadmirza 0:a0c5877bd360 142 * \param [IN] savedTime fix moment in Time
fahadmirza 0:a0c5877bd360 143 * \retval time returns elapsed time in ms
fahadmirza 0:a0c5877bd360 144 */
fahadmirza 32:2d0678039a09 145 uint32_t TimerGetElapsedTime(uint32_t savedTime);
fahadmirza 0:a0c5877bd360 146
fahadmirza 0:a0c5877bd360 147 #ifdef __cplusplus
fahadmirza 0:a0c5877bd360 148 }
fahadmirza 0:a0c5877bd360 149 #endif
fahadmirza 0:a0c5877bd360 150
fahadmirza 0:a0c5877bd360 151 #endif /* __TIME_SERVER_H__*/
fahadmirza 0:a0c5877bd360 152
fahadmirza 0:a0c5877bd360 153 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
fahadmirza 0:a0c5877bd360 154