Documentation/devicetree/bindings/thermal/renesas,r9a09g047-tsu.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/thermal/renesas,r9a09g047-tsu.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Renesas RZ/G3E Temperature Sensor Unit (TSU)

maintainers:
  - John Madieu <john.madieu.xa@bp.renesas.com>

description:
  The Temperature Sensor Unit (TSU) is an integrated thermal sensor that
  monitors the chip temperature on the Renesas RZ/G3E SoC. The TSU provides
  real-time temperature measurements for thermal management.

properties:
  compatible:
    oneOf:
      - enum:
          - renesas,r9a09g047-tsu # RZ/G3E
          - renesas,r9a09g077-tsu # RZ/T2H
      - items:
          - enum:
              - renesas,r9a09g056-tsu # RZ/V2N
              - renesas,r9a09g057-tsu # RZ/V2H
          - const: renesas,r9a09g047-tsu # RZ/G3E
      - items:
          - const: renesas,r9a09g087-tsu # RZ/N2H
          - const: renesas,r9a09g077-tsu # RZ/T2H

  reg:
    maxItems: 1

  clocks:
    maxItems: 1

  resets:
    maxItems: 1

  power-domains:
    maxItems: 1

  interrupts:
    items:
      - description: Conversion complete interrupt signal (pulse)
      - description: Comparison result interrupt signal (level)

  interrupt-names:
    items:
      - const: adi
      - const: adcmpi

  "#thermal-sensor-cells":
    const: 0

  renesas,tsu-trim:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    items:
      - items:
          - description: phandle to system controller
          - description: offset of trim registers
    description:
      Phandle and offset to the system controller containing the TSU
      calibration trim values. The offset points to the first trim register
      (OTPTSU1TRMVAL0), with the second trim register (OTPTSU1TRMVAL1) located
      at offset + 4.

required:
  - compatible
  - reg
  - clocks
  - power-domains
  - interrupts
  - interrupt-names
  - "#thermal-sensor-cells"

allOf:
  - if:
      properties:
        compatible:
          contains:
            const: renesas,r9a09g047-tsu
    then:
      required:
        - resets
        - renesas,tsu-trim

  - if:
      properties:
        compatible:
          contains:
            const: renesas,r9a09g077-tsu
    then:
      properties:
        resets: false
        renesas,tsu-trim: false

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/renesas,r9a09g047-cpg.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>

    thermal-sensor@14002000 {
        compatible = "renesas,r9a09g047-tsu";
        reg = <0x14002000 0x1000>;
        clocks = <&cpg CPG_MOD 0x10a>;
        resets = <&cpg 0xf8>;
        power-domains = <&cpg>;
        interrupts = <GIC_SPI 250 IRQ_TYPE_EDGE_RISING>,
                     <GIC_SPI 251 IRQ_TYPE_LEVEL_HIGH>;
        interrupt-names = "adi", "adcmpi";
        #thermal-sensor-cells = <0>;
        renesas,tsu-trim = <&sys 0x330>;
    };