xref: /linux/Documentation/devicetree/bindings/power/reset/restart-handler.yaml (revision 3f5b93f4077b37d576b6cdbcb636f443aa09eb03)
1*3f5b93f4SKrzysztof Kozlowski# SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause
2*3f5b93f4SKrzysztof Kozlowski%YAML 1.2
3*3f5b93f4SKrzysztof Kozlowski---
4*3f5b93f4SKrzysztof Kozlowski$id: http://devicetree.org/schemas/power/reset/restart-handler.yaml#
5*3f5b93f4SKrzysztof Kozlowski$schema: http://devicetree.org/meta-schemas/core.yaml#
6*3f5b93f4SKrzysztof Kozlowski
7*3f5b93f4SKrzysztof Kozlowskititle: Restart and shutdown handler generic binding
8*3f5b93f4SKrzysztof Kozlowski
9*3f5b93f4SKrzysztof Kozlowskimaintainers:
10*3f5b93f4SKrzysztof Kozlowski  - Sebastian Reichel <sre@kernel.org>
11*3f5b93f4SKrzysztof Kozlowski
12*3f5b93f4SKrzysztof Kozlowskidescription:
13*3f5b93f4SKrzysztof Kozlowski  Restart and shutdown handler device is responsible for powering off the
14*3f5b93f4SKrzysztof Kozlowski  system, e.g. my cutting off the power.  System might have several restart
15*3f5b93f4SKrzysztof Kozlowski  handlers, which usually are tried from most precise to last resort.
16*3f5b93f4SKrzysztof Kozlowski
17*3f5b93f4SKrzysztof Kozlowskiproperties:
18*3f5b93f4SKrzysztof Kozlowski  priority:
19*3f5b93f4SKrzysztof Kozlowski    $ref: /schemas/types.yaml#/definitions/uint32
20*3f5b93f4SKrzysztof Kozlowski    description: |
21*3f5b93f4SKrzysztof Kozlowski      A priority ranging from 0 to 255 according to the following guidelines::
22*3f5b93f4SKrzysztof Kozlowski        0::   Restart handler of last resort, with limited restart capabilities.
23*3f5b93f4SKrzysztof Kozlowski        128:: Typical, default restart handler; use if no other restart handler
24*3f5b93f4SKrzysztof Kozlowski              is expected to be available, and/or if restart functionality is
25*3f5b93f4SKrzysztof Kozlowski              sufficient to restart the entire system.
26*3f5b93f4SKrzysztof Kozlowski        255:: Highest priority restart handler, will preempt all other restart handlers.
27*3f5b93f4SKrzysztof Kozlowski    minimum: 0
28*3f5b93f4SKrzysztof Kozlowski    maximum: 255
29*3f5b93f4SKrzysztof Kozlowski
30*3f5b93f4SKrzysztof KozlowskiadditionalProperties: true
31