summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/pci/toshiba,tc9563.yaml
blob: f084830c6d0cb36ee60e2372d38a1e3228db9d4e (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
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/pci/toshiba,tc9563.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Toshiba TC9563 PCIe switch

maintainers:
  - Krishna Chaitanya Chundru <krishna.chundru@oss.qualcomm.com>

description: |
  Toshiba TC9563 PCIe switch has one upstream and three downstream ports.
  The 3rd downstream port has integrated endpoint device of Ethernet MAC.
  Other two downstream ports are supposed to connect to external device.

  The TC9563 PCIe switch can be configured through I2C interface before
  PCIe link is established to change FTS, ASPM related entry delays,
  tx amplitude etc for better power efficiency and functionality.

properties:
  compatible:
    enum:
      - pci1179,0623

  reg:
    maxItems: 1

  resx-gpios:
    maxItems: 1
    description:
      GPIO controlling the RESX# pin.

  vdd18-supply: true

  vdd09-supply: true

  vddc-supply: true

  vddio1-supply: true

  vddio2-supply: true

  vddio18-supply: true

  i2c-parent:
    $ref: /schemas/types.yaml#/definitions/phandle-array
    description:
      A phandle to the parent I2C node and the slave address of the device
      used to configure tc9563 to change FTS, tx amplitude etc.
    items:
      - items:
          - description: Phandle to the I2C controller node
          - description: I2C slave address

patternProperties:
  "^pcie@[1-2],0$":
    description:
      child nodes describing the internal downstream ports of
      the tc9563 switch.
    type: object
    allOf:
      - $ref: "#/$defs/tc9563-node"
      - $ref: /schemas/pci/pci-pci-bridge.yaml#
    unevaluatedProperties: false

  "^pcie@[3],0$":
    description:
      child node describing the internal downstream port connected to the
      integrated Ethernet MAC endpoint of the tc9563 switch.
    type: object
    $ref: /schemas/pci/pci-pci-bridge.yaml#
    properties:
      n-fts: false
    patternProperties:
      "^ethernet@0,[0-1]$":
        type: object
        properties:
          n-fts: false
    unevaluatedProperties: false

$defs:
  tc9563-node:
    type: object

    properties:
      toshiba,tx-amplitude-microvolt:
        description:
          Change Tx Margin setting for low power consumption.

      toshiba,no-dfe-support:
        type: boolean
        description:
          Disable DFE (Decision Feedback Equalizer), which mitigates
          intersymbol interference and some reflections caused by
          impedance mismatches.

required:
  - resx-gpios
  - vdd18-supply
  - vdd09-supply
  - vddc-supply
  - vddio1-supply
  - vddio2-supply
  - vddio18-supply
  - i2c-parent

allOf:
  - $ref: "#/$defs/tc9563-node"
  - $ref: /schemas/pci/pci-bus-common.yaml#

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    pcie {
        #address-cells = <3>;
        #size-cells = <2>;

        pcie@0 {
            device_type = "pci";
            reg = <0x0 0x0 0x0 0x0 0x0>;

            #address-cells = <3>;
            #size-cells = <2>;
            ranges;
            bus-range = <0x01 0xff>;

            pcie@0,0 {
                compatible = "pci1179,0623";

                reg = <0x10000 0x0 0x0 0x0 0x0>;
                device_type = "pci";
                #address-cells = <3>;
                #size-cells = <2>;
                ranges;
                bus-range = <0x02 0xff>;

                i2c-parent = <&qup_i2c 0x77>;

                vdd18-supply = <&vdd>;
                vdd09-supply = <&vdd>;
                vddc-supply = <&vdd>;
                vddio1-supply = <&vdd>;
                vddio2-supply = <&vdd>;
                vddio18-supply = <&vdd>;

                resx-gpios = <&gpio 1 GPIO_ACTIVE_LOW>;

                pcie@1,0 {
                    compatible = "pciclass,0604";
                    reg = <0x20800 0x0 0x0 0x0 0x0>;
                    #address-cells = <3>;
                    #size-cells = <2>;
                    device_type = "pci";
                    ranges;
                    bus-range = <0x03 0xff>;

                    toshiba,no-dfe-support;
                };

                pcie@2,0 {
                    compatible = "pciclass,0604";
                    reg = <0x21000 0x0 0x0 0x0 0x0>;
                    #address-cells = <3>;
                    #size-cells = <2>;
                    device_type = "pci";
                    ranges;
                    bus-range = <0x04 0xff>;

                    toshiba,tx-amplitude-microvolt = <10>;
                };

                pcie@3,0 {
                    compatible = "pciclass,0604";
                    reg = <0x21800 0x0 0x0 0x0 0x0>;
                    #address-cells = <3>;
                    #size-cells = <2>;
                    device_type = "pci";
                    ranges;
                    bus-range = <0x05 0xff>;

                    ethernet@0,0 {
                        reg = <0x50000 0x0 0x0 0x0 0x0>;
                    };

                    ethernet@0,1 {
                        reg = <0x50100 0x0 0x0 0x0 0x0>;
                    };
                };
            };
        };
    };