xref: /freebsd/sys/contrib/device-tree/Bindings/arm/hisilicon/controller/sysctrl.yaml (revision 19fae0f66023a97a9b464b3beeeabb2081f575b3) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/arm/hisilicon/controller/sysctrl.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Hisilicon system controller
8
9maintainers:
10  - Wei Xu <xuwei5@hisilicon.com>
11
12description: |
13  The Hisilicon system controller is used on many Hisilicon boards, it can be
14  used to assist the slave core startup, reboot the system, etc.
15
16  There are some variants of the Hisilicon system controller, such as HiP01,
17  Hi3519, Hi6220 system controller, each of them is mostly compatible with the
18  Hisilicon system controller, but some same registers located at different
19  offset. In addition, the HiP01 system controller has some specific control
20  registers for HIP01 SoC family, such as slave core boot.
21
22  The compatible names of each system controller are as follows:
23  Hisilicon system controller   --> hisilicon,sysctrl
24  HiP01     system controller   --> hisilicon,hip01-sysctrl
25  Hi6220    system controller   --> hisilicon,hi6220-sysctrl
26  Hi3519    system controller   --> hisilicon,hi3519-sysctrl
27
28allOf:
29  - if:
30      properties:
31        compatible:
32          contains:
33            const: hisilicon,hi6220-sysctrl
34    then:
35      required:
36        - '#clock-cells'
37
38properties:
39  compatible:
40    oneOf:
41      - items:
42          - enum:
43              - hisilicon,sysctrl
44              - hisilicon,hi6220-sysctrl
45              - hisilicon,hi3519-sysctrl
46          - const: syscon
47      - items:
48          - const: hisilicon,hip01-sysctrl
49          - const: hisilicon,sysctrl
50
51  reg:
52    maxItems: 1
53
54  smp-offset:
55    description: |
56      offset in sysctrl for notifying slave cpu booting
57      cpu 1, reg;
58      cpu 2, reg + 0x4;
59      cpu 3, reg + 0x8;
60      If reg value is not zero, cpun exit wfi and go
61    $ref: /schemas/types.yaml#/definitions/uint32
62
63  resume-offset:
64    description: offset in sysctrl for notifying cpu0 when resume
65    $ref: /schemas/types.yaml#/definitions/uint32
66
67  reboot-offset:
68    description: offset in sysctrl for system reboot
69    $ref: /schemas/types.yaml#/definitions/uint32
70
71  '#clock-cells':
72    const: 1
73
74  '#reset-cells':
75    const: 1
76
77  '#address-cells':
78    const: 1
79
80  '#size-cells':
81    const: 1
82
83  ranges: true
84
85required:
86  - compatible
87  - reg
88
89additionalProperties:
90  type: object
91
92examples:
93  - |
94    /* Hisilicon system controller */
95    system-controller@802000 {
96        compatible = "hisilicon,sysctrl", "syscon";
97        #address-cells = <1>;
98        #size-cells = <1>;
99        ranges = <0 0x802000 0x1000>;
100        reg = <0x802000 0x1000>;
101
102        smp-offset = <0x31c>;
103        resume-offset = <0x308>;
104        reboot-offset = <0x4>;
105
106        clock: clock@0 {
107            compatible = "hisilicon,hi3620-clock";
108            reg = <0 0x10000>;
109            #clock-cells = <1>;
110        };
111    };
112
113    /* HiP01 system controller */
114    system-controller@10000000 {
115        compatible = "hisilicon,hip01-sysctrl", "hisilicon,sysctrl";
116        reg = <0x10000000 0x1000>;
117        reboot-offset = <0x4>;
118    };
119
120    /* Hi6220 system controller */
121    system-controller@f7030000 {
122        compatible = "hisilicon,hi6220-sysctrl", "syscon";
123        reg = <0xf7030000 0x2000>;
124        #clock-cells = <1>;
125    };
126
127    /* Hi3519 system controller */
128    system-controller@12010000 {
129        compatible = "hisilicon,hi3519-sysctrl", "syscon";
130        reg = <0x12010000 0x1000>;
131    };
132...
133