[api] enable DIAG_GET request command into commissioner

This PR adds a DIAG_GET request command to the commissioner module, allowing users to request one or more diagnostic TLVs from a peer Thread device by setting the device's mesh local address and TLV mask bits flag. Supported Diagnostic TLVs ExtMacAddress Rloc16 Mode Route64 LeaderData Eui64 Ipv6Address ChildTable Test: config set pskc 445f2b5ca6f2a93a55ce570a70efeecb [done] start 192.168.9.2 49154 [done] diag get leaderdata { "DataVersion": 70, "PartitionId": 1612549395, "RouterId": 51, "StableDataVersion": 249, "Weighting": 64 } [done] diag get ipaddr { "Ipv6 Addresses": [ "fdce:bb1d:37f6:6978:0000:00ff:fe00:fc31", "fdce:bb1d:37f6:6978:0000:00ff:fe00:fc11", "fdce:bb1d:37f6:6978:0000:00ff:fe00:fc10", "fdce:bb1d:37f6:6978:0000:00ff:fe00:fc38", "fd11:0022:0000:0000:0eff:b88e:150d:6192", "fdce:bb1d:37f6:6978:0000:00ff:fe00:fc00", "fdce:bb1d:37f6:6978:0000:00ff:fe00:cc00", "fdce:bb1d:37f6:6978:6346:d247:62e8:7ba8", "fe80:0000:0000:0000:bcda:4117:61f5:6516" ] } [done] diag get rloc16 { "Rloc16": "0xcc00" } [done] diag get rloc16 fdce:bb1d:37f6:6978:0000:00ff:fe00:fc00 { "Rloc16": "0xcc00" } diag get route64 fdce:bb1d:37f6:6978:0000:00ff:fe00:cc00 { "IdSequence": 20, "Mask": "0000000000001000", "RouteData": [ "{\n \"IncommingLinkQuality\": 0,\n \"OutgoingLinkQuality\": 0,\n \"RouteCost\": 1,\n \"RouterId\": 51\n}" ] } [done]
openthread · Sep 30, 2024 · 3804aff · 3804aff
1 parent d1f713d
commit 3804aff
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 65 deletions.
diff --git a/include/commissioner/commissioner.hpp b/include/commissioner/commissioner.hpp
@@ -43,7 +43,7 @@
 #include <commissioner/defines.hpp>
 #include <commissioner/error.hpp>
 #include <commissioner/network_data.hpp>
-#include <commissioner/network_diagnostic_tlvs.hpp>
+#include <commissioner/network_diag_data.hpp>
 
 namespace ot {
 

diff --git a/.../commissioner/network_diagnostic_tlvs.hpp → include/commissioner/network_diag_data.hpp b/.../commissioner/network_diagnostic_tlvs.hpp → include/commissioner/network_diag_data.hpp
@@ -47,43 +47,6 @@ namespace ot {
 
 namespace commissioner {
 
-/**
- * @brief Enum representing the types of Network Diagnostic TLVs.
- */
-enum class NetworkDiagTlvType : uint8_t
-{
-    kNetworkDiagExtMacAddress           = 0,  ///< Extended MAC Address TLV
-    kNetworkDiagMacAddress              = 1,  ///< MAC Address TLV
-    kNetworkDiagMode                    = 2,  ///< Mode TLV
-    kNetworkDiagTimeout                 = 3,  ///< Timeout TLV
-    kNetworkDiagConnectivity            = 4,  ///< Connectivity TLV
-    kNetworkDiagRoute64                 = 5,  ///< Route64 TLV
-    kNetworkDiagLeaderData              = 6,  ///< Leader Data TLV
-    kNetworkDiagNetworkData             = 7,  ///< Network Data TLV
-    kNetworkDiagIpv6Address             = 8,  ///< IPv6 Address TLV
-    kNetworkDiagMacCounters             = 9,  ///< MAC Counters TLV
-    kNetworkDiagBatteryLevel            = 14, ///< Battery Level TLV
-    kNetworkDiagSupplyVoltage           = 15, ///< Supply Voltage TLV
-    kNetworkDiagChildTable              = 16, ///< Child Table TLV
-    kNetworkDiagChannelPages            = 17, ///< Channel Pages TLV
-    kNetworkDiagTypeList                = 18, ///< Type List TLV
-    kNetworkDiagMaxChildTimeout         = 19, ///< Max Child Timeout TLV
-    kNetworkDiagLDevIDSubjectPubKeyInfo = 20, ///< LDevID Subject Public Key Info TLV
-    kNetworkDiagIDevIDCert              = 21, ///< IDevID Certificate TLV
-    kNetworkDiagEui64                   = 23, ///< EUI-64 TLV
-    kNetworkDiagVersion                 = 24, ///< Version TLV
-    kNetworkDiagVendorName              = 25, ///< Vendor Name TLV
-    kNetworkDiagVendorModel             = 26, ///< Vendor Model TLV
-    kNetworkDiagVendorSWVersion         = 27, ///< Vendor Software Version TLV
-    kNetworkDiagThreadStackVersion      = 28, ///< Thread Stack Version TLV
-    kNetworkDiagChild                   = 29, ///< Child TLV
-    kNetworkDiagChildIpv6Address        = 30, ///< Child IPv6 Address TLV
-    kNetworkDiagRouterNeighbor          = 31, ///< Router Neighbor TLV
-    kNetworkDiagAnswer                  = 32, ///< Answer TLV
-    kNetworkDiagQueryID                 = 33, ///< Query ID TLV
-    kNetworkDiagMleCounters             = 34  ///< MLE Counters TLV
-};
-
 /**
  * @brief Mode TLV
  */
@@ -358,24 +321,17 @@ struct NetDiagTlvs
      */
     uint64_t mPresentFlags;
 
-    static constexpr uint64_t kExtMacAddressBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagExtMacAddress));
-    static constexpr uint64_t kMacAddressBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagMacAddress));
-    static constexpr uint64_t kModeBit    = (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagMode));
-    static constexpr uint64_t kRoute64Bit = (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagRoute64));
-    static constexpr uint64_t kLeaderDataBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagLeaderData));
-    static constexpr uint64_t kIpv6AddressBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagIpv6Address));
-    static constexpr uint64_t kChildTableBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagChildTable));
-    static constexpr uint64_t kEui64Bit   = (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagEui64));
-    static constexpr uint64_t kTlvTypeBit = (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagTypeList));
-    static constexpr uint64_t kMacCountersBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagMacCounters));
-    static constexpr uint64_t kChildIpv6AddressBit =
-        (1ull << static_cast<uint8_t>(NetworkDiagTlvType::kNetworkDiagChildIpv6Address));
+    static constexpr uint64_t kExtMacAddressBit    = (1ull << 63);
+    static constexpr uint64_t kMacAddressBit       = (1ull << 62);
+    static constexpr uint64_t kModeBit             = (1ull << 61);
+    static constexpr uint64_t kRoute64Bit          = (1ull << 60);
+    static constexpr uint64_t kLeaderDataBit       = (1ull << 59);
+    static constexpr uint64_t kIpv6AddressBit      = (1ull << 58);
+    static constexpr uint64_t kChildTableBit       = (1ull << 57);
+    static constexpr uint64_t kEui64Bit            = (1ull << 56);
+    static constexpr uint64_t kTlvTypeBit          = (1ull << 55);
+    static constexpr uint64_t kMacCountersBit      = (1ull << 54);
+    static constexpr uint64_t kChildIpv6AddressBit = (1ull << 53);
 };
 
 } // namespace commissioner

diff --git a/src/app/json.hpp b/src/app/json.hpp
@@ -40,7 +40,7 @@
 #include <commissioner/commissioner.hpp>
 #include <commissioner/error.hpp>
 #include <commissioner/network_data.hpp>
-#include <commissioner/network_diagnostic_tlvs.hpp>
+#include <commissioner/network_diag_data.hpp>
 
 #include "app/border_agent.hpp"
 #include "app/commissioner_app.hpp"

diff --git a/src/java/commissioner.i b/src/java/commissioner.i
@@ -40,7 +40,7 @@
 #include <commissioner/defines.hpp>
 #include <commissioner/error.hpp>
 #include <commissioner/network_data.hpp>
-#include <commissioner/network_diagnostic_tlvs.hpp>
+#include <commissioner/network_diag_data.hpp>
 #include <commissioner/commissioner.hpp>
 %}
 
@@ -194,6 +194,6 @@ namespace commissioner {
 %include <commissioner/defines.hpp>
 %include <commissioner/error.hpp>
 %include <commissioner/network_data.hpp>
-%include <commissioner/network_diagnostic_tlvs.hpp>
+%include <commissioner/network_diag_data.hpp>
 %include <commissioner/commissioner.hpp>
 %include <commissioner/commissioner.hpp>
diff --git a/src/library/CMakeLists.txt b/src/library/CMakeLists.txt
@@ -49,7 +49,7 @@ add_library(commissioner
     mbedtls_error.hpp
     message.hpp
     network_data.cpp
-    network_diagnostic_tlvs.cpp
+    network_diag_data.cpp
     openthread/bloom_filter.cpp
     openthread/bloom_filter.hpp
     openthread/crc16.cpp

diff --git a/src/library/commissioner_impl.cpp b/src/library/commissioner_impl.cpp
@@ -46,7 +46,7 @@
 #include "commissioner/defines.hpp"
 #include "commissioner/error.hpp"
 #include "commissioner/network_data.hpp"
-#include "commissioner/network_diagnostic_tlvs.hpp"
+#include "commissioner/network_diag_data.hpp"
 #include "common/address.hpp"
 #include "common/error_macros.hpp"
 #include "common/logging.hpp"

diff --git a/src/library/commissioner_impl.hpp b/src/library/commissioner_impl.hpp
@@ -40,7 +40,7 @@
 #include "commissioner/defines.hpp"
 #include "commissioner/error.hpp"
 #include "commissioner/network_data.hpp"
-#include "commissioner/network_diagnostic_tlvs.hpp"
+#include "commissioner/network_diag_data.hpp"
 #include "common/error_macros.hpp"
 #include "common/time.hpp"
 #include "event2/event.h"

diff --git a/src/library/commissioner_safe.cpp b/src/library/commissioner_safe.cpp
@@ -47,7 +47,7 @@
 #include "commissioner/defines.hpp"
 #include "commissioner/error.hpp"
 #include "commissioner/network_data.hpp"
-#include "commissioner/network_diagnostic_tlvs.hpp"
+#include "commissioner/network_diag_data.hpp"
 #include "common/error_macros.hpp"
 #include "common/logging.hpp"
 #include "common/utils.hpp"

diff --git a/src/library/commissioner_safe.hpp b/src/library/commissioner_safe.hpp
@@ -43,7 +43,7 @@
 
 #include "commissioner/defines.hpp"
 #include "commissioner/error.hpp"
-#include "commissioner/network_diagnostic_tlvs.hpp"
+#include "commissioner/network_diag_data.hpp"
 #include "library/coap.hpp"
 #include "library/coap_secure.hpp"
 #include "library/commissioner_impl.hpp"

diff --git a/src/library/network_diagnostic_tlvs.cpp → src/library/network_diag_data.cpp b/src/library/network_diagnostic_tlvs.cpp → src/library/network_diag_data.cpp
@@ -26,7 +26,7 @@
  *    POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include "commissioner/network_diagnostic_tlvs.hpp"
+#include "commissioner/network_diag_data.hpp"
 #include <cstddef>
 #include <cstdint>
 #include <string>