summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/arm/cpus.yaml
blob: 365dcf384d73922a22bc70a32e98444122bc4fa7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/arm/cpus.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: ARM CPUs bindings

maintainers:
  - Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>

description: |+
  The device tree allows to describe the layout of CPUs in a system through
  the "cpus" node, which in turn contains a number of subnodes (ie "cpu")
  defining properties for every cpu.

  Bindings for CPU nodes follow the Devicetree Specification, available from:

  https://www.devicetree.org/specifications/

  with updates for 32-bit and 64-bit ARM systems provided in this document.

  ================================
  Convention used in this document
  ================================

  This document follows the conventions described in the Devicetree
  Specification, with the addition:

  - square brackets define bitfields, eg reg[7:0] value of the bitfield in
    the reg property contained in bits 7 down to 0

  =====================================
  cpus and cpu node bindings definition
  =====================================

  The ARM architecture, in accordance with the Devicetree Specification,
  requires the cpus and cpu nodes to be present and contain the properties
  described below.

properties:
  $nodename:
    const: cpus
    description: Container of cpu nodes

  '#address-cells':
    enum: [1, 2]
    description: |
      Definition depends on ARM architecture version and configuration:

      On uniprocessor ARM architectures previous to v7
        value must be 1, to enable a simple enumeration
        scheme for processors that do not have a HW CPU
        identification register.
      On 32-bit ARM 11 MPcore, ARM v7 or later systems
        value must be 1, that corresponds to CPUID/MPIDR
        registers sizes.
      On ARM v8 64-bit systems value should be set to 2,
        that corresponds to the MPIDR_EL1 register size.
        If MPIDR_EL1[63:32] value is equal to 0 on all CPUs
        in the system, #address-cells can be set to 1, since
        MPIDR_EL1[63:32] bits are not used for CPUs
        identification.

  '#size-cells':
    const: 0

patternProperties:
  '^cpu@[0-9a-f]+$':
    properties:
      device_type:
        const: cpu

      reg:
        maxItems: 1
        description: |
          Usage and definition depend on ARM architecture version and
          configuration:

          On uniprocessor ARM architectures previous to v7
          this property is required and must be set to 0.

          On ARM 11 MPcore based systems this property is
            required and matches the CPUID[11:0] register bits.

            Bits [11:0] in the reg cell must be set to
            bits [11:0] in CPU ID register.

            All other bits in the reg cell must be set to 0.

          On 32-bit ARM v7 or later systems this property is
            required and matches the CPU MPIDR[23:0] register
            bits.

            Bits [23:0] in the reg cell must be set to
            bits [23:0] in MPIDR.

            All other bits in the reg cell must be set to 0.

          On ARM v8 64-bit systems this property is required
            and matches the MPIDR_EL1 register affinity bits.

            * If cpus node's #address-cells property is set to 2

              The first reg cell bits [7:0] must be set to
              bits [39:32] of MPIDR_EL1.

              The second reg cell bits [23:0] must be set to
              bits [23:0] of MPIDR_EL1.

            * If cpus node's #address-cells property is set to 1

              The reg cell bits [23:0] must be set to bits [23:0]
              of MPIDR_EL1.

          All other bits in the reg cells must be set to 0.

      compatible:
        items:
          - enum:
              - arm,arm710t
              - arm,arm720t
              - arm,arm740t
              - arm,arm7ej-s
              - arm,arm7tdmi
              - arm,arm7tdmi-s
              - arm,arm9es
              - arm,arm9ej-s
              - arm,arm920t
              - arm,arm922t
              - arm,arm925
              - arm,arm926e-s
              - arm,arm926ej-s
              - arm,arm940t
              - arm,arm946e-s
              - arm,arm966e-s
              - arm,arm968e-s
              - arm,arm9tdmi
              - arm,arm1020e
              - arm,arm1020t
              - arm,arm1022e
              - arm,arm1026ej-s
              - arm,arm1136j-s
              - arm,arm1136jf-s
              - arm,arm1156t2-s
              - arm,arm1156t2f-s
              - arm,arm1176jzf
              - arm,arm1176jz-s
              - arm,arm1176jzf-s
              - arm,arm11mpcore
              - arm,armv8 # Only for s/w models
              - arm,cortex-a5
              - arm,cortex-a7
              - arm,cortex-a8
              - arm,cortex-a9
              - arm,cortex-a12
              - arm,cortex-a15
              - arm,cortex-a17
              - arm,cortex-a53
              - arm,cortex-a57
              - arm,cortex-a72
              - arm,cortex-a73
              - arm,cortex-m0
              - arm,cortex-m0+
              - arm,cortex-m1
              - arm,cortex-m3
              - arm,cortex-m4
              - arm,cortex-r4
              - arm,cortex-r5
              - arm,cortex-r7
              - brcm,brahma-b15
              - brcm,brahma-b53
              - brcm,vulcan
              - cavium,thunder
              - cavium,thunder2
              - faraday,fa526
              - intel,sa110
              - intel,sa1100
              - marvell,feroceon
              - marvell,mohawk
              - marvell,pj4a
              - marvell,pj4b
              - marvell,sheeva-v5
              - marvell,sheeva-v7
              - nvidia,tegra132-denver
              - nvidia,tegra186-denver
              - nvidia,tegra194-carmel
              - qcom,krait
              - qcom,kryo
              - qcom,kryo385
              - qcom,scorpion

      enable-method:
        allOf:
          - $ref: '/schemas/types.yaml#/definitions/string'
          - oneOf:
            # On ARM v8 64-bit this property is required
            - enum:
                - psci
                - spin-table
            # On ARM 32-bit systems this property is optional
            - enum:
                - actions,s500-smp
                - allwinner,sun6i-a31
                - allwinner,sun8i-a23
                - allwinner,sun9i-a80-smp
                - allwinner,sun8i-a83t-smp
                - amlogic,meson8-smp
                - amlogic,meson8b-smp
                - arm,realview-smp
                - brcm,bcm11351-cpu-method
                - brcm,bcm23550
                - brcm,bcm2836-smp
                - brcm,bcm63138
                - brcm,bcm-nsp-smp
                - brcm,brahma-b15
                - marvell,armada-375-smp
                - marvell,armada-380-smp
                - marvell,armada-390-smp
                - marvell,armada-xp-smp
                - marvell,98dx3236-smp
                - mediatek,mt6589-smp
                - mediatek,mt81xx-tz-smp
                - qcom,gcc-msm8660
                - qcom,kpss-acc-v1
                - qcom,kpss-acc-v2
                - renesas,apmu
                - renesas,r9a06g032-smp
                - rockchip,rk3036-smp
                - rockchip,rk3066-smp
		- socionext,milbeaut-m10v-smp
                - ste,dbx500-smp

      cpu-release-addr:
        $ref: '/schemas/types.yaml#/definitions/uint64'

        description:
          Required for systems that have an "enable-method"
            property value of "spin-table".
          On ARM v8 64-bit systems must be a two cell
            property identifying a 64-bit zero-initialised
            memory location.

      cpu-idle-states:
        $ref: '/schemas/types.yaml#/definitions/phandle-array'
        description: |
          List of phandles to idle state nodes supported
          by this cpu (see ./idle-states.txt).

      capacity-dmips-mhz:
        $ref: '/schemas/types.yaml#/definitions/uint32'
        description:
          u32 value representing CPU capacity (see ./cpu-capacity.txt) in
          DMIPS/MHz, relative to highest capacity-dmips-mhz
          in the system.

      dynamic-power-coefficient:
        $ref: '/schemas/types.yaml#/definitions/uint32'
        description:
          A u32 value that represents the running time dynamic
          power coefficient in units of uW/MHz/V^2. The
          coefficient can either be calculated from power
          measurements or derived by analysis.

          The dynamic power consumption of the CPU  is
          proportional to the square of the Voltage (V) and
          the clock frequency (f). The coefficient is used to
          calculate the dynamic power as below -

          Pdyn = dynamic-power-coefficient * V^2 * f

          where voltage is in V, frequency is in MHz.

      qcom,saw:
        $ref: '/schemas/types.yaml#/definitions/phandle'
        description: |
          Specifies the SAW* node associated with this CPU.

          Required for systems that have an "enable-method" property
          value of "qcom,kpss-acc-v1" or "qcom,kpss-acc-v2"

          * arm/msm/qcom,saw2.txt

      qcom,acc:
        $ref: '/schemas/types.yaml#/definitions/phandle'
        description: |
          Specifies the ACC* node associated with this CPU.

          Required for systems that have an "enable-method" property
          value of "qcom,kpss-acc-v1" or "qcom,kpss-acc-v2"

          * arm/msm/qcom,kpss-acc.txt

      rockchip,pmu:
        $ref: '/schemas/types.yaml#/definitions/phandle'
        description: |
          Specifies the syscon node controlling the cpu core power domains.

          Optional for systems that have an "enable-method"
          property value of "rockchip,rk3066-smp"
          While optional, it is the preferred way to get access to
          the cpu-core power-domains.

    required:
      - device_type
      - reg
      - compatible

    dependencies:
      cpu-release-addr: [enable-method]
      rockchip,pmu: [enable-method]

required:
  - '#address-cells'
  - '#size-cells'

examples:
  - |
    cpus {
      #size-cells = <0>;
      #address-cells = <1>;

      cpu@0 {
        device_type = "cpu";
        compatible = "arm,cortex-a15";
        reg = <0x0>;
      };

      cpu@1 {
        device_type = "cpu";
        compatible = "arm,cortex-a15";
        reg = <0x1>;
      };

      cpu@100 {
        device_type = "cpu";
        compatible = "arm,cortex-a7";
        reg = <0x100>;
      };

      cpu@101 {
        device_type = "cpu";
        compatible = "arm,cortex-a7";
        reg = <0x101>;
      };
    };

  - |
    // Example 2 (Cortex-A8 uniprocessor 32-bit system):
    cpus {
      #size-cells = <0>;
      #address-cells = <1>;

      cpu@0 {
        device_type = "cpu";
        compatible = "arm,cortex-a8";
        reg = <0x0>;
      };
    };

  - |
    // Example 3 (ARM 926EJ-S uniprocessor 32-bit system):
    cpus {
      #size-cells = <0>;
      #address-cells = <1>;

      cpu@0 {
        device_type = "cpu";
        compatible = "arm,arm926ej-s";
        reg = <0x0>;
      };
    };

  - |
    //  Example 4 (ARM Cortex-A57 64-bit system):
    cpus {
      #size-cells = <0>;
      #address-cells = <2>;

      cpu@0 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x0>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@1 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x1>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x100>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@101 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x101>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@10000 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x10000>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@10001 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x10001>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@10100 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x10100>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@10101 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x0 0x10101>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100000000 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x0>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100000001 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x1>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100000100 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x100>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100000101 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x101>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100010000 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x10000>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100010001 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x10001>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100010100 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x10100>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };

      cpu@100010101 {
        device_type = "cpu";
        compatible = "arm,cortex-a57";
        reg = <0x1 0x10101>;
        enable-method = "spin-table";
        cpu-release-addr = <0 0x20000000>;
      };
    };
...