You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
164 lines
5.9 KiB
164 lines
5.9 KiB
/*
|
|
/ _____) _ | |
|
|
( (____ _____ ____ _| |_ _____ ____| |__
|
|
\____ \| ___ | (_ _) ___ |/ ___) _ \
|
|
_____) ) ____| | | || |_| ____( (___| | | |
|
|
(______/|_____)_|_|_| \__)_____)\____)_| |_|
|
|
(C)2013 Semtech
|
|
|
|
Description: Timer objects and scheduling management
|
|
|
|
License: Revised BSD License, see LICENSE.TXT file include in the project
|
|
|
|
Maintainer: Miguel Luis and Gregory Cristian
|
|
*/
|
|
/******************************************************************************
|
|
* @file timeServer.h
|
|
* @author MCD Application Team
|
|
* @version V1.1.2
|
|
* @date 08-September-2017
|
|
* @brief is the timer server driver
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2017 STMicroelectronics International N.V.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted, provided that the following conditions are met:
|
|
*
|
|
* 1. Redistribution of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* 3. Neither the name of STMicroelectronics nor the names of other
|
|
* contributors to this software may be used to endorse or promote products
|
|
* derived from this software without specific written permission.
|
|
* 4. This software, including modifications and/or derivative works of this
|
|
* software, must execute solely and exclusively on microcontroller or
|
|
* microprocessor devices manufactured by or for STMicroelectronics.
|
|
* 5. Redistribution and use of this software other than as permitted under
|
|
* this license is void and will automatically terminate your rights under
|
|
* this license.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
|
* PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
|
|
* RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
|
|
* SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
|
|
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef __TIMESERVER_H__
|
|
#define __TIMESERVER_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
|
|
#include "utilities.h"
|
|
|
|
/* Exported types ------------------------------------------------------------*/
|
|
|
|
/*!
|
|
* \brief Timer object description
|
|
*/
|
|
typedef struct TimerEvent_s
|
|
{
|
|
uint32_t Timestamp; //! Expiring timer value in ticks from TimerContext
|
|
uint32_t ReloadValue; //! Reload Value when Timer is restarted
|
|
bool IsRunning; //! Is the timer currently running
|
|
void ( *Callback )( void ); //! Timer IRQ callback function
|
|
struct TimerEvent_s *Next; //! Pointer to the next Timer object.
|
|
} TimerEvent_t;
|
|
|
|
|
|
/* Exported constants --------------------------------------------------------*/
|
|
/* External variables --------------------------------------------------------*/
|
|
/* Exported macros -----------------------------------------------------------*/
|
|
/* Exported functions ------------------------------------------------------- */
|
|
|
|
/*!
|
|
* \brief Initializes the timer object
|
|
*
|
|
* \remark TimerSetValue function must be called before starting the timer.
|
|
* this function initializes timestamp and reload value at 0.
|
|
*
|
|
* \param [IN] obj Structure containing the timer object parameters
|
|
* \param [IN] callback Function callback called at the end of the timeout
|
|
*/
|
|
void TimerInit( TimerEvent_t *obj, void ( *callback )( void ) );
|
|
|
|
/*!
|
|
* \brief Timer IRQ event handler
|
|
*
|
|
* \note Head Timer Object is automaitcally removed from the List
|
|
*
|
|
* \note e.g. it is snot needded to stop it
|
|
*/
|
|
void TimerIrqHandler( void );
|
|
|
|
/*!
|
|
* \brief Starts and adds the timer object to the list of timer events
|
|
*
|
|
* \param [IN] obj Structure containing the timer object parameters
|
|
*/
|
|
void TimerStart( TimerEvent_t *obj );
|
|
|
|
/*!
|
|
* \brief Stops and removes the timer object from the list of timer events
|
|
*
|
|
* \param [IN] obj Structure containing the timer object parameters
|
|
*/
|
|
void TimerStop( TimerEvent_t *obj );
|
|
|
|
/*!
|
|
* \brief Resets the timer object
|
|
*
|
|
* \param [IN] obj Structure containing the timer object parameters
|
|
*/
|
|
void TimerReset( TimerEvent_t *obj );
|
|
|
|
/*!
|
|
* \brief Set timer new timeout value
|
|
*
|
|
* \param [IN] obj Structure containing the timer object parameters
|
|
* \param [IN] value New timer timeout value
|
|
*/
|
|
void TimerSetValue( TimerEvent_t *obj, uint32_t value );
|
|
|
|
|
|
/*!
|
|
* \brief Read the current time
|
|
*
|
|
* \retval returns current time in ms
|
|
*/
|
|
TimerTime_t TimerGetCurrentTime( void );
|
|
|
|
/*!
|
|
* \brief Return the Time elapsed since a fix moment in Time
|
|
*
|
|
* \param [IN] savedTime fix moment in Time
|
|
* \retval time returns elapsed time in ms
|
|
*/
|
|
TimerTime_t TimerGetElapsedTime( TimerTime_t savedTime );
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __TIMESERVER_H__*/
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
|
|