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