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