hal_gpc.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_GPC_H__
#define __HAL_GPC_H__
#include "hal_platform.h"

#ifdef HAL_GPC_MODULE_ENABLED

#ifdef HAL_GPC_FEATURE_ADVANCED_CONFIG

#endif


#ifdef HAL_GPC_FEATURE_ADVANCED_CONFIG

#endif

#ifdef __cplusplus
extern "C" {
#endif

#ifdef HAL_GPC_FEATURE_ADVANCED_CONFIG

typedef void (*hal_gpc_callback_t)(void *user_data);
#endif

#ifdef HAL_GPC_FEATURE_ADVANCED_CONFIG

typedef enum {
    HAL_GPC_CLOCK_26MHZ = 0,                        
    HAL_GPC_CLOCK_32KHZ = 1,                        
} hal_gpc_clock_t;
#endif


typedef enum {
    HAL_GPC_EDGE_RAISING = 0,                       
    HAL_GPC_EDGE_FALLING = 1,                       
} hal_gpc_edge_t;

typedef enum {
    HAL_GPC_STATUS_ERROR             = -3,          
    HAL_GPC_STATUS_ERROR_PORT        = -2,          
    HAL_GPC_STATUS_INVALID_PARAMETER = -1,          
    HAL_GPC_STATUS_OK   = 0,                        
} hal_gpc_status_t;

typedef enum {
    HAL_GPC_STATUS_IDLE = 0,                        
    HAL_GPC_STATUS_BUSY = 1,                        
} hal_gpc_running_status_t;
typedef struct {
    hal_gpc_edge_t     edge;             
} hal_gpc_config_t;

#ifdef HAL_GPC_FEATURE_ADVANCED_CONFIG

typedef struct {
    hal_gpc_clock_t    clock_source;     
    uint32_t           debounce;         
    uint32_t           threshold;        
} hal_gpc_advanced_config_t;
#endif

hal_gpc_status_t hal_gpc_init(hal_gpc_port_t gpc_port, const hal_gpc_config_t *gpc_config);

hal_gpc_status_t hal_gpc_deinit(hal_gpc_port_t gpc_port);


hal_gpc_status_t hal_gpc_enable(hal_gpc_port_t gpc_port);


hal_gpc_status_t hal_gpc_disable(hal_gpc_port_t gpc_port);


hal_gpc_status_t hal_gpc_get_running_status(hal_gpc_port_t gpc_port, hal_gpc_running_status_t *running_state);


hal_gpc_status_t hal_gpc_get_and_clear_count(hal_gpc_port_t gpc_port, uint32_t *count);


/************************************ HAL_GPC_FEATURE_ADVANCED_CONFIG *********************************/
#ifdef  HAL_GPC_FEATURE_ADVANCED_CONFIG

hal_gpc_status_t hal_gpc_interrupt_enable(hal_gpc_port_t gpc_port);

hal_gpc_status_t hal_gpc_interrupt_disable(hal_gpc_port_t gpc_port);

hal_gpc_status_t hal_gpc_register_callback(hal_gpc_port_t gpc_port, hal_gpc_callback_t callback, void *user_data);


hal_gpc_status_t hal_gpc_set_threshold(hal_gpc_port_t gpc_port, uint32_t *threshold);

hal_gpc_status_t hal_gpc_get_threshold(hal_gpc_port_t gpc_port, uint32_t *threshold);

hal_gpc_status_t hal_gpc_advanced_config(hal_gpc_port_t gpc_port, const hal_gpc_advanced_config_t *gpc_advanced_config);

#endif

#ifdef __cplusplus
}
#endif

#endif /*HAL_GPC_MODULE_ENABLED*/
#endif /* __HAL_GPC_H__ */