espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-03 09:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[tcat][ble] update BLE API and related TCAT agent change to re-enable advertising after disconnect (#12913)

Browse Source 
This fixes some ble.h issues and makes explicit that BLE advertising will stop once a client connects.
The TCAT agent is updated to re-enable advertising after a client disconnects (in the default case).
This fixes an issue observed in cert tests. For easier testing in the future, debug log messages are
added for the simulation BLE platform.

The simulation platform (ble.c) is improved to act more like a real BLE platform, by now supporting
client connection state and calling of otPlatBleGapOnConnected() and otPlatBleGapOnDisconnected().
This is required to manually test the TCAT Commissioner/Device flow in Posix simulation.
This commit is contained in:
Esko Dijk
2026-06-08 14:47:21 -07:00
committed by Jonathan Hui
parent c801d291b3
commit fee7292f15
4 changed files with 88 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/platforms/simulation/ble.c
+55 -7
View File
@@ -28,12 +28,15 @@
#include "platform-simulation.h"
#if OPENTHREAD_CONFIG_BLE_TCAT_ENABLE
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <openthread/error.h>
#include <openthread/logging.h>
#include <openthread/tcat.h>
#include <openthread/platform/ble.h>
@@ -43,7 +46,9 @@
#define PLAT_BLE_MSG_DATA_MAX 2048
static uint8_t sBleBuffer[PLAT_BLE_MSG_DATA_MAX];
static int sFd = -1;
static int sFd = -1;
static bool sIsConnected = false;
static bool sIsDisconnecting = false;
static const uint16_t kPortBase = 10000;
static uint16_t sPort = 0;
@@ -109,27 +114,47 @@ otError otPlatBleEnable(otInstance *aInstance)
otError otPlatBleDisable(otInstance *aInstance)
{
deinitFds();
OT_UNUSED_VARIABLE(aInstance);
deinitFds();
sIsConnected = false;
sIsDisconnecting = false;
return OT_ERROR_NONE;
}
otError otPlatBleGapAdvStart(otInstance *aInstance, uint16_t aInterval)
{
OT_UNUSED_VARIABLE(aInstance);
OT_UNUSED_VARIABLE(aInterval);
if (sIsDisconnecting) // finalize the disconnection of the TCAT client
{
sIsConnected = false;
sIsDisconnecting = false;
}
if (sIsConnected)
{
return OT_ERROR_INVALID_STATE;
}
otLogDebgPlat("BLE adv start (interval %u)", aInterval);
return OT_ERROR_NONE;
}
otError otPlatBleGapAdvStop(otInstance *aInstance)
{
OT_UNUSED_VARIABLE(aInstance);
otLogDebgPlat("BLE adv stop");
return OT_ERROR_NONE;
}
otError otPlatBleGapDisconnect(otInstance *aInstance)
{
OT_UNUSED_VARIABLE(aInstance);
if (!sIsConnected && !sIsDisconnecting)
{
return OT_ERROR_INVALID_STATE;
}
if (!sIsDisconnecting) // check, to avoid reentrant calls
{
sIsDisconnecting = true;
otPlatBleGapOnDisconnected(aInstance, 0);
}
return OT_ERROR_NONE;
}
@@ -193,6 +218,14 @@ void platformBleProcess(otInstance *aInstance, const fd_set *aReadFdSet, const f
if (rval > 0)
{
otBleRadioPacket myPacket;
if (!sIsConnected)
{
sIsConnected = true;
otLogDebgPlat("BLE client connected");
otPlatBleGapOnConnected(aInstance, 0);
}
myPacket.mValue = sBleBuffer;
myPacket.mLength = (uint16_t)rval;
myPacket.mPower = 0;
@@ -215,6 +248,22 @@ exit:
return;
}
/* Weak stubs for callbacks defined in the FTD/MTD core library, not available for RCP targets. */
OT_TOOL_WEAK void otPlatBleGapOnConnected(otInstance *aInstance, uint16_t aConnectionId)
{
OT_UNUSED_VARIABLE(aInstance);
OT_UNUSED_VARIABLE(aConnectionId);
assert(false);
}
OT_TOOL_WEAK void otPlatBleGapOnDisconnected(otInstance *aInstance, uint16_t aConnectionId)
{
OT_UNUSED_VARIABLE(aInstance);
OT_UNUSED_VARIABLE(aConnectionId);
assert(false);
}
OT_TOOL_WEAK void otPlatBleGattServerOnWriteRequest(otInstance *aInstance,
uint16_t aHandle,
const otBleRadioPacket *aPacket)
@@ -223,9 +272,6 @@ OT_TOOL_WEAK void otPlatBleGattServerOnWriteRequest(otInstance *aIns
OT_UNUSED_VARIABLE(aHandle);
OT_UNUSED_VARIABLE(aPacket);
assert(false);
/* In case of rcp there is a problem with linking to otPlatBleGattServerOnWriteRequest
* which is available in FTD/MTD library.
*/
}
void otPlatBleGetLinkCapabilities(otInstance *aInstance, otBleLinkCapabilities *aBleLinkCapabilities)
@@ -257,3 +303,5 @@ bool otPlatBleSupportsMultiRadio(otInstance *aInstance)
OT_UNUSED_VARIABLE(aInstance);
return false;
}
#endif // OPENTHREAD_CONFIG_BLE_TCAT_ENABLE
include/openthread/platform/ble.h
+28 -24
View File
@@ -74,10 +74,10 @@ extern "C" {
#define OT_BLE_ADV_INTERVAL_MAX 0x4000
/**
* Default interval for advertising packet (ms).
* Default interval for advertising packet in OT_BLE_ADV_INTERVAL_UNIT units (100 ms).
*/
#define OT_BLE_ADV_INTERVAL_DEFAULT 100
#define OT_BLE_ADV_INTERVAL_DEFAULT 160
/**
* Unit used to calculate interval duration (0.625ms).
@@ -104,13 +104,13 @@ extern "C" {
#define OT_BLE_ATT_MTU_DEFAULT 23
/**
* Default power value for BLE.
* Default Tx power value for BLE in dBm.
*/
#define OT_BLE_DEFAULT_POWER 0
/**
* TOBLE service UUID
* ToBLE service UUID (a GATT service UUID for Thread over BLE)
*/
#define OT_TOBLE_SERVICE_UUID 0xfffb
@@ -130,7 +130,7 @@ typedef struct otBleLinkCapabilities
*/
typedef struct otBleRadioPacket
{
uint8_t *mValue; ///< The value of an attribute
uint8_t *mValue; ///< Pointer to the packet data
uint16_t mLength; ///< Length of the @p mValue.
int8_t mPower; ///< Transmit/receive power in dBm.
} otBleRadioPacket;
@@ -171,18 +171,16 @@ otError otPlatBleDisable(otInstance *aInstance);
* @section Bluetooth Low Energy GAP.
***************************************************************************/
/**
* Gets BLE Advertising buffer.
* Gets a platform-provided buffer for BLE advertising data.
*
* @note This function shall be used only for BLE Peripheral role.
* Returned buffer should have enough space to fit max advertisement
* defined by specification.
* The platform must provide a buffer of at least @p OT_TCAT_ADVERTISEMENT_MAX_LEN bytes.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aAdvertisementData The formatted TCAT advertisement frame.
* @param[in] aAdvertisementLen The TCAT advertisement frame length.
* @param[in] aInstance The OpenThread instance structure.
* @param[out] aAdvertisementBuffer A pointer to be set to the platform-provided advertisement buffer.
*
* @retval OT_ERROR_NONE Advertising procedure has been started.
* @retval OT_ERROR_NO_BUFS No bufferspace available.
* @retval OT_ERROR_NONE Successfully retrieved the advertisement buffer.
* @retval OT_ERROR_NO_BUFS No buffer space available.
*/
otError otPlatBleGetAdvertisementBuffer(otInstance *aInstance, uint8_t **aAdvertisementBuffer);
@@ -190,12 +188,13 @@ otError otPlatBleGetAdvertisementBuffer(otInstance *aInstance, uint8_t **aAdvert
* Sets BLE Advertising data.
*
* @note This function shall be used only for BLE Peripheral role.
* It shall only be called while advertising is not active.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aAdvertisementData The formatted TCAT advertisement frame.
* @param[in] aAdvertisementLen The TCAT advertisement frame length.
* @param[in] aAdvertisementLen The length of the @p aAdvertisementData frame.
*
* @retval OT_ERROR_NONE Advertising procedure has been started.
* @retval OT_ERROR_NONE Advertising data set successfully.
* @retval OT_ERROR_INVALID_STATE BLE Device is in invalid state.
* @retval OT_ERROR_INVALID_ARGS Invalid value has been supplied.
*/
@@ -205,12 +204,13 @@ otError otPlatBleGapAdvSetData(otInstance *aInstance, uint8_t *aAdvertisementDat
* Updates BLE Advertising data.
*
* @note This function shall be used only for BLE Peripheral role.
* It shall only be called while advertising is active.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aAdvertisementData The formatted TCAT advertisement frame.
* @param[in] aAdvertisementLen The TCAT advertisement frame length.
* @param[in] aAdvertisementLen The length of the @p aAdvertisementData frame.
*
* @retval OT_ERROR_NONE Advertising procedure has been started.
* @retval OT_ERROR_NONE Advertising data updated successfully.
* @retval OT_ERROR_FAILED Update of data failed.
* @retval OT_ERROR_INVALID_ARGS Invalid value has been supplied.
*/
@@ -222,6 +222,8 @@ otError otPlatBleGapAdvUpdateData(otInstance *aInstance, uint8_t *aAdvertisement
* The BLE device shall use undirected advertising with no filter applied.
* A single BLE Advertising packet must be sent on all advertising
* channels (37, 38 and 39).
* The advertising shall remain active until either otPlatBleGapAdvStop() is
* called or a BLE Central Device connects (otPlatBleGapOnConnected()).
*
* @note This function shall be used only for BLE Peripheral role.
*
@@ -272,7 +274,7 @@ extern void otPlatBleGapOnDisconnected(otInstance *aInstance, uint16_t aConnecti
* Disconnects BLE connection.
*
* The BLE device shall use the Remote User Terminated Connection (0x13) reason
* code when disconnecting from the peer BLE device..
* code when disconnecting from the peer BLE device.
*
* @param[in] aInstance The OpenThread instance structure.
*
@@ -315,7 +317,7 @@ extern void otPlatBleGattOnMtuUpdate(otInstance *aInstance, uint16_t aMtu);
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aHandle The handle of the attribute to be indicated.
* @param[in] aPacket A pointer to the packet contains value to be indicated.
* @param[in] aPacket A pointer to the packet containing the value to be indicated.
*
* @retval OT_ERROR_NONE ATT Handle Value Indication has been sent.
* @retval OT_ERROR_INVALID_STATE BLE Device is in invalid state.
@@ -332,22 +334,24 @@ otError otPlatBleGattServerIndicate(otInstance *aInstance, uint16_t aHandle, con
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aHandle The handle of the attribute to be written.
* @param[in] aPacket A pointer to the packet contains value to be written to the attribute.
* @param[in] aPacket A pointer to the packet containing the value to be written to the attribute.
*/
extern void otPlatBleGattServerOnWriteRequest(otInstance *aInstance, uint16_t aHandle, const otBleRadioPacket *aPacket);
/**
* Function to retrieve from platform BLE link capabilities.
* Retrieve BLE link capabilities from the platform.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[out] aBleLinkCapabilities The pointer to retrieve the BLE ling capabilities.
* @param[out] aBleLinkCapabilities The pointer to retrieve the BLE link capabilities into.
*/
void otPlatBleGetLinkCapabilities(otInstance *aInstance, otBleLinkCapabilities *aBleLinkCapabilities);
/**
* Function to retrieve from platform multiradio support of BLE and IEEE.
* Check if the platform has multi-radio support for BLE and IEEE 802.15.4.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aInstance The OpenThread instance structure.
*
* @returns TRUE if the platform supports simultaneous BLE and IEEE 802.15.4 operation, FALSE otherwise.
*/
bool otPlatBleSupportsMultiRadio(otInstance *aInstance);
/**
src/core/meshcop/tcat_agent.cpp
+1 -2
View File
@@ -1069,8 +1069,7 @@ void TcatAgent::HandleTimer(void)
// internally called when TcatAgent state changes: perform any required actions.
void TcatAgent::NotifyStateChange(void)
{
Get<Ble::BleSecure>().NotifySendAdvertisements(mState == kStateActive || mState == kStateActiveTemporary ||
mState == kStateConnected);
Get<Ble::BleSecure>().NotifySendAdvertisements(mState == kStateActive || mState == kStateActiveTemporary);
}
void TcatAgent::HandleNotifierEvents(Events aEvents)
src/core/radio/ble_secure.cpp
+4 -6
View File
@@ -56,7 +56,7 @@ BleSecure::BleSecure(Instance &aInstance)
, mSendMessage(nullptr)
, mTransmitTask(aInstance)
, mBleState(kStopped)
, mBleAdvRequestedState(kAdvertising)
, mBleAdvRequestedState(kStopped)
, mMtuSize(kInitialMtuSize)
{
}
@@ -223,7 +223,7 @@ Error BleSecure::SetRequestedBleAdvertisementsState(void)
SuccessOrExit(error = otPlatBleGapAdvStart(&GetInstance(), OT_BLE_ADV_INTERVAL_DEFAULT));
mBleState = kAdvertising;
}
else if (mBleAdvRequestedState == kNotAdvertising && mBleState == kAdvertising)
else if (mBleAdvRequestedState != kAdvertising && mBleState == kAdvertising)
{
SuccessOrExit(error = otPlatBleGapAdvStop(&GetInstance()));
mBleState = kNotAdvertising;
@@ -398,14 +398,12 @@ void BleSecure::HandleBleDisconnected(uint16_t aConnectionId)
{
OT_UNUSED_VARIABLE(aConnectionId);
// kAdvertising is the state that the BLE stack will automatically assume, after a BLE client disconnects.
mBleState = kAdvertising;
mBleState = kNotAdvertising; // per otPlatBleGapAdvStart() API, advertising stopped already when client connected.
mMtuSize = kInitialMtuSize;
Disconnect(); // Stop TLS connection and update advertisement data
// if a different BLE advertising state was requested earlier while a BLE client was connected,
// then now's the time to fulfill the request.
// Resume advertising (or fulfill a different advertising state requested while a client was connected).
IgnoreError(SetRequestedBleAdvertisementsState());
}