1 /* 2 * Copyright (C) 2016 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_INCLUDE_BLE_ADVERTISER_H 18 #define ANDROID_INCLUDE_BLE_ADVERTISER_H 19 20 #include <base/callback_forward.h> 21 #include <raw_address.h> 22 #include <stdint.h> 23 24 #include <vector> 25 26 #include "bt_common_types.h" 27 #include "bt_gatt_types.h" 28 29 struct AdvertiseParameters { 30 uint16_t advertising_event_properties; 31 uint32_t min_interval; 32 uint32_t max_interval; 33 uint8_t channel_map; 34 int8_t tx_power; 35 uint8_t primary_advertising_phy; 36 uint8_t secondary_advertising_phy; 37 uint8_t scan_request_notification_enable; 38 int8_t own_address_type; 39 }; 40 41 struct PeriodicAdvertisingParameters { 42 uint8_t enable; 43 uint16_t min_interval; 44 uint16_t max_interval; 45 uint16_t periodic_advertising_properties; 46 }; 47 48 /** 49 * LE Advertising related callbacks invoked from from the Bluetooth native stack 50 * All callbacks are invoked on the JNI thread 51 */ 52 class AdvertisingCallbacks { 53 public: 54 virtual ~AdvertisingCallbacks() = default; 55 virtual void OnAdvertisingSetStarted(int reg_id, uint8_t advertiser_id, 56 int8_t tx_power, uint8_t status) = 0; 57 virtual void OnAdvertisingEnabled(uint8_t advertiser_id, bool enable, 58 uint8_t status) = 0; 59 virtual void OnAdvertisingDataSet(uint8_t advertiser_id, uint8_t status) = 0; 60 virtual void OnScanResponseDataSet(uint8_t advertiser_id, uint8_t status) = 0; 61 virtual void OnAdvertisingParametersUpdated(uint8_t advertiser_id, 62 int8_t tx_power, 63 uint8_t status) = 0; 64 virtual void OnPeriodicAdvertisingParametersUpdated(uint8_t advertiser_id, 65 uint8_t status) = 0; 66 virtual void OnPeriodicAdvertisingDataSet(uint8_t advertiser_id, 67 uint8_t status) = 0; 68 virtual void OnPeriodicAdvertisingEnabled(uint8_t advertiser_id, bool enable, 69 uint8_t status) = 0; 70 virtual void OnOwnAddressRead(uint8_t advertiser_id, uint8_t address_type, 71 RawAddress address) = 0; 72 }; 73 74 class BleAdvertiserInterface { 75 public: 76 virtual ~BleAdvertiserInterface() = default; 77 78 /** Callback invoked when multi-adv operation has completed */ 79 using StatusCallback = base::Callback<void(uint8_t /* status */)>; 80 using IdStatusCallback = 81 base::Callback<void(uint8_t /* advertiser_id */, uint8_t /* status */)>; 82 using IdTxPowerStatusCallback = 83 base::Callback<void(uint8_t /* advertiser_id */, int8_t /* tx_power */, 84 uint8_t /* status */)>; 85 using ParametersCallback = 86 base::Callback<void(uint8_t /* status */, int8_t /* tx_power */)>; 87 88 /** Registers an advertiser with the stack */ 89 virtual void RegisterAdvertiser(IdStatusCallback) = 0; 90 91 using GetAddressCallback = 92 base::Callback<void(uint8_t /* address_type*/, RawAddress /*address*/)>; 93 virtual void GetOwnAddress(uint8_t advertiser_id, GetAddressCallback cb) = 0; 94 95 /* Set the parameters as per spec, user manual specified values */ 96 virtual void SetParameters(uint8_t advertiser_id, AdvertiseParameters params, 97 ParametersCallback cb) = 0; 98 99 /* Setup the data */ 100 virtual void SetData(int advertiser_id, bool set_scan_rsp, 101 std::vector<uint8_t> data, StatusCallback cb) = 0; 102 103 /* Enable the advertising instance */ 104 virtual void Enable(uint8_t advertiser_id, bool enable, StatusCallback cb, 105 uint16_t duration, uint8_t maxExtAdvEvents, 106 StatusCallback timeout_cb) = 0; 107 108 /* Unregisters an advertiser */ 109 virtual void Unregister(uint8_t advertiser_id) = 0; 110 111 virtual void StartAdvertising(uint8_t advertiser_id, StatusCallback cb, 112 AdvertiseParameters params, 113 std::vector<uint8_t> advertise_data, 114 std::vector<uint8_t> scan_response_data, 115 int timeout_s, StatusCallback timeout_cb) = 0; 116 117 /** Start the advertising set. This include registering, setting all 118 * parameters and data, and enabling it. |register_cb| is called when the set 119 * is advertising. |timeout_cb| is called when the timeout_s have passed. 120 * |reg_id| is the callback id assigned from upper layer */ 121 virtual void StartAdvertisingSet( 122 int reg_id, IdTxPowerStatusCallback register_cb, 123 AdvertiseParameters params, std::vector<uint8_t> advertise_data, 124 std::vector<uint8_t> scan_response_data, 125 PeriodicAdvertisingParameters periodic_params, 126 std::vector<uint8_t> periodic_data, uint16_t duration, 127 uint8_t maxExtAdvEvents, IdStatusCallback timeout_cb) = 0; 128 129 virtual void SetPeriodicAdvertisingParameters( 130 int advertiser_id, PeriodicAdvertisingParameters parameters, 131 StatusCallback cb) = 0; 132 133 virtual void SetPeriodicAdvertisingData(int advertiser_id, 134 std::vector<uint8_t> data, 135 StatusCallback cb) = 0; 136 137 virtual void SetPeriodicAdvertisingEnable(int advertiser_id, bool enable, 138 StatusCallback cb) = 0; 139 virtual void RegisterCallbacks(AdvertisingCallbacks* callbacks) = 0; 140 }; 141 142 #endif /* ANDROID_INCLUDE_BLE_ADVERTISER_H */ 143