Skip to content

Commit

Permalink
Change InteractionModel::Status to be 8-bit.
Browse files Browse the repository at this point in the history 
This change is happening on the spec side in
CHIP-Specifications/connectedhomeip-spec#4814
  • Loading branch information
@bzbarsky-apple
bzbarsky-apple committed Jan 11, 2022
1 parent 68df85c commit e41f2ac
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 50 deletions.
2 changes: 1 addition & 1 deletion src/app/CommandSender.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ CHIP_ERROR CommandSender::ProcessInvokeResponseIB(InvokeResponseIB::Parser & aIn
{
ChipLogProgress(DataManagement,
"Received Command Response Status for Endpoint=%" PRIu16 " Cluster=" ChipLogFormatMEI
" Command=" ChipLogFormatMEI " Status=0x%" PRIx16,
" Command=" ChipLogFormatMEI " Status=0x%" PRIx8,
endpointId, ChipLogValueMEI(clusterId), ChipLogValueMEI(commandId),
to_underlying(statusIB.mStatus));
}
Expand Down
2 changes: 1 addition & 1 deletion src/app/StatusResponse.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ CHIP_ERROR StatusResponse::ProcessStatusResponse(System::PacketBufferHandle && a
ReturnErrorOnFailure(response.CheckSchemaValidity());
#endif
ReturnErrorOnFailure(response.GetStatus(aStatus.mStatus));
ChipLogProgress(InteractionModel, "Received status response, status is %" PRIu16, to_underlying(aStatus.mStatus));
ChipLogProgress(InteractionModel, "Received status response, status is %" PRIu8, to_underlying(aStatus.mStatus));

if (aStatus.mStatus == Protocols::InteractionModel::Status::Success)
{
Expand Down
2 changes: 1 addition & 1 deletion src/app/tests/TestCommandInteraction.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ class MockCommandSenderCallback : public CommandSender::Callback
}
void OnError(const chip::app::CommandSender * apCommandSender, const chip::app::StatusIB & aStatus, CHIP_ERROR aError) override
{
ChipLogError(Controller, "OnError happens with %" PRIx16 " %" CHIP_ERROR_FORMAT, to_underlying(aStatus.mStatus),
ChipLogError(Controller, "OnError happens with %" PRIx8 " %" CHIP_ERROR_FORMAT, to_underlying(aStatus.mStatus),
aError.Format());
onErrorCalledTimes++;
}
Expand Down
84 changes: 42 additions & 42 deletions src/app/util/im-client-callbacks.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,130 +145,130 @@ static void LogIMStatus(Protocols::InteractionModel::Status status)
switch (status)
{
case Protocols::InteractionModel::Status::Success:
ChipLogProgress(Zcl, " status: Success (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Success (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Failure:
ChipLogProgress(Zcl, " status: Failure (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Failure (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::InvalidSubscription:
ChipLogProgress(Zcl, " status: InvalidSubscription (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: InvalidSubscription (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedAccess:
ChipLogProgress(Zcl, " status: UnsupportedAccess (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedAccess (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedEndpoint:
ChipLogProgress(Zcl, " status: UnsupportedEndpoint (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedEndpoint (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::InvalidAction:
ChipLogProgress(Zcl, " status: InvalidAction (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: InvalidAction (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedCommand:
ChipLogProgress(Zcl, " status: UnsupportedCommand (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedCommand (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated82:
ChipLogProgress(Zcl, " status: Deprecated82 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated82 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated83:
ChipLogProgress(Zcl, " status: Deprecated83 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated83 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated84:
ChipLogProgress(Zcl, " status: Deprecated84 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated84 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::InvalidCommand:
ChipLogProgress(Zcl, " status: InvalidCommand (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: InvalidCommand (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedAttribute:
ChipLogProgress(Zcl, " status: UnsupportedAttribute (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedAttribute (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::InvalidValue:
ChipLogProgress(Zcl, " status: InvalidValue (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: InvalidValue (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedWrite:
ChipLogProgress(Zcl, " status: UnsupportedWrite (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedWrite (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::ResourceExhausted:
ChipLogProgress(Zcl, " status: ResourceExhausted (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: ResourceExhausted (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated8a:
ChipLogProgress(Zcl, " status: Deprecated8a (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated8a (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::NotFound:
ChipLogProgress(Zcl, " status: NotFound (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: NotFound (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnreportableAttribute:
ChipLogProgress(Zcl, " status: UnreportableAttribute (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnreportableAttribute (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::InvalidDataType:
ChipLogProgress(Zcl, " status: InvalidDataType (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: InvalidDataType (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated8e:
ChipLogProgress(Zcl, " status: Deprecated8e (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated8e (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedRead:
ChipLogProgress(Zcl, " status: UnsupportedRead (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedRead (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated90:
ChipLogProgress(Zcl, " status: Deprecated90 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated90 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated91:
ChipLogProgress(Zcl, " status: Deprecated91 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated91 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved92:
ChipLogProgress(Zcl, " status: Reserved92 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved92 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecated93:
ChipLogProgress(Zcl, " status: Deprecated93 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecated93 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Timeout:
ChipLogProgress(Zcl, " status: Timeout (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Timeout (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved95:
ChipLogProgress(Zcl, " status: Reserved95 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved95 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved96:
ChipLogProgress(Zcl, " status: Reserved96 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved96 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved97:
ChipLogProgress(Zcl, " status: Reserved97 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved97 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved98:
ChipLogProgress(Zcl, " status: Reserved98 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved98 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved99:
ChipLogProgress(Zcl, " status: Reserved99 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved99 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Reserved9a:
ChipLogProgress(Zcl, " status: Reserved9a (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Reserved9a (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::ConstraintError:
ChipLogProgress(Zcl, " status: ConstraintError (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: ConstraintError (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Busy:
ChipLogProgress(Zcl, " status: Busy (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Busy (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecatedc0:
ChipLogProgress(Zcl, " status: Deprecatedc0 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecatedc0 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecatedc1:
ChipLogProgress(Zcl, " status: Deprecatedc1 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecatedc1 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecatedc2:
ChipLogProgress(Zcl, " status: Deprecatedc2 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecatedc2 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::UnsupportedCluster:
ChipLogProgress(Zcl, " status: UnsupportedCluster (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: UnsupportedCluster (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::Deprecatedc4:
ChipLogProgress(Zcl, " status: Deprecatedc4 (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: Deprecatedc4 (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::NoUpstreamSubscription:
ChipLogProgress(Zcl, " status: NoUpstreamSubscription (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: NoUpstreamSubscription (0x%02" PRIx8 ")", to_underlying(status));
break;
case Protocols::InteractionModel::Status::NeedsTimedInteraction:
ChipLogProgress(Zcl, " status: NeedsTimedInteraction (0x%04" PRIx16 ")", to_underlying(status));
ChipLogProgress(Zcl, " status: NeedsTimedInteraction (0x%02" PRIx8 ")", to_underlying(status));
break;
default:
ChipLogError(Zcl, "Unknown status: 0x%04" PRIx16, to_underlying(status));
ChipLogError(Zcl, "Unknown status: 0x%02" PRIx8, to_underlying(status));
break;
}
}
Expand Down
6 changes: 4 additions & 2 deletions src/controller/python/chip/interaction_model/Delegate.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ namespace Controller {

// The command status will be used for python script.
// use packed attribute so we can unpack it from python and no need to worry about padding.
// This struct needs to match the IMCommandStatus definition in delegate.py
struct __attribute__((packed)) CommandStatus
{
Protocols::InteractionModel::Status status;
Expand All @@ -43,7 +44,7 @@ struct __attribute__((packed)) CommandStatus
static_assert(std::is_same<chip::EndpointId, uint16_t>::value && std::is_same<chip::ClusterId, uint32_t>::value &&
std::is_same<chip::CommandId, uint32_t>::value,
"Members in CommandStatus does not match interaction_model/delegate.py");
static_assert(sizeof(CommandStatus) == 2 + 1 + 2 + 4 + 4 + 1, "Size of CommandStatus might contain padding");
static_assert(sizeof(CommandStatus) == 1 + 1 + 2 + 4 + 4 + 1, "Size of CommandStatus might contain padding");

struct __attribute__((packed)) AttributePath
{
Expand All @@ -57,6 +58,7 @@ static_assert(std::is_same<chip::EndpointId, uint16_t>::value && std::is_same<ch
"Members in AttributePath does not match interaction_model/delegate.py");
static_assert(sizeof(AttributePath) == 2 + 4 + 4, "AttributePath might contain padding");

// This struct needs to match the IMWriteStatus definition in delegate.py
struct __attribute__((packed)) AttributeWriteStatus
{
chip::NodeId nodeId;
Expand All @@ -69,7 +71,7 @@ struct __attribute__((packed)) AttributeWriteStatus
static_assert(std::is_same<chip::EndpointId, uint16_t>::value && std::is_same<chip::ClusterId, uint32_t>::value &&
std::is_same<chip::FieldId, uint32_t>::value,
"Members in AttributeWriteStatus does not match interaction_model/delegate.py");
static_assert(sizeof(AttributeWriteStatus) == 8 + 8 + 2 + 2 + 4 + 4, "Size of AttributeWriteStatus might contain padding");
static_assert(sizeof(AttributeWriteStatus) == 8 + 8 + 1 + 2 + 4 + 4, "Size of AttributeWriteStatus might contain padding");

extern "C" {
typedef void (*PythonInteractionModelDelegate_OnCommandResponseStatusCodeReceivedFunct)(uint64_t commandSenderPtr,
Expand Down
5 changes: 3 additions & 2 deletions src/controller/python/chip/interaction_model/delegate.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,19 @@
# The type should match CommandStatus in interaction_model/Delegate.h
# CommandStatus should not contain padding
IMCommandStatus = Struct(
"Status" / Int16ul,
"Status" / Int8ul,
"ClusterStatus" / Int8ul,
"EndpointId" / Int16ul,
"ClusterId" / Int32ul,
"CommandId" / Int32ul,
"CommandIndex" / Int8ul,
)

# The type should match WriteStatus in interaction_model/Delegate.h
IMWriteStatus = Struct(
"NodeId" / Int64ul,
"AppIdentifier" / Int64ul,
"Status" / Int16ul,
"Status" / Int8ul,
"EndpointId" / Int16ul,
"ClusterId" / Int32ul,
"AttributeId" / Int32ul,
Expand Down
2 changes: 1 addition & 1 deletion src/protocols/interaction_model/Constants.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ enum class MsgType : uint8_t
};

// This table comes from the IM's "Status Code Table" section from the Interaction Model spec.
enum class Status : uint16_t
enum class Status : uint8_t
{
Success = 0x0,
Failure = 0x01,
Expand Down

0 comments on commit e41f2ac

Please sign in to comment.