hal_gpt.h

/* Copyright Statement:
 *
 * (C) 2005-2016  MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User").  If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER 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 MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */


#ifndef __HAL_GPT_H__
#define __HAL_GPT_H__
#include "hal_platform.h"

#ifdef HAL_GPT_MODULE_ENABLED

#ifdef HAL_GPT_FEATURE_US_TIMER

#else

#endif

#ifdef HAL_GPT_SW_GPT_FEATURE

#endif

#ifdef HAL_GPT_FEATURE_US_TIMER

#endif

#ifdef HAL_GPT_FEATURE_US_TIMER

#endif

#ifdef HAL_GPT_SW_GPT_FEATURE

#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef void(* hal_gpt_callback_t)(void *user_data);

typedef enum {
    HAL_GPT_TIMER_TYPE_ONE_SHOT = 0,                
    HAL_GPT_TIMER_TYPE_REPEAT   = 1                 
} hal_gpt_timer_type_t;


typedef enum {
    HAL_GPT_STATUS_ERROR_PORT_USED   = -4,         
    HAL_GPT_STATUS_ERROR             = -3,         
    HAL_GPT_STATUS_ERROR_PORT        = -2,         
    HAL_GPT_STATUS_INVALID_PARAMETER = -1,         
    HAL_GPT_STATUS_OK   = 0                        
} hal_gpt_status_t;


typedef enum {
    HAL_GPT_STOPPED = 0,                            
    HAL_GPT_RUNNING = 1                             
} hal_gpt_running_status_t;


hal_gpt_status_t hal_gpt_init(hal_gpt_port_t gpt_port);


hal_gpt_status_t hal_gpt_deinit(hal_gpt_port_t gpt_port);


hal_gpt_status_t hal_gpt_get_running_status(hal_gpt_port_t gpt_port, hal_gpt_running_status_t *running_status);


hal_gpt_status_t hal_gpt_register_callback(hal_gpt_port_t gpt_port, hal_gpt_callback_t callback, void *user_data);

hal_gpt_status_t hal_gpt_get_free_run_count(hal_gpt_clock_source_t clock_source, uint32_t *count);


hal_gpt_status_t hal_gpt_start_timer_ms(hal_gpt_port_t gpt_port, uint32_t timeout_time_ms, hal_gpt_timer_type_t timer_type);


hal_gpt_status_t hal_gpt_delay_ms(uint32_t ms);


#ifdef HAL_GPT_FEATURE_US_TIMER

hal_gpt_status_t hal_gpt_start_timer_us(hal_gpt_port_t gpt_port, uint32_t timeout_time_us, hal_gpt_timer_type_t timer_type);
#endif


hal_gpt_status_t hal_gpt_delay_us(uint32_t us);

hal_gpt_status_t hal_gpt_stop_timer(hal_gpt_port_t gpt_port);

hal_gpt_status_t hal_gpt_get_duration_count(uint32_t start_count, uint32_t end_count, uint32_t *duration_count);

#ifdef HAL_GPT_SW_GPT_FEATURE

hal_gpt_status_t hal_gpt_sw_get_timer(uint32_t *handle);

hal_gpt_status_t hal_gpt_sw_free_timer(uint32_t handle);

hal_gpt_status_t hal_gpt_sw_start_timer_ms(uint32_t handle, uint32_t timeout_time_ms, hal_gpt_callback_t callback, void *user_data);

hal_gpt_status_t hal_gpt_sw_stop_timer_ms(uint32_t handle);

hal_gpt_status_t hal_gpt_sw_get_remaining_time_ms(uint32_t handle, uint32_t *remaing_time);

#endif

#ifdef __cplusplus
}
#endif

#endif /*HAL_GPT_MODULE_ENABLED*/
#endif /* __HAL_GPT_H__ */