Define Errors on CurrentOperatingConfig properties
There are some conditions which would prevent changes to the
CurrentOperatingConfig interface on a CPU. To make it easier for a user
to know their property Set was rejected, define some common error codes
to return.
Signed-off-by: Jonathan Doman <jonathan.doman@intel.com>
Change-Id: I7a1d3a8c0194a5c2f7b275d779915d2c2c72c530
diff --git a/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml b/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml
index 918f9f9..d231ba5 100644
--- a/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml
+++ b/xyz/openbmc_project/Control/Processor/CurrentOperatingConfig.interface.yaml
@@ -4,8 +4,25 @@
- name: AppliedConfig
type: object_path
description: Path to currently selected configuration.
+ errors:
+ # Indicate that the set object_path is not a valid associated
+ # OperatingConfig.
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ # Indicate that this property is permanently unable to be changed.
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ # Indicate that this property is temporarily unable to be changed.
+ - xyz.openbmc_project.Common.Error.Unavailable
+ # Indicate a failure to apply changes to the processor.
+ - xyz.openbmc_project.Common.Device.Error.WriteFailure
- name: BaseSpeedPriorityEnabled
type: boolean
description: >
Whether base speed prioritization is enabled in the currently selected
configuration.
+ errors:
+ # Indicate that this property is permanently unable to be changed.
+ - xyz.openbmc_project.Common.Error.NotAllowed
+ # Indicate that this property is temporarily unable to be changed.
+ - xyz.openbmc_project.Common.Error.Unavailable
+ # Indicate a failure to apply changes to the processor.
+ - xyz.openbmc_project.Common.Device.Error.WriteFailure