linux/Documentation/devicetree/bindings/net/intel,ixp4xx-hss.yaml
Rob Herring 39bd2b6a37 dt-bindings: Improve phandle-array schemas
The 'phandle-array' type is a bit ambiguous. It can be either just an
array of phandles or an array of phandles plus args. Many schemas for
phandle-array properties aren't clear in the schema which case applies
though the description usually describes it.

The array of phandles case boils down to needing:

items:
  maxItems: 1

The phandle plus args cases should typically take this form:

items:
  - items:
      - description: A phandle
      - description: 1st arg cell
      - description: 2nd arg cell

With this change, some examples need updating so that the bracketing of
property values matches the schema.

Signed-off-by: Rob Herring <robh@kernel.org>
Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
Acked-by: Vinod Koul <vkoul@kernel.org>
Acked-by: Ulf Hansson <ulf.hansson@linaro.org>
Acked-by: Georgi Djakov <djakov@kernel.org>
Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>
Acked-by: Mark Brown <broonie@kernel.org>
Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>
Acked-by: Stephen Boyd <sboyd@kernel.org>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Marc Kleine-Budde <mkl@pengutronix.de>
Link: https://lore.kernel.org/r/20220119015038.2433585-1-robh@kernel.org
2022-02-04 09:43:42 -06:00

124 lines
3.5 KiB
YAML

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
# Copyright 2021 Linaro Ltd.
%YAML 1.2
---
$id: "http://devicetree.org/schemas/net/intel,ixp4xx-hss.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"
title: Intel IXP4xx V.35 WAN High Speed Serial Link (HSS)
maintainers:
- Linus Walleij <linus.walleij@linaro.org>
description: |
The Intel IXP4xx HSS makes use of the IXP4xx NPE (Network
Processing Engine) and the IXP4xx Queue Manager to process
V.35 Wideband Modem (WAN) links.
properties:
compatible:
const: intel,ixp4xx-hss
reg:
maxItems: 1
description: The HSS instance
intel,npe-handle:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
items:
items:
- description: phandle to the NPE this HSS instance is using
- description: the NPE instance number
description: phandle to the NPE this HSS instance is using
and the instance to use in the second cell
intel,queue-chl-rxtrig:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
items:
- items:
- description: phandle to the RX trigger queue on the NPE
- description: the queue instance number
description: phandle to the RX trigger queue on the NPE
intel,queue-chl-txready:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
items:
- items:
- description: phandle to the TX ready queue on the NPE
- description: the queue instance number
description: phandle to the TX ready queue on the NPE
intel,queue-pkt-rx:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
items:
- items:
- description: phandle to the RX queue on the NPE
- description: the queue instance number
description: phandle to the packet RX queue on the NPE
intel,queue-pkt-tx:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
maxItems: 4
items:
items:
- description: phandle to the TX queue on the NPE
- description: the queue instance number
description: phandle to the packet TX0, TX1, TX2 and TX3 queues on the NPE
intel,queue-pkt-rxfree:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
maxItems: 4
items:
items:
- description: phandle to the RXFREE queue on the NPE
- description: the queue instance number
description: phandle to the packet RXFREE0, RXFREE1, RXFREE2 and
RXFREE3 queues on the NPE
intel,queue-pkt-txdone:
$ref: '/schemas/types.yaml#/definitions/phandle-array'
items:
- items:
- description: phandle to the TXDONE queue on the NPE
- description: the queue instance number
description: phandle to the packet TXDONE queue on the NPE
cts-gpios:
maxItems: 1
description: Clear To Send (CTS) GPIO line
rts-gpios:
maxItems: 1
description: Ready To Send (RTS) GPIO line
dcd-gpios:
maxItems: 1
description: Data Carrier Detect (DCD) GPIO line
dtr-gpios:
maxItems: 1
description: Data Terminal Ready (DTR) GPIO line
clk-internal-gpios:
maxItems: 1
description: Clock internal GPIO line, driving this high will make the HSS
use internal clocking as opposed to external clocking
required:
- compatible
- reg
- intel,npe-handle
- intel,queue-chl-rxtrig
- intel,queue-chl-txready
- intel,queue-pkt-rx
- intel,queue-pkt-tx
- intel,queue-pkt-rxfree
- intel,queue-pkt-txdone
- cts-gpios
- rts-gpios
- dcd-gpios
- dtr-gpios
- clk-internal-gpios
additionalProperties: false