
/**
    \file EM_timer_internal.h

    This Header File contains Internal Declarations of Structures,
    Functions and Global Definitions for FreeRTOS.
*/

/*
    Copyright (C) 2013. Mindtree Ltd.
    All rights reserved.
*/

#ifndef _H_EM_TIMER_INTERNAL_
#define _H_EM_TIMER_INTERNAL_

/* ----------------------------------------------- Header File Inclusion */
#include "EM_timer.h"
#include "EM_debug.h"

/* ----------------------------------------------- Timer Debug Macros */

#ifdef EM_TIMERL_DEBUG
    #define EM_TIMERL_TRC(...)      EM_debug_trace(bt_debug_fd, __VA_ARGS__)
#else  /* EM_TIMERL_DEBUG */
    #define EM_TIMERL_TRC           EM_debug_null
#endif /* EM_TIMERL_DEBUG */

#ifdef EM_TIMERT_DEBUG
    #define EM_TIMERT_TRC(...)      EM_debug_trace(bt_debug_fd, __VA_ARGS__)
#else  /* EM_TIMERT_DEBUG */
    #define EM_TIMERT_TRC           EM_debug_null
#endif /* EM_TIMERT_DEBUG */

#ifdef EM_TIMER_DEBUG

    #define EM_TIMER_ERR(...)       EM_debug_error(bt_debug_fd, __VA_ARGS__)
    #define EM_TIMER_TRC(...)       EM_debug_trace(bt_debug_fd, __VA_ARGS__)
    #define EM_TIMER_INF(...)       EM_debug_info(bt_debug_fd, __VA_ARGS__)

#else  /* EM_TIMER_DEBUG */

    #define EM_TIMER_ERR            EM_debug_null
    #define EM_TIMER_TRC            EM_debug_null
    #define EM_TIMER_INF            EM_debug_null

#endif /* EM_TIMER_DEBUG */


/* ----------------------------------------------- Global Definitions */

/* Timer Malloc/Free Related --------- */
#define timer_malloc            osal_mem_alloc
#define timer_free              osal_mem_free

/* Lock/Unlock Timer Library */
/* TODO: Check if PhyOS is pre-emptive */
#if 0
    #define timer_lock()            EM_thread_mutex_lock(&timer_mutex)
    #define timer_unlock()          EM_thread_mutex_unlock(&timer_mutex)
#else
    #define timer_lock()
    #define timer_unlock()
#endif /* 0 */

/* Null Check for Timer Handles */
#define timer_null_check(p)     if (NULL == (p)) return -1;

/* Timer Task State Values */
#define TIMER_INIT              0x00
#define TIMER_WAITING           0x01
#define TIMER_RUNNING           0x02
#define TIMER_SHUTDOWN          0x03
#define TIMER_IMMEDIATE         0x04

/* One Timer Tick => 10 MilliSecond */
#define TIMER_TICK              10

/* Timer task yield period (in Microsecond) */
#define TIMER_YIELD_PERIOD      (1 * 1000)

/* ----------------------------------------------- Structures/Data Types */


/* ----------------------------------------------- Internal Functions */

#ifdef __cplusplus
extern "C" {
#endif

EM_THREAD_RETURN_TYPE timer_start_routine (EM_THREAD_ARGS args);
void timer_service_queue (void);

EM_RESULT timer_add_entity ( TIMER_ENTITY* timer );
EM_RESULT timer_del_entity ( TIMER_ENTITY* timer, UCHAR free );
EM_RESULT timer_search_entity ( TIMER_ENTITY* timer );
EM_RESULT timer_init_entity ( TIMER_ENTITY* timer );

/* Get the timer based on obtained timer id */
EM_RESULT timer_search_entity_timer_id
(
    TIMER_ENTITY** timer,
    UINT8          timer_id
);

/* Callback registered with timer module */
void timer_timeout_handler (UINT8* timer_id);

UINT64 em_timer_get_ms_timestamp(void);

#ifdef __cplusplus
};
#endif

#endif /* _H_EM_TIMER_INTERNAL_ */

