/******************************************************************************
|
*
|
* Copyright (C) 2009-2014 Broadcom Corporation
|
*
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at:
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*
|
******************************************************************************/
|
|
/******************************************************************************
|
*
|
* this file contains the NCI transport internal definitions and functions.
|
*
|
******************************************************************************/
|
|
#ifndef NFC_HAL_INT_H
|
#define NFC_HAL_INT_H
|
|
#include "gki.h"
|
#include "nci_defs.h"
|
#include "nfc_brcm_defs.h"
|
#include "nfc_hal_api.h"
|
#include "nfc_hal_int_api.h"
|
#include "nfc_hal_target.h"
|
|
using android::base::StringPrintf;
|
|
/* NFC HAL Task Timer events */
|
#ifndef NFC_HAL_QUICK_TIMER_EVT_MASK
|
#define NFC_HAL_QUICK_TIMER_EVT_MASK (TIMER_0_EVT_MASK)
|
#endif
|
|
#ifndef NFC_HAL_QUICK_TIMER_ID
|
#define NFC_HAL_QUICK_TIMER_ID (TIMER_0)
|
#endif
|
|
typedef uint8_t tNFC_HAL_WAIT_RSP;
|
|
#if (NFC_HAL_HCI_INCLUDED == TRUE)
|
|
#endif
|
|
/* NFC HAL transport configuration */
|
typedef struct {
|
bool shared_transport; /* TRUE if using shared HCI/NCI transport */
|
uint8_t userial_baud;
|
uint8_t userial_fc;
|
} tNFC_HAL_TRANS_CFG;
|
|
#ifdef TESTER
|
/* For Insight, ncit_cfg is runtime-configurable */
|
#define NFC_HAL_TRANS_CFG_QUALIFIER
|
#else
|
/* For all other platforms, ncit_cfg is constant */
|
#define NFC_HAL_TRANS_CFG_QUALIFIER const
|
#endif
|
extern NFC_HAL_TRANS_CFG_QUALIFIER tNFC_HAL_TRANS_CFG nfc_hal_trans_cfg;
|
|
/****************************************************************************
|
** Internal constants and definitions
|
****************************************************************************/
|
|
typedef uint8_t tNFC_HAL_NCI_RAS;
|
|
typedef uint8_t tNFC_HAL_POWER_MODE;
|
|
#define NFC_HAL_SAVED_HDR_SIZE (2)
|
#define NFC_HAL_SAVED_CMD_SIZE (2)
|
|
#ifndef NFC_HAL_DEBUG
|
#define NFC_HAL_DEBUG TRUE
|
#endif
|
|
#if (NFC_HAL_DEBUG == TRUE)
|
extern bool nfc_debug_enabled;
|
extern const char* const nfc_hal_init_state_str[];
|
#define NFC_HAL_SET_INIT_STATE(state) \
|
DLOG_IF(INFO, nfc_debug_enabled) << StringPrintf( \
|
"init state: %d->%d(%s)", nfc_hal_cb.dev_cb.initializing_state, state, \
|
nfc_hal_init_state_str[state]); \
|
nfc_hal_cb.dev_cb.initializing_state = state;
|
#else
|
#define NFC_HAL_SET_INIT_STATE(state) \
|
nfc_hal_cb.dev_cb.initializing_state = state;
|
#endif
|
|
typedef uint8_t tNFC_HAL_INIT_STATE;
|
|
typedef uint8_t tNFC_HAL_DM_CONFIG;
|
|
/* callback function prototype */
|
typedef struct {
|
uint16_t opcode;
|
uint16_t param_len;
|
uint8_t* p_param_buf;
|
} tNFC_HAL_BTVSC_CPLT;
|
|
#if (NFC_HAL_HCI_INCLUDED == TRUE)
|
|
/* data type for NFC_HAL_HCI_RSP_NV_READ_EVT */
|
typedef struct {
|
NFC_HDR hdr;
|
uint8_t block;
|
uint16_t size;
|
tHAL_NFC_STATUS status;
|
} tNFC_HAL_HCI_RSP_NV_READ_EVT;
|
|
/* data type for NFC_HAL_HCI_RSP_NV_WRITE_EVT */
|
typedef struct {
|
NFC_HDR hdr;
|
tHAL_NFC_STATUS status;
|
} tNFC_HAL_HCI_RSP_NV_WRITE_EVT;
|
|
/* union of all event data types */
|
typedef union {
|
NFC_HDR hdr;
|
/* Internal events */
|
tNFC_HAL_HCI_RSP_NV_READ_EVT nv_read;
|
tNFC_HAL_HCI_RSP_NV_WRITE_EVT nv_write;
|
} tNFC_HAL_HCI_EVENT_DATA;
|
|
#endif
|
/*****************************************************************************
|
** Control block for NFC HAL
|
*****************************************************************************/
|
|
/* Information about current patch in NVM */
|
typedef struct {
|
uint16_t project_id; /* Current project_id of patch in nvm */
|
uint16_t ver_major; /* Current major version of patch in nvm */
|
uint16_t ver_minor; /* Current minor version of patch in nvm */
|
uint16_t fpm_size; /* Current size of FPM patch in nvm */
|
uint16_t lpm_size; /* Current size of LPM patch in nvm */
|
uint8_t flags; /* See NFC_HAL_NVM_FLAGS_* flag definitions */
|
uint8_t nvm_type; /* Current NVM Type - UICC/EEPROM */
|
uint8_t chip_ver[NFC_HAL_PRM_MAX_CHIP_VER_LEN]; /* patch chip version */
|
} tNFC_HAL_NVM;
|
|
/* Patch for I2C fix */
|
typedef struct {
|
uint8_t* p_patch; /* patch for i2c fix */
|
uint32_t prei2c_delay; /* the dealy after preI2C patch */
|
uint16_t len; /* i2c patch length */
|
} tNFC_HAL_PRM_I2C_FIX_CB;
|
|
/* Control block for NCI transport */
|
typedef struct {
|
uint8_t nci_ctrl_size; /* Max size for NCI messages */
|
uint8_t rcv_state; /* current rx state */
|
uint16_t rcv_len; /* bytes remaining to be received in current rx state */
|
NFC_HDR* p_rcv_msg; /* buffer to receive NCI message */
|
NFC_HDR* p_frag_msg; /* fragmented NCI message; waiting for last fragment */
|
NFC_HDR*
|
p_pend_cmd; /* pending NCI message; waiting for NFCC state to be free */
|
tNFC_HAL_NCI_RAS nci_ras; /* nci reassembly error status */
|
TIMER_LIST_ENT
|
nci_wait_rsp_timer; /* Timer for waiting for nci command response */
|
tNFC_HAL_WAIT_RSP nci_wait_rsp; /* nci wait response flag */
|
uint8_t
|
last_hdr[NFC_HAL_SAVED_HDR_SIZE]; /* part of last NCI command header */
|
uint8_t
|
last_cmd[NFC_HAL_SAVED_CMD_SIZE]; /* part of last NCI command payload */
|
void* p_vsc_cback; /* the callback function for last VSC command */
|
} tNFC_HAL_NCIT_CB;
|
|
/* Control block for device initialization */
|
typedef struct {
|
tNFC_HAL_INIT_STATE initializing_state; /* state of initializing NFCC */
|
|
uint32_t brcm_hw_id; /* BRCM NFCC HW ID */
|
tNFC_HAL_DM_CONFIG next_dm_config; /* next config in post initialization */
|
uint8_t next_startup_vsc; /* next start-up VSC offset in post init */
|
|
tNFC_HAL_POWER_MODE power_mode; /* NFCC power mode */
|
uint8_t snooze_mode; /* current snooze mode */
|
uint8_t new_snooze_mode; /* next snooze mode after receiving cmpl */
|
uint8_t nfc_wake_active_mode; /* NFC_HAL_LP_ACTIVE_LOW/HIGH */
|
TIMER_LIST_ENT lp_timer; /* timer for low power mode */
|
|
tHAL_NFC_STATUS_CBACK*
|
p_prop_cback; /* callback to notify complete of proprietary update */
|
} tNFC_HAL_DEV_CB;
|
|
#if (NFC_HAL_HCI_INCLUDED == TRUE)
|
|
/* data members for NFC_HAL-HCI */
|
typedef struct {
|
TIMER_LIST_ENT
|
hci_timer; /* Timer to avoid indefinitely waiting for response */
|
uint8_t*
|
p_hci_netwk_info_buf; /* Buffer for reading HCI Network information */
|
uint8_t* p_hci_netwk_dh_info_buf; /* Buffer for reading HCI Network DH
|
information */
|
uint8_t hci_netwk_config_block; /* Rsp awaiting for hci network configuration
|
block */
|
bool b_wait_hcp_conn_create_rsp; /* Waiting for hcp connection create response
|
*/
|
bool clear_all_pipes_to_uicc1; /* UICC1 was restarted for patch download */
|
bool update_session_id; /* Next response from NFCC is to Get Session id cmd */
|
bool hci_fw_workaround; /* HAL HCI Workaround need */
|
bool hci_fw_validate_netwk_cmd; /* Flag to indicate if hci network ntf to
|
validate */
|
uint8_t hcp_conn_id; /* NCI Connection id for HCP */
|
uint8_t dh_session_id[1]; /* Byte 0 of DH Session ID */
|
} tNFC_HAL_HCI_CB;
|
|
#endif
|
|
typedef uint8_t tNFC_HAL_FLAGS;
|
|
typedef struct {
|
tHAL_NFC_CBACK* p_stack_cback; /* Callback for HAL event notification */
|
tHAL_NFC_DATA_CBACK* p_data_cback; /* Callback for data event notification */
|
|
TIMER_LIST_Q quick_timer_queue; /* timer list queue */
|
TIMER_LIST_ENT timer; /* timer for NCI transport task */
|
|
tNFC_HAL_NCIT_CB ncit_cb; /* NCI transport */
|
tNFC_HAL_DEV_CB dev_cb; /* device initialization */
|
tNFC_HAL_NVM nvm_cb; /* Information about current patch in NVM */
|
|
/* Patchram control block */
|
tNFC_HAL_PRM_CB prm;
|
tNFC_HAL_PRM_I2C_FIX_CB prm_i2c;
|
|
#if (NFC_HAL_HCI_INCLUDED == TRUE)
|
/* data members for NFC_HAL-HCI */
|
tNFC_HAL_HCI_CB hci_cb;
|
#endif
|
|
uint8_t pre_discover_done; /* TRUE, when the prediscover config is complete */
|
tNFC_HAL_FLAGS hal_flags;
|
uint8_t pre_set_mem_idx;
|
|
uint8_t max_rf_credits; /* NFC Max RF data credits */
|
uint8_t max_ee; /* NFC Max number of NFCEE supported by NFCC */
|
} tNFC_HAL_CB;
|
|
/* Global NCI data */
|
extern tNFC_HAL_CB nfc_hal_cb;
|
|
extern uint8_t* p_nfc_hal_pre_discover_cfg;
|
|
/****************************************************************************
|
** Internal nfc functions
|
****************************************************************************/
|
|
#if (NFC_HAL_HCI_INCLUDED == TRUE)
|
/* nfc_hal_hci.c */
|
void nfc_hal_hci_enable(void);
|
void nfc_hal_hci_evt_hdlr(tNFC_HAL_HCI_EVENT_DATA* p_evt_data);
|
|
void nfc_hal_hci_handle_build_info(uint8_t chipverlen, uint8_t* p_chipverstr);
|
#else
|
#define nfc_hal_hci_enable() NFC_HAL_SET_INIT_STATE(NFC_HAL_INIT_STATE_IDLE);
|
#define nfc_hal_hci_handle_build_info(p, a)
|
#define nfc_hal_hci_evt_hdlr(p) ;
|
#endif
|
|
#endif /* NFC_HAL_INT_H */
|
