hal_keypad.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_KEYPAD_H__
#define __HAL_KEYPAD_H__

#include "hal_platform.h"


#ifdef HAL_KEYPAD_MODULE_ENABLED
#include "hal_keypad_table.h"

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

#endif

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

#endif

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

#endif

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

#else

#endif


#ifdef __cplusplus
extern "C" {
#endif

typedef void (*hal_keypad_callback_t)(void *user_data);

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

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

typedef enum {
    HAL_KEYPAD_MODE_SINGLE_KEY = 0,          
    HAL_KEYPAD_MODE_DOUBLE_KEY = 1          
} hal_keypad_mode_t;

typedef enum {
    HAL_KEYPAD_STATUS_ERROR      = -2,      
    HAL_KEYPAD_INVALID_PARAMETER = -1,      
    HAL_KEYPAD_STATUS_OK   = 0              
} hal_keypad_status_t;

typedef enum {
    HAL_KEYPAD_KEY_RELEASE        = 0,        
    HAL_KEYPAD_KEY_PRESS          = 1,        
    HAL_KEYPAD_KEY_LONG_PRESS     = 2,        
    HAL_KEYPAD_KEY_REPEAT         = 3,        
    HAL_KEYPAD_KEY_PMU_LONG_PRESS = 4         
} hal_keypad_key_state_t;
typedef struct {
    uint8_t column_bitmap;                  
    uint8_t row_bitmap;                     
} hal_keypad_column_row_t;


typedef struct {
    hal_keypad_mode_t       mode;           
    hal_keypad_column_row_t key_map;        
    uint32_t    debounce;                   
    uint32_t    repeat_time;                
    uint32_t    longpress_time;             
} hal_keypad_config_t;


typedef struct {
    uint8_t column_high_pulse;              
    uint8_t row_high_pulse;                 
    uint8_t column_scan_div;                
    uint8_t row_scan_div;                   
} hal_keypad_scan_timing_t;

typedef struct {
    hal_keypad_key_state_t   state;          
    uint32_t             key_data;           
    uint32_t             time_stamp;         
} hal_keypad_event_t;

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

typedef struct {
    hal_keypad_key_state_t   state;          
    uint32_t             key_data;           
    uint32_t             time_stamp;         
} hal_keypad_powerkey_event_t;
#endif

hal_keypad_status_t hal_keypad_init(const hal_keypad_config_t *keypad_config);


#ifdef HAL_KEYPAD_FEATURE_POWERKEY

hal_keypad_status_t hal_keypad_powerkey_init(uint32_t powerkey_data);
#endif


hal_keypad_status_t hal_keypad_deinit(void);

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

hal_keypad_status_t hal_keypad_powerkey_deinit(void);
#endif

hal_keypad_status_t hal_keypad_set_debounce(const uint32_t *keypad_debounce);

hal_keypad_status_t hal_keypad_get_debounce(uint32_t *keypad_debounce);


hal_keypad_status_t hal_keypad_enable(void);

hal_keypad_status_t hal_keypad_disable(void);

hal_keypad_status_t hal_keypad_set_scan_timing(const hal_keypad_scan_timing_t *keypad_scan_timing);


hal_keypad_status_t hal_keypad_get_scan_timing(hal_keypad_scan_timing_t *keypad_scan_timing);


hal_keypad_status_t hal_keypad_register_callback(hal_keypad_callback_t callback, void *user_data);

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

hal_keypad_status_t hal_keypad_powerkey_register_callback(hal_powerkey_callback_t callback, void *user_data);
#endif

hal_keypad_status_t hal_keypad_get_key(hal_keypad_event_t *keypad_event);

#ifdef HAL_KEYPAD_FEATURE_POWERKEY

hal_keypad_status_t hal_keypad_powerkey_get_key(hal_keypad_powerkey_event_t *powerkey_event);
#endif /* HAL_KEYPAD_FEATURE_POWERKEY */

#ifdef __cplusplus
}
#endif

#endif /* HAL_KEYPAD_MODULE_ENABLED */
#endif /* __HAL_KEYPAD_H__ */