Documentation/devicetree/bindings/i2c/st,nomadik-i2c.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/i2c/st,nomadik-i2c.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: ST Microelectronics Nomadik I2C
   8
   9 description: The Nomadik I2C host controller began its life in the ST
  10   Microelectronics STn8800 SoC, and was then inherited into STn8810 and
  11   STn8815. It was part of the prototype STn8500 which then became ST-Ericsson
  12   DB8500 after the merge of these two companies wireless divisions.
  13
  14 maintainers:
  15   - Linus Walleij <linus.walleij@linaro.org>
  16
  17 # Need a custom select here or 'arm,primecell' will match on lots of nodes
  18 select:
  19   properties:
  20     compatible:
  21       contains:
  22         enum:
  23           - st,nomadik-i2c
  24           - mobileye,eyeq5-i2c
  25           - mobileye,eyeq6h-i2c
  26   required:
  27     - compatible
  28
  29 properties:
  30   compatible:
  31     oneOf:
  32       - items:
  33           - enum:
  34               - st,nomadik-i2c
  35               - mobileye,eyeq5-i2c
  36               - mobileye,eyeq6h-i2c
  37           - const: arm,primecell
  38       - items:
  39           - const: stericsson,db8500-i2c
  40           - const: st,nomadik-i2c
  41           - const: arm,primecell
  42
  43   reg:
  44     maxItems: 1
  45
  46   interrupts:
  47     maxItems: 1
  48
  49   clocks:
  50     maxItems: 2
  51
  52   clock-names:
  53     oneOf:
  54       # Clock name in STn8815
  55       - items:
  56           - const: mclk
  57           - const: apb_pclk
  58       # Clock name in DB8500 or EyeQ
  59       - items:
  60           - const: i2cclk
  61           - const: apb_pclk
  62
  63   power-domains:
  64     maxItems: 1
  65
  66   resets:
  67     maxItems: 1
  68
  69   clock-frequency:
  70     minimum: 1
  71     maximum: 3400000
  72
  73   mobileye,olb:
  74     $ref: /schemas/types.yaml#/definitions/phandle-array
  75     items:
  76       - items:
  77           - description: Phandle to OLB system controller node.
  78           - description: Platform-wide controller ID (integer starting from zero).
  79     description:
  80       The phandle pointing to OLB system controller node, with the I2C
  81       controller index.
  82
  83 required:
  84   - compatible
  85   - reg
  86   - interrupts
  87   - clocks
  88   - clock-names
  89
  90 unevaluatedProperties: false
  91
  92 allOf:
  93   - $ref: /schemas/i2c/i2c-controller.yaml#
  94   - if:
  95       properties:
  96         compatible:
  97           contains:
  98             const: mobileye,eyeq5-i2c
  99     then:
 100       required:
 101         - mobileye,olb
 102     else:
 103       properties:
 104         mobileye,olb: false
 105
 106 examples:
 107   - |
 108     #include <dt-bindings/interrupt-controller/irq.h>
 109     #include <dt-bindings/interrupt-controller/arm-gic.h>
 110     #include <dt-bindings/reset/stericsson,db8500-prcc-reset.h>
 111     #include <dt-bindings/arm/ux500_pm_domains.h>
 112     i2c@80004000 {
 113       compatible = "stericsson,db8500-i2c", "st,nomadik-i2c", "arm,primecell";
 114       reg = <0x80004000 0x1000>;
 115       interrupts = <GIC_SPI 21 IRQ_TYPE_LEVEL_HIGH>;
 116
 117       #address-cells = <1>;
 118       #size-cells = <0>;
 119
 120       clock-frequency = <400000>;
 121       clocks = <&prcc_kclk 3 3>, <&prcc_pclk 3 3>;
 122       clock-names = "i2cclk", "apb_pclk";
 123       power-domains = <&pm_domains DOMAIN_VAPE>;
 124       resets = <&prcc_reset DB8500_PRCC_3 DB8500_PRCC_3_RESET_I2C0>;
 125     };
 126
 127     i2c@101f8000 {
 128       compatible = "st,nomadik-i2c", "arm,primecell";
 129       reg = <0x101f8000 0x1000>;
 130       interrupt-parent = <&vica>;
 131       interrupts = <20>;
 132       clock-frequency = <100000>;
 133       #address-cells = <1>;
 134       #size-cells = <0>;
 135       clocks = <&i2c0clk>, <&pclki2c0>;
 136       clock-names = "mclk", "apb_pclk";
 137     };
 138   - |
 139     #include <dt-bindings/interrupt-controller/mips-gic.h>
 140     i2c@300000 {
 141       compatible = "mobileye,eyeq5-i2c", "arm,primecell";
 142       reg = <0x300000 0x1000>;
 143       interrupt-parent = <&gic>;
 144       interrupts = <GIC_SHARED 1 IRQ_TYPE_LEVEL_HIGH>;
 145       clock-frequency = <400000>;
 146       #address-cells = <1>;
 147       #size-cells = <0>;
 148       clocks = <&i2c_ser_clk>, <&i2c_clk>;
 149       clock-names = "i2cclk", "apb_pclk";
 150       mobileye,olb = <&olb 0>;
 151     };
 152
 153 ...