hal_irrx.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_IRRX_H__
#define __HAL_IRRX_H__

#include "hal_platform.h"

#ifdef HAL_IRRX_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif



typedef enum {
    HAL_IRRX_STATUS_INVALID_PARAM = -2,     
    HAL_IRRX_STATUS_NOT_SUPPORTED = -1,    
    HAL_IRRX_STATUS_OK = 0                 
} hal_irrx_status_t;


typedef enum {
    HAL_IRRX_EVENT_TRANSACTION_ERROR = -1,   
    HAL_IRRX_EVENT_TRANSACTION_SUCCESS = 0   
} hal_irrx_event_t;

typedef enum {
    HAL_IRRX_IDLE = 0,                     
    HAL_IRRX_BUSY = 1                      
} hal_irrx_running_status_t;


typedef void (*hal_irrx_callback_t)(hal_irrx_event_t event, void  *user_data);

typedef struct {
    uint8_t     bits;  
    uint32_t    code[2];   
} hal_irrx_rc5_code_t;


typedef struct {
    uint8_t     inverse;  
    uint32_t    terminate_threshold;  
} hal_irrx_pwd_config_t;

#define HAL_IRRX_RC5_RECEIVE_FORMAT_SIGNAL_INVERSE      (0x1)     
#define HAL_IRRX_RC5_RECEIVE_FORMAT_BIT_REVERSE         (0x10)   
hal_irrx_status_t hal_irrx_init(void);


hal_irrx_status_t hal_irrx_deinit(void);



hal_irrx_status_t hal_irrx_receive_rc5_start(uint8_t             format,
        hal_irrx_callback_t callback,
        void                *parameter);
hal_irrx_status_t hal_irrx_receive_rc5(hal_irrx_rc5_code_t *code);


hal_irrx_status_t hal_irrx_receive_pwd_start(
    const hal_irrx_pwd_config_t     *config,
    hal_irrx_callback_t             callback,
    uint32_t                        *precision_us);


hal_irrx_status_t hal_irrx_receive_pwd(uint8_t  *received_length,
                                       uint8_t  *buffer,
                                       uint8_t  buffer_length);


hal_irrx_status_t hal_irrx_get_running_status(hal_irrx_running_status_t *running_status);



#ifdef __cplusplus
}
#endif

#endif /*HAL_IRRX_MODULE_ENABLED*/
#endif /* __HAL_IRRX_H__ */