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

[meshcop] MeshCoP::ChannelTlv to utilize Mle::ChannelTlvValue (#9674)

Browse Source 
This commit introduces `IsValid()` and `SetChannelAndPage()` methods
to `Mle::ChannelTlvValue`, enabling its use as value of
`MeshCoP::ChannelTlv`.
This commit is contained in:
Abtin Keshavarzian
2023-12-04 08:22:47 -08:00
committed by GitHub
parent b78b71b537
commit c378bd9a25
6 changed files with 86 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/meshcop/dataset.cpp
+6 -6
View File
@@ -194,7 +194,7 @@ void Dataset::ConvertTo(Info &aDatasetInfo) const
break;
case Tlv::kChannel:
aDatasetInfo.SetChannel(As<ChannelTlv>(cur)->GetChannel());
aDatasetInfo.SetChannel(cur->ReadValueAs<ChannelTlv>().GetChannel());
break;
case Tlv::kChannelMask:
@@ -304,10 +304,10 @@ Error Dataset::SetFrom(const Info &aDatasetInfo)
if (aDatasetInfo.IsChannelPresent())
{
ChannelTlv tlv;
tlv.Init();
tlv.SetChannel(aDatasetInfo.GetChannel());
IgnoreError(WriteTlv(tlv));
ChannelTlvValue channelValue;
channelValue.SetChannelAndPage(aDatasetInfo.GetChannel());
IgnoreError(Write<ChannelTlv>(channelValue));
}
if (aDatasetInfo.IsChannelMaskPresent())
@@ -527,7 +527,7 @@ Error Dataset::ApplyConfiguration(Instance &aInstance, bool *aIsNetworkKeyUpdate
{
case Tlv::kChannel:
{
uint8_t channel = static_cast<uint8_t>(As<ChannelTlv>(cur)->GetChannel());
uint8_t channel = static_cast<uint8_t>(cur->ReadValueAs<ChannelTlv>().GetChannel());
error = mac.SetPanChannel(channel);
src/core/meshcop/dataset_manager_ftd.cpp
+8 -9
View File
@@ -82,7 +82,7 @@ Error DatasetManager::HandleSet(Coap::Message &aMessage, const Ip6::MessageInfo
StateTlv::State state = StateTlv::kReject;
Dataset dataset;
Timestamp activeTimestamp;
ChannelTlv channel;
ChannelTlvValue channelValue;
uint16_t sessionId;
Ip6::NetworkPrefix meshLocalPrefix;
NetworkKey networkKey;
@@ -116,12 +116,11 @@ Error DatasetManager::HandleSet(Coap::Message &aMessage, const Ip6::MessageInfo
VerifyOrExit(Timestamp::Compare(&activeTimestamp, mLocal.GetTimestamp()) > 0);
}
// check channel
if (Tlv::FindTlv(aMessage, channel) == kErrorNone)
if (Tlv::Find<ChannelTlv>(aMessage, channelValue) == kErrorNone)
{
VerifyOrExit(channel.IsValid());
VerifyOrExit(channelValue.IsValid());
if (channel.GetChannel() != Get<Mac::Mac>().GetPanChannel())
if (channelValue.GetChannel() != Get<Mac::Mac>().GetPanChannel())
{
doesAffectConnectivity = true;
}
@@ -312,10 +311,10 @@ Error ActiveDatasetManager::GenerateLocal(void)
if (!dataset.Contains<ChannelTlv>())
{
ChannelTlv tlv;
tlv.Init();
tlv.SetChannel(Get<Mac::Mac>().GetPanChannel());
IgnoreError(dataset.WriteTlv(tlv));
ChannelTlvValue channelValue;
channelValue.SetChannelAndPage(Get<Mac::Mac>().GetPanChannel());
IgnoreError(dataset.Write<ChannelTlv>(channelValue));
}
if (!dataset.Contains<ChannelMaskTlv>())
src/core/meshcop/meshcop_tlvs.cpp
+3 -47
View File
@@ -65,9 +65,9 @@ bool Tlv::IsValid(const Tlv &aTlv)
case Tlv::kMeshLocalPrefix:
minLength = sizeof(MeshLocalPrefixTlv::ValueType);
break;
case Tlv::kChannel:
isValid = As<ChannelTlv>(aTlv).IsValid();
VerifyOrExit(aTlv.GetLength() >= sizeof(ChannelTlvValue), isValid = false);
isValid = aTlv.ReadValueAs<ChannelTlv>().IsValid();
break;
case Tlv::kNetworkName:
isValid = As<NetworkNameTlv>(aTlv).IsValid();
@@ -90,6 +90,7 @@ bool Tlv::IsValid(const Tlv &aTlv)
isValid = (aTlv.GetLength() >= minLength);
}
exit:
return isValid;
}
@@ -143,51 +144,6 @@ void SecurityPolicyTlv::SetSecurityPolicy(const SecurityPolicy &aSecurityPolicy)
aSecurityPolicy.GetFlags(mFlags, sizeof(mFlags));
}
bool ChannelTlv::IsValid(void) const
{
bool ret = false;
VerifyOrExit(GetLength() == sizeof(*this) - sizeof(Tlv));
VerifyOrExit(mChannelPage < BitSizeOf(uint32_t));
VerifyOrExit((1U << mChannelPage) & Radio::kSupportedChannelPages);
VerifyOrExit(Radio::kChannelMin <= GetChannel() && GetChannel() <= Radio::kChannelMax);
ret = true;
exit:
return ret;
}
void ChannelTlv::SetChannel(uint16_t aChannel)
{
uint8_t channelPage = OT_RADIO_CHANNEL_PAGE_0;
#if OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT
if ((OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN <= aChannel) && (aChannel <= OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX))
{
channelPage = OT_RADIO_CHANNEL_PAGE_0;
}
#endif
#if OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT
if ((OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN <= aChannel) && (aChannel <= OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX))
{
channelPage = OT_RADIO_CHANNEL_PAGE_2;
}
#endif
#if OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT
if ((OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MIN == aChannel) ||
((OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MIN < aChannel) &&
(aChannel <= OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MAX)))
{
channelPage = OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_PAGE;
}
#endif
SetChannelPage(channelPage);
mChannel = BigEndian::HostSwap16(aChannel);
}
const char *StateTlv::StateToString(State aState)
{
static const char *const kStateStrings[] = {
src/core/meshcop/meshcop_tlvs.hpp
+9 -61
View File
@@ -54,6 +54,7 @@
#include "net/ip6_address.hpp"
#include "radio/radio.hpp"
#include "thread/key_manager.hpp"
#include "thread/mle_tlvs.hpp"
#include "thread/mle_types.hpp"
namespace ot {
@@ -245,75 +246,22 @@ typedef UintTlvInfo<Tlv::kPeriod, uint16_t> PeriodTlv;
typedef UintTlvInfo<Tlv::kScanDuration, uint16_t> ScanDurationTlv;
/**
* Defines Commissioner ID TLV constants and type.s
* Defines Commissioner ID TLV constants and types.
*
*/
typedef StringTlvInfo<Tlv::kCommissionerId, Tlv::kMaxCommissionerIdLength> CommissionerIdTlv;
/**
* Implements Channel TLV generation and parsing.
* Implements Channel TLV value format.
*
*/
OT_TOOL_PACKED_BEGIN
class ChannelTlv : public Tlv, public TlvInfo<Tlv::kChannel>
{
public:
/**
* Initializes the TLV.
*
*/
void Init(void)
{
SetType(kChannel);
SetLength(sizeof(*this) - sizeof(Tlv));
}
typedef Mle::ChannelTlvValue ChannelTlvValue;
/**
* Indicates whether or not the TLV appears to be well-formed.
*
* @retval TRUE If the TLV appears to be well-formed.
* @retval FALSE If the TLV does not appear to be well-formed.
*
*/
bool IsValid(void) const;
/**
* Returns the ChannelPage value.
*
* @returns The ChannelPage value.
*
*/
uint8_t GetChannelPage(void) const { return mChannelPage; }
/**
* Sets the ChannelPage value.
*
* @param[in] aChannelPage The ChannelPage value.
*
*/
void SetChannelPage(uint8_t aChannelPage) { mChannelPage = aChannelPage; }
/**
* Returns the Channel value.
*
* @returns The Channel value.
*
*/
uint16_t GetChannel(void) const { return BigEndian::HostSwap16(mChannel); }
/**
* Sets the Channel value.
* Note: This method also sets the channel page according to the channel value.
*
* @param[in] aChannel The Channel value.
*
*/
void SetChannel(uint16_t aChannel);
private:
uint8_t mChannelPage;
uint16_t mChannel;
} OT_TOOL_PACKED_END;
/**
* Defines Channel TLV constants and types.
*
*/
typedef SimpleTlvInfo<Tlv::kChannel, ChannelTlvValue> ChannelTlv;
/**
* Defines PAN ID TLV constants and types.
src/core/thread/mle_tlvs.cpp
+43
View File
@@ -34,6 +34,8 @@
#include "mle_tlvs.hpp"
#include "common/code_utils.hpp"
#include "common/numeric_limits.hpp"
#include "radio/radio.hpp"
namespace ot {
namespace Mle {
@@ -94,5 +96,46 @@ void ConnectivityTlv::SetParentPriority(int8_t aParentPriority)
mFlags = static_cast<uint8_t>(Preference::To2BitUint(aParentPriority) << kFlagsParentPriorityOffset);
}
void ChannelTlvValue::SetChannelAndPage(uint16_t aChannel)
{
uint8_t channelPage = OT_RADIO_CHANNEL_PAGE_0;
#if OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT
if ((OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN <= aChannel) && (aChannel <= OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX))
{
channelPage = OT_RADIO_CHANNEL_PAGE_2;
}
#endif
#if OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT
if ((OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MIN == aChannel) ||
((OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MIN < aChannel) &&
(aChannel <= OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MAX)))
{
channelPage = OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_PAGE;
}
#endif
SetChannelPage(channelPage);
SetChannel(aChannel);
}
bool ChannelTlvValue::IsValid(void) const
{
bool isValid = false;
uint16_t channel;
VerifyOrExit(mChannelPage < BitSizeOf(uint32_t));
VerifyOrExit((1U << mChannelPage) & Radio::kSupportedChannelPages);
channel = GetChannel();
VerifyOrExit((Radio::kChannelMin <= channel) && (channel <= Radio::kChannelMax));
isValid = true;
exit:
return isValid;
}
} // namespace Mle
} // namespace ot
src/core/thread/mle_tlvs.hpp
+17
View File
@@ -1096,6 +1096,23 @@ public:
*/
void SetChannel(uint16_t aChannel) { mChannel = BigEndian::HostSwap16(aChannel); }
/**
* Sets the Channel and determines and sets the Channel Page from the given channel.
*
* @param[in] aChannel The Channel value.
*
*/
void SetChannelAndPage(uint16_t aChannel);
/**
* Indicates whether or not the Channel and Channel Page values are valid.
*
* @retval TRUE If the Channel and Channel Page values are valid.
* @retval FALSE If the Channel and Channel Page values are not valid.
*
*/
bool IsValid(void) const;
private:
uint8_t mChannelPage;
uint16_t mChannel;