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

[link-raw] set receive done callback when enabled (#5108)

Browse Source
This commit is contained in:
Yakun Xu
2020-06-17 14:42:39 -07:00
committed by GitHub
parent f5d7f50f44
commit 3b362071e5
10 changed files with 154 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (6)
#define OPENTHREAD_API_VERSION (7)
/**
* @addtogroup api-instance
include/openthread/link_raw.h
+17 -16
View File
@@ -51,17 +51,30 @@ extern "C" {
*
*/
/**
* This function pointer on receipt of a IEEE 802.15.4 frame.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aFrame A pointer to the received frame or NULL if the receive operation was aborted.
* @param[in] aError OT_ERROR_NONE when successfully received a frame.
* OT_ERROR_ABORT when reception was aborted and a frame was not received.
*
*/
typedef void (*otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError);
/**
* This function enables/disables the raw link-layer.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnabled TRUE to enable raw link-layer, FALSE otherwise.
* @param[in] aCallback A pointer to a function called on receipt of a IEEE 802.15.4 frame. NULL to disable the
* raw-link layer.
*
* @retval OT_ERROR_NONE If the enable state was successfully set.
* @retval OT_ERROR_FAILED The radio could not be enabled/disabled.
* @retval OT_ERROR_INVALID_STATE If the OpenThread Ip6 interface is already enabled.
* @retval OT_ERROR_NONE If the enable state was successfully set.
*
*/
otError otLinkRawSetEnable(otInstance *aInstance, bool aEnabled);
otError otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCallback);
/**
* This function indicates whether or not the raw link-layer is enabled.
@@ -122,29 +135,17 @@ otError otLinkRawSetShortAddress(otInstance *aInstance, uint16_t aShortAddress);
*/
otError otLinkRawSleep(otInstance *aInstance);
/**
* This function pointer on receipt of a IEEE 802.15.4 frame.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aFrame A pointer to the received frame or NULL if the receive operation was aborted.
* @param[in] aError OT_ERROR_NONE when successfully received a frame.
* OT_ERROR_ABORT when reception was aborted and a frame was not received.
*
*/
typedef void (*otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError);
/**
* Transitioning the radio from Sleep to Receive.
* Turn on the radio.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aCallback A pointer to a function called on receipt of a IEEE 802.15.4 frame.
*
* @retval OT_ERROR_NONE Successfully transitioned to Receive.
* @retval OT_ERROR_INVALID_STATE The radio was disabled or transmitting.
*
*/
otError otLinkRawReceive(otInstance *aInstance, otLinkRawReceiveDone aCallback);
otError otLinkRawReceive(otInstance *aInstance);
/**
* The radio transitions from Transmit to Receive.