mcu/service/mertos/include/mer_kernel_timer.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2018
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
*
* Filename:
* ---------
*   mer_kernel_timer.h
*
* Project:
* --------
*   MERTOS
*
* Description:
* ------------
*   The OS timer header
*
* Author:
* -------
 * -------
*
*****************************************************************************/
#ifndef _MER_KERNEL_TIMER_H_
#define _MER_KERNEL_TIMER_H_

#include "mer_service_types.h"
#include "mer_kernel_config_public.h"
#include "us_timer.h"
#include "kal_internal_api.h"

///////////////////////////////////////////////////////////////////////////////
// Macro
///////////////////////////////////////////////////////////////////////////////
#define OSTD_MAX_VALUE                0xffffffff
#define OSTD_MAX_SLEEP_VALUE          MAX_SLEEP_TIME

///////////////////////////////////////////////////////////////////////////////
// External variable
///////////////////////////////////////////////////////////////////////////////
extern mer_uint32   mer_kernel_timer_initial_tick;
#if !defined(__EVENT_BASED_TIMER__)
extern mer_uint32 mer_kernel_timer_fake_global_tick;
#endif
///////////////////////////////////////////////////////////////////////////////
// Compile time assertion check
///////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////
// Typedef
///////////////////////////////////////////////////////////////////////////////
typedef struct timer_tick_info{
    mer_uint32 afn;
    mer_uint32 ufn;
    mer_uint32 delayed;
    struct timer_tick_info *next_ptr;
} mer_kernel_timer_tick_info;

///////////////////////////////////////////////////////////////////////////////
// Enum
/////////////////////////////////////////////////////////////////////////////// 

///////////////////////////////////////////////////////////////////////////////
// Structure
///////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////
// Static inline function
///////////////////////////////////////////////////////////////////////////////
static inline mer_uint32 mer_kernel_timer_tick_duration(mer_uint32 from, mer_uint32 to){
    return ust_us_duration(from, to);
}
static inline mer_uint32 mer_kernel_timer_get_current_tick(){
#if defined(__EVENT_BASED_TIMER__)
    return USC_Get_TimeStamp();
#else /* __EVENT_BASED_TIMER__ */
    return mer_kernel_timer_fake_global_tick; 
#endif /* __EVENT_BASED_TIMER__ */
}

///////////////////////////////////////////////////////////////////////////////
// External Function
///////////////////////////////////////////////////////////////////////////////
void        mer_kernel_timer_initialization();
void        mer_kernel_timer_register_tick_interrupt(mer_uint32 afn, mer_uint32 ufn, mer_kernel_timer_tick_info* timer_cb, mer_uint32 delayed);
void        mer_kernel_timer_get_sleep_afn_ufn(mer_uint32 *afn, mer_uint32 *ufn, mer_kernel_timer_tick_info* afn_cb, mer_kernel_timer_tick_info* ufn_cb);
mer_uint32  mer_kernel_timer_remove_event(mer_kernel_timer_tick_info *cb);
mer_uint32  mer_kernel_timer_sleep_available();
mer_kernel_timer_tick_info* mer_kernel_timer_get_expired_cb();
#endif /* _MER_KERNEL_TIMER_H_ */