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

Add OT APIs for manipulating the active and pending datasets. (#336)

Browse Source
This commit is contained in:
Jonathan Hui
2016-08-05 11:44:24 -07:00
committed by GitHub
parent 6587132ff2
commit b665529dac
9 changed files with 489 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread-types.h
+88 -18
View File
@@ -125,12 +125,51 @@ typedef enum ThreadError
kThreadError_Error = 255,
} ThreadError;
#define OT_IP6_IID_SIZE 8 ///< Size of an IPv6 Interface Identifier (bytes)
#define OT_EXT_ADDRESS_SIZE 8 ///< Size of an IEEE 802.15.4 Extended Address (bytes)
#define OT_EXT_PAN_ID_SIZE 8 ///< Size of a Thread PAN ID (bytes)
#define OT_NETWORK_NAME_SIZE 16 ///< Size of the Thread Network Name field (bytes)
#define OT_IP6_ADDRESS_SIZE 16 ///< Size of an IPv6 address (bytes)
#define OT_IP6_IID_SIZE 8 ///< Size of an IPv6 Interface Identifier (bytes)
#define OT_MASTER_KEY_SIZE 16 ///< Size of the Thread Master Key (bytes)
/**
* This structure represents a Thread Master Key.
*
*/
typedef struct otMasterKey
{
uint8_t m8[OT_MASTER_KEY_SIZE];
} otMasterKey;
#define OT_NETWORK_NAME_SIZE 16 ///< Size of the Thread Network Name field (bytes)
/**
* This structure represents a Network Name.
*
*/
typedef struct otNetworkName
{
char m8[OT_NETWORK_NAME_SIZE];
} otNetworkName;
#define OT_EXT_PAN_ID_SIZE 8 ///< Size of a Thread PAN ID (bytes)
/**
* This structure represents an Extended PAN ID.
*
*/
typedef struct otExtendedPanId
{
uint8_t m8[OT_EXT_PAN_ID_SIZE];
} otExtendedPanId;
#define OT_MESH_LOCAL_PREFIX_SIZE 8 ///< Size of the Mesh Local Prefix (bytes)
/**
* This structure represents a Mesh Local Prefix.
*
*/
typedef struct otMeshLocalPrefix
{
uint8_t m8[OT_MESH_LOCAL_PREFIX_SIZE];
} otMeshLocalPrefix;
/**
* This type represents the IEEE 802.15.4 PAN ID.
@@ -144,6 +183,8 @@ typedef uint16_t otPanId;
*/
typedef uint16_t otShortAddress;
#define OT_EXT_ADDRESS_SIZE 8 ///< Size of an IEEE 802.15.4 Extended Address (bytes)
/**
* This type represents the IEEE 802.15.4 Extended Address.
*
@@ -153,6 +194,21 @@ typedef struct otExtAddress
uint8_t m8[OT_EXT_ADDRESS_SIZE]; ///< IEEE 802.15.4 Extended Address bytes
} otExtAddress;
#define OT_IP6_ADDRESS_SIZE 16 ///< Size of an IPv6 address (bytes)
/**
* This structure represents an IPv6 address.
*/
typedef OT_TOOL_PACKED_BEGIN struct otIp6Address
{
union
{
uint8_t m8[OT_IP6_ADDRESS_SIZE]; ///< 8-bit fields
uint16_t m16[OT_IP6_ADDRESS_SIZE / sizeof(uint16_t)]; ///< 16-bit fields
uint32_t m32[OT_IP6_ADDRESS_SIZE / sizeof(uint32_t)]; ///< 32-bit fields
} mFields; ///< IPv6 accessor fields
} OT_TOOL_PACKED_END otIp6Address;
/**
* @addtogroup commands Commands
*
@@ -224,6 +280,33 @@ typedef struct otActiveScanResult
*
*/
/**
* This structure represents an Active or Pending Operational Dataset.
*
*/
typedef struct otOperationalDataset
{
uint64_t mActiveTimestamp; ///< Active Timestamp
uint64_t mPendingTimestamp; ///< Pending Timestamp
otMasterKey mMasterKey; ///< Network Master Key
otNetworkName mNetworkName; ///< Network Name
otExtendedPanId mExtendedPanId; ///< Extended PAN ID
otMeshLocalPrefix mMeshLocalPrefix; ///< Mesh Local Prefix
uint32_t mDelay; ///< Delay Timer
otPanId mPanId; ///< PAN ID
uint8_t mChannel; ///< Channel
bool mIsActiveTimestampSet : 1; ///< TRUE if Active Timestamp is set, FALSE otherwise.
bool mIsPendingTimestampSet : 1; ///< TRUE if Pending Timestamp is set, FALSE otherwise.
bool mIsMasterKeySet : 1; ///< TRUE if Network Master Key is set, FALSE otherwise.
bool mIsNetworkNameSet : 1; ///< TRUE if Network Name is set, FALSE otherwise.
bool mIsExtendedPanIdSet : 1; ///< TRUE if Extended PAN ID is set, FALSE otherwise.
bool mIsMeshLocalPrefixSet : 1; ///< TRUE if Mesh Local Prefix is set, FALSE otherwise.
bool mIsDelaySet : 1; ///< TRUE if Delay Timer is set, FALSE otherwise.
bool mIsPanIdSet : 1; ///< TRUE if PAN ID is set, FALSE otherwise.
bool mIsChannelSet : 1; ///< TRUE if Channel is set, FALSE otherwise.
} otOperationalDataset;
/**
* This structure represents an MLE Link Mode configuration.
*/
@@ -285,19 +368,6 @@ enum
*
*/
/**
* This structure represents an IPv6 address.
*/
typedef OT_TOOL_PACKED_BEGIN struct otIp6Address
{
union
{
uint8_t m8[OT_IP6_ADDRESS_SIZE]; ///< 8-bit fields
uint16_t m16[OT_IP6_ADDRESS_SIZE / sizeof(uint16_t)]; ///< 16-bit fields
uint32_t m32[OT_IP6_ADDRESS_SIZE / sizeof(uint32_t)]; ///< 32-bit fields
} mFields; ///< IPv6 accessor fields
} OT_TOOL_PACKED_END otIp6Address;
/**
* This structure represents an IPv6 prefix.
*/
include/openthread.h
+46
View File
@@ -584,6 +584,52 @@ typedef void (*otStateChangedCallback)(uint32_t aFlags, void *aContext);
*/
void otSetStateChangedCallback(otStateChangedCallback aCallback, void *aContext);
/**
* This function gets the Active Operational Dataset.
*
* @param[out] aDataset A pointer to where the Active Operational Dataset will be placed.
*
* @retval kThreadError_None Successfully retrieved the Active Operational Dataset.
* @retval kThreadError_InvalidArgs @p aDataset was NULL.
*
*/
ThreadError otGetActiveDataset(otOperationalDataset *aDataset);
/**
* This function sets the Active Operational Dataset.
*
* @param[in] aDataset A pointer to the Active Operational Dataset.
*
* @retval kThreadError_None Successfully set the Active Operational Dataset.
* @retval kThreadError_NoBufs Insufficient buffer space to set the Active Operational Datset.
* @retval kThreadError_InvalidArgs @p aDataset was NULL.
*
*/
ThreadError otSetActiveDataset(otOperationalDataset *aDataset);
/**
* This function gets the Pending Operational Dataset.
*
* @param[out] aDataset A pointer to where the Pending Operational Dataset will be placed.
*
* @retval kThreadError_None Successfully retrieved the Pending Operational Dataset.
* @retval kThreadError_InvalidArgs @p aDataset was NULL.
*
*/
ThreadError otGetPendingDataset(otOperationalDataset *aDataset);
/**
* This function sets the Pending Operational Dataset.
*
* @param[in] aDataset A pointer to the Pending Operational Dataset.
*
* @retval kThreadError_None Successfully set the Pending Operational Dataset.
* @retval kThreadError_NoBufs Insufficient buffer space to set the Pending Operational Datset.
* @retval kThreadError_InvalidArgs @p aDataset was NULL.
*
*/
ThreadError otSetPendingDataset(otOperationalDataset *aDataset);
/**
* @}
*/