ble_advertiser_hci_interface.h revision 8e774d1c533dde1b0775aa61933b24eef2213de4 
1/******************************************************************************
2 *
3 *  Copyright (C) 2016 The Android Open Source Project
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#ifndef BLE_ADVERTISER_HCI_INTERFACE_H
20#define BLE_ADVERTISER_HCI_INTERFACE_H
21
22#include <base/bind.h>
23#include "stack/include/bt_types.h"
24
25/* This class is an abstraction of HCI commands used for managing
26 * advertisements. Please see VSC HCI SPEC at
27 * https://static.googleusercontent.com/media/source.android.com/en//devices/Android-6.0-Bluetooth-HCI-Reqs.pdf
28 * and Bluetooth 5.0 "Advertising Extension" feature for more details  */
29class BleAdvertiserHciInterface {
30 public:
31  using status_cb = base::Callback<void(uint8_t /* status */)>;
32
33  static void Initialize();
34  static BleAdvertiserHciInterface* Get();
35  static void CleanUp();
36
37  virtual ~BleAdvertiserHciInterface() = default;
38
39  class AdvertisingEventObserver {
40   public:
41    virtual ~AdvertisingEventObserver() = default;
42    virtual void OnAdvertisingSetTerminated(
43        uint8_t status, uint8_t advertising_handle, uint16_t connection_handle,
44        uint8_t num_completed_extended_adv_events) = 0;
45  };
46
47  virtual void SetAdvertisingEventObserver(
48      AdvertisingEventObserver* observer) = 0;
49  virtual void ReadInstanceCount(
50      base::Callback<void(uint8_t /* inst_cnt*/)> cb) = 0;
51  virtual void SetParameters(uint8_t handle, uint16_t properties,
52                             uint32_t adv_int_min, uint32_t adv_int_max,
53                             uint8_t channel_map, uint8_t own_address_type,
54                             BD_ADDR own_address, uint8_t peer_address_type,
55                             BD_ADDR peer_address, uint8_t filter_policy,
56                             int8_t tx_power, uint8_t primary_phy,
57                             uint8_t secondary_max_skip, uint8_t secondary_phy,
58                             uint8_t advertising_sid,
59                             uint8_t scan_request_notify_enable,
60                             status_cb command_complete) = 0;
61  virtual void SetAdvertisingData(uint8_t handle, uint8_t operation,
62                                  uint8_t fragment_preference,
63                                  uint8_t data_length, uint8_t* data,
64                                  status_cb command_complete) = 0;
65  virtual void SetScanResponseData(uint8_t handle, uint8_t operation,
66                                   uint8_t fragment_preference,
67                                   uint8_t scan_response_data_length,
68                                   uint8_t* scan_response_data,
69                                   status_cb command_complete) = 0;
70  virtual void SetRandomAddress(uint8_t handle, BD_ADDR random_address,
71                                status_cb command_complete) = 0;
72  virtual void Enable(uint8_t enable, uint8_t handle, uint16_t duration,
73                      uint8_t max_extended_advertising_events,
74                      status_cb command_complete) = 0;
75  virtual void SetPeriodicAdvertisingParameters(uint8_t handle,
76                                                uint16_t periodic_adv_int_min,
77                                                uint16_t periodic_adv_int_max,
78                                                uint16_t periodic_properties,
79                                                status_cb command_complete) = 0;
80  virtual void SetPeriodicAdvertisingData(uint8_t handle, uint8_t operation,
81                                          uint8_t adv_data_length,
82                                          uint8_t* adv_data,
83                                          status_cb command_complete) = 0;
84  virtual void SetPeriodicAdvertisingEnable(uint8_t enable, uint8_t handle,
85                                            status_cb command_complete) = 0;
86
87  // Some implementation don't behave well when handle value 0 is used.
88  virtual bool QuirkAdvertiserZeroHandle() { return 0; }
89};
90
91#endif  // BLE_ADVERTISER_HCI_INTERFACE_H
92