Skip to content

Commit 2d602dc

Browse files
EskoDijkjwhui
authored andcommitted
[ble] update BLE API docs to make platform's BLE advertising explicit (openthread#12913)
Also, changes term 'method' to correct term 'function'.
1 parent baaf93a commit 2d602dc

2 files changed

Lines changed: 8 additions & 7 deletions

File tree

include/openthread/instance.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ extern "C" {
5252
*
5353
* @note This number versions both OpenThread platform and user APIs.
5454
*/
55-
#define OPENTHREAD_API_VERSION (603)
55+
#define OPENTHREAD_API_VERSION (604)
5656

5757
/**
5858
* @addtogroup api-instance

include/openthread/platform/ble.h

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -257,17 +257,18 @@ otError otPlatBleGapAdvStart(otInstance *aInstance, uint16_t aInterval);
257257
otError otPlatBleGapAdvStop(otInstance *aInstance);
258258

259259
/**
260-
* The BLE driver calls this method to notify OpenThread that a BLE Central Device has
261-
* been connected.
260+
* The BLE driver calls this function to notify OpenThread that a BLE Central Device has
261+
* been connected. The BLE driver MUST stop advertising before calling this function.
262262
*
263263
* @param[in] aInstance The OpenThread instance structure.
264264
* @param[in] aConnectionId The identifier of the open connection.
265265
*/
266266
extern void otPlatBleGapOnConnected(otInstance *aInstance, uint16_t aConnectionId);
267267

268268
/**
269-
* The BLE driver calls this method to notify OpenThread that the BLE Central Device
270-
* has been disconnected.
269+
* The BLE driver calls this function to notify OpenThread that the BLE Central Device
270+
* has been disconnected. The BLE driver MUST NOT start advertising before or after this
271+
* call: this is controlled explicitly via otPlatBleGapAdvStart().
271272
*
272273
* @param[in] aInstance The OpenThread instance structure.
273274
* @param[in] aConnectionId The identifier of the closed connection.
@@ -307,7 +308,7 @@ otError otPlatBleGapDisconnect(otInstance *aInstance);
307308
otError otPlatBleGattMtuGet(otInstance *aInstance, uint16_t *aMtu);
308309

309310
/**
310-
* The BLE driver calls this method to notify OpenThread that ATT_MTU has been updated.
311+
* The BLE driver calls this function to notify OpenThread that ATT_MTU has been updated.
311312
*
312313
* @param[in] aInstance The OpenThread instance structure.
313314
* @param[in] aMtu The updated ATT_MTU value. It MUST be >=OT_BLE_ATT_MTU_MIN.
@@ -335,7 +336,7 @@ extern void otPlatBleGattOnMtuUpdate(otInstance *aInstance, uint16_t aMtu);
335336
otError otPlatBleGattServerIndicate(otInstance *aInstance, uint16_t aHandle, const otBleRadioPacket *aPacket);
336337

337338
/**
338-
* The BLE driver calls this method to notify OpenThread that an ATT Write Request
339+
* The BLE driver calls this function to notify OpenThread that an ATT Write Request
339340
* packet has been received.
340341
*
341342
* @note This function shall be used only for GATT Server.

0 commit comments

Comments
 (0)