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 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /**************************************************************************** 39 ** Internal NFC constants and definitions 40 ****************************************************************************/ 41 42 /**************************************************************************** 43 ** NFC_TASK definitions 44 ****************************************************************************/ 45 46 /* NFC_TASK event masks */ 47 #define NFC_TASK_EVT_TRANSPORT_READY EVENT_MASK(APPL_EVT_0) 48 49 /* NFC Timer events */ 50 #define NFC_TTYPE_NCI_WAIT_RSP 0 51 #define NFC_TTYPE_WAIT_2_DEACTIVATE 1 52 53 #define NFC_TTYPE_LLCP_LINK_MANAGER 100 54 #define NFC_TTYPE_LLCP_LINK_INACT 101 55 #define NFC_TTYPE_LLCP_DATA_LINK 102 56 #define NFC_TTYPE_LLCP_DELAY_FIRST_PDU 103 57 #define NFC_TTYPE_RW_T1T_RESPONSE 104 58 #define NFC_TTYPE_RW_T2T_RESPONSE 105 59 #define NFC_TTYPE_RW_T3T_RESPONSE 106 60 #define NFC_TTYPE_RW_T4T_RESPONSE 107 61 #define NFC_TTYPE_RW_I93_RESPONSE 108 62 #define NFC_TTYPE_CE_T4T_UPDATE 109 63 /* added for p2p prio logic timer */ 64 #define NFC_TTYPE_P2P_PRIO_RESPONSE 110 65 /* added for p2p prio logic clenaup */ 66 #define NFC_TTYPE_P2P_PRIO_LOGIC_CLEANUP 111 67 #define NFC_TTYPE_VS_BASE 200 68 69 /* NFC Task event messages */ 70 71 enum { 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_t tNFC_STATE; 83 84 /* DM P2P Priority event type */ 85 enum { 86 NFA_DM_P2P_PRIO_RSP = 0x01, /* P2P priority event from RSP */ 87 NFA_DM_P2P_PRIO_NTF /* P2P priority event from NTF */ 88 }; 89 90 /* NFC control block flags */ 91 /* NFC_Deactivate () is called and the NCI cmd is not sent */ 92 #define NFC_FL_DEACTIVATING 0x0001 93 /* restarting NFCC after PowerOffSleep */ 94 #define NFC_FL_RESTARTING 0x0002 95 /* enterning power off sleep mode */ 96 #define NFC_FL_POWER_OFF_SLEEP 0x0004 97 /* Power cycle NFCC */ 98 #define NFC_FL_POWER_CYCLE_NFCC 0x0008 99 /* HAL requested control on NCI command window */ 100 #define NFC_FL_CONTROL_REQUESTED 0x0010 101 /* NCI command window is on the HAL side */ 102 #define NFC_FL_CONTROL_GRANTED 0x0020 103 /* NCI command window is on the HAL side */ 104 #define NFC_FL_DISCOVER_PENDING 0x0040 105 /* NFC_FL_CONTROL_REQUESTED on HAL request */ 106 #define NFC_FL_HAL_REQUESTED 0x0080 107 108 #define NFC_PEND_CONN_ID 0xFE 109 #define NFC_CONN_ID_INT_MASK 0xF0 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 #define NFC_NCI_CONN_NO_FC 0xFF 114 115 #if (NFC_RW_ONLY == FALSE) 116 /* only allow the entries that the NFCC can support */ 117 #define NFC_CHECK_MAX_CONN() \ 118 { \ 119 if (max > nfc_cb.max_conn) max = nfc_cb.max_conn; \ 120 } 121 #else 122 #define NFC_CHECK_MAX_CONN() 123 #endif 124 125 typedef struct { 126 tNFC_CONN_CBACK* p_cback; /* the callback function to receive the data */ 127 BUFFER_Q tx_q; /* transmit queue */ 128 BUFFER_Q rx_q; /* receive queue */ 129 uint8_t id; /* NFCEE ID or RF Discovery ID or NFC_TEST_ID */ 130 uint8_t act_protocol; /* the active protocol 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 /* NFCC power state change pending callback */ 154 typedef void(tNFC_PWR_ST_CBACK)(void); 155 #define NFC_SAVED_HDR_SIZE (2) 156 /* data Reassembly error (in NFC_HDR.layer_specific) */ 157 #define NFC_RAS_TOO_BIG 0x08 158 #define NFC_RAS_FRAGMENTED 0x01 159 160 /* NCI command buffer contains a VSC (in NFC_HDR.layer_specific) */ 161 #define NFC_WAIT_RSP_VSC 0x01 162 163 /* NFC control blocks */ 164 typedef struct { 165 uint16_t flags; /* NFC control block flags - NFC_FL_* */ 166 tNFC_CONN_CB conn_cb[NCI_MAX_CONN_CBS]; 167 uint8_t conn_id[NFC_MAX_CONN_ID + 1]; /* index: conn_id; conn_id[]: index(1 168 based) to conn_cb[] */ 169 tNFC_DISCOVER_CBACK* p_discv_cback; 170 tNFC_RESPONSE_CBACK* p_resp_cback; 171 tNFC_TEST_CBACK* p_test_cback; 172 tNFC_VS_CBACK* 173 p_vs_cb[NFC_NUM_VS_CBACKS]; /* Register for vendor specific events */ 174 175 #if (NFC_RW_ONLY == FALSE) 176 /* NFCC information at init rsp */ 177 uint32_t nci_features; /* the NCI features supported by NFCC */ 178 uint16_t max_ce_table; /* the max routing table size */ 179 uint8_t max_conn; /* the num of connections supported by NFCC */ 180 #endif 181 uint8_t nci_ctrl_size; /* Max Control Packet Payload Size */ 182 183 const tNCI_DISCOVER_MAPS* 184 p_disc_maps; /* NCI RF Discovery interface mapping */ 185 uint8_t vs_interface 186 [NFC_NFCC_MAX_NUM_VS_INTERFACE]; /* the NCI VS interfaces of NFCC */ 187 uint16_t nci_interfaces; /* the NCI interfaces of NFCC */ 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 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 trace_level; 201 uint8_t last_hdr[NFC_SAVED_HDR_SIZE]; /* part of last NCI command header */ 202 uint8_t last_cmd[NFC_SAVED_CMD_SIZE]; /* part of last NCI command payload */ 203 void* p_vsc_cback; /* the callback function for last VSC command */ 204 BUFFER_Q nci_cmd_xmit_q; /* NCI command queue */ 205 TIMER_LIST_ENT 206 nci_wait_rsp_timer; /* Timer for waiting for nci command response */ 207 uint16_t nci_wait_rsp_tout; /* NCI command timeout (in ms) */ 208 uint8_t nci_wait_rsp; /* layer_specific for last NCI message */ 209 210 uint8_t nci_cmd_window; /* Number of commands the controller can accecpt 211 without waiting for response */ 212 213 NFC_HDR* p_nci_init_rsp; /* holding INIT_RSP until receiving 214 HAL_NFC_POST_INIT_CPLT_EVT */ 215 tHAL_NFC_ENTRY* p_hal; 216 217 } tNFC_CB; 218 219 /***************************************************************************** 220 ** EXTERNAL FUNCTION DECLARATIONS 221 *****************************************************************************/ 222 223 /* Global NFC data */ 224 extern tNFC_CB nfc_cb; 225 226 /**************************************************************************** 227 ** Internal nfc functions 228 ****************************************************************************/ 229 230 extern void nfc_init(void); 231 232 /* from nfc_utils.c */ 233 extern tNFC_CONN_CB* nfc_alloc_conn_cb(tNFC_CONN_CBACK* p_cback); 234 extern tNFC_CONN_CB* nfc_find_conn_cb_by_conn_id(uint8_t conn_id); 235 extern tNFC_CONN_CB* nfc_find_conn_cb_by_handle(uint8_t target_handle); 236 extern void nfc_set_conn_id(tNFC_CONN_CB* p_cb, uint8_t conn_id); 237 extern void nfc_free_conn_cb(tNFC_CONN_CB* p_cb); 238 extern void nfc_reset_all_conn_cbs(void); 239 extern void nfc_data_event(tNFC_CONN_CB* p_cb); 240 241 void nfc_ncif_send(NFC_HDR* p_buf, bool is_cmd); 242 extern uint8_t nfc_ncif_send_data(tNFC_CONN_CB* p_cb, NFC_HDR* p_data); 243 extern void nfc_ncif_cmd_timeout(void); 244 extern void nfc_wait_2_deactivate_timeout(void); 245 246 extern bool nfc_ncif_process_event(NFC_HDR* p_msg); 247 extern void nfc_ncif_check_cmd_queue(NFC_HDR* p_buf); 248 extern void nfc_ncif_send_cmd(NFC_HDR* p_buf); 249 extern void nfc_ncif_proc_discover_ntf(uint8_t* p, uint16_t plen); 250 extern void nfc_ncif_rf_management_status(tNFC_DISCOVER_EVT event, 251 uint8_t status); 252 extern void nfc_ncif_set_config_status(uint8_t* p, uint8_t len); 253 extern void nfc_ncif_event_status(tNFC_RESPONSE_EVT event, uint8_t status); 254 extern void nfc_ncif_error_status(uint8_t conn_id, uint8_t status); 255 extern void nfc_ncif_proc_credits(uint8_t* p, uint16_t plen); 256 extern void nfc_ncif_proc_activate(uint8_t* p, uint8_t len); 257 extern void nfc_ncif_proc_deactivate(uint8_t status, uint8_t deact_type, 258 bool is_ntf); 259 #if (NFC_NFCEE_INCLUDED == TRUE && NFC_RW_ONLY == FALSE) 260 extern void nfc_ncif_proc_ee_action(uint8_t* p, uint16_t plen); 261 extern void nfc_ncif_proc_ee_discover_req(uint8_t* p, uint16_t plen); 262 extern void nfc_ncif_proc_get_routing(uint8_t* p, uint8_t len); 263 #endif 264 extern void nfc_ncif_proc_conn_create_rsp(uint8_t* p, uint16_t plen, 265 uint8_t dest_type); 266 extern void nfc_ncif_report_conn_close_evt(uint8_t conn_id, tNFC_STATUS status); 267 extern void nfc_ncif_proc_t3t_polling_ntf(uint8_t* p, uint16_t plen); 268 extern void nfc_ncif_proc_reset_rsp(uint8_t* p, bool is_ntf); 269 extern void nfc_ncif_proc_init_rsp(NFC_HDR* p_msg); 270 extern void nfc_ncif_proc_get_config_rsp(NFC_HDR* p_msg); 271 extern void nfc_ncif_proc_data(NFC_HDR* p_msg); 272 extern bool nfa_dm_p2p_prio_logic(uint8_t event, uint8_t* p, uint8_t ntf_rsp); 273 extern void nfa_dm_p2p_timer_event(); 274 extern void nfa_dm_p2p_prio_logic_cleanup(); 275 276 #if (NFC_RW_ONLY == FALSE) 277 extern void nfc_ncif_proc_rf_field_ntf(uint8_t rf_status); 278 #else 279 #define nfc_ncif_proc_rf_field_ntf(rf_status) 280 #endif 281 282 /* From nfc_task.c */ 283 extern uint32_t nfc_task(uint32_t param); 284 void nfc_task_shutdown_nfcc(void); 285 286 /* From nfc_main.c */ 287 void nfc_enabled(tNFC_STATUS nfc_status, NFC_HDR* p_init_rsp_msg); 288 void nfc_set_state(tNFC_STATE nfc_state); 289 void nfc_main_flush_cmd_queue(void); 290 void nfc_gen_cleanup(void); 291 void nfc_main_handle_hal_evt(tNFC_HAL_EVT_MSG* p_msg); 292 293 /* Timer functions */ 294 void nfc_start_timer(TIMER_LIST_ENT* p_tle, uint16_t type, uint32_t timeout); 295 uint32_t nfc_remaining_time(TIMER_LIST_ENT* p_tle); 296 void nfc_stop_timer(TIMER_LIST_ENT* p_tle); 297 298 void nfc_start_quick_timer(TIMER_LIST_ENT* p_tle, uint16_t type, 299 uint32_t timeout); 300 void nfc_stop_quick_timer(TIMER_LIST_ENT* p_tle); 301 void nfc_process_quick_timer_evt(void); 302 303 #ifdef __cplusplus 304 } 305 #endif 306 307 #endif /* NFC_INT_H_ */ 308