Commit d45c6e7a authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring
Browse files

dt-bindings: nfc: st,st95hf: convert to dtschema

parent 4d9bae33
Loading
Loading
Loading
Loading
+57 −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/net/nfc/st,st95hf.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: STMicroelectronics ST95HF NFC controller

maintainers:
  - Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>

properties:
  compatible:
    const: st,st95hf

  enable-gpio:
    description: Output GPIO pin used for enabling/disabling the controller

  interrupts:
    maxItems: 1

  reg:
    maxItems: 1

  st95hfvin-supply:
    description: ST95HF transceiver's Vin regulator supply

  spi-max-frequency: true

required:
  - compatible
  - enable-gpio
  - interrupts
  - reg
  - spi-max-frequency

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/interrupt-controller/irq.h>

    spi {
        #address-cells = <1>;
        #size-cells = <0>;

        nfc@0{
            compatible = "st,st95hf";
            reg = <0>;

            spi-max-frequency = <1000000>;
            enable-gpio = <&pio4 GPIO_ACTIVE_HIGH>;
            interrupt-parent = <&pio0>;
            interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
        };
    };
+0 −45
Original line number Diff line number Diff line
* STMicroelectronics : NFC Transceiver ST95HF

ST NFC Transceiver is required to attach with SPI bus.
ST95HF node should be defined in DT as SPI slave device of SPI
master with which ST95HF transceiver is physically connected.
The properties defined below are required to be the part of DT
to include ST95HF transceiver into the platform.

Required properties:
===================
- reg: Address of SPI slave "ST95HF transceiver" on SPI master bus.

- compatible: should be "st,st95hf" for ST95HF NFC transceiver

- spi-max-frequency: Max. operating SPI frequency for ST95HF
	transceiver.

- enable-gpio: GPIO line to enable ST95HF transceiver.

- interrupts : Standard way to define ST95HF transceiver's out
	interrupt.

Optional property:
=================
- st95hfvin-supply : This is an optional property. It contains a
	phandle to ST95HF transceiver's regulator supply node in DT.

Example:
=======
spi@9840000 {
	reg = <0x9840000 0x110>;
	#address-cells = <1>;
	#size-cells = <0>;
	cs-gpios = <&pio0 4>;

	st95hf@0{
		reg = <0>;
		compatible = "st,st95hf";
		spi-max-frequency = <1000000>;
		enable-gpio = <&pio4 0>;
		interrupt-parent = <&pio0>;
		interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
	};

};