summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/pinctrl/pinctrl-mt8195.yaml
blob: 5e2bb2bf3a55f860582462709edbef6d636fc653 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/pinctrl/pinctrl-mt8195.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Mediatek MT8195 Pin Controller

maintainers:
  - Sean Wang <sean.wang@mediatek.com>

description: |
  The Mediatek's Pin controller is used to control SoC pins.

properties:
  compatible:
    const: mediatek,mt8195-pinctrl

  gpio-controller: true

  '#gpio-cells':
    description: |
      Number of cells in GPIO specifier. Since the generic GPIO binding is used,
      the amount of cells must be specified as 2. See the below
      mentioned gpio binding representation for description of particular cells.
    const: 2

  gpio-ranges:
    description: gpio valid number range.
    maxItems: 1

  reg:
    description: |
      Physical address base for gpio base registers. There are 8 GPIO
      physical address base in mt8195.
    maxItems: 8

  reg-names:
    description: |
      Gpio base register names.
    maxItems: 8

  interrupt-controller: true

  '#interrupt-cells':
    const: 2

  interrupts:
    description: The interrupt outputs to sysirq.
    maxItems: 1

  mediatek,rsel_resistance_in_si_unit:
    type: boolean
    description: |
      Identifying i2c pins pull up/down type which is RSEL. It can support
      RSEL define or si unit value(ohm) to set different resistance.

#PIN CONFIGURATION NODES
patternProperties:
  '-pins$':
    type: object
    description: |
      A pinctrl node should contain at least one subnodes representing the
      pinctrl groups available on the machine. Each subnode will list the
      pins it needs, and how they should be configured, with regard to muxer
      configuration, pullups, drive strength, input enable/disable and
      input schmitt.
      An example of using macro:
      pincontroller {
        /* GPIO0 set as multifunction GPIO0 */
        gpio_pin {
          pinmux = <PINMUX_GPIO0__FUNC_GPIO0>;
        };
        /* GPIO8 set as multifunction SDA0 */
        i2c0_pin {
          pinmux = <PINMUX_GPIO8__FUNC_SDA0>;
        };
      };
    $ref: "pinmux-node.yaml"

    properties:
      pinmux:
        description: |
          Integer array, represents gpio pin number and mux setting.
          Supported pin number and mux varies for different SoCs, and are defined
          as macros in dt-bindings/pinctrl/<soc>-pinfunc.h directly.

      drive-strength:
        enum: [2, 4, 6, 8, 10, 12, 14, 16]

      bias-pull-down:
        description: |
          For pull down type is normal, it don't need add RSEL & R1R0 define
          and resistance value.
          For pull down type is PUPD/R0/R1 type, it can add R1R0 define to
          set different resistance. It can support "MTK_PUPD_SET_R1R0_00" &
          "MTK_PUPD_SET_R1R0_01" & "MTK_PUPD_SET_R1R0_10" & "MTK_PUPD_SET_R1R0_11"
          define in mt8195.
          For pull down type is RSEL, it can add RSEL define & resistance value(ohm)
          to set different resistance by identifying property "mediatek,rsel_resistance_in_si_unit".
          It can support "MTK_PULL_SET_RSEL_000" & "MTK_PULL_SET_RSEL_001"
          & "MTK_PULL_SET_RSEL_010" & "MTK_PULL_SET_RSEL_011" & "MTK_PULL_SET_RSEL_100"
          & "MTK_PULL_SET_RSEL_101" & "MTK_PULL_SET_RSEL_110" & "MTK_PULL_SET_RSEL_111"
          define in mt8195. It can also support resistance value(ohm) "75000" & "5000" in mt8195.
          oneOf:
            - enum: [100, 101, 102, 103]
            - description: mt8195 pull down PUPD/R0/R1 type define value.
            - enum: [200, 201, 202, 203, 204, 205, 206, 207]
            - description: mt8195 pull down RSEL type define value.
            - enum: [75000, 5000]
            - description: mt8195 pull down RSEL type si unit value(ohm).

          An example of using RSEL define:
          pincontroller {
            i2c0_pin {
              pinmux = <PINMUX_GPIO8__FUNC_SDA0>;
              bias-pull-down = <MTK_PULL_SET_RSEL_001>;
            };
          };
          An example of using si unit resistance value(ohm):
          &pio {
            mediatek,rsel_resistance_in_si_unit;
          }
          pincontroller {
            i2c0_pin {
              pinmux = <PINMUX_GPIO8__FUNC_SDA0>;
              bias-pull-down = <75000>;
            };
          };

      bias-pull-up:
        description: |
          For pull up type is normal, it don't need add RSEL & R1R0 define
          and resistance value.
          For pull up type is PUPD/R0/R1 type, it can add R1R0 define to
          set different resistance. It can support "MTK_PUPD_SET_R1R0_00" &
          "MTK_PUPD_SET_R1R0_01" & "MTK_PUPD_SET_R1R0_10" & "MTK_PUPD_SET_R1R0_11"
          define in mt8195.
          For pull up type is RSEL, it can add RSEL define & resistance value(ohm)
          to set different resistance by identifying property "mediatek,rsel_resistance_in_si_unit".
          It can support "MTK_PULL_SET_RSEL_000" & "MTK_PULL_SET_RSEL_001"
          & "MTK_PULL_SET_RSEL_010" & "MTK_PULL_SET_RSEL_011" & "MTK_PULL_SET_RSEL_100"
          & "MTK_PULL_SET_RSEL_101" & "MTK_PULL_SET_RSEL_110" & "MTK_PULL_SET_RSEL_111"
          define in mt8195. It can also support resistance value(ohm)
          "1000" & "1500" & "2000" & "3000" & "4000" & "5000" & "10000" & "75000" in mt8195.
          oneOf:
            - enum: [100, 101, 102, 103]
            - description: mt8195 pull up PUPD/R0/R1 type define value.
            - enum: [200, 201, 202, 203, 204, 205, 206, 207]
            - description: mt8195 pull up RSEL type define value.
            - enum: [1000, 1500, 2000, 3000, 4000, 5000, 10000, 75000]
            - description: mt8195 pull up RSEL type si unit value(ohm).
          An example of using RSEL define:
          pincontroller {
            i2c0_pin {
              pinmux = <PINMUX_GPIO8__FUNC_SDA0>;
              bias-pull-up = <MTK_PULL_SET_RSEL_001>;
            };
          };
          An example of using si unit resistance value(ohm):
          &pio {
            mediatek,rsel_resistance_in_si_unit;
          }
          pincontroller {
            i2c0_pin {
              pinmux = <PINMUX_GPIO8__FUNC_SDA0>;
              bias-pull-up = <1000>;
            };
          };

      bias-disable: true

      output-high: true

      output-low: true

      input-enable: true

      input-disable: true

      input-schmitt-enable: true

      input-schmitt-disable: true

    required:
      - pinmux

    additionalProperties: false

required:
  - compatible
  - reg
  - interrupts
  - interrupt-controller
  - '#interrupt-cells'
  - gpio-controller
  - '#gpio-cells'
  - gpio-ranges

additionalProperties: false

examples:
  - |
            #include <dt-bindings/pinctrl/mt8195-pinfunc.h>
            #include <dt-bindings/interrupt-controller/arm-gic.h>
            pio: pinctrl@10005000 {
                    compatible = "mediatek,mt8195-pinctrl";
                    reg = <0x10005000 0x1000>,
                          <0x11d10000 0x1000>,
                          <0x11d30000 0x1000>,
                          <0x11d40000 0x1000>,
                          <0x11e20000 0x1000>,
                          <0x11eb0000 0x1000>,
                          <0x11f40000 0x1000>,
                          <0x1000b000 0x1000>;
                    reg-names = "iocfg0", "iocfg_bm", "iocfg_bl",
                          "iocfg_br", "iocfg_lm", "iocfg_rb",
                          "iocfg_tl", "eint";
                    gpio-controller;
                    #gpio-cells = <2>;
                    gpio-ranges = <&pio 0 0 144>;
                    interrupt-controller;
                    interrupts = <GIC_SPI 225 IRQ_TYPE_LEVEL_HIGH 0>;
                    #interrupt-cells = <2>;

                    pio-pins {
                      pinmux = <PINMUX_GPIO0__FUNC_GPIO0>;
                      output-low;
                    };
            };