GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / pinctrl / qcom,ipq8074-pinctrl.txt
1 Qualcomm Technologies, Inc. IPQ8074 TLMM block
2
3 This binding describes the Top Level Mode Multiplexer block found in the
4 IPQ8074 platform.
5
6 - compatible:
7         Usage: required
8         Value type: <string>
9         Definition: must be "qcom,ipq8074-pinctrl"
10
11 - reg:
12         Usage: required
13         Value type: <prop-encoded-array>
14         Definition: the base address and size of the TLMM register space.
15
16 - interrupts:
17         Usage: required
18         Value type: <prop-encoded-array>
19         Definition: should specify the TLMM summary IRQ.
20
21 - interrupt-controller:
22         Usage: required
23         Value type: <none>
24         Definition: identifies this node as an interrupt controller
25
26 - #interrupt-cells:
27         Usage: required
28         Value type: <u32>
29         Definition: must be 2. Specifying the pin number and flags, as defined
30                     in <dt-bindings/interrupt-controller/irq.h>
31
32 - gpio-controller:
33         Usage: required
34         Value type: <none>
35         Definition: identifies this node as a gpio controller
36
37 - #gpio-cells:
38         Usage: required
39         Value type: <u32>
40         Definition: must be 2. Specifying the pin number and flags, as defined
41                     in <dt-bindings/gpio/gpio.h>
42
43 Please refer to ../gpio/gpio.txt and ../interrupt-controller/interrupts.txt for
44 a general description of GPIO and interrupt bindings.
45
46 Please refer to pinctrl-bindings.txt in this directory for details of the
47 common pinctrl bindings used by client devices, including the meaning of the
48 phrase "pin configuration node".
49
50 The pin configuration nodes act as a container for an arbitrary number of
51 subnodes. Each of these subnodes represents some desired configuration for a
52 pin, a group, or a list of pins or groups. This configuration can include the
53 mux function to select on those pin(s)/group(s), and various pin configuration
54 parameters, such as pull-up, drive strength, etc.
55
56
57 PIN CONFIGURATION NODES:
58
59 The name of each subnode is not important; all subnodes should be enumerated
60 and processed purely based on their content.
61
62 Each subnode only affects those parameters that are explicitly listed. In
63 other words, a subnode that lists a mux function but no pin configuration
64 parameters implies no information about any pin configuration parameters.
65 Similarly, a pin subnode that describes a pullup parameter implies no
66 information about e.g. the mux function.
67
68
69 The following generic properties as defined in pinctrl-bindings.txt are valid
70 to specify in a pin configuration subnode:
71
72 - pins:
73         Usage: required
74         Value type: <string-array>
75         Definition: List of gpio pins affected by the properties specified in
76                     this subnode.  Valid pins are:
77                     gpio0-gpio69
78
79 - function:
80         Usage: required
81         Value type: <string>
82         Definition: Specify the alternative function to be configured for the
83                     specified pins. Functions are only valid for gpio pins.
84                     Valid values are:
85                     atest_char, atest_char0, atest_char1, atest_char2,
86                     atest_char3, audio_rxbclk, audio_rxd, audio_rxfsync,
87                     audio_rxmclk, audio_txbclk, audio_txd, audio_txfsync,
88                     audio_txmclk, blsp0_i2c, blsp0_spi, blsp0_uart, blsp1_i2c,
89                     blsp1_spi, blsp1_uart, blsp2_i2c, blsp2_spi, blsp2_uart,
90                     blsp3_i2c, blsp3_spi, blsp3_spi0, blsp3_spi1, blsp3_spi2,
91                     blsp3_spi3, blsp3_uart, blsp4_i2c0, blsp4_i2c1, blsp4_spi0,
92                     blsp4_spi1, blsp4_uart0, blsp4_uart1, blsp5_i2c, blsp5_spi,
93                     blsp5_uart, burn0, burn1, cri_trng, cri_trng0, cri_trng1,
94                     cxc0, cxc1, dbg_out, gcc_plltest, gcc_tlmm, gpio, ldo_en,
95                     ldo_update, led0, led1, led2, mac0_sa0, mac0_sa1, mac1_sa0,
96                     mac1_sa1, mac1_sa2, mac1_sa3, mac2_sa0, mac2_sa1, mdc,
97                     mdio, pcie0_clk, pcie0_rst, pcie0_wake, pcie1_clk,
98                     pcie1_rst, pcie1_wake, pcm_drx, pcm_dtx, pcm_fsync,
99                     pcm_pclk, pcm_zsi0, pcm_zsi1, prng_rosc, pta1_0, pta1_1,
100                     pta1_2, pta2_0, pta2_1, pta2_2, pwm0, pwm1, pwm2, pwm3,
101                     qdss_cti_trig_in_a0, qdss_cti_trig_in_a1,
102                     qdss_cti_trig_in_b0, qdss_cti_trig_in_b1,
103                     qdss_cti_trig_out_a0, qdss_cti_trig_out_a1,
104                     qdss_cti_trig_out_b0, qdss_cti_trig_out_b1,
105                     qdss_traceclk_a, qdss_traceclk_b, qdss_tracectl_a,
106                     qdss_tracectl_b, qdss_tracedata_a, qdss_tracedata_b,
107                     qpic, rx0, rx1, rx2, sd_card, sd_write, tsens_max, wci2a,
108                     wci2b, wci2c, wci2d
109
110 - bias-disable:
111         Usage: optional
112         Value type: <none>
113         Definition: The specified pins should be configued as no pull.
114
115 - bias-pull-down:
116         Usage: optional
117         Value type: <none>
118         Definition: The specified pins should be configued as pull down.
119
120 - bias-pull-up:
121         Usage: optional
122         Value type: <none>
123         Definition: The specified pins should be configued as pull up.
124
125 - output-high:
126         Usage: optional
127         Value type: <none>
128         Definition: The specified pins are configured in output mode, driven
129                     high.
130
131 - output-low:
132         Usage: optional
133         Value type: <none>
134         Definition: The specified pins are configured in output mode, driven
135                     low.
136
137 - drive-strength:
138         Usage: optional
139         Value type: <u32>
140         Definition: Selects the drive strength for the specified pins, in mA.
141                     Valid values are: 2, 4, 6, 8, 10, 12, 14 and 16
142
143 Example:
144
145         tlmm: pinctrl@1000000 {
146                 compatible = "qcom,ipq8074-pinctrl";
147                 reg = <0x1000000 0x300000>;
148                 interrupts = <GIC_SPI 208 IRQ_TYPE_LEVEL_HIGH>;
149                 gpio-controller;
150                 #gpio-cells = <2>;
151                 interrupt-controller;
152                 #interrupt-cells = <2>;
153
154                 uart2: uart2-default {
155                         mux {
156                                 pins = "gpio23", "gpio24";
157                                 function = "blsp4_uart1";
158                         };
159
160                         rx {
161                                 pins = "gpio23";
162                                 drive-strength = <4>;
163                                 bias-disable;
164                         };
165
166                         tx {
167                                 pins = "gpio24";
168                                 drive-strength = <2>;
169                                 bias-pull-up;
170                         };
171                 };
172         };