GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / pinctrl / qcom,apq8064-pinctrl.txt
1 Qualcomm APQ8064 TLMM block
2
3 Required properties:
4 - compatible: "qcom,apq8064-pinctrl"
5 - reg: Should be the base address and length of the TLMM block.
6 - interrupts: Should be the parent IRQ of the TLMM block.
7 - interrupt-controller: Marks the device node as an interrupt controller.
8 - #interrupt-cells: Should be two.
9 - gpio-controller: Marks the device node as a GPIO controller.
10 - #gpio-cells : Should be two.
11                 The first cell is the gpio pin number and the
12                 second cell is used for optional parameters.
13
14 Please refer to ../gpio/gpio.txt and ../interrupt-controller/interrupts.txt for
15 a general description of GPIO and interrupt bindings.
16
17 Please refer to pinctrl-bindings.txt in this directory for details of the
18 common pinctrl bindings used by client devices, including the meaning of the
19 phrase "pin configuration node".
20
21 Qualcomm's pin configuration nodes act as a container for an arbitrary number of
22 subnodes. Each of these subnodes represents some desired configuration for a
23 pin, a group, or a list of pins or groups. This configuration can include the
24 mux function to select on those pin(s)/group(s), and various pin configuration
25 parameters, such as pull-up, drive strength, etc.
26
27 The name of each subnode is not important; all subnodes should be enumerated
28 and processed purely based on their content.
29
30 Each subnode only affects those parameters that are explicitly listed. In
31 other words, a subnode that lists a mux function but no pin configuration
32 parameters implies no information about any pin configuration parameters.
33 Similarly, a pin subnode that describes a pullup parameter implies no
34 information about e.g. the mux function.
35
36
37 The following generic properties as defined in pinctrl-bindings.txt are valid
38 to specify in a pin configuration subnode:
39
40  pins, function, bias-disable, bias-pull-down, bias-pull,up, drive-strength,
41  output-low, output-high.
42
43 Non-empty subnodes must specify the 'pins' property.
44
45 Valid values for pins are:
46   gpio0-gpio89
47
48 Valid values for function are:
49   cam_mclk, codec_mic_i2s, codec_spkr_i2s, gp_clk_0a, gp_clk_0b, gp_clk_1a,
50   gp_clk_1b, gp_clk_2a, gp_clk_2b, gpio, gsbi1, gsbi2, gsbi3, gsbi4,
51   gsbi4_cam_i2c, gsbi5, gsbi5_spi_cs1, gsbi5_spi_cs2, gsbi5_spi_cs3, gsbi6,
52   gsbi6_spi_cs1, gsbi6_spi_cs2, gsbi6_spi_cs3, gsbi7, gsbi7_spi_cs1,
53   gsbi7_spi_cs2, gsbi7_spi_cs3, gsbi_cam_i2c, hdmi, mi2s, riva_bt, riva_fm,
54   riva_wlan, sdc2, sdc4, slimbus, spkr_i2s, tsif1, tsif2, usb2_hsic, ps_hold
55
56 Example:
57
58         msmgpio: pinctrl@800000 {
59                 compatible = "qcom,apq8064-pinctrl";
60                 reg = <0x800000 0x4000>;
61
62                 gpio-controller;
63                 #gpio-cells = <2>;
64                 interrupt-controller;
65                 #interrupt-cells = <2>;
66                 interrupts = <0 16 0x4>;
67
68                 pinctrl-names = "default";
69                 pinctrl-0 = <&gsbi5_uart_default>;
70
71                 gsbi5_uart_default: gsbi5_uart_default {
72                         mux {
73                                 pins = "gpio51", "gpio52";
74                                 function = "gsbi5";
75                         };
76
77                         tx {
78                                 pins = "gpio51";
79                                 drive-strength = <4>;
80                                 bias-disable;
81                         };
82
83                         rx {
84                                 pins = "gpio52";
85                                 drive-strength = <2>;
86                                 bias-pull-up;
87                         };
88                 };
89         };