xref: /linux/Documentation/devicetree/bindings/hwmon/fan-common.yaml (revision e6a901a00822659181c93c86d8bbc2a17779fddc)
1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/hwmon/fan-common.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Common Fan Properties
8
9maintainers:
10  - Naresh Solanki <naresh.solanki@9elements.com>
11  - Billy Tsai <billy_tsai@aspeedtech.com>
12
13properties:
14  max-rpm:
15    description:
16      Max RPM supported by fan.
17    $ref: /schemas/types.yaml#/definitions/uint32
18    maximum: 100000
19
20  min-rpm:
21    description:
22      Min RPM supported by fan.
23    $ref: /schemas/types.yaml#/definitions/uint32
24    maximum: 1000
25
26  pulses-per-revolution:
27    description:
28      The number of pulse from fan sensor per revolution.
29    $ref: /schemas/types.yaml#/definitions/uint32
30    maximum: 4
31
32  tach-div:
33    description:
34      Divisor for the tach sampling clock, which determines the sensitivity of the tach pin.
35    $ref: /schemas/types.yaml#/definitions/uint32
36
37  target-rpm:
38    description:
39      The default desired fan speed in RPM.
40    $ref: /schemas/types.yaml#/definitions/uint32
41
42  fan-driving-mode:
43    description:
44      Select the driving mode of the fan.(DC, PWM and so on)
45    $ref: /schemas/types.yaml#/definitions/string
46    enum: [ dc, pwm ]
47
48  pwms:
49    description:
50      PWM provider.
51    maxItems: 1
52
53  "#cooling-cells":
54    const: 2
55
56  cooling-levels:
57    description:
58      The control value which correspond to thermal cooling states.
59    $ref: /schemas/types.yaml#/definitions/uint32-array
60
61  tach-ch:
62    description:
63      The tach channel used for the fan.
64    $ref: /schemas/types.yaml#/definitions/uint8-array
65
66  label:
67    description:
68      Optional fan label
69
70  fan-supply:
71    description:
72      Power supply for fan.
73
74  reg:
75    maxItems: 1
76
77additionalProperties: true
78
79...
80