diff options
Diffstat (limited to 'ucs2-lib/inc/ucs_timer.h')
| -rw-r--r-- | ucs2-lib/inc/ucs_timer.h | 144 |
1 files changed, 0 insertions, 144 deletions
diff --git a/ucs2-lib/inc/ucs_timer.h b/ucs2-lib/inc/ucs_timer.h deleted file mode 100644 index 5321988..0000000 --- a/ucs2-lib/inc/ucs_timer.h +++ /dev/null @@ -1,144 +0,0 @@ -/*------------------------------------------------------------------------------------------------*/ -/* UNICENS V2.1.0-3491 */ -/* Copyright (c) 2017 Microchip Technology Germany II GmbH & Co. KG. */ -/* */ -/* This program is free software: you can redistribute it and/or modify */ -/* it under the terms of the GNU General Public License as published by */ -/* the Free Software Foundation, either version 2 of the License, or */ -/* (at your option) any later version. */ -/* */ -/* This program is distributed in the hope that it will be useful, */ -/* but WITHOUT ANY WARRANTY; without even the implied warranty of */ -/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */ -/* GNU General Public License for more details. */ -/* */ -/* You should have received a copy of the GNU General Public License */ -/* along with this program. If not, see <http://www.gnu.org/licenses/>. */ -/* */ -/* You may also obtain this software under a propriety license from Microchip. */ -/* Please contact Microchip for further information. */ -/*------------------------------------------------------------------------------------------------*/ - -/*! - * \file - * \brief Internal header file of the timer management module. - * - * \cond UCS_INTERNAL_DOC - * \addtogroup G_TIMER - * @{ - */ - -#ifndef UCS_TIMER_H -#define UCS_TIMER_H - -/*------------------------------------------------------------------------------------------------*/ -/* Includes */ -/*------------------------------------------------------------------------------------------------*/ -#include "ucs_rules.h" -#include "ucs_dl.h" -#include "ucs_scheduler.h" - -#ifdef __cplusplus -extern "C" -{ -#endif - -/*------------------------------------------------------------------------------------------------*/ -/* Types */ -/*------------------------------------------------------------------------------------------------*/ -/*! \brief Function signature used for timer handler - * \param args Void pointer to optional data - */ -typedef void (*Tm_Handler_t)(void *args); - -/*------------------------------------------------------------------------------------------------*/ -/* Structures */ -/*------------------------------------------------------------------------------------------------*/ -/*! \brief Initialization structure of the timer management module. */ -typedef struct Tm_InitData_ -{ - /*! \brief Observer used to request current tick count value */ - CSingleObserver *get_tick_count_obs_ptr; - /*! \brief Observer used to start application timer for delayed TM service calls */ - CSingleObserver *set_application_timer_obs_ptr; - /*! \brief UNICENS instance ID */ - /*uint8_t ucs_inst_id;*/ - -} Tm_InitData_t; - -/*! \brief Class structure of the a timer object. */ -typedef struct CTimer_ -{ - /*! \brief Node of the doubly linked (timer-) list */ - CDlNode node; - /*! \brief Handler function which is invoked when the timer expires */ - Tm_Handler_t handler_fptr; - /*! \brief Reference to optional parameter */ - void *args_ptr; - /*! \brief The Timeout value before the timer expires for the first time, in milliseconds */ - uint16_t elapse; - /*! \brief The period of the timer, in milliseconds */ - uint16_t period; - /*! \brief Delta time related to next timer in list */ - uint16_t delta; - /*! \brief Flag which signals that the timer is in use */ - bool in_use; - /*! \brief Flag to check if timer object has changed within timer handler callback function */ - bool changed; - -} CTimer; - -/*! \brief Class structure of the timer management */ -typedef struct CTimerManagement_ -{ - /*! \brief Doubly linked list to manage the active timers */ - CDlList timer_list; - /*! \brief Subject to request current tick count */ - CSingleSubject get_tick_count_subject; - /*! \brief Subject to start the application timer which triggers a UCS service call */ - CSingleSubject set_application_timer_subject; - /*! \brief Service instance to add the timer management to the scheduler */ - CService tm_srv; - /*! \brief Last tick count value (saved at TM service) */ - uint16_t last_tick_count; - /*! \brief Signals that the application timer callbacks are used */ - bool delayed_tm_service_enabled; - /*! \brief Indicates that the application timer must be started */ - bool set_service_timer; - /*! \brief UNICENS instance ID */ - void * ucs_user_ptr; - -} CTimerManagement; - -/*------------------------------------------------------------------------------------------------*/ -/* Prototypes of class CTimerManagement */ -/*------------------------------------------------------------------------------------------------*/ -extern void Tm_Ctor(CTimerManagement *self, CScheduler *scd, const Tm_InitData_t *init_ptr, void * ucs_user_ptr); -extern void Tm_SetTimer(CTimerManagement *self, CTimer *timer_ptr, Tm_Handler_t handler_fptr, - void *args_ptr, uint16_t elapse, uint16_t period); -extern void Tm_ClearTimer(CTimerManagement *self, CTimer *timer_ptr); -extern void Tm_CheckForNextService(CTimerManagement *self); -extern void Tm_TriggerService(CTimerManagement *self); -extern void Tm_StopService(CTimerManagement *self); - -/*------------------------------------------------------------------------------------------------*/ -/* Prototypes of class CTimer */ -/*------------------------------------------------------------------------------------------------*/ -extern void T_Ctor(CTimer *self); -extern bool T_IsTimerInUse(CTimer *self); - -#ifdef __cplusplus -} /* extern "C" */ -#endif - -#endif /* #ifndef UCS_TIMER_H */ - -/*! - * @} - * \endcond - */ - -/*------------------------------------------------------------------------------------------------*/ -/* End of file */ -/*------------------------------------------------------------------------------------------------*/ - |