blob: a16868ccb900ba530c3362da5bfd4c51528ca344 [file] [log] [blame]
* Copyright (c) 2021 Project CHIP Authors
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#pragma once
#include <lib/core/GroupId.h>
#include <lib/core/PasscodeId.h>
#include <cstdint>
namespace chip {
// TODO: Consider making this a class and the various utility methods static
// methods.
using NodeId = uint64_t;
constexpr NodeId kUndefinedNodeId = 0ULL;
// The range of possible NodeId values has some pieces carved out for special
// uses.
constexpr NodeId kMinGroupNodeId = 0xFFFF'FFFF'FFFF'0000ULL;
// The max group id is complicated, depending on how we want to count the
// various special group ids. Let's not define it for now, until we have use
// cases.
constexpr NodeId kMaskGroupId = 0x0000'0000'0000'FFFFULL;
constexpr NodeId kMinTemporaryLocalId = 0xFFFF'FFFE'0000'0000ULL;
// We use the largest available temporary local id to represent
// kPlaceholderNodeId, so the range is narrowed compared to the spec.
constexpr NodeId kMaxTemporaryLocalId = 0xFFFF'FFFE'FFFF'FFFEULL;
constexpr NodeId kPlaceholderNodeId = 0xFFFF'FFFE'FFFF'FFFFULL;
constexpr NodeId kMinCASEAuthTag = 0xFFFF'FFFD'0000'0000ULL;
constexpr NodeId kMaxCASEAuthTag = 0xFFFF'FFFD'FFFF'FFFFULL;
constexpr NodeId kMaskCASEAuthTag = 0x0000'0000'FFFF'FFFFULL;
constexpr NodeId kMinPAKEKeyId = 0xFFFF'FFFB'0000'0000ULL;
constexpr NodeId kMaxPAKEKeyId = 0xFFFF'FFFB'FFFF'FFFFULL;
constexpr NodeId kMaskPAKEKeyId = 0x0000'0000'0000'FFFFULL;
constexpr NodeId kMaskUnusedPAKEKeyId = 0x0000'0000'FFFF'0000ULL;
// There are more reserved ranges here, not assigned to anything yet, going down
// all the way to 0xFFFF'FFF0'0000'0000ULL
constexpr NodeId kMaxOperationalNodeId = 0xFFFF'FFEF'FFFF'FFFFULL;
constexpr bool IsOperationalNodeId(NodeId aNodeId)
return (aNodeId != kUndefinedNodeId) && (aNodeId <= kMaxOperationalNodeId);
constexpr bool IsGroupId(NodeId aNodeId)
return (aNodeId >= kMinGroupNodeId);
constexpr bool IsCASEAuthTag(NodeId aNodeId)
return (aNodeId >= kMinCASEAuthTag) && (aNodeId <= kMaxCASEAuthTag);
constexpr bool IsPAKEKeyId(NodeId aNodeId)
return (aNodeId >= kMinPAKEKeyId) && (aNodeId <= kMaxPAKEKeyId);
constexpr NodeId NodeIdFromGroupId(GroupId aGroupId)
return kMinGroupNodeId | aGroupId;
constexpr GroupId GroupIdFromNodeId(NodeId aNodeId)
return aNodeId & kMaskGroupId;
constexpr NodeId NodeIdFromPAKEKeyId(PasscodeId aPAKEKeyId)
return kMinPAKEKeyId | aPAKEKeyId;
constexpr PasscodeId PAKEKeyIdFromNodeId(NodeId aNodeId)
return aNodeId & kMaskPAKEKeyId;
} // namespace chip