blob: a99847c9f90168286f7bdd43c681779925c0654a [file] [log] [blame]
* Copyright (c) 2020-2021 Project CHIP Authors
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
* @file
* Provides an implementation of the BLEManager singleton object
* for the Zephyr platforms.
#pragma once
#include <bluetooth/bluetooth.h>
#include <bluetooth/conn.h>
#include <bluetooth/gatt.h>
#include <lib/support/logging/CHIPLogging.h>
#include <type_traits>
namespace chip {
namespace DeviceLayer {
namespace Internal {
using namespace chip::Ble;
* Concrete implementation of the BLEManager singleton object for the Zephyr platforms.
class BLEManagerImpl final : public BLEManager, private BleLayer, private BlePlatformDelegate, private BleApplicationDelegate
// Allow the BLEManager interface class to delegate method calls to
// the implementation methods provided by this class.
friend BLEManager;
// As a result of, BLE indication
// callback parameter type has changed in recent Zephyr revisions. Select the compatible type
// below to support both versions for now.
using IndicationAttrType =
std::conditional_t<std::is_same<bt_gatt_indicate_func_t, void (*)(bt_conn *, bt_gatt_indicate_params *, uint8_t)>::value,
bt_gatt_indicate_params *, const bt_gatt_attr *>;
// ===== Members that implement the BLEManager internal interface.
CHIP_ERROR _Init(void);
void _Shutdown() {}
bool _IsAdvertisingEnabled(void);
CHIP_ERROR _SetAdvertisingEnabled(bool val);
bool _IsAdvertising(void);
CHIP_ERROR _SetAdvertisingMode(BLEAdvertisingMode mode);
CHIP_ERROR _GetDeviceName(char * buf, size_t bufSize);
CHIP_ERROR _SetDeviceName(const char * deviceName);
uint16_t _NumConnections(void);
void _OnPlatformEvent(const ChipDeviceEvent * event);
BleLayer * _GetBleLayer(void);
// ===== Members that implement virtual methods on BlePlatformDelegate.
bool SubscribeCharacteristic(BLE_CONNECTION_OBJECT conId, const ChipBleUUID * svcId, const ChipBleUUID * charId);
bool UnsubscribeCharacteristic(BLE_CONNECTION_OBJECT conId, const ChipBleUUID * svcId, const ChipBleUUID * charId);
bool CloseConnection(BLE_CONNECTION_OBJECT conId);
uint16_t GetMTU(BLE_CONNECTION_OBJECT conId) const;
bool SendIndication(BLE_CONNECTION_OBJECT conId, const ChipBleUUID * svcId, const ChipBleUUID * charId,
PacketBufferHandle pBuf);
bool SendWriteRequest(BLE_CONNECTION_OBJECT conId, const ChipBleUUID * svcId, const ChipBleUUID * charId,
PacketBufferHandle pBuf);
bool SendReadRequest(BLE_CONNECTION_OBJECT conId, const ChipBleUUID * svcId, const ChipBleUUID * charId,
PacketBufferHandle pBuf);
bool SendReadResponse(BLE_CONNECTION_OBJECT conId, BLE_READ_REQUEST_CONTEXT requestContext, const ChipBleUUID * svcId,
const ChipBleUUID * charId);
// ===== Members that implement virtual methods on BleApplicationDelegate.
void NotifyChipConnectionClosed(BLE_CONNECTION_OBJECT conId);
// ===== Private members reserved for use by this class only.
enum class Flags : uint8_t
kAsyncInitCompleted = 0x0001, /**< One-time asynchronous initialization actions have been performed. */
kAdvertisingEnabled = 0x0002, /**< The application has enabled CHIPoBLE advertising. */
kFastAdvertisingEnabled = 0x0004, /**< The application has enabled fast advertising. */
kAdvertising = 0x0008, /**< The system is currently CHIPoBLE advertising. */
kAdvertisingRefreshNeeded =
0x0010, /**< The advertising state/configuration has changed, but the SoftDevice has yet to be updated. */
kChipoBleGattServiceRegister = 0x0020, /**< The system has currently CHIPoBLE GATT service registered. */
struct ServiceData;
BitFlags<Flags> mFlags;
uint16_t mGAPConns;
CHIPoBLEServiceMode mServiceMode;
bool mSubscribedConns[CONFIG_BT_MAX_CONN];
bt_gatt_indicate_params mIndicateParams[CONFIG_BT_MAX_CONN];
bt_conn_cb mConnCallbacks;
PacketBufferHandle c3CharDataBufferHandle;
void DriveBLEState(void);
CHIP_ERROR ConfigureAdvertising(void);
CHIP_ERROR StartAdvertising(void);
CHIP_ERROR StopAdvertising(void);
CHIP_ERROR HandleGAPConnect(const ChipDeviceEvent * event);
CHIP_ERROR HandleGAPDisconnect(const ChipDeviceEvent * event);
CHIP_ERROR HandleRXCharWrite(const ChipDeviceEvent * event);
CHIP_ERROR HandleTXCharCCCDWrite(const ChipDeviceEvent * event);
CHIP_ERROR HandleTXCharComplete(const ChipDeviceEvent * event);
CHIP_ERROR PrepareC3CharData();
bool IsSubscribed(bt_conn * conn);
bool SetSubscribed(bt_conn * conn);
bool UnsetSubscribed(bt_conn * conn);
uint32_t GetAdvertisingInterval();
static void DriveBLEState(intptr_t arg);
// Below callbacks run from the system workqueue context and have a limited stack capacity.
static void HandleTXIndicated(bt_conn * conn, IndicationAttrType attr, uint8_t err);
static void HandleConnect(bt_conn * conn, uint8_t err);
static void HandleDisconnect(bt_conn * conn, uint8_t reason);
static void HandleBLEAdvertisementIntervalChange(System::Layer * layer, void * param);
// ===== Members for internal use by the following friends.
friend BLEManager & BLEMgr(void);
friend BLEManagerImpl & BLEMgrImpl(void);
static BLEManagerImpl sInstance;
// Below callbacks are public in order to be visible from the global scope.
static ssize_t HandleRXWrite(bt_conn * conn, const bt_gatt_attr * attr, const void * buf, uint16_t len, uint16_t offset,
uint8_t flags);
static ssize_t HandleTXCCCWrite(bt_conn * conn, const bt_gatt_attr * attr, uint16_t value);
static ssize_t HandleC3Read(struct bt_conn * conn, const struct bt_gatt_attr * attr, void * buf, uint16_t len, uint16_t offset);
* Returns a reference to the public interface of the BLEManager singleton object.
* Internal components should use this to access features of the BLEManager object
* that are common to all platforms.
inline BLEManager & BLEMgr(void)
return BLEManagerImpl::sInstance;
* Returns the platform-specific implementation of the BLEManager singleton object.
* Internal components can use this to gain access to features of the BLEManager
* that are specific to the Zephyr platforms.
inline BLEManagerImpl & BLEMgrImpl(void)
return BLEManagerImpl::sInstance;
inline BleLayer * BLEManagerImpl::_GetBleLayer()
return this;
inline bool BLEManagerImpl::_IsAdvertisingEnabled(void)
return mFlags.Has(Flags::kAdvertisingEnabled);
inline bool BLEManagerImpl::_IsAdvertising(void)
return mFlags.Has(Flags::kAdvertising);
} // namespace Internal
} // namespace DeviceLayer
} // namespace chip