1/******************************************************************************
2 *
3 *  Copyright (C) 1999-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 L2CAP internal definitions
22 *
23 ******************************************************************************/
24#ifndef L2C_INT_H
25#define L2C_INT_H
26
27#include <stdbool.h>
28
29#include "osi/include/alarm.h"
30#include "osi/include/fixed_queue.h"
31#include "osi/include/list.h"
32#include "btm_api.h"
33#include "bt_common.h"
34#include "l2c_api.h"
35#include "l2cdefs.h"
36
37#define L2CAP_MIN_MTU   48      /* Minimum acceptable MTU is 48 bytes */
38
39/* LE credit based L2CAP connection parameters */
40#define L2CAP_LE_MIN_MTU            23
41#define L2CAP_LE_MIN_MPS            23
42#define L2CAP_LE_MAX_MPS            65533
43#define L2CAP_LE_MIN_CREDIT         0
44#define L2CAP_LE_MAX_CREDIT         65535
45#define L2CAP_LE_DEFAULT_MTU        512
46#define L2CAP_LE_DEFAULT_MPS        23
47#define L2CAP_LE_DEFAULT_CREDIT     1
48
49/*
50 * Timeout values (in milliseconds).
51 */
52#define L2CAP_LINK_ROLE_SWITCH_TIMEOUT_MS  (10 * 1000)  /* 10 seconds */
53#define L2CAP_LINK_CONNECT_TIMEOUT_MS      (60 * 1000)  /* 30 seconds */
54#define L2CAP_LINK_CONNECT_EXT_TIMEOUT_MS (120 * 1000)  /* 120 seconds */
55#define L2CAP_ECHO_RSP_TIMEOUT_MS          (30 * 1000)  /* 30 seconds */
56#define L2CAP_LINK_FLOW_CONTROL_TIMEOUT_MS  (2 * 1000)  /* 2 seconds */
57#define L2CAP_LINK_DISCONNECT_TIMEOUT_MS   (30 * 1000)  /* 30 seconds */
58#define L2CAP_CHNL_CONNECT_TIMEOUT_MS      (60 * 1000)  /* 60 seconds */
59#define L2CAP_CHNL_CONNECT_EXT_TIMEOUT_MS (120 * 1000)  /* 120 seconds */
60#define L2CAP_CHNL_CFG_TIMEOUT_MS          (30 * 1000)  /* 30 seconds */
61#define L2CAP_CHNL_DISCONNECT_TIMEOUT_MS   (10 * 1000)  /* 10 seconds */
62#define L2CAP_DELAY_CHECK_SM4_TIMEOUT_MS    (2 * 1000)  /* 2 seconds */
63#define L2CAP_WAIT_INFO_RSP_TIMEOUT_MS      (3 * 1000)  /* 3 seconds */
64#define L2CAP_BLE_LINK_CONNECT_TIMEOUT_MS  (30 * 1000)  /* 30 seconds */
65#define L2CAP_FCR_ACK_TIMEOUT_MS                  200   /* 200 milliseconds */
66
67/* Define the possible L2CAP channel states. The names of
68** the states may seem a bit strange, but they are taken from
69** the Bluetooth specification.
70*/
71typedef enum
72{
73    CST_CLOSED,                           /* Channel is in closed state           */
74    CST_ORIG_W4_SEC_COMP,                 /* Originator waits security clearence  */
75    CST_TERM_W4_SEC_COMP,                 /* Acceptor waits security clearence    */
76    CST_W4_L2CAP_CONNECT_RSP,             /* Waiting for peer conenct response    */
77    CST_W4_L2CA_CONNECT_RSP,              /* Waiting for upper layer connect rsp  */
78    CST_CONFIG,                           /* Negotiating configuration            */
79    CST_OPEN,                             /* Data transfer state                  */
80    CST_W4_L2CAP_DISCONNECT_RSP,          /* Waiting for peer disconnect rsp      */
81    CST_W4_L2CA_DISCONNECT_RSP            /* Waiting for upper layer disc rsp     */
82} tL2C_CHNL_STATE;
83
84/* Define the possible L2CAP link states
85*/
86typedef enum
87{
88    LST_DISCONNECTED,
89    LST_CONNECT_HOLDING,
90    LST_CONNECTING_WAIT_SWITCH,
91    LST_CONNECTING,
92    LST_CONNECTED,
93    LST_DISCONNECTING
94} tL2C_LINK_STATE;
95
96
97
98/* Define input events to the L2CAP link and channel state machines. The names
99** of the events may seem a bit strange, but they are taken from
100** the Bluetooth specification.
101*/
102#define L2CEVT_LP_CONNECT_CFM          0          /* Lower layer connect confirm          */
103#define L2CEVT_LP_CONNECT_CFM_NEG      1          /* Lower layer connect confirm (failed) */
104#define L2CEVT_LP_CONNECT_IND          2          /* Lower layer connect indication       */
105#define L2CEVT_LP_DISCONNECT_IND       3          /* Lower layer disconnect indication    */
106#define L2CEVT_LP_QOS_CFM              4          /* Lower layer QOS confirmation         */
107#define L2CEVT_LP_QOS_CFM_NEG          5          /* Lower layer QOS confirmation (failed)*/
108#define L2CEVT_LP_QOS_VIOLATION_IND    6          /* Lower layer QOS violation indication */
109
110#define L2CEVT_SEC_COMP                7          /* Security cleared successfully        */
111#define L2CEVT_SEC_COMP_NEG            8          /* Security procedure failed            */
112
113#define L2CEVT_L2CAP_CONNECT_REQ      10          /* Peer connection request              */
114#define L2CEVT_L2CAP_CONNECT_RSP      11          /* Peer connection response             */
115#define L2CEVT_L2CAP_CONNECT_RSP_PND  12          /* Peer connection response pending     */
116#define L2CEVT_L2CAP_CONNECT_RSP_NEG  13          /* Peer connection response (failed)    */
117#define L2CEVT_L2CAP_CONFIG_REQ       14          /* Peer configuration request           */
118#define L2CEVT_L2CAP_CONFIG_RSP       15          /* Peer configuration response          */
119#define L2CEVT_L2CAP_CONFIG_RSP_NEG   16          /* Peer configuration response (failed) */
120#define L2CEVT_L2CAP_DISCONNECT_REQ   17          /* Peer disconnect request              */
121#define L2CEVT_L2CAP_DISCONNECT_RSP   18          /* Peer disconnect response             */
122#define L2CEVT_L2CAP_INFO_RSP         19          /* Peer information response            */
123#define L2CEVT_L2CAP_DATA             20          /* Peer data                            */
124
125#define L2CEVT_L2CA_CONNECT_REQ       21          /* Upper layer connect request          */
126#define L2CEVT_L2CA_CONNECT_RSP       22          /* Upper layer connect response         */
127#define L2CEVT_L2CA_CONNECT_RSP_NEG   23          /* Upper layer connect response (failed)*/
128#define L2CEVT_L2CA_CONFIG_REQ        24          /* Upper layer config request           */
129#define L2CEVT_L2CA_CONFIG_RSP        25          /* Upper layer config response          */
130#define L2CEVT_L2CA_CONFIG_RSP_NEG    26          /* Upper layer config response (failed) */
131#define L2CEVT_L2CA_DISCONNECT_REQ    27          /* Upper layer disconnect request       */
132#define L2CEVT_L2CA_DISCONNECT_RSP    28          /* Upper layer disconnect response      */
133#define L2CEVT_L2CA_DATA_READ         29          /* Upper layer data read                */
134#define L2CEVT_L2CA_DATA_WRITE        30          /* Upper layer data write               */
135#define L2CEVT_L2CA_FLUSH_REQ         31          /* Upper layer flush                    */
136
137#define L2CEVT_TIMEOUT                32          /* Timeout                              */
138#define L2CEVT_SEC_RE_SEND_CMD        33          /* btm_sec has enough info to proceed   */
139
140#define L2CEVT_ACK_TIMEOUT            34          /* RR delay timeout                     */
141
142#define L2CEVT_L2CA_SEND_FLOW_CONTROL_CREDIT     35    /* Upper layer credit packet */
143#define L2CEVT_L2CAP_RECV_FLOW_CONTROL_CREDIT    36    /* Peer credit packet */
144
145/* Bitmask to skip over Broadcom feature reserved (ID) to avoid sending two
146   successive ID values, '0' id only or both */
147#define L2CAP_ADJ_BRCM_ID           0x1
148#define L2CAP_ADJ_ZERO_ID           0x2
149#define L2CAP_ADJ_ID                0x3
150
151/* Return values for l2cu_process_peer_cfg_req() */
152#define L2CAP_PEER_CFG_UNACCEPTABLE     0
153#define L2CAP_PEER_CFG_OK               1
154#define L2CAP_PEER_CFG_DISCONNECT       2
155
156/* eL2CAP option constants */
157#define L2CAP_MIN_RETRANS_TOUT          2000    /* Min retransmission timeout if no flush timeout or PBF */
158#define L2CAP_MIN_MONITOR_TOUT          12000   /* Min monitor timeout if no flush timeout or PBF */
159
160#define L2CAP_MAX_FCR_CFG_TRIES         2       /* Config attempts before disconnecting */
161
162typedef uint8_t tL2C_BLE_FIXED_CHNLS_MASK;
163
164typedef struct
165{
166    UINT8       next_tx_seq;                /* Next sequence number to be Tx'ed         */
167    UINT8       last_rx_ack;                /* Last sequence number ack'ed by the peer  */
168    UINT8       next_seq_expected;          /* Next peer sequence number expected       */
169    UINT8       last_ack_sent;              /* Last peer sequence number ack'ed         */
170    UINT8       num_tries;                  /* Number of retries to send a packet       */
171    UINT8       max_held_acks;              /* Max acks we can hold before sending      */
172
173    BOOLEAN     remote_busy;                /* TRUE if peer has flowed us off           */
174    BOOLEAN     local_busy;                 /* TRUE if we have flowed off the peer      */
175
176    BOOLEAN     rej_sent;                   /* Reject was sent                          */
177    BOOLEAN     srej_sent;                  /* Selective Reject was sent                */
178    BOOLEAN     wait_ack;                   /* Transmitter is waiting ack (poll sent)   */
179    BOOLEAN     rej_after_srej;             /* Send a REJ when SREJ clears              */
180
181    BOOLEAN     send_f_rsp;                 /* We need to send an F-bit response        */
182
183    UINT16      rx_sdu_len;                 /* Length of the SDU being received         */
184    BT_HDR      *p_rx_sdu;                  /* Buffer holding the SDU being received    */
185    fixed_queue_t *waiting_for_ack_q;       /* Buffers sent and waiting for peer to ack */
186    fixed_queue_t *srej_rcv_hold_q;         /* Buffers rcvd but held pending SREJ rsp   */
187    fixed_queue_t *retrans_q;               /* Buffers being retransmitted              */
188
189    alarm_t       *ack_timer;                /* Timer delaying RR                        */
190    alarm_t       *mon_retrans_timer;       /* Timer Monitor or Retransmission          */
191
192#if (L2CAP_ERTM_STATS == TRUE)
193    UINT32      connect_tick_count;         /* Time channel was established             */
194    UINT32      ertm_pkt_counts[2];         /* Packets sent and received                */
195    UINT32      ertm_byte_counts[2];        /* Bytes   sent and received                */
196    UINT32      s_frames_sent[4];           /* S-frames sent (RR, REJ, RNR, SREJ)       */
197    UINT32      s_frames_rcvd[4];           /* S-frames rcvd (RR, REJ, RNR, SREJ)       */
198    UINT32      xmit_window_closed;         /* # of times the xmit window was closed    */
199    UINT32      controller_idle;            /* # of times less than 2 packets in controller */
200                                            /* when the xmit window was closed          */
201    UINT32      pkts_retransmitted;         /* # of packets that were retransmitted     */
202    UINT32      retrans_touts;              /* # of retransmission timouts              */
203    UINT32      xmit_ack_touts;             /* # of xmit ack timouts                    */
204
205#define L2CAP_ERTM_STATS_NUM_AVG 10
206#define L2CAP_ERTM_STATS_AVG_NUM_SAMPLES 100
207    UINT32      ack_delay_avg_count;
208    UINT32      ack_delay_avg_index;
209    UINT32      throughput_start;
210    UINT32      throughput[L2CAP_ERTM_STATS_NUM_AVG];
211    UINT32      ack_delay_avg[L2CAP_ERTM_STATS_NUM_AVG];
212    UINT32      ack_delay_min[L2CAP_ERTM_STATS_NUM_AVG];
213    UINT32      ack_delay_max[L2CAP_ERTM_STATS_NUM_AVG];
214    UINT32      ack_q_count_avg[L2CAP_ERTM_STATS_NUM_AVG];
215    UINT32      ack_q_count_min[L2CAP_ERTM_STATS_NUM_AVG];
216    UINT32      ack_q_count_max[L2CAP_ERTM_STATS_NUM_AVG];
217#endif
218} tL2C_FCRB;
219
220
221/* Define a registration control block. Every application (e.g. RFCOMM, SDP,
222** TCS etc) that registers with L2CAP is assigned one of these.
223*/
224#if (L2CAP_UCD_INCLUDED == TRUE)
225#define L2C_UCD_RCB_ID              0x00
226#define L2C_UCD_STATE_UNUSED        0x00
227#define L2C_UCD_STATE_W4_DATA       0x01
228#define L2C_UCD_STATE_W4_RECEPTION  0x02
229#define L2C_UCD_STATE_W4_MTU        0x04
230
231typedef struct
232{
233    UINT8               state;
234    tL2CAP_UCD_CB_INFO  cb_info;
235} tL2C_UCD_REG;
236#endif
237
238typedef struct
239{
240    BOOLEAN                 in_use;
241    UINT16                  psm;
242    UINT16                  real_psm;               /* This may be a dummy RCB for an o/b connection but */
243                                                    /* this is the real PSM that we need to connect to   */
244#if (L2CAP_UCD_INCLUDED == TRUE)
245    tL2C_UCD_REG            ucd;
246#endif
247
248    tL2CAP_APPL_INFO        api;
249} tL2C_RCB;
250
251
252#ifndef L2CAP_CBB_DEFAULT_DATA_RATE_BUFF_QUOTA
253#define L2CAP_CBB_DEFAULT_DATA_RATE_BUFF_QUOTA 100
254#endif
255
256typedef void (tL2CAP_SEC_CBACK) (BD_ADDR bd_addr, tBT_TRANSPORT trasnport,
257                                void *p_ref_data, tBTM_STATUS result);
258
259typedef struct
260{
261    UINT16                  psm;
262    tBT_TRANSPORT           transport;
263    BOOLEAN                 is_originator;
264    tL2CAP_SEC_CBACK        *p_callback;
265    void                    *p_ref_data;
266}tL2CAP_SEC_DATA;
267
268/* Define a channel control block (CCB). There may be many channel control blocks
269** between the same two Bluetooth devices (i.e. on the same link).
270** Each CCB has unique local and remote CIDs. All channel control blocks on
271** the same physical link and are chained together.
272*/
273typedef struct t_l2c_ccb
274{
275    BOOLEAN             in_use;                 /* TRUE when in use, FALSE when not */
276    tL2C_CHNL_STATE     chnl_state;             /* Channel state                    */
277    tL2CAP_LE_CFG_INFO  local_conn_cfg;         /* Our config for ble conn oriented channel */
278    tL2CAP_LE_CFG_INFO  peer_conn_cfg;          /* Peer device config ble conn oriented channel */
279    BOOLEAN             is_first_seg;           /* Dtermine whether the received packet is the first segment or not */
280    BT_HDR*             ble_sdu;                /* Buffer for storing unassembled sdu*/
281    UINT16              ble_sdu_length;         /* Length of unassembled sdu length*/
282    struct t_l2c_ccb    *p_next_ccb;            /* Next CCB in the chain            */
283    struct t_l2c_ccb    *p_prev_ccb;            /* Previous CCB in the chain        */
284    struct t_l2c_linkcb *p_lcb;                 /* Link this CCB is assigned to     */
285
286    UINT16              local_cid;              /* Local CID                        */
287    UINT16              remote_cid;             /* Remote CID                       */
288
289    alarm_t             *l2c_ccb_timer;         /* CCB Timer Entry */
290
291    tL2C_RCB            *p_rcb;                 /* Registration CB for this Channel */
292    bool                should_free_rcb;        /* True if RCB was allocated on the heap */
293
294#define IB_CFG_DONE     0x01
295#define OB_CFG_DONE     0x02
296#define RECONFIG_FLAG   0x04                    /* True after initial configuration */
297#define CFG_DONE_MASK   (IB_CFG_DONE | OB_CFG_DONE)
298
299    UINT8               config_done;            /* Configuration flag word         */
300    UINT8               local_id;               /* Transaction ID for local trans  */
301    UINT8               remote_id;              /* Transaction ID for local  */
302
303#define CCB_FLAG_NO_RETRY       0x01            /* no more retry */
304#define CCB_FLAG_SENT_PENDING   0x02            /* already sent pending response */
305    UINT8               flags;
306
307    tL2CAP_CFG_INFO     our_cfg;                /* Our saved configuration options    */
308    tL2CAP_CH_CFG_BITS  peer_cfg_bits;          /* Store what peer wants to configure */
309    tL2CAP_CFG_INFO     peer_cfg;               /* Peer's saved configuration options */
310
311    fixed_queue_t       *xmit_hold_q;            /* Transmit data hold queue         */
312    BOOLEAN             cong_sent;              /* Set when congested status sent   */
313    UINT16              buff_quota;             /* Buffer quota before sending congestion   */
314
315    tL2CAP_CHNL_PRIORITY ccb_priority;          /* Channel priority                 */
316    tL2CAP_CHNL_DATA_RATE tx_data_rate;         /* Channel Tx data rate             */
317    tL2CAP_CHNL_DATA_RATE rx_data_rate;         /* Channel Rx data rate             */
318
319    /* Fields used for eL2CAP */
320    tL2CAP_ERTM_INFO    ertm_info;
321    tL2C_FCRB           fcrb;
322    UINT16              tx_mps;                 /* TX MPS adjusted based on current controller */
323    UINT16              max_rx_mtu;
324    UINT8               fcr_cfg_tries;          /* Max number of negotiation attempts */
325    BOOLEAN             peer_cfg_already_rejected; /* If mode rejected once, set to TRUE */
326    BOOLEAN             out_cfg_fcr_present;    /* TRUE if cfg response shoulkd include fcr options */
327
328#define L2CAP_CFG_FCS_OUR   0x01                /* Our desired config FCS option */
329#define L2CAP_CFG_FCS_PEER  0x02                /* Peer's desired config FCS option */
330#define L2CAP_BYPASS_FCS    (L2CAP_CFG_FCS_OUR | L2CAP_CFG_FCS_PEER)
331    UINT8               bypass_fcs;
332
333#if (L2CAP_NON_FLUSHABLE_PB_INCLUDED == TRUE)
334    BOOLEAN             is_flushable;                   /* TRUE if channel is flushable     */
335#endif
336
337#if (L2CAP_NUM_FIXED_CHNLS > 0) || (L2CAP_UCD_INCLUDED == TRUE)
338    UINT16              fixed_chnl_idle_tout;   /* Idle timeout to use for the fixed channel       */
339#endif
340    UINT16              tx_data_len;
341} tL2C_CCB;
342
343/***********************************************************************
344** Define a queue of linked CCBs.
345*/
346typedef struct
347{
348    tL2C_CCB        *p_first_ccb;               /* The first channel in this queue */
349    tL2C_CCB        *p_last_ccb;                /* The last  channel in this queue */
350} tL2C_CCB_Q;
351
352#if (L2CAP_ROUND_ROBIN_CHANNEL_SERVICE == TRUE)
353
354/* Round-Robin service for the same priority channels */
355#define L2CAP_NUM_CHNL_PRIORITY     3           /* Total number of priority group (high, medium, low)*/
356#define L2CAP_CHNL_PRIORITY_WEIGHT  5           /* weight per priority for burst transmission quota */
357#define L2CAP_GET_PRIORITY_QUOTA(pri) ((L2CAP_NUM_CHNL_PRIORITY - (pri)) * L2CAP_CHNL_PRIORITY_WEIGHT)
358
359/* CCBs within the same LCB are served in round robin with priority                       */
360/* It will make sure that low priority channel (for example, HF signaling on RFCOMM)      */
361/* can be sent to headset even if higher priority channel (for example, AV media channel) */
362/* is congested.                                                                          */
363
364typedef struct
365{
366    tL2C_CCB        *p_serve_ccb;               /* current serving ccb within priority group */
367    tL2C_CCB        *p_first_ccb;               /* first ccb of priority group */
368    UINT8           num_ccb;                    /* number of channels in priority group */
369    UINT8           quota;                      /* burst transmission quota */
370} tL2C_RR_SERV;
371
372#endif /* (L2CAP_ROUND_ROBIN_CHANNEL_SERVICE == TRUE) */
373
374/* Define a link control block. There is one link control block between
375** this device and any other device (i.e. BD ADDR).
376*/
377typedef struct t_l2c_linkcb
378{
379    BOOLEAN             in_use;                     /* TRUE when in use, FALSE when not */
380    tL2C_LINK_STATE     link_state;
381
382    alarm_t             *l2c_lcb_timer;             /* Timer entry for timeout evt */
383    UINT16              handle;                     /* The handle used with LM          */
384
385    tL2C_CCB_Q          ccb_queue;                  /* Queue of CCBs on this LCB        */
386
387    tL2C_CCB            *p_pending_ccb;             /* ccb of waiting channel during link disconnect */
388    alarm_t             *info_resp_timer;           /* Timer entry for info resp timeout evt */
389    BD_ADDR             remote_bd_addr;             /* The BD address of the remote     */
390
391    UINT8               link_role;                  /* Master or slave                  */
392    UINT8               id;
393    UINT8               cur_echo_id;                /* Current id value for echo request */
394    tL2CA_ECHO_RSP_CB   *p_echo_rsp_cb;             /* Echo response callback           */
395    UINT16              idle_timeout;               /* Idle timeout                     */
396    BOOLEAN             is_bonding;                 /* True - link active only for bonding */
397
398    UINT16              link_flush_tout;            /* Flush timeout used               */
399
400    UINT16              link_xmit_quota;            /* Num outstanding pkts allowed     */
401    UINT16              sent_not_acked;             /* Num packets sent but not acked   */
402
403    BOOLEAN             partial_segment_being_sent; /* Set TRUE when a partial segment  */
404                                                    /* is being sent.                   */
405    BOOLEAN             w4_info_rsp;                /* TRUE when info request is active */
406    UINT8               info_rx_bits;               /* set 1 if received info type */
407    UINT32              peer_ext_fea;               /* Peer's extended features mask    */
408    list_t              *link_xmit_data_q;          /* Link transmit data buffer queue  */
409
410    UINT8               peer_chnl_mask[L2CAP_FIXED_CHNL_ARRAY_SIZE];
411#if (L2CAP_UCD_INCLUDED == TRUE)
412    UINT16              ucd_mtu;                    /* peer MTU on UCD */
413    fixed_queue_t       *ucd_out_sec_pending_q;     /* Security pending outgoing UCD packet  */
414    fixed_queue_t       *ucd_in_sec_pending_q;       /* Security pending incoming UCD packet  */
415#endif
416
417    BT_HDR              *p_hcit_rcv_acl;            /* Current HCIT ACL buf being rcvd  */
418    UINT16              idle_timeout_sv;            /* Save current Idle timeout        */
419    UINT8               acl_priority;               /* L2C_PRIORITY_NORMAL or L2C_PRIORITY_HIGH */
420    tL2CA_NOCP_CB       *p_nocp_cb;                 /* Num Cmpl pkts callback           */
421
422#if (L2CAP_NUM_FIXED_CHNLS > 0)
423    tL2C_CCB            *p_fixed_ccbs[L2CAP_NUM_FIXED_CHNLS];
424    UINT16              disc_reason;
425#endif
426
427    tBT_TRANSPORT       transport;
428#if (BLE_INCLUDED == TRUE)
429    tBLE_ADDR_TYPE      ble_addr_type;
430    UINT16              tx_data_len;            /* tx data length used in data length extension */
431    fixed_queue_t       *le_sec_pending_q;      /* LE coc channels waiting for security check completion */
432    UINT8               sec_act;
433#define L2C_BLE_CONN_UPDATE_DISABLE 0x1  /* disable update connection parameters */
434#define L2C_BLE_NEW_CONN_PARAM      0x2  /* new connection parameter to be set */
435#define L2C_BLE_UPDATE_PENDING      0x4  /* waiting for connection update finished */
436#define L2C_BLE_NOT_DEFAULT_PARAM   0x8  /* not using default connection parameters */
437    UINT8               conn_update_mask;
438
439    UINT16              min_interval; /* parameters as requested by peripheral */
440    UINT16              max_interval;
441    UINT16              latency;
442    UINT16              timeout;
443
444#endif
445
446#if (L2CAP_ROUND_ROBIN_CHANNEL_SERVICE == TRUE)
447    /* each priority group is limited burst transmission  */
448    /* round robin service for the same priority channels */
449    tL2C_RR_SERV        rr_serv[L2CAP_NUM_CHNL_PRIORITY];
450    UINT8               rr_pri;                             /* current serving priority group */
451#endif
452
453} tL2C_LCB;
454
455/* Define the L2CAP control structure
456*/
457typedef struct
458{
459    UINT8           l2cap_trace_level;
460    UINT16          controller_xmit_window;         /* Total ACL window for all links   */
461
462    UINT16          round_robin_quota;              /* Round-robin link quota           */
463    UINT16          round_robin_unacked;            /* Round-robin unacked              */
464    BOOLEAN         check_round_robin;              /* Do a round robin check           */
465
466    BOOLEAN         is_cong_cback_context;
467
468    tL2C_LCB        lcb_pool[MAX_L2CAP_LINKS];      /* Link Control Block pool          */
469    tL2C_CCB        ccb_pool[MAX_L2CAP_CHANNELS];   /* Channel Control Block pool       */
470    tL2C_RCB        rcb_pool[MAX_L2CAP_CLIENTS];    /* Registration info pool           */
471
472    tL2C_CCB        *p_free_ccb_first;              /* Pointer to first free CCB        */
473    tL2C_CCB        *p_free_ccb_last;               /* Pointer to last  free CCB        */
474
475    UINT8           desire_role;                    /* desire to be master/slave when accepting a connection */
476    BOOLEAN         disallow_switch;                /* FALSE, to allow switch at create conn */
477    UINT16          num_lm_acl_bufs;                /* # of ACL buffers on controller   */
478    UINT16          idle_timeout;                   /* Idle timeout                     */
479
480    list_t          *rcv_pending_q;                 /* Recv pending queue               */
481    alarm_t         *receive_hold_timer;            /* Timer entry for rcv hold    */
482
483    tL2C_LCB        *p_cur_hcit_lcb;                /* Current HCI Transport buffer     */
484    UINT16          num_links_active;               /* Number of links active           */
485
486#if (L2CAP_NON_FLUSHABLE_PB_INCLUDED == TRUE)
487    UINT16          non_flushable_pbf;              /* L2CAP_PKT_START_NON_FLUSHABLE if controller supports */
488                                                    /* Otherwise, L2CAP_PKT_START */
489    BOOLEAN         is_flush_active;                /* TRUE if an HCI_Enhanced_Flush has been sent */
490#endif
491
492#if L2CAP_CONFORMANCE_TESTING == TRUE
493    UINT32          test_info_resp;                 /* Conformance testing needs a dynamic response */
494#endif
495
496#if (L2CAP_NUM_FIXED_CHNLS > 0)
497    tL2CAP_FIXED_CHNL_REG   fixed_reg[L2CAP_NUM_FIXED_CHNLS];   /* Reg info for fixed channels */
498#endif
499
500#if (BLE_INCLUDED == TRUE)
501    UINT16                   num_ble_links_active;               /* Number of LE links active           */
502    BOOLEAN                  is_ble_connecting;
503    BD_ADDR                  ble_connecting_bda;
504    UINT16                   controller_le_xmit_window;         /* Total ACL window for all links   */
505    tL2C_BLE_FIXED_CHNLS_MASK l2c_ble_fixed_chnls_mask;         // LE fixed channels mask
506    UINT16                   num_lm_ble_bufs;                   /* # of ACL buffers on controller   */
507    UINT16                   ble_round_robin_quota;              /* Round-robin link quota           */
508    UINT16                   ble_round_robin_unacked;            /* Round-robin unacked              */
509    BOOLEAN                  ble_check_round_robin;              /* Do a round robin check           */
510    tL2C_RCB                 ble_rcb_pool[BLE_MAX_L2CAP_CLIENTS]; /* Registration info pool           */
511#endif
512
513    tL2CA_ECHO_DATA_CB      *p_echo_data_cb;                /* Echo data callback */
514
515#if (defined(L2CAP_HIGH_PRI_CHAN_QUOTA_IS_CONFIGURABLE) && (L2CAP_HIGH_PRI_CHAN_QUOTA_IS_CONFIGURABLE == TRUE))
516    UINT16              high_pri_min_xmit_quota;    /* Minimum number of ACL credit for high priority link */
517#endif /* (L2CAP_HIGH_PRI_CHAN_QUOTA_IS_CONFIGURABLE == TRUE) */
518
519    UINT16          dyn_psm;
520} tL2C_CB;
521
522
523
524/* Define a structure that contains the information about a connection.
525** This structure is used to pass between functions, and not all the
526** fields will always be filled in.
527*/
528typedef struct
529{
530    BD_ADDR         bd_addr;                        /* Remote BD address        */
531    UINT8           status;                         /* Connection status        */
532    UINT16          psm;                            /* PSM of the connection    */
533    UINT16          l2cap_result;                   /* L2CAP result             */
534    UINT16          l2cap_status;                   /* L2CAP status             */
535    UINT16          remote_cid;                     /* Remote CID               */
536} tL2C_CONN_INFO;
537
538
539typedef void (tL2C_FCR_MGMT_EVT_HDLR) (UINT8, tL2C_CCB *);
540
541/* The offset in a buffer that L2CAP will use when building commands.
542*/
543#define L2CAP_SEND_CMD_OFFSET       0
544
545
546/* Number of ACL buffers to use for high priority channel
547*/
548#if (!defined(L2CAP_HIGH_PRI_CHAN_QUOTA_IS_CONFIGURABLE) || (L2CAP_HIGH_PRI_CHAN_QUOTA_IS_CONFIGURABLE == FALSE))
549#define L2CAP_HIGH_PRI_MIN_XMIT_QUOTA_A     (L2CAP_HIGH_PRI_MIN_XMIT_QUOTA)
550#else
551#define L2CAP_HIGH_PRI_MIN_XMIT_QUOTA_A     (l2cb.high_pri_min_xmit_quota)
552#endif
553
554#ifdef __cplusplus
555extern "C" {
556#endif
557
558
559/* L2CAP global data
560************************************
561*/
562#if (!defined L2C_DYNAMIC_MEMORY) || (L2C_DYNAMIC_MEMORY == FALSE)
563extern tL2C_CB  l2cb;
564#else
565extern tL2C_CB *l2c_cb_ptr;
566#define l2cb (*l2c_cb_ptr)
567#endif
568
569
570/* Functions provided by l2c_main.c
571************************************
572*/
573void l2c_init(void);
574void l2c_free(void);
575
576extern void     l2c_receive_hold_timer_timeout(void *data);
577extern void     l2c_ccb_timer_timeout(void *data);
578extern void     l2c_lcb_timer_timeout(void *data);
579extern void     l2c_fcrb_ack_timer_timeout(void *data);
580extern UINT8    l2c_data_write (UINT16 cid, BT_HDR *p_data, UINT16 flag);
581extern void     l2c_rcv_acl_data (BT_HDR *p_msg);
582extern void     l2c_process_held_packets (BOOLEAN timed_out);
583
584/* Functions provided by l2c_utils.c
585************************************
586*/
587extern tL2C_LCB *l2cu_allocate_lcb (BD_ADDR p_bd_addr, BOOLEAN is_bonding, tBT_TRANSPORT transport);
588extern BOOLEAN  l2cu_start_post_bond_timer (UINT16 handle);
589extern void     l2cu_release_lcb (tL2C_LCB *p_lcb);
590extern tL2C_LCB *l2cu_find_lcb_by_bd_addr (BD_ADDR p_bd_addr, tBT_TRANSPORT transport);
591extern tL2C_LCB *l2cu_find_lcb_by_handle (UINT16 handle);
592extern void     l2cu_update_lcb_4_bonding (BD_ADDR p_bd_addr, BOOLEAN is_bonding);
593
594extern UINT8    l2cu_get_conn_role (tL2C_LCB *p_this_lcb);
595extern BOOLEAN  l2cu_set_acl_priority (BD_ADDR bd_addr, UINT8 priority, BOOLEAN reset_after_rs);
596
597extern void     l2cu_enqueue_ccb (tL2C_CCB *p_ccb);
598extern void     l2cu_dequeue_ccb (tL2C_CCB *p_ccb);
599extern void     l2cu_change_pri_ccb (tL2C_CCB *p_ccb, tL2CAP_CHNL_PRIORITY priority);
600
601extern tL2C_CCB *l2cu_allocate_ccb (tL2C_LCB *p_lcb, UINT16 cid);
602extern void     l2cu_release_ccb (tL2C_CCB *p_ccb);
603extern tL2C_CCB *l2cu_find_ccb_by_cid (tL2C_LCB *p_lcb, UINT16 local_cid);
604extern tL2C_CCB *l2cu_find_ccb_by_remote_cid (tL2C_LCB *p_lcb, UINT16 remote_cid);
605extern void     l2cu_adj_id (tL2C_LCB *p_lcb, UINT8 adj_mask);
606extern BOOLEAN  l2c_is_cmd_rejected (UINT8 cmd_code, UINT8 id, tL2C_LCB *p_lcb);
607
608extern void     l2cu_send_peer_cmd_reject (tL2C_LCB *p_lcb, UINT16 reason,
609                                           UINT8 rem_id,UINT16 p1, UINT16 p2);
610extern void     l2cu_send_peer_connect_req (tL2C_CCB *p_ccb);
611extern void     l2cu_send_peer_connect_rsp (tL2C_CCB *p_ccb, UINT16 result, UINT16 status);
612extern void     l2cu_send_peer_config_req (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
613extern void     l2cu_send_peer_config_rsp (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
614extern void     l2cu_send_peer_config_rej (tL2C_CCB *p_ccb, UINT8 *p_data, UINT16 data_len, UINT16 rej_len);
615extern void     l2cu_send_peer_disc_req (tL2C_CCB *p_ccb);
616extern void     l2cu_send_peer_disc_rsp (tL2C_LCB *p_lcb, UINT8 remote_id, UINT16 local_cid, UINT16 remote_cid);
617extern void     l2cu_send_peer_echo_req (tL2C_LCB *p_lcb, UINT8 *p_data, UINT16 data_len);
618extern void     l2cu_send_peer_echo_rsp (tL2C_LCB *p_lcb, UINT8 id, UINT8 *p_data, UINT16 data_len);
619extern void     l2cu_send_peer_info_rsp (tL2C_LCB *p_lcb, UINT8 id, UINT16 info_type);
620extern void     l2cu_reject_connection (tL2C_LCB *p_lcb, UINT16 remote_cid, UINT8 rem_id, UINT16 result);
621extern void     l2cu_send_peer_info_req (tL2C_LCB *p_lcb, UINT16 info_type);
622extern void     l2cu_set_acl_hci_header (BT_HDR *p_buf, tL2C_CCB *p_ccb);
623extern void     l2cu_check_channel_congestion (tL2C_CCB *p_ccb);
624extern void     l2cu_disconnect_chnl (tL2C_CCB *p_ccb);
625
626#if (L2CAP_NON_FLUSHABLE_PB_INCLUDED == TRUE)
627extern void     l2cu_set_non_flushable_pbf(BOOLEAN);
628#endif
629
630#if (BLE_INCLUDED == TRUE)
631extern void l2cu_send_peer_ble_par_req (tL2C_LCB *p_lcb, UINT16 min_int, UINT16 max_int, UINT16 latency, UINT16 timeout);
632extern void l2cu_send_peer_ble_par_rsp (tL2C_LCB *p_lcb, UINT16 reason, UINT8 rem_id);
633extern void l2cu_reject_ble_connection (tL2C_LCB *p_lcb, UINT8 rem_id, UINT16 result);
634extern void l2cu_send_peer_ble_credit_based_conn_res (tL2C_CCB *p_ccb, UINT16 result);
635extern void l2cu_send_peer_ble_credit_based_conn_req (tL2C_CCB *p_ccb);
636extern void l2cu_send_peer_ble_flow_control_credit(tL2C_CCB *p_ccb, UINT16 credit_value);
637extern void l2cu_send_peer_ble_credit_based_disconn_req(tL2C_CCB *p_ccb);
638#endif
639
640extern BOOLEAN l2cu_initialize_fixed_ccb (tL2C_LCB *p_lcb, UINT16 fixed_cid, tL2CAP_FCR_OPTS *p_fcr);
641extern void    l2cu_no_dynamic_ccbs (tL2C_LCB *p_lcb);
642extern void    l2cu_process_fixed_chnl_resp (tL2C_LCB *p_lcb);
643
644/* Functions provided by l2c_ucd.c
645************************************
646*/
647#if (L2CAP_UCD_INCLUDED == TRUE)
648void l2c_ucd_delete_sec_pending_q(tL2C_LCB  *p_lcb);
649void l2c_ucd_enqueue_pending_out_sec_q(tL2C_CCB  *p_ccb, void *p_data);
650BOOLEAN l2c_ucd_check_pending_info_req(tL2C_CCB  *p_ccb);
651BOOLEAN l2c_ucd_check_pending_out_sec_q(tL2C_CCB  *p_ccb);
652void l2c_ucd_send_pending_out_sec_q(tL2C_CCB  *p_ccb);
653void l2c_ucd_discard_pending_out_sec_q(tL2C_CCB  *p_ccb);
654BOOLEAN l2c_ucd_check_pending_in_sec_q(tL2C_CCB  *p_ccb);
655void l2c_ucd_send_pending_in_sec_q(tL2C_CCB  *p_ccb);
656void l2c_ucd_discard_pending_in_sec_q(tL2C_CCB  *p_ccb);
657BOOLEAN l2c_ucd_check_rx_pkts(tL2C_LCB  *p_lcb, BT_HDR *p_msg);
658BOOLEAN l2c_ucd_process_event(tL2C_CCB *p_ccb, UINT16 event, void *p_data);
659#endif
660
661/* Functions provided for Broadcom Aware
662****************************************
663*/
664extern BOOLEAN  l2cu_check_feature_req (tL2C_LCB *p_lcb, UINT8 id, UINT8 *p_data, UINT16 data_len);
665extern void     l2cu_check_feature_rsp (tL2C_LCB *p_lcb, UINT8 id, UINT8 *p_data, UINT16 data_len);
666extern void     l2cu_send_feature_req (tL2C_CCB *p_ccb);
667
668extern tL2C_RCB *l2cu_allocate_rcb (UINT16 psm);
669extern tL2C_RCB *l2cu_find_rcb_by_psm (UINT16 psm);
670extern void     l2cu_release_rcb (tL2C_RCB *p_rcb);
671extern tL2C_RCB *l2cu_allocate_ble_rcb (UINT16 psm);
672extern tL2C_RCB *l2cu_find_ble_rcb_by_psm (UINT16 psm);
673
674extern UINT8    l2cu_process_peer_cfg_req (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
675extern void     l2cu_process_peer_cfg_rsp (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
676extern void     l2cu_process_our_cfg_req (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
677extern void     l2cu_process_our_cfg_rsp (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
678
679extern void     l2cu_device_reset (void);
680extern tL2C_LCB *l2cu_find_lcb_by_state (tL2C_LINK_STATE state);
681extern BOOLEAN  l2cu_lcb_disconnecting (void);
682
683extern BOOLEAN l2cu_create_conn (tL2C_LCB *p_lcb, tBT_TRANSPORT transport);
684extern BOOLEAN l2cu_create_conn_after_switch (tL2C_LCB *p_lcb);
685extern BT_HDR *l2cu_get_next_buffer_to_send (tL2C_LCB *p_lcb);
686extern void    l2cu_resubmit_pending_sec_req (BD_ADDR p_bda);
687extern void    l2cu_initialize_amp_ccb (tL2C_LCB *p_lcb);
688extern void    l2cu_adjust_out_mps (tL2C_CCB *p_ccb);
689
690/* Functions provided by l2c_link.c
691************************************
692*/
693extern BOOLEAN  l2c_link_hci_conn_req (BD_ADDR bd_addr);
694extern BOOLEAN  l2c_link_hci_conn_comp (UINT8 status, UINT16 handle, BD_ADDR p_bda);
695extern BOOLEAN  l2c_link_hci_disc_comp (UINT16 handle, UINT8 reason);
696extern BOOLEAN  l2c_link_hci_qos_violation (UINT16 handle);
697extern void     l2c_link_timeout (tL2C_LCB *p_lcb);
698extern void     l2c_info_resp_timer_timeout(void *data);
699extern void     l2c_link_check_send_pkts (tL2C_LCB *p_lcb, tL2C_CCB *p_ccb, BT_HDR *p_buf);
700extern void     l2c_link_adjust_allocation (void);
701extern void     l2c_link_process_num_completed_pkts (UINT8 *p);
702extern void     l2c_link_process_num_completed_blocks (UINT8 controller_id, UINT8 *p, UINT16 evt_len);
703extern void     l2c_link_processs_num_bufs (UINT16 num_lm_acl_bufs);
704extern UINT8    l2c_link_pkts_rcvd (UINT16 *num_pkts, UINT16 *handles);
705extern void     l2c_link_role_changed (BD_ADDR bd_addr, UINT8 new_role, UINT8 hci_status);
706extern void     l2c_link_sec_comp (BD_ADDR p_bda, tBT_TRANSPORT trasnport, void *p_ref_data, UINT8 status);
707extern void     l2c_link_segments_xmitted (BT_HDR *p_msg);
708extern void     l2c_pin_code_request (BD_ADDR bd_addr);
709extern void     l2c_link_adjust_chnl_allocation (void);
710
711#if (BLE_INCLUDED == TRUE)
712extern void     l2c_link_processs_ble_num_bufs (UINT16 num_lm_acl_bufs);
713#endif
714
715#if L2CAP_WAKE_PARKED_LINK == TRUE
716extern BOOLEAN  l2c_link_check_power_mode ( tL2C_LCB *p_lcb );
717#define L2C_LINK_CHECK_POWER_MODE(x) l2c_link_check_power_mode ((x))
718#else  // L2CAP_WAKE_PARKED_LINK
719#define L2C_LINK_CHECK_POWER_MODE(x) (FALSE)
720#endif  // L2CAP_WAKE_PARKED_LINK
721
722#if L2CAP_CONFORMANCE_TESTING == TRUE
723/* Used only for conformance testing */
724extern void l2cu_set_info_rsp_mask (UINT32 mask);
725#endif
726
727/* Functions provided by l2c_csm.c
728************************************
729*/
730extern void l2c_csm_execute (tL2C_CCB *p_ccb, UINT16 event, void *p_data);
731
732extern void l2c_enqueue_peer_data (tL2C_CCB *p_ccb, BT_HDR *p_buf);
733
734
735/* Functions provided by l2c_fcr.c
736************************************
737*/
738extern void     l2c_fcr_cleanup (tL2C_CCB *p_ccb);
739extern void     l2c_fcr_proc_pdu (tL2C_CCB *p_ccb, BT_HDR *p_buf);
740extern void     l2c_fcr_proc_tout (tL2C_CCB *p_ccb);
741extern void     l2c_fcr_proc_ack_tout (tL2C_CCB *p_ccb);
742extern void     l2c_fcr_send_S_frame (tL2C_CCB *p_ccb, UINT16 function_code, UINT16 pf_bit);
743extern BT_HDR   *l2c_fcr_clone_buf(BT_HDR *p_buf, UINT16 new_offset, UINT16 no_of_bytes);
744extern BOOLEAN  l2c_fcr_is_flow_controlled (tL2C_CCB *p_ccb);
745extern BT_HDR   *l2c_fcr_get_next_xmit_sdu_seg (tL2C_CCB *p_ccb, UINT16 max_packet_length);
746extern void     l2c_fcr_start_timer (tL2C_CCB *p_ccb);
747extern void     l2c_lcc_proc_pdu (tL2C_CCB *p_ccb, BT_HDR *p_buf);
748extern BT_HDR   *l2c_lcc_get_next_xmit_sdu_seg (tL2C_CCB *p_ccb, UINT16 max_packet_length);
749
750/* Configuration negotiation */
751extern UINT8    l2c_fcr_chk_chan_modes (tL2C_CCB *p_ccb);
752extern BOOLEAN  l2c_fcr_adj_our_req_options (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
753extern void     l2c_fcr_adj_our_rsp_options (tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_peer_cfg);
754extern BOOLEAN  l2c_fcr_renegotiate_chan(tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
755extern UINT8    l2c_fcr_process_peer_cfg_req(tL2C_CCB *p_ccb, tL2CAP_CFG_INFO *p_cfg);
756extern void     l2c_fcr_adj_monitor_retran_timeout (tL2C_CCB *p_ccb);
757extern void     l2c_fcr_stop_timer (tL2C_CCB *p_ccb);
758
759/* Functions provided by l2c_ble.c
760************************************
761*/
762#if (BLE_INCLUDED == TRUE)
763extern BOOLEAN l2cble_create_conn (tL2C_LCB *p_lcb);
764extern void l2cble_process_sig_cmd (tL2C_LCB *p_lcb, UINT8 *p, UINT16 pkt_len);
765extern void l2cble_conn_comp (UINT16 handle, UINT8 role, BD_ADDR bda, tBLE_ADDR_TYPE type,
766                              UINT16 conn_interval, UINT16 conn_latency, UINT16 conn_timeout);
767extern BOOLEAN l2cble_init_direct_conn (tL2C_LCB *p_lcb);
768extern void l2cble_notify_le_connection (BD_ADDR bda);
769extern void l2c_ble_link_adjust_allocation (void);
770extern void l2cble_process_conn_update_evt (UINT16 handle, UINT8 status);
771
772extern void l2cble_credit_based_conn_req (tL2C_CCB *p_ccb);
773extern void l2cble_credit_based_conn_res (tL2C_CCB *p_ccb, UINT16 result);
774extern void l2cble_send_peer_disc_req(tL2C_CCB *p_ccb);
775extern void l2cble_send_flow_control_credit(tL2C_CCB *p_ccb, UINT16 credit_value);
776extern BOOLEAN l2ble_sec_access_req(BD_ADDR bd_addr, UINT16 psm, BOOLEAN is_originator, tL2CAP_SEC_CBACK *p_callback, void *p_ref_data);
777
778#if (defined BLE_LLT_INCLUDED) && (BLE_LLT_INCLUDED == TRUE)
779extern void l2cble_process_rc_param_request_evt(UINT16 handle, UINT16 int_min, UINT16 int_max,
780                                                        UINT16 latency, UINT16 timeout);
781#endif
782
783extern void l2cble_update_data_length(tL2C_LCB *p_lcb);
784extern void l2cble_set_fixed_channel_tx_data_length(BD_ADDR remote_bda, UINT16 fix_cid,
785                                                                UINT16 tx_mtu);
786extern void l2cble_process_data_length_change_event(UINT16 handle, UINT16 tx_data_len,
787                                                                UINT16 rx_data_len);
788
789#endif
790extern void l2cu_process_fixed_disc_cback (tL2C_LCB *p_lcb);
791
792#ifdef __cplusplus
793}
794#endif
795
796#endif
797