dt-bindings: Remove "status" from examples
[linux-block.git] / Documentation / devicetree / bindings / soc / qcom / qcom,gsbi.txt
CommitLineData
08f9234a
AG
1QCOM GSBI (General Serial Bus Interface) Driver
2
3The GSBI controller is modeled as a node with zero or more child nodes, each
4representing a serial sub-node device that is mux'd as part of the GSBI
5configuration settings. The mode setting will govern the input/output mode of
6the 4 GSBI IOs.
7
8Required properties:
e5fdad68
AG
9- compatible: Should contain "qcom,gsbi-v1.0.0"
10- cell-index: Should contain the GSBI index
08f9234a
AG
11- reg: Address range for GSBI registers
12- clocks: required clock
13- clock-names: must contain "iface" entry
14- qcom,mode : indicates MUX value for configuration of the serial interface.
15 Please reference dt-bindings/soc/qcom,gsbi.h for valid mux values.
16
17Optional properties:
18- qcom,crci : indicates CRCI MUX value for QUP CRCI ports. Please reference
19 dt-bindings/soc/qcom,gsbi.h for valid CRCI mux values.
e5fdad68
AG
20- syscon-tcsr: indicates phandle of TCSR syscon node. Required if child uses
21 dma.
08f9234a
AG
22
23Required properties if child node exists:
24- #address-cells: Must be 1
25- #size-cells: Must be 1
26- ranges: Must be present
27
28Properties for children:
29
30A GSBI controller node can contain 0 or more child nodes representing serial
31devices. These serial devices can be a QCOM UART, I2C controller, spi
32controller, or some combination of aforementioned devices.
33
34See the following for child node definitions:
35Documentation/devicetree/bindings/i2c/qcom,i2c-qup.txt
36Documentation/devicetree/bindings/spi/qcom,spi-qup.txt
37Documentation/devicetree/bindings/serial/qcom,msm-uartdm.txt
38
39Example for APQ8064:
40
41#include <dt-bindings/soc/qcom,gsbi.h>
42
43 gsbi4@16300000 {
44 compatible = "qcom,gsbi-v1.0.0";
e5fdad68 45 cell-index = <4>;
08f9234a
AG
46 reg = <0x16300000 0x100>;
47 clocks = <&gcc GSBI4_H_CLK>;
48 clock-names = "iface";
49 #address-cells = <1>;
50 #size-cells = <1>;
51 ranges;
52 qcom,mode = <GSBI_PROT_I2C_UART>;
53 qcom,crci = <GSBI_CRCI_QUP>;
54
e5fdad68
AG
55 syscon-tcsr = <&tcsr>;
56
08f9234a
AG
57 /* child nodes go under here */
58
59 i2c_qup4: i2c@16380000 {
e5fdad68
AG
60 compatible = "qcom,i2c-qup-v1.1.1";
61 reg = <0x16380000 0x1000>;
62 interrupts = <0 153 0>;
08f9234a 63
e5fdad68
AG
64 clocks = <&gcc GSBI4_QUP_CLK>, <&gcc GSBI4_H_CLK>;
65 clock-names = "core", "iface";
08f9234a 66
e5fdad68 67 clock-frequency = <200000>;
08f9234a 68
e5fdad68
AG
69 #address-cells = <1>;
70 #size-cells = <0>;
08f9234a 71
e5fdad68 72 };
08f9234a
AG
73
74 uart4: serial@16340000 {
75 compatible = "qcom,msm-uartdm-v1.3", "qcom,msm-uartdm";
76 reg = <0x16340000 0x1000>,
77 <0x16300000 0x1000>;
78 interrupts = <0 152 0x0>;
79 clocks = <&gcc GSBI4_UART_CLK>, <&gcc GSBI4_H_CLK>;
80 clock-names = "core", "iface";
08f9234a
AG
81 };
82 };
83
e5fdad68
AG
84 tcsr: syscon@1a400000 {
85 compatible = "qcom,apq8064-tcsr", "syscon";
86 reg = <0x1a400000 0x100>;
87 };