hal_eint.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_EINT_H__
#define __HAL_EINT_H__
#include "hal_platform.h"

#ifdef HAL_EINT_MODULE_ENABLED

#ifdef HAL_EINT_FEATURE_MASK

#else

#endif

#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
    HAL_EINT_LEVEL_LOW     = 0,                 
    HAL_EINT_LEVEL_HIGH    = 1,                 
    HAL_EINT_EDGE_FALLING  = 2,                 
    HAL_EINT_EDGE_RISING   = 3,                 
    HAL_EINT_EDGE_FALLING_AND_RISING = 4        
} hal_eint_trigger_mode_t;


typedef enum {
    HAL_EINT_STATUS_ERROR_EINT_NUMBER  = -3,     
    HAL_EINT_STATUS_INVALID_PARAMETER  = -2,     
    HAL_EINT_STATUS_ERROR              = -1,     
    HAL_EINT_STATUS_OK                 = 0       
} hal_eint_status_t;


typedef struct {
    hal_eint_trigger_mode_t trigger_mode;      
    uint32_t debounce_time;                    
} hal_eint_config_t;

typedef void (*hal_eint_callback_t)(void *user_data);

/*****************************************************************************
* Functions
*****************************************************************************/

hal_eint_status_t hal_eint_init(hal_eint_number_t eint_number, const hal_eint_config_t *eint_config);


hal_eint_status_t hal_eint_deinit(hal_eint_number_t eint_number);


hal_eint_status_t hal_eint_register_callback(hal_eint_number_t eint_number,
        hal_eint_callback_t callback,
        void *user_data);


hal_eint_status_t hal_eint_set_trigger_mode(hal_eint_number_t eint_number,
        hal_eint_trigger_mode_t trigger_mode);


hal_eint_status_t hal_eint_set_debounce_time(hal_eint_number_t eint_number,
        uint32_t time_ms);

#ifdef HAL_EINT_FEATURE_SW_TRIGGER_EINT

hal_eint_status_t hal_eint_set_software_trigger(hal_eint_number_t eint_number);


hal_eint_status_t hal_eint_clear_software_trigger(hal_eint_number_t eint_number);
#endif

#ifdef HAL_EINT_FEATURE_MASK

hal_eint_status_t hal_eint_mask(hal_eint_number_t eint_number);


hal_eint_status_t hal_eint_unmask(hal_eint_number_t eint_number);
#endif

hal_eint_status_t hal_eint_set_debounce_count(hal_eint_number_t eint_number, uint32_t count);


#ifdef __cplusplus
}
#endif


#endif /*HAL_EINT_MODULE_ENABLED*/
#endif /* __HAL_EINT_H__ */