Documentation / devicetree / bindings / hwmon / gpio-fan.yaml


Based on kernel version 6.10. Page generated on 2024-07-16 09:00 EST.

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
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/hwmon/gpio-fan.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Fan connected to GPIO lines

maintainers:
  - Rob Herring <robh@kernel.org>

properties:
  compatible:
    const: gpio-fan

  gpios:
    description: |
      Specifies the pins that map to bits in the control value,
      ordered MSB-->LSB.
    minItems: 1
    maxItems: 7

  alarm-gpios:
    maxItems: 1

  gpio-fan,speed-map:
    $ref: /schemas/types.yaml#/definitions/uint32-matrix
    minItems: 2
    maxItems: 127
    items:
      items:
        - description: fan speed in RPMs
        - description: control value
    description: |
      A mapping of possible fan RPM speeds and the
      control value that should be set to achieve them. This array
      must have the RPM values in ascending order.

  '#cooling-cells':
    const: 2

required:
  - compatible
  - gpios
  - gpio-fan,speed-map

additionalProperties: false

examples:
  - |
    gpio-fan {
      compatible = "gpio-fan";
      gpios = <&gpio2 14 1
               &gpio2 13 1>;
      gpio-fan,speed-map = <   0 0>,
                           <3000 1>,
                           <6000 2>;
      alarm-gpios = <&gpio2 15 1>;
      #cooling-cells = <2>; /* min followed by max */
    };