xref: /freebsd/sys/contrib/device-tree/Bindings/soc/fsl/fsl,qman-portal.yaml (revision 0e8011faf58b743cc652e3b2ad0f7671227610df) 
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    description: See pamu.txt. Two LIODN(s). DQRR LIODN (DLIODN) and Frame LIODN
39      (FLIODN)
40
41  fsl,iommu-parent:
42    $ref: /schemas/types.yaml#/definitions/phandle
43    description: See pamu.txt.
44
45  fsl,qman-channel-id:
46    $ref: /schemas/types.yaml#/definitions/uint32
47    description: qman channel id.
48
49  cell-index:
50    $ref: /schemas/types.yaml#/definitions/uint32
51    description:
52      The hardware index of the channel. This can also be
53      determined by dividing any of the channel's 8 work queue
54      IDs by 8
55
56      In addition to these properties the qman-portals should have sub-nodes to
57      represent the HW devices/portals that are connected to the software portal
58      described here
59
60required:
61  - compatible
62  - reg
63  - interrupts
64
65additionalProperties: false
66
67patternProperties:
68  '^(fman0|fman1|pme|crypto)+$':
69    type: object
70    properties:
71      fsl,liodn:
72        description: See pamu.txt, PAMU property used for static LIODN assignment
73
74      fsl,iommu-parent:
75        description: See pamu.txt, PAMU property used for dynamic LIODN assignment
76
77      dev-handle:
78        $ref: /schemas/types.yaml#/definitions/phandle
79        description:
80          The phandle to the particular hardware device that this
81          portal is connected to.
82
83    additionalProperties: false
84
85examples:
86  - |
87    #include <dt-bindings/interrupt-controller/irq.h>
88
89    qman-portal@0 {
90        compatible = "fsl,qman-portal-1.2.0", "fsl,qman-portal";
91        reg = <0 0x4000>, <0x100000 0x1000>;
92        interrupts = <104 IRQ_TYPE_EDGE_FALLING 0 0>;
93        fsl,liodn = <1 2>;
94        fsl,qman-channel-id = <0>;
95
96        fman0 {
97            fsl,liodn = <0x21>;
98            dev-handle = <&fman0>;
99        };
100
101        fman1 {
102            fsl,liodn = <0xa1>;
103            dev-handle = <&fman1>;
104        };
105
106        crypto {
107            fsl,liodn = <0x41 0x66>;
108            dev-handle = <&crypto>;
109        };
110    };
111