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