timer.h

Go to the documentation of this file.

/*
 / _____)             _              | |
( (____  _____ ____ _| |_ _____  ____| |__
 \____ \| ___ |    (_   _) ___ |/ ___)  _ \
 _____) ) ____| | | || |_| ____( (___| | | |
(______/|_____)_|_|_| \__)_____)\____)_| |_|
    (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    timer.h
 * @author  Insight SiP
 * @version V1.0.0
 * @date    02-mars-2018
 * @brief   timer header functions for LORA.
 *
 * @attention
 *  THIS SOFTWARE IS PROVIDED BY INSIGHT SIP "AS IS" AND ANY EXPRESS
 *  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 *  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL INSIGHT SIP 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.
 *
 *****************************************************************************/
 
#ifndef __TIMER_H__
#define __TIMER_H__
 
#include "stdint.h"
#include "stdbool.h"
#if defined(ESP32) || defined(ESP8266)
#include <Ticker.h>
#endif
#include "sx126x-debug.h"
 
extern "C"
{
#define ROUNDED_DIV(A, B) (((A) + ((B) / 2)) / (B))
 
    typedef void (*callbackType)(void);
 
    typedef struct TimerEvent_s
    {
        uint8_t timerNum;          
        bool oneShot = true;          
        uint32_t Timestamp;        
        uint32_t ReloadValue = 10000; 
        bool IsRunning;            
        void (*Callback)(void);    
        struct TimerEvent_s *Next; 
    } TimerEvent_t;
 
#ifndef TimerTime_t
    typedef uint32_t TimerTime_t;
#endif
 
    void TimerConfig(void);
 
    void TimerInit(TimerEvent_t *obj, void (*callback)(void));
 
    void TimerStart(TimerEvent_t *obj);
 
    void TimerStop(TimerEvent_t *obj);
 
    void TimerReset(TimerEvent_t *obj);
 
    void TimerSetValue(TimerEvent_t *obj, uint32_t value);
 
    TimerTime_t TimerGetElapsedTime(TimerTime_t savedTime);
 
    TimerTime_t TimerGetCurrentTime(void);
};
#endif // __TIMER_H__