__vsf_arch_interface.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_ARCH_INTERFACE_H__
#define __VSF_ARCH_INTERFACE_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
#include "vsf_arch_abstraction.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/******************************************************************************
 * IMPORTANT: This header file can only be included by source code files      *
 *            within arch                                                     *
 ******************************************************************************/
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ LOCAL VARIABLES ===============================*/
/*============================ PROTOTYPES ====================================*/
 
/*----------------------------------------------------------------------------*
 * APIs or Interfaces each Arch must use or implement                         *
 *----------------------------------------------------------------------------*/
 
extern bool vsf_arch_low_level_init(void);
 
 
#if VSF_SYSTIMER_CFG_IMPL_MODE != VSF_SYSTIMER_IMPL_NONE
 
extern void vsf_systimer_prio_set(vsf_arch_prio_t priority);
 
extern uint_fast32_t vsf_arch_req___systimer_freq___from_usr(void);
#   if VSF_SYSTIMER_CFG_IMPL_MODE == VSF_SYSTIMER_IMPL_TICK_MODE
extern uint_fast32_t vsf_arch_req___systimer_resolution___from_usr(void);
#   endif
 
/*----------------------------------------------------------------------------*
 * System Timer : Implement with Normal Timer (Count down or Count up)        *
 *----------------------------------------------------------------------------*/
#   if  (VSF_SYSTIMER_CFG_IMPL_MODE == VSF_SYSTIMER_IMPL_WITH_NORMAL_TIMER)      \
    ||  (VSF_SYSTIMER_CFG_IMPL_MODE == VSF_SYSTIMER_IMPL_TICK_MODE)
 
/*-------------------------------------------*
 * APIs to be implemented by target arch     *
 *-------------------------------------------*/
 
extern vsf_err_t vsf_systimer_low_level_init(uintmax_t ticks);
 
extern bool vsf_systimer_low_level_disable(void);
 
extern void vsf_systimer_low_level_enable(void);
extern void vsf_systimer_low_level_int_disable(void);
extern void vsf_systimer_low_level_int_enable(void);
extern void vsf_systimer_set_reload_value(vsf_systimer_tick_t tick_cnt);
extern void vsf_systimer_reset_counter_value(void);
extern void vsf_systimer_clear_int_pending_bit(void);
extern vsf_systimer_tick_t vsf_systimer_get_tick_elapsed(void);
 
/*-------------------------------------------*
 * APIs to be used by target arch            *
 *-------------------------------------------*/
extern void vsf_systimer_ovf_evt_handler(void);
 
/*----------------------------------------------------------------------------*
 * System Timer : Implement with timer with compare match, trigger when       *
 *                  current_value >= compare_value                            *
 *----------------------------------------------------------------------------*/
#   elif VSF_SYSTIMER_CFG_IMPL_MODE == VSF_SYSTIMER_IMPL_WITH_COMP_TIMER
 
/*-------------------------------------------*
 * APIs to be implemented by target arch     *
 *-------------------------------------------*/
 
extern vsf_err_t vsf_systimer_low_level_init(void);
 
extern void vsf_systimer_low_level_enable(void);
 
extern vsf_systimer_tick_t vsf_systimer_low_level_get_current(void);
 
extern void vsf_systimer_low_level_set_match(vsf_systimer_tick_t match);
 
/*-------------------------------------------*
 * APIs to be used by target arch            *
 *-------------------------------------------*/
extern void vsf_systimer_match_evthandler(void);
 
/*----------------------------------------------------------------------------*
 * System Timer : Implement with request / response model                     *
 *----------------------------------------------------------------------------*/
#   elif VSF_SYSTIMER_CFG_IMPL_MODE == VSF_SYSTIMER_IMPL_REQUEST_RESPONSE
 
/*-------------------------------------------*
 * APIs to be implemented by target arch     *
 *-------------------------------------------*/
extern vsf_err_t vsf_systimer_init(void);
extern bool vsf_systimer_is_due(vsf_systimer_tick_t due);
 
extern vsf_err_t vsf_systimer_start(void);
extern void vsf_systimer_set_idle(void);
 
extern vsf_systimer_tick_t vsf_systimer_get(void);
extern bool vsf_systimer_set(vsf_systimer_tick_t due);
 
extern vsf_systimer_tick_t vsf_systimer_us_to_tick(uint_fast32_t time_us);
extern vsf_systimer_tick_t vsf_systimer_ms_to_tick(uint_fast32_t time_ms);
extern vsf_systimer_tick_t vsf_systimer_tick_to_us(vsf_systimer_tick_t tick);
extern vsf_systimer_tick_t vsf_systimer_tick_to_ms(vsf_systimer_tick_t tick);
 
/*-------------------------------------------*
 * APIs to be used by target arch            *
 *-------------------------------------------*/
extern void vsf_systimer_timeout_evt_handler(vsf_systimer_tick_t tick);
 
#   endif
#endif      // VSF_SYSTIMER_CFG_IMPL_MODE
 
 
#ifdef __cplusplus
}
#endif
 
#endif
/* EOF */