Skip to content

Commit 368b9a0

Browse files
andy31415andreilitvin
andy31415
and
andreilitvin
authored
Match Wake On LAN Cluster to spec (#30214)
* Add Link local address to wake on lan cluster * zap regen * Fix up wake-on-lan implementation to match spec * zap regen * minor change to kick CI * minor change - fix the revision attribute * restyle * Fix openiot test * Make link local address provisional * Return an error instead of static_assert * Restyle * Remove openthread from linux builds of the tv app * Added prefix for CLUSTER_REVISION_ID --------- Co-authored-by: Andrei Litvin <andreilitvin@google.com>
1 parent 155917e commit 368b9a0

File tree

31 files changed

+346
-21
lines changed

31 files changed

+346
-21
lines changed

‎examples/all-clusters-app/all-clusters-common/all-clusters-app.matter

+1-1
Original file line numberDiff line numberDiff line change
@@ -4768,7 +4768,7 @@ server cluster RadonConcentrationMeasurement = 1071 {
47684768

47694769
/** This cluster provides an interface for managing low power mode on a device that supports the Wake On LAN protocol. */
47704770
server cluster WakeOnLan = 1283 {
4771-
readonly attribute char_string<32> MACAddress = 0;
4771+
readonly attribute char_string<12> MACAddress = 0;
47724772
readonly attribute command_id generatedCommandList[] = 65528;
47734773
readonly attribute command_id acceptedCommandList[] = 65529;
47744774
readonly attribute event_id eventList[] = 65530;

‎examples/tv-app/linux/args.gni

+3
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,6 @@ chip_enable_additional_data_advertising = true
3131
chip_enable_rotating_device_id = true
3232

3333
matter_enable_tracing_support = true
34+
35+
# Thread devices do not support WakeOnLan because their mac address is >48bit
36+
chip_enable_openthread = false

‎examples/tv-app/tv-common/clusters/wake-on-lan/WakeOnLanManager.cpp

+12-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
#include <platform/ConfigurationManager.h>
2424
#include <string>
2525

26+
constexpr const char * kNullHexMACAddress = "000000000000";
27+
2628
using namespace chip;
2729
using namespace chip::app::Clusters::WakeOnLan;
2830

@@ -33,15 +35,15 @@ std::string getMacAddress()
3335
if (chip::DeviceLayer::ConfigurationMgr().GetPrimaryMACAddress(mac) != CHIP_NO_ERROR)
3436
{
3537
ChipLogProgress(Zcl, "WakeOnLanManager::getMacAddress no primary MAC configured by DeviceLayer");
36-
return "0000000000";
38+
return kNullHexMACAddress;
3739
}
3840

3941
char macStr[chip::DeviceLayer::ConfigurationManager::kPrimaryMACAddressLength * 2 + 1] = { 0 }; // added null char
4042
if (BytesToHex(&macBuffer[0], sizeof(macBuffer), &macStr[0], sizeof(macBuffer) * 2u, chip::Encoding::HexFlags::kUppercase) !=
4143
CHIP_NO_ERROR)
4244
{
4345
ChipLogProgress(Zcl, "WakeOnLanManager::getMacAddress hex conversion failed");
44-
return "0000000000";
46+
return kNullHexMACAddress;
4547
}
4648

4749
return std::string(macStr);
@@ -51,5 +53,13 @@ CHIP_ERROR WakeOnLanManager::HandleGetMacAddress(chip::app::AttributeValueEncode
5153
{
5254
ChipLogProgress(Zcl, "WakeOnLanManager::HandleGetMacAddress");
5355

56+
// Spec REQUIRES 48-bit mac addresses. This means at least Thread devices will
57+
// fail here.
58+
if (chip::DeviceLayer::ConfigurationManager::kPrimaryMACAddressLength != 6)
59+
{
60+
ChipLogError(Zcl, "WakeOnLanManager: primary MAC address is not 48-bit");
61+
return CHIP_ERROR_BUFFER_TOO_SMALL;
62+
}
63+
5464
return aEncoder.Encode(CharSpan::fromCharString(getMacAddress().c_str()));
5565
}

‎examples/tv-app/tv-common/tv-app.matter

+1-1
Original file line numberDiff line numberDiff line change
@@ -1828,7 +1828,7 @@ server cluster RelativeHumidityMeasurement = 1029 {
18281828

18291829
/** This cluster provides an interface for managing low power mode on a device that supports the Wake On LAN protocol. */
18301830
server cluster WakeOnLan = 1283 {
1831-
readonly attribute char_string<32> MACAddress = 0;
1831+
readonly attribute char_string<12> MACAddress = 0;
18321832
readonly attribute command_id generatedCommandList[] = 65528;
18331833
readonly attribute command_id acceptedCommandList[] = 65529;
18341834
readonly attribute event_id eventList[] = 65530;

‎examples/tv-casting-app/tv-casting-common/tv-casting-app.matter

+2-1
Original file line numberDiff line numberDiff line change
@@ -1347,7 +1347,8 @@ server cluster FixedLabel = 64 {
13471347

13481348
/** This cluster provides an interface for managing low power mode on a device that supports the Wake On LAN protocol. */
13491349
client cluster WakeOnLan = 1283 {
1350-
readonly attribute optional char_string<32> MACAddress = 0;
1350+
readonly attribute optional char_string<12> MACAddress = 0;
1351+
readonly attribute optional octet_string<16> linkLocalAddress = 1;
13511352
readonly attribute command_id generatedCommandList[] = 65528;
13521353
readonly attribute command_id acceptedCommandList[] = 65529;
13531354
readonly attribute event_id eventList[] = 65530;

‎scripts/tools/zap/tests/outputs/all-clusters-app/app-templates/endpoint_config.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -1182,7 +1182,7 @@
11821182
{ ZAP_SIMPLE_DEFAULT(3), 0x0000FFFD, 2, ZAP_TYPE(INT16U), 0 }, /* ClusterRevision */ \
11831183
\
11841184
/* Endpoint: 1, Cluster: Wake on LAN (server) */ \
1185-
{ ZAP_EMPTY_DEFAULT(), 0x00000000, 33, ZAP_TYPE(CHAR_STRING), 0 }, /* MACAddress */ \
1185+
{ ZAP_EMPTY_DEFAULT(), 0x00000000, 13, ZAP_TYPE(CHAR_STRING), 0 }, /* MACAddress */ \
11861186
{ ZAP_SIMPLE_DEFAULT(0), 0x0000FFFC, 4, ZAP_TYPE(BITMAP32), 0 }, /* FeatureMap */ \
11871187
{ ZAP_SIMPLE_DEFAULT(1), 0x0000FFFD, 2, ZAP_TYPE(INT16U), 0 }, /* ClusterRevision */ \
11881188
\
@@ -2721,7 +2721,7 @@
27212721
.clusterId = 0x00000503, \
27222722
.attributes = ZAP_ATTRIBUTE_INDEX(536), \
27232723
.attributeCount = 3, \
2724-
.clusterSize = 39, \
2724+
.clusterSize = 19, \
27252725
.mask = ZAP_CLUSTER_MASK(SERVER), \
27262726
.functions = NULL, \
27272727
.acceptedCommandList = nullptr, \
@@ -3024,7 +3024,7 @@
30243024
// This is an array of EmberAfEndpointType structures.
30253025
#define GENERATED_ENDPOINT_TYPES \
30263026
{ \
3027-
{ ZAP_CLUSTER_INDEX(0), 27, 345 }, { ZAP_CLUSTER_INDEX(27), 44, 3717 }, { ZAP_CLUSTER_INDEX(71), 7, 127 }, \
3027+
{ ZAP_CLUSTER_INDEX(0), 27, 345 }, { ZAP_CLUSTER_INDEX(27), 44, 3697 }, { ZAP_CLUSTER_INDEX(71), 7, 127 }, \
30283028
{ ZAP_CLUSTER_INDEX(78), 2, 4 }, \
30293029
}
30303030

@@ -3037,7 +3037,7 @@ static_assert(ATTRIBUTE_LARGEST <= CHIP_CONFIG_MAX_ATTRIBUTE_STORE_ELEMENT_SIZE,
30373037
#define ATTRIBUTE_SINGLETONS_SIZE (37)
30383038

30393039
// Total size of attribute storage
3040-
#define ATTRIBUTE_MAX_SIZE (4193)
3040+
#define ATTRIBUTE_MAX_SIZE (4173)
30413041

30423042
// Number of fixed endpoints
30433043
#define FIXED_ENDPOINT_COUNT (4)

‎src/app/zap-templates/zcl/data-model/chip/wake-on-lan-cluster.xml

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0"?>
22
<!--
3-
Copyright (c) 2021 Project CHIP Authors
3+
Copyright (c) 2021-2023 Project CHIP Authors
44
55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -24,6 +24,10 @@ limitations under the License.
2424
<client init="false" tick="false">true</client>
2525
<server init="false" tick="false">true</server>
2626
<description>This cluster provides an interface for managing low power mode on a device that supports the Wake On LAN protocol.</description>
27-
<attribute side="server" code="0x0000" define="WAKE_ON_LAN_MAC_ADDRESS" type="char_string" length="32" writable="false" optional="true">MACAddress</attribute>
27+
28+
<global side="either" code="0xFFFD" value="1"/>
29+
30+
<attribute side="server" code="0x0000" define="WAKE_ON_LAN_MAC_ADDRESS" type="char_string" length="12" writable="false" optional="true">MACAddress</attribute>
31+
<attribute apiMaturity="provisional" side="server" code="0x0001" define="LINK_LOCAL_ADDRESS" type="octet_string" length="16" writable="false" optional="true">LinkLocalAddress</attribute>
2832
</cluster>
29-
</configurator>
33+
</configurator>

‎src/controller/data_model/controller-clusters.matter

+2-1
Original file line numberDiff line numberDiff line change
@@ -5859,7 +5859,8 @@ client cluster RadonConcentrationMeasurement = 1071 {
58595859

58605860
/** This cluster provides an interface for managing low power mode on a device that supports the Wake On LAN protocol. */
58615861
client cluster WakeOnLan = 1283 {
5862-
readonly attribute optional char_string<32> MACAddress = 0;
5862+
readonly attribute optional char_string<12> MACAddress = 0;
5863+
readonly attribute optional octet_string<16> linkLocalAddress = 1;
58635864
readonly attribute command_id generatedCommandList[] = 65528;
58645865
readonly attribute command_id acceptedCommandList[] = 65529;
58655866
readonly attribute event_id eventList[] = 65530;

‎src/controller/java/generated/java/chip/devicecontroller/ChipClusters.java

+26
Original file line numberDiff line numberDiff line change
@@ -43201,6 +43201,7 @@ public static class WakeOnLanCluster extends BaseChipCluster {
4320143201
public static final long CLUSTER_ID = 1283L;
4320243202

4320343203
private static final long M_A_C_ADDRESS_ATTRIBUTE_ID = 0L;
43204+
private static final long LINK_LOCAL_ADDRESS_ATTRIBUTE_ID = 1L;
4320443205
private static final long GENERATED_COMMAND_LIST_ATTRIBUTE_ID = 65528L;
4320543206
private static final long ACCEPTED_COMMAND_LIST_ATTRIBUTE_ID = 65529L;
4320643207
private static final long EVENT_LIST_ATTRIBUTE_ID = 65530L;
@@ -43259,6 +43260,31 @@ public void onSuccess(byte[] tlv) {
4325943260
}, M_A_C_ADDRESS_ATTRIBUTE_ID, minInterval, maxInterval);
4326043261
}
4326143262

43263+
public void readLinkLocalAddressAttribute(
43264+
OctetStringAttributeCallback callback) {
43265+
ChipAttributePath path = ChipAttributePath.newInstance(endpointId, clusterId, LINK_LOCAL_ADDRESS_ATTRIBUTE_ID);
43266+
43267+
readAttribute(new ReportCallbackImpl(callback, path) {
43268+
@Override
43269+
public void onSuccess(byte[] tlv) {
43270+
byte[] value = ChipTLVValueDecoder.decodeAttributeValue(path, tlv);
43271+
callback.onSuccess(value);
43272+
}
43273+
}, LINK_LOCAL_ADDRESS_ATTRIBUTE_ID, true);
43274+
}
43275+
43276+
public void subscribeLinkLocalAddressAttribute(
43277+
OctetStringAttributeCallback callback, int minInterval, int maxInterval) {
43278+
ChipAttributePath path = ChipAttributePath.newInstance(endpointId, clusterId, LINK_LOCAL_ADDRESS_ATTRIBUTE_ID);
43279+
43280+
subscribeAttribute(new ReportCallbackImpl(callback, path) {
43281+
@Override
43282+
public void onSuccess(byte[] tlv) {
43283+
byte[] value = ChipTLVValueDecoder.decodeAttributeValue(path, tlv);
43284+
}
43285+
}, LINK_LOCAL_ADDRESS_ATTRIBUTE_ID, minInterval, maxInterval);
43286+
}
43287+
4326243288
public void readGeneratedCommandListAttribute(
4326343289
GeneratedCommandListAttributeCallback callback) {
4326443290
ChipAttributePath path = ChipAttributePath.newInstance(endpointId, clusterId, GENERATED_COMMAND_LIST_ATTRIBUTE_ID);

‎src/controller/java/generated/java/chip/devicecontroller/ClusterIDMapping.java

+1
Original file line numberDiff line numberDiff line change
@@ -11968,6 +11968,7 @@ public long getID() {
1196811968

1196911969
public enum Attribute {
1197011970
MACAddress(0L),
11971+
LinkLocalAddress(1L),
1197111972
GeneratedCommandList(65528L),
1197211973
AcceptedCommandList(65529L),
1197311974
EventList(65530L),

‎src/controller/java/generated/java/chip/devicecontroller/ClusterReadMapping.java

+11
Original file line numberDiff line numberDiff line change
@@ -14002,6 +14002,17 @@ private static Map<String, InteractionInfo> readWakeOnLanInteractionInfo() {
1400214002
readWakeOnLanMACAddressCommandParams
1400314003
);
1400414004
result.put("readMACAddressAttribute", readWakeOnLanMACAddressAttributeInteractionInfo);
14005+
Map<String, CommandParameterInfo> readWakeOnLanLinkLocalAddressCommandParams = new LinkedHashMap<String, CommandParameterInfo>();
14006+
InteractionInfo readWakeOnLanLinkLocalAddressAttributeInteractionInfo = new InteractionInfo(
14007+
(cluster, callback, commandArguments) -> {
14008+
((ChipClusters.WakeOnLanCluster) cluster).readLinkLocalAddressAttribute(
14009+
(ChipClusters.OctetStringAttributeCallback) callback
14010+
);
14011+
},
14012+
() -> new ClusterInfoMapping.DelegatedOctetStringAttributeCallback(),
14013+
readWakeOnLanLinkLocalAddressCommandParams
14014+
);
14015+
result.put("readLinkLocalAddressAttribute", readWakeOnLanLinkLocalAddressAttributeInteractionInfo);
1400514016
Map<String, CommandParameterInfo> readWakeOnLanGeneratedCommandListCommandParams = new LinkedHashMap<String, CommandParameterInfo>();
1400614017
InteractionInfo readWakeOnLanGeneratedCommandListAttributeInteractionInfo = new InteractionInfo(
1400714018
(cluster, callback, commandArguments) -> {

‎src/controller/java/generated/java/matter/devicecontroller/cluster/clusters/WakeOnLanCluster.kt

+8
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,14 @@ class WakeOnLanCluster(private val controller: MatterController, private val end
3737
// Implementation needs to be added here
3838
}
3939

40+
suspend fun readLinkLocalAddressAttribute(): OctetString {
41+
// Implementation needs to be added here
42+
}
43+
44+
suspend fun subscribeLinkLocalAddressAttribute(minInterval: Int, maxInterval: Int): OctetString {
45+
// Implementation needs to be added here
46+
}
47+
4048
suspend fun readGeneratedCommandListAttribute(): GeneratedCommandListAttribute {
4149
// Implementation needs to be added here
4250
}

‎src/controller/java/zap-generated/CHIPAttributeTLVValueDecoder.cpp

+15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/controller/python/chip/clusters/CHIPClusters.py

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/controller/python/chip/clusters/Objects.py

+18
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/darwin/Framework/CHIP/zap-generated/MTRAttributeSpecifiedCheck.mm

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/darwin/Framework/CHIP/zap-generated/MTRAttributeTLVValueDecoder.mm

+11
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.h

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)