xref: /freebsd/sys/contrib/device-tree/Bindings/mtd/ti,elm.yaml (revision af23369a6deaaeb612ab266eb88b8bb8d560c322) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/mtd/ti,elm.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Texas Instruments Error Location Module (ELM).
8
9maintainers:
10  - Roger Quadros <rogerq@kernel.org>
11
12description:
13  ELM module is used together with GPMC and NAND Flash to detect
14  errors and the location of the error based on BCH algorithms
15  so they can be corrected if possible.
16
17properties:
18  compatible:
19    enum:
20      - ti,am3352-elm
21      - ti,am64-elm
22
23  reg:
24    maxItems: 1
25
26  interrupts:
27    maxItems: 1
28
29  clocks:
30    maxItems: 1
31    description: Functional clock.
32
33  clock-names:
34    items:
35      - const: fck
36
37  power-domains:
38    maxItems: 1
39
40  ti,hwmods:
41    description:
42      Name of the HWMOD associated with ELM. This is for legacy
43      platforms only.
44    $ref: /schemas/types.yaml#/definitions/string
45    deprecated: true
46
47required:
48  - compatible
49  - reg
50  - interrupts
51
52allOf:
53  - if:
54      properties:
55        compatible:
56          contains:
57            const: ti,am64-elm
58    then:
59      required:
60        - clocks
61        - clock-names
62        - power-domains
63
64additionalProperties: false
65
66examples:
67  - |
68    elm: ecc@0 {
69        compatible = "ti,am3352-elm";
70        reg = <0x0 0x2000>;
71        interrupts = <4>;
72    };
73