Skip to contentSkip to conversation

dt-bindings: spi: Add YAML DT binding document for trivial devices

PATCH In review Marek Vasut 3 participants 4 messages Apr 7, 2022 – Apr 8, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: spi: Add YAML DT binding document for trivial devices

Document trivial SPI devices in single YAML DT binding document. Currently this overlaps Linux kernel spidev.

To: [email protected]

---
 .../devicetree/bindings/spi/trivial.yaml      | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/trivial.yaml
Documentation/devicetree/bindings/spi/trivial.yaml new file +51 -0
new file mode 100644
index 0000000000000..6d6e682948dfc
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/trivial.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Trivial SPI device DT bindings
+
+maintainers:
+  - Marek Vasut <[email protected]>
+  - Mark Brown <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - cisco,spi-petra
+      - dh,dhcom-board
+      - lineartechnology,ltc2488
+      - lwn,bk4
+      - menlo,m53cpld
+      - micron,spi-authenta
+      - rohm,dh2228fv
+      - semtech,sx1301
+
+  reg:
+    description: Chip select
+    maxItems: 1
+
+  spi-max-frequency: true
+  spi-cs-high: true
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      spidev@0 {
+        compatible = "rohm,dh2228fv";
+        reg = <0>;
+        spi-max-frequency = <1000000>;
+      };
+    };
Signature · 1 line
2.35.1
#1 lore raw
Quoted 1 line · Marek Vasut

'dt-bindings' pretty much implies or says 'YAML DT binding document' already. Given limited subject line, don't repeat yourself.

Quoted 19 lines

Document trivial SPI devices in single YAML DT binding document. Currently this overlaps Linux kernel spidev.

To: [email protected]

---
 .../devicetree/bindings/spi/trivial.yaml      | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/trivial.yaml
Documentation/devicetree/bindings/spi/trivial.yaml new file +0 -0
new file mode 100644
index 0000000000000..6d6e682948dfc

Documentation/devicetree/bindings/spi/trivial.yaml line 8

Quoted 8 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +8 -0
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/spi/trivial.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Trivial SPI device DT bindings
+

Add 'description' and describe what devices do and don't qualify as trivial. (And you can't say 'spidev' :)).

Documentation/devicetree/bindings/spi/trivial.yaml line 19

Quoted 11 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +11 -0
+maintainers:
+  - Marek Vasut <[email protected]>
+  - Mark Brown <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - cisco,spi-petra
+      - dh,dhcom-board
+      - lineartechnology,ltc2488
+      - lwn,bk4

This one is a *board*!. Wait, and a device... I suppose that's possible if the board can be a device in another system. Except both are used in the same dts file. That should create some nice warnings, but I'm not sure anyone is paying attention to fsl.yaml warnings.

In any case, we're left with Documentation/devicetree/bindings/misc/lwn-bk4.txt. That and any other cases need to be deleted.

Documentation/devicetree/bindings/spi/trivial.yaml line 22

Quoted 3 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +3 -0
+      - menlo,m53cpld
+      - micron,spi-authenta
+      - rohm,dh2228fv

This is a DAC. We have lots of DACs in trivial-devices.yaml already. How does one decide where to document?

Documentation/devicetree/bindings/spi/trivial.yaml line 30

Quoted 8 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +8 -0
+      - semtech,sx1301
+
+  reg:
+    description: Chip select
+    maxItems: 1
+
+  spi-max-frequency: true
+  spi-cs-high: true

Reference spi-peripheral-props.yaml and drop these. Will also need to use unevaluatedProperties.

Quoted 6 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +6 -0
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false

Documentation/devicetree/bindings/spi/trivial.yaml line 46

Quoted 10 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +10 -0
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      spidev@0 {

dac@0

Quoted 8 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +5 -1
+        compatible = "rohm,dh2228fv";
+        reg = <0>;
+        spi-max-frequency = <1000000>;
+      };
+    };
--

2.35.1

#2 lore raw

On 4/7/22 22:35, Rob Herring wrote:

[...]

Quoted 8 lines

Documentation/devicetree/bindings/spi/trivial.yaml line 8

Quoted 5 lines

+$id: http://devicetree.org/schemas/spi/trivial.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#

Documentation/devicetree/bindings/spi/trivial.yaml new file +3 -0
+
+title: Trivial SPI device DT bindings
+

Add 'description' and describe what devices do and don't qualify as trivial. (And you can't say 'spidev' :)).

I got as far as here and then realized all the devices I need to document do fit the trivial-devices.yaml ... so, patches are out, please drop this patch for now.

Quoted 17 lines

Documentation/devicetree/bindings/spi/trivial.yaml line 19

Quoted 11 lines
Documentation/devicetree/bindings/spi/trivial.yaml new file +11 -0
+maintainers:
+  - Marek Vasut <[email protected]>
+  - Mark Brown <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - cisco,spi-petra
+      - dh,dhcom-board
+      - lineartechnology,ltc2488
+      - lwn,bk4

This one is a *board*!. Wait, and a device... I suppose that's possible if the board can be a device in another system. Except both are used in the same dts file. That should create some nice warnings, but I'm not sure anyone is paying attention to fsl.yaml warnings.

Quoted 3 lines

In any case, we're left with Documentation/devicetree/bindings/misc/lwn-bk4.txt. That and any other cases need to be deleted.

+CC Lukasz.

maintainer
#3 lore raw
In reply to Marek Vasut
Quoted 7 lines · Marek Vasut

Document trivial SPI devices in single YAML DT binding document. Currently this overlaps Linux kernel spidev.

Quoted 6 lines

To: [email protected]

---
 .../devicetree/bindings/spi/trivial.yaml      | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/trivial.yaml

Running 'make dtbs_check' with the schema in this patch gives the following warnings. Consider if they are expected or the schema is incorrect. These may not be new warnings.

Note that it is not yet a requirement to have 0 warnings for dtbs_check. This will change in the future.

Full log is available here: https://patchwork.ozlabs.org/patch/

/: '#address-cells', '#size-cells', 'aliases', 'chosen', 'cpus', 'fxosc', 'iio-hwmon', 'leds', 'memory@80000000', 'model', 'oscillator-audio', 'oscillator-ethernet', 'regulator-3p3v', 'regulator-vcc3v3mcu', 'soc', 'spi-gpio', 'sxosc', 'syscon-reboot' do not match any of the regexes: 'pinctrl-[0-9]+'

	arch/arm/boot/dts/vf610-bk4.dtb

channel@0: '#address-cells', '#size-cells', 'spi-cpha' do not match any of the regexes: 'pinctrl-[0-9]+'
arch/arm/boot/dts/am335x-sancloud-bbe-lite.dtb

/: compatible: ['lwn,bk4', 'fsl,vf610'] is too long

	arch/arm/boot/dts/vf610-bk4.dtb

dac@0: 'spi-cpha', 'spi-cpol' do not match any of the regexes: 'pinctrl-[0-9]+'

	arch/arm/boot/dts/rv1108-elgin-r1.dtb

/: 'reg' is a required property

	arch/arm/boot/dts/vf610-bk4.dtb

slave: 'reg' is a required property

	arch/arm/boot/dts/vf610-bk4.dtb

spidev0@0: 'fsl,spi-cs-sck-delay', 'fsl,spi-sck-cs-delay' do not match any of the regexes: 'pinctrl-[0-9]+'

	arch/arm/boot/dts/vf610-bk4.dtb