xref: /freebsd/sys/contrib/device-tree/Bindings/net/intel,ixp4xx-hss.yaml (revision 525fe93dc7487a1e63a90f6a2b956abc601963c1) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2# Copyright 2021 Linaro Ltd.
3%YAML 1.2
4---
5$id: http://devicetree.org/schemas/net/intel,ixp4xx-hss.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: Intel IXP4xx V.35 WAN High Speed Serial Link (HSS)
9
10maintainers:
11  - Linus Walleij <linus.walleij@linaro.org>
12
13description: |
14  The Intel IXP4xx HSS makes use of the IXP4xx NPE (Network
15  Processing Engine) and the IXP4xx Queue Manager to process
16  V.35 Wideband Modem (WAN) links.
17
18properties:
19  compatible:
20    const: intel,ixp4xx-hss
21
22  reg:
23    maxItems: 1
24    description: The HSS instance
25
26  intel,npe-handle:
27    $ref: /schemas/types.yaml#/definitions/phandle-array
28    items:
29      items:
30        - description: phandle to the NPE this HSS instance is using
31        - description: the NPE instance number
32    description: phandle to the NPE this HSS instance is using
33      and the instance to use in the second cell
34
35  intel,queue-chl-rxtrig:
36    $ref: /schemas/types.yaml#/definitions/phandle-array
37    items:
38      - items:
39          - description: phandle to the RX trigger queue on the NPE
40          - description: the queue instance number
41    description: phandle to the RX trigger queue on the NPE
42
43  intel,queue-chl-txready:
44    $ref: /schemas/types.yaml#/definitions/phandle-array
45    items:
46      - items:
47          - description: phandle to the TX ready queue on the NPE
48          - description: the queue instance number
49    description: phandle to the TX ready queue on the NPE
50
51  intel,queue-pkt-rx:
52    $ref: /schemas/types.yaml#/definitions/phandle-array
53    items:
54      - items:
55          - description: phandle to the RX queue on the NPE
56          - description: the queue instance number
57    description: phandle to the packet RX queue on the NPE
58
59  intel,queue-pkt-tx:
60    $ref: /schemas/types.yaml#/definitions/phandle-array
61    maxItems: 4
62    items:
63      items:
64        - description: phandle to the TX queue on the NPE
65        - description: the queue instance number
66    description: phandle to the packet TX0, TX1, TX2 and TX3 queues on the NPE
67
68  intel,queue-pkt-rxfree:
69    $ref: /schemas/types.yaml#/definitions/phandle-array
70    maxItems: 4
71    items:
72      items:
73        - description: phandle to the RXFREE queue on the NPE
74        - description: the queue instance number
75    description: phandle to the packet RXFREE0, RXFREE1, RXFREE2 and
76      RXFREE3 queues on the NPE
77
78  intel,queue-pkt-txdone:
79    $ref: /schemas/types.yaml#/definitions/phandle-array
80    items:
81      - items:
82          - description: phandle to the TXDONE queue on the NPE
83          - description: the queue instance number
84    description: phandle to the packet TXDONE queue on the NPE
85
86  cts-gpios:
87    maxItems: 1
88    description: Clear To Send (CTS) GPIO line
89
90  rts-gpios:
91    maxItems: 1
92    description: Ready To Send (RTS) GPIO line
93
94  dcd-gpios:
95    maxItems: 1
96    description: Data Carrier Detect (DCD) GPIO line
97
98  dtr-gpios:
99    maxItems: 1
100    description: Data Terminal Ready (DTR) GPIO line
101
102  clk-internal-gpios:
103    maxItems: 1
104    description: Clock internal GPIO line, driving this high will make the HSS
105      use internal clocking as opposed to external clocking
106
107required:
108  - compatible
109  - reg
110  - intel,npe-handle
111  - intel,queue-chl-rxtrig
112  - intel,queue-chl-txready
113  - intel,queue-pkt-rx
114  - intel,queue-pkt-tx
115  - intel,queue-pkt-rxfree
116  - intel,queue-pkt-txdone
117  - cts-gpios
118  - rts-gpios
119  - dcd-gpios
120  - dtr-gpios
121  - clk-internal-gpios
122
123additionalProperties: false
124