bta/dm/bta_dm_int.h

   1 /******************************************************************************
   2  *
   3  *  Copyright 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 private interface file for the BTA device manager.
  22  *
  23  ******************************************************************************/
  24 #ifndef BTA_DM_INT_H
  25 #define BTA_DM_INT_H
  26
  27 #include <memory>
  28 #include "bt_target.h"
  29 #include "bta/sys/bta_sys.h"
  30
  31 #include "bta/include/bta_gatt_api.h"
  32
  33 /*****************************************************************************
  34  *  Constants and data types
  35  ****************************************************************************/
  36
  37 #define BTA_COPY_DEVICE_CLASS(coddst, codsrc)          \
  38   {                                                    \
  39     ((uint8_t*)(coddst))[0] = ((uint8_t*)(codsrc))[0]; \
  40     ((uint8_t*)(coddst))[1] = ((uint8_t*)(codsrc))[1]; \
  41     ((uint8_t*)(coddst))[2] = ((uint8_t*)(codsrc))[2]; \
  42   }
  43
  44 #define BTA_DM_MSG_LEN 50
  45
  46 #define BTA_SERVICE_ID_TO_SERVICE_MASK(id) (1 << (id))
  47
  48 /* DM search events */
  49 enum {
  50   /* DM search API events */
  51   BTA_DM_API_SEARCH_EVT = BTA_SYS_EVT_START(BTA_ID_DM_SEARCH),
  52   BTA_DM_API_DISCOVER_EVT,
  53   BTA_DM_INQUIRY_CMPL_EVT,
  54   BTA_DM_REMT_NAME_EVT,
  55   BTA_DM_SDP_RESULT_EVT,
  56   BTA_DM_SEARCH_CMPL_EVT,
  57   BTA_DM_DISCOVERY_RESULT_EVT,
  58   BTA_DM_DISC_CLOSE_TOUT_EVT
  59 };
  60
  61 /* data type for BTA_DM_API_SEARCH_EVT */
  62 typedef struct {
  63   BT_HDR hdr;
  64   tBTA_SERVICE_MASK services;
  65   tBTA_DM_SEARCH_CBACK* p_cback;
  66 } tBTA_DM_API_SEARCH;
  67
  68 /* data type for BTA_DM_API_DISCOVER_EVT */
  69 typedef struct {
  70   BT_HDR hdr;
  71   RawAddress bd_addr;
  72   tBTA_DM_SEARCH_CBACK* p_cback;
  73   tBT_TRANSPORT transport;
  74 } tBTA_DM_API_DISCOVER;
  75
  76 typedef struct {
  77   RawAddress bd_addr;
  78   bool accept;
  79   uint8_t pin_len;
  80   uint8_t p_pin[PIN_CODE_LEN];
  81 } tBTA_DM_API_PIN_REPLY;
  82
  83 typedef struct {
  84   BT_HDR hdr;
  85   RawAddress bd_addr;
  86   tBTM_IO_CAP io_cap;
  87   tBTM_OOB_DATA oob_data;
  88   tBTM_AUTH_REQ auth_req;
  89 } tBTA_DM_CI_IO_REQ;
  90
  91 typedef struct {
  92   RawAddress bd_addr;
  93   Octet16 c;
  94   Octet16 r;
  95   bool accept;
  96 } tBTA_DM_CI_RMT_OOB;
  97
  98 /* data type for BTA_DM_REMT_NAME_EVT */
  99 typedef struct {
 100   BT_HDR hdr;
 101   tBTA_DM_SEARCH result;
 102 } tBTA_DM_REM_NAME;
 103
 104 /* data type for tBTA_DM_DISC_RESULT */
 105 typedef struct {
 106   BT_HDR hdr;
 107   tBTA_DM_SEARCH result;
 108 } tBTA_DM_DISC_RESULT;
 109
 110 /* data type for BTA_DM_INQUIRY_CMPL_EVT */
 111 typedef struct {
 112   BT_HDR hdr;
 113   uint8_t num;
 114 } tBTA_DM_INQUIRY_CMPL;
 115
 116 /* data type for BTA_DM_SDP_RESULT_EVT */
 117 typedef struct {
 118   BT_HDR hdr;
 119   uint16_t sdp_result;
 120 } tBTA_DM_SDP_RESULT;
 121
 122 typedef struct {
 123   RawAddress bd_addr;
 124   DEV_CLASS dc;
 125   LinkKey link_key;
 126   uint8_t key_type;
 127   bool link_key_known;
 128   bool dc_known;
 129   BD_NAME bd_name;
 130   uint8_t pin_length;
 131 } tBTA_DM_API_ADD_DEVICE;
 132
 133 typedef struct {
 134   BT_HDR hdr;
 135   bool enable;
 136 } tBTA_DM_API_BLE_FEATURE;
 137
 138 /* union of all data types */
 139 typedef union {
 140   /* GKI event buffer header */
 141   BT_HDR hdr;
 142
 143   tBTA_DM_API_SEARCH search;
 144
 145   tBTA_DM_API_DISCOVER discover;
 146
 147   tBTA_DM_REM_NAME rem_name;
 148
 149   tBTA_DM_DISC_RESULT disc_result;
 150
 151   tBTA_DM_INQUIRY_CMPL inq_cmpl;
 152
 153   tBTA_DM_SDP_RESULT sdp_event;
 154
 155 } tBTA_DM_MSG;
 156
 157 #define BTA_DM_NUM_PEER_DEVICE 7
 158
 159 #define BTA_DM_NOT_CONNECTED 0
 160 #define BTA_DM_CONNECTED 1
 161 #define BTA_DM_UNPAIRING 2
 162 typedef uint8_t tBTA_DM_CONN_STATE;
 163
 164 typedef enum : uint8_t {
 165   BTA_DM_DI_NONE = 0x00,      /* nothing special */
 166   BTA_DM_DI_SET_SNIFF = 0x01, /* set this bit if call BTM_SetPowerMode(sniff) */
 167   BTA_DM_DI_INT_SNIFF = 0x02, /* set this bit if call BTM_SetPowerMode(sniff) &
 168                                  enter sniff mode */
 169   BTA_DM_DI_ACP_SNIFF = 0x04, /* set this bit if peer init sniff */
 170   BTA_DM_DI_USE_SSR = 0x10, /* set this bit if ssr is supported for this link */
 171   BTA_DM_DI_AV_ACTIVE = 0x20, /* set this bit if AV is active for this link */
 172 } tBTA_DM_DEV_INFO_BITMASK;
 173 typedef uint8_t tBTA_DM_DEV_INFO;
 174
 175 /* set power mode request type */
 176 #define BTA_DM_PM_RESTART 1
 177 #define BTA_DM_PM_NEW_REQ 2
 178 #define BTA_DM_PM_EXECUTE 3
 179 typedef uint8_t tBTA_DM_PM_REQ;
 180
 181 typedef struct {
 182   RawAddress peer_bdaddr;
 183   tBTA_DM_CONN_STATE conn_state;
 184   tBTA_PREF_ROLES pref_role;
 185   bool in_use;
 186   tBTA_DM_DEV_INFO info;
 187   tBTA_DM_ENCRYPT_CBACK* p_encrypt_cback;
 188   tBTM_PM_STATUS prev_low; /* previous low power mode used */
 189   tBTA_DM_PM_ACTION pm_mode_attempted;
 190   tBTA_DM_PM_ACTION pm_mode_failed;
 191   bool remove_dev_pending;
 192   tBT_TRANSPORT transport;
 193 } tBTA_DM_PEER_DEVICE;
 194
 195 /* structure to store list of
 196   active connections */
 197 typedef struct {
 198   tBTA_DM_PEER_DEVICE peer_device[BTA_DM_NUM_PEER_DEVICE];
 199   uint8_t count;
 200   uint8_t le_count;
 201 } tBTA_DM_ACTIVE_LINK;
 202
 203 typedef struct {
 204   RawAddress peer_bdaddr;
 205   tBTA_SYS_ID id;
 206   uint8_t app_id;
 207   tBTA_SYS_CONN_STATUS state;
 208   bool new_request;
 209
 210 } tBTA_DM_SRVCS;
 211
 212 #ifndef BTA_DM_NUM_CONN_SRVS
 213 #define BTA_DM_NUM_CONN_SRVS 30
 214 #endif
 215
 216 typedef struct {
 217   uint8_t count;
 218   tBTA_DM_SRVCS conn_srvc[BTA_DM_NUM_CONN_SRVS];
 219
 220 } tBTA_DM_CONNECTED_SRVCS;
 221
 222 typedef struct {
 223 #define BTA_DM_PM_SNIFF_TIMER_IDX 0
 224 #define BTA_DM_PM_PARK_TIMER_IDX 1
 225 #define BTA_DM_PM_SUSPEND_TIMER_IDX 2
 226 #define BTA_DM_PM_MODE_TIMER_MAX 3
 227   /*
 228    * Keep three different timers for PARK, SNIFF and SUSPEND if TBFC is
 229    * supported.
 230    */
 231   alarm_t* timer[BTA_DM_PM_MODE_TIMER_MAX];
 232
 233   uint8_t srvc_id[BTA_DM_PM_MODE_TIMER_MAX];
 234   uint8_t pm_action[BTA_DM_PM_MODE_TIMER_MAX];
 235   uint8_t active; /* number of active timer */
 236
 237   RawAddress peer_bdaddr;
 238   bool in_use;
 239 } tBTA_PM_TIMER;
 240
 241 extern tBTA_DM_CONNECTED_SRVCS bta_dm_conn_srvcs;
 242
 243 #define BTA_DM_NUM_PM_TIMER 7
 244
 245 /* DM control block */
 246 typedef struct {
 247   bool is_bta_dm_active;
 248   tBTA_DM_ACTIVE_LINK device_list;
 249   tBTA_DM_SEC_CBACK* p_sec_cback;
 250   tBTA_BLE_ENERGY_INFO_CBACK* p_energy_info_cback;
 251   uint16_t state;
 252   bool disabling;
 253   alarm_t* disable_timer;
 254   uint32_t wbt_sdp_handle; /* WIDCOMM Extensions SDP record handle */
 255   uint8_t wbt_scn;         /* WIDCOMM Extensions SCN */
 256   uint8_t num_central_only;
 257   uint8_t pm_id;
 258   tBTA_PM_TIMER pm_timer[BTA_DM_NUM_PM_TIMER];
 259   uint8_t cur_av_count;   /* current AV connecions */
 260   bool disable_pair_mode; /* disable pair mode or not */
 261   bool conn_paired_only;  /* allow connectable to paired device only or not */
 262   tBTA_DM_API_SEARCH search_msg;
 263
 264   /* Storage for pin code request parameters */
 265   RawAddress pin_bd_addr;
 266   DEV_CLASS pin_dev_class;
 267   tBTA_DM_SEC_EVT pin_evt;
 268   tBTM_IO_CAP loc_io_caps;    /* IO Capabilities of local device */
 269   tBTM_IO_CAP rmt_io_caps;    /* IO Capabilities of remote device */
 270   tBTM_AUTH_REQ loc_auth_req; /* Authentication required for local device */
 271   tBTM_AUTH_REQ rmt_auth_req;
 272   uint32_t num_val; /* the numeric value for comparison. If just_works, do not
 273                        show this number to UI */
 274   bool just_works;  /* true, if "Just Works" association model */
 275 #if (BTA_EIR_CANNED_UUID_LIST != TRUE)
 276   /* store UUID list for EIR */
 277   uint32_t eir_uuid[BTM_EIR_SERVICE_ARRAY_SIZE];
 278 #if (BTA_EIR_SERVER_NUM_CUSTOM_UUID > 0)
 279   tBTA_CUSTOM_UUID bta_custom_uuid[BTA_EIR_SERVER_NUM_CUSTOM_UUID];
 280 #endif
 281
 282 #endif
 283
 284   tBTA_DM_ENCRYPT_CBACK* p_encrypt_cback;
 285   alarm_t* switch_delay_timer;
 286
 287 } tBTA_DM_CB;
 288
 289 /* DM search control block */
 290 typedef struct {
 291   tBTA_DM_SEARCH_CBACK* p_search_cback;
 292   tBTM_INQ_INFO* p_btm_inq_info;
 293   tBTA_SERVICE_MASK services;
 294   tBTA_SERVICE_MASK services_to_search;
 295   tBTA_SERVICE_MASK services_found;
 296   tSDP_DISCOVERY_DB* p_sdp_db;
 297   uint16_t state;
 298   RawAddress peer_bdaddr;
 299   bool name_discover_done;
 300   BD_NAME peer_name;
 301   alarm_t* search_timer;
 302   uint8_t service_index;
 303   tBTA_DM_MSG* p_pending_search;
 304   tBTA_DM_MSG* p_pending_discovery;
 305   bool wait_disc;
 306   bool sdp_results;
 307   bluetooth::Uuid uuid;
 308   uint8_t peer_scn;
 309   tBT_TRANSPORT transport;
 310   tBTA_DM_SEARCH_CBACK* p_scan_cback;
 311   tGATT_IF client_if;
 312   uint8_t uuid_to_search;
 313   bool gatt_disc_active;
 314   uint16_t conn_id;
 315   alarm_t* gatt_close_timer; /* GATT channel close delay timer */
 316   RawAddress pending_close_bda; /* pending GATT channel remote device address */
 317
 318 } tBTA_DM_SEARCH_CB;
 319
 320 /* DI control block */
 321 typedef struct {
 322   uint8_t di_num;                     /* total local DI record number */
 323   uint32_t di_handle[BTA_DI_NUM_MAX]; /* local DI record handle, the first one
 324                                          is primary record */
 325 } tBTA_DM_DI_CB;
 326
 327 /* DM search state */
 328 enum {
 329
 330   BTA_DM_SEARCH_IDLE,
 331   BTA_DM_SEARCH_ACTIVE,
 332   BTA_DM_SEARCH_CANCELLING,
 333   BTA_DM_DISCOVER_ACTIVE
 334
 335 };
 336
 337 typedef struct {
 338   DEV_CLASS dev_class; /* local device class */
 339   uint16_t page_timeout; /* timeout for page in slots */
 340   uint16_t link_timeout; /* link supervision timeout in slots */
 341   bool avoid_scatter; /* true to avoid scatternet when av is streaming (be the
 342                          central) */
 343
 344 } tBTA_DM_CFG;
 345
 346 extern const uint32_t bta_service_id_to_btm_srv_id_lkup_tbl[];
 347
 348 typedef struct {
 349   uint8_t id;
 350   uint8_t app_id;
 351   uint8_t cfg;
 352
 353 } tBTA_DM_RM;
 354
 355 extern const tBTA_DM_CFG* p_bta_dm_cfg;
 356 extern const tBTA_DM_RM* p_bta_dm_rm_cfg;
 357
 358 typedef struct {
 359   uint8_t id;
 360   uint8_t app_id;
 361   uint8_t spec_idx; /* index of spec table to use */
 362
 363 } tBTA_DM_PM_CFG;
 364
 365 typedef struct {
 366   tBTA_DM_PM_ACTION power_mode;
 367   uint16_t timeout;
 368
 369 } tBTA_DM_PM_ACTN;
 370
 371 typedef struct {
 372   uint8_t allow_mask; /* mask of sniff/hold/park modes to allow */
 373   uint8_t ssr; /* set SSR on conn open/unpark */
 374   tBTA_DM_PM_ACTN actn_tbl[BTA_DM_PM_NUM_EVTS][2];
 375
 376 } tBTA_DM_PM_SPEC;
 377
 378 typedef struct {
 379   uint16_t max_lat;
 380   uint16_t min_rmt_to;
 381   uint16_t min_loc_to;
 382 } tBTA_DM_SSR_SPEC;
 383
 384 typedef struct {
 385   uint16_t manufacturer;
 386   uint16_t lmp_sub_version;
 387   uint8_t lmp_version;
 388 } tBTA_DM_LMP_VER_INFO;
 389
 390 extern const uint16_t bta_service_id_to_uuid_lkup_tbl[];
 391
 392 extern const tBTA_DM_PM_CFG* p_bta_dm_pm_cfg;
 393 extern const tBTA_DM_PM_SPEC* p_bta_dm_pm_spec;
 394 extern const tBTM_PM_PWR_MD* p_bta_dm_pm_md;
 395 extern tBTA_DM_SSR_SPEC* p_bta_dm_ssr_spec;
 396
 397 /* update dynamic BRCM Aware EIR data */
 398 extern const tBTA_DM_EIR_CONF bta_dm_eir_cfg;
 399 extern const tBTA_DM_EIR_CONF* p_bta_dm_eir_cfg;
 400
 401 /* DM control block */
 402 extern tBTA_DM_CB bta_dm_cb;
 403
 404 /* DM search control block */
 405 extern tBTA_DM_SEARCH_CB bta_dm_search_cb;
 406
 407 /* DI control block */
 408 extern tBTA_DM_DI_CB bta_dm_di_cb;
 409
 410 extern bool bta_dm_search_sm_execute(BT_HDR* p_msg);
 411 extern void bta_dm_search_sm_disable(void);
 412
 413 extern void bta_dm_enable(tBTA_DM_SEC_CBACK*);
 414 extern void bta_dm_disable();
 415 extern void bta_dm_init_cb(void);
 416 extern void bta_dm_set_dev_name(const std::vector<uint8_t>&);
 417 extern void bta_dm_set_visibility(tBTA_DM_DISC, tBTA_DM_CONN);
 418 extern void bta_dm_set_scan_config(tBTA_DM_MSG* p_data);
 419 extern void bta_dm_vendor_spec_command(tBTA_DM_MSG* p_data);
 420 extern void bta_dm_bond(const RawAddress&, tBLE_ADDR_TYPE, tBT_TRANSPORT, int);
 421 extern void bta_dm_bond_cancel(const RawAddress&);
 422 extern void bta_dm_pin_reply(std::unique_ptr<tBTA_DM_API_PIN_REPLY> msg);
 423 extern void bta_dm_add_device(std::unique_ptr<tBTA_DM_API_ADD_DEVICE> msg);
 424 extern void bta_dm_remove_device(const RawAddress& bd_addr);
 425 extern void bta_dm_close_acl(const RawAddress&, bool, tBT_TRANSPORT);
 426
 427 extern void bta_dm_pm_btm_status(const RawAddress&, tBTM_PM_STATUS, uint16_t,
 428                                  uint8_t);
 429 extern void bta_dm_pm_timer(const RawAddress&, tBTA_DM_PM_ACTION);
 430 extern void bta_dm_add_ampkey(tBTA_DM_MSG* p_data);
 431
 432 extern void bta_dm_add_blekey(const RawAddress& bd_addr,
 433                               tBTA_LE_KEY_VALUE blekey,
 434                               tBTM_LE_KEY_TYPE key_type);
 435 extern void bta_dm_add_ble_device(const RawAddress& bd_addr,
 436                                   tBLE_ADDR_TYPE addr_type,
 437                                   tBT_DEVICE_TYPE dev_type);
 438 extern void bta_dm_ble_passkey_reply(const RawAddress& bd_addr, bool accept,
 439                                      uint32_t passkey);
 440 extern void bta_dm_ble_confirm_reply(const RawAddress&, bool);
 441 extern void bta_dm_ble_set_conn_params(const RawAddress&, uint16_t, uint16_t,
 442                                        uint16_t, uint16_t);
 443 extern void bta_dm_close_gatt_conn(tBTA_DM_MSG* p_data);
 444 extern void bta_dm_ble_observe(bool, uint8_t, tBTA_DM_SEARCH_CBACK*);
 445 extern void bta_dm_ble_update_conn_params(const RawAddress&, uint16_t, uint16_t,
 446                                           uint16_t, uint16_t, uint16_t,
 447                                           uint16_t);
 448 extern void bta_dm_ble_config_local_privacy(bool);
 449
 450 extern void bta_dm_ble_set_data_length(const RawAddress&, uint16_t);
 451
 452 extern void bta_dm_ble_get_energy_info(tBTA_BLE_ENERGY_INFO_CBACK*);
 453
 454 extern void bta_dm_set_encryption(const RawAddress&, tBT_TRANSPORT,
 455                                   tBTA_DM_ENCRYPT_CBACK*, tBTM_BLE_SEC_ACT);
 456 extern void bta_dm_confirm(const RawAddress&, bool);
 457
 458 extern void bta_dm_ci_rmt_oob_act(std::unique_ptr<tBTA_DM_CI_RMT_OOB> msg);
 459
 460 extern void bta_dm_init_pm(void);
 461 extern void bta_dm_disable_pm(void);
 462
 463 extern uint8_t bta_dm_get_av_count(void);
 464 extern void bta_dm_search_start(tBTA_DM_MSG* p_data);
 465 extern void bta_dm_search_cancel();
 466 extern void bta_dm_discover(tBTA_DM_MSG* p_data);
 467 extern void bta_dm_inq_cmpl(uint8_t num);
 468 extern void bta_dm_rmt_name(tBTA_DM_MSG* p_data);
 469 extern void bta_dm_sdp_result(tBTA_DM_MSG* p_data);
 470 extern void bta_dm_search_cmpl();
 471 extern void bta_dm_free_sdp_db();
 472 extern void bta_dm_disc_result(tBTA_DM_MSG* p_data);
 473 extern void bta_dm_search_result(tBTA_DM_MSG* p_data);
 474 extern void bta_dm_discovery_cmpl(tBTA_DM_MSG* p_data);
 475 extern void bta_dm_queue_search(tBTA_DM_MSG* p_data);
 476 extern void bta_dm_queue_disc(tBTA_DM_MSG* p_data);
 477 extern void bta_dm_search_clear_queue();
 478 extern void bta_dm_search_cancel_cmpl();
 479 extern void bta_dm_search_cancel_notify();
 480 extern void bta_dm_disc_rmt_name(tBTA_DM_MSG* p_data);
 481 extern tBTA_DM_PEER_DEVICE* bta_dm_find_peer_device(
 482     const RawAddress& peer_addr);
 483
 484 uint8_t bta_dm_search_get_state();
 485 void bta_dm_search_set_state(uint8_t state);
 486
 487 void bta_dm_eir_update_uuid(uint16_t uuid16, bool adding);
 488 void bta_dm_eir_update_cust_uuid(const tBTA_CUSTOM_UUID &curr, bool adding);
 489 #endif /* BTA_DM_INT_H */