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