Define the unknown enum value for cluster enums. (#20907)

And fix various bits of code that did not handle unexpected enum
values.

examples/lock-app/cyw30739/src/LockManager.cpp

@@ -623,6 +623,8 @@ const char * LockManager::lockStateToString(DlLockState lockState) const
         return "Locked";
     case DlLockState::kUnlocked:
         return "Unlocked";
+    case DlLockState::kUnknownEnumValue:
+        break;
     }
 
     return "Unknown";

examples/lock-app/efr32/src/LockManager.cpp

@@ -619,6 +619,8 @@ const char * LockManager::lockStateToString(DlLockState lockState) const
         return "Locked";
     case DlLockState::kUnlocked:
         return "Unlocked";
+    case DlLockState::kUnknownEnumValue:
+        break;
     }
 
     return "Unknown";

examples/lock-app/linux/src/LockEndpoint.cpp

@@ -385,6 +385,8 @@ const char * LockEndpoint::lockStateToString(DlLockState lockState) const
         return "Locked";
     case DlLockState::kUnlocked:
         return "Unlocked";
+    case DlLockState::kUnknownEnumValue:
+        break;
     }
 
     return "Unknown";

src/app/clusters/diagnostic-logs-server/diagnostic-logs-server.cpp

@@ -38,6 +38,13 @@ void DiagnosticLogsCommandHandler::InvokeCommand(HandlerContext & handlerContext
 {
     HandleCommand<chip::app::Clusters::DiagnosticLogs::Commands::RetrieveLogsRequest::DecodableType>(
         handlerContext, [&](auto & _u, auto & payload) {
+            if (payload.requestedProtocol == chip::app::Clusters::DiagnosticLogs::LogsTransferProtocol::kUnknownEnumValue)
+            {
+                handlerContext.mCommandHandler.AddStatus(handlerContext.mRequestPath,
+                                                         chip::Protocols::InteractionModel::Status::InvalidCommand);
+                return;
+            }
+
             switch (payload.intent)
             {
             case chip::app::Clusters::DiagnosticLogs::LogsIntent::kEndUserSupport: {
@@ -86,6 +93,11 @@ void DiagnosticLogsCommandHandler::InvokeCommand(HandlerContext & handlerContext
                 handlerContext.mCommandHandler.AddResponse(handlerContext.mRequestPath, response);
             }
             break;
+            case chip::app::Clusters::DiagnosticLogs::LogsIntent::kUnknownEnumValue: {
+                handlerContext.mCommandHandler.AddStatus(handlerContext.mRequestPath,
+                                                         chip::Protocols::InteractionModel::Status::InvalidCommand);
+                break;
+            }
             }
         });
 }
@@ -94,6 +106,7 @@ bool emberAfDiagnosticLogsClusterRetrieveLogsRequestCallback(
     chip::app::CommandHandler * commandObj, const chip::app::ConcreteCommandPath & commandPath,
     const chip::app::Clusters::DiagnosticLogs::Commands::RetrieveLogsRequest::DecodableType & commandData)
 {
+    // TODO: Shouldn't the default "no-op" impl return some sort of error?
     EmberAfStatus status = EMBER_ZCL_STATUS_SUCCESS;
     emberAfSendImmediateDefaultResponse(status);
     return true;

src/app/clusters/door-lock-server/door-lock-server.cpp

@@ -2944,6 +2944,8 @@ DlLockDataType DoorLockServer::credentialTypeToLockDataType(DlCredentialType cre
     case DlCredentialType::kFace:
         // So far there's no distinct data type for face credentials
         return DlLockDataType::kUnspecified;
+    case DlCredentialType::kUnknownEnumValue:
+        return DlLockDataType::kUnspecified;
     }
 
     return DlLockDataType::kUnspecified;

src/app/clusters/ota-requestor/DefaultOTARequestor.cpp

@@ -289,6 +289,9 @@ void DefaultOTARequestor::OnApplyUpdateResponse(void * context, const ApplyUpdat
         requestorCore->mOtaRequestorDriver->UpdateDiscontinued();
         requestorCore->RecordNewUpdateState(OTAUpdateStateEnum::kIdle, OTAChangeReasonEnum::kSuccess);
         break;
+    case OTAApplyUpdateAction::kUnknownEnumValue:
+        OnApplyUpdateFailure(context, CHIP_ERROR_INVALID_ARGUMENT);
+        break;
     }
 }
 

src/app/clusters/pump-configuration-and-control-server/pump-configuration-and-control-server.cpp

@@ -229,6 +229,11 @@ static void updateAttributeLinks(EndpointId endpoint)
         }
     }
     break;
+
+    case PumpOperationMode::kUnknownEnumValue: {
+        // Not expected; see check in MatterPumpConfigurationAndControlClusterServerPreAttributeChangedCallback.
+        break;
+    }
     }
 
     if (isPumpStatusAvailable)
@@ -384,8 +389,18 @@ chip::Protocols::InteractionModel::Status MatterPumpConfigurationAndControlClust
                 status = Protocols::InteractionModel::Status::ConstraintError;
             }
             break;
-        default:
+        case PumpControlMode::kProportionalPressure:
+            if (!IsFeatureSupported(attributePath.mEndpointId, Attributes::MinCompPressure::Get, Attributes::MaxCompPressure::Get))
+            {
+                status = Protocols::InteractionModel::Status::ConstraintError;
+            }
+            break;
+        case PumpControlMode::kAutomatic:
             status = Protocols::InteractionModel::Status::Success;
+            break;
+        case PumpControlMode::kUnknownEnumValue:
+            status = Protocols::InteractionModel::Status::ConstraintError;
+            break;
         }
     }
     break;
@@ -410,8 +425,13 @@ chip::Protocols::InteractionModel::Status MatterPumpConfigurationAndControlClust
                 status = Protocols::InteractionModel::Status::ConstraintError;
             }
             break;
-        default:
+        case PumpOperationMode::kLocal:
+        case PumpOperationMode::kNormal:
             status = Protocols::InteractionModel::Status::Success;
+            break;
+        case PumpOperationMode::kUnknownEnumValue:
+            status = Protocols::InteractionModel::Status::ConstraintError;
+            break;
         }
 
         break;

src/app/zap-templates/templates/app/cluster-enums.zapt

@@ -24,7 +24,7 @@ enum class {{asType label}} : {{asUnderlyingZclType name}} {
 {{#zcl_enum_items}}
 k{{asUpperCamelCase label}} = {{asHex value 2}},
 {{/zcl_enum_items}}
-// kUnknownEnumValue = {{first_unused_enum_value mode="first_unused"}},
+kUnknownEnumValue = {{first_unused_enum_value mode="first_unused"}},
 };
 {{#if (isWeaklyTypedEnum label)}}
 #else // CHIP_USE_ENUM_CLASS_FOR_IM_ENUM

src/controller/CHIPDeviceController.cpp

@@ -1283,6 +1283,9 @@ CHIP_ERROR DeviceCommissioner::ConvertFromOperationalCertStatus(OperationalCrede
         return CHIP_ERROR_INVALID_ARGUMENT;
     case OperationalCertStatus::kInvalidFabricIndex:
         return CHIP_ERROR_INVALID_FABRIC_INDEX;
+    case OperationalCertStatus::kUnknownEnumValue:
+        // Is this a reasonable value?
+        return CHIP_ERROR_CERT_LOAD_FAILED;
     }
 
     return CHIP_ERROR_CERT_LOAD_FAILED;