1 # SPDX-License-Identifier: GPL-2.0-only
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/i2c/i2c-mux-gpio.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: GPIO-based I2C Bus Mux
8
9 maintainers:
10 - Wolfram Sang <wsa@kernel.org>
11
12 description: |
13 This binding describes an I2C bus multiplexer that uses GPIOs to route the I2C signals.
14
15 +-----+ +-----+
16 | dev | | dev |
17 +------------+ +-----+ +-----+
18 | SoC | | |
19 | | /--------+--------+
20 | +------+ | +------+ child bus A, on GPIO value set to 0
21 | | I2C |-|--| Mux |
22 | +------+ | +--+---+ child bus B, on GPIO value set to 1
23 | | | \----------+--------+--------+
24 | +------+ | | | | |
25 | | GPIO |-|-----+ +-----+ +-----+ +-----+
26 | +------+ | | dev | | dev | | dev |
27 +------------+ +-----+ +-----+ +-----+
28
29 For each I2C child node, an I2C child bus will be created. They will be numbered based on their
30 order in the device tree.
31
32 Whenever an access is made to a device on a child bus, the value set in the relevant node's reg
33 property will be output using the list of GPIOs, the first in the list holding the least-
34 significant value.
35
36 If an idle state is defined, using the idle-state (optional) property, whenever an access is not
37 being made to a device on a child bus, the GPIOs will be set according to the idle value.
38
39 If an idle state is not defined, the most recently used value will be left programmed into
40 hardware whenever no access is being made to a device on a child bus.
41
42 properties:
43 compatible:
44 const: i2c-mux-gpio
45
46 i2c-parent:
47 description: phandle of the I2C bus that this multiplexer's master-side port is connected to
48 $ref: /schemas/types.yaml#/definitions/phandle
49
50 mux-gpios:
51 description: list of GPIOs used to control the muxer
52 minItems: 1
53 maxItems: 4 # Should be enough
54
55 idle-state:
56 description: Value to set the muxer to when idle. When no value is given, it defaults to the
57 last value used.
58 $ref: /schemas/types.yaml#/definitions/uint32
59
60 settle-time-us:
61 description: Delay to wait before doing any transfer when a new bus gets selected.
62
63 allOf:
64 - $ref: i2c-mux.yaml
65
66 unevaluatedProperties: false
67
68 required:
69 - compatible
70 - i2c-parent
71 - mux-gpios
72
73 examples:
74 - |
75 i2cmux {
76 compatible = "i2c-mux-gpio";
77 #address-cells = <1>;
78 #size-cells = <0>;
79 mux-gpios = <&gpio1 22 0>, <&gpio1 23 0>;
80 i2c-parent = <&i2c1>;
81
82 i2c@1 {
83 reg = <1>;
84 #address-cells = <1>;
85 #size-cells = <0>;
86
87 ssd1307: oled@3c {
88 compatible = "solomon,ssd1307fb-i2c";
89 reg = <0x3c>;
90 pwms = <&pwm 4 3000>;
91 reset-gpios = <&gpio2 7 1>;
92 };
93 };
94
95 i2c@3 {
96 reg = <3>;
97 #address-cells = <1>;
98 #size-cells = <0>;
99
100 pca9555: pca9555@20 {
101 compatible = "nxp,pca9555";
102 gpio-controller;
103 #gpio-cells = <2>;
104 reg = <0x20>;
105 };
106 };
107 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.