1 /****************************************************************************** 2 * 3 * Copyright (C) 2009-2013 Broadcom Corporation 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at: 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 ******************************************************************************/ 18 19 20 /****************************************************************************** 21 * 22 * this file contains the main NFC Upper Layer internal definitions and 23 * functions. 24 * 25 ******************************************************************************/ 26 27 #ifndef NFC_INT_H_ 28 #define NFC_INT_H_ 29 30 #include "nfc_target.h" 31 #include "gki.h" 32 #include "nci_defs.h" 33 #include "nfc_api.h" 34 #include "btu_api.h" 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /**************************************************************************** 41 ** Internal NFC constants and definitions 42 ****************************************************************************/ 43 44 /**************************************************************************** 45 ** NFC_TASK definitions 46 ****************************************************************************/ 47 48 /* NFC_TASK event masks */ 49 #define NFC_TASK_EVT_TRANSPORT_READY EVENT_MASK (APPL_EVT_0) 50 51 /* NFC Timer events */ 52 #define NFC_TTYPE_NCI_WAIT_RSP 0 53 #define NFC_TTYPE_WAIT_2_DEACTIVATE 1 54 55 #define NFC_TTYPE_LLCP_LINK_MANAGER 100 56 #define NFC_TTYPE_LLCP_LINK_INACT 101 57 #define NFC_TTYPE_LLCP_DATA_LINK 102 58 #define NFC_TTYPE_LLCP_DELAY_FIRST_PDU 103 59 #define NFC_TTYPE_RW_T1T_RESPONSE 104 60 #define NFC_TTYPE_RW_T2T_RESPONSE 105 61 #define NFC_TTYPE_RW_T3T_RESPONSE 106 62 #define NFC_TTYPE_RW_T4T_RESPONSE 107 63 #define NFC_TTYPE_RW_I93_RESPONSE 108 64 #define NFC_TTYPE_CE_T4T_UPDATE 109 65 #define NFC_TTYPE_VS_BASE 200 66 67 68 /* NFC Task event messages */ 69 70 enum 71 { 72 NFC_STATE_NONE, /* not start up yet */ 73 NFC_STATE_W4_HAL_OPEN, /* waiting for HAL_NFC_OPEN_CPLT_EVT */ 74 NFC_STATE_CORE_INIT, /* sending CORE_RESET and CORE_INIT */ 75 NFC_STATE_W4_POST_INIT_CPLT, /* waiting for HAL_NFC_POST_INIT_CPLT_EVT */ 76 NFC_STATE_IDLE, /* normal operation (discovery state) */ 77 NFC_STATE_OPEN, /* NFC link is activated */ 78 NFC_STATE_CLOSING, /* de-activating */ 79 NFC_STATE_W4_HAL_CLOSE, /* waiting for HAL_NFC_POST_INIT_CPLT_EVT */ 80 NFC_STATE_NFCC_POWER_OFF_SLEEP /* NFCC is power-off sleep mode */ 81 }; 82 typedef UINT8 tNFC_STATE; 83 84 /* NFC control block flags */ 85 #define NFC_FL_DEACTIVATING 0x0001 /* NFC_Deactivate () is called and the NCI cmd is not sent */ 86 #define NFC_FL_RESTARTING 0x0002 /* restarting NFCC after PowerOffSleep */ 87 #define NFC_FL_POWER_OFF_SLEEP 0x0004 /* enterning power off sleep mode */ 88 #define NFC_FL_POWER_CYCLE_NFCC 0x0008 /* Power cycle NFCC */ 89 #define NFC_FL_CONTROL_REQUESTED 0x0010 /* HAL requested control on NCI command window */ 90 #define NFC_FL_CONTROL_GRANTED 0x0020 /* NCI command window is on the HAL side */ 91 #define NFC_FL_DISCOVER_PENDING 0x0040 /* NCI command window is on the HAL side */ 92 #define NFC_FL_HAL_REQUESTED 0x0080 /* NFC_FL_CONTROL_REQUESTED on HAL request */ 93 94 #define NFC_PEND_CONN_ID 0xFE 95 #define NFC_CONN_ID_INT_MASK 0xF0 96 #define NFC_CONN_ID_ID_MASK NCI_CID_MASK 97 #define NFC_CONN_NO_FC 0xFF /* set num_buff to this for no flow control */ 98 #define NFC_NCI_CONN_NO_FC 0xFF 99 100 #if (NFC_RW_ONLY == FALSE) 101 /* only allow the entries that the NFCC can support */ 102 #define NFC_CHECK_MAX_CONN() {if (max > nfc_cb.max_conn) max = nfc_cb.max_conn;} 103 #else 104 #define NFC_CHECK_MAX_CONN() 105 #endif 106 107 typedef struct 108 { 109 tNFC_CONN_CBACK *p_cback; /* the callback function to receive the data */ 110 BUFFER_Q tx_q; /* transmit queue */ 111 BUFFER_Q rx_q; /* receive queue */ 112 UINT8 id; /* NFCEE ID or RF Discovery ID or NFC_TEST_ID */ 113 UINT8 act_protocol; /* the active protocol on this logical connection */ 114 UINT8 conn_id; /* the connection id assigned by NFCC for this conn */ 115 UINT8 buff_size; /* the max buffer size for this connection. . */ 116 UINT8 num_buff; /* num of buffers left to send on this connection */ 117 UINT8 init_credits; /* initial num of buffer credits */ 118 } tNFC_CONN_CB; 119 120 /* This data type is for NFC task to send a NCI VS command to NCIT task */ 121 typedef struct 122 { 123 BT_HDR bt_hdr; /* the NCI command */ 124 tNFC_VS_CBACK *p_cback; /* the callback function to receive RSP */ 125 } tNFC_NCI_VS_MSG; 126 127 /* This data type is for HAL event */ 128 typedef struct 129 { 130 BT_HDR hdr; 131 UINT8 hal_evt; /* HAL event code */ 132 UINT8 status; /* tHAL_NFC_STATUS */ 133 } tNFC_HAL_EVT_MSG; 134 135 #define NFC_RECEIVE_MSGS_OFFSET (10) /* callback function pointer(8; use 8 to be safe + NFC_SAVED_CMD_SIZE(2) */ 136 137 /* NFCC power state change pending callback */ 138 typedef void (tNFC_PWR_ST_CBACK) (void); 139 #define NFC_SAVED_HDR_SIZE (2) 140 /* data Reassembly error (in BT_HDR.layer_specific) */ 141 #define NFC_RAS_TOO_BIG 0x08 142 #define NFC_RAS_FRAGMENTED 0x01 143 144 /* NCI command buffer contains a VSC (in BT_HDR.layer_specific) */ 145 #define NFC_WAIT_RSP_VSC 0x01 146 147 /* NFC control blocks */ 148 typedef struct 149 { 150 UINT16 flags; /* NFC control block flags - NFC_FL_* */ 151 tNFC_CONN_CB conn_cb[NCI_MAX_CONN_CBS]; 152 UINT8 conn_id[NFC_MAX_CONN_ID+1]; /* index: conn_id; conn_id[]: index(1 based) to conn_cb[] */ 153 tNFC_DISCOVER_CBACK *p_discv_cback; 154 tNFC_RESPONSE_CBACK *p_resp_cback; 155 tNFC_TEST_CBACK *p_test_cback; 156 tNFC_VS_CBACK *p_vs_cb[NFC_NUM_VS_CBACKS];/* Register for vendor specific events */ 157 158 #if (NFC_RW_ONLY == FALSE) 159 /* NFCC information at init rsp */ 160 UINT32 nci_features; /* the NCI features supported by NFCC */ 161 UINT16 max_ce_table; /* the max routing table size */ 162 UINT8 max_conn; /* the num of connections supported by NFCC */ 163 #endif 164 UINT8 nci_ctrl_size; /* Max Control Packet Payload Size */ 165 166 const tNCI_DISCOVER_MAPS *p_disc_maps; /* NCI RF Discovery interface mapping */ 167 UINT8 vs_interface[NFC_NFCC_MAX_NUM_VS_INTERFACE]; /* the NCI VS interfaces of NFCC */ 168 UINT16 nci_interfaces; /* the NCI interfaces of NFCC */ 169 UINT8 num_disc_maps; /* number of RF Discovery interface mappings */ 170 void *p_disc_pending; /* the parameters associated with pending NFC_DiscoveryStart */ 171 172 /* NFC_TASK timer management */ 173 TIMER_LIST_Q timer_queue; /* 1-sec timer event queue */ 174 TIMER_LIST_Q quick_timer_queue; 175 176 TIMER_LIST_ENT deactivate_timer; /* Timer to wait for deactivation */ 177 178 tNFC_STATE nfc_state; 179 UINT8 trace_level; 180 UINT8 last_hdr[NFC_SAVED_HDR_SIZE];/* part of last NCI command header */ 181 UINT8 last_cmd[NFC_SAVED_CMD_SIZE];/* part of last NCI command payload */ 182 void *p_vsc_cback; /* the callback function for last VSC command */ 183 BUFFER_Q nci_cmd_xmit_q; /* NCI command queue */ 184 TIMER_LIST_ENT nci_wait_rsp_timer; /* Timer for waiting for nci command response */ 185 UINT16 nci_wait_rsp_tout; /* NCI command timeout (in ms) */ 186 UINT8 nci_wait_rsp; /* layer_specific for last NCI message */ 187 188 UINT8 nci_cmd_window; /* Number of commands the controller can accecpt without waiting for response */ 189 190 BT_HDR *p_nci_init_rsp; /* holding INIT_RSP until receiving HAL_NFC_POST_INIT_CPLT_EVT */ 191 tHAL_NFC_ENTRY *p_hal; 192 193 } tNFC_CB; 194 195 196 /***************************************************************************** 197 ** EXTERNAL FUNCTION DECLARATIONS 198 *****************************************************************************/ 199 200 /* Global NFC data */ 201 #if NFC_DYNAMIC_MEMORY == FALSE 202 NFC_API extern tNFC_CB nfc_cb; 203 #else 204 NFC_API extern tNFC_CB *nfc_cb_ptr; 205 #define nfc_cb (*nfc_cb_ptr) 206 #endif 207 208 /**************************************************************************** 209 ** Internal nfc functions 210 ****************************************************************************/ 211 212 NFC_API extern void nfc_init(void); 213 214 /* from nfc_utils.c */ 215 NFC_API extern tNFC_CONN_CB * nfc_alloc_conn_cb ( tNFC_CONN_CBACK *p_cback); 216 NFC_API extern tNFC_CONN_CB * nfc_find_conn_cb_by_conn_id (UINT8 conn_id); 217 NFC_API extern tNFC_CONN_CB * nfc_find_conn_cb_by_handle (UINT8 target_handle); 218 NFC_API extern void nfc_set_conn_id (tNFC_CONN_CB * p_cb, UINT8 conn_id); 219 NFC_API extern void nfc_free_conn_cb (tNFC_CONN_CB *p_cb); 220 NFC_API extern void nfc_reset_all_conn_cbs (void); 221 NFC_API extern void nfc_data_event (tNFC_CONN_CB * p_cb); 222 223 void nfc_ncif_send (BT_HDR *p_buf, BOOLEAN is_cmd); 224 extern UINT8 nfc_ncif_send_data (tNFC_CONN_CB *p_cb, BT_HDR *p_data); 225 NFC_API extern void nfc_ncif_cmd_timeout (void); 226 NFC_API extern void nfc_wait_2_deactivate_timeout (void); 227 228 NFC_API extern BOOLEAN nfc_ncif_process_event (BT_HDR *p_msg); 229 NFC_API extern void nfc_ncif_check_cmd_queue (BT_HDR *p_buf); 230 NFC_API extern void nfc_ncif_send_cmd (BT_HDR *p_buf); 231 NFC_API extern void nfc_ncif_proc_discover_ntf (UINT8 *p, UINT16 plen); 232 NFC_API extern void nfc_ncif_rf_management_status (tNFC_DISCOVER_EVT event, UINT8 status); 233 NFC_API extern void nfc_ncif_set_config_status (UINT8 *p, UINT8 len); 234 NFC_API extern void nfc_ncif_event_status (tNFC_RESPONSE_EVT event, UINT8 status); 235 NFC_API extern void nfc_ncif_error_status (UINT8 conn_id, UINT8 status); 236 NFC_API extern void nfc_ncif_proc_credits(UINT8 *p, UINT16 plen); 237 NFC_API extern void nfc_ncif_proc_activate (UINT8 *p, UINT8 len); 238 NFC_API extern void nfc_ncif_proc_deactivate (UINT8 status, UINT8 deact_type, BOOLEAN is_ntf); 239 #if ((NFC_NFCEE_INCLUDED == TRUE) && (NFC_RW_ONLY == FALSE)) 240 NFC_API extern void nfc_ncif_proc_ee_action (UINT8 *p, UINT16 plen); 241 NFC_API extern void nfc_ncif_proc_ee_discover_req (UINT8 *p, UINT16 plen); 242 NFC_API extern void nfc_ncif_proc_get_routing (UINT8 *p, UINT8 len); 243 #endif 244 NFC_API extern void nfc_ncif_proc_conn_create_rsp (UINT8 *p, UINT16 plen, UINT8 dest_type); 245 NFC_API extern void nfc_ncif_report_conn_close_evt (UINT8 conn_id, tNFC_STATUS status); 246 NFC_API extern void nfc_ncif_proc_t3t_polling_ntf (UINT8 *p, UINT16 plen); 247 NFC_API extern void nfc_ncif_proc_reset_rsp (UINT8 *p, BOOLEAN is_ntf); 248 NFC_API extern void nfc_ncif_proc_init_rsp (BT_HDR *p_msg); 249 NFC_API extern void nfc_ncif_proc_get_config_rsp (BT_HDR *p_msg); 250 NFC_API extern void nfc_ncif_proc_data (BT_HDR *p_msg); 251 252 #if (NFC_RW_ONLY == FALSE) 253 NFC_API extern void nfc_ncif_proc_rf_field_ntf (UINT8 rf_status); 254 #else 255 #define nfc_ncif_proc_rf_field_ntf(rf_status) 256 #endif 257 258 /* From nfc_task.c */ 259 NFC_API extern UINT32 nfc_task (UINT32 param); 260 void nfc_task_shutdown_nfcc (void); 261 262 /* From nfc_main.c */ 263 void nfc_enabled (tNFC_STATUS nfc_status, BT_HDR *p_init_rsp_msg); 264 void nfc_set_state (tNFC_STATE nfc_state); 265 void nfc_main_flush_cmd_queue (void); 266 void nfc_gen_cleanup (void); 267 void nfc_main_handle_hal_evt (tNFC_HAL_EVT_MSG *p_msg); 268 269 /* Timer functions */ 270 void nfc_start_timer (TIMER_LIST_ENT *p_tle, UINT16 type, UINT32 timeout); 271 UINT32 nfc_remaining_time (TIMER_LIST_ENT *p_tle); 272 void nfc_stop_timer (TIMER_LIST_ENT *p_tle); 273 274 void nfc_start_quick_timer (TIMER_LIST_ENT *p_tle, UINT16 type, UINT32 timeout); 275 void nfc_stop_quick_timer (TIMER_LIST_ENT *p_tle); 276 void nfc_process_quick_timer_evt (void); 277 278 279 #ifdef __cplusplus 280 } 281 #endif 282 283 #endif /* NFC_INT_H_ */ 284