• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /******************************************************************************
2  *
3  *  Copyright (C) 2010-2013 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  *
22  *  This file contains LLCP internal definitions
23  *
24  ******************************************************************************/
25 #ifndef LLCP_INT_H
26 #define LLCP_INT_H
27 
28 #include "llcp_api.h"
29 #include "nfc_api.h"
30 
31 /*
32 ** LLCP link states
33 */
34 enum
35 {
36     LLCP_LINK_STATE_DEACTIVATED,                /* llcp link is deactivated     */
37     LLCP_LINK_STATE_ACTIVATED,                  /* llcp link has been activated */
38     LLCP_LINK_STATE_DEACTIVATING,               /* llcp link is deactivating    */
39     LLCP_LINK_STATE_ACTIVATION_FAILED           /* llcp link activation was failed */
40 };
41 typedef UINT8 tLLCP_LINK_STATE;
42 
43 /*
44 ** LLCP Symmetric state
45 */
46 
47 #define LLCP_LINK_SYMM_LOCAL_XMIT_NEXT   0
48 #define LLCP_LINK_SYMM_REMOTE_XMIT_NEXT  1
49 
50 /*
51 ** LLCP internal flags
52 */
53 #define LLCP_LINK_FLAGS_RX_ANY_LLC_PDU      0x01    /* Received any LLC PDU in activated state */
54 
55 /*
56 ** LLCP link control block
57 */
58 typedef struct
59 {
60     tLLCP_LINK_STATE    link_state;             /* llcp link state                              */
61     tLLCP_LINK_CBACK   *p_link_cback;           /* callback function to report llcp link status */
62     UINT16              wks;                    /* well-known service bit-map                   */
63 
64     BOOLEAN             is_initiator;           /* TRUE if initiator role                       */
65     BOOLEAN             is_sending_data;        /* TRUE if llcp_link_check_send_data() is excuting    */
66     UINT8               flags;                  /* LLCP internal flags                          */
67     BOOLEAN             received_first_packet;  /* TRUE if a packet has been received from remote */
68     UINT8               agreed_major_version;   /* llcp major version used in activated state   */
69     UINT8               agreed_minor_version;   /* llcp minor version used in activated state   */
70 
71     UINT8               peer_version;           /* llcp version of peer device                  */
72     UINT16              peer_miu;               /* link MIU of peer device                      */
73     UINT16              peer_wks;               /* WKS of peer device                           */
74     UINT16              peer_lto;               /* link timeout of peer device in ms            */
75     UINT8               peer_opt;               /* Option field of peer device                  */
76     UINT16              effective_miu;          /* MIU to send PDU in activated state           */
77     TIMER_LIST_ENT      timer;                  /* link timer for LTO and SYMM response         */
78     UINT8               symm_state;             /* state of symmectric procedure                */
79     BOOLEAN             ll_served;              /* TRUE if last transmisstion was for UI        */
80     UINT8               ll_idx;                 /* for scheduler of logical link connection     */
81     UINT8               dl_idx;                 /* for scheduler of data link connection        */
82 
83     TIMER_LIST_ENT      inact_timer;            /* inactivity timer                             */
84     UINT16              inact_timeout;          /* inactivity timeout in ms                     */
85 
86     UINT8               link_deact_reason;      /* reason of LLCP link deactivated              */
87 
88     BUFFER_Q            sig_xmit_q;             /* tx signaling PDU queue                       */
89 
90     /* runtime configuration parameters */
91     UINT16              local_link_miu;         /* Maximum Information Unit                     */
92     UINT8               local_opt;              /* Option parameter                             */
93     UINT8               local_wt;               /* Response Waiting Time Index                  */
94     UINT16              local_lto;              /* Local Link Timeout                           */
95     UINT16              inact_timeout_init;     /* Inactivity Timeout as initiator role         */
96     UINT16              inact_timeout_target;   /* Inactivity Timeout as target role            */
97     UINT16              symm_delay;             /* Delay SYMM response                          */
98     UINT16              data_link_timeout;      /* data link conneciton timeout                 */
99     UINT16              delay_first_pdu_timeout;/* delay timeout to send first PDU as initiator */
100 
101 } tLLCP_LCB;
102 
103 /*
104 ** LLCP Application's registration control block on service access point (SAP)
105 */
106 
107 typedef struct
108 {
109     UINT8               link_type;              /* logical link and/or data link                */
110     UINT8               *p_service_name;        /* GKI buffer containing service name           */
111     tLLCP_APP_CBACK     *p_app_cback;           /* application's callback pointer               */
112 
113     BUFFER_Q            ui_xmit_q;              /* UI PDU queue for transmitting                */
114     BUFFER_Q            ui_rx_q;                /* UI PDU queue for receiving                   */
115     BOOLEAN             is_ui_tx_congested;     /* TRUE if transmitting UI PDU is congested     */
116 
117 } tLLCP_APP_CB;
118 
119 /*
120 ** LLCP data link connection states
121 */
122 enum
123 {
124     LLCP_DLC_STATE_IDLE,            /* initial state                                    */
125     LLCP_DLC_STATE_W4_REMOTE_RESP,  /* waiting for connection confirm from peer         */
126     LLCP_DLC_STATE_W4_LOCAL_RESP,   /* waiting for connection confirm from upper layer  */
127     LLCP_DLC_STATE_CONNECTED,       /* data link connection has been established        */
128     LLCP_DLC_STATE_W4_REMOTE_DM,    /* waiting for disconnection confirm from peer      */
129     LLCP_DLC_STATE_MAX
130 };
131 typedef UINT8 tLLCP_DLC_STATE;
132 
133 /*
134 ** LLCP data link connection events
135 */
136 enum
137 {
138     LLCP_DLC_EVENT_API_CONNECT_REQ,      /* connection request from upper layer  */
139     LLCP_DLC_EVENT_API_CONNECT_CFM,      /* connection confirm from upper layer  */
140     LLCP_DLC_EVENT_API_CONNECT_REJECT,   /* connection reject from upper layer   */
141     LLCP_DLC_EVENT_PEER_CONNECT_IND,     /* connection request from peer         */
142     LLCP_DLC_EVENT_PEER_CONNECT_CFM,     /* connection confirm from peer         */
143 
144     LLCP_DLC_EVENT_API_DATA_REQ,         /* data packet from upper layer         */
145     LLCP_DLC_EVENT_PEER_DATA_IND,        /* data packet from peer                */
146 
147     LLCP_DLC_EVENT_API_DISCONNECT_REQ,   /* disconnect request from upper layer  */
148     LLCP_DLC_EVENT_PEER_DISCONNECT_IND,  /* disconnect request from peer         */
149     LLCP_DLC_EVENT_PEER_DISCONNECT_RESP, /* disconnect response from peer        */
150 
151     LLCP_DLC_EVENT_FRAME_ERROR,          /* received erroneous frame from peer   */
152     LLCP_DLC_EVENT_LINK_ERROR,           /* llcp link has been deactivated       */
153 
154     LLCP_DLC_EVENT_TIMEOUT               /* timeout event                        */
155 };
156 typedef UINT8 tLLCP_DLC_EVENT;
157 
158 /*
159 ** LLCP data link connection control block
160 */
161 
162 #define LLCP_DATA_LINK_FLAG_PENDING_DISC     0x01 /* send DISC when tx queue is empty       */
163 #define LLCP_DATA_LINK_FLAG_PENDING_RR_RNR   0x02 /* send RR/RNR with valid sequence        */
164 #define LLCP_DATA_LINK_FLAG_NOTIFY_TX_DONE   0x04 /* notify upper later when tx complete    */
165 
166 
167 typedef struct
168 {
169     tLLCP_DLC_STATE         state;              /* data link connection state               */
170     UINT8                   flags;              /* specific action flags                    */
171     tLLCP_APP_CB            *p_app_cb;          /* pointer of application registration      */
172     TIMER_LIST_ENT          timer;              /* timer for connection complete            */
173 
174     UINT8                   local_sap;          /* SAP of local end point                   */
175     UINT16                  local_miu;          /* MIU of local SAP                         */
176     UINT8                   local_rw;           /* RW of local SAP                          */
177     BOOLEAN                 local_busy;         /* TRUE if local SAP is busy                */
178 
179     UINT8                   remote_sap;         /* SAP of remote end point                  */
180     UINT16                  remote_miu;         /* MIU of remote SAP                        */
181     UINT8                   remote_rw;          /* RW of remote SAP                         */
182     BOOLEAN                 remote_busy;        /* TRUE if remote SAP is busy               */
183 
184     UINT8                   next_tx_seq;        /* V(S), send state variable                */
185     UINT8                   rcvd_ack_seq;       /* V(SA), send ack state variable           */
186     UINT8                   next_rx_seq;        /* V(R), receive state variable             */
187     UINT8                   sent_ack_seq;       /* V(RA), receive ack state variable        */
188 
189     BUFFER_Q                i_xmit_q;           /* tx queue of I PDU                        */
190     BOOLEAN                 is_tx_congested;    /* TRUE if tx I PDU is congested            */
191 
192     BUFFER_Q                i_rx_q;             /* rx queue of I PDU                        */
193     BOOLEAN                 is_rx_congested;    /* TRUE if rx I PDU is congested            */
194     UINT8                   num_rx_i_pdu;       /* number of I PDU in rx queue              */
195     UINT8                   rx_congest_threshold; /* dynamic congest threshold for rx I PDU */
196 
197 } tLLCP_DLCB;
198 
199 /*
200 ** LLCP service discovery control block
201 */
202 
203 typedef struct
204 {
205     UINT8           tid;        /* transaction ID                           */
206     tLLCP_SDP_CBACK *p_cback;   /* callback function for service discovery  */
207 } tLLCP_SDP_TRANSAC;
208 
209 typedef struct
210 {
211     UINT8               next_tid;                       /* next TID to use         */
212     tLLCP_SDP_TRANSAC   transac[LLCP_MAX_SDP_TRANSAC];  /* active SDP transactions */
213     BT_HDR              *p_snl;                         /* buffer for SNL PDU      */
214 } tLLCP_SDP_CB;
215 
216 
217 /*
218 ** LLCP control block
219 */
220 
221 typedef struct
222 {
223     UINT8           trace_level;                    /* LLCP trace level                             */
224 
225     tLLCP_SDP_CB    sdp_cb;                         /* SDP control block                            */
226     tLLCP_LCB       lcb;                            /* LLCP link control block                      */
227     tLLCP_APP_CB    wks_cb[LLCP_MAX_WKS];           /* Application's registration for well-known services */
228     tLLCP_APP_CB    server_cb[LLCP_MAX_SERVER];     /* Application's registration for SDP services  */
229     tLLCP_APP_CB    client_cb[LLCP_MAX_CLIENT];     /* Application's registration for client        */
230     tLLCP_DLCB      dlcb[LLCP_MAX_DATA_LINK];       /* Data link connection control block           */
231 
232     UINT8           max_num_ll_tx_buff;             /* max number of tx UI PDU in queue             */
233     UINT8           max_num_tx_buff;                /* max number of tx UI/I PDU in queue           */
234 
235     UINT8           num_logical_data_link;          /* number of logical data link                  */
236     UINT8           num_data_link_connection;       /* number of established data link connection   */
237 
238     /* these two thresholds (number of tx UI PDU) are dynamically adjusted based on number of logical links */
239     UINT8           ll_tx_congest_start;            /* congest start threshold for each logical link*/
240     UINT8           ll_tx_congest_end;              /* congest end threshold for each logical link  */
241 
242     UINT8           total_tx_ui_pdu;                /* total number of tx UI PDU in all of ui_xmit_q*/
243     UINT8           total_tx_i_pdu;                 /* total number of tx I PDU in all of i_xmit_q  */
244     BOOLEAN         overall_tx_congested;           /* TRUE if tx link is congested                 */
245 
246     /* start point of uncongested status notification is in round robin */
247     UINT8           ll_tx_uncongest_ntf_start_sap;  /* next start of logical data link              */
248     UINT8           dl_tx_uncongest_ntf_start_idx;  /* next start of data link connection           */
249 
250     /*
251     ** when overall rx link congestion starts, RNR is sent to remote end point of data link connection
252     ** while rx link is congested, UI PDU is discarded.
253     */
254     UINT8           num_rx_buff;                    /* reserved number of rx UI/I PDU in queue      */
255     UINT8           overall_rx_congest_start;       /* threshold of overall rx congestion start     */
256     UINT8           overall_rx_congest_end;         /* threshold of overall rx congestion end       */
257     UINT8           max_num_ll_rx_buff;             /* max number of rx UI PDU in queue             */
258 
259     /*
260     ** threshold (number of rx UI PDU) is dynamically adjusted based on number of logical links
261     ** when number of rx UI PDU is more than ll_rx_congest_start, the oldest UI PDU is discarded
262     */
263     UINT8           ll_rx_congest_start;            /* rx congest start threshold for each logical link */
264 
265     UINT8           total_rx_ui_pdu;                /* total number of rx UI PDU in all of ui_rx_q  */
266     UINT8           total_rx_i_pdu;                 /* total number of rx I PDU in all of i_rx_q    */
267     BOOLEAN         overall_rx_congested;           /* TRUE if overall rx link is congested         */
268 } tLLCP_CB;
269 
270 #if (LLCP_TEST_INCLUDED == TRUE) /* this is for LLCP testing */
271 
272 typedef struct {
273     UINT8  version;
274     UINT16 wks;
275 } tLLCP_TEST_PARAMS;
276 
277 #endif
278 
279 #ifdef __cplusplus
280 extern "C" {
281 #endif
282 
283 
284 /*
285 ** LLCP global data
286 */
287 
288 #if (!defined LLCP_DYNAMIC_MEMORY) || (LLCP_DYNAMIC_MEMORY == FALSE)
289 LLCP_API extern tLLCP_CB  llcp_cb;
290 #else
291 LLCP_API extern tLLCP_CB *llcp_cb_ptr;
292 #define llcp_cb (*llcp_cb_ptr)
293 #endif
294 
295 /*
296 ** Functions provided by llcp_main.c
297 */
298 void llcp_init (void);
299 void llcp_cleanup (void);
300 void llcp_process_timeout (TIMER_LIST_ENT *p_tle);
301 
302 /*
303 ** Functions provided by llcp_link.c
304 */
305 tLLCP_STATUS llcp_link_activate (tLLCP_ACTIVATE_CONFIG *p_config);
306 void llcp_link_process_link_timeout (void);
307 void llcp_link_deactivate (UINT8 reason);
308 
309 void llcp_link_check_send_data (void);
310 void llcp_link_connection_cback (UINT8 conn_id, tNFC_CONN_EVT event, tNFC_CONN *p_data);
311 
312 /*
313 **  Functions provided by llcp_util.c
314 */
315 void         llcp_util_adjust_ll_congestion (void);
316 void         llcp_util_adjust_dl_rx_congestion (void);
317 void         llcp_util_check_rx_congested_status (void);
318 BOOLEAN      llcp_util_parse_link_params (UINT16 length, UINT8 *p_bytes);
319 tLLCP_STATUS llcp_util_send_ui (UINT8 ssap, UINT8 dsap, tLLCP_APP_CB *p_app_cb, BT_HDR *p_msg);
320 void         llcp_util_send_disc (UINT8 dsap, UINT8 ssap);
321 tLLCP_DLCB  *llcp_util_allocate_data_link (UINT8 reg_sap, UINT8 remote_sap);
322 void         llcp_util_deallocate_data_link (tLLCP_DLCB *p_dlcb);
323 tLLCP_STATUS llcp_util_send_connect (tLLCP_DLCB *p_dlcb, tLLCP_CONNECTION_PARAMS *p_params);
324 tLLCP_STATUS llcp_util_parse_connect (UINT8 *p_bytes, UINT16 length, tLLCP_CONNECTION_PARAMS *p_params);
325 tLLCP_STATUS llcp_util_send_cc (tLLCP_DLCB *p_dlcb, tLLCP_CONNECTION_PARAMS *p_params);
326 tLLCP_STATUS llcp_util_parse_cc (UINT8 *p_bytes, UINT16 length, UINT16 *p_miu, UINT8 *p_rw);
327 void         llcp_util_send_dm (UINT8 dsap, UINT8 ssap, UINT8 reason);
328 void         llcp_util_build_info_pdu (tLLCP_DLCB *p_dlcb, BT_HDR *p_msg);
329 tLLCP_STATUS llcp_util_send_frmr (tLLCP_DLCB *p_dlcb, UINT8 flags, UINT8 ptype, UINT8 sequence);
330 void         llcp_util_send_rr_rnr (tLLCP_DLCB *p_dlcb);
331 tLLCP_APP_CB *llcp_util_get_app_cb (UINT8 sap);
332 /*
333 ** Functions provided by llcp_dlc.c
334 */
335 tLLCP_STATUS llcp_dlsm_execute (tLLCP_DLCB *p_dlcb, tLLCP_DLC_EVENT event, void *p_data);
336 tLLCP_DLCB  *llcp_dlc_find_dlcb_by_sap (UINT8 local_sap, UINT8 remote_sap);
337 void         llcp_dlc_flush_q (tLLCP_DLCB *p_dlcb);
338 void         llcp_dlc_proc_i_pdu (UINT8 dsap, UINT8 ssap, UINT16 i_pdu_length, UINT8 *p_i_pdu, BT_HDR *p_msg);
339 void         llcp_dlc_proc_rx_pdu (UINT8 dsap, UINT8 ptype, UINT8 ssap, UINT16 length, UINT8 *p_data);
340 void         llcp_dlc_check_to_send_rr_rnr (void);
341 BOOLEAN      llcp_dlc_is_rw_open (tLLCP_DLCB *p_dlcb);
342 BT_HDR      *llcp_dlc_get_next_pdu (tLLCP_DLCB *p_dlcb);
343 UINT16       llcp_dlc_get_next_pdu_length (tLLCP_DLCB *p_dlcb);
344 
345 /*
346 ** Functions provided by llcp_sdp.c
347 */
348 void         llcp_sdp_proc_data (tLLCP_SAP_CBACK_DATA *p_data);
349 tLLCP_STATUS llcp_sdp_send_sdreq (UINT8 tid, char *p_name);
350 UINT8        llcp_sdp_get_sap_by_name (char *p_name, UINT8 length);
351 tLLCP_STATUS llcp_sdp_proc_snl (UINT16 sdu_length, UINT8 *p);
352 void         llcp_sdp_check_send_snl (void);
353 void         llcp_sdp_proc_deactivation (void);
354 #ifdef __cplusplus
355 }
356 #endif
357 
358 #endif
359