summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/i2c/st,nomadik-i2c.yaml
blob: 44c54b162bb10741ec7aac70d165403c28176eba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/i2c/st,nomadik-i2c.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: ST Microelectronics Nomadik I2C

description: The Nomadik I2C host controller began its life in the ST
  Microelectronics STn8800 SoC, and was then inherited into STn8810 and
  STn8815. It was part of the prototype STn8500 which then became ST-Ericsson
  DB8500 after the merge of these two companies wireless divisions.

maintainers:
  - Linus Walleij <linus.walleij@linaro.org>

# Need a custom select here or 'arm,primecell' will match on lots of nodes
select:
  properties:
    compatible:
      contains:
        enum:
          - st,nomadik-i2c
          - mobileye,eyeq5-i2c
  required:
    - compatible

properties:
  compatible:
    oneOf:
      - items:
          - const: st,nomadik-i2c
          - const: arm,primecell
      - items:
          - const: stericsson,db8500-i2c
          - const: st,nomadik-i2c
          - const: arm,primecell
      - items:
          - const: mobileye,eyeq5-i2c
          - const: arm,primecell

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 2

  clock-names:
    oneOf:
      # Clock name in STn8815
      - items:
          - const: mclk
          - const: apb_pclk
      # Clock name in DB8500 or EyeQ5
      - items:
          - const: i2cclk
          - const: apb_pclk

  power-domains:
    maxItems: 1

  resets:
    maxItems: 1

  clock-frequency:
    minimum: 1
    maximum: 400000

  mobileye,olb:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    items:
      - items:
          - description: Phandle to OLB system controller node.
          - description: Platform-wide controller ID (integer starting from zero).
    description:
      The phandle pointing to OLB system controller node, with the I2C
      controller index.

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - clock-names

unevaluatedProperties: false

allOf:
  - $ref: /schemas/i2c/i2c-controller.yaml#
  - if:
      properties:
        compatible:
          contains:
            const: mobileye,eyeq5-i2c
    then:
      required:
        - mobileye,olb
    else:
      properties:
        mobileye,olb: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    #include <dt-bindings/reset/stericsson,db8500-prcc-reset.h>
    #include <dt-bindings/arm/ux500_pm_domains.h>
    i2c@80004000 {
      compatible = "stericsson,db8500-i2c", "st,nomadik-i2c", "arm,primecell";
      reg = <0x80004000 0x1000>;
      interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;

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

      clock-frequency = <400000>;
      clocks = <&prcc_kclk 3 3>, <&prcc_pclk 3 3>;
      clock-names = "i2cclk", "apb_pclk";
      power-domains = <&pm_domains DOMAIN_VAPE>;
      resets = <&prcc_reset DB8500_PRCC_3 DB8500_PRCC_3_RESET_I2C0>;
    };

    i2c@101f8000 {
      compatible = "st,nomadik-i2c", "arm,primecell";
      reg = <0x101f8000 0x1000>;
      interrupt-parent = <&vica>;
      interrupts = <20>;
      clock-frequency = <100000>;
      #address-cells = <1>;
      #size-cells = <0>;
      clocks = <&i2c0clk>, <&pclki2c0>;
      clock-names = "mclk", "apb_pclk";
    };
  - |
    #include <dt-bindings/interrupt-controller/mips-gic.h>
    i2c@300000 {
      compatible = "mobileye,eyeq5-i2c", "arm,primecell";
      reg = <0x300000 0x1000>;
      interrupt-parent = <&gic>;
      interrupts = <GIC_SHARED 1 IRQ_TYPE_LEVEL_HIGH>;
      clock-frequency = <400000>;
      #address-cells = <1>;
      #size-cells = <0>;
      clocks = <&i2c_ser_clk>, <&i2c_clk>;
      clock-names = "i2cclk", "apb_pclk";
      mobileye,olb = <&olb 0>;
    };

...