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 internally used SDP definitions
22  *
23  ******************************************************************************/
24 
25 #ifndef  SDP_INT_H
26 #define  SDP_INT_H
27 
28 #include "common/bt_target.h"
29 #include "common/bt_defs.h"
30 #include "stack/sdp_api.h"
31 #include "stack/l2c_api.h"
32 #include "osi/list.h"
33 
34 #if (SDP_INCLUDED == TRUE)
35 /* Continuation length - we use a 2-byte offset */
36 #define SDP_CONTINUATION_LEN        2
37 #define SDP_MAX_CONTINUATION_LEN    16          /* As per the spec */
38 
39 /* Timeout definitions. */
40 #define SDP_INACT_TIMEOUT       30              /* Inactivity timeout         */
41 
42 
43 /* Define the Out-Flow default values. */
44 #define  SDP_OFLOW_QOS_FLAG                 0
45 #define  SDP_OFLOW_SERV_TYPE                0
46 #define  SDP_OFLOW_TOKEN_RATE               0
47 #define  SDP_OFLOW_TOKEN_BUCKET_SIZE        0
48 #define  SDP_OFLOW_PEAK_BANDWIDTH           0
49 #define  SDP_OFLOW_LATENCY                  0
50 #define  SDP_OFLOW_DELAY_VARIATION          0
51 
52 /* Define the In-Flow default values. */
53 #define  SDP_IFLOW_QOS_FLAG                 0
54 #define  SDP_IFLOW_SERV_TYPE                0
55 #define  SDP_IFLOW_TOKEN_RATE               0
56 #define  SDP_IFLOW_TOKEN_BUCKET_SIZE        0
57 #define  SDP_IFLOW_PEAK_BANDWIDTH           0
58 #define  SDP_IFLOW_LATENCY                  0
59 #define  SDP_IFLOW_DELAY_VARIATION          0
60 
61 #define  SDP_LINK_TO                        0
62 
63 /* Define the type of device notification. */
64 /* (Inquiry Scan and Page Scan)            */
65 #define  SDP_DEVICE_NOTI_LEN                sizeof (BT_HDR) +           \
66                                             HCIC_PREAMBLE_SIZE +        \
67                                             HCIC_PARAM_SIZE_WRITE_PARAM1
68 
69 #define  SDP_DEVICE_NOTI_FLAG               0x03
70 
71 /* Define the Protocol Data Unit (PDU) types.
72 */
73 #define  SDP_PDU_ERROR_RESPONSE                 0x01
74 #define  SDP_PDU_SERVICE_SEARCH_REQ             0x02
75 #define  SDP_PDU_SERVICE_SEARCH_RSP             0x03
76 #define  SDP_PDU_SERVICE_ATTR_REQ               0x04
77 #define  SDP_PDU_SERVICE_ATTR_RSP               0x05
78 #define  SDP_PDU_SERVICE_SEARCH_ATTR_REQ        0x06
79 #define  SDP_PDU_SERVICE_SEARCH_ATTR_RSP        0x07
80 
81 /* Max UUIDs and attributes we support per sequence */
82 #define     MAX_UUIDS_PER_SEQ       8
83 #define     MAX_ATTR_PER_SEQ        8
84 
85 /* Max length we support for any attribute */
86 // btla-specific ++
87 #ifdef SDP_MAX_ATTR_LEN
88 #define MAX_ATTR_LEN SDP_MAX_ATTR_LEN
89 #else
90 #define     MAX_ATTR_LEN            256
91 #endif
92 // btla-specific --
93 
94 /* Internal UUID sequence representation */
95 typedef struct {
96     UINT16     len;
97     UINT8      value[MAX_UUID_SIZE];
98 } tUID_ENT;
99 
100 typedef struct {
101     UINT16      num_uids;
102     tUID_ENT    uuid_entry[MAX_UUIDS_PER_SEQ];
103 } tSDP_UUID_SEQ;
104 
105 
106 /* Internal attribute sequence definitions */
107 typedef struct {
108     UINT16      start;
109     UINT16      end;
110 } tATT_ENT;
111 
112 typedef struct {
113     UINT16      num_attr;
114     tATT_ENT    attr_entry[MAX_ATTR_PER_SEQ];
115 } tSDP_ATTR_SEQ;
116 
117 
118 /* Define the attribute element of the SDP database record */
119 typedef struct {
120     UINT32  len;           /* Number of bytes in the entry */
121     UINT8   *value_ptr;    /* Points to attr_pad */
122     UINT16  id;
123     UINT8   type;
124 } tSDP_ATTRIBUTE;
125 
126 /* An SDP record consists of a handle, and 1 or more attributes */
127 typedef struct {
128     UINT32              record_handle;
129     UINT32              free_pad_ptr;
130     UINT16              num_attributes;
131     tSDP_ATTRIBUTE      attribute[SDP_MAX_REC_ATTR];
132     UINT8               attr_pad[SDP_MAX_PAD_LEN];
133 } tSDP_RECORD;
134 
135 
136 /* Define the SDP database */
137 typedef struct {
138     UINT32         di_primary_handle;       /* Device ID Primary record or NULL if nonexistent */
139     UINT16         num_records;
140     list_t         *p_record_list;
141 } tSDP_DB;
142 
143 enum {
144     SDP_IS_SEARCH,
145     SDP_IS_ATTR_SEARCH,
146 };
147 
148 #if SDP_SERVER_ENABLED == TRUE
149 /* Continuation information for the SDP server response */
150 typedef struct {
151     UINT16            next_attr_index; /* attr index for next continuation response */
152     UINT16            next_attr_start_id;  /* attr id to start with for the attr index in next cont. response */
153     tSDP_RECORD       *prev_sdp_rec; /* last sdp record that was completely sent in the response */
154     BOOLEAN           last_attr_seq_desc_sent; /* whether attr seq length has been sent previously */
155     UINT16            attr_offset; /* offset within the attr to keep trak of partial attributes in the responses */
156 } tSDP_CONT_INFO;
157 #endif  /* SDP_SERVER_ENABLED == TRUE */
158 
159 /* Define the SDP Connection Control Block */
160 typedef struct {
161 #define SDP_STATE_IDLE              0
162 #define SDP_STATE_CONN_SETUP        1
163 #define SDP_STATE_CFG_SETUP         2
164 #define SDP_STATE_CONNECTED         3
165     UINT8             con_state;
166 
167 #define SDP_FLAGS_IS_ORIG           0x01
168 #define SDP_FLAGS_HIS_CFG_DONE      0x02
169 #define SDP_FLAGS_MY_CFG_DONE       0x04
170     UINT8             con_flags;
171 
172     BD_ADDR           device_address;
173     TIMER_LIST_ENT    timer_entry;
174     UINT16            rem_mtu_size;
175     UINT16            connection_id;
176     UINT16            list_len;                 /* length of the response in the GKI buffer */
177     UINT8             *rsp_list;                /* pointer to GKI buffer holding response */
178 
179 #if SDP_CLIENT_ENABLED == TRUE
180     tSDP_DISCOVERY_DB *p_db;                    /* Database to save info into   */
181     tSDP_DISC_CMPL_CB *p_cb;                    /* Callback for discovery done  */
182     tSDP_DISC_CMPL_CB2 *p_cb2;                   /* Callback for discovery done piggy back with the user data */
183     void               *user_data;              /* piggy back user data */
184     UINT32            handles[SDP_MAX_DISC_SERVER_RECS]; /* Discovered server record handles */
185     UINT16            num_handles;              /* Number of server handles     */
186     UINT16            cur_handle;               /* Current handle being processed */
187     UINT16            transaction_id;
188     UINT16            disconnect_reason;        /* Disconnect reason            */
189 #if (defined(SDP_BROWSE_PLUS) && SDP_BROWSE_PLUS == TRUE)
190     UINT16            cur_uuid_idx;
191 #endif
192 
193 #define SDP_DISC_WAIT_CONN          0
194 #define SDP_DISC_WAIT_HANDLES       1
195 #define SDP_DISC_WAIT_ATTR          2
196 #define SDP_DISC_WAIT_SEARCH_ATTR   3
197 #define SDP_DISC_WAIT_CANCEL        5
198 
199     UINT8             disc_state;
200     UINT8             is_attr_search;
201 #endif  /* SDP_CLIENT_ENABLED == TRUE */
202 
203 #if SDP_SERVER_ENABLED == TRUE
204     UINT16            cont_offset;              /* Continuation state data in the server response */
205     tSDP_CONT_INFO    cont_info;                /* structure to hold continuation information for the server response */
206 #endif  /* SDP_SERVER_ENABLED == TRUE */
207 
208 } tCONN_CB;
209 
210 
211 /*  The main SDP control block */
212 typedef struct {
213     tL2CAP_CFG_INFO   l2cap_my_cfg;             /* My L2CAP config     */
214     tCONN_CB          ccb[SDP_MAX_CONNECTIONS];
215 #if SDP_SERVER_ENABLED == TRUE
216     tSDP_DB           server_db;
217 #endif
218     tL2CAP_APPL_INFO  reg_info;                 /* L2CAP Registration info */
219     UINT16            max_attr_list_size;       /* Max attribute list size to use   */
220     UINT16            max_recs_per_search;      /* Max records we want per seaarch  */
221     UINT8             trace_level;
222 } tSDP_CB;
223 
224 #ifdef __cplusplus
225 extern "C" {
226 #endif
227 /* Global SDP data */
228 #if SDP_DYNAMIC_MEMORY == FALSE
229 extern tSDP_CB  sdp_cb;
230 #else
231 extern tSDP_CB *sdp_cb_ptr;
232 #define sdp_cb (*sdp_cb_ptr)
233 #endif
234 
235 #ifdef __cplusplus
236 }
237 #endif
238 
239 /* Functions provided by sdp_main.c */
240 extern void     sdp_init (void);
241 extern void     sdp_deinit (void);
242 extern void     sdp_disconnect (tCONN_CB *p_ccb, UINT16 reason);
243 
244 #if (defined(SDP_DEBUG) && SDP_DEBUG == TRUE)
245 extern UINT16 sdp_set_max_attr_list_size (UINT16 max_size);
246 #endif
247 
248 /* Functions provided by sdp_conn.c
249 */
250 extern void sdp_conn_rcv_l2e_conn_ind (BT_HDR *p_msg);
251 extern void sdp_conn_rcv_l2e_conn_cfm (BT_HDR *p_msg);
252 extern void sdp_conn_rcv_l2e_disc (BT_HDR *p_msg);
253 extern void sdp_conn_rcv_l2e_config_ind (BT_HDR *p_msg);
254 extern void sdp_conn_rcv_l2e_config_cfm (BT_HDR *p_msg);
255 extern void sdp_conn_rcv_l2e_conn_failed (BT_HDR *p_msg);
256 extern void sdp_conn_rcv_l2e_connected (BT_HDR *p_msg);
257 extern void sdp_conn_rcv_l2e_conn_failed (BT_HDR *p_msg);
258 extern void sdp_conn_rcv_l2e_data (BT_HDR *p_msg);
259 extern void sdp_conn_timeout (tCONN_CB *p_ccb);
260 
261 extern tCONN_CB *sdp_conn_originate (UINT8 *p_bd_addr);
262 
263 /* Functions provided by sdp_utils.c
264 */
265 extern tCONN_CB *sdpu_find_ccb_by_cid (UINT16 cid);
266 extern tCONN_CB *sdpu_find_ccb_by_db (tSDP_DISCOVERY_DB *p_db);
267 extern tCONN_CB *sdpu_allocate_ccb (void);
268 extern void      sdpu_release_ccb (tCONN_CB *p_ccb);
269 
270 extern UINT8    *sdpu_build_attrib_seq (UINT8 *p_out, UINT16 *p_attr, UINT16 num_attrs);
271 extern UINT8    *sdpu_build_attrib_entry (UINT8 *p_out, tSDP_ATTRIBUTE *p_attr);
272 extern void      sdpu_build_n_send_error (tCONN_CB *p_ccb, UINT16 trans_num, UINT16 error_code, char *p_error_text);
273 
274 extern UINT8    *sdpu_extract_attr_seq (UINT8 *p, UINT16 param_len, tSDP_ATTR_SEQ *p_seq);
275 extern UINT8    *sdpu_extract_uid_seq (UINT8 *p, UINT16 param_len, tSDP_UUID_SEQ *p_seq);
276 
277 extern UINT8    *sdpu_get_len_from_type (UINT8 *p, UINT8 type, UINT32 *p_len);
278 extern BOOLEAN  sdpu_is_base_uuid (UINT8 *p_uuid);
279 extern BOOLEAN  sdpu_compare_uuid_arrays (UINT8 *p_uuid1, UINT32 len1, UINT8 *p_uuid2, UINT16 len2);
280 extern BOOLEAN  sdpu_compare_bt_uuids (tBT_UUID *p_uuid1, tBT_UUID *p_uuid2);
281 extern BOOLEAN  sdpu_compare_uuid_with_attr (tBT_UUID *p_btuuid, tSDP_DISC_ATTR *p_attr);
282 
283 extern void     sdpu_sort_attr_list( UINT16 num_attr, tSDP_DISCOVERY_DB *p_db );
284 extern UINT16 sdpu_get_list_len( tSDP_UUID_SEQ   *uid_seq, tSDP_ATTR_SEQ   *attr_seq );
285 extern UINT16 sdpu_get_attrib_seq_len(tSDP_RECORD *p_rec, tSDP_ATTR_SEQ *attr_seq);
286 extern UINT16 sdpu_get_attrib_entry_len(tSDP_ATTRIBUTE *p_attr);
287 extern UINT8 *sdpu_build_partial_attrib_entry (UINT8 *p_out, tSDP_ATTRIBUTE *p_attr, UINT16 len, UINT16 *offset);
288 extern void sdpu_uuid16_to_uuid128(UINT16 uuid16, UINT8 *p_uuid128);
289 
290 /* Functions provided by sdp_db.c
291 */
292 extern tSDP_RECORD    *sdp_db_service_search (tSDP_RECORD *p_rec, tSDP_UUID_SEQ *p_seq);
293 extern tSDP_RECORD    *sdp_db_find_record (UINT32 handle);
294 extern tSDP_ATTRIBUTE *sdp_db_find_attr_in_rec (tSDP_RECORD *p_rec, UINT16 start_attr, UINT16 end_attr);
295 
296 
297 /* Functions provided by sdp_server.c
298 */
299 #if SDP_SERVER_ENABLED == TRUE
300 extern void     sdp_server_handle_client_req (tCONN_CB *p_ccb, BT_HDR *p_msg);
301 #else
302 #define sdp_server_handle_client_req(p_ccb, p_msg)
303 #endif
304 
305 /* Functions provided by sdp_discovery.c
306 */
307 #if SDP_CLIENT_ENABLED == TRUE
308 extern void sdp_disc_connected (tCONN_CB *p_ccb);
309 extern void sdp_disc_server_rsp (tCONN_CB *p_ccb, BT_HDR *p_msg);
310 #else
311 #define sdp_disc_connected(p_ccb)
312 #define sdp_disc_server_rsp(p_ccb, p_msg)
313 #endif
314 
315 #endif  ///SDP_INCLUDED == TRUE
316 
317 #endif
318