blob: da95d4c9cb803e708c27a26f2138cc91d55ed7ab [file] [log] [blame]
Yi Li4f025cd2016-12-02 19:03:53 +08001description: >
2 Implement the watchdog function.
William A. Kennington III34fc2962018-01-23 21:05:19 -08003
William A. Kennington IIIc61651d2018-04-23 10:13:24 -07004methods:
5 - name: ResetTimeRemaining
6 description: >
7 Resets the time remaining to the configured interval.
8 This is equivalent to reading the Interval and writing it
9 into the TimeRemaining. Optionally the watchdog can be enabled
10 during the reset process.
11 parameters:
12 - name: EnableWatchdog
13 type: boolean
14 description: >
15 If true the watchdog will be enabled when the reset
16 is performed.
17 errors:
18 - xyz.openbmc_project.Common.Error.InternalFailure
19
Yi Li4f025cd2016-12-02 19:03:53 +080020properties:
William A. Kennington III34fc2962018-01-23 21:05:19 -080021 - name: Initialized
22 type: boolean
23 description: >
24 Whether the host has configured the watchdog yet.
25 default: false
Yi Li4f025cd2016-12-02 19:03:53 +080026 - name: Enabled
27 type: boolean
28 description: >
29 The watchdog is enabled or not.
30 default: false
William A. Kennington IIIdfa9e652018-01-23 21:05:38 -080031 - name: ExpireAction
32 type: enum[self.Action]
33 description: >
34 The action the watchdog should perform when it expires.
35 default: 'HardReset'
Yi Li4f025cd2016-12-02 19:03:53 +080036 - name: Interval
37 type: uint64
38 description: >
Patrick Venture08b0d932017-07-30 10:40:41 -070039 Time interval to arm the watchdog, in milli-second.
Yi Li4f025cd2016-12-02 19:03:53 +080040 default: 30000
41 - name: TimeRemaining
42 type: uint64
43 description: >
Patrick Venture08b0d932017-07-30 10:40:41 -070044 Time remaining before timeout, in milli-second.
Yi Li4f025cd2016-12-02 19:03:53 +080045 Setting this property can re-arm the watchdog.
46 default: 0
William A. Kennington IIIc39e8ce2019-01-15 15:06:00 -080047 - name: CurrentTimerUse
48 type: enum[self.TimerUse]
Yong Lid8b93b52018-12-05 18:12:46 +080049 description: >
William A. Kennington IIIc39e8ce2019-01-15 15:06:00 -080050 The host defined user of this timer.
Yong Lid8b93b52018-12-05 18:12:46 +080051 default: 'Reserved'
William A. Kennington IIIc39e8ce2019-01-15 15:06:00 -080052 - name: ExpiredTimerUse
53 type: enum[self.TimerUse]
Yong Lid8b93b52018-12-05 18:12:46 +080054 description: >
William A. Kennington IIIc39e8ce2019-01-15 15:06:00 -080055 The timer user at the time of expiration.
Yong Lid8b93b52018-12-05 18:12:46 +080056 default: 'Reserved'
Yi Li4f025cd2016-12-02 19:03:53 +080057
William A. Kennington IIIdfa9e652018-01-23 21:05:38 -080058enumerations:
59 - name: Action
60 description: >
61 The type of action to perform.
62 values:
63 - name: 'None'
64 description: >
65 Do nothing.
66 - name: 'HardReset'
67 description: >
68 Perform a reset of the system.
69 - name: 'PowerOff'
70 description: >
71 Perform a power off of the system.
72 - name: 'PowerCycle'
73 description: >
74 Perform a power cycle of the system.
75
William A. Kennington IIIc39e8ce2019-01-15 15:06:00 -080076 - name: TimerUse
Yong Lid8b93b52018-12-05 18:12:46 +080077 description: >
78 The type of timer use.
79 values:
80 - name: 'Reserved'
81 description: >
82 Reserved.
83 - name: 'BIOSFRB2'
84 description: >
85 BIOS FRB2.
86 - name: 'BIOSPOST'
87 description: >
88 BIOS POST.
89 - name: 'OSLoad'
90 description: >
91 OS Load.
92 - name: SMSOS
93 description: >
94 SMS OS.
95 - name: 'OEM'
96 description: >
97 OEM.
98
Yi Li4f025cd2016-12-02 19:03:53 +080099# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4