• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /******************************************************************************
2  *
3  *  Copyright (C) 2003-2014 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 is the public interface file for BTA, Broadcom's Bluetooth
22  *  application layer for mobile phones.
23  *
24  ******************************************************************************/
25 #ifndef BTA_API_H
26 #define BTA_API_H
27 
28 #include "bt_target.h"
29 #include "bt_types.h"
30 #include "btm_api.h"
31 
32 #if BLE_INCLUDED == TRUE
33 #include "btm_ble_api.h"
34 #endif
35 
36 /*****************************************************************************
37 **  Constants and data types
38 *****************************************************************************/
39 
40 /* Status Return Value */
41 #define BTA_SUCCESS             0           /* Successful operation. */
42 #define BTA_FAILURE             1           /* Generic failure. */
43 #define BTA_PENDING             2           /* API cannot be completed right now */
44 #define BTA_BUSY                3
45 #define BTA_NO_RESOURCES        4
46 #define BTA_WRONG_MODE          5
47 
48 typedef UINT8 tBTA_STATUS;
49 
50 /*
51  * Service ID
52  *
53  * NOTES: When you add a new Service ID for BTA AND require to change the value of BTA_MAX_SERVICE_ID,
54  *        make sure that the correct security ID of the new service from Security service definitions (btm_api.h)
55  *        should be added to bta_service_id_to_btm_srv_id_lkup_tbl table in bta_dm_act.c.
56  */
57 
58 #define BTA_RES_SERVICE_ID      0           /* Reserved */
59 #define BTA_SPP_SERVICE_ID      1           /* Serial port profile. */
60 #define BTA_DUN_SERVICE_ID      2           /* Dial-up networking profile. */
61 #define BTA_A2DP_SOURCE_SERVICE_ID      3   /* A2DP Source profile. */
62 #define BTA_LAP_SERVICE_ID      4           /* LAN access profile. */
63 #define BTA_HSP_SERVICE_ID      5           /* Headset profile. */
64 #define BTA_HFP_SERVICE_ID      6           /* Hands-free profile. */
65 #define BTA_OPP_SERVICE_ID      7           /* Object push  */
66 #define BTA_FTP_SERVICE_ID      8           /* File transfer */
67 #define BTA_CTP_SERVICE_ID      9           /* Cordless Terminal */
68 #define BTA_ICP_SERVICE_ID      10          /* Intercom Terminal */
69 #define BTA_SYNC_SERVICE_ID     11          /* Synchronization */
70 #define BTA_BPP_SERVICE_ID      12          /* Basic printing profile */
71 #define BTA_BIP_SERVICE_ID      13          /* Basic Imaging profile */
72 #define BTA_PANU_SERVICE_ID     14          /* PAN User */
73 #define BTA_NAP_SERVICE_ID      15          /* PAN Network access point */
74 #define BTA_GN_SERVICE_ID       16          /* PAN Group Ad-hoc networks */
75 #define BTA_SAP_SERVICE_ID      17          /* SIM Access profile */
76 #define BTA_A2DP_SINK_SERVICE_ID        18  /* A2DP Sink */
77 #define BTA_AVRCP_SERVICE_ID    19          /* A/V remote control */
78 #define BTA_HID_SERVICE_ID      20          /* HID */
79 #define BTA_VDP_SERVICE_ID      21          /* Video distribution */
80 #define BTA_PBAP_SERVICE_ID     22          /* PhoneBook Access Server*/
81 #define BTA_HSP_HS_SERVICE_ID   23          /* HFP HS role */
82 #define BTA_HFP_HS_SERVICE_ID   24          /* HSP HS role */
83 #define BTA_MAP_SERVICE_ID      25          /* Message Access Profile */
84 #define BTA_MN_SERVICE_ID       26          /* Message Notification Service */
85 #define BTA_HDP_SERVICE_ID      27          /* Health Device Profile */
86 #define BTA_PCE_SERVICE_ID      28          /* PhoneBook Access Client*/
87 #define BTA_SDP_SERVICE_ID      29          /* SDP Search*/
88 #if BLE_INCLUDED == TRUE && BTA_GATT_INCLUDED == TRUE
89 /* BLE profile service ID */
90 #define BTA_BLE_SERVICE_ID      30          /* GATT profile */
91 
92 #define BTA_USER_SERVICE_ID     31          /* User requested UUID */
93 
94 #define BTA_MAX_SERVICE_ID      32
95 #else
96 #define BTA_USER_SERVICE_ID     30          /* User requested UUID */
97 #define BTA_MAX_SERVICE_ID      31
98 #endif
99 /* service IDs (BTM_SEC_SERVICE_FIRST_EMPTY + 1) to (BTM_SEC_MAX_SERVICES - 1)
100  * are used by BTA JV */
101 #define BTA_FIRST_JV_SERVICE_ID     (BTM_SEC_SERVICE_FIRST_EMPTY + 1)
102 #define BTA_LAST_JV_SERVICE_ID      (BTM_SEC_MAX_SERVICES - 1)
103 
104 typedef UINT8 tBTA_SERVICE_ID;
105 
106 /* Service ID Mask */
107 #define BTA_RES_SERVICE_MASK        0x00000001  /* Reserved */
108 #define BTA_SPP_SERVICE_MASK        0x00000002  /* Serial port profile. */
109 #define BTA_DUN_SERVICE_MASK        0x00000004  /* Dial-up networking profile. */
110 #define BTA_FAX_SERVICE_MASK        0x00000008  /* Fax profile. */
111 #define BTA_LAP_SERVICE_MASK        0x00000010  /* LAN access profile. */
112 #define BTA_HSP_SERVICE_MASK        0x00000020  /* HSP AG role. */
113 #define BTA_HFP_SERVICE_MASK        0x00000040  /* HFP AG role */
114 #define BTA_OPP_SERVICE_MASK        0x00000080  /* Object push  */
115 #define BTA_FTP_SERVICE_MASK        0x00000100  /* File transfer */
116 #define BTA_CTP_SERVICE_MASK        0x00000200  /* Cordless Terminal */
117 #define BTA_ICP_SERVICE_MASK        0x00000400  /* Intercom Terminal */
118 #define BTA_SYNC_SERVICE_MASK       0x00000800  /* Synchronization */
119 #define BTA_BPP_SERVICE_MASK        0x00001000  /* Print server */
120 #define BTA_BIP_SERVICE_MASK        0x00002000  /* Basic Imaging */
121 #define BTA_PANU_SERVICE_MASK       0x00004000  /* PAN User */
122 #define BTA_NAP_SERVICE_MASK        0x00008000  /* PAN Network access point */
123 #define BTA_GN_SERVICE_MASK         0x00010000  /* PAN Group Ad-hoc networks */
124 #define BTA_SAP_SERVICE_MASK        0x00020000  /* PAN Group Ad-hoc networks */
125 #define BTA_A2DP_SERVICE_MASK       0x00040000  /* Advanced audio distribution */
126 #define BTA_AVRCP_SERVICE_MASK      0x00080000  /* A/V remote control */
127 #define BTA_HID_SERVICE_MASK        0x00100000  /* HID */
128 #define BTA_VDP_SERVICE_MASK        0x00200000  /* Video distribution */
129 #define BTA_PBAP_SERVICE_MASK       0x00400000  /* Phone Book Server */
130 #define BTA_HSP_HS_SERVICE_MASK     0x00800000  /* HFP HS role */
131 #define BTA_HFP_HS_SERVICE_MASK     0x01000000  /* HSP HS role */
132 #define BTA_MAS_SERVICE_MASK        0x02000000  /* Message Access Profile */
133 #define BTA_MN_SERVICE_MASK         0x04000000  /* Message Notification Profile */
134 #define BTA_HL_SERVICE_MASK         0x08000000  /* Health Device Profile */
135 #define BTA_PCE_SERVICE_MASK        0x10000000  /* Phone Book Client */
136 
137 #if BLE_INCLUDED == TRUE && BTA_GATT_INCLUDED == TRUE
138 #define BTA_BLE_SERVICE_MASK        0x20000000  /* GATT based service */
139 #define BTA_USER_SERVICE_MASK       0x40000000  /* Message Notification Profile */
140 #else
141 #define BTA_USER_SERVICE_MASK       0x20000000  /* Message Notification Profile */
142 #endif
143 
144 #if BLE_INCLUDED == TRUE && BTA_GATT_INCLUDED == TRUE
145 #define BTA_ALL_SERVICE_MASK        0x3FFFFFFF  /* All services supported by BTA. */
146 #else
147 #define BTA_ALL_SERVICE_MASK        0x1FFFFFFF  /* All services supported by BTA. */
148 #endif
149 
150 typedef UINT32 tBTA_SERVICE_MASK;
151 
152 /* extended service mask, including mask with one or more GATT UUID */
153 typedef struct
154 {
155     tBTA_SERVICE_MASK   srvc_mask;
156     UINT8               num_uuid;
157     tBT_UUID            *p_uuid;
158 }tBTA_SERVICE_MASK_EXT;
159 
160 /* Security Setting Mask */
161 #define BTA_SEC_NONE            BTM_SEC_NONE                                         /* No security. */
162 #define BTA_SEC_AUTHORIZE       (BTM_SEC_IN_AUTHORIZE )                              /* Authorization required (only needed for out going connection )*/
163 #define BTA_SEC_AUTHENTICATE    (BTM_SEC_IN_AUTHENTICATE | BTM_SEC_OUT_AUTHENTICATE) /* Authentication required. */
164 #define BTA_SEC_ENCRYPT         (BTM_SEC_IN_ENCRYPT | BTM_SEC_OUT_ENCRYPT)           /* Encryption required. */
165 #define BTA_SEC_MODE4_LEVEL4    (BTM_SEC_MODE4_LEVEL4)                               /* Mode 4 level 4 service, i.e. incoming/outgoing MITM and P-256 encryption */
166 #define BTA_SEC_MITM            (BTM_SEC_IN_MITM | BTM_SEC_OUT_MITM)                 /* Man-In-The_Middle protection */
167 #define BTA_SEC_IN_16_DIGITS    (BTM_SEC_IN_MIN_16_DIGIT_PIN)                        /* Min 16 digit for pin code */
168 
169 typedef UINT16 tBTA_SEC;
170 
171 /* Ignore for Discoverable, Connectable, Pairable and Connectable Paired only device modes */
172 #define BTA_DM_IGNORE           0x00FF
173 
174 /* Ignore for Discoverable, Connectable only for LE modes */
175 #define BTA_DM_LE_IGNORE           0xFF00
176 
177 #define BTA_APP_ID_PAN_MULTI    0xFE    /* app id for pan multiple connection */
178 #define BTA_ALL_APP_ID          0xFF
179 
180 /* Discoverable Modes */
181 #define BTA_DM_NON_DISC         BTM_NON_DISCOVERABLE        /* Device is not discoverable. */
182 #define BTA_DM_GENERAL_DISC     BTM_GENERAL_DISCOVERABLE    /* General discoverable. */
183 #define BTA_DM_LIMITED_DISC     BTM_LIMITED_DISCOVERABLE    /* Limited discoverable. */
184 #if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
185 #define BTA_DM_BLE_NON_DISCOVERABLE        BTM_BLE_NON_DISCOVERABLE        /* Device is not LE discoverable */
186 #define BTA_DM_BLE_GENERAL_DISCOVERABLE    BTM_BLE_GENERAL_DISCOVERABLE    /* Device is LE General discoverable */
187 #define BTA_DM_BLE_LIMITED_DISCOVERABLE    BTM_BLE_LIMITED_DISCOVERABLE    /* Device is LE Limited discoverable */
188 #endif
189 typedef UINT16 tBTA_DM_DISC;        /* this discoverability mode is a bit mask among BR mode and LE mode */
190 
191 /* Connectable Modes */
192 #define BTA_DM_NON_CONN         BTM_NON_CONNECTABLE         /* Device is not connectable. */
193 #define BTA_DM_CONN             BTM_CONNECTABLE             /* Device is connectable. */
194 #if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
195 #define BTA_DM_BLE_NON_CONNECTABLE      BTM_BLE_NON_CONNECTABLE     /* Device is LE non-connectable. */
196 #define BTA_DM_BLE_CONNECTABLE          BTM_BLE_CONNECTABLE         /* Device is LE connectable. */
197 #endif
198 
199 typedef UINT16 tBTA_DM_CONN;
200 
201 #define BTA_TRANSPORT_UNKNOWN   0
202 #define BTA_TRANSPORT_BR_EDR    BT_TRANSPORT_BR_EDR
203 #define BTA_TRANSPORT_LE        BT_TRANSPORT_LE
204 typedef tBT_TRANSPORT tBTA_TRANSPORT;
205 
206 /* Pairable Modes */
207 #define BTA_DM_PAIRABLE         1
208 #define BTA_DM_NON_PAIRABLE     0
209 
210 /* Connectable Paired Only Mode */
211 #define BTA_DM_CONN_ALL         0
212 #define BTA_DM_CONN_PAIRED      1
213 
214 /* Inquiry Modes */
215 #define BTA_DM_INQUIRY_NONE     BTM_INQUIRY_NONE            /*No BR inquiry. */
216 #define BTA_DM_GENERAL_INQUIRY  BTM_GENERAL_INQUIRY         /* Perform general inquiry. */
217 #define BTA_DM_LIMITED_INQUIRY  BTM_LIMITED_INQUIRY         /* Perform limited inquiry. */
218 
219 #if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
220 #define BTA_BLE_INQUIRY_NONE    BTM_BLE_INQUIRY_NONE
221 #define BTA_BLE_GENERAL_INQUIRY BTM_BLE_GENERAL_INQUIRY      /* Perform LE general inquiry. */
222 #define BTA_BLE_LIMITED_INQUIRY BTM_BLE_LIMITED_INQUIRY      /* Perform LE limited inquiry. */
223 #endif
224 typedef UINT8 tBTA_DM_INQ_MODE;
225 
226 /* Inquiry Filter Type */
227 #define BTA_DM_INQ_CLR          BTM_CLR_INQUIRY_FILTER          /* Clear inquiry filter. */
228 #define BTA_DM_INQ_DEV_CLASS    BTM_FILTER_COND_DEVICE_CLASS    /* Filter on device class. */
229 #define BTA_DM_INQ_BD_ADDR      BTM_FILTER_COND_BD_ADDR         /* Filter on a specific  BD address. */
230 
231 typedef UINT8 tBTA_DM_INQ_FILT;
232 
233 /* Authorize Response */
234 #define BTA_DM_AUTH_PERM        0      /* Authorized for future connections to the service */
235 #define BTA_DM_AUTH_TEMP        1      /* Authorized for current connection only */
236 #define BTA_DM_NOT_AUTH         2      /* Not authorized for the service */
237 
238 typedef UINT8 tBTA_AUTH_RESP;
239 
240 /* M/S preferred roles */
241 #define BTA_ANY_ROLE          0x00
242 #define BTA_MASTER_ROLE_PREF  0x01
243 #define BTA_MASTER_ROLE_ONLY  0x02
244 #define BTA_SLAVE_ROLE_ONLY   0x03     /* Used for PANU only, skip role switch to master */
245 
246 typedef UINT8 tBTA_PREF_ROLES;
247 
248 enum
249 {
250 
251     BTA_DM_NO_SCATTERNET,        /* Device doesn't support scatternet, it might
252                                     support "role switch during connection" for
253                                     an incoming connection, when it already has
254                                     another connection in master role */
255     BTA_DM_PARTIAL_SCATTERNET,   /* Device supports partial scatternet. It can have
256                                     simulateous connection in Master and Slave roles
257                                     for short period of time */
258     BTA_DM_FULL_SCATTERNET       /* Device can have simultaneous connection in master
259                                     and slave roles */
260 
261 };
262 
263 
264 /* Inquiry filter device class condition */
265 typedef struct
266 {
267     DEV_CLASS       dev_class;        /* device class of interest */
268     DEV_CLASS       dev_class_mask;   /* mask to determine the bits of device class of interest */
269 } tBTA_DM_COD_COND;
270 
271 
272 /* Inquiry Filter Condition */
273 typedef union
274 {
275     BD_ADDR              bd_addr;            /* BD address of  device to filter. */
276     tBTA_DM_COD_COND     dev_class_cond;     /* Device class filter condition */
277 } tBTA_DM_INQ_COND;
278 
279 /* Inquiry Parameters */
280 typedef struct
281 {
282     tBTA_DM_INQ_MODE    mode;           /* Inquiry mode, limited or general. */
283     UINT8               duration;       /* Inquiry duration in 1.28 sec units. */
284     UINT8               max_resps;      /* Maximum inquiry responses.  Set to zero for unlimited responses. */
285     BOOLEAN             report_dup;     /* report duplicated inquiry response with higher RSSI value */
286     tBTA_DM_INQ_FILT    filter_type;    /* Filter condition type. */
287     tBTA_DM_INQ_COND    filter_cond;    /* Filter condition data. */
288 #if (defined(BTA_HOST_INTERLEAVE_SEARCH) && BTA_HOST_INTERLEAVE_SEARCH == TRUE)
289     UINT8               intl_duration[4];/*duration array storing the interleave scan's time portions*/
290 #endif
291 } tBTA_DM_INQ;
292 
293 typedef struct
294 {
295     UINT8   bta_dm_eir_min_name_len;        /* minimum length of local name when it is shortened */
296 #if (BTA_EIR_CANNED_UUID_LIST == TRUE)
297     UINT8   bta_dm_eir_uuid16_len;          /* length of 16-bit UUIDs */
298     UINT8  *bta_dm_eir_uuid16;              /* 16-bit UUIDs */
299 #else
300     UINT32  uuid_mask[BTM_EIR_SERVICE_ARRAY_SIZE]; /* mask of UUID list in EIR */
301 #endif
302     INT8   *bta_dm_eir_inq_tx_power;        /* Inquiry TX power         */
303     UINT8   bta_dm_eir_flag_len;            /* length of flags in bytes */
304     UINT8  *bta_dm_eir_flags;               /* flags for EIR */
305     UINT8   bta_dm_eir_manufac_spec_len;    /* length of manufacturer specific in bytes */
306     UINT8  *bta_dm_eir_manufac_spec;        /* manufacturer specific */
307     UINT8   bta_dm_eir_additional_len;      /* length of additional data in bytes */
308     UINT8  *bta_dm_eir_additional;          /* additional data */
309 } tBTA_DM_EIR_CONF;
310 
311 #if BLE_INCLUDED == TRUE
312 /* ADV data flag bit definition used for BTM_BLE_AD_TYPE_FLAG */
313 #define BTA_BLE_LIMIT_DISC_FLAG     BTM_BLE_LIMIT_DISC_FLAG
314 #define BTA_BLE_GEN_DISC_FLAG       BTM_BLE_GEN_DISC_FLAG
315 #define BTA_BLE_BREDR_NOT_SPT       BTM_BLE_BREDR_NOT_SPT
316 #define BTA_BLE_DMT_CONTROLLER_SPT  BTM_BLE_DMT_CONTROLLER_SPT
317 #define BTA_BLE_DMT_HOST_SPT        BTM_BLE_DMT_HOST_SPT
318 #define BTA_BLE_NON_LIMIT_DISC_FLAG BTM_BLE_NON_LIMIT_DISC_FLAG
319 #define BTA_BLE_ADV_FLAG_MASK       BTM_BLE_ADV_FLAG_MASK
320 #define BTA_BLE_LIMIT_DISC_MASK     BTM_BLE_LIMIT_DISC_MASK
321 
322 /* ADV data bit mask */
323 #define BTA_BLE_AD_BIT_DEV_NAME        BTM_BLE_AD_BIT_DEV_NAME
324 #define BTA_BLE_AD_BIT_FLAGS           BTM_BLE_AD_BIT_FLAGS
325 #define BTA_BLE_AD_BIT_MANU            BTM_BLE_AD_BIT_MANU
326 #define BTA_BLE_AD_BIT_TX_PWR          BTM_BLE_AD_BIT_TX_PWR
327 #define BTA_BLE_AD_BIT_INT_RANGE       BTM_BLE_AD_BIT_INT_RANGE
328 #define BTA_BLE_AD_BIT_SERVICE         BTM_BLE_AD_BIT_SERVICE
329 #define BTA_BLE_AD_BIT_APPEARANCE      BTM_BLE_AD_BIT_APPEARANCE
330 #define BTA_BLE_AD_BIT_PROPRIETARY     BTM_BLE_AD_BIT_PROPRIETARY
331 #define BTA_DM_BLE_AD_BIT_SERVICE_SOL     BTM_BLE_AD_BIT_SERVICE_SOL
332 #define BTA_DM_BLE_AD_BIT_SERVICE_DATA    BTM_BLE_AD_BIT_SERVICE_DATA
333 #define BTA_DM_BLE_AD_BIT_SIGN_DATA       BTM_BLE_AD_BIT_SIGN_DATA
334 #define BTA_DM_BLE_AD_BIT_SERVICE_128SOL  BTM_BLE_AD_BIT_SERVICE_128SOL
335 #define BTA_DM_BLE_AD_BIT_PUBLIC_ADDR     BTM_BLE_AD_BIT_PUBLIC_ADDR
336 #define BTA_DM_BLE_AD_BIT_RANDOM_ADDR     BTM_BLE_AD_BIT_RANDOM_ADDR
337 #define BTA_DM_BLE_AD_BIT_SERVICE_128     BTM_BLE_AD_BIT_SERVICE_128      /*128-bit Service UUIDs*/
338 
339 typedef tBTM_BLE_AD_MASK tBTA_BLE_AD_MASK;
340 typedef tBTM_BLE_INT_RANGE tBTA_BLE_INT_RANGE;
341 typedef tBTM_BLE_SERVICE tBTA_BLE_SERVICE;
342 typedef tBTM_BLE_PROP_ELEM tBTA_BLE_PROP_ELEM;
343 typedef tBTM_BLE_PROPRIETARY tBTA_BLE_PROPRIETARY;
344 typedef tBTM_BLE_MANU tBTA_BLE_MANU;
345 typedef tBTM_BLE_SERVICE_DATA tBTA_BLE_SERVICE_DATA;
346 typedef tBTM_BLE_128SERVICE tBTA_BLE_128SERVICE;
347 typedef tBTM_BLE_32SERVICE  tBTA_BLE_32SERVICE;
348 
349 typedef struct
350 {
351     tBTA_BLE_INT_RANGE      int_range;          /* slave prefered conn interval range */
352     tBTA_BLE_MANU           manu;            /* manufacturer data */
353     tBTA_BLE_SERVICE        services;        /* 16 bits services */
354     tBTA_BLE_128SERVICE     services_128b;   /* 128 bits service */
355     tBTA_BLE_32SERVICE      service_32b;     /* 32 bits Service UUID */
356     tBTA_BLE_SERVICE        sol_services;    /* 16 bits services Solicitation UUIDs */
357     tBTA_BLE_32SERVICE      sol_service_32b; /* List of 32 bit Service Solicitation UUIDs */
358     tBTA_BLE_128SERVICE     sol_service_128b;/* List of 128 bit Service Solicitation UUIDs */
359     tBTA_BLE_PROPRIETARY    proprietary;     /* proprietary data */
360     tBTA_BLE_SERVICE_DATA   service_data;    /* service data */
361     UINT16                  appearance;         /* appearance data */
362     UINT8                   flag;
363     UINT8                   tx_power;
364 }tBTA_BLE_ADV_DATA;
365 
366 typedef void (tBTA_SET_ADV_DATA_CMPL_CBACK) (tBTA_STATUS status);
367 
368 /* advertising channel map */
369 #define BTA_BLE_ADV_CHNL_37 BTM_BLE_ADV_CHNL_37
370 #define BTA_BLE_ADV_CHNL_38 BTM_BLE_ADV_CHNL_38
371 #define BTA_BLE_ADV_CHNL_39 BTM_BLE_ADV_CHNL_39
372 typedef tBTM_BLE_ADV_CHNL_MAP tBTA_BLE_ADV_CHNL_MAP; /* use as a bit mask */
373 
374 /* advertising filter policy */
375 typedef tBTM_BLE_AFP   tBTA_BLE_AFP;
376 
377 /* adv event type */
378 #define BTA_BLE_CONNECT_EVT         BTM_BLE_CONNECT_EVT     /* Connectable undirected advertising */
379 #define BTA_BLE_CONNECT_DIR_EVT     BTM_BLE_CONNECT_DIR_EVT /* Connectable directed advertising */
380 #define BTA_BLE_DISCOVER_EVT        BTM_BLE_DISCOVER_EVT    /* Scannable undirected advertising */
381 #define BTA_BLE_NON_CONNECT_EVT     BTM_BLE_NON_CONNECT_EVT /* Non connectable undirected advertising */
382 typedef UINT8 tBTA_BLE_ADV_EVT;
383 
384 /* adv tx power level */
385 #define BTA_BLE_ADV_TX_POWER_MIN        0           /* minimum tx power */
386 #define BTA_BLE_ADV_TX_POWER_LOW        1           /* low tx power     */
387 #define BTA_BLE_ADV_TX_POWER_MID        2           /* middle tx power  */
388 #define BTA_BLE_ADV_TX_POWER_UPPER      3           /* upper tx power   */
389 #define BTA_BLE_ADV_TX_POWER_MAX        4           /* maximum tx power */
390 typedef UINT8 tBTA_BLE_ADV_TX_POWER;
391 
392 /* advertising instance parameters */
393 typedef struct
394 {
395     UINT16                  adv_int_min;            /* minimum adv interval */
396     UINT16                  adv_int_max;            /* maximum adv interval */
397     tBTA_BLE_ADV_EVT        adv_type;               /* adv event type */
398     tBTA_BLE_ADV_CHNL_MAP   channel_map;            /* adv channel map */
399     tBTA_BLE_AFP            adv_filter_policy;      /* advertising filter policy */
400     tBTA_BLE_ADV_TX_POWER   tx_power;               /* adv tx power */
401 }tBTA_BLE_ADV_PARAMS;
402 
403 /* These are the fields returned in each device adv packet.  It
404 ** is returned in the results callback if registered.
405 */
406 typedef struct
407 {
408     UINT8               conn_mode;
409     tBTA_BLE_AD_MASK    ad_mask;        /* mask of the valid adv data field */
410     UINT8               flag;
411     UINT8               tx_power_level;
412     UINT8               remote_name_len;
413     UINT8               *p_remote_name;
414     tBTA_BLE_SERVICE    service;
415 } tBTA_BLE_INQ_DATA;
416 
417 enum
418 {
419     BTA_BLE_BATCH_SCAN_MODE_PASS = 1,
420     BTA_BLE_BATCH_SCAN_MODE_ACTI = 2,
421     BTA_BLE_BATCH_SCAN_MODE_PASS_ACTI = 3
422 };
423 typedef UINT8 tBTA_BLE_BATCH_SCAN_MODE;
424 
425 enum
426 {
427     BTA_BLE_DISCARD_OLD_ITEMS=0,
428     BTA_BLE_DISCARD_LOWER_RSSI_ITEMS=1
429 };
430 typedef UINT8 tBTA_BLE_DISCARD_RULE;
431 
432 enum
433 {
434     BTA_BLE_ADV_SEEN_FIRST_TIME=0,
435     BTA_BLE_ADV_TRACKING_TIMEOUT=1
436 };
437 typedef UINT8 tBTA_BLE_ADV_CHANGE_REASON;
438 
439 enum
440 {
441     BTA_BLE_BATCH_SCAN_ENB_EVT      = 1,
442     BTA_BLE_BATCH_SCAN_CFG_STRG_EVT = 2,
443     BTA_BLE_BATCH_SCAN_DATA_EVT     = 3,
444     BTA_BLE_BATCH_SCAN_THRES_EVT    = 4,
445     BTA_BLE_BATCH_SCAN_PARAM_EVT    = 5,
446     BTA_BLE_BATCH_SCAN_DIS_EVT      = 6
447 };
448 typedef tBTM_BLE_BATCH_SCAN_EVT tBTA_BLE_BATCH_SCAN_EVT;
449 
450 typedef tBTM_BLE_TRACK_ADV_ACTION tBTA_BLE_TRACK_ADV_ACTION;
451 #endif
452 
453 /* BLE customer specific feature function type definitions */
454 /* data type used on customer specific feature for RSSI monitoring */
455 #define BTA_BLE_RSSI_ALERT_HI        0
456 #define BTA_BLE_RSSI_ALERT_RANGE     1
457 #define BTA_BLE_RSSI_ALERT_LO        2
458 typedef UINT8 tBTA_DM_BLE_RSSI_ALERT_TYPE;
459 
460 #define BTA_BLE_RSSI_ALERT_NONE         BTM_BLE_RSSI_ALERT_NONE         /*    (0) */
461 #define BTA_BLE_RSSI_ALERT_HI_BIT       BTM_BLE_RSSI_ALERT_HI_BIT       /*    (1) */
462 #define BTA_BLE_RSSI_ALERT_RANGE_BIT    BTM_BLE_RSSI_ALERT_RANGE_BIT    /*    (1 << 1) */
463 #define BTA_BLE_RSSI_ALERT_LO_BIT       BTM_BLE_RSSI_ALERT_LO_BIT       /*    (1 << 2) */
464 typedef UINT8     tBTA_DM_BLE_RSSI_ALERT_MASK;
465 
466 
467 typedef void (tBTA_DM_BLE_RSSI_CBACK) (BD_ADDR bd_addr, tBTA_DM_BLE_RSSI_ALERT_TYPE alert_type, INT8 rssi);
468 
469 /* max number of filter spot for different filter type */
470 #define BTA_DM_BLE_MAX_UUID_FILTER     BTM_BLE_MAX_UUID_FILTER    /* 8 */
471 #define BTA_DM_BLE_MAX_ADDR_FILTER     BTM_BLE_MAX_ADDR_FILTER    /* 8 */
472 #define BTA_DM_BLE_PF_STR_COND_MAX     BTM_BLE_PF_STR_COND_MAX    /* 4    apply to manu data , or local name */
473 #define BTA_DM_BLE_PF_STR_LEN_MAX      BTM_BLE_PF_STR_LEN_MAX     /* match for first 20 bytes */
474 
475 #define BTA_DM_BLE_PF_LOGIC_OR              0
476 #define BTA_DM_BLE_PF_LOGIC_AND             1
477 typedef UINT8 tBTA_DM_BLE_PF_LOGIC_TYPE;
478 
479 enum
480 {
481     BTA_DM_BLE_SCAN_COND_ADD,
482     BTA_DM_BLE_SCAN_COND_DELETE,
483     BTA_DM_BLE_SCAN_COND_CLEAR = 2
484 };
485 typedef UINT8 tBTA_DM_BLE_SCAN_COND_OP;
486 
487 /* ADV payload filtering vendor specific call event */
488 enum
489 {
490     BTA_BLE_SCAN_PF_ENABLE_EVT = 7,
491     BTA_BLE_SCAN_PF_COND_EVT
492 };
493 
494 /* filter selection bit index  */
495 #define BTA_DM_BLE_PF_ADDR_FILTER          BTM_BLE_PF_ADDR_FILTER
496 #define BTA_DM_BLE_PF_SRVC_DATA            BTM_BLE_PF_SRVC_DATA
497 #define BTA_DM_BLE_PF_SRVC_UUID            BTM_BLE_PF_SRVC_UUID
498 #define BTA_DM_BLE_PF_SRVC_SOL_UUID        BTM_BLE_PF_SRVC_SOL_UUID
499 #define BTA_DM_BLE_PF_LOCAL_NAME           BTM_BLE_PF_LOCAL_NAME
500 #define BTA_DM_BLE_PF_MANU_DATA            BTM_BLE_PF_MANU_DATA
501 #define BTA_DM_BLE_PF_SRVC_DATA_PATTERN    BTM_BLE_PF_SRVC_DATA_PATTERN
502 #define BTA_DM_BLE_PF_TYPE_ALL             BTM_BLE_PF_TYPE_ALL
503 #define BTA_DM_BLE_PF_TYPE_MAX             BTM_BLE_PF_TYPE_MAX
504 typedef UINT8   tBTA_DM_BLE_PF_COND_TYPE;
505 
506 typedef union
507 {
508       UINT16              uuid16_mask;
509       UINT32              uuid32_mask;
510       UINT8               uuid128_mask[LEN_UUID_128];
511 }tBTA_DM_BLE_PF_COND_MASK;
512 
513 typedef struct
514 {
515     tBLE_BD_ADDR                *p_target_addr;     /* target address, if NULL, generic UUID filter */
516     tBT_UUID                    uuid;           /* UUID condition */
517     tBTA_DM_BLE_PF_LOGIC_TYPE   cond_logic;    /* AND/OR */
518     tBTA_DM_BLE_PF_COND_MASK    *p_uuid_mask;           /* UUID condition mask, if NULL, match exact as UUID condition */
519 }tBTA_DM_BLE_PF_UUID_COND;
520 
521 typedef struct
522 {
523     UINT8                   data_len;       /* <= 20 bytes */
524     UINT8                   *p_data;
525 }tBTA_DM_BLE_PF_LOCAL_NAME_COND;
526 
527 typedef struct
528 {
529     UINT16                  company_id;     /* company ID */
530     UINT8                   data_len;       /* <= 20 bytes */
531     UINT8                   *p_pattern;
532     UINT16                  company_id_mask; /* UUID value mask */
533     UINT8                   *p_pattern_mask; /* Manufacturer data matching mask, same length
534                                                 as data pattern, set to all 0xff, match exact data */
535 }tBTA_DM_BLE_PF_MANU_COND;
536 
537 typedef struct
538 {
539     UINT16                  uuid;     /* service ID */
540     UINT8                   data_len;       /* <= 20 bytes */
541     UINT8                   *p_pattern;
542     UINT8                   *p_pattern_mask; /* Service data matching mask, same length
543                                                 as data pattern, set to all 0xff, match exact data */
544 }tBTA_DM_BLE_PF_SRVC_PATTERN_COND;
545 
546 typedef union
547 {
548     tBLE_BD_ADDR                            target_addr;
549     tBTA_DM_BLE_PF_LOCAL_NAME_COND             local_name; /* lcoal name filtering */
550     tBTA_DM_BLE_PF_MANU_COND                   manu_data;  /* manufactuer data filtering */
551     tBTA_DM_BLE_PF_UUID_COND                   srvc_uuid;  /* service UUID filtering */
552     tBTA_DM_BLE_PF_UUID_COND                   solicitate_uuid;   /* solicitated service UUID filtering */
553     tBTA_DM_BLE_PF_SRVC_PATTERN_COND           srvc_data;      /* service data pattern */
554 }tBTA_DM_BLE_PF_COND_PARAM;
555 
556 typedef UINT8 tBTA_DM_BLE_PF_FILT_INDEX;
557 typedef UINT8 tBTA_DM_BLE_PF_AVBL_SPACE;
558 
559 typedef INT8 tBTA_DM_RSSI_VALUE;
560 typedef UINT8 tBTA_DM_LINK_QUALITY_VALUE;
561 
562 
563 typedef UINT8 tBTA_SIG_STRENGTH_MASK;
564 
565 
566 /* Security Callback Events */
567 #define BTA_DM_ENABLE_EVT               0       /* Enable Event */
568 #define BTA_DM_DISABLE_EVT              1       /* Disable Event */
569 #define BTA_DM_PIN_REQ_EVT              2       /* PIN request. */
570 #define BTA_DM_AUTH_CMPL_EVT            3       /* Authentication complete indication. */
571 #define BTA_DM_AUTHORIZE_EVT            4       /* Authorization request. */
572 #define BTA_DM_LINK_UP_EVT              5       /* Connection UP event */
573 #define BTA_DM_LINK_DOWN_EVT            6       /* Connection DOWN event */
574 #define BTA_DM_SIG_STRENGTH_EVT         7       /* Signal strength for bluetooth connection */
575 #define BTA_DM_BUSY_LEVEL_EVT           8       /* System busy level */
576 #define BTA_DM_BOND_CANCEL_CMPL_EVT     9       /* Bond cancel complete indication */
577 #define BTA_DM_SP_CFM_REQ_EVT           10      /* Simple Pairing User Confirmation request. */
578 #define BTA_DM_SP_KEY_NOTIF_EVT         11      /* Simple Pairing Passkey Notification */
579 #define BTA_DM_SP_RMT_OOB_EVT           12      /* Simple Pairing Remote OOB Data request. */
580 #define BTA_DM_SP_KEYPRESS_EVT          13      /* Key press notification event. */
581 #define BTA_DM_ROLE_CHG_EVT             14      /* Role Change event. */
582 #define BTA_DM_BLE_KEY_EVT              15      /* BLE SMP key event for peer device keys */
583 #define BTA_DM_BLE_SEC_REQ_EVT          16      /* BLE SMP security request */
584 #define BTA_DM_BLE_PASSKEY_NOTIF_EVT    17      /* SMP passkey notification event */
585 #define BTA_DM_BLE_PASSKEY_REQ_EVT      18      /* SMP passkey request event */
586 #define BTA_DM_BLE_OOB_REQ_EVT          19      /* SMP OOB request event */
587 #define BTA_DM_BLE_LOCAL_IR_EVT         20      /* BLE local IR event */
588 #define BTA_DM_BLE_LOCAL_ER_EVT         21      /* BLE local ER event */
589 #define BTA_DM_BLE_NC_REQ_EVT           22      /* SMP Numeric Comparison request event */
590 #define BTA_DM_SP_RMT_OOB_EXT_EVT       23      /* Simple Pairing Remote OOB Extended Data request. */
591 #define BTA_DM_BLE_AUTH_CMPL_EVT        24      /* BLE Auth complete */
592 #define BTA_DM_DEV_UNPAIRED_EVT         25
593 #define BTA_DM_HW_ERROR_EVT             26      /* BT Chip H/W error */
594 #define BTA_DM_LE_FEATURES_READ         27      /* Cotroller specific LE features are read */
595 #define BTA_DM_ENER_INFO_READ           28      /* Energy info read */
596 typedef UINT8 tBTA_DM_SEC_EVT;
597 
598 /* Structure associated with BTA_DM_ENABLE_EVT */
599 typedef struct
600 {
601     tBTA_STATUS    status;
602 } tBTA_DM_ENABLE;
603 
604 /* Structure associated with BTA_DM_PIN_REQ_EVT */
605 typedef struct
606 {
607     /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
608     BD_ADDR         bd_addr;            /* BD address peer device. */
609     DEV_CLASS       dev_class;          /* Class of Device */
610     BD_NAME         bd_name;            /* Name of peer device. */
611     BOOLEAN         min_16_digit;       /* TRUE if the pin returned must be at least 16 digits */
612 } tBTA_DM_PIN_REQ;
613 
614 /* BLE related definition */
615 
616 #define BTA_DM_AUTH_FAIL_BASE                   (HCI_ERR_MAX_ERR + 10)
617 
618 /* Converts SMP error codes defined in smp_api.h to SMP auth fail reasons below. */
619 #define BTA_DM_AUTH_CONVERT_SMP_CODE(x)         (BTA_DM_AUTH_FAIL_BASE + (x))
620 
621 #define BTA_DM_AUTH_SMP_PASSKEY_FAIL            (BTA_DM_AUTH_FAIL_BASE + SMP_PASSKEY_ENTRY_FAIL)
622 #define BTA_DM_AUTH_SMP_OOB_FAIL                (BTA_DM_AUTH_FAIL_BASE + SMP_OOB_FAIL)
623 #define BTA_DM_AUTH_SMP_PAIR_AUTH_FAIL          (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_AUTH_FAIL)
624 #define BTA_DM_AUTH_SMP_CONFIRM_VALUE_FAIL      (BTA_DM_AUTH_FAIL_BASE + SMP_CONFIRM_VALUE_ERR)
625 #define BTA_DM_AUTH_SMP_PAIR_NOT_SUPPORT        (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_NOT_SUPPORT)
626 #define BTA_DM_AUTH_SMP_ENC_KEY_SIZE            (BTA_DM_AUTH_FAIL_BASE + SMP_ENC_KEY_SIZE)
627 #define BTA_DM_AUTH_SMP_INVALID_CMD             (BTA_DM_AUTH_FAIL_BASE + SMP_INVALID_CMD)
628 #define BTA_DM_AUTH_SMP_UNKNOWN_ERR             (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_FAIL_UNKNOWN)
629 #define BTA_DM_AUTH_SMP_REPEATED_ATTEMPT        (BTA_DM_AUTH_FAIL_BASE + SMP_REPEATED_ATTEMPTS)
630 #define BTA_DM_AUTH_SMP_INVALID_PARAMETERS      (BTA_DM_AUTH_FAIL_BASE + SMP_INVALID_PARAMETERS)
631 #define BTA_DM_AUTH_SMP_INTERNAL_ERR            (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_INTERNAL_ERR)
632 #define BTA_DM_AUTH_SMP_UNKNOWN_IO              (BTA_DM_AUTH_FAIL_BASE + SMP_UNKNOWN_IO_CAP)
633 #define BTA_DM_AUTH_SMP_INIT_FAIL               (BTA_DM_AUTH_FAIL_BASE + SMP_INIT_FAIL)
634 #define BTA_DM_AUTH_SMP_CONFIRM_FAIL            (BTA_DM_AUTH_FAIL_BASE + SMP_CONFIRM_FAIL)
635 #define BTA_DM_AUTH_SMP_BUSY                    (BTA_DM_AUTH_FAIL_BASE + SMP_BUSY)
636 #define BTA_DM_AUTH_SMP_ENC_FAIL                (BTA_DM_AUTH_FAIL_BASE + SMP_ENC_FAIL)
637 #define BTA_DM_AUTH_SMP_RSP_TIMEOUT             (BTA_DM_AUTH_FAIL_BASE + SMP_RSP_TIMEOUT)
638 #define BTA_DM_AUTH_SMP_CONN_TOUT               (BTA_DM_AUTH_FAIL_BASE + SMP_CONN_TOUT)
639 
640 /* connection parameter boundary value and dummy value */
641 #define BTA_DM_BLE_SCAN_INT_MIN          BTM_BLE_SCAN_INT_MIN
642 #define BTA_DM_BLE_SCAN_INT_MAX          BTM_BLE_SCAN_INT_MAX
643 #define BTA_DM_BLE_SCAN_WIN_MIN          BTM_BLE_SCAN_WIN_MIN
644 #define BTA_DM_BLE_SCAN_WIN_MAX          BTM_BLE_SCAN_WIN_MAX
645 #define BTA_DM_BLE_CONN_INT_MIN          BTM_BLE_CONN_INT_MIN
646 #define BTA_DM_BLE_CONN_INT_MAX          BTM_BLE_CONN_INT_MAX
647 #define BTA_DM_BLE_CONN_LATENCY_MAX      BTM_BLE_CONN_LATENCY_MAX
648 #define BTA_DM_BLE_CONN_SUP_TOUT_MIN     BTM_BLE_CONN_SUP_TOUT_MIN
649 #define BTA_DM_BLE_CONN_SUP_TOUT_MAX     BTM_BLE_CONN_SUP_TOUT_MAX
650 #define BTA_DM_BLE_CONN_PARAM_UNDEF      BTM_BLE_CONN_PARAM_UNDEF  /* use this value when a specific value not to be overwritten */
651 
652 
653 #define BTA_LE_KEY_PENC      BTM_LE_KEY_PENC  /* encryption information of peer device */
654 #define BTA_LE_KEY_PID       BTM_LE_KEY_PID   /* identity key of the peer device */
655 #define BTA_LE_KEY_PCSRK     BTM_LE_KEY_PCSRK   /* peer SRK */
656 #define BTA_LE_KEY_LENC      BTM_LE_KEY_LENC        /* master role security information:div */
657 #define BTA_LE_KEY_LID       BTM_LE_KEY_LID         /* master device ID key */
658 #define BTA_LE_KEY_LCSRK     BTM_LE_KEY_LCSRK        /* local CSRK has been deliver to peer */
659 typedef UINT8 tBTA_LE_KEY_TYPE; /* can be used as a bit mask */
660 
661 
662 typedef tBTM_LE_PENC_KEYS  tBTA_LE_PENC_KEYS ;
663 typedef tBTM_LE_PCSRK_KEYS tBTA_LE_PCSRK_KEYS;
664 typedef tBTM_LE_LENC_KEYS  tBTA_LE_LENC_KEYS  ;
665 typedef tBTM_LE_LCSRK_KEYS tBTA_LE_LCSRK_KEYS ;
666 typedef tBTM_LE_PID_KEYS   tBTA_LE_PID_KEYS ;
667 
668 typedef union
669 {
670     tBTA_LE_PENC_KEYS   penc_key;       /* received peer encryption key */
671     tBTA_LE_PCSRK_KEYS  psrk_key;       /* received peer device SRK */
672     tBTA_LE_PID_KEYS    pid_key;        /* peer device ID key */
673     tBTA_LE_LENC_KEYS   lenc_key;       /* local encryption reproduction keys LTK = = d1(ER,DIV,0)*/
674     tBTA_LE_LCSRK_KEYS  lcsrk_key;      /* local device CSRK = d1(ER,DIV,1)*/
675     tBTA_LE_PID_KEYS    lid_key;        /* local device ID key for the particular remote */
676 }tBTA_LE_KEY_VALUE;
677 
678 #define BTA_BLE_LOCAL_KEY_TYPE_ID         1
679 #define BTA_BLE_LOCAL_KEY_TYPE_ER         2
680 typedef UINT8 tBTA_DM_BLE_LOCAL_KEY_MASK;
681 
682 typedef struct
683 {
684     BT_OCTET16       ir;
685     BT_OCTET16       irk;
686     BT_OCTET16       dhk;
687 }tBTA_BLE_LOCAL_ID_KEYS;
688 
689 #define BTA_DM_SEC_GRANTED              BTA_SUCCESS
690 #define BTA_DM_SEC_PAIR_NOT_SPT         BTA_DM_AUTH_SMP_PAIR_NOT_SUPPORT
691 #define BTA_DM_SEC_REP_ATTEMPTS         BTA_DM_AUTH_SMP_REPEATED_ATTEMPT
692 typedef UINT8 tBTA_DM_BLE_SEC_GRANT;
693 
694 
695 #define BTA_DM_BLE_ONN_NONE             BTM_BLE_CONN_NONE
696 #define BTA_DM_BLE_CONN_AUTO            BTM_BLE_CONN_AUTO
697 #define BTA_DM_BLE_CONN_SELECTIVE       BTM_BLE_CONN_SELECTIVE
698 typedef UINT8 tBTA_DM_BLE_CONN_TYPE;
699 
700 typedef BOOLEAN (tBTA_DM_BLE_SEL_CBACK)(BD_ADDR random_bda, UINT8 *p_remote_name);
701 
702 /* Structure associated with BTA_DM_BLE_SEC_REQ_EVT */
703 typedef struct
704 {
705     BD_ADDR         bd_addr;        /* peer address */
706     BD_NAME         bd_name;        /* peer device name */
707 } tBTA_DM_BLE_SEC_REQ;
708 
709 typedef struct
710 {
711     BD_ADDR                 bd_addr;        /* peer address */
712     tBTM_LE_KEY_TYPE        key_type;
713     tBTM_LE_KEY_VALUE       *p_key_value;
714 }tBTA_DM_BLE_KEY;
715 
716 /* Structure associated with BTA_DM_AUTH_CMPL_EVT */
717 typedef struct
718 {
719     BD_ADDR         bd_addr;            /* BD address peer device. */
720     BD_NAME         bd_name;            /* Name of peer device. */
721     BOOLEAN         key_present;        /* Valid link key value in key element */
722     LINK_KEY        key;                /* Link key associated with peer device. */
723     UINT8           key_type;           /* The type of Link Key */
724     BOOLEAN         success;            /* TRUE of authentication succeeded, FALSE if failed. */
725     UINT8           fail_reason;        /* The HCI reason/error code for when success=FALSE */
726     tBLE_ADDR_TYPE  addr_type;          /* Peer device address type */
727     tBT_DEVICE_TYPE dev_type;
728 } tBTA_DM_AUTH_CMPL;
729 
730 
731 /* Structure associated with BTA_DM_AUTHORIZE_EVT */
732 typedef struct
733 {
734     BD_ADDR         bd_addr;            /* BD address peer device. */
735     BD_NAME         bd_name;            /* Name of peer device. */
736     tBTA_SERVICE_ID service;            /* Service ID to authorize. */
737     DEV_CLASS      dev_class;
738 } tBTA_DM_AUTHORIZE;
739 
740 /* Structure associated with BTA_DM_LINK_UP_EVT */
741 typedef struct
742 {
743     BD_ADDR         bd_addr;            /* BD address peer device. */
744 #if BLE_INCLUDED == TRUE
745     tBTA_TRANSPORT  link_type;
746 #endif
747 } tBTA_DM_LINK_UP;
748 
749 /* Structure associated with BTA_DM_LINK_DOWN_EVT */
750 typedef struct
751 {
752     BD_ADDR         bd_addr;            /* BD address peer device. */
753     UINT8           status;             /* connection open/closed */
754     BOOLEAN         is_removed;         /* TRUE if device is removed when link is down */
755 #if BLE_INCLUDED == TRUE
756     tBTA_TRANSPORT  link_type;
757 #endif
758 } tBTA_DM_LINK_DOWN;
759 
760 /* Structure associated with BTA_DM_ROLE_CHG_EVT */
761 typedef struct
762 {
763     BD_ADDR         bd_addr;            /* BD address peer device. */
764     UINT8           new_role;           /* the new connection role */
765 } tBTA_DM_ROLE_CHG;
766 
767 /* Structure associated with BTA_DM_BUSY_LEVEL_EVT */
768 typedef struct
769 {
770     UINT8           level;     /* when paging or inquiring, level is 10.
771                                     Otherwise, the number of ACL links */
772     UINT8           level_flags; /* indicates individual flags */
773 } tBTA_DM_BUSY_LEVEL;
774 
775 #define BTA_IO_CAP_OUT      BTM_IO_CAP_OUT      /* 0 DisplayOnly */
776 #define BTA_IO_CAP_IO       BTM_IO_CAP_IO       /* 1 DisplayYesNo */
777 #define BTA_IO_CAP_IN       BTM_IO_CAP_IN       /* 2 KeyboardOnly */
778 #define BTA_IO_CAP_NONE     BTM_IO_CAP_NONE     /* 3 NoInputNoOutput */
779 #if BLE_INCLUDED == TRUE && SMP_INCLUDED == TRUE
780 #define BTA_IO_CAP_KBDISP   BTM_IO_CAP_KBDISP   /* 4 Keyboard display */
781 #endif
782 typedef tBTM_IO_CAP     tBTA_IO_CAP;
783 
784 #define BTA_AUTH_SP_NO    BTM_AUTH_SP_NO      /* 0 MITM Protection Not Required - Single Profile/non-bonding
785                                                 Numeric comparison with automatic accept allowed */
786 #define BTA_AUTH_SP_YES   BTM_AUTH_SP_YES     /* 1 MITM Protection Required - Single Profile/non-bonding
787                                                 Use IO Capabilities to determine authentication procedure */
788 #define BTA_AUTH_AP_NO    BTM_AUTH_AP_NO      /* 2 MITM Protection Not Required - All Profiles/dedicated bonding
789                                                 Numeric comparison with automatic accept allowed */
790 #define BTA_AUTH_AP_YES   BTM_AUTH_AP_YES     /* 3 MITM Protection Required - All Profiles/dedicated bonding
791                                                 Use IO Capabilities to determine authentication procedure */
792 #define BTA_AUTH_SPGB_NO  BTM_AUTH_SPGB_NO    /* 4 MITM Protection Not Required - Single Profiles/general bonding
793                                                 Numeric comparison with automatic accept allowed */
794 #define BTA_AUTH_SPGB_YES BTM_AUTH_SPGB_YES   /* 5 MITM Protection Required - Single Profiles/general bonding
795                                                 Use IO Capabilities to determine authentication procedure */
796 typedef tBTM_AUTH_REQ   tBTA_AUTH_REQ;
797 
798 #define BTA_AUTH_DD_BOND    BTM_AUTH_DD_BOND  /* 2 this bit is set for dedicated bonding */
799 #define BTA_AUTH_GEN_BOND   BTM_AUTH_SPGB_NO  /* 4 this bit is set for general bonding */
800 #define BTA_AUTH_BONDS      BTM_AUTH_BONDS    /* 6 the general/dedicated bonding bits  */
801 
802 #define BTA_LE_AUTH_NO_BOND    BTM_LE_AUTH_REQ_NO_BOND  /* 0*/
803 #define BTA_LE_AUTH_BOND       BTM_LE_AUTH_REQ_BOND     /* 1 << 0 */
804 #define BTA_LE_AUTH_REQ_MITM   BTM_LE_AUTH_REQ_MITM    /* 1 << 2 */
805 
806 #define BTA_LE_AUTH_REQ_SC_ONLY         BTM_LE_AUTH_REQ_SC_ONLY         /* 1 << 3 */
807 #define BTA_LE_AUTH_REQ_SC_BOND         BTM_LE_AUTH_REQ_SC_BOND      /* 1001 */
808 #define BTA_LE_AUTH_REQ_SC_MITM         BTM_LE_AUTH_REQ_SC_MITM      /* 1100 */
809 #define BTA_LE_AUTH_REQ_SC_MITM_BOND    BTM_LE_AUTH_REQ_SC_MITM_BOND /* 1101 */
810 typedef tBTM_LE_AUTH_REQ       tBTA_LE_AUTH_REQ;       /* combination of the above bit pattern */
811 
812 #define BTA_OOB_NONE        BTM_OOB_NONE
813 #define BTA_OOB_PRESENT     BTM_OOB_PRESENT
814 #define BTA_OOB_UNKNOWN     BTM_OOB_UNKNOWN
815 
816 typedef tBTM_OOB_DATA   tBTA_OOB_DATA;
817 
818 /* Structure associated with BTA_DM_SP_CFM_REQ_EVT */
819 typedef struct
820 {
821     /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
822     BD_ADDR         bd_addr;        /* peer address */
823     DEV_CLASS       dev_class;      /* peer CoD */
824     BD_NAME         bd_name;        /* peer device name */
825     UINT32          num_val;        /* the numeric value for comparison. If just_works, do not show this number to UI */
826     BOOLEAN         just_works;     /* TRUE, if "Just Works" association model */
827     tBTA_AUTH_REQ   loc_auth_req;   /* Authentication required for local device */
828     tBTA_AUTH_REQ   rmt_auth_req;   /* Authentication required for peer device */
829     tBTA_IO_CAP     loc_io_caps;    /* IO Capabilities of local device */
830     tBTA_AUTH_REQ   rmt_io_caps;    /* IO Capabilities of remote device */
831 } tBTA_DM_SP_CFM_REQ;
832 
833 enum
834 {
835     BTA_SP_KEY_STARTED,         /* passkey entry started */
836     BTA_SP_KEY_ENTERED,         /* passkey digit entered */
837     BTA_SP_KEY_ERASED,          /* passkey digit erased */
838     BTA_SP_KEY_CLEARED,         /* passkey cleared */
839     BTA_SP_KEY_COMPLT           /* passkey entry completed */
840 };
841 typedef UINT8   tBTA_SP_KEY_TYPE;
842 
843 /* Structure associated with BTA_DM_SP_KEYPRESS_EVT */
844 typedef struct
845 {
846     BD_ADDR             bd_addr;        /* peer address */
847     tBTA_SP_KEY_TYPE   notif_type;
848 }tBTA_DM_SP_KEY_PRESS;
849 
850 /* Structure associated with BTA_DM_SP_KEY_NOTIF_EVT */
851 typedef struct
852 {
853     /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
854     BD_ADDR         bd_addr;        /* peer address */
855     DEV_CLASS       dev_class;      /* peer CoD */
856     BD_NAME         bd_name;        /* peer device name */
857     UINT32          passkey;        /* the numeric value for comparison. If just_works, do not show this number to UI */
858 } tBTA_DM_SP_KEY_NOTIF;
859 
860 /* Structure associated with BTA_DM_SP_RMT_OOB_EVT */
861 typedef struct
862 {
863     /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
864     BD_ADDR         bd_addr;        /* peer address */
865     DEV_CLASS       dev_class;      /* peer CoD */
866     BD_NAME         bd_name;        /* peer device name */
867 } tBTA_DM_SP_RMT_OOB;
868 
869 /* Structure associated with BTA_DM_BOND_CANCEL_CMPL_EVT */
870 typedef struct
871 {
872     tBTA_STATUS     result;    /* TRUE of bond cancel succeeded, FALSE if failed. */
873 } tBTA_DM_BOND_CANCEL_CMPL;
874 
875 /* Union of all security callback structures */
876 typedef union
877 {
878     tBTA_DM_ENABLE      enable;         /* BTA enabled */
879     tBTA_DM_PIN_REQ     pin_req;        /* PIN request. */
880     tBTA_DM_AUTH_CMPL   auth_cmpl;      /* Authentication complete indication. */
881     tBTA_DM_AUTHORIZE   authorize;      /* Authorization request. */
882     tBTA_DM_LINK_UP     link_up;       /* ACL connection down event */
883     tBTA_DM_LINK_DOWN   link_down;       /* ACL connection down event */
884     tBTA_DM_BUSY_LEVEL  busy_level;     /* System busy level */
885     tBTA_DM_SP_CFM_REQ  cfm_req;        /* user confirm request */
886     tBTA_DM_SP_KEY_NOTIF key_notif;     /* passkey notification */
887     tBTA_DM_SP_RMT_OOB  rmt_oob;        /* remote oob */
888     tBTA_DM_BOND_CANCEL_CMPL bond_cancel_cmpl; /* Bond Cancel Complete indication */
889     tBTA_DM_SP_KEY_PRESS   key_press;   /* key press notification event */
890     tBTA_DM_ROLE_CHG     role_chg;       /* role change event */
891     tBTA_DM_BLE_SEC_REQ  ble_req;        /* BLE SMP related request */
892     tBTA_DM_BLE_KEY      ble_key;        /* BLE SMP keys used when pairing */
893     tBTA_BLE_LOCAL_ID_KEYS  ble_id_keys;  /* IR event */
894     BT_OCTET16              ble_er;       /* ER event data */
895 } tBTA_DM_SEC;
896 
897 /* Security callback */
898 typedef void (tBTA_DM_SEC_CBACK)(tBTA_DM_SEC_EVT event, tBTA_DM_SEC *p_data);
899 
900 #define BTA_BLE_MULTI_ADV_ILLEGAL 0
901 
902 /* multi adv callback event */
903 #define BTA_BLE_MULTI_ADV_ENB_EVT           1
904 #define BTA_BLE_MULTI_ADV_DISABLE_EVT       2
905 #define BTA_BLE_MULTI_ADV_PARAM_EVT         3
906 #define BTA_BLE_MULTI_ADV_DATA_EVT          4
907 
908 typedef UINT8 tBTA_BLE_MULTI_ADV_EVT;
909 
910 /* multi adv callback */
911 typedef void (tBTA_BLE_MULTI_ADV_CBACK)(tBTA_BLE_MULTI_ADV_EVT event,
912                                         UINT8 inst_id, void *p_ref, tBTA_STATUS status);
913 typedef UINT32 tBTA_DM_BLE_REF_VALUE;
914 
915 #define BTA_DM_BLE_PF_ENABLE_EVT       BTM_BLE_PF_ENABLE
916 #define BTA_DM_BLE_PF_CONFIG_EVT       BTM_BLE_PF_CONFIG
917 typedef UINT8 tBTA_DM_BLE_PF_EVT;
918 
919 #define BTA_DM_BLE_PF_ENABLE       1
920 #define BTA_DM_BLE_PF_CONFIG       2
921 typedef UINT8 tBTA_DM_BLE_PF_ACTION;
922 
923 /* Config callback */
924 typedef void (tBTA_DM_BLE_PF_CFG_CBACK) (tBTA_DM_BLE_PF_ACTION action,
925                                          tBTA_DM_BLE_PF_COND_TYPE cfg_cond,
926                                          tBTA_DM_BLE_PF_AVBL_SPACE avbl_space, tBTA_STATUS status,
927                                          tBTA_DM_BLE_REF_VALUE ref_value);
928 /* Param callback */
929 typedef void (tBTA_DM_BLE_PF_PARAM_CBACK) (UINT8 action_type, tBTA_DM_BLE_PF_AVBL_SPACE avbl_space,
930                                            tBTA_DM_BLE_REF_VALUE ref_value, tBTA_STATUS status);
931 
932 /* Status callback */
933 typedef void (tBTA_DM_BLE_PF_STATUS_CBACK) (UINT8 action, tBTA_STATUS status,
934                                             tBTA_DM_BLE_REF_VALUE ref_value);
935 
936 
937 #define BTA_DM_BLE_PF_BRDCAST_ADDR_FILT  1
938 #define BTA_DM_BLE_PF_SERV_DATA_CHG_FILT 2
939 #define BTA_DM_BLE_PF_SERV_UUID          4
940 #define BTA_DM_BLE_PF_SERV_SOLC_UUID     8
941 #define BTA_DM_BLE_PF_LOC_NAME_CHECK    16
942 #define BTA_DM_BLE_PF_MANUF_NAME_CHECK  32
943 #define BTA_DM_BLE_PF_SERV_DATA_CHECK   64
944 typedef UINT16 tBTA_DM_BLE_PF_FEAT_SEL;
945 
946 #define BTA_DM_BLE_PF_LIST_LOGIC_OR   1
947 #define BTA_DM_BLE_PF_LIST_LOGIC_AND  2
948 typedef UINT16 tBTA_DM_BLE_PF_LIST_LOGIC_TYPE;
949 
950 #define BTA_DM_BLE_PF_FILT_LOGIC_OR   0
951 #define BTA_DM_BLE_PF_FILT_LOGIC_AND  1
952 typedef UINT16 tBTA_DM_BLE_PF_FILT_LOGIC_TYPE;
953 
954 typedef UINT8  tBTA_DM_BLE_PF_RSSI_THRESHOLD;
955 typedef UINT8  tBTA_DM_BLE_PF_DELIVERY_MODE;
956 typedef UINT16 tBTA_DM_BLE_PF_TIMEOUT;
957 typedef UINT8  tBTA_DM_BLE_PF_TIMEOUT_CNT;
958 typedef UINT16 tBTA_DM_BLE_PF_ADV_TRACK_ENTRIES;
959 
960 typedef struct
961 {
962     tBTA_DM_BLE_PF_FEAT_SEL feat_seln;
963     tBTA_DM_BLE_PF_LIST_LOGIC_TYPE list_logic_type;
964     tBTA_DM_BLE_PF_FILT_LOGIC_TYPE filt_logic_type;
965     tBTA_DM_BLE_PF_RSSI_THRESHOLD  rssi_high_thres;
966     tBTA_DM_BLE_PF_RSSI_THRESHOLD  rssi_low_thres;
967     tBTA_DM_BLE_PF_DELIVERY_MODE dely_mode;
968     tBTA_DM_BLE_PF_TIMEOUT found_timeout;
969     tBTA_DM_BLE_PF_TIMEOUT lost_timeout;
970     tBTA_DM_BLE_PF_TIMEOUT_CNT found_timeout_cnt;
971     tBTA_DM_BLE_PF_ADV_TRACK_ENTRIES num_of_tracking_entries;
972 } tBTA_DM_BLE_PF_FILT_PARAMS;
973 
974 /* Search callback events */
975 #define BTA_DM_INQ_RES_EVT              0       /* Inquiry result for a peer device. */
976 #define BTA_DM_INQ_CMPL_EVT             1       /* Inquiry complete. */
977 #define BTA_DM_DISC_RES_EVT             2       /* Discovery result for a peer device. */
978 #define BTA_DM_DISC_BLE_RES_EVT         3       /* Discovery result for BLE GATT based servoce on a peer device. */
979 #define BTA_DM_DISC_CMPL_EVT            4       /* Discovery complete. */
980 #define BTA_DM_DI_DISC_CMPL_EVT         5       /* Discovery complete. */
981 #define BTA_DM_SEARCH_CANCEL_CMPL_EVT   6       /* Search cancelled */
982 
983 typedef UINT8 tBTA_DM_SEARCH_EVT;
984 
985 #define BTA_DM_INQ_RES_IGNORE_RSSI      BTM_INQ_RES_IGNORE_RSSI /* 0x7f RSSI value not supplied (ignore it) */
986 
987 /* Structure associated with BTA_DM_INQ_RES_EVT */
988 typedef struct
989 {
990     BD_ADDR         bd_addr;                /* BD address peer device. */
991     DEV_CLASS       dev_class;              /* Device class of peer device. */
992     BOOLEAN         remt_name_not_required; /* Application sets this flag if it already knows the name of the device */
993                                             /* If the device name is known to application BTA skips the remote name request */
994     BOOLEAN         is_limited;             /* TRUE, if the limited inquiry bit is set in the CoD */
995     INT8            rssi;                   /* The rssi value */
996     UINT8           *p_eir;                 /* received EIR */
997 #if (BLE_INCLUDED == TRUE)
998     UINT8               inq_result_type;
999     UINT8               ble_addr_type;
1000     tBTM_BLE_EVT_TYPE   ble_evt_type;
1001     tBT_DEVICE_TYPE     device_type;
1002     UINT8               flag;
1003 #endif
1004 
1005 } tBTA_DM_INQ_RES;
1006 
1007 /* Structure associated with BTA_DM_INQ_CMPL_EVT */
1008 typedef struct
1009 {
1010     UINT8           num_resps;          /* Number of inquiry responses. */
1011 } tBTA_DM_INQ_CMPL;
1012 
1013 /* Structure associated with BTA_DM_DI_DISC_CMPL_EVT */
1014 typedef struct
1015 {
1016     BD_ADDR             bd_addr;        /* BD address peer device. */
1017     UINT8               num_record;     /* Number of DI record */
1018     tBTA_STATUS         result;
1019 } tBTA_DM_DI_DISC_CMPL;
1020 
1021 /* Structure associated with BTA_DM_DISC_RES_EVT */
1022 typedef struct
1023 {
1024     BD_ADDR             bd_addr;        /* BD address peer device. */
1025     BD_NAME             bd_name;        /* Name of peer device. */
1026     tBTA_SERVICE_MASK   services;       /* Services found on peer device. */
1027     UINT8           *   p_raw_data;     /* Raw data for discovery DB */
1028     UINT32              raw_data_size;  /* size of raw data */
1029     tBT_DEVICE_TYPE     device_type;    /* device type in case it is BLE device */
1030     UINT32              num_uuids;
1031     UINT8               *p_uuid_list;
1032     tBTA_STATUS         result;
1033 } tBTA_DM_DISC_RES;
1034 
1035 /* Structure associated with tBTA_DM_DISC_BLE_RES */
1036 typedef struct
1037 {
1038     BD_ADDR             bd_addr;        /* BD address peer device. */
1039     BD_NAME             bd_name;        /* Name of peer device. */
1040     tBT_UUID            service;        /* GATT based Services UUID found on peer device. */
1041 } tBTA_DM_DISC_BLE_RES;
1042 
1043 
1044 /* Union of all search callback structures */
1045 typedef union
1046 {
1047     tBTA_DM_INQ_RES     inq_res;        /* Inquiry result for a peer device. */
1048     tBTA_DM_INQ_CMPL    inq_cmpl;       /* Inquiry complete. */
1049     tBTA_DM_DISC_RES    disc_res;       /* Discovery result for a peer device. */
1050     tBTA_DM_DISC_BLE_RES    disc_ble_res;   /* discovery result for GATT based service */
1051     tBTA_DM_DI_DISC_CMPL    di_disc;        /* DI discovery result for a peer device */
1052 
1053 } tBTA_DM_SEARCH;
1054 
1055 /* Search callback */
1056 typedef void (tBTA_DM_SEARCH_CBACK)(tBTA_DM_SEARCH_EVT event, tBTA_DM_SEARCH *p_data);
1057 
1058 /* Execute call back */
1059 typedef void (tBTA_DM_EXEC_CBACK) (void * p_param);
1060 
1061 /* Encryption callback*/
1062 typedef void (tBTA_DM_ENCRYPT_CBACK) (BD_ADDR bd_addr, tBTA_TRANSPORT transport, tBTA_STATUS result);
1063 
1064 #define BTA_DM_BLE_SEC_NONE         BTM_BLE_SEC_NONE
1065 #define BTA_DM_BLE_SEC_ENCRYPT      BTM_BLE_SEC_ENCRYPT
1066 #define BTA_DM_BLE_SEC_NO_MITM      BTM_BLE_SEC_ENCRYPT_NO_MITM
1067 #define BTA_DM_BLE_SEC_MITM         BTM_BLE_SEC_ENCRYPT_MITM
1068 typedef tBTM_BLE_SEC_ACT            tBTA_DM_BLE_SEC_ACT;
1069 
1070 #if BLE_INCLUDED == TRUE
1071 typedef tBTM_BLE_TX_TIME_MS         tBTA_DM_BLE_TX_TIME_MS;
1072 typedef tBTM_BLE_RX_TIME_MS         tBTA_DM_BLE_RX_TIME_MS;
1073 typedef tBTM_BLE_IDLE_TIME_MS       tBTA_DM_BLE_IDLE_TIME_MS;
1074 typedef tBTM_BLE_ENERGY_USED        tBTA_DM_BLE_ENERGY_USED;
1075 
1076 #define BTA_DM_CONTRL_UNKNOWN 0       /* Unknown state */
1077 #define BTA_DM_CONTRL_ACTIVE  1       /* ACL link on, SCO link ongoing, sniff mode */
1078 #define BTA_DM_CONTRL_SCAN    2       /* Scan state - paging/inquiry/trying to connect*/
1079 #define BTA_DM_CONTRL_IDLE    3       /* Idle state - page scan, LE advt, inquiry scan */
1080 
1081 typedef UINT8 tBTA_DM_CONTRL_STATE;
1082 
1083 typedef UINT8 tBTA_DM_BLE_ADV_STATE;
1084 typedef UINT8 tBTA_DM_BLE_ADV_INFO_PRESENT;
1085 typedef UINT8 tBTA_DM_BLE_RSSI_VALUE;
1086 typedef UINT16 tBTA_DM_BLE_ADV_INFO_TIMESTAMP;
1087 
1088 typedef tBTM_BLE_TRACK_ADV_DATA tBTA_DM_BLE_TRACK_ADV_DATA;
1089 
1090 typedef void (tBTA_BLE_SCAN_THRESHOLD_CBACK)(tBTA_DM_BLE_REF_VALUE ref_value);
1091 
1092 typedef void (tBTA_BLE_SCAN_REP_CBACK) (tBTA_DM_BLE_REF_VALUE ref_value, UINT8 report_format,
1093                                         UINT8 num_records, UINT16 data_len,
1094                                         UINT8* p_rep_data, tBTA_STATUS status);
1095 
1096 typedef void (tBTA_BLE_SCAN_SETUP_CBACK) (tBTA_BLE_BATCH_SCAN_EVT evt,
1097                                           tBTA_DM_BLE_REF_VALUE ref_value,
1098                                           tBTA_STATUS status);
1099 
1100 typedef void (tBTA_BLE_TRACK_ADV_CMPL_CBACK)(int action, tBTA_STATUS status,
1101                                              tBTA_DM_BLE_PF_AVBL_SPACE avbl_space,
1102                                              tBTA_DM_BLE_REF_VALUE ref_value);
1103 
1104 typedef void (tBTA_BLE_TRACK_ADV_CBACK)(tBTA_DM_BLE_TRACK_ADV_DATA *p_adv_data);
1105 
1106 typedef void (tBTA_BLE_ENERGY_INFO_CBACK)(tBTA_DM_BLE_TX_TIME_MS tx_time,
1107                                           tBTA_DM_BLE_RX_TIME_MS rx_time,
1108                                           tBTA_DM_BLE_IDLE_TIME_MS idle_time,
1109                                           tBTA_DM_BLE_ENERGY_USED  energy_used,
1110                                           tBTA_DM_CONTRL_STATE ctrl_state,
1111                                           tBTA_STATUS status);
1112 
1113 #else
1114 typedef UINT8                       tBTA_DM_BLE_SEC_ACT;
1115 #endif
1116 
1117 /* Maximum service name length */
1118 #define BTA_SERVICE_NAME_LEN    35
1119 #define BTA_SERVICE_DESP_LEN    BTA_SERVICE_NAME_LEN
1120 #define BTA_PROVIDER_NAME_LEN   BTA_SERVICE_NAME_LEN
1121 
1122 
1123 /* link policy masks  */
1124 #define BTA_DM_LP_SWITCH        HCI_ENABLE_MASTER_SLAVE_SWITCH
1125 #define BTA_DM_LP_HOLD          HCI_ENABLE_HOLD_MODE
1126 #define BTA_DM_LP_SNIFF         HCI_ENABLE_SNIFF_MODE
1127 #define BTA_DM_LP_PARK          HCI_ENABLE_PARK_MODE
1128 typedef UINT16 tBTA_DM_LP_MASK;
1129 
1130 /* power mode actions  */
1131 #define BTA_DM_PM_NO_ACTION    0x00       /* no change to the current pm setting */
1132 #define BTA_DM_PM_PARK         0x10       /* prefers park mode */
1133 #define BTA_DM_PM_SNIFF        0x20       /* prefers sniff mode */
1134 #define BTA_DM_PM_SNIFF1       0x21       /* prefers sniff1 mode */
1135 #define BTA_DM_PM_SNIFF2       0x22       /* prefers sniff2 mode */
1136 #define BTA_DM_PM_SNIFF3       0x23       /* prefers sniff3 mode */
1137 #define BTA_DM_PM_SNIFF4       0x24       /* prefers sniff4 mode */
1138 #define BTA_DM_PM_SNIFF5       0x25       /* prefers sniff5 mode */
1139 #define BTA_DM_PM_SNIFF6       0x26       /* prefers sniff6 mode */
1140 #define BTA_DM_PM_SNIFF7       0x27       /* prefers sniff7 mode */
1141 #define BTA_DM_PM_SNIFF_USER0  0x28       /* prefers user-defined sniff0 mode (testtool only) */
1142 #define BTA_DM_PM_SNIFF_USER1  0x29       /* prefers user-defined sniff1 mode (testtool only) */
1143 #define BTA_DM_PM_ACTIVE       0x40       /* prefers active mode */
1144 #define BTA_DM_PM_RETRY        0x80       /* retry power mode based on current settings */
1145 #define BTA_DM_PM_SUSPEND      0x04       /* prefers suspend mode */
1146 #define BTA_DM_PM_NO_PREF      0x01       /* service has no prefernce on power mode setting. eg. connection to service got closed */
1147 
1148 typedef UINT8 tBTA_DM_PM_ACTION;
1149 
1150 /* index to bta_dm_ssr_spec */
1151 #define BTA_DM_PM_SSR0          0
1152 #define BTA_DM_PM_SSR1          1       /* BTA_DM_PM_SSR1 will be dedicated for
1153                                         HH SSR setting entry, no other profile can use it */
1154 #define BTA_DM_PM_SSR2          2
1155 #define BTA_DM_PM_SSR3          3
1156 #define BTA_DM_PM_SSR4          4
1157 #define BTA_DM_PM_SSR5          5
1158 #define BTA_DM_PM_SSR6          6
1159 
1160 #define BTA_DM_PM_NUM_EVTS      9
1161 
1162 #ifndef BTA_DM_PM_PARK_IDX
1163 #define BTA_DM_PM_PARK_IDX      5 /* the actual index to bta_dm_pm_md[] for PARK mode */
1164 #endif
1165 
1166 #ifndef BTA_DM_PM_SNIFF_A2DP_IDX
1167 #define BTA_DM_PM_SNIFF_A2DP_IDX      BTA_DM_PM_SNIFF
1168 #endif
1169 
1170 #ifndef BTA_DM_PM_SNIFF_HD_IDLE_IDX
1171 #define BTA_DM_PM_SNIFF_HD_IDLE_IDX   BTA_DM_PM_SNIFF2
1172 #endif
1173 
1174 #ifndef BTA_DM_PM_SNIFF_SCO_OPEN_IDX
1175 #define BTA_DM_PM_SNIFF_SCO_OPEN_IDX  BTA_DM_PM_SNIFF3
1176 #endif
1177 
1178 #ifndef BTA_DM_PM_SNIFF_HD_ACTIVE_IDX
1179 #define BTA_DM_PM_SNIFF_HD_ACTIVE_IDX BTA_DM_PM_SNIFF4
1180 #endif
1181 
1182 #ifndef BTA_DM_PM_SNIFF_HH_OPEN_IDX
1183 #define BTA_DM_PM_SNIFF_HH_OPEN_IDX BTA_DM_PM_SNIFF2
1184 #endif
1185 
1186 #ifndef BTA_DM_PM_SNIFF_HH_ACTIVE_IDX
1187 #define BTA_DM_PM_SNIFF_HH_ACTIVE_IDX BTA_DM_PM_SNIFF2
1188 #endif
1189 
1190 #ifndef BTA_DM_PM_SNIFF_HH_IDLE_IDX
1191 #define BTA_DM_PM_SNIFF_HH_IDLE_IDX BTA_DM_PM_SNIFF2
1192 #endif
1193 
1194 
1195 #ifndef BTA_DM_PM_HH_OPEN_DELAY
1196 #define BTA_DM_PM_HH_OPEN_DELAY 30000
1197 #endif
1198 
1199 #ifndef BTA_DM_PM_HH_ACTIVE_DELAY
1200 #define BTA_DM_PM_HH_ACTIVE_DELAY 30000
1201 #endif
1202 
1203 #ifndef BTA_DM_PM_HH_IDLE_DELAY
1204 #define BTA_DM_PM_HH_IDLE_DELAY 30000
1205 #endif
1206 
1207 /* The Sniff Parameters defined below must be ordered from highest
1208  * latency (biggest interval) to lowest latency.  If there is a conflict
1209  * among the connected services the setting with the lowest latency will
1210  * be selected.  If a device should override a sniff parameter then it
1211  * must insure that order is maintained.
1212  */
1213 #ifndef BTA_DM_PM_SNIFF_MAX
1214 #define BTA_DM_PM_SNIFF_MAX      800
1215 #define BTA_DM_PM_SNIFF_MIN      400
1216 #define BTA_DM_PM_SNIFF_ATTEMPT  4
1217 #define BTA_DM_PM_SNIFF_TIMEOUT  1
1218 #endif
1219 
1220 #ifndef BTA_DM_PM_SNIFF1_MAX
1221 #define BTA_DM_PM_SNIFF1_MAX     400
1222 #define BTA_DM_PM_SNIFF1_MIN     200
1223 #define BTA_DM_PM_SNIFF1_ATTEMPT 4
1224 #define BTA_DM_PM_SNIFF1_TIMEOUT 1
1225 #endif
1226 
1227 #ifndef BTA_DM_PM_SNIFF2_MAX
1228 #define BTA_DM_PM_SNIFF2_MAX     180
1229 #define BTA_DM_PM_SNIFF2_MIN     150
1230 #define BTA_DM_PM_SNIFF2_ATTEMPT 4
1231 #define BTA_DM_PM_SNIFF2_TIMEOUT 1
1232 #endif
1233 
1234 #ifndef BTA_DM_PM_SNIFF3_MAX
1235 #define BTA_DM_PM_SNIFF3_MAX     150
1236 #define BTA_DM_PM_SNIFF3_MIN     50
1237 #define BTA_DM_PM_SNIFF3_ATTEMPT 4
1238 #define BTA_DM_PM_SNIFF3_TIMEOUT 1
1239 #endif
1240 
1241 #ifndef BTA_DM_PM_SNIFF4_MAX
1242 #define BTA_DM_PM_SNIFF4_MAX     54
1243 #define BTA_DM_PM_SNIFF4_MIN     30
1244 #define BTA_DM_PM_SNIFF4_ATTEMPT 4
1245 #define BTA_DM_PM_SNIFF4_TIMEOUT 1
1246 #endif
1247 
1248 #ifndef BTA_DM_PM_SNIFF5_MAX
1249 #define BTA_DM_PM_SNIFF5_MAX     36
1250 #define BTA_DM_PM_SNIFF5_MIN     30
1251 #define BTA_DM_PM_SNIFF5_ATTEMPT 2
1252 #define BTA_DM_PM_SNIFF5_TIMEOUT 0
1253 #endif
1254 
1255 #ifndef BTA_DM_PM_PARK_MAX
1256 #define BTA_DM_PM_PARK_MAX       800
1257 #define BTA_DM_PM_PARK_MIN       400
1258 #define BTA_DM_PM_PARK_ATTEMPT   0
1259 #define BTA_DM_PM_PARK_TIMEOUT   0
1260 #endif
1261 
1262 
1263 /* Switch callback events */
1264 #define BTA_DM_SWITCH_CMPL_EVT      0       /* Completion of the Switch API */
1265 
1266 typedef UINT8 tBTA_DM_SWITCH_EVT;
1267 typedef void (tBTA_DM_SWITCH_CBACK)(tBTA_DM_SWITCH_EVT event, tBTA_STATUS status);
1268 
1269 /* Audio routing out configuration */
1270 #define BTA_DM_ROUTE_NONE       0x00    /* No Audio output */
1271 #define BTA_DM_ROUTE_DAC        0x01    /* routing over analog output */
1272 #define BTA_DM_ROUTE_I2S        0x02    /* routing over digital (I2S) output */
1273 #define BTA_DM_ROUTE_BT_MONO    0x04    /* routing over SCO */
1274 #define BTA_DM_ROUTE_BT_STEREO  0x08    /* routing over BT Stereo */
1275 #define BTA_DM_ROUTE_HOST       0x10    /* routing over Host */
1276 #define BTA_DM_ROUTE_FMTX       0x20    /* routing over FMTX */
1277 #define BTA_DM_ROUTE_FMRX       0x40    /* routing over FMRX */
1278 #define BTA_DM_ROUTE_BTSNK      0x80    /* routing over BT SNK */
1279 
1280 typedef UINT8 tBTA_DM_ROUTE_PATH;
1281 
1282 
1283 /* Device Identification (DI) data structure
1284 */
1285 /* Used to set the DI record */
1286 typedef tSDP_DI_RECORD          tBTA_DI_RECORD;
1287 /* Used to get the DI record */
1288 typedef tSDP_DI_GET_RECORD      tBTA_DI_GET_RECORD;
1289 /* SDP discovery database */
1290 typedef tSDP_DISCOVERY_DB       tBTA_DISCOVERY_DB;
1291 
1292 #ifndef         BTA_DI_NUM_MAX
1293 #define         BTA_DI_NUM_MAX       3
1294 #endif
1295 
1296 /* Device features mask definitions */
1297 #define BTA_FEATURE_BYTES_PER_PAGE  BTM_FEATURE_BYTES_PER_PAGE
1298 #define BTA_EXT_FEATURES_PAGE_MAX   BTM_EXT_FEATURES_PAGE_MAX
1299 /* ACL type
1300 */
1301 #define BTA_DM_LINK_TYPE_BR_EDR    0x01
1302 #define BTA_DM_LINK_TYPE_LE        0x02
1303 #define BTA_DM_LINK_TYPE_ALL       0xFF
1304 typedef UINT8 tBTA_DM_LINK_TYPE;
1305 
1306 #define IMMEDIATE_DELY_MODE  0x00
1307 #define ONFOUND_DELY_MODE    0x01
1308 #define BATCH_DELY_MODE      0x02
1309 #define ALLOW_ALL_FILTER     0x00
1310 #define LOWEST_RSSI_VALUE     129
1311 
1312 /*****************************************************************************
1313 **  External Function Declarations
1314 *****************************************************************************/
1315 #ifdef __cplusplus
1316 extern "C"
1317 {
1318 #endif
1319 
1320 /*******************************************************************************
1321 **
1322 ** Function         BTA_EnableBluetooth
1323 **
1324 ** Description      This function initializes BTA and prepares BTA and the
1325 **                  Bluetooth protocol stack for use.  This function is
1326 **                  typically called at startup or when Bluetooth services
1327 **                  are required by the phone.  This function must be called
1328 **                  before calling any other API function.
1329 **
1330 **
1331 ** Returns          BTA_SUCCESS if successful.
1332 **                  BTA_FAIL if internal failure.
1333 **
1334 *******************************************************************************/
1335 extern tBTA_STATUS BTA_EnableBluetooth(tBTA_DM_SEC_CBACK *p_cback);
1336 
1337 /*******************************************************************************
1338 **
1339 ** Function         BTA_DisableBluetooth
1340 **
1341 ** Description      This function disables BTA and the Bluetooth protocol
1342 **                  stack.  It is called when BTA is no longer being used
1343 **                  by any application in the system.
1344 **
1345 **
1346 ** Returns          void
1347 **
1348 *******************************************************************************/
1349 extern tBTA_STATUS BTA_DisableBluetooth(void);
1350 
1351 /*******************************************************************************
1352 **
1353 ** Function         BTA_EnableTestMode
1354 **
1355 ** Description      Enables bluetooth device under test mode
1356 **
1357 **
1358 ** Returns          tBTA_STATUS
1359 **
1360 *******************************************************************************/
1361 extern tBTA_STATUS BTA_EnableTestMode(void);
1362 
1363 /*******************************************************************************
1364 **
1365 ** Function         BTA_DisableTestMode
1366 **
1367 ** Description      Disable bluetooth device under test mode
1368 **
1369 **
1370 ** Returns          None
1371 **
1372 *******************************************************************************/
1373 extern void BTA_DisableTestMode(void);
1374 
1375 /*******************************************************************************
1376 **
1377 ** Function         BTA_DmSetDeviceName
1378 **
1379 ** Description      This function sets the Bluetooth name of the local device.
1380 **
1381 **
1382 ** Returns          void
1383 **
1384 *******************************************************************************/
1385 extern void BTA_DmSetDeviceName(char *p_name);
1386 
1387 /*******************************************************************************
1388 **
1389 ** Function         BTA_DmSetVisibility
1390 **
1391 ** Description      This function sets the Bluetooth connectable,discoverable,
1392 **                  pairable and conn paired only modesmodes of the local device.
1393 **                  This controls whether other Bluetooth devices can find and connect to
1394 **                  the local device.
1395 **
1396 **
1397 ** Returns          void
1398 **
1399 *******************************************************************************/
1400 extern void BTA_DmSetVisibility(tBTA_DM_DISC disc_mode, tBTA_DM_CONN conn_mode, UINT8 pairable_mode, UINT8 conn_filter);
1401 
1402 /*******************************************************************************
1403 **
1404 ** Function         BTA_DmSearch
1405 **
1406 ** Description      This function searches for peer Bluetooth devices.  It
1407 **                  first performs an inquiry; for each device found from the
1408 **                  inquiry it gets the remote name of the device.  If
1409 **                  parameter services is nonzero, service discovery will be
1410 **                  performed on each device for the services specified.
1411 **
1412 **
1413 ** Returns          void
1414 **
1415 *******************************************************************************/
1416 extern void BTA_DmSearch(tBTA_DM_INQ *p_dm_inq, tBTA_SERVICE_MASK services,
1417                          tBTA_DM_SEARCH_CBACK *p_cback);
1418 
1419 /*******************************************************************************
1420 **
1421 ** Function         BTA_DmSearchCancel
1422 **
1423 ** Description      This function cancels a search that has been initiated
1424 **                  by calling BTA_DmSearch().
1425 **
1426 **
1427 ** Returns          void
1428 **
1429 *******************************************************************************/
1430 extern void BTA_DmSearchCancel(void);
1431 
1432 /*******************************************************************************
1433 **
1434 ** Function         BTA_DmDiscover
1435 **
1436 ** Description      This function performs service discovery for the services
1437 **                  of a particular peer device.
1438 **
1439 **
1440 ** Returns          void
1441 **
1442 *******************************************************************************/
1443 extern void BTA_DmDiscover(BD_ADDR bd_addr, tBTA_SERVICE_MASK services,
1444                            tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search);
1445 
1446 /*******************************************************************************
1447 **
1448 ** Function         BTA_DmDiscoverUUID
1449 **
1450 ** Description      This function performs service discovery for the services
1451 **                  of a particular peer device.
1452 **
1453 **
1454 ** Returns          void
1455 **
1456 *******************************************************************************/
1457 extern void BTA_DmDiscoverUUID(BD_ADDR bd_addr, tSDP_UUID *uuid,
1458                                tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search);
1459 
1460 /*******************************************************************************
1461 **
1462 ** Function         BTA_DmGetCachedRemoteName
1463 **
1464 ** Description      Retieve cached remote name if available
1465 **
1466 ** Returns          BTA_SUCCESS if cached name was retrieved
1467 **                  BTA_FAILURE if cached name is not available
1468 **
1469 *******************************************************************************/
1470 tBTA_STATUS BTA_DmGetCachedRemoteName(BD_ADDR remote_device, UINT8 **pp_cached_name);
1471 
1472 /*******************************************************************************
1473 **
1474 ** Function         BTA_DmBond
1475 **
1476 ** Description      This function initiates a bonding procedure with a peer
1477 **                  device.  The bonding procedure enables authentication
1478 **                  and optionally encryption on the Bluetooth link.
1479 **
1480 **
1481 ** Returns          void
1482 **
1483 *******************************************************************************/
1484 extern void BTA_DmBond(BD_ADDR bd_addr);
1485 
1486 /*******************************************************************************
1487 **
1488 ** Function         BTA_DmBondByTransport
1489 **
1490 ** Description      This function initiates a bonding procedure with a peer
1491 **                  device by designated transport.  The bonding procedure enables
1492 **                  authentication and optionally encryption on the Bluetooth link.
1493 **
1494 **
1495 ** Returns          void
1496 **
1497 *******************************************************************************/
1498 extern void BTA_DmBondByTransport(BD_ADDR bd_addr, tBTA_TRANSPORT transport);
1499 
1500 
1501 /*******************************************************************************
1502 **
1503 ** Function         BTA_DmBondCancel
1504 **
1505 ** Description      This function cancels a bonding procedure with a peer
1506 **                  device.
1507 **
1508 **
1509 ** Returns          void
1510 **
1511 *******************************************************************************/
1512 extern void BTA_DmBondCancel(BD_ADDR bd_addr);
1513 
1514 /*******************************************************************************
1515 **
1516 ** Function         BTA_DmPinReply
1517 **
1518 ** Description      This function provides a PIN when one is requested by DM
1519 **                  during a bonding procedure.  The application should call
1520 **                  this function after the security callback is called with
1521 **                  a BTA_DM_PIN_REQ_EVT.
1522 **
1523 **
1524 ** Returns          void
1525 **
1526 *******************************************************************************/
1527 extern void BTA_DmPinReply(BD_ADDR bd_addr, BOOLEAN accept, UINT8 pin_len,
1528                            UINT8 *p_pin);
1529 
1530 /*******************************************************************************
1531 **
1532 ** Function         BTA_DmLocalOob
1533 **
1534 ** Description      This function retrieves the OOB data from local controller.
1535 **                  The result is reported by bta_dm_co_loc_oob().
1536 **
1537 ** Returns          void
1538 **
1539 *******************************************************************************/
1540 extern void BTA_DmLocalOob(void);
1541 
1542 /*******************************************************************************
1543 **
1544 ** Function         BTA_DmConfirm
1545 **
1546 ** Description      This function accepts or rejects the numerical value of the
1547 **                  Simple Pairing process on BTA_DM_SP_CFM_REQ_EVT
1548 **
1549 ** Returns          void
1550 **
1551 *******************************************************************************/
1552 extern void BTA_DmConfirm(BD_ADDR bd_addr, BOOLEAN accept);
1553 
1554 /*******************************************************************************
1555 **
1556 ** Function         BTA_DmAddDevice
1557 **
1558 ** Description      This function adds a device to the security database list
1559 **                  of peer devices. This function would typically be called
1560 **                  at system startup to initialize the security database with
1561 **                  known peer devices.  This is a direct execution function
1562 **                  that may lock task scheduling on some platforms.
1563 **
1564 ** Returns          void
1565 **
1566 *******************************************************************************/
1567 extern void BTA_DmAddDevice(BD_ADDR bd_addr, DEV_CLASS dev_class,
1568                             LINK_KEY link_key, tBTA_SERVICE_MASK trusted_mask,
1569                             BOOLEAN is_trusted, UINT8 key_type,
1570                             tBTA_IO_CAP io_cap, UINT8 pin_length);
1571 
1572 /*******************************************************************************
1573 **
1574 ** Function         BTA_DmRemoveDevice
1575 **
1576 ** Description      This function removes a device from the security database.
1577 **                  This is a direct execution function that may lock task
1578 **                  scheduling on some platforms.
1579 **
1580 **
1581 ** Returns          BTA_SUCCESS if successful.
1582 **                  BTA_FAIL if operation failed.
1583 **
1584 *******************************************************************************/
1585 extern tBTA_STATUS BTA_DmRemoveDevice(BD_ADDR bd_addr);
1586 
1587 /*******************************************************************************
1588 **
1589 ** Function         BTA_GetEirService
1590 **
1591 ** Description      This function is called to get BTA service mask from EIR.
1592 **
1593 ** Parameters       p_eir - pointer of EIR significant part
1594 **                  p_services - return the BTA service mask
1595 **
1596 ** Returns          None
1597 **
1598 *******************************************************************************/
1599 extern void BTA_GetEirService( UINT8 *p_eir, tBTA_SERVICE_MASK *p_services );
1600 
1601 /*******************************************************************************
1602 **
1603 ** Function         BTA_DmGetConnectionState
1604 **
1605 ** Description      Returns whether the remote device is currently connected.
1606 **
1607 ** Returns          0 if the device is NOT connected.
1608 **
1609 *******************************************************************************/
1610 extern UINT16 BTA_DmGetConnectionState( BD_ADDR bd_addr );
1611 
1612 
1613 /*******************************************************************************
1614 **
1615 ** Function         BTA_DmSetLocalDiRecord
1616 **
1617 ** Description      This function adds a DI record to the local SDP database.
1618 **
1619 ** Returns          BTA_SUCCESS if record set sucessfully, otherwise error code.
1620 **
1621 *******************************************************************************/
1622 extern tBTA_STATUS BTA_DmSetLocalDiRecord( tBTA_DI_RECORD *p_device_info,
1623                                            UINT32 *p_handle );
1624 
1625 /*******************************************************************************
1626 **
1627 **
1628 ** Function         BTA_DmCloseACL
1629 **
1630 ** Description      This function force to close an ACL connection and remove the
1631 **                  device from the security database list of known devices.
1632 **
1633 ** Parameters:      bd_addr       - Address of the peer device
1634 **                  remove_dev    - remove device or not after link down
1635 **                  transport     - which transport to close
1636 
1637 **
1638 ** Returns          void.
1639 **
1640 *******************************************************************************/
1641 extern void BTA_DmCloseACL(BD_ADDR bd_addr, BOOLEAN remove_dev, tBTA_TRANSPORT transport);
1642 
1643 /*******************************************************************************
1644 **
1645 ** Function         bta_dmexecutecallback
1646 **
1647 ** Description      This function will request BTA to execute a call back in the context of BTU task
1648 **                  This API was named in lower case because it is only intended
1649 **                  for the internal customers(like BTIF).
1650 **
1651 ** Returns          void
1652 **
1653 *******************************************************************************/
1654 extern void bta_dmexecutecallback (tBTA_DM_EXEC_CBACK* p_callback, void * p_param);
1655 
1656 #if (BTM_SCO_HCI_INCLUDED == TRUE)
1657 /*******************************************************************************
1658 **
1659 ** Function         BTA_DmPcmInitSamples
1660 **
1661 ** Description      initialize the down sample converter.
1662 **
1663 **                  src_sps: original samples per second (source audio data)
1664 **                            (ex. 44100, 48000)
1665 **                  bits: number of bits per pcm sample (16)
1666 **                  n_channels: number of channels (i.e. mono(1), stereo(2)...)
1667 **
1668 ** Returns          none
1669 **
1670 *******************************************************************************/
1671 extern void BTA_DmPcmInitSamples (UINT32 src_sps, UINT32 bits, UINT32 n_channels);
1672 
1673 /**************************************************************************************
1674 ** Function         BTA_DmPcmResample
1675 **
1676 ** Description      Down sampling utility to convert higher sampling rate into 8K/16bits
1677 **                  PCM samples.
1678 **
1679 ** Parameters       p_src: pointer to the buffer where the original sampling PCM
1680 **                              are stored.
1681 **                  in_bytes:  Length of the input PCM sample buffer in byte.
1682 **                  p_dst:      pointer to the buffer which is to be used to store
1683 **                              the converted PCM samples.
1684 **
1685 **
1686 ** Returns          INT32: number of samples converted.
1687 **
1688 **************************************************************************************/
1689 extern INT32 BTA_DmPcmResample (void *p_src, UINT32 in_bytes, void *p_dst);
1690 #endif
1691 
1692 #if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
1693 /* BLE related API functions */
1694 /*******************************************************************************
1695 **
1696 ** Function         BTA_DmBleSecurityGrant
1697 **
1698 ** Description      Grant security request access.
1699 **
1700 ** Parameters:      bd_addr          - BD address of the peer
1701 **                  res              - security grant status.
1702 **
1703 ** Returns          void
1704 **
1705 *******************************************************************************/
1706 extern void BTA_DmBleSecurityGrant(BD_ADDR bd_addr, tBTA_DM_BLE_SEC_GRANT res);
1707 
1708 
1709 
1710 /*******************************************************************************
1711 **
1712 ** Function         BTA_DmBleSetBgConnType
1713 **
1714 ** Description      This function is called to set BLE connectable mode for a
1715 **                  peripheral device.
1716 **
1717 ** Parameters       bg_conn_type: it can be auto connection, or selective connection.
1718 **                  p_select_cback: callback function when selective connection procedure
1719 **                              is being used.
1720 **
1721 ** Returns          void
1722 **
1723 *******************************************************************************/
1724 extern void BTA_DmBleSetBgConnType(tBTA_DM_BLE_CONN_TYPE bg_conn_type, tBTA_DM_BLE_SEL_CBACK *p_select_cback);
1725 
1726 /*******************************************************************************
1727 **
1728 ** Function         BTA_DmBlePasskeyReply
1729 **
1730 ** Description      Send BLE SMP passkey reply.
1731 **
1732 ** Parameters:      bd_addr          - BD address of the peer
1733 **                  accept           - passkey entry sucessful or declined.
1734 **                  passkey          - passkey value, must be a 6 digit number,
1735 **                                     can be lead by 0.
1736 **
1737 ** Returns          void
1738 **
1739 *******************************************************************************/
1740 extern void BTA_DmBlePasskeyReply(BD_ADDR bd_addr, BOOLEAN accept, UINT32 passkey);
1741 
1742 /*******************************************************************************
1743 **
1744 ** Function         BTA_DmBleConfirmReply
1745 **
1746 ** Description      Send BLE SMP SC user confirmation reply.
1747 **
1748 ** Parameters:      bd_addr          - BD address of the peer
1749 **                  accept           - numbers to compare are the same or different.
1750 **
1751 ** Returns          void
1752 **
1753 *******************************************************************************/
1754 extern void BTA_DmBleConfirmReply(BD_ADDR bd_addr, BOOLEAN accept);
1755 
1756 /*******************************************************************************
1757 **
1758 ** Function         BTA_DmAddBleDevice
1759 **
1760 ** Description      Add a BLE device.  This function will be normally called
1761 **                  during host startup to restore all required information
1762 **                  for a LE device stored in the NVRAM.
1763 **
1764 ** Parameters:      bd_addr          - BD address of the peer
1765 **                  dev_type         - Remote device's device type.
1766 **                  addr_type        - LE device address type.
1767 **
1768 ** Returns          void
1769 **
1770 *******************************************************************************/
1771 extern void BTA_DmAddBleDevice(BD_ADDR bd_addr, tBLE_ADDR_TYPE addr_type,
1772                                tBT_DEVICE_TYPE dev_type);
1773 
1774 
1775 /*******************************************************************************
1776 **
1777 ** Function         BTA_DmAddBleKey
1778 **
1779 ** Description      Add/modify LE device information.  This function will be
1780 **                  normally called during host startup to restore all required
1781 **                  information stored in the NVRAM.
1782 **
1783 ** Parameters:      bd_addr          - BD address of the peer
1784 **                  p_le_key         - LE key values.
1785 **                  key_type         - LE SMP key type.
1786 **
1787 ** Returns          void
1788 **
1789 *******************************************************************************/
1790 extern void BTA_DmAddBleKey (BD_ADDR bd_addr,
1791                              tBTA_LE_KEY_VALUE *p_le_key,
1792                              tBTA_LE_KEY_TYPE key_type);
1793 
1794 /*******************************************************************************
1795 **
1796 ** Function         BTA_DmSetBlePrefConnParams
1797 **
1798 ** Description      This function is called to set the preferred connection
1799 **                  parameters when default connection parameter is not desired.
1800 **
1801 ** Parameters:      bd_addr          - BD address of the peripheral
1802 **                  min_conn_int     - minimum preferred connection interval
1803 **                  max_conn_int     - maximum preferred connection interval
1804 **                  slave_latency    - preferred slave latency
1805 **                  supervision_tout - preferred supervision timeout
1806 **
1807 **
1808 ** Returns          void
1809 **
1810 *******************************************************************************/
1811 extern void BTA_DmSetBlePrefConnParams(BD_ADDR bd_addr,
1812                                        UINT16 min_conn_int, UINT16 max_conn_int,
1813                                        UINT16 slave_latency, UINT16 supervision_tout );
1814 
1815 /*******************************************************************************
1816 **
1817 ** Function         BTA_DmSetBleConnScanParams
1818 **
1819 ** Description      This function is called to set scan parameters used in
1820 **                  BLE connection request
1821 **
1822 ** Parameters:      scan_interval    - scan interval
1823 **                  scan_window      - scan window
1824 **
1825 ** Returns          void
1826 **
1827 *******************************************************************************/
1828 extern void BTA_DmSetBleConnScanParams(UINT32 scan_interval,
1829                                        UINT32 scan_window);
1830 
1831 /*******************************************************************************
1832 **
1833 ** Function         BTA_DmSetBleScanParams
1834 **
1835 ** Description      This function is called to set scan parameters
1836 **
1837 ** Parameters:      client_if - Client IF
1838 **                  scan_interval - scan interval
1839 **                  scan_window - scan window
1840 **                  scan_mode - scan mode
1841 **                  scan_param_setup_status_cback - Set scan param status callback
1842 **
1843 ** Returns          void
1844 **
1845 *******************************************************************************/
1846 extern void BTA_DmSetBleScanParams(tGATT_IF client_if, UINT32 scan_interval,
1847                                    UINT32 scan_window, tBLE_SCAN_MODE scan_mode,
1848                                    tBLE_SCAN_PARAM_SETUP_CBACK scan_param_setup_status_cback);
1849 
1850 /*******************************************************************************
1851 **
1852 ** Function         BTA_DmSetBleAdvParams
1853 **
1854 ** Description      This function sets the advertising parameters BLE functionality.
1855 **                  It is to be called when device act in peripheral or broadcaster
1856 **                  role.
1857 **
1858 ** Parameters:      adv_int_min    - adv interval minimum
1859 **                  adv_int_max    - adv interval max
1860 **                  p_dir_bda      - directed adv initator address
1861 **
1862 ** Returns          void
1863 **
1864 *******************************************************************************/
1865 extern void BTA_DmSetBleAdvParams (UINT16 adv_int_min, UINT16 adv_int_max,
1866                                    tBLE_BD_ADDR *p_dir_bda);
1867 /*******************************************************************************
1868 **
1869 ** Function         BTA_DmSearchExt
1870 **
1871 ** Description      This function searches for peer Bluetooth devices. It performs
1872 **                  an inquiry and gets the remote name for devices. Service
1873 **                  discovery is done if services is non zero
1874 **
1875 ** Parameters       p_dm_inq: inquiry conditions
1876 **                  services: if service is not empty, service discovery will be done.
1877 **                            for all GATT based service condition, put num_uuid, and
1878 **                            p_uuid is the pointer to the list of UUID values.
1879 **                  p_cback: callback functino when search is completed.
1880 **
1881 **
1882 **
1883 ** Returns          void
1884 **
1885 *******************************************************************************/
1886 extern void BTA_DmSearchExt(tBTA_DM_INQ *p_dm_inq, tBTA_SERVICE_MASK_EXT *p_services,
1887                             tBTA_DM_SEARCH_CBACK *p_cback);
1888 
1889 /*******************************************************************************
1890 **
1891 ** Function         BTA_DmDiscoverExt
1892 **
1893 ** Description      This function does service discovery for services of a
1894 **                  peer device. When services.num_uuid is 0, it indicates all
1895 **                  GATT based services are to be searched; other wise a list of
1896 **                  UUID of interested services should be provided through
1897 **                  services.p_uuid.
1898 **
1899 **
1900 **
1901 ** Returns          void
1902 **
1903 *******************************************************************************/
1904 extern void BTA_DmDiscoverExt(BD_ADDR bd_addr, tBTA_SERVICE_MASK_EXT *p_services,
1905                               tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search);
1906 
1907 /*******************************************************************************
1908 **
1909 ** Function         BTA_DmDiscoverByTransport
1910 **
1911 ** Description      This function does service discovery on particular transport
1912 **                  for services of a
1913 **                  peer device. When services.num_uuid is 0, it indicates all
1914 **                  GATT based services are to be searched; other wise a list of
1915 **                  UUID of interested services should be provided through
1916 **                  p_services->p_uuid.
1917 **
1918 **
1919 **
1920 ** Returns          void
1921 **
1922 *******************************************************************************/
1923 extern void BTA_DmDiscoverByTransport(BD_ADDR bd_addr, tBTA_SERVICE_MASK_EXT *p_services,
1924                                       tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search,
1925                                       tBTA_TRANSPORT transport);
1926 
1927 /*******************************************************************************
1928 **
1929 ** Function         BTA_DmSetEncryption
1930 **
1931 ** Description      This function is called to ensure that connection is
1932 **                  encrypted.  Should be called only on an open connection.
1933 **                  Typically only needed for connections that first want to
1934 **                  bring up unencrypted links, then later encrypt them.
1935 **
1936 ** Parameters:      bd_addr       - Address of the peer device
1937 **                  transport     - transport of the link to be encruypted
1938 **                  p_callback    - Pointer to callback function to indicat the
1939 **                                  link encryption status
1940 **                  sec_act       - This is the security action to indicate
1941 **                                  what knid of BLE security level is required for
1942 **                                  the BLE link if the BLE is supported
1943 **                                  Note: This parameter is ignored for the BR/EDR link
1944 **                                        or the BLE is not supported
1945 **
1946 ** Returns          void
1947 **
1948 **
1949 *******************************************************************************/
1950 extern void BTA_DmSetEncryption(BD_ADDR bd_addr, tBTA_TRANSPORT transport,
1951                                 tBTA_DM_ENCRYPT_CBACK *p_callback,
1952                                 tBTA_DM_BLE_SEC_ACT sec_act);
1953 
1954 
1955 /*******************************************************************************
1956 **
1957 ** Function         BTA_DmBleObserve
1958 **
1959 ** Description      This procedure keep the device listening for advertising
1960 **                  events from a broadcast device.
1961 **
1962 ** Parameters       start: start or stop observe.
1963 **                  duration : Duration of the scan. Continuous scan if 0 is passed
1964 **                  p_results_cb: Callback to be called with scan results
1965 **
1966 ** Returns          void
1967 **
1968 *******************************************************************************/
1969 extern void BTA_DmBleObserve(BOOLEAN start, UINT8 duration,
1970                              tBTA_DM_SEARCH_CBACK *p_results_cb);
1971 
1972 
1973 #endif
1974 
1975 #if BLE_INCLUDED == TRUE
1976 /*******************************************************************************
1977 **
1978 ** Function         BTA_DmBleConfigLocalPrivacy
1979 **
1980 ** Description      Enable/disable privacy on the local device
1981 **
1982 ** Parameters:      privacy_enable   - enable/disabe privacy on remote device.
1983 **
1984 ** Returns          void
1985 **
1986 *******************************************************************************/
1987 extern void BTA_DmBleConfigLocalPrivacy(BOOLEAN privacy_enable);
1988 
1989 /*******************************************************************************
1990 **
1991 ** Function         BTA_DmBleEnableRemotePrivacy
1992 **
1993 ** Description      Enable/disable privacy on a remote device
1994 **
1995 ** Parameters:      bd_addr          - BD address of the peer
1996 **                  privacy_enable   - enable/disabe privacy on remote device.
1997 **
1998 ** Returns          void
1999 **
2000 *******************************************************************************/
2001 extern void BTA_DmBleEnableRemotePrivacy(BD_ADDR bd_addr, BOOLEAN privacy_enable);
2002 
2003 
2004 /*******************************************************************************
2005 **
2006 ** Function         BTA_DmBleSetAdvConfig
2007 **
2008 ** Description      This function is called to override the BTA default ADV parameters.
2009 **
2010 ** Parameters       Pointer to User defined ADV data structure
2011 **
2012 ** Returns          None
2013 **
2014 *******************************************************************************/
2015 extern void BTA_DmBleSetAdvConfig (tBTA_BLE_AD_MASK data_mask,
2016                                    tBTA_BLE_ADV_DATA *p_adv_cfg,
2017                                    tBTA_SET_ADV_DATA_CMPL_CBACK *p_adv_data_cback);
2018 
2019 /*******************************************************************************
2020 **
2021 ** Function         BTA_DmBleSetScanRsp
2022 **
2023 ** Description      This function is called to override the BTA scan response.
2024 **
2025 ** Parameters       Pointer to User defined ADV data structure
2026 **
2027 ** Returns          None
2028 **
2029 *******************************************************************************/
2030 extern void BTA_DmBleSetScanRsp (tBTA_BLE_AD_MASK data_mask,
2031                                  tBTA_BLE_ADV_DATA *p_adv_cfg,
2032                                  tBTA_SET_ADV_DATA_CMPL_CBACK *p_adv_data_cback);
2033 
2034 /*******************************************************************************
2035 **
2036 ** Function         BTA_DmBleBroadcast
2037 **
2038 ** Description      This function starts or stops LE broadcasting.
2039 **
2040 ** Parameters       start: start or stop broadcast.
2041 **
2042 ** Returns          None
2043 **
2044 *******************************************************************************/
2045 extern void BTA_DmBleBroadcast (BOOLEAN start);
2046 
2047 
2048 /*******************************************************************************
2049 **
2050 ** Function         BTA_BleEnableAdvInstance
2051 **
2052 ** Description      This function enables the Multi ADV instance feature
2053 **
2054 ** Parameters       p_params Pointer to ADV param user defined structure
2055 **                  p_cback  Pointer to Multi ADV callback structure
2056 **                  p_ref - Reference pointer
2057 **
2058 ** Returns          None
2059 **
2060 *******************************************************************************/
2061 extern void BTA_BleEnableAdvInstance (tBTA_BLE_ADV_PARAMS *p_params,
2062                                 tBTA_BLE_MULTI_ADV_CBACK *p_cback,void *p_ref);
2063 
2064 /*******************************************************************************
2065 **
2066 ** Function         BTA_BleUpdateAdvInstParam
2067 **
2068 ** Description      This function updates the Multi ADV instance params
2069 **
2070 ** Parameters       inst_id Instance ID
2071 **                  p_params Pointer to ADV param user defined structure
2072 **
2073 ** Returns          None
2074 **
2075 *******************************************************************************/
2076 extern void BTA_BleUpdateAdvInstParam (UINT8 inst_id,
2077                                 tBTA_BLE_ADV_PARAMS *p_params);
2078 
2079 /*******************************************************************************
2080 **
2081 ** Function         BTA_BleCfgAdvInstData
2082 **
2083 ** Description      This function is called to configure the ADV instance data
2084 **
2085 ** Parameters       inst_id - Instance ID
2086 **                  is_scan_rsp - Boolean value Scan response
2087 **                  Pointer to User defined ADV data structure
2088 ** Returns          None
2089 **
2090 *******************************************************************************/
2091 extern void BTA_BleCfgAdvInstData (UINT8 inst_id, BOOLEAN is_scan_rsp,
2092                                 tBTA_BLE_AD_MASK data_mask, tBTA_BLE_ADV_DATA *p_data);
2093 
2094 /*******************************************************************************
2095 **
2096 ** Function         BTA_BleDisableAdvInstance
2097 **
2098 ** Description      This function is called to disable the ADV instance
2099 **
2100 ** Parameters       inst_id - Instance ID to be disabled
2101 **
2102 ** Returns          None
2103 **
2104 *******************************************************************************/
2105 extern void BTA_BleDisableAdvInstance(UINT8 inst_id);
2106 
2107 /*******************************************************************************
2108 **
2109 ** Function         BTA_DmBleUpdateConnectionParams
2110 **
2111 ** Description      Update connection parameters, can only be used when connection is up.
2112 **
2113 ** Parameters:      bd_addr   - BD address of the peer
2114 **                  min_int   -     minimum connection interval, [0x0004~ 0x4000]
2115 **                  max_int   -     maximum connection interval, [0x0004~ 0x4000]
2116 **                  latency   -     slave latency [0 ~ 500]
2117 **                  timeout   -     supervision timeout [0x000a ~ 0xc80]
2118 **
2119 ** Returns          void
2120 **
2121 *******************************************************************************/
2122 extern void BTA_DmBleUpdateConnectionParams(BD_ADDR bd_addr, UINT16 min_int,
2123                                    UINT16 max_int, UINT16 latency, UINT16 timeout);
2124 
2125 /*******************************************************************************
2126 **
2127 ** Function         BTA_DmBleSetDataLength
2128 **
2129 ** Description      This function is to set maximum LE data packet size
2130 **
2131 ** Returns          void
2132 **
2133 *******************************************************************************/
2134 extern void BTA_DmBleSetDataLength(BD_ADDR remote_device, UINT16 tx_data_length);
2135 
2136 /*******************************************************************************
2137 **
2138 ** Function         BTA_DmBleSetStorageParams
2139 **
2140 ** Description      This function is called to set the storage parameters
2141 **
2142 ** Parameters       batch_scan_full_max -Max storage space (in %) allocated to full scanning
2143 **                  batch_scan_trunc_max -Max storage space (in %) allocated to truncated scanning
2144 **                  batch_scan_notify_threshold - Setup notification level based on total space
2145 **                  consumed by both pools. Setting it to 0 will disable threshold notification
2146 **                  p_setup_cback - Setup callback
2147 **                  p_thres_cback - Threshold callback
2148 **                  p_rep_cback - Reports callback
2149 **                  ref_value - Reference value
2150 **
2151 ** Returns           None
2152 **
2153 *******************************************************************************/
2154 extern void BTA_DmBleSetStorageParams(UINT8 batch_scan_full_max,
2155                                          UINT8 batch_scan_trunc_max,
2156                                          UINT8 batch_scan_notify_threshold,
2157                                          tBTA_BLE_SCAN_SETUP_CBACK *p_setup_cback,
2158                                          tBTA_BLE_SCAN_THRESHOLD_CBACK *p_thres_cback,
2159                                          tBTA_BLE_SCAN_REP_CBACK* p_rep_cback,
2160                                          tBTA_DM_BLE_REF_VALUE ref_value);
2161 
2162 /*******************************************************************************
2163 **
2164 ** Function         BTA_DmBleEnableBatchScan
2165 **
2166 ** Description      This function is called to enable the batch scan
2167 **
2168 ** Parameters       scan_mode -Batch scan mode
2169 **                  scan_interval - Scan interval
2170 **                  scan_window - Scan window
2171 **                  discard_rule -Discard rules
2172 **                  addr_type - Address type
2173 **                  ref_value - Reference value
2174 **
2175 ** Returns           None
2176 **
2177 *******************************************************************************/
2178 extern void BTA_DmBleEnableBatchScan(tBTA_BLE_BATCH_SCAN_MODE scan_mode,
2179                                          UINT32 scan_interval, UINT32 scan_window,
2180                                          tBTA_BLE_DISCARD_RULE discard_rule,
2181                                          tBLE_ADDR_TYPE        addr_type,
2182                                          tBTA_DM_BLE_REF_VALUE ref_value);
2183 
2184 /*******************************************************************************
2185 **
2186 ** Function         BTA_DmBleReadScanReports
2187 **
2188 ** Description      This function is called to read the batch scan reports
2189 **
2190 ** Parameters       scan_mode -Batch scan mode
2191 **                  ref_value - Reference value
2192 **
2193 ** Returns          None
2194 **
2195 *******************************************************************************/
2196 extern void BTA_DmBleReadScanReports(tBTA_BLE_BATCH_SCAN_MODE scan_type,
2197                                              tBTA_DM_BLE_REF_VALUE ref_value);
2198 
2199 /*******************************************************************************
2200 **
2201 ** Function         BTA_DmBleDisableBatchScan
2202 **
2203 ** Description      This function is called to disable the batch scanning
2204 **
2205 ** Parameters       ref_value - Reference value
2206 **
2207 ** Returns          None
2208 **
2209 *******************************************************************************/
2210 extern void BTA_DmBleDisableBatchScan(tBTA_DM_BLE_REF_VALUE ref_value);
2211 
2212 /*******************************************************************************
2213 **
2214 ** Function         BTA_DmEnableScanFilter
2215 **
2216 ** Description      This function is called to enable the adv data payload filter
2217 **
2218 ** Parameters       action - enable or disable the APCF feature
2219 **                  p_cmpl_cback - Command completed callback
2220 **                  ref_value - Reference value
2221 **
2222 ** Returns          void
2223 **
2224 *******************************************************************************/
2225 extern void BTA_DmEnableScanFilter(UINT8 action,
2226                                         tBTA_DM_BLE_PF_STATUS_CBACK *p_cmpl_cback,
2227                                         tBTA_DM_BLE_REF_VALUE ref_value);
2228 
2229 /*******************************************************************************
2230 **
2231 ** Function         BTA_DmBleScanFilterSetup
2232 **
2233 ** Description      This function is called to setup the filter params
2234 **
2235 ** Parameters       p_target: enable the filter condition on a target device; if NULL
2236 **                  filt_index - Filter index
2237 **                  p_filt_params -Filter parameters
2238 **                  ref_value - Reference value
2239 **                  action - Add, delete or clear
2240 **                  p_cmpl_back - Command completed callback
2241 **
2242 ** Returns          void
2243 **
2244 *******************************************************************************/
2245 extern void BTA_DmBleScanFilterSetup(UINT8 action,
2246                                                    tBTA_DM_BLE_PF_FILT_INDEX filt_index,
2247                                                    tBTA_DM_BLE_PF_FILT_PARAMS *p_filt_params,
2248                                                    tBLE_BD_ADDR *p_target,
2249                                                    tBTA_DM_BLE_PF_PARAM_CBACK *p_cmpl_cback,
2250                                                    tBTA_DM_BLE_REF_VALUE ref_value);
2251 
2252 /*******************************************************************************
2253 **
2254 ** Function         BTA_DmBleCfgFilterCondition
2255 **
2256 ** Description      This function is called to configure the adv data payload filter
2257 **                  condition.
2258 **
2259 ** Parameters       action: to read/write/clear
2260 **                  cond_type: filter condition type
2261 **                  filt_index - Filter index
2262 **                  p_cond: filter condition parameter
2263 **                  p_cmpl_back - Command completed callback
2264 **                  ref_value - Reference value
2265 **
2266 ** Returns          void
2267 **
2268 *******************************************************************************/
2269 extern void BTA_DmBleCfgFilterCondition(tBTA_DM_BLE_SCAN_COND_OP action,
2270                                                  tBTA_DM_BLE_PF_COND_TYPE cond_type,
2271                                                  tBTA_DM_BLE_PF_FILT_INDEX filt_index,
2272                                                  tBTA_DM_BLE_PF_COND_PARAM *p_cond,
2273                                                  tBTA_DM_BLE_PF_CFG_CBACK *p_cmpl_cback,
2274                                                  tBTA_DM_BLE_REF_VALUE ref_value);
2275 
2276 
2277 /*******************************************************************************
2278 **
2279 ** Function         BTA_DmBleTrackAdvertiser
2280 **
2281 ** Description      This function is called to track the advertiser
2282 **
2283 ** Parameters    ref_value - Reference value
2284 **               p_track_adv_cback - ADV callback
2285 **
2286 ** Returns          None
2287 **
2288 *******************************************************************************/
2289 extern void BTA_DmBleTrackAdvertiser(tBTA_DM_BLE_REF_VALUE ref_value,
2290                             tBTA_BLE_TRACK_ADV_CBACK *p_track_adv_cback);
2291 
2292 /*******************************************************************************
2293 **
2294 ** Function         BTA_DmBleGetEnergyInfo
2295 **
2296 ** Description      This function is called to obtain the energy info
2297 **
2298 ** Parameters       p_cmpl_cback - Command complete callback
2299 **
2300 ** Returns          void
2301 **
2302 *******************************************************************************/
2303 extern void BTA_DmBleGetEnergyInfo(tBTA_BLE_ENERGY_INFO_CBACK *p_cmpl_cback);
2304 
2305 /*******************************************************************************
2306 **
2307 ** Function         BTA_BrcmInit
2308 **
2309 ** Description      This function initializes Broadcom specific VS handler in BTA
2310 **
2311 ** Returns          void
2312 **
2313 *******************************************************************************/
2314 extern void BTA_VendorInit  (void);
2315 
2316 /*******************************************************************************
2317 **
2318 ** Function         BTA_BrcmCleanup
2319 **
2320 ** Description      This function frees up Broadcom specific VS specific dynamic memory
2321 **
2322 ** Returns          void
2323 **
2324 *******************************************************************************/
2325 extern void BTA_VendorCleanup (void);
2326 
2327 #endif
2328 
2329 #ifdef __cplusplus
2330 }
2331 #endif
2332 
2333 #endif /* BTA_API_H */
2334