xref: /freebsd/sys/contrib/device-tree/Bindings/usb/smsc,usb3503.yaml (revision 8cc087a1eee9ec1ca9f7ac1e63ad51bdb5a682eb) 
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/usb/smsc,usb3503.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: SMSC USB3503 High-Speed Hub Controller Device Tree Bindings
8
9maintainers:
10  - Dongjin Kim <tobetter@gmail.com>
11
12properties:
13  compatible:
14    enum:
15      - smsc,usb3503
16      - smsc,usb3503a
17
18  reg:
19    maxItems: 1
20
21  connect-gpios:
22    maxItems: 1
23    description: >
24      GPIO for connect
25
26  intn-gpios:
27    maxItems: 1
28    description: >
29      GPIO for interrupt
30
31  reset-gpios:
32    maxItems: 1
33    description: >
34      GPIO for reset
35
36  disabled-ports:
37    $ref: /schemas/types.yaml#/definitions/uint32-array
38    minItems: 1
39    maxItems: 3
40    items:
41      minimum: 1
42      maximum: 3
43    description: >
44      Specifies the ports unused using their port number. Do not describe this
45      property if all ports have to be enabled.
46
47  initial-mode:
48    enum: [1, 2]
49    description: >
50      Specifies initial mode. 1 for Hub mode, 2 for standby mode.
51
52  clocks:
53    maxItems: 1
54    description: >
55      Clock used for driving REFCLK signal. If not provided the driver assumes
56      that clock signal is always available, its rate is specified by REF_SEL
57      pins and a value from the primary reference clock frequencies table is
58      used.
59
60  clock-names:
61    const: refclk
62
63  refclk-frequency:
64    $ref: /schemas/types.yaml#/definitions/uint32
65    description: >
66      Frequency of the REFCLK signal as defined by REF_SEL pins. If not
67      provided, driver will not set rate of the REFCLK signal and assume that a
68      value from the primary reference clock frequencies table is used.
69
70required:
71  - compatible
72
73additionalProperties: false
74
75examples:
76  - |
77      i2c {
78          #address-cells = <1>;
79          #size-cells = <0>;
80
81          usb-hub@8 {
82              compatible = "smsc,usb3503";
83              reg = <0x08>;
84              connect-gpios = <&gpx3 0 1>;
85              disabled-ports = <2 3>;
86              intn-gpios = <&gpx3 4 1>;
87              reset-gpios = <&gpx3 5 1>;
88              initial-mode = <1>;
89              clocks = <&clks 80>;
90              clock-names = "refclk";
91          };
92      };
93
94  - |
95      #include <dt-bindings/gpio/gpio.h>
96
97      usb-hub {
98          /* I2C is not connected */
99          compatible = "smsc,usb3503";
100          initial-mode = <1>; /* initialize in HUB mode */
101          disabled-ports = <1>;
102          intn-gpios = <&pio 7 5 GPIO_ACTIVE_HIGH>; /* PH5 */
103          reset-gpios = <&pio 4 16 GPIO_ACTIVE_LOW>; /* PE16 */
104          connect-gpios = <&pio 4 17 GPIO_ACTIVE_HIGH>; /* PE17 */
105          refclk-frequency = <19200000>;
106      };
107
108...
109