bta_api.h revision 781b5adee20e222ef87b56b72bfcd3f64013e4a0
1/******************************************************************************
2 *
3 *  Copyright (C) 2003-2012 Broadcom Corporation
4 *
5 *  Licensed under the Apache License, Version 2.0 (the "License");
6 *  you may not use this file except in compliance with the License.
7 *  You may obtain a copy of the License at:
8 *
9 *  http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 *
17 ******************************************************************************/
18
19/******************************************************************************
20 *
21 *  This 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 "data_types.h"
29#include "bt_target.h"
30#include "bt_types.h"
31#include "btm_api.h"
32#include "uipc_msg.h"
33
34#if BLE_INCLUDED == TRUE
35#include "btm_ble_api.h"
36#endif
37
38/*****************************************************************************
39**  Constants and data types
40*****************************************************************************/
41
42/* Status Return Value */
43#define BTA_SUCCESS             0           /* Successful operation. */
44#define BTA_FAILURE             1           /* Generic failure. */
45#define BTA_PENDING             2           /* API cannot be completed right now */
46#define BTA_BUSY                3
47#define BTA_NO_RESOURCES        4
48#define BTA_WRONG_MODE          5
49
50typedef UINT8 tBTA_STATUS;
51
52/*
53 * Service ID
54 *
55 * NOTES: When you add a new Service ID for BTA AND require to change the value of BTA_MAX_SERVICE_ID,
56 *        make sure that the correct security ID of the new service from Security service definitions (btm_api.h)
57 *        should be added to bta_service_id_to_btm_srv_id_lkup_tbl table in bta_dm_act.c.
58 */
59
60#define BTA_RES_SERVICE_ID      0           /* Reserved */
61#define BTA_SPP_SERVICE_ID      1           /* Serial port profile. */
62#define BTA_DUN_SERVICE_ID      2           /* Dial-up networking profile. */
63#define BTA_A2DP_SOURCE_SERVICE_ID      3   /* A2DP Source profile. */
64#define BTA_LAP_SERVICE_ID      4           /* LAN access profile. */
65#define BTA_HSP_SERVICE_ID      5           /* Headset profile. */
66#define BTA_HFP_SERVICE_ID      6           /* Hands-free profile. */
67#define BTA_OPP_SERVICE_ID      7           /* Object push  */
68#define BTA_FTP_SERVICE_ID      8           /* File transfer */
69#define BTA_CTP_SERVICE_ID      9           /* Cordless Terminal */
70#define BTA_ICP_SERVICE_ID      10          /* Intercom Terminal */
71#define BTA_SYNC_SERVICE_ID     11          /* Synchronization */
72#define BTA_BPP_SERVICE_ID      12          /* Basic printing profile */
73#define BTA_BIP_SERVICE_ID      13          /* Basic Imaging profile */
74#define BTA_PANU_SERVICE_ID     14          /* PAN User */
75#define BTA_NAP_SERVICE_ID      15          /* PAN Network access point */
76#define BTA_GN_SERVICE_ID       16          /* PAN Group Ad-hoc networks */
77#define BTA_SAP_SERVICE_ID      17          /* SIM Access profile */
78#define BTA_A2DP_SERVICE_ID     18          /* A2DP Sink */
79#define BTA_AVRCP_SERVICE_ID    19          /* A/V remote control */
80#define BTA_HID_SERVICE_ID      20          /* HID */
81#define BTA_VDP_SERVICE_ID      21          /* Video distribution */
82#define BTA_PBAP_SERVICE_ID     22          /* PhoneBook Access Server*/
83#define BTA_HSP_HS_SERVICE_ID   23          /* HFP HS role */
84#define BTA_HFP_HS_SERVICE_ID   24          /* HSP HS role */
85#define BTA_MAP_SERVICE_ID      25          /* Message Access Profile */
86#define BTA_MN_SERVICE_ID       26          /* Message Notification Service */
87#define BTA_HDP_SERVICE_ID      27          /* Health Device Profile */
88#define BTA_PCE_SERVICE_ID      28          /* PhoneBook Access Client*/
89
90#if BLE_INCLUDED == TRUE && BTA_GATT_INCLUDED == TRUE
91/* BLE profile service ID */
92#define BTA_BLE_SERVICE_ID      29          /* GATT profile */
93
94// btla-specific ++
95#define BTA_USER_SERVICE_ID     30          /* User requested UUID */
96
97#define BTA_MAX_SERVICE_ID      31
98// btla-specific --
99#else
100#define BTA_USER_SERVICE_ID     29          /* User requested UUID */
101#define BTA_MAX_SERVICE_ID      30
102#endif
103/* service IDs (BTM_SEC_SERVICE_FIRST_EMPTY + 1) to (BTM_SEC_MAX_SERVICES - 1)
104 * are used by BTA JV */
105#define BTA_FIRST_JV_SERVICE_ID     (BTM_SEC_SERVICE_FIRST_EMPTY + 1)
106#define BTA_LAST_JV_SERVICE_ID      (BTM_SEC_MAX_SERVICES - 1)
107
108typedef UINT8 tBTA_SERVICE_ID;
109
110/* Service ID Mask */
111#define BTA_RES_SERVICE_MASK        0x00000001  /* Reserved */
112#define BTA_SPP_SERVICE_MASK        0x00000002  /* Serial port profile. */
113#define BTA_DUN_SERVICE_MASK        0x00000004  /* Dial-up networking profile. */
114#define BTA_FAX_SERVICE_MASK        0x00000008  /* Fax profile. */
115#define BTA_LAP_SERVICE_MASK        0x00000010  /* LAN access profile. */
116#define BTA_HSP_SERVICE_MASK        0x00000020  /* HSP AG role. */
117#define BTA_HFP_SERVICE_MASK        0x00000040  /* HFP AG role */
118#define BTA_OPP_SERVICE_MASK        0x00000080  /* Object push  */
119#define BTA_FTP_SERVICE_MASK        0x00000100  /* File transfer */
120#define BTA_CTP_SERVICE_MASK        0x00000200  /* Cordless Terminal */
121#define BTA_ICP_SERVICE_MASK        0x00000400  /* Intercom Terminal */
122#define BTA_SYNC_SERVICE_MASK       0x00000800  /* Synchronization */
123#define BTA_BPP_SERVICE_MASK        0x00001000  /* Print server */
124#define BTA_BIP_SERVICE_MASK        0x00002000  /* Basic Imaging */
125#define BTA_PANU_SERVICE_MASK       0x00004000  /* PAN User */
126#define BTA_NAP_SERVICE_MASK        0x00008000  /* PAN Network access point */
127#define BTA_GN_SERVICE_MASK         0x00010000  /* PAN Group Ad-hoc networks */
128#define BTA_SAP_SERVICE_MASK        0x00020000  /* PAN Group Ad-hoc networks */
129#define BTA_A2DP_SERVICE_MASK       0x00040000  /* Advanced audio distribution */
130#define BTA_AVRCP_SERVICE_MASK      0x00080000  /* A/V remote control */
131#define BTA_HID_SERVICE_MASK        0x00100000  /* HID */
132#define BTA_VDP_SERVICE_MASK        0x00200000  /* Video distribution */
133#define BTA_PBAP_SERVICE_MASK       0x00400000  /* Phone Book Server */
134#define BTA_HSP_HS_SERVICE_MASK     0x00800000  /* HFP HS role */
135#define BTA_HFP_HS_SERVICE_MASK     0x01000000  /* HSP HS role */
136#define BTA_MAS_SERVICE_MASK        0x02000000  /* Message Access Profile */
137#define BTA_MN_SERVICE_MASK         0x04000000  /* Message Notification Profile */
138#define BTA_HL_SERVICE_MASK         0x08000000  /* Health Device Profile */
139#define BTA_PCE_SERVICE_MASK        0x10000000  /* Phone Book Client */
140
141#if BLE_INCLUDED == TRUE && BTA_GATT_INCLUDED == TRUE
142#define BTA_BLE_SERVICE_MASK        0x20000000  /* GATT based service */
143// btla-specific ++
144#define BTA_USER_SERVICE_MASK       0x40000000  /* Message Notification Profile */
145// btla-specific --
146#else
147// btla-specific ++
148#define BTA_USER_SERVICE_MASK       0x20000000  /* Message Notification Profile */
149// btla-specific --
150#endif
151
152#if BLE_INCLUDED == TRUE && BTA_GATT_INCLUDED == TRUE
153#define BTA_ALL_SERVICE_MASK        0x3FFFFFFF  /* All services supported by BTA. */
154#else
155#define BTA_ALL_SERVICE_MASK        0x1FFFFFFF  /* All services supported by BTA. */
156#endif
157
158typedef UINT32 tBTA_SERVICE_MASK;
159
160/* extended service mask, including mask with one or more GATT UUID */
161typedef struct
162{
163    tBTA_SERVICE_MASK   srvc_mask;
164    UINT8               num_uuid;
165    tBT_UUID            *p_uuid;
166}tBTA_SERVICE_MASK_EXT;
167
168/* Security Setting Mask */
169#define BTA_SEC_NONE            BTM_SEC_NONE                                         /* No security. */
170#define BTA_SEC_AUTHORIZE       (BTM_SEC_IN_AUTHORIZE )                              /* Authorization required (only needed for out going connection )*/
171#define BTA_SEC_AUTHENTICATE    (BTM_SEC_IN_AUTHENTICATE | BTM_SEC_OUT_AUTHENTICATE) /* Authentication required. */
172#define BTA_SEC_ENCRYPT         (BTM_SEC_IN_ENCRYPT | BTM_SEC_OUT_ENCRYPT)           /* Encryption required. */
173
174typedef UINT8 tBTA_SEC;
175
176/* Ignore for Discoverable, Connectable, Pairable and Connectable Paired only device modes */
177
178#define BTA_DM_IGNORE           0xFF
179
180#define BTA_ALL_APP_ID          0xFF
181
182/* Discoverable Modes */
183#define BTA_DM_NON_DISC         BTM_NON_DISCOVERABLE        /* Device is not discoverable. */
184#define BTA_DM_GENERAL_DISC     BTM_GENERAL_DISCOVERABLE    /* General discoverable. */
185#define BTA_DM_LIMITED_DISC     BTM_LIMITED_DISCOVERABLE    /* Limited discoverable. */
186#if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
187#define BTA_DM_BLE_NON_DISCOVERABLE        BTM_BLE_NON_DISCOVERABLE        /* Device is not LE discoverable */
188#define BTA_DM_BLE_GENERAL_DISCOVERABLE    BTM_BLE_GENERAL_DISCOVERABLE    /* Device is LE General discoverable */
189#define BTA_DM_BLE_LIMITED_DISCOVERABLE    BTM_BLE_LIMITED_DISCOVERABLE    /* Device is LE Limited discoverable */
190#endif
191typedef UINT16 tBTA_DM_DISC;        /* this discoverability mode is a bit mask among BR mode and LE mode */
192
193/* Connectable Modes */
194#define BTA_DM_NON_CONN         BTM_NON_CONNECTABLE         /* Device is not connectable. */
195#define BTA_DM_CONN             BTM_CONNECTABLE             /* Device is connectable. */
196#if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
197#define BTA_DM_BLE_NON_CONNECTABLE      BTM_BLE_NON_CONNECTABLE     /* Device is LE non-connectable. */
198#define BTA_DM_BLE_CONNECTABLE          BTM_BLE_CONNECTABLE         /* Device is LE connectable. */
199#endif
200
201// btla-specific ++
202typedef UINT16 tBTA_DM_CONN;
203// btla-specific --
204
205/* Pairable Modes */
206#define BTA_DM_PAIRABLE         1
207#define BTA_DM_NON_PAIRABLE     0
208
209/* Connectable Paired Only Mode */
210#define BTA_DM_CONN_ALL         0
211#define BTA_DM_CONN_PAIRED      1
212
213/* Inquiry Modes */
214#define BTA_DM_INQUIRY_NONE		BTM_INQUIRY_NONE            /*No BR inquiry. */
215#define BTA_DM_GENERAL_INQUIRY  BTM_GENERAL_INQUIRY         /* Perform general inquiry. */
216#define BTA_DM_LIMITED_INQUIRY  BTM_LIMITED_INQUIRY         /* Perform limited inquiry. */
217
218#if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
219#define BTA_BLE_INQUIRY_NONE    BTM_BLE_INQUIRY_NONE
220#define BTA_BLE_GENERAL_INQUIRY BTM_BLE_GENERAL_INQUIRY      /* Perform LE general inquiry. */
221#define BTA_BLE_LIMITED_INQUIRY BTM_BLE_LIMITED_INQUIRY      /* Perform LE limited inquiry. */
222#endif
223typedef UINT8 tBTA_DM_INQ_MODE;
224
225/* Inquiry Filter Type */
226#define BTA_DM_INQ_CLR          BTM_CLR_INQUIRY_FILTER          /* Clear inquiry filter. */
227#define BTA_DM_INQ_DEV_CLASS    BTM_FILTER_COND_DEVICE_CLASS    /* Filter on device class. */
228#define BTA_DM_INQ_BD_ADDR      BTM_FILTER_COND_BD_ADDR         /* Filter on a specific  BD address. */
229
230typedef UINT8 tBTA_DM_INQ_FILT;
231
232/* Authorize Response */
233#define BTA_DM_AUTH_PERM        0      /* Authorized for future connections to the service */
234#define BTA_DM_AUTH_TEMP        1      /* Authorized for current connection only */
235#define BTA_DM_NOT_AUTH         2      /* Not authorized for the service */
236
237typedef UINT8 tBTA_AUTH_RESP;
238
239/* M/S preferred roles */
240#define BTA_ANY_ROLE          0x00
241#define BTA_MASTER_ROLE_PREF  0x01
242#define BTA_MASTER_ROLE_ONLY  0x02
243
244typedef UINT8 tBTA_PREF_ROLES;
245
246enum
247{
248
249    BTA_DM_NO_SCATTERNET,        /* Device doesn't support scatternet, it might
250                                    support "role switch during connection" for
251                                    an incoming connection, when it already has
252                                    another connection in master role */
253    BTA_DM_PARTIAL_SCATTERNET,   /* Device supports partial scatternet. It can have
254                                    simulateous connection in Master and Slave roles
255                                    for short period of time */
256    BTA_DM_FULL_SCATTERNET       /* Device can have simultaneous connection in master
257                                    and slave roles */
258
259};
260
261
262/* Inquiry filter device class condition */
263typedef struct
264{
265    DEV_CLASS       dev_class;        /* device class of interest */
266    DEV_CLASS       dev_class_mask;   /* mask to determine the bits of device class of interest */
267} tBTA_DM_COD_COND;
268
269
270/* Inquiry Filter Condition */
271typedef union
272{
273    BD_ADDR              bd_addr;            /* BD address of  device to filter. */
274    tBTA_DM_COD_COND     dev_class_cond;     /* Device class filter condition */
275} tBTA_DM_INQ_COND;
276
277/* Inquiry Parameters */
278typedef struct
279{
280    tBTA_DM_INQ_MODE    mode;           /* Inquiry mode, limited or general. */
281    UINT8               duration;       /* Inquiry duration in 1.28 sec units. */
282    UINT8               max_resps;      /* Maximum inquiry responses.  Set to zero for unlimited responses. */
283    BOOLEAN             report_dup;     /* report duplicated inquiry response with higher RSSI value */
284    tBTA_DM_INQ_FILT    filter_type;    /* Filter condition type. */
285    tBTA_DM_INQ_COND    filter_cond;    /* Filter condition data. */
286} tBTA_DM_INQ;
287
288typedef struct
289{
290    UINT8   bta_dm_eir_min_name_len;        /* minimum length of local name when it is shortened */
291#if (BTA_EIR_CANNED_UUID_LIST == TRUE)
292    UINT8   bta_dm_eir_uuid16_len;          /* length of 16-bit UUIDs */
293    UINT8  *bta_dm_eir_uuid16;              /* 16-bit UUIDs */
294#else
295    UINT32  uuid_mask[BTM_EIR_SERVICE_ARRAY_SIZE]; /* mask of UUID list in EIR */
296#endif
297    INT8   *bta_dm_eir_inq_tx_power;        /* Inquiry TX power         */
298    UINT8   bta_dm_eir_flag_len;            /* length of flags in bytes */
299    UINT8  *bta_dm_eir_flags;               /* flags for EIR */
300    UINT8   bta_dm_eir_manufac_spec_len;    /* length of manufacturer specific in bytes */
301    UINT8  *bta_dm_eir_manufac_spec;        /* manufacturer specific */
302    UINT8   bta_dm_eir_additional_len;      /* length of additional data in bytes */
303    UINT8  *bta_dm_eir_additional;          /* additional data */
304} tBTA_DM_EIR_CONF;
305
306#if BLE_INCLUDED == TRUE
307/* ADV data flag bit definition used for BTM_BLE_AD_TYPE_FLAG */
308#define BTA_BLE_LIMIT_DISC_FLAG     BTM_BLE_LIMIT_DISC_FLAG
309#define BTA_BLE_GEN_DISC_FLAG       BTM_BLE_GEN_DISC_FLAG
310#define BTA_BLE_BREDR_NOT_SPT       BTM_BLE_BREDR_NOT_SPT
311#define BTA_BLE_NON_LIMIT_DISC_FLAG BTM_BLE_NON_LIMIT_DISC_FLAG
312#define BTA_BLE_ADV_FLAG_MASK       BTM_BLE_ADV_FLAG_MASK
313#define BTA_BLE_LIMIT_DISC_MASK     BTM_BLE_LIMIT_DISC_MASK
314
315/* ADV data bit mask */
316#define BTA_BLE_AD_BIT_DEV_NAME        BTM_BLE_AD_BIT_DEV_NAME
317#define BTA_BLE_AD_BIT_FLAGS           BTM_BLE_AD_BIT_FLAGS
318#define BTA_BLE_AD_BIT_MANU            BTM_BLE_AD_BIT_MANU
319#define BTA_BLE_AD_BIT_TX_PWR          BTM_BLE_AD_BIT_TX_PWR
320#define BTA_BLE_AD_BIT_INT_RANGE       BTM_BLE_AD_BIT_INT_RANGE
321#define BTA_BLE_AD_BIT_SERVICE         BTM_BLE_AD_BIT_SERVICE
322#define BTA_BLE_AD_BIT_APPEARANCE      BTM_BLE_AD_BIT_APPEARANCE
323#define BTA_BLE_AD_BIT_PROPRIETARY     BTM_BLE_AD_BIT_PROPRIETARY
324#define BTA_DM_BLE_AD_BIT_SERVICE_SOL     BTM_BLE_AD_BIT_SERVICE_SOL
325#define BTA_DM_BLE_AD_BIT_SERVICE_DATA    BTM_BLE_AD_BIT_SERVICE_DATA
326#define BTA_DM_BLE_AD_BIT_SIGN_DATA       BTM_BLE_AD_BIT_SIGN_DATA
327#define BTA_DM_BLE_AD_BIT_SERVICE_128SOL  BTM_BLE_AD_BIT_SERVICE_128SOL
328#define BTA_DM_BLE_AD_BIT_PUBLIC_ADDR     BTM_BLE_AD_BIT_PUBLIC_ADDR
329#define BTA_DM_BLE_AD_BIT_RANDOM_ADDR     BTM_BLE_AD_BIT_RANDOM_ADDR
330
331typedef  UINT16  tBTA_BLE_AD_MASK;
332
333/* slave preferred connection interval range */
334typedef struct
335{
336    UINT16  low;
337    UINT16  hi;
338
339}tBTA_BLE_INT_RANGE;
340
341/* Service tag supported in the device */
342typedef struct
343{
344    UINT8       num_service;
345    BOOLEAN     list_cmpl;
346    UINT16      *p_uuid;
347}tBTA_BLE_SERVICE;
348
349
350typedef struct
351{
352    UINT8       len;
353    UINT8      *p_val;
354}tBTA_BLE_MANU;
355
356typedef struct
357{
358    UINT8       adv_type;
359    UINT8       len;
360    UINT8       *p_val;     /* number of len byte */
361}tBTA_BLE_PROP_ELEM;
362
363/* vendor proprietary adv type */
364typedef struct
365{
366    UINT8                   num_elem;
367    tBTA_BLE_PROP_ELEM      *p_elem;
368}tBTA_BLE_PROPRIETARY;
369
370typedef struct
371{
372    tBTA_BLE_MANU			manu;			/* manufactuer data */
373    tBTA_BLE_INT_RANGE		int_range;      /* slave prefered conn interval range */
374    tBTA_BLE_SERVICE		services;       /* services */
375	UINT16					appearance;		/* appearance data */
376    UINT8					flag;
377    tBTA_BLE_PROPRIETARY    *p_proprietary;
378
379}tBTA_BLE_ADV_DATA;
380
381/* These are the fields returned in each device adv packet.  It
382** is returned in the results callback if registered.
383*/
384typedef struct
385{
386    UINT8               conn_mode;
387    tBTA_BLE_AD_MASK    ad_mask;        /* mask of the valid adv data field */
388    UINT8               flag;
389    UINT8               tx_power_level;
390    UINT8               remote_name_len;
391    UINT8               *p_remote_name;
392    tBTA_BLE_SERVICE    service;
393} tBTA_BLE_INQ_DATA;
394#endif
395
396/* BLE customer specific feature function type definitions */
397/* data type used on customer specific feature for RSSI monitoring */
398#define BTA_BLE_RSSI_ALERT_HI        0
399#define BTA_BLE_RSSI_ALERT_RANGE     1
400#define BTA_BLE_RSSI_ALERT_LO        2
401typedef UINT8 tBTA_DM_BLE_RSSI_ALERT_TYPE;
402
403#define BTA_BLE_RSSI_ALERT_NONE		    BTM_BLE_RSSI_ALERT_NONE		/*	(0) */
404#define BTA_BLE_RSSI_ALERT_HI_BIT		BTM_BLE_RSSI_ALERT_HI_BIT		/*	(1) */
405#define BTA_BLE_RSSI_ALERT_RANGE_BIT	BTM_BLE_RSSI_ALERT_RANGE_BIT	/*	(1 << 1) */
406#define BTA_BLE_RSSI_ALERT_LO_BIT		BTM_BLE_RSSI_ALERT_LO_BIT		/*	(1 << 2) */
407typedef UINT8     tBTA_DM_BLE_RSSI_ALERT_MASK;
408
409
410typedef void (tBTA_DM_BLE_RSSI_CBACK) (BD_ADDR bd_addr, tBTA_DM_BLE_RSSI_ALERT_TYPE alert_type, INT8 rssi);
411
412/* max number of filter spot for different filter type */
413#define BTA_DM_BLE_MAX_UUID_FILTER     BTM_BLE_MAX_UUID_FILTER    /* 8 */
414#define BTA_DM_BLE_MAX_ADDR_FILTER     BTM_BLE_MAX_ADDR_FILTER    /* 8 */
415#define BTA_DM_BLE_PF_STR_COND_MAX     BTM_BLE_PF_STR_COND_MAX    /* 4    apply to manu data , or local name */
416#define BTA_DM_BLE_PF_STR_LEN_MAX      BTM_BLE_PF_STR_LEN_MAX  /* match for first 20 bytes */
417
418#define BTA_DM_BLE_PF_LOGIC_OR              0
419#define BTA_DM_BLE_PF_LOGIC_AND             1
420typedef UINT8 tBTA_DM_BLE_PF_LOGIC_TYPE;
421
422enum
423{
424    BTA_DM_BLE_SCAN_COND_ADD,
425    BTA_DM_BLE_SCAN_COND_DELETE,
426    BTA_DM_BLE_SCAN_COND_CLEAR = 2
427};
428typedef UINT8 tBTA_DM_BLE_SCAN_COND_OP;
429
430/* filter selection bit index  */
431#define BTA_DM_BLE_PF_ADDR_FILTER          BTM_BLE_PF_ADDR_FILTER
432#define BTA_DM_BLE_PF_SRVC_UUID            BTM_BLE_PF_SRVC_UUID
433#define BTA_DM_BLE_PF_SRVC_SOL_UUID        BTM_BLE_PF_SRVC_SOL_UUID
434#define BTA_DM_BLE_PF_LOCAL_NAME           BTM_BLE_PF_LOCAL_NAME
435#define BTA_DM_BLE_PF_MANU_DATA            BTM_BLE_PF_MANU_DATA
436#define BTA_DM_BLE_PF_SRVC_DATA            BTM_BLE_PF_SRVC_DATA
437#define BTA_DM_BLE_PF_TYPE_MAX             BTM_BLE_PF_TYPE_MAX
438#define BTA_DM_BLE_PF_TYPE_ALL             BTM_BLE_PF_TYPE_ALL
439typedef UINT8   tBTA_DM_BLE_PF_COND_TYPE;
440
441typedef struct
442{
443    tBLE_BD_ADDR                *p_target_addr;     /* target address, if NULL, generic UUID filter */
444    tBT_UUID                    uuid;           /* UUID condition */
445    tBTA_DM_BLE_PF_LOGIC_TYPE   cond_logic;    /* AND/OR */
446}tBTA_DM_BLE_PF_UUID_COND;
447
448typedef struct
449{
450    UINT8                   data_len;       /* <= 20 bytes */
451    UINT8                   *p_data;
452}tBTA_DM_BLE_PF_LOCAL_NAME_COND;
453
454typedef struct
455{
456    UINT16                  company_id;     /* company ID */
457    UINT8                   data_len;       /* <= 20 bytes */
458    UINT8                   *p_pattern;
459}tBTA_DM_BLE_PF_MANU_COND;
460
461typedef union
462{
463    tBLE_BD_ADDR                            target_addr;
464    tBTA_DM_BLE_PF_LOCAL_NAME_COND             local_name; /* lcoal name filtering */
465    tBTA_DM_BLE_PF_MANU_COND                   manu_data;  /* manufactuer data filtering */
466    tBTA_DM_BLE_PF_UUID_COND                   srvc_uuid;  /* service UUID filtering */
467    tBTA_DM_BLE_PF_UUID_COND                   solicitate_uuid;   /* solicitated service UUID filtering */
468}tBTA_DM_BLE_PF_COND_PARAM;
469
470
471typedef INT8 tBTA_DM_RSSI_VALUE;
472typedef UINT8 tBTA_DM_LINK_QUALITY_VALUE;
473
474
475/* signal strength mask */
476#define BTA_SIG_STRENGTH_RSSI_MASK          1
477#define BTA_SIG_STRENGTH_LINK_QUALITY_MASK  2
478
479typedef UINT8 tBTA_SIG_STRENGTH_MASK;
480
481
482/* Security Callback Events */
483#define BTA_DM_ENABLE_EVT               0       /* Enable Event */
484#define BTA_DM_DISABLE_EVT              1       /* Disable Event */
485#define BTA_DM_PIN_REQ_EVT              2       /* PIN request. */
486#define BTA_DM_AUTH_CMPL_EVT            3       /* Authentication complete indication. */
487#define BTA_DM_AUTHORIZE_EVT            4       /* Authorization request. */
488#define BTA_DM_LINK_UP_EVT              5       /* Connection UP event */
489#define BTA_DM_LINK_DOWN_EVT            6       /* Connection DOWN event */
490#define BTA_DM_SIG_STRENGTH_EVT         7       /* Signal strength for bluetooth connection */
491#define BTA_DM_BUSY_LEVEL_EVT           8       /* System busy level */
492#define BTA_DM_BOND_CANCEL_CMPL_EVT     9       /* Bond cancel complete indication */
493#define BTA_DM_SP_CFM_REQ_EVT           10      /* Simple Pairing User Confirmation request. */
494#define BTA_DM_SP_KEY_NOTIF_EVT         11      /* Simple Pairing Passkey Notification */
495#define BTA_DM_SP_RMT_OOB_EVT           12      /* Simple Pairing Remote OOB Data request. */
496#define BTA_DM_SP_KEYPRESS_EVT          13      /* Key press notification event. */
497#define BTA_DM_ROLE_CHG_EVT             14      /* Role Change event. */
498#define BTA_DM_BLE_KEY_EVT              15      /* BLE SMP key event for peer device keys */
499#define BTA_DM_BLE_SEC_REQ_EVT          16      /* BLE SMP security request */
500#define BTA_DM_BLE_PASSKEY_NOTIF_EVT    17      /* SMP passkey notification event */
501#define BTA_DM_BLE_PASSKEY_REQ_EVT      18      /* SMP passkey request event */
502#define BTA_DM_BLE_OOB_REQ_EVT          19      /* SMP OOB request event */
503#define BTA_DM_BLE_LOCAL_IR_EVT         20      /* BLE local IR event */
504#define BTA_DM_BLE_LOCAL_ER_EVT         21      /* BLE local ER event */
505// btla-specific ++
506#define BTA_DM_BLE_AUTH_CMPL_EVT        22      /* BLE Auth complete */
507// btla-specific --
508#define BTA_DM_DEV_UNPAIRED_EVT         23
509#define BTA_DM_HW_ERROR_EVT             24      /* BT Chip H/W error */
510typedef UINT8 tBTA_DM_SEC_EVT;
511
512/* Structure associated with BTA_DM_ENABLE_EVT */
513typedef struct
514{
515    BD_ADDR         bd_addr;            /* BD address of local device. */
516    tBTA_STATUS    status;
517} tBTA_DM_ENABLE;
518
519/* Structure associated with BTA_DM_PIN_REQ_EVT */
520typedef struct
521{
522    BD_ADDR         bd_addr;            /* BD address peer device. */
523    DEV_CLASS       dev_class;          /* Class of Device */
524    BD_NAME         bd_name;            /* Name of peer device. */
525} tBTA_DM_PIN_REQ;
526
527/* BLE related definition */
528
529#define BTA_DM_AUTH_FAIL_BASE                   (HCI_ERR_MAX_ERR + 10)
530#define BTA_DM_AUTH_CONVERT_SMP_CODE(x)        (BTA_DM_AUTH_FAIL_BASE + (x))
531#define BTA_DM_AUTH_SMP_PASSKEY_FAIL             BTA_DM_AUTH_CONVERT_SMP_CODE (SMP_PASSKEY_ENTRY_FAIL)
532#define BTA_DM_AUTH_SMP_OOB_FAIL                (BTA_DM_AUTH_FAIL_BASE + SMP_OOB_FAIL)
533#define BTA_DM_AUTH_SMP_PAIR_AUTH_FAIL          (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_AUTH_FAIL)
534#define BTA_DM_AUTH_SMP_CONFIRM_VALUE_FAIL      (BTA_DM_AUTH_FAIL_BASE + SMP_CONFIRM_VALUE_ERR)
535#define BTA_DM_AUTH_SMP_PAIR_NOT_SUPPORT        (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_NOT_SUPPORT)
536#define BTA_DM_AUTH_SMP_ENC_KEY_SIZE            (BTA_DM_AUTH_FAIL_BASE + SMP_ENC_KEY_SIZE)
537#define BTA_DM_AUTH_SMP_INVALID_CMD             (BTA_DM_AUTH_FAIL_BASE + SMP_INVALID_CMD)
538#define BTA_DM_AUTH_SMP_UNKNOWN_ERR             (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_FAIL_UNKNOWN)
539#define BTA_DM_AUTH_SMP_REPEATED_ATTEMPT        (BTA_DM_AUTH_FAIL_BASE + SMP_REPEATED_ATTEMPTS)
540#define BTA_DM_AUTH_SMP_INTERNAL_ERR            (BTA_DM_AUTH_FAIL_BASE + SMP_PAIR_INTERNAL_ERR)
541#define BTA_DM_AUTH_SMP_UNKNOWN_IO              (BTA_DM_AUTH_FAIL_BASE + SMP_UNKNOWN_IO_CAP)
542#define BTA_DM_AUTH_SMP_INIT_FAIL               (BTA_DM_AUTH_FAIL_BASE + SMP_INIT_FAIL)
543#define BTA_DM_AUTH_SMP_CONFIRM_FAIL            (BTA_DM_AUTH_FAIL_BASE + SMP_CONFIRM_FAIL)
544#define BTA_DM_AUTH_SMP_BUSY                    (BTA_DM_AUTH_FAIL_BASE + SMP_BUSY)
545#define BTA_DM_AUTH_SMP_ENC_FAIL                (BTA_DM_AUTH_FAIL_BASE + SMP_ENC_FAIL)
546#define BTA_DM_AUTH_SMP_RSP_TIMEOUT             (BTA_DM_AUTH_FAIL_BASE + SMP_RSP_TIMEOUT)
547
548/* connection parameter boundary value and dummy value */
549#define BTA_DM_BLE_SCAN_INT_MIN          BTM_BLE_SCAN_INT_MIN
550#define BTA_DM_BLE_SCAN_INT_MAX          BTM_BLE_SCAN_INT_MAX
551#define BTA_DM_BLE_SCAN_WIN_MIN          BTM_BLE_SCAN_WIN_MIN
552#define BTA_DM_BLE_SCAN_WIN_MAX          BTM_BLE_SCAN_WIN_MAX
553#define BTA_DM_BLE_CONN_INT_MIN          BTM_BLE_CONN_INT_MIN
554#define BTA_DM_BLE_CONN_INT_MAX          BTM_BLE_CONN_INT_MAX
555#define BTA_DM_BLE_CONN_LATENCY_MAX      BTM_BLE_CONN_LATENCY_MAX
556#define BTA_DM_BLE_CONN_SUP_TOUT_MIN     BTM_BLE_CONN_SUP_TOUT_MIN
557#define BTA_DM_BLE_CONN_SUP_TOUT_MAX     BTM_BLE_CONN_SUP_TOUT_MAX
558#define BTA_DM_BLE_CONN_PARAM_UNDEF      BTM_BLE_CONN_PARAM_UNDEF  /* use this value when a specific value not to be overwritten */
559
560
561#define BTA_LE_KEY_PENC      BTM_LE_KEY_PENC  /* encryption information of peer device */
562#define BTA_LE_KEY_PID       BTM_LE_KEY_PID   /* identity key of the peer device */
563#define BTA_LE_KEY_PCSRK     BTM_LE_KEY_PCSRK   /* peer SRK */
564#define BTA_LE_KEY_LENC      BTM_LE_KEY_LENC        /* master role security information:div */
565#define BTA_LE_KEY_LID       BTM_LE_KEY_LID         /* master device ID key */
566#define BTA_LE_KEY_LCSRK     BTM_LE_KEY_LCSRK        /* local CSRK has been deliver to peer */
567typedef UINT8 tBTA_LE_KEY_TYPE; /* can be used as a bit mask */
568
569
570typedef tBTM_LE_PENC_KEYS  tBTA_LE_PENC_KEYS ;
571typedef tBTM_LE_PCSRK_KEYS tBTA_LE_PCSRK_KEYS;
572typedef tBTM_LE_LENC_KEYS  tBTA_LE_LENC_KEYS  ;
573typedef tBTM_LE_LCSRK_KEYS tBTA_LE_LCSRK_KEYS ;
574typedef tBTM_LE_PID_KEYS   tBTA_LE_PID_KEYS ;
575
576typedef union
577{
578    tBTA_LE_PENC_KEYS   penc_key;       /* received peer encryption key */
579    tBTA_LE_PCSRK_KEYS  psrk_key;       /* received peer device SRK */
580    tBTA_LE_PID_KEYS    pid_key;        /* peer device ID key */
581    tBTA_LE_LENC_KEYS   lenc_key;       /* local encryption reproduction keys LTK = = d1(ER,DIV,0)*/
582    tBTA_LE_LCSRK_KEYS  lcsrk_key;      /* local device CSRK = d1(ER,DIV,1)*/
583}tBTA_LE_KEY_VALUE;
584
585#define BTA_BLE_LOCAL_KEY_TYPE_ID         1
586#define BTA_BLE_LOCAL_KEY_TYPE_ER         2
587typedef UINT8 tBTA_DM_BLE_LOCAL_KEY_MASK;
588
589typedef struct
590{
591    BT_OCTET16       ir;
592    BT_OCTET16       irk;
593    BT_OCTET16       dhk;
594}tBTA_BLE_LOCAL_ID_KEYS;
595
596#define BTA_DM_SEC_GRANTED              BTA_SUCCESS
597#define BTA_DM_SEC_PAIR_NOT_SPT         BTA_DM_AUTH_SMP_PAIR_NOT_SUPPORT
598#define BTA_DM_SEC_REP_ATTEMPTS         BTA_DM_AUTH_SMP_REPEATED_ATTEMPT
599typedef UINT8 tBTA_DM_BLE_SEC_GRANT;
600
601
602#define BTA_DM_BLE_ONN_NONE             BTM_BLE_CONN_NONE
603#define BTA_DM_BLE_CONN_AUTO            BTM_BLE_CONN_AUTO
604#define BTA_DM_BLE_CONN_SELECTIVE       BTM_BLE_CONN_SELECTIVE
605typedef UINT8 tBTA_DM_BLE_CONN_TYPE;
606
607typedef BOOLEAN (tBTA_DM_BLE_SEL_CBACK)(BD_ADDR random_bda, UINT8 *p_remote_name);
608
609/* Structure associated with BTA_DM_BLE_SEC_REQ_EVT */
610typedef struct
611{
612    BD_ADDR         bd_addr;        /* peer address */
613    BD_NAME         bd_name;        /* peer device name */
614} tBTA_DM_BLE_SEC_REQ;
615
616typedef struct
617{
618    BD_ADDR                 bd_addr;        /* peer address */
619    tBTM_LE_KEY_TYPE        key_type;
620    tBTM_LE_KEY_VALUE       key_value;
621}tBTA_DM_BLE_KEY;
622
623/* Structure associated with BTA_DM_AUTH_CMPL_EVT */
624typedef struct
625{
626    BD_ADDR         bd_addr;            /* BD address peer device. */
627    BD_NAME         bd_name;            /* Name of peer device. */
628    BOOLEAN         key_present;        /* Valid link key value in key element */
629    LINK_KEY        key;                /* Link key associated with peer device. */
630    UINT8           key_type;           /* The type of Link Key */
631    BOOLEAN         success;            /* TRUE of authentication succeeded, FALSE if failed. */
632#if BLE_INCLUDED == TRUE
633    BOOLEAN         privacy_enabled;    /* used for BLE device only */
634#endif
635    UINT8           fail_reason;        /* The HCI reason/error code for when success=FALSE */
636
637} tBTA_DM_AUTH_CMPL;
638
639
640/* Structure associated with BTA_DM_AUTHORIZE_EVT */
641typedef struct
642{
643    BD_ADDR         bd_addr;            /* BD address peer device. */
644    BD_NAME         bd_name;            /* Name of peer device. */
645    tBTA_SERVICE_ID service;            /* Service ID to authorize. */
646// btla-specific ++
647    DEV_CLASS      dev_class;
648// btla-specific --
649} tBTA_DM_AUTHORIZE;
650
651/* Structure associated with BTA_DM_LINK_UP_EVT */
652typedef struct
653{
654    BD_ADDR         bd_addr;            /* BD address peer device. */
655} tBTA_DM_LINK_UP;
656
657/* Structure associated with BTA_DM_LINK_DOWN_EVT */
658typedef struct
659{
660    BD_ADDR         bd_addr;            /* BD address peer device. */
661    UINT8           status;             /* connection open/closed */
662    BOOLEAN         is_removed;         /* TRUE if device is removed when link is down */
663} tBTA_DM_LINK_DOWN;
664
665/* Structure associated with BTA_DM_ROLE_CHG_EVT */
666typedef struct
667{
668    BD_ADDR         bd_addr;            /* BD address peer device. */
669    UINT8           new_role;           /* the new connection role */
670} tBTA_DM_ROLE_CHG;
671
672/* Structure associated with BTA_DM_SIG_STRENGTH_EVT */
673typedef struct
674{
675    BD_ADDR         bd_addr;            /* BD address peer device. */
676    tBTA_SIG_STRENGTH_MASK mask;        /* mask for the values that are valid */
677    tBTA_DM_RSSI_VALUE  rssi_value;
678    tBTA_DM_LINK_QUALITY_VALUE link_quality_value;
679
680} tBTA_DM_SIG_STRENGTH;
681
682/* Structure associated with BTA_DM_BUSY_LEVEL_EVT */
683typedef struct
684{
685    UINT8           level;     /* when paging or inquiring, level is 10.
686                                    Otherwise, the number of ACL links */
687    UINT8           level_flags; /* indicates individual flags */
688} tBTA_DM_BUSY_LEVEL;
689
690#define BTA_IO_CAP_OUT      BTM_IO_CAP_OUT      /* DisplayOnly */
691#define BTA_IO_CAP_IO       BTM_IO_CAP_IO       /* DisplayYesNo */
692#define BTA_IO_CAP_IN       BTM_IO_CAP_IN       /* KeyboardOnly */
693#define BTA_IO_CAP_NONE     BTM_IO_CAP_NONE     /* NoInputNoOutput */
694typedef tBTM_IO_CAP     tBTA_IO_CAP;
695
696#define BTA_AUTH_SP_NO    BTM_AUTH_SP_NO      /* 0 MITM Protection Not Required - Single Profile/non-bonding
697                                                Numeric comparison with automatic accept allowed */
698#define BTA_AUTH_SP_YES   BTM_AUTH_SP_YES     /* 1 MITM Protection Required - Single Profile/non-bonding
699                                                Use IO Capabilities to determine authentication procedure */
700#define BTA_AUTH_AP_NO    BTM_AUTH_AP_NO      /* 2 MITM Protection Not Required - All Profiles/dedicated bonding
701                                                Numeric comparison with automatic accept allowed */
702#define BTA_AUTH_AP_YES   BTM_AUTH_AP_YES     /* 3 MITM Protection Required - All Profiles/dedicated bonding
703                                                Use IO Capabilities to determine authentication procedure */
704#define BTA_AUTH_SPGB_NO  BTM_AUTH_SPGB_NO    /* 4 MITM Protection Not Required - Single Profiles/general bonding
705                                                Numeric comparison with automatic accept allowed */
706#define BTA_AUTH_SPGB_YES BTM_AUTH_SPGB_YES   /* 5 MITM Protection Required - Single Profiles/general bonding
707                                                Use IO Capabilities to determine authentication procedure */
708typedef tBTM_AUTH_REQ   tBTA_AUTH_REQ;
709
710#define BTA_AUTH_DD_BOND    BTM_AUTH_DD_BOND  /* 2 this bit is set for dedicated bonding */
711#define BTA_AUTH_GEN_BOND   BTM_AUTH_SPGB_NO  /* 4 this bit is set for general bonding */
712#define BTA_AUTH_BONDS      BTM_AUTH_BONDS    /* 6 the general/dedicated bonding bits  */
713
714#define BTA_LE_AUTH_NO_BOND    BTM_LE_AUTH_REQ_NO_BOND  /* 0*/
715#define BTA_LE_AUTH_BOND       BTM_LE_AUTH_REQ_BOND     /* 1 << 0 */
716#define BTA_LE_AUTH_REQ_MITM   BTM_LE_AUTH_REQ_MITM    /* 1 << 2 */
717typedef tBTM_LE_AUTH_REQ       tBTA_LE_AUTH_REQ;       /* combination of the above bit pattern */
718
719#define BTA_OOB_NONE        BTM_OOB_NONE
720#define BTA_OOB_PRESENT     BTM_OOB_PRESENT
721#if BTM_OOB_INCLUDED == TRUE
722#define BTA_OOB_UNKNOWN     BTM_OOB_UNKNOWN
723#endif
724typedef tBTM_OOB_DATA   tBTA_OOB_DATA;
725
726/* Structure associated with BTA_DM_SP_CFM_REQ_EVT */
727typedef struct
728{
729    /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
730    BD_ADDR         bd_addr;        /* peer address */
731    DEV_CLASS       dev_class;      /* peer CoD */
732    BD_NAME         bd_name;        /* peer device name */
733    UINT32          num_val;        /* the numeric value for comparison. If just_works, do not show this number to UI */
734    BOOLEAN         just_works;     /* TRUE, if "Just Works" association model */
735    tBTA_AUTH_REQ   loc_auth_req;   /* Authentication required for local device */
736    tBTA_AUTH_REQ   rmt_auth_req;   /* Authentication required for peer device */
737    tBTA_IO_CAP     loc_io_caps;    /* IO Capabilities of local device */
738    tBTA_AUTH_REQ   rmt_io_caps;    /* IO Capabilities of remote device */
739} tBTA_DM_SP_CFM_REQ;
740
741enum
742{
743    BTA_SP_KEY_STARTED,         /* passkey entry started */
744    BTA_SP_KEY_ENTERED,         /* passkey digit entered */
745    BTA_SP_KEY_ERASED,          /* passkey digit erased */
746    BTA_SP_KEY_CLEARED,         /* passkey cleared */
747    BTA_SP_KEY_COMPLT           /* passkey entry completed */
748};
749typedef UINT8   tBTA_SP_KEY_TYPE;
750
751/* Structure associated with BTA_DM_SP_KEYPRESS_EVT */
752typedef struct
753{
754    BD_ADDR             bd_addr;        /* peer address */
755    tBTA_SP_KEY_TYPE   notif_type;
756}tBTA_DM_SP_KEY_PRESS;
757
758/* Structure associated with BTA_DM_SP_KEY_NOTIF_EVT */
759typedef struct
760{
761    /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
762    BD_ADDR         bd_addr;        /* peer address */
763    DEV_CLASS       dev_class;      /* peer CoD */
764    BD_NAME         bd_name;        /* peer device name */
765    UINT32          passkey;        /* the numeric value for comparison. If just_works, do not show this number to UI */
766} tBTA_DM_SP_KEY_NOTIF;
767
768/* Structure associated with BTA_DM_SP_RMT_OOB_EVT */
769typedef struct
770{
771    /* Note: First 3 data members must be, bd_addr, dev_class, and bd_name in order */
772    BD_ADDR         bd_addr;        /* peer address */
773    DEV_CLASS       dev_class;      /* peer CoD */
774    BD_NAME         bd_name;        /* peer device name */
775} tBTA_DM_SP_RMT_OOB;
776
777/* Structure associated with BTA_DM_BOND_CANCEL_CMPL_EVT */
778typedef struct
779{
780    tBTA_STATUS     result;    /* TRUE of bond cancel succeeded, FALSE if failed. */
781} tBTA_DM_BOND_CANCEL_CMPL;
782
783/* Union of all security callback structures */
784typedef union
785{
786    tBTA_DM_ENABLE      enable;         /* BTA enabled */
787    tBTA_DM_PIN_REQ     pin_req;        /* PIN request. */
788    tBTA_DM_AUTH_CMPL   auth_cmpl;      /* Authentication complete indication. */
789    tBTA_DM_AUTHORIZE   authorize;      /* Authorization request. */
790    tBTA_DM_LINK_UP     link_up;       /* ACL connection down event */
791    tBTA_DM_LINK_DOWN   link_down;       /* ACL connection down event */
792    tBTA_DM_SIG_STRENGTH sig_strength;  /* rssi and link quality value */
793    tBTA_DM_BUSY_LEVEL  busy_level;     /* System busy level */
794    tBTA_DM_SP_CFM_REQ  cfm_req;        /* user confirm request */
795    tBTA_DM_SP_KEY_NOTIF key_notif;     /* passkey notification */
796    tBTA_DM_SP_RMT_OOB  rmt_oob;        /* remote oob */
797    tBTA_DM_BOND_CANCEL_CMPL bond_cancel_cmpl; /* Bond Cancel Complete indication */
798    tBTA_DM_SP_KEY_PRESS   key_press;   /* key press notification event */
799    tBTA_DM_ROLE_CHG     role_chg;       /* role change event */
800    tBTA_DM_BLE_SEC_REQ  ble_req;        /* BLE SMP related request */
801    tBTA_DM_BLE_KEY      ble_key;        /* BLE SMP keys used when pairing */
802    tBTA_BLE_LOCAL_ID_KEYS  ble_id_keys;  /* IR event */
803    BT_OCTET16              ble_er;       /* ER event data */
804} tBTA_DM_SEC;
805
806/* Security callback */
807typedef void (tBTA_DM_SEC_CBACK)(tBTA_DM_SEC_EVT event, tBTA_DM_SEC *p_data);
808
809/* Vendor Specific Command Callback */
810typedef tBTM_VSC_CMPL_CB        tBTA_VENDOR_CMPL_CBACK;
811
812/* Search callback events */
813#define BTA_DM_INQ_RES_EVT              0       /* Inquiry result for a peer device. */
814#define BTA_DM_INQ_CMPL_EVT             1       /* Inquiry complete. */
815#define BTA_DM_DISC_RES_EVT             2       /* Discovery result for a peer device. */
816#define BTA_DM_DISC_BLE_RES_EVT         3       /* Discovery result for BLE GATT based servoce on a peer device. */
817#define BTA_DM_DISC_CMPL_EVT            4       /* Discovery complete. */
818#define BTA_DM_DI_DISC_CMPL_EVT         5       /* Discovery complete. */
819#define BTA_DM_SEARCH_CANCEL_CMPL_EVT   6       /* Search cancelled */
820
821typedef UINT8 tBTA_DM_SEARCH_EVT;
822
823#define BTA_DM_INQ_RES_IGNORE_RSSI      BTM_INQ_RES_IGNORE_RSSI /* 0x7f RSSI value not supplied (ignore it) */
824
825/* Structure associated with BTA_DM_INQ_RES_EVT */
826typedef struct
827{
828    BD_ADDR         bd_addr;                /* BD address peer device. */
829    DEV_CLASS       dev_class;              /* Device class of peer device. */
830    BOOLEAN         remt_name_not_required; /* Application sets this flag if it already knows the name of the device */
831                                            /* If the device name is known to application BTA skips the remote name request */
832    BOOLEAN         is_limited;             /* TRUE, if the limited inquiry bit is set in the CoD */
833    INT8            rssi;                   /* The rssi value */
834    UINT8           *p_eir;                 /* received EIR */
835#if (BLE_INCLUDED == TRUE)
836    UINT8               inq_result_type;
837    UINT8               ble_addr_type;
838    tBTM_BLE_EVT_TYPE   ble_evt_type;
839    tBT_DEVICE_TYPE     device_type;
840#endif
841
842} tBTA_DM_INQ_RES;
843
844/* Structure associated with BTA_DM_INQ_CMPL_EVT */
845typedef struct
846{
847    UINT8           num_resps;          /* Number of inquiry responses. */
848} tBTA_DM_INQ_CMPL;
849
850/* Structure associated with BTA_DM_DI_DISC_CMPL_EVT */
851typedef struct
852{
853    BD_ADDR             bd_addr;        /* BD address peer device. */
854    UINT8               num_record;     /* Number of DI record */
855    tBTA_STATUS         result;
856} tBTA_DM_DI_DISC_CMPL;
857
858/* Structure associated with BTA_DM_DISC_RES_EVT */
859typedef struct
860{
861    BD_ADDR             bd_addr;        /* BD address peer device. */
862    BD_NAME             bd_name;        /* Name of peer device. */
863    tBTA_SERVICE_MASK   services;       /* Services found on peer device. */
864// btla-specific ++
865    UINT8           *   p_raw_data;     /* Raw data for discovery DB */
866    UINT32              raw_data_size;  /* size of raw data */
867    tBT_DEVICE_TYPE     device_type;    /* device type in case it is BLE device */
868    UINT32              num_uuids;
869    UINT8               *p_uuid_list;
870// btla-specific --
871    tBTA_STATUS         result;
872} tBTA_DM_DISC_RES;
873
874/* Structure associated with tBTA_DM_DISC_BLE_RES */
875typedef struct
876{
877    BD_ADDR             bd_addr;        /* BD address peer device. */
878    BD_NAME             bd_name;        /* Name of peer device. */
879    tBT_UUID            service;        /* GATT based Services UUID found on peer device. */
880} tBTA_DM_DISC_BLE_RES;
881
882
883/* Union of all search callback structures */
884typedef union
885{
886    tBTA_DM_INQ_RES     inq_res;        /* Inquiry result for a peer device. */
887    tBTA_DM_INQ_CMPL    inq_cmpl;       /* Inquiry complete. */
888    tBTA_DM_DISC_RES    disc_res;       /* Discovery result for a peer device. */
889    tBTA_DM_DISC_BLE_RES    disc_ble_res;   /* discovery result for GATT based service */
890    tBTA_DM_DI_DISC_CMPL    di_disc;        /* DI discovery result for a peer device */
891
892} tBTA_DM_SEARCH;
893
894/* Search callback */
895typedef void (tBTA_DM_SEARCH_CBACK)(tBTA_DM_SEARCH_EVT event, tBTA_DM_SEARCH *p_data);
896
897/* Execute call back */
898typedef void (tBTA_DM_EXEC_CBACK) (void * p_param);
899
900/* Encryption callback*/
901typedef void (tBTA_DM_ENCRYPT_CBACK) (BD_ADDR bd_addr, tBTA_STATUS result);
902
903#if BLE_INCLUDED == TRUE
904#define BTA_DM_BLE_SEC_NONE         BTM_BLE_SEC_NONE
905#define BTA_DM_BLE_SEC_ENCRYPT      BTM_BLE_SEC_ENCRYPT
906#define BTA_DM_BLE_SEC_NO_MITM      BTM_BLE_SEC_ENCRYPT_NO_MITM
907#define BTA_DM_BLE_SEC_MITM         BTM_BLE_SEC_ENCRYPT_MITM
908typedef tBTM_BLE_SEC_ACT            tBTA_DM_BLE_SEC_ACT;
909#else
910typedef UINT8                       tBTA_DM_BLE_SEC_ACT;
911#endif
912
913/* Maximum service name length */
914#define BTA_SERVICE_NAME_LEN    35
915#define BTA_SERVICE_DESP_LEN    BTA_SERVICE_NAME_LEN
916#define BTA_PROVIDER_NAME_LEN   BTA_SERVICE_NAME_LEN
917
918
919/* link policy masks  */
920#define BTA_DM_LP_SWITCH        HCI_ENABLE_MASTER_SLAVE_SWITCH
921#define BTA_DM_LP_HOLD          HCI_ENABLE_HOLD_MODE
922#define BTA_DM_LP_SNIFF         HCI_ENABLE_SNIFF_MODE
923#define BTA_DM_LP_PARK          HCI_ENABLE_PARK_MODE
924typedef UINT16 tBTA_DM_LP_MASK;
925
926/* power mode actions  */
927#define BTA_DM_PM_NO_ACTION    0x00       /* no change to the current pm setting */
928#define BTA_DM_PM_PARK         0x10       /* prefers park mode */
929#define BTA_DM_PM_SNIFF        0x20       /* prefers sniff mode */
930#define BTA_DM_PM_SNIFF1       0x21       /* prefers sniff1 mode */
931#define BTA_DM_PM_SNIFF2       0x22       /* prefers sniff2 mode */
932#define BTA_DM_PM_SNIFF3       0x23       /* prefers sniff3 mode */
933#define BTA_DM_PM_SNIFF4       0x24       /* prefers sniff4 mode */
934#define BTA_DM_PM_SNIFF5       0x25       /* prefers sniff5 mode */
935#define BTA_DM_PM_SNIFF6       0x26       /* prefers sniff6 mode */
936#define BTA_DM_PM_SNIFF7       0x27       /* prefers sniff7 mode */
937#define BTA_DM_PM_SNIFF_USER0  0x28       /* prefers user-defined sniff0 mode (testtool only) */
938#define BTA_DM_PM_SNIFF_USER1  0x29       /* prefers user-defined sniff1 mode (testtool only) */
939#define BTA_DM_PM_ACTIVE       0x40       /* prefers active mode */
940#define BTA_DM_PM_RETRY        0x80       /* retry power mode based on current settings */
941#define BTA_DM_PM_NO_PREF      0x01       /* service has no prefernce on power mode setting. eg. connection to service got closed */
942
943typedef UINT8 tBTA_DM_PM_ACTTION;
944
945/* index to bta_dm_ssr_spec */
946#define BTA_DM_PM_SSR0          0
947#define BTA_DM_PM_SSR1          1       /* BTA_DM_PM_SSR1 will be dedicated for
948                                        HH SSR setting entry, no other profile can use it */
949#define BTA_DM_PM_SSR2          2
950#define BTA_DM_PM_SSR3          3
951#define BTA_DM_PM_SSR4          4
952#define BTA_DM_PM_SSR5          5
953#define BTA_DM_PM_SSR6          6
954
955#define BTA_DM_PM_NUM_EVTS      9
956
957#ifndef BTA_DM_PM_PARK_IDX
958#define BTA_DM_PM_PARK_IDX      5 /* the actual index to bta_dm_pm_md[] for PARK mode */
959#endif
960
961#define BTA_DM_SW_BB_TO_MM      BTM_SW_BB_TO_MM
962#define BTA_DM_SW_MM_TO_BB      BTM_SW_MM_TO_BB
963#define BTA_DM_SW_BB_TO_BTC     BTM_SW_BB_TO_BTC
964#define BTA_DM_SW_BTC_TO_BB     BTM_SW_BTC_TO_BB
965
966typedef tBTM_SW_DIR tBTA_DM_SW_DIR;
967
968/* Switch callback events */
969#define BTA_DM_SWITCH_CMPL_EVT      0       /* Completion of the Switch API */
970
971typedef UINT8 tBTA_DM_SWITCH_EVT;
972typedef void (tBTA_DM_SWITCH_CBACK)(tBTA_DM_SWITCH_EVT event, tBTA_STATUS status);
973
974/* Audio routing out configuration */
975#define BTA_DM_ROUTE_NONE       0x00    /* No Audio output */
976#define BTA_DM_ROUTE_DAC        0x01    /* routing over analog output */
977#define BTA_DM_ROUTE_I2S        0x02    /* routing over digital (I2S) output */
978#define BTA_DM_ROUTE_BT_MONO    0x04    /* routing over SCO */
979#define BTA_DM_ROUTE_BT_STEREO  0x08    /* routing over BT Stereo */
980#define BTA_DM_ROUTE_HOST       0x10    /* routing over Host */
981#define BTA_DM_ROUTE_FMTX       0x20    /* routing over FMTX */
982#define BTA_DM_ROUTE_FMRX       0x40    /* routing over FMRX */
983#define BTA_DM_ROUTE_BTSNK      0x80    /* routing over BT SNK */
984
985typedef UINT8 tBTA_DM_ROUTE_PATH;
986
987
988/* Device Identification (DI) data structure
989*/
990/* Used to set the DI record */
991typedef tSDP_DI_RECORD          tBTA_DI_RECORD;
992/* Used to get the DI record */
993typedef tSDP_DI_GET_RECORD      tBTA_DI_GET_RECORD;
994/* SDP discovery database */
995typedef tSDP_DISCOVERY_DB       tBTA_DISCOVERY_DB;
996
997#ifndef         BTA_DI_NUM_MAX
998#define         BTA_DI_NUM_MAX       3
999#endif
1000
1001/* Device features mask definitions */
1002#define BTA_FEATURE_BYTES_PER_PAGE  BTM_FEATURE_BYTES_PER_PAGE
1003#define BTA_EXT_FEATURES_PAGE_MAX   BTM_EXT_FEATURES_PAGE_MAX
1004
1005/*****************************************************************************
1006**  External Function Declarations
1007*****************************************************************************/
1008#ifdef __cplusplus
1009extern "C"
1010{
1011#endif
1012
1013/*******************************************************************************
1014**
1015** Function         BTA_EnableBluetooth
1016**
1017** Description      This function initializes BTA and prepares BTA and the
1018**                  Bluetooth protocol stack for use.  This function is
1019**                  typically called at startup or when Bluetooth services
1020**                  are required by the phone.  This function must be called
1021**                  before calling any other API function.
1022**
1023**
1024** Returns          BTA_SUCCESS if successful.
1025**                  BTA_FAIL if internal failure.
1026**
1027*******************************************************************************/
1028BTA_API extern tBTA_STATUS BTA_EnableBluetooth(tBTA_DM_SEC_CBACK *p_cback);
1029
1030/*******************************************************************************
1031**
1032** Function         BTA_DisableBluetooth
1033**
1034** Description      This function disables BTA and the Bluetooth protocol
1035**                  stack.  It is called when BTA is no longer being used
1036**                  by any application in the system.
1037**
1038**
1039** Returns          void
1040**
1041*******************************************************************************/
1042BTA_API extern tBTA_STATUS BTA_DisableBluetooth(void);
1043
1044/*******************************************************************************
1045**
1046** Function         BTA_EnableTestMode
1047**
1048** Description      Enables bluetooth device under test mode
1049**
1050**
1051** Returns          tBTA_STATUS
1052**
1053*******************************************************************************/
1054BTA_API extern tBTA_STATUS BTA_EnableTestMode(void);
1055
1056/*******************************************************************************
1057**
1058** Function         BTA_DisableTestMode
1059**
1060** Description      Disable bluetooth device under test mode
1061**
1062**
1063** Returns          None
1064**
1065*******************************************************************************/
1066BTA_API extern void BTA_DisableTestMode(void);
1067
1068/*******************************************************************************
1069**
1070** Function         BTA_DmIsDeviceUp
1071**
1072** Description      This function tests whether the Bluetooth module is up
1073**                  and ready.  This is a direct execution function that
1074**                  may lock task scheduling on some platforms.
1075**
1076**
1077** Returns          TRUE if the module is ready.
1078**                  FALSE if the module is not ready.
1079**
1080*******************************************************************************/
1081BTA_API extern BOOLEAN BTA_DmIsDeviceUp(void);
1082
1083/*******************************************************************************
1084**
1085** Function         BTA_DmSetDeviceName
1086**
1087** Description      This function sets the Bluetooth name of the local device.
1088**
1089**
1090** Returns          void
1091**
1092*******************************************************************************/
1093BTA_API extern void BTA_DmSetDeviceName(char *p_name);
1094
1095/*******************************************************************************
1096**
1097** Function         BTA_DmSetVisibility
1098**
1099** Description      This function sets the Bluetooth connectable,discoverable,
1100**                  pairable and conn paired only modesmodes of the local device.
1101**                  This controls whether other Bluetooth devices can find and connect to
1102**                  the local device.
1103**
1104**
1105** Returns          void
1106**
1107*******************************************************************************/
1108BTA_API extern void BTA_DmSetVisibility(tBTA_DM_DISC disc_mode, tBTA_DM_CONN conn_mode, UINT8 pairable_mode, UINT8 conn_filter);
1109
1110/*******************************************************************************
1111**
1112** Function         BTA_DmSetScanParam
1113**
1114** Description      This function sets the parameters for page scan and
1115**                  inquiry scan.
1116**
1117**
1118** Returns          void
1119**
1120*******************************************************************************/
1121BTA_API extern void BTA_DmSetScanParam (UINT16 page_scan_interval, UINT16 page_scan_window,
1122                                  UINT16 inquiry_scan_interval, UINT16 inquiry_scan_window);
1123
1124/*******************************************************************************
1125**
1126** Function         BTA_DmSetAfhChannels
1127**
1128** Description      This function sets the AFH first and
1129**                  last disable channel, so channels within
1130**                  that range are disabled.
1131**                  In order to use this API, BTM_BYPASS_AMP_AUTO_AFH must be set
1132**                  to be TRUE
1133**
1134** Returns          void
1135**
1136*******************************************************************************/
1137BTA_API extern void BTA_DmSetAfhChannels(UINT8 first, UINT8 last);
1138
1139
1140/*******************************************************************************
1141**
1142** Function         BTA_DmVendorSpecificCommand
1143**
1144** Description      This function sends the vendor specific command
1145**                  to the controller
1146**
1147**
1148** Returns          tBTA_STATUS
1149**
1150*******************************************************************************/
1151BTA_API extern tBTA_STATUS BTA_DmVendorSpecificCommand (UINT16 opcode, UINT8 param_len,UINT8 *p_param_buf, tBTA_VENDOR_CMPL_CBACK *p_cback);
1152
1153
1154/*******************************************************************************
1155**
1156** Function         BTA_DmSearch
1157**
1158** Description      This function searches for peer Bluetooth devices.  It
1159**                  first performs an inquiry; for each device found from the
1160**                  inquiry it gets the remote name of the device.  If
1161**                  parameter services is nonzero, service discovery will be
1162**                  performed on each device for the services specified.
1163**
1164**
1165** Returns          void
1166**
1167*******************************************************************************/
1168BTA_API extern void BTA_DmSearch(tBTA_DM_INQ *p_dm_inq, tBTA_SERVICE_MASK services,
1169                                 tBTA_DM_SEARCH_CBACK *p_cback);
1170
1171/*******************************************************************************
1172**
1173** Function         BTA_DmSearchCancel
1174**
1175** Description      This function cancels a search that has been initiated
1176**                  by calling BTA_DmSearch().
1177**
1178**
1179** Returns          void
1180**
1181*******************************************************************************/
1182BTA_API extern void BTA_DmSearchCancel(void);
1183
1184/*******************************************************************************
1185**
1186** Function         BTA_DmDiscover
1187**
1188** Description      This function performs service discovery for the services
1189**                  of a particular peer device.
1190**
1191**
1192** Returns          void
1193**
1194*******************************************************************************/
1195BTA_API extern void BTA_DmDiscover(BD_ADDR bd_addr, tBTA_SERVICE_MASK services,
1196                                   tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search);
1197
1198// btla-specific ++
1199/*******************************************************************************
1200**
1201** Function         BTA_DmDiscoverUUID
1202**
1203** Description      This function performs service discovery for the services
1204**                  of a particular peer device.
1205**
1206**
1207** Returns          void
1208**
1209*******************************************************************************/
1210BTA_API extern void BTA_DmDiscoverUUID(BD_ADDR bd_addr, tSDP_UUID *uuid,
1211                    tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search);
1212
1213/*******************************************************************************
1214**
1215** Function         BTA_DmGetCachedRemoteName
1216**
1217** Description      Retieve cached remote name if available
1218**
1219** Returns          BTA_SUCCESS if cached name was retrieved
1220**                  BTA_FAILURE if cached name is not available
1221**
1222*******************************************************************************/
1223tBTA_STATUS BTA_DmGetCachedRemoteName(BD_ADDR remote_device, UINT8 **pp_cached_name);
1224// btla-specific --
1225
1226/*******************************************************************************
1227**
1228** Function         BTA_DmIsMaster
1229**
1230** Description      This function checks if the local device is the master of
1231**                  the link to the given device
1232**
1233** Returns          TRUE if master.
1234**                  FALSE if not.
1235**
1236*******************************************************************************/
1237BTA_API extern BOOLEAN BTA_DmIsMaster(BD_ADDR bd_addr);
1238
1239/*******************************************************************************
1240**
1241** Function         BTA_DmBond
1242**
1243** Description      This function initiates a bonding procedure with a peer
1244**                  device.  The bonding procedure enables authentication
1245**                  and optionally encryption on the Bluetooth link.
1246**
1247**
1248** Returns          void
1249**
1250*******************************************************************************/
1251BTA_API extern void BTA_DmBond(BD_ADDR bd_addr);
1252
1253/*******************************************************************************
1254**
1255** Function         BTA_DmBondCancel
1256**
1257** Description      This function cancels a bonding procedure with a peer
1258**                  device.
1259**
1260**
1261** Returns          void
1262**
1263*******************************************************************************/
1264BTA_API extern void BTA_DmBondCancel(BD_ADDR bd_addr);
1265
1266/*******************************************************************************
1267**
1268** Function         BTA_DmPinReply
1269**
1270** Description      This function provides a PIN when one is requested by DM
1271**                  during a bonding procedure.  The application should call
1272**                  this function after the security callback is called with
1273**                  a BTA_DM_PIN_REQ_EVT.
1274**
1275**
1276** Returns          void
1277**
1278*******************************************************************************/
1279BTA_API extern void BTA_DmPinReply(BD_ADDR bd_addr, BOOLEAN accept, UINT8 pin_len,
1280                                   UINT8 *p_pin);
1281
1282/*******************************************************************************
1283**
1284** Function         BTA_DmLinkPolicy
1285**
1286** Description      This function sets/clears the link policy mask to the given
1287**                  bd_addr.
1288**                  If clearing the sniff or park mode mask, the link is put
1289**                  in active mode.
1290**
1291** Returns          void
1292**
1293*******************************************************************************/
1294BTA_API extern void BTA_DmLinkPolicy(BD_ADDR bd_addr, tBTA_DM_LP_MASK policy_mask,
1295                                     BOOLEAN set);
1296
1297#if (BTM_OOB_INCLUDED == TRUE)
1298/*******************************************************************************
1299**
1300** Function         BTA_DmLocalOob
1301**
1302** Description      This function retrieves the OOB data from local controller.
1303**                  The result is reported by bta_dm_co_loc_oob().
1304**
1305** Returns          void
1306**
1307*******************************************************************************/
1308BTA_API extern void BTA_DmLocalOob(void);
1309#endif /* BTM_OOB_INCLUDED */
1310
1311/*******************************************************************************
1312**
1313** Function         BTA_DmConfirm
1314**
1315** Description      This function accepts or rejects the numerical value of the
1316**                  Simple Pairing process on BTA_DM_SP_CFM_REQ_EVT
1317**
1318** Returns          void
1319**
1320*******************************************************************************/
1321BTA_API extern void BTA_DmConfirm(BD_ADDR bd_addr, BOOLEAN accept);
1322
1323/*******************************************************************************
1324**
1325** Function         BTA_DmPasskeyCancel
1326**
1327** Description      This function is called to cancel the simple pairing process
1328**                  reported by BTA_DM_SP_KEY_NOTIF_EVT
1329**
1330** Returns          void
1331**
1332*******************************************************************************/
1333BTA_API extern void BTA_DmPasskeyCancel(BD_ADDR bd_addr);
1334
1335/*******************************************************************************
1336**
1337** Function         BTA_DmAddDevice
1338**
1339** Description      This function adds a device to the security database list
1340**                  of peer devices. This function would typically be called
1341**                  at system startup to initialize the security database with
1342**                  known peer devices.  This is a direct execution function
1343**                  that may lock task scheduling on some platforms.
1344**
1345** Returns          void
1346**
1347*******************************************************************************/
1348BTA_API extern void BTA_DmAddDevice(BD_ADDR bd_addr, DEV_CLASS dev_class,
1349                                    LINK_KEY link_key, tBTA_SERVICE_MASK trusted_mask,
1350                                    BOOLEAN is_trusted, UINT8 key_type,
1351                                    tBTA_IO_CAP io_cap);
1352
1353/*******************************************************************************
1354**
1355** Function         BTA_DmAddDevWithName
1356**
1357** Description      This function is newer version of  BTA_DmAddDevice()
1358**                  which added bd_name and features as input parameters.
1359**
1360**
1361** Returns          void
1362**
1363** Note:            features points to the remote device features array.
1364**                  The array size is
1365**                  BTA_FEATURE_BYTES_PER_PAGE * (BTA_EXT_FEATURES_PAGE_MAX + 1)
1366**
1367*******************************************************************************/
1368BTA_API extern void BTA_DmAddDevWithName (BD_ADDR bd_addr, DEV_CLASS dev_class,
1369                                      BD_NAME bd_name, UINT8 *features,
1370                                      LINK_KEY link_key, tBTA_SERVICE_MASK trusted_mask,
1371                                      BOOLEAN is_trusted, UINT8 key_type, tBTA_IO_CAP io_cap);
1372
1373/*******************************************************************************
1374**
1375** Function         BTA_DmRemoveDevice
1376**
1377** Description      This function removes a device from the security database.
1378**                  This is a direct execution function that may lock task
1379**                  scheduling on some platforms.
1380**
1381**
1382** Returns          BTA_SUCCESS if successful.
1383**                  BTA_FAIL if operation failed.
1384**
1385*******************************************************************************/
1386BTA_API extern tBTA_STATUS BTA_DmRemoveDevice(BD_ADDR bd_addr);
1387
1388/*******************************************************************************
1389**
1390** Function         BTA_DmAuthorizeReply
1391**
1392** Description      This function provides an authorization reply when
1393**                  authorization is requested by BTA.  The application calls
1394**                  this function after the security callback is called with
1395**                  a BTA_DM_AUTHORIZE_EVT.
1396**
1397**
1398** Returns          void
1399**
1400*******************************************************************************/
1401BTA_API extern void BTA_DmAuthorizeReply(BD_ADDR bd_addr, tBTA_SERVICE_ID service,
1402                                         tBTA_AUTH_RESP response);
1403
1404/*******************************************************************************
1405**
1406** Function         BTA_DmSignalStrength
1407**
1408** Description      This function initiates RSSI and channnel quality
1409**                  measurments. BTA_DM_SIG_STRENGTH_EVT is sent to
1410**                  application with the values of RSSI and channel
1411**                  quality
1412**
1413**
1414** Returns          void
1415**
1416*******************************************************************************/
1417BTA_API extern void BTA_DmSignalStrength(tBTA_SIG_STRENGTH_MASK mask, UINT16 period, BOOLEAN start);
1418
1419/*******************************************************************************
1420**
1421** Function         BTA_DmWriteInqTxPower
1422**
1423** Description      This command is used to write the inquiry transmit power level
1424**                  used to transmit the inquiry (ID) data packets.
1425**
1426** Parameters       tx_power - tx inquiry power to use, valid value is -70 ~ 20
1427
1428** Returns          void
1429**
1430*******************************************************************************/
1431BTA_API extern void BTA_DmWriteInqTxPower(INT8 tx_power);
1432
1433/*******************************************************************************
1434**
1435** Function         BTA_DmEirAddUUID
1436**
1437** Description      This function is called to add UUID into EIR.
1438**
1439** Parameters       tBT_UUID - UUID
1440**
1441** Returns          None
1442**
1443*******************************************************************************/
1444BTA_API extern void BTA_DmEirAddUUID (tBT_UUID *p_uuid);
1445
1446/*******************************************************************************
1447**
1448** Function         BTA_DmEirRemoveUUID
1449**
1450** Description      This function is called to remove UUID from EIR.
1451**
1452** Parameters       tBT_UUID - UUID
1453**
1454** Returns          None
1455**
1456*******************************************************************************/
1457BTA_API extern void BTA_DmEirRemoveUUID (tBT_UUID *p_uuid);
1458
1459/*******************************************************************************
1460**
1461** Function         BTA_DmSetEIRConfig
1462**
1463** Description      This function is called to override the BTA default EIR parameters.
1464**                  This funciton is only valid in a system where BTU & App task
1465**                  are in the same memory space.
1466**
1467** Parameters       Pointer to User defined EIR config
1468**
1469** Returns          None
1470**
1471*******************************************************************************/
1472BTA_API extern void BTA_DmSetEIRConfig (tBTA_DM_EIR_CONF *p_eir_cfg);
1473
1474/*******************************************************************************
1475**
1476** Function         BTA_CheckEirData
1477**
1478** Description      This function is called to get EIR data from significant part.
1479**
1480** Parameters       p_eir - pointer of EIR significant part
1481**                  type   - finding EIR data type
1482**                  p_length - return the length of EIR data
1483**
1484** Returns          pointer of EIR data
1485**
1486*******************************************************************************/
1487BTA_API extern UINT8 *BTA_CheckEirData( UINT8 *p_eir, UINT8 tag, UINT8 *p_length );
1488
1489/*******************************************************************************
1490**
1491** Function         BTA_GetEirService
1492**
1493** Description      This function is called to get BTA service mask from EIR.
1494**
1495** Parameters       p_eir - pointer of EIR significant part
1496**                  p_services - return the BTA service mask
1497**
1498** Returns          None
1499**
1500*******************************************************************************/
1501BTA_API extern void BTA_GetEirService( UINT8 *p_eir, tBTA_SERVICE_MASK *p_services );
1502
1503/*******************************************************************************
1504**
1505** Function         BTA_DmUseSsr
1506**
1507** Description      This function is called to check if the connected peer device
1508**                  supports SSR or not.
1509**
1510** Returns          TRUE, if SSR is supported
1511**
1512*******************************************************************************/
1513BTA_API extern BOOLEAN BTA_DmUseSsr( BD_ADDR bd_addr );
1514
1515
1516/*******************************************************************************
1517**
1518** Function         BTA_DmSetLocalDiRecord
1519**
1520** Description      This function adds a DI record to the local SDP database.
1521**
1522** Returns          BTA_SUCCESS if record set sucessfully, otherwise error code.
1523**
1524*******************************************************************************/
1525BTA_API extern tBTA_STATUS BTA_DmSetLocalDiRecord( tBTA_DI_RECORD *p_device_info,
1526	                          UINT32 *p_handle );
1527
1528/*******************************************************************************
1529**
1530** Function         BTA_DmGetLocalDiRecord
1531**
1532** Description      Get a specified DI record to the local SDP database. If no
1533**                  record handle is provided, the primary DI record will be
1534**                  returned.
1535**
1536** Returns          BTA_SUCCESS if record set sucessfully, otherwise error code.
1537**
1538*******************************************************************************/
1539BTA_API extern tBTA_STATUS BTA_DmGetLocalDiRecord( tBTA_DI_GET_RECORD *p_device_info,
1540	                          UINT32 *p_handle );
1541
1542/*******************************************************************************
1543**
1544** Function         BTA_DmDiDiscover
1545**
1546** Description      This function queries a remote device for DI information.
1547**
1548** Returns          None.
1549**
1550*******************************************************************************/
1551BTA_API extern void BTA_DmDiDiscover( BD_ADDR remote_device, tBTA_DISCOVERY_DB *p_db,
1552                       UINT32 len, tBTA_DM_SEARCH_CBACK *p_cback );
1553
1554/*******************************************************************************
1555**
1556** Function         BTA_DmGetDiRecord
1557**
1558** Description      This function retrieves a remote device's DI record from
1559**                  the specified database.
1560**
1561** Returns          None.
1562**
1563*******************************************************************************/
1564BTA_API extern tBTA_STATUS BTA_DmGetDiRecord( UINT8 get_record_index, tBTA_DI_GET_RECORD *p_device_info,
1565                        tBTA_DISCOVERY_DB *p_db );
1566
1567/*******************************************************************************
1568**
1569**
1570** Function         BTA_DmCloseACL
1571**
1572** Description      This function force to close an ACL connection and remove the
1573**                  device from the security database list of known devices.
1574**
1575** Parameters:      bd_addr       - Address of the peer device
1576**                  remove_dev    - remove device or not after link down
1577**
1578** Returns          void.
1579**
1580*******************************************************************************/
1581BTA_API extern void BTA_DmCloseACL(BD_ADDR bd_addr, BOOLEAN remove_dev);
1582
1583/*******************************************************************************
1584**
1585** Function         BTA_SysFeatures
1586**
1587** Description      This function is called to set system features.
1588**
1589** Returns          void
1590**
1591*******************************************************************************/
1592BTA_API extern void BTA_SysFeatures (UINT16 sys_features);
1593
1594/*******************************************************************************
1595**
1596** Function         bta_dmexecutecallback
1597**
1598** Description      This function will request BTA to execute a call back in the context of BTU task
1599**                  This API was named in lower case because it is only intended
1600**                  for the internal customers(like BTIF).
1601**
1602** Returns          void
1603**
1604*******************************************************************************/
1605BTA_API extern void bta_dmexecutecallback (tBTA_DM_EXEC_CBACK* p_callback, void * p_param);
1606
1607#if (BTM_SCO_HCI_INCLUDED == TRUE)
1608/*******************************************************************************
1609**
1610** Function         BTA_DmPcmInitSamples
1611**
1612** Description      initialize the down sample converter.
1613**
1614**                  src_sps: original samples per second (source audio data)
1615**                            (ex. 44100, 48000)
1616**                  bits: number of bits per pcm sample (16)
1617**                  n_channels: number of channels (i.e. mono(1), stereo(2)...)
1618**
1619** Returns          none
1620**
1621*******************************************************************************/
1622BTA_API extern void BTA_DmPcmInitSamples (UINT32 src_sps, UINT32 bits, UINT32 n_channels);
1623
1624/**************************************************************************************
1625** Function         BTA_DmPcmResample
1626**
1627** Description      Down sampling utility to convert higher sampling rate into 8K/16bits
1628**                  PCM samples.
1629**
1630** Parameters       p_src: pointer to the buffer where the original sampling PCM
1631**                              are stored.
1632**                  in_bytes:  Length of the input PCM sample buffer in byte.
1633**                  p_dst:      pointer to the buffer which is to be used to store
1634**                              the converted PCM samples.
1635**
1636**
1637** Returns          INT32: number of samples converted.
1638**
1639**************************************************************************************/
1640BTA_API extern INT32 BTA_DmPcmResample (void *p_src, UINT32 in_bytes, void *p_dst);
1641#endif
1642
1643#if ((defined BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
1644/* BLE related API functions */
1645/*******************************************************************************
1646**
1647** Function         BTA_DmBleSecurityGrant
1648**
1649** Description      Grant security request access.
1650**
1651** Parameters:      bd_addr          - BD address of the peer
1652**                  res              - security grant status.
1653**
1654** Returns          void
1655**
1656*******************************************************************************/
1657BTA_API extern void BTA_DmBleSecurityGrant(BD_ADDR bd_addr, tBTA_DM_BLE_SEC_GRANT res);
1658
1659
1660
1661/*******************************************************************************
1662**
1663** Function         BTA_DmBleSetBgConnType
1664**
1665** Description      This function is called to set BLE connectable mode for a
1666**                  peripheral device.
1667**
1668** Parameters       bg_conn_type: it can be auto connection, or selective connection.
1669**                  p_select_cback: callback function when selective connection procedure
1670**                              is being used.
1671**
1672** Returns          void
1673**
1674*******************************************************************************/
1675BTA_API extern void BTA_DmBleSetBgConnType(tBTA_DM_BLE_CONN_TYPE bg_conn_type, tBTA_DM_BLE_SEL_CBACK *p_select_cback);
1676
1677/*******************************************************************************
1678**
1679** Function         BTA_DmBlePasskeyReply
1680**
1681** Description      Send BLE SMP passkey reply.
1682**
1683** Parameters:      bd_addr          - BD address of the peer
1684**                  accept           - passkey entry sucessful or declined.
1685**                  passkey          - passkey value, must be a 6 digit number,
1686**                                     can be lead by 0.
1687**
1688** Returns          void
1689**
1690*******************************************************************************/
1691BTA_API extern void BTA_DmBlePasskeyReply(BD_ADDR bd_addr, BOOLEAN accept, UINT32 passkey);
1692
1693/*******************************************************************************
1694**
1695** Function         BTA_DmAddBleDevice
1696**
1697** Description      Add a BLE device.  This function will be normally called
1698**                  during host startup to restore all required information
1699**                  for a LE device stored in the NVRAM.
1700**
1701** Parameters:      bd_addr          - BD address of the peer
1702**                  dev_type         - Remote device's device type.
1703**                  addr_type        - LE device address type.
1704**
1705** Returns          void
1706**
1707*******************************************************************************/
1708BTA_API extern void BTA_DmAddBleDevice(BD_ADDR bd_addr, tBLE_ADDR_TYPE addr_type,
1709                                       tBT_DEVICE_TYPE dev_type);
1710
1711
1712/*******************************************************************************
1713**
1714** Function         BTA_DmAddBleKey
1715**
1716** Description      Add/modify LE device information.  This function will be
1717**                  normally called during host startup to restore all required
1718**                  information stored in the NVRAM.
1719**
1720** Parameters:      bd_addr          - BD address of the peer
1721**                  p_le_key         - LE key values.
1722**                  key_type         - LE SMP key type.
1723**
1724** Returns          void
1725**
1726*******************************************************************************/
1727BTA_API extern void BTA_DmAddBleKey (BD_ADDR bd_addr, tBTA_LE_KEY_VALUE *p_le_key,
1728                                     tBTA_LE_KEY_TYPE key_type);
1729
1730/*******************************************************************************
1731**
1732** Function         BTA_DmSetBlePrefConnParams
1733**
1734** Description      This function is called to set the preferred connection
1735**                  parameters when default connection parameter is not desired.
1736**
1737** Parameters:      bd_addr          - BD address of the peripheral
1738**                  min_conn_int     - minimum preferred connection interval
1739**                  max_conn_int     - maximum preferred connection interval
1740**                  slave_latency    - preferred slave latency
1741**                  supervision_tout - preferred supervision timeout
1742**
1743**
1744** Returns          void
1745**
1746*******************************************************************************/
1747BTA_API extern void BTA_DmSetBlePrefConnParams(BD_ADDR bd_addr,
1748                               UINT16 min_conn_int, UINT16 max_conn_int,
1749                               UINT16 slave_latency, UINT16 supervision_tout );
1750
1751/*******************************************************************************
1752**
1753** Function         BTA_DmSetBleConnScanParams
1754**
1755** Description      This function is called to set scan parameters used in
1756**                  BLE connection request
1757**
1758** Parameters:      bd_addr          - BD address of the peripheral
1759**                  scan_interval    - scan interval
1760**                  scan_window      - scan window
1761**
1762** Returns          void
1763**
1764*******************************************************************************/
1765BTA_API extern void BTA_DmSetBleConnScanParams(UINT16 scan_interval,
1766                                               UINT16 scan_window );
1767
1768/*******************************************************************************
1769**
1770** Function         BTA_DmSearchExt
1771**
1772** Description      This function searches for peer Bluetooth devices. It performs
1773**                  an inquiry and gets the remote name for devices. Service
1774**                  discovery is done if services is non zero
1775**
1776** Parameters       p_dm_inq: inquiry conditions
1777**                  services: if service is not empty, service discovery will be done.
1778**                            for all GATT based service condition, put num_uuid, and
1779**                            p_uuid is the pointer to the list of UUID values.
1780**                  p_cback: callback functino when search is completed.
1781**
1782**
1783**
1784** Returns          void
1785**
1786*******************************************************************************/
1787BTA_API extern void BTA_DmSearchExt(tBTA_DM_INQ *p_dm_inq, tBTA_SERVICE_MASK_EXT *p_services,
1788                                    tBTA_DM_SEARCH_CBACK *p_cback);
1789
1790/*******************************************************************************
1791**
1792** Function         BTA_DmDiscoverExt
1793**
1794** Description      This function does service discovery for services of a
1795**                  peer device. When services.num_uuid is 0, it indicates all
1796**                  GATT based services are to be searched; other wise a list of
1797**                  UUID of interested services should be provided through
1798**                  services.p_uuid.
1799**
1800**
1801**
1802** Returns          void
1803**
1804*******************************************************************************/
1805BTA_API extern void BTA_DmDiscoverExt(BD_ADDR bd_addr, tBTA_SERVICE_MASK_EXT *p_services,
1806                                    tBTA_DM_SEARCH_CBACK *p_cback, BOOLEAN sdp_search);
1807
1808
1809/*******************************************************************************
1810**
1811** Function         BTA_DmSetEncryption
1812**
1813** Description      This function is called to ensure that connection is
1814**                  encrypted.  Should be called only on an open connection.
1815**                  Typically only needed for connections that first want to
1816**                  bring up unencrypted links, then later encrypt them.
1817**
1818** Parameters:      bd_addr       - Address of the peer device
1819**                  p_callback    - Pointer to callback function to indicat the
1820**                                  link encryption status
1821**                  sec_act       - This is the security action to indicate
1822**                                  what knid of BLE security level is required for
1823**                                  the BLE link if the BLE is supported
1824**                                  Note: This parameter is ignored for the BR/EDR link
1825**                                        or the BLE is not supported
1826**
1827** Returns          void
1828**
1829**
1830*******************************************************************************/
1831BTA_API extern void BTA_DmSetEncryption(BD_ADDR bd_addr, tBTA_DM_ENCRYPT_CBACK *p_callback,
1832                            tBTA_DM_BLE_SEC_ACT sec_act);
1833
1834
1835/*******************************************************************************
1836**
1837** Function         BTA_DmBleObserve
1838**
1839** Description      This procedure keep the device listening for advertising
1840**                  events from a broadcast device.
1841**
1842** Parameters       start: start or stop observe.
1843**                  duration : Duration of the scan. Continuous scan if 0 is passed
1844**                  p_results_cb: Callback to be called with scan results
1845**
1846** Returns          void
1847**
1848*******************************************************************************/
1849BTA_API extern void BTA_DmBleObserve(BOOLEAN start, UINT8 duration,
1850                                           tBTA_DM_SEARCH_CBACK *p_results_cb);
1851
1852
1853#endif
1854
1855// btla-specific ++
1856/*******************************************************************************
1857**
1858** Function         BTA_DmSetAfhChannelAssessment
1859**
1860** Description      This function is called to set the channel assessment mode on or off
1861**
1862** Returns          status
1863**
1864*******************************************************************************/
1865BTA_API extern void BTA_DmSetAfhChannelAssessment (BOOLEAN enable_or_disable);
1866
1867#if BLE_INCLUDE == TRUE
1868// btla-specific --
1869/*******************************************************************************
1870**
1871** Function         BTA_DmBleConfigLocalPrivacy
1872**
1873** Description      Enable/disable privacy on the local device
1874**
1875** Parameters:      privacy_enable   - enable/disabe privacy on remote device.
1876**
1877** Returns          void
1878**
1879*******************************************************************************/
1880BTA_API extern void BTA_DmBleConfigLocalPrivacy(BOOLEAN privacy_enable);
1881
1882/*******************************************************************************
1883**
1884** Function         BTA_DmBleEnableRemotePrivacy
1885**
1886** Description      Enable/disable privacy on a remote device
1887**
1888** Parameters:      bd_addr          - BD address of the peer
1889**                  privacy_enable   - enable/disabe privacy on remote device.
1890**
1891** Returns          void
1892**
1893*******************************************************************************/
1894BTA_API extern void BTA_DmBleEnableRemotePrivacy(BD_ADDR bd_addr, BOOLEAN privacy_enable);
1895
1896
1897/*******************************************************************************
1898**
1899** Function         BTA_DmBleSetAdvConfig
1900**
1901** Description      This function is called to override the BTA default ADV parameters.
1902**
1903** Parameters       Pointer to User defined ADV data structure
1904**
1905** Returns          None
1906**
1907*******************************************************************************/
1908BTA_API extern void BTA_DmBleSetAdvConfig (tBTA_BLE_AD_MASK data_mask,
1909                                           tBTA_BLE_ADV_DATA *p_adv_cfg);
1910#endif
1911
1912#ifdef __cplusplus
1913}
1914#endif
1915
1916#endif /* BTA_API_H */
1917
1918