Gitiles
Code Review Sign In
android-review.linaro.org / platform / external / libnfc-nci / refs/heads/jb-mr1.1-dev / . / src / nfc / int / nfc_int.h
blob: e9180e610c5304828d8013a514517b712fa93eb1 [file] [log] [blame]
The Android Open Source Projecte9df6ba2012-12-13 14:55:37 -0800[diff] [blame]1/******************************************************************************
2 *
3 * Copyright (C) 2009-2012 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 "nfc_target.h"
30#include "gki.h"
31#include "nci_defs.h"
32#include "nfc_api.h"
33#include "btu_api.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39/****************************************************************************
40** Internal NFC constants and definitions
41****************************************************************************/
42
43/****************************************************************************
44** NFC_TASK definitions
45****************************************************************************/
46
47/* NFC_TASK event masks */
48#define NFC_TASK_EVT_TRANSPORT_READY EVENT_MASK (APPL_EVT_0)
49
50/* NFC Timer events */
51#define NFC_TTYPE_NCI_WAIT_RSP 0
52#define NFC_TTYPE_WAIT_2_DEACTIVATE 1
53
54#define NFC_TTYPE_LLCP_LINK_MANAGER 100
55#define NFC_TTYPE_LLCP_LINK_INACT 101
56#define NFC_TTYPE_LLCP_DATA_LINK 102
57#define NFC_TTYPE_LLCP_DELAY_FIRST_PDU 103
58#define NFC_TTYPE_RW_T1T_RESPONSE 104
59#define NFC_TTYPE_RW_T2T_RESPONSE 105
60#define NFC_TTYPE_RW_T3T_RESPONSE 106
61#define NFC_TTYPE_RW_T4T_RESPONSE 107
62#define NFC_TTYPE_RW_I93_RESPONSE 108
63#define NFC_TTYPE_CE_T4T_UPDATE 109
64#define NFC_TTYPE_VS_BASE 200
65
66
67/* NFC Task event messages */
68
69enum
70{
71 NFC_STATE_NONE, /* not start up yet */
72 NFC_STATE_W4_HAL_OPEN, /* waiting for HAL_NFC_OPEN_CPLT_EVT */
73 NFC_STATE_CORE_INIT, /* sending CORE_RESET and CORE_INIT */
74 NFC_STATE_W4_POST_INIT_CPLT, /* waiting for HAL_NFC_POST_INIT_CPLT_EVT */
75 NFC_STATE_IDLE, /* normal operation (discovery state) */
76 NFC_STATE_OPEN, /* NFC link is activated */
77 NFC_STATE_CLOSING, /* de-activating */
78 NFC_STATE_W4_HAL_CLOSE, /* waiting for HAL_NFC_POST_INIT_CPLT_EVT */
79 NFC_STATE_NFCC_POWER_OFF_SLEEP /* NFCC is power-off sleep mode */
80};
81typedef UINT8 tNFC_STATE;
82
83/* NFC control block flags */
84#define NFC_FL_DEACTIVATING 0x0001 /* NFC_Deactivate () is called and the NCI cmd is not sent */
85#define NFC_FL_RESTARTING 0x0002 /* restarting NFCC after PowerOffSleep */
86#define NFC_FL_POWER_OFF_SLEEP 0x0004 /* enterning power off sleep mode */
87#define NFC_FL_POWER_CYCLE_NFCC 0x0008 /* Power cycle NFCC */
88#define NFC_FL_CONTROL_REQUESTED 0x0010 /* HAL requested control on NCI command window */
89#define NFC_FL_CONTROL_GRANTED 0x0020 /* NCI command window is on the HAL side */
90#define NFC_FL_DISCOVER_PENDING 0x0040 /* NCI command window is on the HAL side */
91
92#define NFC_PEND_CONN_ID 0xFE
93#define NFC_CONN_ID_INT_MASK 0xF0
94#define NFC_CONN_ID_ID_MASK NCI_CID_MASK
95#define NFC_CONN_NO_FC 0xFF /* set num_buff to this for no flow control */
96#define NFC_NCI_CONN_NO_FC 0xFF
97
98#if (NFC_RW_ONLY == FALSE)
99/* only allow the entries that the NFCC can support */
100#define NFC_CHECK_MAX_CONN() {if (max > nfc_cb.max_conn) max = nfc_cb.max_conn;}
101#else
102#define NFC_CHECK_MAX_CONN()
103#endif
104
105typedef struct
106{
107 tNFC_CONN_CBACK *p_cback; /* the callback function to receive the data */
108 BUFFER_Q tx_q; /* transmit queue */
109 BUFFER_Q rx_q; /* receive queue */
110 UINT8 id; /* NFCEE ID or RF Discovery ID or NFC_TEST_ID */
111 UINT8 act_protocol; /* the active protocol on this logical connection */
112 UINT8 conn_id; /* the connection id assigned by NFCC for this conn */
113 UINT8 buff_size; /* the max buffer size for this connection. . */
114 UINT8 num_buff; /* num of buffers left to send on this connection */
115 UINT8 init_credits; /* initial num of buffer credits */
116} tNFC_CONN_CB;
117
118/* This data type is for NFC task to send a NCI VS command to NCIT task */
119typedef struct
120{
121 BT_HDR bt_hdr; /* the NCI command */
122 tNFC_VS_CBACK *p_cback; /* the callback function to receive RSP */
123} tNFC_NCI_VS_MSG;
124
125/* This data type is for HAL event */
126typedef struct
127{
128 BT_HDR hdr;
129 UINT8 hal_evt; /* HAL event code */
130 UINT8 status; /* tHAL_NFC_STATUS */
131} tNFC_HAL_EVT_MSG;
132
133#define NFC_RECEIVE_MSGS_OFFSET (10) /* callback function pointer(8; use 8 to be safe + NFC_SAVED_CMD_SIZE(2) */
134
135/* NFCC power state change pending callback */
136typedef void (tNFC_PWR_ST_CBACK) (void);
137#define NFC_SAVED_HDR_SIZE (2)
138/* data Reassembly error (in BT_HDR.layer_specific) */
139#define NFC_RAS_TOO_BIG 0x08
140#define NFC_RAS_FRAGMENTED 0x01
141
142/* NCI command buffer contains a VSC (in BT_HDR.layer_specific) */
143#define NFC_WAIT_RSP_VSC 0x01
144
145/* NFC control blocks */
146typedef struct
147{
148 UINT16 flags; /* NFC control block flags - NFC_FL_* */
149 tNFC_CONN_CB conn_cb[NCI_MAX_CONN_CBS];
150 UINT8 conn_id[NFC_MAX_CONN_ID+1]; /* index: conn_id; conn_id[]: index(1 based) to conn_cb[] */
151 tNFC_DISCOVER_CBACK *p_discv_cback;
152 tNFC_RESPONSE_CBACK *p_resp_cback;
153 tNFC_TEST_CBACK *p_test_cback;
154 tNFC_VS_CBACK *p_vs_cb[NFC_NUM_VS_CBACKS];/* Register for vendor specific events */
155
156#if (NFC_RW_ONLY == FALSE)
157 /* NFCC information at init rsp */
158 UINT32 nci_features; /* the NCI features supported by NFCC */
159 UINT16 max_ce_table; /* the max routing table size */
160 UINT8 max_conn; /* the num of connections supported by NFCC */
161#endif
162 UINT8 nci_ctrl_size; /* Max Control Packet Payload Size */
163
164 const tNCI_DISCOVER_MAPS *p_disc_maps; /* NCI RF Discovery interface mapping */
165 UINT8 vs_interface[NFC_NFCC_MAX_NUM_VS_INTERFACE]; /* the NCI VS interfaces of NFCC */
166 UINT16 nci_interfaces; /* the NCI interfaces of NFCC */
167 UINT8 num_disc_maps; /* number of RF Discovery interface mappings */
168 void *p_disc_pending; /* the parameters associated with pending NFC_DiscoveryStart */
169
170 /* NFC_TASK timer management */
171 TIMER_LIST_Q timer_queue; /* 1-sec timer event queue */
172 TIMER_LIST_Q quick_timer_queue;
173
174 TIMER_LIST_ENT deactivate_timer; /* Timer to wait for deactivation */
175
176 tNFC_STATE nfc_state;
177 UINT8 trace_level;
178 UINT8 last_hdr[NFC_SAVED_HDR_SIZE];/* part of last NCI command header */
179 UINT8 last_cmd[NFC_SAVED_CMD_SIZE];/* part of last NCI command payload */
180 void *p_vsc_cback; /* the callback function for last VSC command */
181 BUFFER_Q nci_cmd_xmit_q; /* NCI command queue */
182 TIMER_LIST_ENT nci_wait_rsp_timer; /* Timer for waiting for nci command response */
183 UINT16 nci_wait_rsp_tout; /* NCI command timeout (in ms) */
184 UINT8 nci_wait_rsp; /* layer_specific for last NCI message */
185
186 UINT8 nci_cmd_window; /* Number of commands the controller can accecpt without waiting for response */
187
188 BT_HDR *p_nci_init_rsp; /* holding INIT_RSP until receiving HAL_NFC_POST_INIT_CPLT_EVT */
189 tHAL_NFC_ENTRY *p_hal;
190
191} tNFC_CB;
192
193
194/*****************************************************************************
195** EXTERNAL FUNCTION DECLARATIONS
196*****************************************************************************/
197
198/* Global NFC data */
199#if NFC_DYNAMIC_MEMORY == FALSE
200NFC_API extern tNFC_CB nfc_cb;
201#else
202NFC_API extern tNFC_CB *nfc_cb_ptr;
203#define nfc_cb (*nfc_cb_ptr)
204#endif
205
206/****************************************************************************
207** Internal nfc functions
208****************************************************************************/
209
210NFC_API extern void nfc_init(void);
211
212/* from nfc_utils.c */
213NFC_API extern tNFC_CONN_CB * nfc_alloc_conn_cb ( tNFC_CONN_CBACK *p_cback);
214NFC_API extern tNFC_CONN_CB * nfc_find_conn_cb_by_conn_id (UINT8 conn_id);
215NFC_API extern tNFC_CONN_CB * nfc_find_conn_cb_by_handle (UINT8 target_handle);
216NFC_API extern void nfc_set_conn_id (tNFC_CONN_CB * p_cb, UINT8 conn_id);
217NFC_API extern void nfc_free_conn_cb (tNFC_CONN_CB *p_cb);
218NFC_API extern void nfc_reset_all_conn_cbs (void);
219NFC_API extern void nfc_data_event (tNFC_CONN_CB * p_cb);
220
221void nfc_ncif_send (BT_HDR *p_buf, BOOLEAN is_cmd);
222extern UINT8 nfc_ncif_send_data (tNFC_CONN_CB *p_cb, BT_HDR *p_data);
223NFC_API extern void nfc_ncif_cmd_timeout (void);
224NFC_API extern void nfc_wait_2_deactivate_timeout (void);
225
226NFC_API extern BOOLEAN nfc_ncif_process_event (BT_HDR *p_msg);
227NFC_API extern void nfc_ncif_check_cmd_queue (BT_HDR *p_buf);
228NFC_API extern void nfc_ncif_send_cmd (BT_HDR *p_buf);
229NFC_API extern void nfc_ncif_proc_discover_ntf (UINT8 *p, UINT16 plen);
230NFC_API extern void nfc_ncif_rf_management_status (tNFC_DISCOVER_EVT event, UINT8 status);
231NFC_API extern void nfc_ncif_set_config_status (UINT8 *p, UINT8 len);
232NFC_API extern void nfc_ncif_event_status (tNFC_RESPONSE_EVT event, UINT8 status);
233NFC_API extern void nfc_ncif_error_status (UINT8 conn_id, UINT8 status);
234NFC_API extern void nfc_ncif_proc_credits(UINT8 *p, UINT16 plen);
235NFC_API extern void nfc_ncif_proc_activate (UINT8 *p, UINT8 len);
236NFC_API extern void nfc_ncif_proc_deactivate (UINT8 status, UINT8 deact_type, BOOLEAN is_ntf);
237#if ((NFC_NFCEE_INCLUDED == TRUE) && (NFC_RW_ONLY == FALSE))
238NFC_API extern void nfc_ncif_proc_ee_action (UINT8 *p, UINT16 plen);
239NFC_API extern void nfc_ncif_proc_ee_discover_req (UINT8 *p, UINT16 plen);
240NFC_API extern void nfc_ncif_proc_get_routing (UINT8 *p, UINT8 len);
241#endif
242NFC_API extern void nfc_ncif_proc_conn_create_rsp (UINT8 *p, UINT16 plen, UINT8 dest_type);
243NFC_API extern void nfc_ncif_report_conn_close_evt (UINT8 conn_id, tNFC_STATUS status);
244NFC_API extern void nfc_ncif_proc_t3t_polling_ntf (UINT8 *p, UINT16 plen);
245NFC_API extern void nfc_ncif_proc_reset_rsp (UINT8 *p, BOOLEAN is_ntf);
246NFC_API extern void nfc_ncif_proc_init_rsp (BT_HDR *p_msg);
247NFC_API extern void nfc_ncif_proc_get_config_rsp (BT_HDR *p_msg);
248NFC_API extern void nfc_ncif_proc_data (BT_HDR *p_msg);
249
250#if (NFC_RW_ONLY == FALSE)
251NFC_API extern void nfc_ncif_proc_rf_field_ntf (UINT8 rf_status);
252#else
253#define nfc_ncif_proc_rf_field_ntf(rf_status)
254#endif
255
256/* From nfc_task.c */
257NFC_API extern UINT32 nfc_task (UINT32 param);
258void nfc_task_shutdown_nfcc (void);
259
260/* From nfc_main.c */
261void nfc_enabled (tNFC_STATUS nfc_status, BT_HDR *p_init_rsp_msg);
262void nfc_set_state (tNFC_STATE nfc_state);
263void nfc_main_flush_cmd_queue (void);
264void nfc_gen_cleanup (void);
265void nfc_main_handle_hal_evt (tNFC_HAL_EVT_MSG *p_msg);
266
267/* Timer functions */
268void nfc_start_timer (TIMER_LIST_ENT *p_tle, UINT16 type, UINT32 timeout);
269UINT32 nfc_remaining_time (TIMER_LIST_ENT *p_tle);
270void nfc_stop_timer (TIMER_LIST_ENT *p_tle);
271
272void nfc_start_quick_timer (TIMER_LIST_ENT *p_tle, UINT16 type, UINT32 timeout);
273void nfc_stop_quick_timer (TIMER_LIST_ENT *p_tle);
274void nfc_process_quick_timer_evt (void);
275#ifdef __cplusplus
276}
277#endif
278
279#endif /* NFC_INT_H_ */