Home | History | Annotate | Download | only in avct
      1 /******************************************************************************
      2  *
      3  *  Copyright (C) 2003-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 interfaces which are internal to AVCTP.
     22  *
     23  ******************************************************************************/
     24 #ifndef AVCT_INT_H
     25 #define AVCT_INT_H
     26 
     27 #include "osi/include/fixed_queue.h"
     28 #include "bt_common.h"
     29 #include "avct_api.h"
     30 #include "avct_defs.h"
     31 #include "l2c_api.h"
     32 
     33 /*****************************************************************************
     34 ** constants
     35 *****************************************************************************/
     36 
     37 /* lcb state machine events */
     38 enum {
     39     AVCT_LCB_UL_BIND_EVT,
     40     AVCT_LCB_UL_UNBIND_EVT,
     41     AVCT_LCB_UL_MSG_EVT,
     42     AVCT_LCB_INT_CLOSE_EVT,
     43     AVCT_LCB_LL_OPEN_EVT,
     44     AVCT_LCB_LL_CLOSE_EVT,
     45     AVCT_LCB_LL_MSG_EVT,
     46     AVCT_LCB_LL_CONG_EVT
     47 };
     48 
     49 
     50 /* "states" used for L2CAP channel */
     51 #define AVCT_CH_IDLE    0       /* No connection */
     52 #define AVCT_CH_CONN    1       /* Waiting for connection confirm */
     53 #define AVCT_CH_CFG     2       /* Waiting for configuration complete */
     54 #define AVCT_CH_OPEN    3       /* Channel opened */
     55 
     56 /* "no event" indicator used by ccb dealloc */
     57 #define AVCT_NO_EVT     0xFF
     58 
     59 /*****************************************************************************
     60 ** data types
     61 *****************************************************************************/
     62 /* sub control block type - common data members for tAVCT_LCB and tAVCT_BCB */
     63 typedef struct {
     64     UINT16              peer_mtu;	    /* peer l2c mtu */
     65     UINT16              ch_result;      /* L2CAP connection result value */
     66     UINT16              ch_lcid;        /* L2CAP channel LCID */
     67     UINT8               allocated;      /* 0, not allocated. index+1, otherwise. */
     68     UINT8               state;          /* The state machine state */
     69     UINT8               ch_state;       /* L2CAP channel state */
     70     UINT8               ch_flags;       /* L2CAP configuration flags */
     71 } tAVCT_SCB;
     72 
     73 /* link control block type */
     74 typedef struct {
     75     UINT16              peer_mtu;	    /* peer l2c mtu */
     76     UINT16              ch_result;      /* L2CAP connection result value */
     77     UINT16              ch_lcid;        /* L2CAP channel LCID */
     78     UINT8               allocated;      /* 0, not allocated. index+1, otherwise. */
     79     UINT8               state;          /* The state machine state */
     80     UINT8               ch_state;       /* L2CAP channel state */
     81     UINT8               ch_flags;       /* L2CAP configuration flags */
     82     BT_HDR              *p_rx_msg;      /* Message being reassembled */
     83     UINT16              conflict_lcid;  /* L2CAP channel LCID */
     84     BD_ADDR             peer_addr;      /* BD address of peer */
     85     fixed_queue_t       *tx_q;          /* Transmit data buffer queue       */
     86     BOOLEAN             cong;           /* TRUE, if congested */
     87 } tAVCT_LCB;
     88 
     89 /* browse control block type */
     90 typedef struct {
     91     UINT16              peer_mtu;	    /* peer l2c mtu */
     92     UINT16              ch_result;      /* L2CAP connection result value */
     93     UINT16              ch_lcid;        /* L2CAP channel LCID */
     94     UINT8               allocated;      /* 0, not allocated. index+1, otherwise. */
     95     UINT8               state;          /* The state machine state */
     96     UINT8               ch_state;       /* L2CAP channel state */
     97     UINT8               ch_flags;       /* L2CAP configuration flags */
     98     BT_HDR              *p_tx_msg;      /* Message to be sent - in case the browsing channel is not open when MsgReg is called */
     99     UINT8               ch_close;       /* CCB index+1, if CCB initiated channel close */
    100 } tAVCT_BCB;
    101 
    102 #define AVCT_ALOC_LCB       0x01
    103 #define AVCT_ALOC_BCB       0x02
    104 /* connection control block */
    105 typedef struct {
    106     tAVCT_CC            cc;                 /* parameters from connection creation */
    107     tAVCT_LCB           *p_lcb;             /* Associated LCB */
    108     tAVCT_BCB           *p_bcb;             /* associated BCB */
    109     BOOLEAN             ch_close;           /* Whether CCB initiated channel close */
    110     UINT8               allocated;          /* Whether LCB/BCB is allocated */
    111 } tAVCT_CCB;
    112 
    113 /* data type associated with UL_MSG_EVT */
    114 typedef struct {
    115     BT_HDR                  *p_buf;
    116     tAVCT_CCB               *p_ccb;
    117     UINT8                   label;
    118     UINT8                   cr;
    119 } tAVCT_UL_MSG;
    120 
    121 /* union associated with lcb state machine events */
    122 typedef union {
    123     tAVCT_UL_MSG            ul_msg;
    124     BT_HDR                  *p_buf;
    125     tAVCT_CCB               *p_ccb;
    126     UINT16                  result;
    127     BOOLEAN                 cong;
    128     UINT8                   err_code;
    129 } tAVCT_LCB_EVT;
    130 
    131 /* Control block for AVCT */
    132 typedef struct {
    133     tAVCT_LCB       lcb[AVCT_NUM_LINKS];    /* link control blocks */
    134     tAVCT_BCB       bcb[AVCT_NUM_LINKS];    /* browse control blocks */
    135     tAVCT_CCB       ccb[AVCT_NUM_CONN];     /* connection control blocks */
    136     UINT16          mtu;                    /* our L2CAP MTU */
    137     UINT16          mtu_br;                 /* our L2CAP MTU for the Browsing channel */
    138     UINT8           trace_level;            /* trace level */
    139 } tAVCT_CB;
    140 
    141 /*****************************************************************************
    142 ** function declarations
    143 *****************************************************************************/
    144 
    145 /* LCB function declarations */
    146 extern void avct_lcb_event(tAVCT_LCB *p_lcb, UINT8 event, tAVCT_LCB_EVT *p_data);
    147 #if (AVCT_BROWSE_INCLUDED == TRUE)
    148 extern void avct_bcb_event(tAVCT_BCB *p_bcb, UINT8 event, tAVCT_LCB_EVT *p_data);
    149 extern void avct_close_bcb(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    150 extern tAVCT_LCB *avct_lcb_by_bcb(tAVCT_BCB *p_bcb);
    151 extern tAVCT_BCB *avct_bcb_by_lcb(tAVCT_LCB *p_lcb);
    152 extern BOOLEAN avct_bcb_last_ccb(tAVCT_BCB *p_bcb, tAVCT_CCB *p_ccb_last);
    153 extern tAVCT_BCB *avct_bcb_by_lcid(UINT16 lcid);
    154 #endif
    155 extern tAVCT_LCB *avct_lcb_by_bd(BD_ADDR bd_addr);
    156 extern tAVCT_LCB *avct_lcb_alloc(BD_ADDR bd_addr);
    157 extern void avct_lcb_dealloc(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    158 extern tAVCT_LCB *avct_lcb_by_lcid(UINT16 lcid);
    159 extern tAVCT_CCB *avct_lcb_has_pid(tAVCT_LCB *p_lcb, UINT16 pid);
    160 extern BOOLEAN avct_lcb_last_ccb(tAVCT_LCB *p_lcb, tAVCT_CCB *p_ccb_last);
    161 
    162 /* LCB action functions */
    163 extern void avct_lcb_chnl_open(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    164 extern void avct_lcb_unbind_disc(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    165 extern void avct_lcb_open_ind(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    166 extern void avct_lcb_open_fail(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    167 extern void avct_lcb_close_ind(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    168 extern void avct_lcb_close_cfm(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    169 extern void avct_lcb_bind_conn(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    170 extern void avct_lcb_chk_disc(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    171 extern void avct_lcb_chnl_disc(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    172 extern void avct_lcb_bind_fail(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    173 extern void avct_lcb_cong_ind(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    174 extern void avct_lcb_discard_msg(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    175 extern void avct_lcb_send_msg(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    176 extern void avct_lcb_msg_ind(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    177 extern void avct_lcb_free_msg_ind(tAVCT_LCB *p_lcb, tAVCT_LCB_EVT *p_data);
    178 
    179 /* BCB action functions */
    180 #if (AVCT_BROWSE_INCLUDED == TRUE)
    181 typedef void (*tAVCT_BCB_ACTION)(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    182 extern void avct_bcb_chnl_open(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    183 extern void avct_bcb_unbind_disc(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    184 extern void avct_bcb_open_ind(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    185 extern void avct_bcb_open_fail(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    186 extern void avct_bcb_close_ind(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    187 extern void avct_bcb_close_cfm(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    188 extern void avct_bcb_bind_conn(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    189 extern void avct_bcb_chk_disc(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    190 extern void avct_bcb_chnl_disc(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    191 extern void avct_bcb_bind_fail(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    192 extern void avct_bcb_cong_ind(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    193 extern void avct_bcb_discard_msg(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    194 extern void avct_bcb_send_msg(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    195 extern void avct_bcb_msg_ind(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    196 extern void avct_bcb_free_msg_ind(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    197 
    198 extern void avct_bcb_dealloc(tAVCT_BCB *p_bcb, tAVCT_LCB_EVT *p_data);
    199 
    200 extern const tAVCT_BCB_ACTION avct_bcb_action[];
    201 extern const UINT8 avct_lcb_pkt_type_len[];
    202 extern const tL2CAP_FCR_OPTS avct_l2c_br_fcr_opts_def;
    203 #endif
    204 
    205 /* CCB function declarations */
    206 extern tAVCT_CCB *avct_ccb_alloc(tAVCT_CC *p_cc);
    207 extern void avct_ccb_dealloc(tAVCT_CCB *p_ccb, UINT8 event, UINT16 result, BD_ADDR bd_addr);
    208 extern UINT8 avct_ccb_to_idx(tAVCT_CCB *p_ccb);
    209 extern tAVCT_CCB *avct_ccb_by_idx(UINT8 idx);
    210 
    211 
    212 /*****************************************************************************
    213 ** global data
    214 *****************************************************************************/
    215 #ifdef __cplusplus
    216 extern "C"
    217 {
    218 #endif
    219 
    220 /* Main control block */
    221 #if AVCT_DYNAMIC_MEMORY == FALSE
    222 extern tAVCT_CB avct_cb;
    223 #else
    224 extern tAVCT_CB *avct_cb_ptr;
    225 #define avct_cb (*avct_cb_ptr)
    226 #endif
    227 
    228 /* L2CAP callback registration structure */
    229 extern const tL2CAP_APPL_INFO avct_l2c_appl;
    230 #if (AVCT_BROWSE_INCLUDED == TRUE)
    231 extern const tL2CAP_APPL_INFO avct_l2c_br_appl;
    232 #endif
    233 
    234 #ifdef __cplusplus
    235 }
    236 #endif
    237 
    238 #endif /* AVCT_INT_H */
    239