State.Watchdog: Add a ResetTimeRemaining method

It's common for services to want to pet the watchdog by reading the
interval, writing it to the TimeRemaining field, and possibly enabling
the watchdog. This patch adds a convenience method to acomplish this in
a single dbus call. A single call also reduces the completion time of
reset requests and the load incurred by performing multiple dbus calls.

Change-Id: I847e821a4ea10e49c6b6703a48a346bbab6fd44c
Signed-off-by: William A. Kennington III <wak@google.com>

1 files changed, 16 insertions, 0 deletions

diff --git a/xyz/openbmc_project/State/Watchdog.interface.yaml b/xyz/openbmc_project/State/Watchdog.interface.yaml
index 960b2b0..f76dbf2 100644
--- a/xyz/openbmc_project/State/Watchdog.interface.yaml
+++ b/xyz/openbmc_project/State/Watchdog.interface.yaml
@@ -1,6 +1,22 @@
 description: >
     Implement the watchdog function.
 
+methods:
+    - name: ResetTimeRemaining
+      description: >
+          Resets the time remaining to the configured interval.
+          This is equivalent to reading the Interval and writing it
+          into the TimeRemaining. Optionally the watchdog can be enabled
+          during the reset process.
+      parameters:
+        - name: EnableWatchdog
+          type: boolean
+          description: >
+              If true the watchdog will be enabled when the reset
+              is performed.
+      errors:
+        - xyz.openbmc_project.Common.Error.InternalFailure
+
 properties:
     - name: Initialized
       type: boolean