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

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/hwmon/pwm-fan.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/hwmon/pwm-fan.yaml
Extension
.yaml
Size
2945 bytes
Lines
118
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/hwmon/pwm-fan.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Fan connected to PWM lines

maintainers:
  - Jean Delvare <jdelvare@suse.com>
  - Guenter Roeck <linux@roeck-us.net>

properties:
  compatible:
    const: pwm-fan

  cooling-levels:
    description: PWM duty cycle values corresponding to thermal cooling states.
    $ref: /schemas/types.yaml#/definitions/uint32-array
    items:
      maximum: 255

  fan-supply:
    description: Phandle to the regulator that provides power to the fan.

  interrupts:
    description:
      This contains an interrupt specifier for each fan tachometer output
      connected to an interrupt source. The output signal must generate a
      defined number of interrupts per fan revolution, which require that
      it must be self resetting edge interrupts.
    maxItems: 1

  fan-shutdown-percent:
    description:
      Fan RPM in percent set during shutdown. This is used to keep the fan
      running at fixed RPM after the kernel shut down, which is useful on
      hardware that does keep heating itself even after the kernel did shut
      down, for example from some sort of management core.
    minimum: 0
    maximum: 100

  fan-stop-to-start-percent:
    description:
      Minimum fan RPM in percent to start when stopped.
    minimum: 0
    maximum: 100

  fan-stop-to-start-us:
    description:
      Time to wait in microseconds after start when stopped.

  pulses-per-revolution:
    description:
      Define the number of pulses per fan revolution for each tachometer
      input as an integer.
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 1
    maximum: 4
    default: 2

  pwms:
    description: The PWM that is used to control the fan.
    maxItems: 1

  "#cooling-cells":
    const: 2

required:
  - compatible

Annotation

Implementation Notes