/*******************************************************************************
**
** Function nfc_hal_dm_shutting_down_nfcc
**
** Description This function initializes Broadcom specific control blocks for
** NCI transport
**
** Returns void
**
*******************************************************************************/
void nfc_hal_dm_shutting_down_nfcc (void)
{
HAL_TRACE_DEBUG0 ("nfc_hal_dm_shutting_down_nfcc ()");
nfc_hal_cb.dev_cb.initializing_state = NFC_HAL_INIT_STATE_CLOSING;
/* reset low power mode variables */
if ( (nfc_hal_cb.dev_cb.power_mode == NFC_HAL_POWER_MODE_FULL)
&&(nfc_hal_cb.dev_cb.snooze_mode != NFC_HAL_LP_SNOOZE_MODE_NONE) )
{
nfc_hal_dm_set_nfc_wake (NFC_HAL_ASSERT_NFC_WAKE);
}
nfc_hal_cb.ncit_cb.nci_wait_rsp = NFC_HAL_WAIT_RSP_NONE;
nfc_hal_cb.dev_cb.power_mode = NFC_HAL_POWER_MODE_FULL;
nfc_hal_cb.dev_cb.snooze_mode = NFC_HAL_LP_SNOOZE_MODE_NONE;
/* Stop all timers */
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.ncit_cb.nci_wait_rsp_timer);
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.dev_cb.lp_timer);
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.prm.timer);
#if (defined(NFC_HAL_HCI_INCLUDED) && (NFC_HAL_HCI_INCLUDED == TRUE))
nfc_hal_cb.hci_cb.hcp_conn_id = 0;
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.hci_cb.hci_timer);
#endif
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.timer);
}
/*******************************************************************************
**
** Function nfc_hal_prm_spd_reset_ntf
**
** Description Received RESET NTF from NFCC, indicating it has completed
** reset after patch download.
**
** Returns void
**
*******************************************************************************/
void nfc_hal_prm_spd_reset_ntf (UINT8 reset_reason, UINT8 reset_type)
{
/* Check if we were expecting a RESET NTF */
if (nfc_hal_cb.prm.state == NFC_HAL_PRM_ST_SPD_AUTH_DONE)
{
HAL_TRACE_DEBUG2 ("Received RESET NTF after patch download (reset_reason=%i, reset_type=%i)", reset_reason, reset_type);
/* Stop waiting for RESET NTF */
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.prm.timer);
{
/* Continue with patch download */
nfc_hal_prm_nfcc_ready_to_continue ();
}
}
else if (nfc_hal_cb.prm.state == NFC_HAL_PRM_ST_SPD_GET_PATCH_HEADER)
{
HAL_TRACE_DEBUG0 ("Received RESET NTF after pre-I2C patch download. Proceeding with patch download...");
/* Stop waiting for RESET NTF */
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.prm.timer);
nfc_hal_prm_spd_handle_next_patch_start ();
}
else
{
HAL_TRACE_ERROR2 ("Received unexpected RESET NTF (reset_reason=%i, reset_type=%i)", reset_reason, reset_type);
}
}
/*******************************************************************************
**
** Function nfc_hal_main_userial_cback
**
** Description USERIAL callback for NCI transport
**
** Returns nothing
**
*******************************************************************************/
static void nfc_hal_main_userial_cback (tUSERIAL_PORT port, tUSERIAL_EVT evt, tUSERIAL_EVT_DATA *p_data)
{
if (evt == USERIAL_RX_READY_EVT)
{
/* Notify transport task of serial port event */
GKI_send_event (NFC_HAL_TASK, NFC_HAL_TASK_EVT_DATA_RDY);
}
else if (evt == USERIAL_TX_DONE_EVT)
{
/* Serial driver has finshed sending data from USERIAL_Write */
/* Currently, no action is needed for this event */
}
else if (evt == USERIAL_ERR_EVT)
{
HAL_TRACE_ERROR0 ("nfc_hal_main_userial_cback: USERIAL_ERR_EVT. Notifying NFC_TASK of transport error");
if (nfc_hal_cb.ncit_cb.nci_wait_rsp != NFC_HAL_WAIT_RSP_NONE)
{
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.ncit_cb.nci_wait_rsp_timer);
nfc_hal_nci_cmd_timeout_cback ((void *)&nfc_hal_cb.ncit_cb.nci_wait_rsp_timer);
}
else
{
nfc_hal_main_send_error (HAL_NFC_STATUS_ERR_TRANSPORT);
}
}
else if (evt == USERIAL_WAKEUP_EVT)
{
HAL_TRACE_DEBUG1 ("nfc_hal_main_userial_cback: USERIAL_WAKEUP_EVT: %d", p_data->sigs);
}
else
{
HAL_TRACE_DEBUG1 ("nfc_hal_main_userial_cback: unhandled userial evt: %i", evt);
}
}
/*******************************************************************************
**
** Function nfc_hal_dm_set_snooze_mode_cback
**
** Description This is snooze update complete callback.
**
** Returns void
**
*******************************************************************************/
static void nfc_hal_dm_set_snooze_mode_cback (tNFC_HAL_BTVSC_CPLT *pData)
{
UINT8 status = pData->p_param_buf[0];
tHAL_NFC_STATUS hal_status;
tHAL_NFC_STATUS_CBACK *p_cback;
/* if it is completed */
if (status == HCI_SUCCESS)
{
/* update snooze mode */
nfc_hal_cb.dev_cb.snooze_mode = nfc_hal_cb.dev_cb.new_snooze_mode;
nfc_hal_dm_set_nfc_wake (NFC_HAL_ASSERT_NFC_WAKE);
if ( nfc_hal_cb.dev_cb.snooze_mode != NFC_HAL_LP_SNOOZE_MODE_NONE)
{
/* start idle timer */
nfc_hal_main_start_quick_timer (&nfc_hal_cb.dev_cb.lp_timer, 0x00,
((UINT32) NFC_HAL_LP_IDLE_TIMEOUT) * QUICK_TIMER_TICKS_PER_SEC / 1000);
}
else
{
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.dev_cb.lp_timer);
}
hal_status = HAL_NFC_STATUS_OK;
}
else
{
hal_status = HAL_NFC_STATUS_FAILED;
}
if (nfc_hal_cb.dev_cb.p_prop_cback)
{
p_cback = nfc_hal_cb.dev_cb.p_prop_cback;
nfc_hal_cb.dev_cb.p_prop_cback = NULL;
(*p_cback) (hal_status);
}
}
/*******************************************************************************
**
** Function nfc_hal_prm_nci_command_complete_cback
**
** Description Callback for NCI vendor specific command complete
** (for secure patch download)
**
** Returns void
**
*******************************************************************************/
void nfc_hal_prm_nci_command_complete_cback (tNFC_HAL_NCI_EVT event, UINT16 data_len, UINT8 *p_data)
{
UINT8 status, u8;
UINT8 *p;
UINT32 post_signature_delay;
NFC_HAL_PRM_STATE ("nfc_hal_prm_nci_command_complete_cback");
/* Stop the command-timeout timer */
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.prm.timer);
/* Skip over NCI header */
p = p_data + NCI_MSG_HDR_SIZE;
/* Handle SECURE_PATCH_DOWNLOAD Rsp */
if (event == NFC_VS_SEC_PATCH_DOWNLOAD_EVT)
{
/* Status and error code */
STREAM_TO_UINT8 (status, p);
STREAM_TO_UINT8 (u8, p);
if (status != NCI_STATUS_OK)
{
#if (NFC_HAL_TRACE_VERBOSE == TRUE)
HAL_TRACE_ERROR2 ("Patch download failed, reason code=0x%X (%s)", status, nfc_hal_prm_spd_status_str (status));
#else
HAL_TRACE_ERROR1 ("Patch download failed, reason code=0x%X", status);
#endif
/* Notify application */
nfc_hal_prm_spd_handle_download_complete (NFC_HAL_PRM_ABORT_INVALID_PATCH_EVT);
return;
}
/* If last segment (SIGNATURE) sent */
if (nfc_hal_cb.prm.flags & NFC_HAL_PRM_FLAGS_SIGNATURE_SENT)
{
/* Wait for authentication complete (SECURE_PATCH_DOWNLOAD NTF), including time to commit to NVM (for BCM43341B0) */
int auth_delay = NFC_HAL_PRM_SPD_TOUT;
if (!(nfc_hal_cb.prm.flags & NFC_HAL_PRM_FLAGS_BCM20791B3))
{
/* XXX maco only wait 30 seconds for B4+ revisions to avoid watchdog timeouts */
auth_delay = NFC_HAL_PRM_COMMIT_DELAY;
}
nfc_hal_cb.prm.state = NFC_HAL_PRM_ST_SPD_AUTHENTICATING;
nfc_hal_main_start_quick_timer (&nfc_hal_cb.prm.timer, 0x00,
(auth_delay * QUICK_TIMER_TICKS_PER_SEC) / 1000);
return;
}
/* Download next segment */
else if (nfc_hal_cb.prm.flags & NFC_HAL_PRM_FLAGS_USE_PATCHRAM_BUF)
{
/* If patch is in a buffer, get next patch from buffer */
nfc_hal_prm_spd_send_next_segment ();
}
else
{
/* Notify adaptation layer to get next patch segment (via HAL_NfcPrmDownloadContinue) */
(nfc_hal_cb.prm.p_cback) (NFC_HAL_PRM_CONTINUE_EVT);
}
}
/* Handle SECURE_PATCH_DOWNLOAD NTF */
else if (event == NFC_VS_SEC_PATCH_AUTH_EVT)
{
HAL_TRACE_DEBUG1 ("prm flags:0x%x.", nfc_hal_cb.prm.flags);
/* Status and error code */
STREAM_TO_UINT8 (status, p);
STREAM_TO_UINT8 (u8, p);
/* Sanity check - should only get this NTF while in AUTHENTICATING stage */
if (nfc_hal_cb.prm.state == NFC_HAL_PRM_ST_SPD_AUTHENTICATING)
{
if (status != NCI_STATUS_OK)
{
HAL_TRACE_ERROR0 ("Patch authentication failed");
nfc_hal_prm_spd_handle_download_complete (NFC_HAL_PRM_ABORT_BAD_SIGNATURE_EVT);
return;
}
#if (defined (NFC_HAL_PRE_I2C_PATCH_INCLUDED) && (NFC_HAL_PRE_I2C_PATCH_INCLUDED == TRUE))
if (nfc_hal_cb.prm.flags & NFC_HAL_PRM_FLAGS_I2C_FIX_REQUIRED)
{
HAL_TRACE_DEBUG1 ("PreI2C patch downloaded...waiting %i ms for NFCC to reboot.", nfc_hal_cb.prm_i2c.prei2c_delay);
/* Restore pointers to patchfile */
nfc_hal_cb.prm.flags &= ~NFC_HAL_PRM_FLAGS_I2C_FIX_REQUIRED;
nfc_hal_cb.prm.p_cur_patch_data = nfc_hal_cb.prm.p_spd_patch;
nfc_hal_cb.prm.cur_patch_offset = nfc_hal_cb.prm.spd_patch_offset;
nfc_hal_cb.prm.cur_patch_len_remaining = nfc_hal_cb.prm.spd_patch_len_remaining;
/* Resume normal patch download */
nfc_hal_cb.prm.state = NFC_HAL_PRM_ST_SPD_GET_PATCH_HEADER;
nfc_hal_cb.prm.flags &= ~NFC_HAL_PRM_FLAGS_SIGNATURE_SENT;
/* Post PreI2C delay */
nfc_hal_main_start_quick_timer (&nfc_hal_cb.prm.timer, 0x00, (nfc_hal_cb.prm_i2c.prei2c_delay * QUICK_TIMER_TICKS_PER_SEC) / 1000);
return;
}
#endif /* NFC_HAL_PRE_I2C_PATCH_INCLUDED */
/* Wait for NFCC to save the patch to NVM */
if (!(nfc_hal_cb.prm.flags & NFC_HAL_PRM_FLAGS_BCM20791B3))
{
/* 20791B4 or newer - wait for RESET_NTF; including time to commit to NVM (for BCM20791B4+) */
post_signature_delay = NFC_HAL_PRM_COMMIT_DELAY;
HAL_TRACE_DEBUG1 ("Patch downloaded and authenticated. Waiting %i ms for RESET NTF...", post_signature_delay);
}
else if (nfc_hal_cb.nvm_cb.flags & NFC_HAL_NVM_FLAGS_NO_NVM)
{
/* No NVM. Wait for NFCC to restart */
post_signature_delay = NFC_HAL_PRM_END_DELAY;
HAL_TRACE_DEBUG1 ("Patch downloaded and authenticated. Waiting %i ms for NFCC to restart...", post_signature_delay);
}
else
{
/* Wait for NFCC to save the patch to NVM (need about 1 ms per byte) */
post_signature_delay = nfc_hal_cb.prm.spd_patch_desc[nfc_hal_cb.prm.spd_cur_patch_idx].len;
if (post_signature_delay < nfc_hal_cb.prm.patchram_delay)
post_signature_delay = nfc_hal_cb.prm.patchram_delay;
HAL_TRACE_DEBUG1 ("Patch downloaded and authenticated. Waiting %i ms for NVM update to complete...", post_signature_delay);
}
nfc_hal_cb.prm.state = NFC_HAL_PRM_ST_SPD_AUTH_DONE;
nfc_hal_main_start_quick_timer (&nfc_hal_cb.prm.timer, 0x00,
(post_signature_delay * QUICK_TIMER_TICKS_PER_SEC) / 1000);
}
else
{
HAL_TRACE_ERROR0 ("Got unexpected SECURE_PATCH_DOWNLOAD NTF");
nfc_hal_prm_spd_handle_download_complete (NFC_HAL_PRM_ABORT_EVT);
}
}
/* Handle NCI_MSG_GET_PATCH_VERSION RSP */
else if (event == NFC_VS_GET_PATCH_VERSION_EVT)
{
nfc_hal_prm_spd_handle_download_complete (NFC_HAL_PRM_COMPLETE_EVT);
}
else
{
/* Invalid response from NFCC during patch download */
HAL_TRACE_ERROR1 ("Invalid response from NFCC during patch download (opcode=0x%02X)", event);
nfc_hal_prm_spd_handle_download_complete (NFC_HAL_PRM_ABORT_INVALID_PATCH_EVT);
}
NFC_HAL_PRM_STATE ("prm_nci_command_complete_cback");
}
/*******************************************************************************
**
** Function nfa_hal_pre_discover_done_cback
**
** Description Pre-discovery CFG is sent.
**
** Returns nothing
**
*******************************************************************************/
void nfa_hal_pre_discover_done_cback (tNFC_HAL_NCI_EVT event, UINT16 data_len, UINT8 *p_data)
{
NFC_HAL_SET_INIT_STATE(NFC_HAL_INIT_STATE_IDLE);
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.ncit_cb.nci_wait_rsp_timer);
nfc_hal_cb.p_stack_cback (HAL_NFC_PRE_DISCOVER_CPLT_EVT, HAL_NFC_STATUS_OK);
}
/*******************************************************************************
**
** Function nfc_hal_dm_proc_msg_during_init
**
** Description Process NCI message while initializing NFCC
**
** Returns void
**
*******************************************************************************/
void nfc_hal_dm_proc_msg_during_init (NFC_HDR *p_msg)
{
UINT8 *p;
UINT8 reset_reason, reset_type;
UINT8 mt, pbf, gid, op_code;
UINT8 *p_old, old_gid, old_oid, old_mt;
UINT8 u8;
tNFC_HAL_NCI_CBACK *p_cback = NULL;
UINT8 chipverlen;
UINT8 chipverstr[NCI_SPD_HEADER_CHIPVER_LEN];
UINT32 hw_id = 0;
HAL_TRACE_DEBUG1 ("nfc_hal_dm_proc_msg_during_init(): init state:%d", nfc_hal_cb.dev_cb.initializing_state);
p = (UINT8 *) (p_msg + 1) + p_msg->offset;
NCI_MSG_PRS_HDR0 (p, mt, pbf, gid);
NCI_MSG_PRS_HDR1 (p, op_code);
/* check if waiting for this response */
if ( (nfc_hal_cb.ncit_cb.nci_wait_rsp == NFC_HAL_WAIT_RSP_CMD)
||(nfc_hal_cb.ncit_cb.nci_wait_rsp == NFC_HAL_WAIT_RSP_VSC) )
{
if (mt == NCI_MT_RSP)
{
p_old = nfc_hal_cb.ncit_cb.last_hdr;
NCI_MSG_PRS_HDR0 (p_old, old_mt, pbf, old_gid);
old_oid = ((*p_old) & NCI_OID_MASK);
/* make sure this is the RSP we are waiting for before updating the command window */
if ((old_gid == gid) && (old_oid == op_code))
{
nfc_hal_cb.ncit_cb.nci_wait_rsp = NFC_HAL_WAIT_RSP_NONE;
p_cback = (tNFC_HAL_NCI_CBACK *)nfc_hal_cb.ncit_cb.p_vsc_cback;
nfc_hal_cb.ncit_cb.p_vsc_cback = NULL;
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.ncit_cb.nci_wait_rsp_timer);
}
}
}
if (gid == NCI_GID_CORE)
{
if (op_code == NCI_MSG_CORE_RESET)
{
if (mt == NCI_MT_NTF)
{
if ( (nfc_hal_cb.dev_cb.initializing_state == NFC_HAL_INIT_STATE_W4_NFCC_ENABLE)
||(nfc_hal_cb.dev_cb.initializing_state == NFC_HAL_INIT_STATE_POST_XTAL_SET) )
{
/*
** Core reset ntf in the following cases;
** 1) after power up (raising REG_PU)
** 2) after setting xtal index
** Start pre-initializing NFCC
*/
nfc_hal_main_stop_quick_timer (&nfc_hal_cb.timer);
nfc_hal_dm_pre_init_nfcc ();
}
else
{
/* Core reset ntf after post-patch download, Call reset notification callback */
p++; /* Skip over param len */
STREAM_TO_UINT8 (reset_reason, p);
STREAM_TO_UINT8 (reset_type, p);
nfc_hal_prm_spd_reset_ntf (reset_reason, reset_type);
}
}
}
else if (p_cback)
{
(*p_cback) ((tNFC_HAL_NCI_EVT) (op_code),
p_msg->len,
(UINT8 *) (p_msg + 1) + p_msg->offset);
}
}
else if (gid == NCI_GID_PROP) /* this is for download patch */
{
if (mt == NCI_MT_NTF)
op_code |= NCI_NTF_BIT;
else
op_code |= NCI_RSP_BIT;
if (nfc_hal_cb.dev_cb.initializing_state == NFC_HAL_INIT_STATE_W4_XTAL_SET)
{
if (op_code == (NCI_RSP_BIT|NCI_MSG_GET_XTAL_INDEX_FROM_DH))
{
/* start timer in case that NFCC doesn't send RESET NTF after loading patch from NVM */
NFC_HAL_SET_INIT_STATE (NFC_HAL_INIT_STATE_POST_XTAL_SET);
nfc_hal_main_start_quick_timer (&nfc_hal_cb.timer, NFC_HAL_TTYPE_NFCC_ENABLE,
((p_nfc_hal_cfg->nfc_hal_post_xtal_timeout)*QUICK_TIMER_TICKS_PER_SEC)/1000);
}
}
else if ( (op_code == NFC_VS_GET_BUILD_INFO_EVT)
&&(nfc_hal_cb.dev_cb.initializing_state == NFC_HAL_INIT_STATE_W4_BUILD_INFO) )
{
p += NCI_BUILD_INFO_OFFSET_HWID;
STREAM_TO_UINT32 (hw_id, p);
nfc_hal_cb.dev_cb.brcm_hw_id = nfc_hal_dm_adjust_hw_id (hw_id);
HAL_TRACE_DEBUG2 ("brcm_hw_id: 0x%x -> 0x%x", hw_id, nfc_hal_cb.dev_cb.brcm_hw_id);
STREAM_TO_UINT8 (chipverlen, p);
memset (chipverstr, 0, NCI_SPD_HEADER_CHIPVER_LEN);
STREAM_TO_ARRAY (chipverstr, p, chipverlen);
nfc_hal_hci_handle_build_info (chipverlen, chipverstr);
nfc_hal_cb.pre_set_mem_idx = 0;
if (!nfc_hal_dm_check_pre_set_mem())
{
/* pre-set mem started */
return;
}
nfc_hal_dm_check_xtal();
}
else if ( (op_code == NFC_VS_GET_PATCH_VERSION_EVT)
&&(nfc_hal_cb.dev_cb.initializing_state == NFC_HAL_INIT_STATE_W4_PATCH_INFO) )
{
/* Store NVM info to control block */
/* Skip over rsp len */
p++;
/* Get project id */
STREAM_TO_UINT16 (nfc_hal_cb.nvm_cb.project_id, p);
/* RFU */
p++;
/* Get chip version string */
STREAM_TO_UINT8 (u8, p);
if (u8 > NFC_HAL_PRM_MAX_CHIP_VER_LEN)
u8 = NFC_HAL_PRM_MAX_CHIP_VER_LEN;
memcpy (nfc_hal_cb.nvm_cb.chip_ver, p, u8);
p += NCI_PATCH_INFO_VERSION_LEN;
/* Get major/minor version */
STREAM_TO_UINT16 (nfc_hal_cb.nvm_cb.ver_major, p);
STREAM_TO_UINT16 (nfc_hal_cb.nvm_cb.ver_minor, p);
/* Skip over max_size and patch_max_size */
p += 4;
/* Get current lpm patch size */
STREAM_TO_UINT16 (nfc_hal_cb.nvm_cb.lpm_size, p);
STREAM_TO_UINT16 (nfc_hal_cb.nvm_cb.fpm_size, p);
/* clear all flags which may be set during previous initialization */
nfc_hal_cb.nvm_cb.flags = 0;
/* Set patch present flag */
if ((nfc_hal_cb.nvm_cb.fpm_size) || (nfc_hal_cb.nvm_cb.lpm_size))
nfc_hal_cb.nvm_cb.flags |= NFC_HAL_NVM_FLAGS_PATCH_PRESENT;
/* LPMPatchCodeHasBadCRC (if not bad crc, then indicate LPM patch is present in nvm) */
STREAM_TO_UINT8 (u8, p);
if (u8)
{
/* LPM patch in NVM fails CRC check */
nfc_hal_cb.nvm_cb.flags |= NFC_HAL_NVM_FLAGS_LPM_BAD;
}
/* FPMPatchCodeHasBadCRC (if not bad crc, then indicate LPM patch is present in nvm) */
STREAM_TO_UINT8 (u8, p);
if (u8)
{
/* FPM patch in NVM fails CRC check */
nfc_hal_cb.nvm_cb.flags |= NFC_HAL_NVM_FLAGS_FPM_BAD;
}
/* Check if downloading patch to RAM only (no NVM) */
STREAM_TO_UINT8 (nfc_hal_cb.nvm_cb.nvm_type, p);
if (nfc_hal_cb.nvm_cb.nvm_type == NCI_SPD_NVM_TYPE_NONE)
{
nfc_hal_cb.nvm_cb.flags |= NFC_HAL_NVM_FLAGS_NO_NVM;
}
/* let platform update baudrate or download patch */
NFC_HAL_SET_INIT_STATE (NFC_HAL_INIT_STATE_W4_APP_COMPLETE);
nfc_hal_post_reset_init (nfc_hal_cb.dev_cb.brcm_hw_id, nfc_hal_cb.nvm_cb.nvm_type);
}
else if (p_cback)
{
(*p_cback) ((tNFC_HAL_NCI_EVT) (op_code),
p_msg->len,
(UINT8 *) (p_msg + 1) + p_msg->offset);
}
else if (op_code == NFC_VS_SEC_PATCH_AUTH_EVT)
{
HAL_TRACE_DEBUG0 ("signature!!");
nfc_hal_prm_nci_command_complete_cback ((tNFC_HAL_NCI_EVT) (op_code),
p_msg->len,
(UINT8 *) (p_msg + 1) + p_msg->offset);
}
}
}
