Skip to content

Commit

Permalink
spi: omap-spi: Convert to json-schema
Browse files Browse the repository at this point in the history
Convert omap-spi dt-binding documentation from txt to yaml format.

Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20210621092900.951-1-a-govindraju@ti.com
Signed-off-by: Mark Brown <broonie@kernel.org>
  • Loading branch information
Aswath Govindraju authored and Mark Brown committed Jul 14, 2021
1 parent f84d866 commit 014861c
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 48 deletions.
48 changes: 0 additions & 48 deletions Documentation/devicetree/bindings/spi/omap-spi.txt

This file was deleted.

117 changes: 117 additions & 0 deletions Documentation/devicetree/bindings/spi/omap-spi.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/spi/omap-spi.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: SPI controller bindings for OMAP and K3 SoCs

maintainers:
- Aswath Govindraju <a-govindraju@ti.com>

allOf:
- $ref: spi-controller.yaml#

properties:
compatible:
oneOf:
- items:
- enum:
- ti,am654-mcspi
- ti,am4372-mcspi
- const: ti,omap4-mcspi
- items:
- enum:
- ti,omap2-mcspi
- ti,omap4-mcspi

reg:
maxItems: 1

interrupts:
maxItems: 1

clocks:
maxItems: 1

power-domains:
maxItems: 1

ti,spi-num-cs:
$ref: /schemas/types.yaml#/definitions/uint32
description: Number of chipselect supported by the instance.
minimum: 1
maximum: 4

ti,hwmods:
$ref: /schemas/types.yaml#/definitions/string
description:
Must be "mcspi<n>", n being the instance number (1-based).
This property is applicable only on legacy platforms mainly omap2/3
and ti81xx and should not be used on other platforms.
deprecated: true

ti,pindir-d0-out-d1-in:
description:
Select the D0 pin as output and D1 as input. The default is D0
as input and D1 as output.
type: boolean

dmas:
description:
List of DMA specifiers with the controller specific format as
described in the generic DMA client binding. A tx and rx
specifier is required for each chip select.
minItems: 1
maxItems: 8

dma-names:
description:
List of DMA request names. These strings correspond 1:1 with
the DMA sepecifiers listed in dmas. The string names is to be
"rxN" and "txN" for RX and TX requests, respectively. Where N
is the chip select number.
minItems: 1
maxItems: 8

required:
- compatible
- reg
- interrupts

unevaluatedProperties: false

if:
properties:
compatible:
oneOf:
- const: ti,omap2-mcspi
- const: ti,omap4-mcspi

then:
properties:
ti,hwmods:
items:
- pattern: "^mcspi([1-9])$"

else:
properties:
ti,hwmods: false

examples:
- |
#include <dt-bindings/interrupt-controller/irq.h>
#include <dt-bindings/interrupt-controller/arm-gic.h>
#include <dt-bindings/soc/ti,sci_pm_domain.h>
spi@2100000 {
compatible = "ti,am654-mcspi","ti,omap4-mcspi";
reg = <0x2100000 0x400>;
interrupts = <GIC_SPI 184 IRQ_TYPE_LEVEL_HIGH>;
clocks = <&k3_clks 137 1>;
power-domains = <&k3_pds 137 TI_SCI_PD_EXCLUSIVE>;
#address-cells = <1>;
#size-cells = <0>;
dmas = <&main_udmap 0xc500>, <&main_udmap 0x4500>;
dma-names = "tx0", "rx0";
};

0 comments on commit 014861c

Please sign in to comment.