mirror of
https://github.com/espressif/openthread.git
synced 2026-06-06 05:24:51 +00:00
Marcin K Szczodrak
380 lines
9.5 KiB
C
380 lines
9.5 KiB
C
/*
|
|
* Copyright (c) 2016, Nest Labs, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief
|
|
* This file defines the types and structures used in the OpenThread library API.
|
|
*/
|
|
|
|
#ifndef OPENTHREAD_TYPES_H_
|
|
#define OPENTHREAD_TYPES_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* This enumeration represents error codes used throughout OpenThread.
|
|
*/
|
|
typedef enum ThreadError
|
|
{
|
|
kThreadError_None = 0,
|
|
kThreadError_Failed = 1,
|
|
kThreadError_Drop = 2,
|
|
kThreadError_NoBufs = 3,
|
|
kThreadError_NoRoute = 4,
|
|
kThreadError_Busy = 5,
|
|
kThreadError_Parse = 6,
|
|
kThreadError_InvalidArgs = 7,
|
|
kThreadError_Security = 8,
|
|
kThreadError_AddressQuery = 9,
|
|
kThreadError_NoAddress = 10,
|
|
kThreadError_NotReceiving = 11,
|
|
kThreadError_Abort = 12,
|
|
kThreadError_NotImplemented = 13,
|
|
kThreadError_InvalidState = 14,
|
|
kThreadError_NoTasklets = 15,
|
|
kThreadError_Error = 255,
|
|
} ThreadError;
|
|
|
|
/**
|
|
* @addtogroup config Configuration
|
|
*
|
|
* @brief
|
|
* This module includes functions for configuration.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @defgroup config-general General
|
|
*
|
|
* @brief
|
|
* This module includes functions that manage configuration parameters for the Thread Child, Router, and Leader rols.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
#define OT_NETWORK_NAME_SIZE 16 ///< Network name size (bytes).
|
|
|
|
/**
|
|
* This structure represents an MLE Link Mode configuration.
|
|
*/
|
|
typedef struct otLinkModeConfig
|
|
{
|
|
/**
|
|
* 1, if the sender has its receiver on when not transmitting. 0, otherwise.
|
|
*/
|
|
uint8_t mRxOnWhenIdle : 1;
|
|
|
|
/**
|
|
* 1, if the sender will use IEEE 802.15.4 to secure all data requests. 0, otherwise.
|
|
*/
|
|
uint8_t mSecureDataRequests : 1;
|
|
|
|
/**
|
|
* 1, if the sender is an FFD. 0, otherwise.
|
|
*/
|
|
uint8_t mDeviceType : 1;
|
|
|
|
/**
|
|
* 1, if the sender requires the full Network Data. 0, otherwise.
|
|
*/
|
|
uint8_t mNetworkData : 1;
|
|
} otLinkModeConfig;
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @defgroup config-br Border Router
|
|
*
|
|
* @brief
|
|
* This module includes functions that manage configuration parameters that apply to the Thread Border Router role.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
enum
|
|
{
|
|
kIp6AddressSize = 16,
|
|
};
|
|
|
|
/**
|
|
* This structure represents an IPv6 address.
|
|
*/
|
|
typedef struct otIp6Address
|
|
{
|
|
union
|
|
{
|
|
uint8_t m8[kIp6AddressSize];
|
|
uint16_t m16[kIp6AddressSize / sizeof(uint16_t)];
|
|
uint32_t m32[kIp6AddressSize / sizeof(uint32_t)];
|
|
};
|
|
} __attribute__((packed)) otIp6Address;
|
|
|
|
/**
|
|
* This structure represents an IPv6 prefix.
|
|
*/
|
|
typedef struct otIp6Prefix
|
|
{
|
|
otIp6Address mPrefix; ///< The IPv6 prefix.
|
|
uint8_t mLength; ///< The IPv6 prefix length.
|
|
} otIp6Prefix;
|
|
|
|
/**
|
|
* This structure represents a Border Router configuration.
|
|
*/
|
|
typedef struct otBorderRouterConfig
|
|
{
|
|
/**
|
|
* TRUE, if this border router is a DHCPv6 Agent that supplies other configuration data. FALSE, otherwise.
|
|
*/
|
|
otIp6Prefix mPrefix;
|
|
|
|
/**
|
|
* A 2-bit signed integer indicating router preference as defined in RFC 4291.
|
|
*/
|
|
int8_t mPreference : 2;
|
|
|
|
/**
|
|
* TRUE, if @p mPrefix is preferred and should e used for address autoconfiguration. FALSE, otherwise.
|
|
*/
|
|
uint8_t mSlaacPreferred : 1;
|
|
|
|
/**
|
|
* TRUE, if @p mPrefix is valid and should be used for address autoconfiguration. FALSE, otherwise.
|
|
*/
|
|
uint8_t mSlaacValid : 1;
|
|
|
|
/**
|
|
* TRUE, if this border router is a DHCPv6 Agent that supplies IPv6 address configuration. FALSE, otherwise.
|
|
*/
|
|
uint8_t mDhcp : 1;
|
|
|
|
/**
|
|
* TRUE, if this border router is a DHCPv6 Agent that supplies other configuration data. FALSE, otherwise.
|
|
*/
|
|
uint8_t mConfigure : 1;
|
|
|
|
/**
|
|
* TRUE, if this border router is a default route for @p mPrefix. FALSE, otherwise.
|
|
*/
|
|
uint8_t mDefaultRoute : 1;
|
|
|
|
/**
|
|
* TRUE, if this configuration is considered Stable Network Data. FALSE, otherwise.
|
|
*/
|
|
uint8_t mStable : 1;
|
|
} otBorderRouterConfig;
|
|
|
|
/**
|
|
* This structure represents an External Route configuration.
|
|
*/
|
|
typedef struct otExternalRouteConfig
|
|
{
|
|
/**
|
|
* The prefix for the off-mesh route.
|
|
*/
|
|
otIp6Prefix mPrefix;
|
|
|
|
/**
|
|
* A 2-bit signed integer indicating router preference as defined in RFC 4291.
|
|
*/
|
|
int8_t mPreference : 2;
|
|
|
|
/**
|
|
* TRUE, if this configuration is considered Stable Network Data. FALSE, otherwise.
|
|
*/
|
|
uint8_t mStable : 1;
|
|
} otExternalRouteConfig;
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @defgroup config-test Test
|
|
*
|
|
* @brief
|
|
* This module includes functions that manage configuration parameters required for Thread Certification testing.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Represents any restrictions on the attach process.
|
|
*/
|
|
typedef enum otMleAttachFilter
|
|
{
|
|
kMleAttachAnyPartition = 0, ///< Attach to any Thread partition.
|
|
kMleAttachSamePartition = 1, ///< Attach to the same Thread partition.
|
|
kMleAttachBetterPartition = 2, ///< Attach to a better (i.e. higher weight/partition id) Thread partition.
|
|
} otMleAttachFilter;
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup diags Diagnostics
|
|
*
|
|
* @brief
|
|
* This module includes functions that expose internal state.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Represents a Thread device role.
|
|
*/
|
|
enum otDeviceRole
|
|
{
|
|
kDeviceRoleDisabled, ///< The Thread stack is disabled.
|
|
kDeviceRoleDetached, ///< Not currently participating in a Thread network/partition.
|
|
kDeviceRoleChild, ///< The Thread Child role.
|
|
kDeviceRoleRouter, ///< The Thread Router role.
|
|
kDeviceRoleLeader, ///< The Thread Leader role.
|
|
};
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* This structure represents an IPv6 network interface address.
|
|
*
|
|
*/
|
|
typedef struct otNetifAddress
|
|
{
|
|
otIp6Address mAddress; ///< The IPv6 address.
|
|
uint32_t mPreferredLifetime; ///< The Preferred Lifetime.
|
|
uint32_t mValidLifetime; ///< The Valid lifetime.
|
|
uint8_t mPrefixLength; ///< The Prefix length.
|
|
struct otNetifAddress *mNext; ///< A pointer to the next network interface address.
|
|
} otNetifAddress;
|
|
|
|
/**
|
|
* @addtogroup messages Message Buffers
|
|
*
|
|
* @brief
|
|
* This module includes functions that manipulate OpenThread message buffers
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* This type points to an OpenThread message buffer.
|
|
*/
|
|
typedef void *otMessage;
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup udp UDP
|
|
*
|
|
* @brief
|
|
* This module includes functions that control UDP communication.
|
|
*
|
|
* @{
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* This structure represents an IPv6 socket address.
|
|
*/
|
|
typedef struct otSockAddr
|
|
{
|
|
otIp6Address mAddress; ///< An IPv6 address.
|
|
uint16_t mPort; ///< A transport-layer port.
|
|
uint8_t mScopeId; ///< An IPv6 scope identifier.
|
|
} otSockAddr;
|
|
|
|
/**
|
|
* This structure represents the local and peer IPv6 socket addresses.
|
|
*/
|
|
typedef struct otMessageInfo
|
|
{
|
|
otIp6Address mSockAddr; ///< The local IPv6 address.
|
|
otIp6Address mPeerAddr; ///< The peer IPv6 address.
|
|
uint16_t mSockPort; ///< The local transport-layer port.
|
|
uint16_t mPeerPort; ///< The peer transport-layer port.
|
|
uint8_t mInterfaceId; ///< An IPv6 interface identifier.
|
|
uint8_t mHopLimit; ///< The IPv6 Hop Limit.
|
|
const void *mLinkInfo; ///< A pointer to link-specific information.
|
|
} otMessageInfo;
|
|
|
|
/**
|
|
* This callback allows OpenThread to inform the application of a received UDP message.
|
|
*/
|
|
typedef void (*otUdpReceive)(void *aContext, otMessage aMessage, const otMessageInfo *aMessageInfo);
|
|
|
|
/**
|
|
* This structure represents a UDP socket.
|
|
*/
|
|
typedef struct otUdpSocket
|
|
{
|
|
otSockAddr mSockName; ///< The local IPv6 socket address.
|
|
otSockAddr mPeerName; ///< The peer IPv6 socket address.
|
|
otUdpReceive mHandler; ///< A function pointer to the application callback.
|
|
void *mContext; ///< A pointer to application-specific context.
|
|
struct otUdpSocket *mNext; ///< A pointer to the next UDP socket.
|
|
} otUdpSocket;
|
|
|
|
/**
|
|
* @}
|
|
*
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // OPENTHREAD_TYPES_H_
|