1 /****************************************************************************** 2 * 3 * Copyright (C) 2009-2014 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 * this file contains the main NFC Upper Layer internal definitions and 22 * functions. 23 * 24 ******************************************************************************/ 25 26 #ifndef NFC_INT_H_ 27 #define NFC_INT_H_ 28 29 #include "gki.h" 30 #include "nci_defs.h" 31 #include "nfc_api.h" 32 #include "nfc_target.h" 33 34 /**************************************************************************** 35 ** Internal NFC constants and definitions 36 ****************************************************************************/ 37 38 /**************************************************************************** 39 ** NFC_TASK definitions 40 ****************************************************************************/ 41 42 /* NFC_TASK event masks */ 43 #define NFC_TASK_EVT_TRANSPORT_READY EVENT_MASK(APPL_EVT_0) 44 45 /* NFC Timer events */ 46 #define NFC_TTYPE_NCI_WAIT_RSP 0 47 #define NFC_TTYPE_WAIT_2_DEACTIVATE 1 48 #define NFC_WAIT_RSP_RAW_VS 0x02 49 #define NFC_TTYPE_WAIT_MODE_SET_NTF 2 50 51 #define NFC_TTYPE_LLCP_LINK_MANAGER 100 52 #define NFC_TTYPE_LLCP_LINK_INACT 101 53 #define NFC_TTYPE_LLCP_DATA_LINK 102 54 #define NFC_TTYPE_LLCP_DELAY_FIRST_PDU 103 55 #define NFC_TTYPE_RW_T1T_RESPONSE 104 56 #define NFC_TTYPE_RW_T2T_RESPONSE 105 57 #define NFC_TTYPE_RW_T3T_RESPONSE 106 58 #define NFC_TTYPE_RW_T4T_RESPONSE 107 59 #define NFC_TTYPE_RW_I93_RESPONSE 108 60 #define NFC_TTYPE_CE_T4T_UPDATE 109 61 /* added for p2p prio logic timer */ 62 #define NFC_TTYPE_P2P_PRIO_RESPONSE 110 63 /* added for p2p prio logic clenaup */ 64 #define NFC_TTYPE_P2P_PRIO_LOGIC_CLEANUP 111 65 #define NFC_TTYPE_RW_MFC_RESPONSE 112 66 /* time out for mode set notification */ 67 #define NFC_MODE_SET_NTF_TIMEOUT 2 68 /* NFC Task event messages */ 69 70 enum { 71 NFC_STATE_NONE, /* not start up yet */ 72 NFC_STATE_W4_HAL_OPEN, /* waiting for HAL_NFC_OPEN_CPLT_EVT */ 73 NFC_STATE_CORE_INIT, /* sending CORE_RESET and CORE_INIT */ 74 NFC_STATE_W4_POST_INIT_CPLT, /* waiting for HAL_NFC_POST_INIT_CPLT_EVT */ 75 NFC_STATE_IDLE, /* normal operation (discovery state) */ 76 NFC_STATE_OPEN, /* NFC link is activated */ 77 NFC_STATE_CLOSING, /* de-activating */ 78 NFC_STATE_W4_HAL_CLOSE, /* waiting for HAL_NFC_POST_INIT_CPLT_EVT */ 79 NFC_STATE_NFCC_POWER_OFF_SLEEP /* NFCC is power-off sleep mode */ 80 }; 81 typedef uint8_t tNFC_STATE; 82 83 /* DM P2P Priority event type */ 84 enum { 85 NFA_DM_P2P_PRIO_RSP = 0x01, /* P2P priority event from RSP */ 86 NFA_DM_P2P_PRIO_NTF /* P2P priority event from NTF */ 87 }; 88 89 /* NFC control block flags */ 90 /* NFC_Deactivate () is called and the NCI cmd is not sent */ 91 #define NFC_FL_DEACTIVATING 0x0001 92 /* restarting NFCC after PowerOffSleep */ 93 #define NFC_FL_RESTARTING 0x0002 94 /* enterning power off sleep mode */ 95 #define NFC_FL_POWER_OFF_SLEEP 0x0004 96 /* Power cycle NFCC */ 97 #define NFC_FL_POWER_CYCLE_NFCC 0x0008 98 /* HAL requested control on NCI command window */ 99 #define NFC_FL_CONTROL_REQUESTED 0x0010 100 /* NCI command window is on the HAL side */ 101 #define NFC_FL_CONTROL_GRANTED 0x0020 102 /* NCI command window is on the HAL side */ 103 #define NFC_FL_DISCOVER_PENDING 0x0040 104 /* NFC_FL_CONTROL_REQUESTED on HAL request */ 105 #define NFC_FL_HAL_REQUESTED 0x0080 106 /* Waiting for NFCEE Mode Set NTF */ 107 #define NFC_FL_WAIT_MODE_SET_NTF 0x0100 108 109 #define NFC_PEND_CONN_ID 0xFE 110 #define NFC_CONN_ID_ID_MASK NCI_CID_MASK 111 /* set num_buff to this for no flow control */ 112 #define NFC_CONN_NO_FC 0xFF 113 114 #if (NFC_RW_ONLY == FALSE) 115 /* only allow the entries that the NFCC can support */ 116 #define NFC_CHECK_MAX_CONN() \ 117 { \ 118 if (max > nfc_cb.max_conn) max = nfc_cb.max_conn; \ 119 } 120 #else 121 #define NFC_CHECK_MAX_CONN() 122 #endif 123 124 typedef struct { 125 tNFC_CONN_CBACK* p_cback; /* the callback function to receive the data */ 126 BUFFER_Q tx_q; /* transmit queue */ 127 BUFFER_Q rx_q; /* receive queue */ 128 uint8_t id; /* NFCEE ID or RF Discovery ID or NFC_TEST_ID */ 129 uint8_t act_protocol; /* the active protocol on this logical connection */ 130 uint8_t act_interface; /* the active interface on this logical connection */ 131 uint8_t conn_id; /* the connection id assigned by NFCC for this conn */ 132 uint8_t buff_size; /* the max buffer size for this connection. . */ 133 uint8_t num_buff; /* num of buffers left to send on this connection */ 134 uint8_t init_credits; /* initial num of buffer credits */ 135 } tNFC_CONN_CB; 136 137 /* This data type is for NFC task to send a NCI VS command to NCIT task */ 138 typedef struct { 139 NFC_HDR bt_hdr; /* the NCI command */ 140 tNFC_VS_CBACK* p_cback; /* the callback function to receive RSP */ 141 } tNFC_NCI_VS_MSG; 142 143 /* This data type is for HAL event */ 144 typedef struct { 145 NFC_HDR hdr; 146 uint8_t hal_evt; /* HAL event code */ 147 uint8_t status; /* tHAL_NFC_STATUS */ 148 } tNFC_HAL_EVT_MSG; 149 150 /* callback function pointer(8; use 8 to be safe + NFC_SAVED_CMD_SIZE(2) */ 151 #define NFC_RECEIVE_MSGS_OFFSET (10) 152 153 #define NFC_SAVED_HDR_SIZE (2) 154 /* data Reassembly error (in NFC_HDR.layer_specific) */ 155 #define NFC_RAS_TOO_BIG 0x08 156 #define NFC_RAS_FRAGMENTED 0x01 157 158 /* NCI command buffer contains a VSC (in NFC_HDR.layer_specific) */ 159 #define NFC_WAIT_RSP_VSC 0x01 160 161 /* NFC control blocks */ 162 typedef struct { 163 uint16_t flags; /* NFC control block flags - NFC_FL_* */ 164 tNFC_CONN_CB conn_cb[NCI_MAX_CONN_CBS]; 165 uint8_t conn_id[NFC_MAX_CONN_ID + 1]; /* index: conn_id; conn_id[]: index(1 166 based) to conn_cb[] */ 167 tNFC_DISCOVER_CBACK* p_discv_cback; 168 tNFC_RESPONSE_CBACK* p_resp_cback; 169 tNFC_TEST_CBACK* p_test_cback; 170 tNFC_VS_CBACK* 171 p_vs_cb[NFC_NUM_VS_CBACKS]; /* Register for vendor specific events */ 172 173 #if (NFC_RW_ONLY == FALSE) 174 /* NFCC information at init rsp */ 175 uint32_t nci_features; /* the NCI features supported by NFCC */ 176 uint16_t max_ce_table; /* the max routing table size */ 177 uint8_t max_conn; /* the num of connections supported by NFCC */ 178 #endif 179 uint8_t nci_ctrl_size; /* Max Control Packet Payload Size */ 180 181 const tNCI_DISCOVER_MAPS* 182 p_disc_maps; /* NCI RF Discovery interface mapping */ 183 uint8_t vs_interface 184 [NFC_NFCC_MAX_NUM_VS_INTERFACE]; /* the NCI VS interfaces of NFCC */ 185 uint16_t nci_interfaces; /* the NCI interfaces of NFCC */ 186 uint8_t nci_intf_extensions; 187 uint8_t nci_intf_extension_map[NCI_INTERFACE_EXTENSION_MAX]; 188 uint8_t num_disc_maps; /* number of RF Discovery interface mappings */ 189 void* p_disc_pending; /* the parameters associated with pending 190 NFC_DiscoveryStart */ 191 192 /* NFC_TASK timer management */ 193 TIMER_LIST_Q timer_queue; /* 1-sec timer event queue */ 194 TIMER_LIST_Q quick_timer_queue; 195 TIMER_LIST_ENT mode_set_ntf_timer; /* Timer to wait for deactivation */ 196 TIMER_LIST_ENT deactivate_timer; /* Timer to wait for deactivation */ 197 198 tNFC_STATE nfc_state; 199 bool reassembly; /* Reassemble fragmented data pkt */ 200 uint8_t last_hdr[NFC_SAVED_HDR_SIZE]; /* part of last NCI command header */ 201 uint8_t last_cmd[NFC_SAVED_CMD_SIZE]; /* part of last NCI command payload */ 202 uint8_t 203 last_nfcee_cmd[NFC_SAVED_CMD_SIZE]; /* part of last NCI command payload */ 204 void* p_vsc_cback; /* the callback function for last VSC command */ 205 BUFFER_Q nci_cmd_xmit_q; /* NCI command queue */ 206 TIMER_LIST_ENT 207 nci_wait_rsp_timer; /* Timer for waiting for nci command response */ 208 uint16_t nci_wait_rsp_tout; /* NCI command timeout (in ms) */ 209 uint8_t nci_wait_rsp; /* layer_specific for last NCI message */ 210 211 uint8_t nci_cmd_window; /* Number of commands the controller can accecpt 212 without waiting for response */ 213 214 NFC_HDR* p_nci_init_rsp; /* holding INIT_RSP until receiving 215 HAL_NFC_POST_INIT_CPLT_EVT */ 216 tHAL_NFC_ENTRY* p_hal; 217 218 uint8_t nci_version; /* NCI version used for NCI communication*/ 219 220 bool isScbrSupported; /* indicating if system code based route is supported */ 221 222 uint8_t hci_packet_size; /* maximum hci payload size*/ 223 224 uint8_t hci_conn_credits; /* maximum conn credits for static HCI*/ 225 226 uint16_t nci_max_v_size; /*maximum NFC V rf frame size*/ 227 228 uint8_t rawVsCbflag; 229 uint8_t deact_reason; 230 231 TIMER_LIST_ENT nci_mode_set_ntf_timer; /*Mode set notification timer*/ 232 233 } tNFC_CB; 234 235 /***************************************************************************** 236 ** EXTERNAL FUNCTION DECLARATIONS 237 *****************************************************************************/ 238 239 /* Global NFC data */ 240 extern tNFC_CB nfc_cb; 241 242 /**************************************************************************** 243 ** Internal nfc functions 244 ****************************************************************************/ 245 246 #define NCI_CALCULATE_ACK(a, v) \ 247 { (a) &= ((1 << (v)) - 1); } 248 #define MAX_NUM_VALID_BITS_FOR_ACK 0x07 249 250 /* from nfc_utils.c */ 251 extern tNFC_CONN_CB* nfc_alloc_conn_cb(tNFC_CONN_CBACK* p_cback); 252 extern tNFC_CONN_CB* nfc_find_conn_cb_by_conn_id(uint8_t conn_id); 253 extern tNFC_CONN_CB* nfc_find_conn_cb_by_handle(uint8_t target_handle); 254 extern void nfc_set_conn_id(tNFC_CONN_CB* p_cb, uint8_t conn_id); 255 extern void nfc_free_conn_cb(tNFC_CONN_CB* p_cb); 256 extern void nfc_reset_all_conn_cbs(void); 257 extern void nfc_data_event(tNFC_CONN_CB* p_cb); 258 259 extern uint8_t nfc_ncif_send_data(tNFC_CONN_CB* p_cb, NFC_HDR* p_data); 260 extern void nfc_ncif_cmd_timeout(void); 261 extern void nfc_wait_2_deactivate_timeout(void); 262 extern void nfc_mode_set_ntf_timeout(void); 263 264 extern bool nfc_ncif_process_event(NFC_HDR* p_msg); 265 extern void nfc_ncif_check_cmd_queue(NFC_HDR* p_buf); 266 extern void nfc_ncif_send_cmd(NFC_HDR* p_buf); 267 extern void nfc_ncif_proc_discover_ntf(uint8_t* p, uint16_t plen); 268 extern void nfc_ncif_rf_management_status(tNFC_DISCOVER_EVT event, 269 uint8_t status); 270 extern void nfc_ncif_set_config_status(uint8_t* p, uint8_t len); 271 extern void nfc_ncif_event_status(tNFC_RESPONSE_EVT event, uint8_t status); 272 extern void nfc_ncif_error_status(uint8_t conn_id, uint8_t status); 273 extern void nfc_ncif_proc_credits(uint8_t* p, uint16_t plen); 274 extern void nfc_ncif_proc_activate(uint8_t* p, uint8_t len); 275 extern void nfc_ncif_proc_deactivate(uint8_t status, uint8_t deact_type, 276 bool is_ntf); 277 #if (NFC_NFCEE_INCLUDED == TRUE && NFC_RW_ONLY == FALSE) 278 extern void nfc_ncif_proc_ee_action(uint8_t* p, uint16_t plen); 279 extern void nfc_ncif_proc_ee_discover_req(uint8_t* p, uint16_t plen); 280 extern void nfc_ncif_proc_get_routing(uint8_t* p, uint8_t len); 281 #endif 282 extern void nfc_ncif_proc_conn_create_rsp(uint8_t* p, uint16_t plen, 283 uint8_t dest_type); 284 extern void nfc_ncif_report_conn_close_evt(uint8_t conn_id, tNFC_STATUS status); 285 extern void nfc_ncif_proc_t3t_polling_rsp(uint8_t status); 286 extern void nfc_ncif_proc_t3t_polling_ntf(uint8_t* p, uint16_t plen); 287 extern void nfc_ncif_proc_reset_rsp(uint8_t* p, bool is_ntf); 288 extern void nfc_ncif_proc_init_rsp(NFC_HDR* p_msg); 289 extern void nfc_ncif_proc_get_config_rsp(NFC_HDR* p_msg); 290 extern void nfc_ncif_proc_data(NFC_HDR* p_msg); 291 extern bool nfa_dm_p2p_prio_logic(uint8_t event, uint8_t* p, uint8_t ntf_rsp); 292 extern void nfa_dm_p2p_timer_event(); 293 extern bool nfc_ncif_proc_proprietary_rsp(uint8_t mt, uint8_t gid, uint8_t oid); 294 extern void nfa_dm_p2p_prio_logic_cleanup(); 295 extern void nfc_ncif_proc_isodep_nak_presence_check_status(uint8_t status, 296 bool is_ntf); 297 extern void nfc_ncif_update_window(void); 298 #if (NFC_RW_ONLY == FALSE) 299 extern void nfc_ncif_proc_rf_field_ntf(uint8_t rf_status); 300 #else 301 #define nfc_ncif_proc_rf_field_ntf(rf_status) 302 #endif 303 304 /* From nfc_task.c */ 305 extern uint32_t nfc_task(uint32_t); 306 void nfc_task_shutdown_nfcc(void); 307 308 /* From nfc_main.c */ 309 void nfc_enabled(tNFC_STATUS nfc_status, NFC_HDR* p_init_rsp_msg); 310 void nfc_set_state(tNFC_STATE nfc_state); 311 void nfc_main_flush_cmd_queue(void); 312 void nfc_gen_cleanup(void); 313 void nfc_main_handle_hal_evt(tNFC_HAL_EVT_MSG* p_msg); 314 315 /* Timer functions */ 316 void nfc_start_timer(TIMER_LIST_ENT* p_tle, uint16_t type, uint32_t timeout); 317 uint32_t nfc_remaining_time(TIMER_LIST_ENT* p_tle); 318 void nfc_stop_timer(TIMER_LIST_ENT* p_tle); 319 320 void nfc_start_quick_timer(TIMER_LIST_ENT* p_tle, uint16_t type, 321 uint32_t timeout); 322 void nfc_stop_quick_timer(TIMER_LIST_ENT* p_tle); 323 void nfc_process_quick_timer_evt(void); 324 #endif /* NFC_INT_H_ */ 325