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