xref: /linux/Documentation/devicetree/bindings/net/fsl,fman-port.yaml (revision c771600c6af14749609b49565ffb4cac2959710d)
1243996d1SFrank Li# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2243996d1SFrank Li%YAML 1.2
3243996d1SFrank Li---
4243996d1SFrank Li$id: http://devicetree.org/schemas/net/fsl,fman-port.yaml#
5243996d1SFrank Li$schema: http://devicetree.org/meta-schemas/core.yaml#
6243996d1SFrank Li
7243996d1SFrank Lititle: Freescale Frame Manager Port Device
8243996d1SFrank Li
9243996d1SFrank Limaintainers:
10243996d1SFrank Li  - Frank Li <Frank.Li@nxp.com>
11243996d1SFrank Li
12243996d1SFrank Lidescription: |
13243996d1SFrank Li  The Frame Manager (FMan) supports several types of hardware ports:
14243996d1SFrank Li    Ethernet receiver (RX)
15243996d1SFrank Li    Ethernet transmitter (TX)
16243996d1SFrank Li    Offline/Host command (O/H)
17243996d1SFrank Li
18243996d1SFrank Liproperties:
19243996d1SFrank Li  compatible:
20243996d1SFrank Li    enum:
21243996d1SFrank Li      - fsl,fman-v2-port-oh
22243996d1SFrank Li      - fsl,fman-v2-port-rx
23243996d1SFrank Li      - fsl,fman-v2-port-tx
24243996d1SFrank Li      - fsl,fman-v3-port-oh
25243996d1SFrank Li      - fsl,fman-v3-port-rx
26243996d1SFrank Li      - fsl,fman-v3-port-tx
27243996d1SFrank Li
28243996d1SFrank Li  cell-index:
29243996d1SFrank Li    $ref: /schemas/types.yaml#/definitions/uint32
30243996d1SFrank Li    description:
31243996d1SFrank Li      Specifies the hardware port id.
32243996d1SFrank Li      Each hardware port on the FMan has its own hardware PortID.
33243996d1SFrank Li      Super set of all hardware Port IDs available at FMan Reference
34243996d1SFrank Li      Manual under "FMan Hardware Ports in Freescale Devices" table.
35243996d1SFrank Li
36243996d1SFrank Li      Each hardware port is assigned a 4KB, port-specific page in
37243996d1SFrank Li      the FMan hardware port memory region (which is part of the
38243996d1SFrank Li      FMan memory map). The first 4 KB in the FMan hardware ports
39243996d1SFrank Li      memory region is used for what are called common registers.
40243996d1SFrank Li      The subsequent 63 4KB pages are allocated to the hardware
41243996d1SFrank Li      ports.
42243996d1SFrank Li      The page of a specific port is determined by the cell-index.
43243996d1SFrank Li
44243996d1SFrank Li  reg:
45243996d1SFrank Li    items:
46243996d1SFrank Li      - description: There is one reg region describing the port
47243996d1SFrank Li          configuration registers.
48243996d1SFrank Li
49243996d1SFrank Li  fsl,fman-10g-port:
50243996d1SFrank Li    $ref: /schemas/types.yaml#/definitions/flag
51243996d1SFrank Li    description: The default port rate is 1G.
52243996d1SFrank Li      If this property exists, the port is s 10G port.
53243996d1SFrank Li
54243996d1SFrank Li  fsl,fman-best-effort-port:
55243996d1SFrank Li    $ref: /schemas/types.yaml#/definitions/flag
56243996d1SFrank Li    description: The default port rate is 1G.
57243996d1SFrank Li      Can be defined only if 10G-support is set.
58243996d1SFrank Li      This property marks a best-effort 10G port (10G port that
59243996d1SFrank Li      may not be capable of line rate).
60243996d1SFrank Li
61243996d1SFrank Lirequired:
62243996d1SFrank Li  - compatible
63243996d1SFrank Li  - reg
64243996d1SFrank Li  - cell-index
65243996d1SFrank Li
66243996d1SFrank LiadditionalProperties: false
67243996d1SFrank Li
68243996d1SFrank Liexamples:
69243996d1SFrank Li  - |
70243996d1SFrank Li    port@a8000 {
71243996d1SFrank Li        compatible = "fsl,fman-v2-port-tx";
72243996d1SFrank Li        reg = <0xa8000 0x1000>;
73243996d1SFrank Li        cell-index = <0x28>;
74243996d1SFrank Li    };
75243996d1SFrank Li
76