fsl,qman-portal.yaml

  1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
  2%YAML 1.2
  3---
  4$id: http://devicetree.org/schemas/soc/fsl/fsl,qman-portal.yaml#
  5$schema: http://devicetree.org/meta-schemas/core.yaml#
  6
  7title: QorIQ DPAA Queue Manager Portals
  8
  9maintainers:
 10  - Frank Li <Frank.Li@nxp.com>
 11
 12description:
 13  Portals are memory mapped interfaces to QMan that allow low-latency, lock-less
 14  interaction by software running on processor cores, accelerators and network
 15  interfaces with the QMan
 16
 17properties:
 18  compatible:
 19    oneOf:
 20      - const: fsl,qman-portal
 21      - items:
 22          - enum:
 23              - fsl,ls1043-qman-portal
 24              - fsl,ls1046-qman-portal
 25              - fsl,qman-portal-1.2.0
 26          - const: fsl,qman-portal
 27
 28  reg:
 29    items:
 30      - description: the cache-enabled region of the portal
 31      - description: the cache-inhibited region of the portal
 32
 33  interrupts:
 34    maxItems: 1
 35
 36  fsl,liodn:
 37    $ref: /schemas/types.yaml#/definitions/uint32-array
 38    maxItems: 2
 39    description: See pamu.txt. Two LIODN(s). DQRR LIODN (DLIODN) and Frame LIODN
 40      (FLIODN)
 41
 42  fsl,iommu-parent:
 43    $ref: /schemas/types.yaml#/definitions/phandle
 44    description: See pamu.txt.
 45
 46  fsl,qman-channel-id:
 47    $ref: /schemas/types.yaml#/definitions/uint32
 48    description: qman channel id.
 49
 50  cell-index:
 51    $ref: /schemas/types.yaml#/definitions/uint32
 52    description:
 53      The hardware index of the channel. This can also be
 54      determined by dividing any of the channel's 8 work queue
 55      IDs by 8
 56
 57      In addition to these properties the qman-portals should have sub-nodes to
 58      represent the HW devices/portals that are connected to the software portal
 59      described here
 60
 61required:
 62  - compatible
 63  - reg
 64  - interrupts
 65
 66additionalProperties: false
 67
 68patternProperties:
 69  '^(fman0|fman1|pme|crypto)+$':
 70    type: object
 71    properties:
 72      fsl,liodn:
 73        $ref: /schemas/types.yaml#/definitions/uint32-array
 74        description: See pamu.txt, PAMU property used for static LIODN assignment
 75
 76      fsl,iommu-parent:
 77        description: See pamu.txt, PAMU property used for dynamic LIODN assignment
 78
 79      dev-handle:
 80        $ref: /schemas/types.yaml#/definitions/phandle
 81        description:
 82          The phandle to the particular hardware device that this
 83          portal is connected to.
 84
 85    additionalProperties: false
 86
 87examples:
 88  - |
 89    #include <dt-bindings/interrupt-controller/irq.h>
 90
 91    qman-portal@0 {
 92        compatible = "fsl,qman-portal-1.2.0", "fsl,qman-portal";
 93        reg = <0 0x4000>, <0x100000 0x1000>;
 94        interrupts = <104 IRQ_TYPE_EDGE_FALLING 0 0>;
 95        fsl,liodn = <1 2>;
 96        fsl,qman-channel-id = <0>;
 97
 98        fman0 {
 99            fsl,liodn = <0x21>;
100            dev-handle = <&fman0>;
101        };
102
103        fman1 {
104            fsl,liodn = <0xa1>;
105            dev-handle = <&fman1>;
106        };
107
108        crypto {
109            fsl,liodn = <0x41 0x66>;
110            dev-handle = <&crypto>;
111        };
112    };