1 /******************************************************************************
2  *
3  *  Copyright 2003-2016 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 "avct_api.h"
28 #include "internal_include/bt_target.h"
29 #include "l2c_api.h"
30 #include "osi/include/fixed_queue.h"
31 #include "stack/include/bt_hdr.h"
32 #include "types/raw_address.h"
33 
34 /*****************************************************************************
35  * constants
36  ****************************************************************************/
37 
38 /* lcb state machine events */
39 enum {
40   AVCT_LCB_UL_BIND_EVT,
41   AVCT_LCB_UL_UNBIND_EVT,
42   AVCT_LCB_UL_MSG_EVT,
43   AVCT_LCB_INT_CLOSE_EVT,
44   AVCT_LCB_LL_OPEN_EVT,
45   AVCT_LCB_LL_CLOSE_EVT,
46   AVCT_LCB_LL_MSG_EVT,
47   AVCT_LCB_LL_CONG_EVT
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_t peer_mtu;  /* peer l2c mtu */
65   uint16_t ch_result; /* L2CAP connection result value */
66   uint16_t ch_lcid;   /* L2CAP channel LCID */
67   uint8_t allocated;  /* 0, not allocated. index+1, otherwise. */
68   uint8_t state;      /* The state machine state */
69   uint8_t ch_state;   /* L2CAP channel state */
70 } tAVCT_SCB;
71 
72 /* link control block type */
73 typedef struct {
74   uint16_t peer_mtu;      /* peer l2c mtu */
75   uint16_t ch_result;     /* L2CAP connection result value */
76   uint16_t ch_lcid;       /* L2CAP channel LCID */
77   uint8_t allocated;      /* 0, not allocated. index+1, otherwise. */
78   uint8_t state;          /* The state machine state */
79   uint8_t ch_state;       /* L2CAP channel state */
80   BT_HDR* p_rx_msg;       /* Message being reassembled */
81   uint16_t conflict_lcid; /* L2CAP channel LCID */
82   RawAddress peer_addr;   /* BD address of peer */
83   fixed_queue_t* tx_q;    /* Transmit data buffer queue       */
84   bool cong;              /* true, if congested */
85 } tAVCT_LCB;
86 
87 /* browse control block type */
88 typedef struct {
89   uint16_t peer_mtu;  /* peer l2c mtu */
90   uint16_t ch_result; /* L2CAP connection result value */
91   uint16_t ch_lcid;   /* L2CAP channel LCID */
92   uint8_t allocated;  /* 0, not allocated. index+1, otherwise. */
93   uint8_t state;      /* The state machine state */
94   uint8_t ch_state;   /* L2CAP channel state */
95   uint16_t conflict_lcid; /* L2CAP channel LCID */
96   BT_HDR* p_tx_msg; /* Message to be sent - in case the browsing channel is not
97                        open when MsgReg is called */
98   uint8_t ch_close; /* CCB index+1, if CCB initiated channel close */
99   RawAddress peer_addr; /* BD address of peer */
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   bool ch_close;     /* Whether CCB initiated channel close */
110   uint8_t 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_t label;
118   uint8_t 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_t result;
127   bool cong;
128   uint8_t 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 } tAVCT_CB;
137 
138 /*****************************************************************************
139  * function declarations
140  ****************************************************************************/
141 
142 /* LCB function declarations */
143 void avct_lcb_event(tAVCT_LCB* p_lcb, uint8_t event, tAVCT_LCB_EVT* p_data);
144 void avct_bcb_event(tAVCT_BCB* p_bcb, uint8_t event, tAVCT_LCB_EVT* p_data);
145 void avct_close_bcb(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
146 tAVCT_LCB* avct_lcb_by_bcb(tAVCT_BCB* p_bcb);
147 tAVCT_BCB* avct_bcb_by_lcb(tAVCT_LCB* p_lcb);
148 uint8_t avct_bcb_get_last_ccb_index(tAVCT_BCB* p_bcb, tAVCT_CCB* p_ccb_last);
149 tAVCT_BCB* avct_bcb_by_lcid(uint16_t lcid);
150 tAVCT_LCB* avct_lcb_by_bd(const RawAddress& bd_addr);
151 tAVCT_LCB* avct_lcb_alloc(const RawAddress& bd_addr);
152 void avct_lcb_dealloc(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
153 tAVCT_LCB* avct_lcb_by_lcid(uint16_t lcid);
154 tAVCT_CCB* avct_lcb_has_pid(tAVCT_LCB* p_lcb, uint16_t pid);
155 bool avct_lcb_last_ccb(tAVCT_LCB* p_lcb, tAVCT_CCB* p_ccb_last);
156 
157 /* LCB action functions */
158 void avct_lcb_chnl_open(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
159 void avct_lcb_unbind_disc(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
160 void avct_lcb_open_ind(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
161 void avct_lcb_open_fail(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
162 void avct_lcb_close_ind(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
163 void avct_lcb_close_cfm(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
164 void avct_lcb_bind_conn(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
165 void avct_lcb_chk_disc(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
166 void avct_lcb_chnl_disc(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
167 void avct_lcb_bind_fail(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
168 void avct_lcb_cong_ind(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
169 void avct_lcb_discard_msg(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
170 void avct_lcb_send_msg(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
171 void avct_lcb_msg_ind(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
172 void avct_lcb_free_msg_ind(tAVCT_LCB* p_lcb, tAVCT_LCB_EVT* p_data);
173 
174 /* BCB action functions */
175 typedef void (*tAVCT_BCB_ACTION)(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
176 void avct_bcb_chnl_open(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
177 void avct_bcb_unbind_disc(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
178 void avct_bcb_open_ind(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
179 void avct_bcb_open_fail(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
180 void avct_bcb_close_ind(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
181 void avct_bcb_close_cfm(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
182 void avct_bcb_bind_conn(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
183 void avct_bcb_chk_disc(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
184 void avct_bcb_chnl_disc(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
185 void avct_bcb_bind_fail(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
186 void avct_bcb_cong_ind(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
187 void avct_bcb_discard_msg(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
188 void avct_bcb_send_msg(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
189 void avct_bcb_msg_ind(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
190 void avct_bcb_free_msg_ind(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
191 
192 void avct_bcb_dealloc(tAVCT_BCB* p_bcb, tAVCT_LCB_EVT* p_data);
193 
194 extern const tAVCT_BCB_ACTION avct_bcb_action[];
195 extern const uint8_t avct_lcb_pkt_type_len[];
196 
197 /* CCB function declarations */
198 tAVCT_CCB* avct_ccb_alloc(tAVCT_CC* p_cc);
199 void avct_ccb_dealloc(tAVCT_CCB* p_ccb, uint8_t event, uint16_t result,
200                       const RawAddress* bd_addr);
201 uint8_t avct_ccb_to_idx(tAVCT_CCB* p_ccb);
202 tAVCT_CCB* avct_ccb_by_idx(uint8_t idx);
203 
204 extern bool avct_msg_ind_for_src_sink_coexist(tAVCT_LCB* p_lcb,
205                                               tAVCT_LCB_EVT* p_data,
206                                               uint8_t label, uint8_t cr_ipid);
207 
208 /*****************************************************************************
209  * global data
210  ****************************************************************************/
211 
212 /* Main control block */
213 extern tAVCT_CB avct_cb;
214 
215 /* L2CAP callback registration structure */
216 extern const tL2CAP_APPL_INFO avct_l2c_appl;
217 extern const tL2CAP_APPL_INFO avct_l2c_br_appl;
218 
219 void avct_l2c_disconnect(uint16_t lcid, uint16_t result);
220 void avct_l2c_br_disconnect(uint16_t lcid, uint16_t result);
221 
222 constexpr uint16_t kAvrcMtu = 512;
223 constexpr uint16_t kAvrcBrMtu = 1008;
224 
225 #endif /* AVCT_INT_H */
226