Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 1 | description: > |
| 2 | Implement the watchdog function. |
William A. Kennington III | 34fc296 | 2018-01-23 21:05:19 -0800 | [diff] [blame] | 3 | |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 4 | properties: |
William A. Kennington III | 34fc296 | 2018-01-23 21:05:19 -0800 | [diff] [blame] | 5 | - name: Initialized |
| 6 | type: boolean |
| 7 | description: > |
| 8 | Whether the host has configured the watchdog yet. |
| 9 | default: false |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 10 | - name: Enabled |
| 11 | type: boolean |
| 12 | description: > |
| 13 | The watchdog is enabled or not. |
| 14 | default: false |
William A. Kennington III | dfa9e65 | 2018-01-23 21:05:38 -0800 | [diff] [blame] | 15 | - name: ExpireAction |
| 16 | type: enum[self.Action] |
| 17 | description: > |
| 18 | The action the watchdog should perform when it expires. |
| 19 | default: 'HardReset' |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 20 | - name: Interval |
| 21 | type: uint64 |
| 22 | description: > |
Patrick Venture | 08b0d93 | 2017-07-30 10:40:41 -0700 | [diff] [blame] | 23 | Time interval to arm the watchdog, in milli-second. |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 24 | default: 30000 |
| 25 | - name: TimeRemaining |
| 26 | type: uint64 |
| 27 | description: > |
Patrick Venture | 08b0d93 | 2017-07-30 10:40:41 -0700 | [diff] [blame] | 28 | Time remaining before timeout, in milli-second. |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 29 | Setting this property can re-arm the watchdog. |
| 30 | default: 0 |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 31 | |
William A. Kennington III | dfa9e65 | 2018-01-23 21:05:38 -0800 | [diff] [blame] | 32 | enumerations: |
| 33 | - name: Action |
| 34 | description: > |
| 35 | The type of action to perform. |
| 36 | values: |
| 37 | - name: 'None' |
| 38 | description: > |
| 39 | Do nothing. |
| 40 | - name: 'HardReset' |
| 41 | description: > |
| 42 | Perform a reset of the system. |
| 43 | - name: 'PowerOff' |
| 44 | description: > |
| 45 | Perform a power off of the system. |
| 46 | - name: 'PowerCycle' |
| 47 | description: > |
| 48 | Perform a power cycle of the system. |
| 49 | |
Yi Li | 4f025cd | 2016-12-02 19:03:53 +0800 | [diff] [blame] | 50 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |