Commit ac739bac authored by Biju Das's avatar Biju Das Committed by Alexandre Belloni
Browse files

dt-bindings: rtc: isl1208: Convert to json-schema



Convert the isl1208 RTC device tree binding documentation to json-schema.

Update the example to match reality.

Signed-off-by: default avatarBiju Das <biju.das.jz@bp.renesas.com>
Reviewed-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20230623140948.384762-5-biju.das.jz@bp.renesas.com


Signed-off-by: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
parent 0e6f36cc
Loading
Loading
Loading
Loading
+0 −38
Original line number Diff line number Diff line
Intersil ISL1209/19 I2C RTC/Alarm chip with event in

ISL12X9 have additional pins EVIN and #EVDET for tamper detection, while the
ISL1208 and ISL1218 do not.  They are all use the same driver with the bindings
described here, with chip specific properties as noted.

Required properties supported by the device:
 - "compatible": Should be one of the following:
		- "isil,isl1208"
		- "isil,isl1209"
		- "isil,isl1218"
		- "isil,isl1219"
 - "reg": I2C bus address of the device

Optional properties:
 - "interrupt-names": list which may contains "irq" and "evdet"
	evdet applies to isl1209 and isl1219 only
 - "interrupts": list of interrupts for "irq" and "evdet"
	evdet applies to isl1209 and isl1219 only
 - "isil,ev-evienb": Enable or disable internal pull on EVIN pin
	Applies to isl1209 and isl1219 only
	Possible values are 0 and 1
	Value 0 enables internal pull-up on evin pin, 1 disables it.
	Default will leave the non-volatile configuration of the pullup
	as is.

Example isl1219 node with #IRQ pin connected to SoC gpio1 pin12 and #EVDET pin
connected to SoC gpio2 pin 24 and internal pull-up enabled in EVIN pin.

	isl1219: rtc@68 {
		compatible = "isil,isl1219";
		reg = <0x68>;
		interrupt-names = "irq", "evdet";
		interrupts-extended = <&gpio1 12 IRQ_TYPE_EDGE_FALLING>,
			<&gpio2 24 IRQ_TYPE_EDGE_FALLING>;
		isil,ev-evienb = <1>;
	};
+89 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/rtc/isil,isl1208.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Intersil ISL1209/19 I2C RTC/Alarm chip with event in

maintainers:
  - Biju Das <biju.das.jz@bp.renesas.com>
  - Trent Piepho <tpiepho@gmail.com>

description:
  ISL12X9 have additional pins EVIN and EVDET for tamper detection, while the
  ISL1208 and ISL1218 do not.

properties:
  compatible:
    enum:
      - isil,isl1208
      - isil,isl1209
      - isil,isl1218
      - isil,isl1219

  reg:
    maxItems: 1

  interrupts:
    minItems: 1
    maxItems: 2

  interrupt-names:
    minItems: 1
    items:
      - const: irq
      - const: evdet

  isil,ev-evienb:
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [ 0, 1 ]
    description: |
      Enable or disable internal pull on EVIN pin
      Default will leave the non-volatile configuration of the pullup
      as is.
        <0> : Enables internal pull-up on evin pin
        <1> : Disables internal pull-up on evin pin

required:
  - compatible
  - reg

allOf:
  - $ref: rtc.yaml#
  - if:
      properties:
        compatible:
          contains:
            enum:
              - isil,isl1209
              - isil,isl1219
    then:
      properties:
        interrupts:
          maxItems: 2
        interrupt-names:
          items:
            - const: irq
            - const: evdet
    else:
      properties:
        interrupts:
          maxItems: 1
        interrupt-names:
          items:
            - const: irq

unevaluatedProperties: false

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

        rtc_twi: rtc@6f {
            compatible = "isil,isl1208";
            reg = <0x6f>;
        };
    };