1 # SPDX-License-Identifier: (GPL-2.0-only OR BS 1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/net/fsl,fma 4 $id: http://devicetree.org/schemas/net/fsl,fman-port.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: Freescale Frame Manager Port Device 7 title: Freescale Frame Manager Port Device
8 8
9 maintainers: 9 maintainers:
10 - Frank Li <Frank.Li@nxp.com> 10 - Frank Li <Frank.Li@nxp.com>
11 11
12 description: | 12 description: |
13 The Frame Manager (FMan) supports several ty 13 The Frame Manager (FMan) supports several types of hardware ports:
14 Ethernet receiver (RX) 14 Ethernet receiver (RX)
15 Ethernet transmitter (TX) 15 Ethernet transmitter (TX)
16 Offline/Host command (O/H) 16 Offline/Host command (O/H)
17 17
18 properties: 18 properties:
19 compatible: 19 compatible:
20 enum: 20 enum:
21 - fsl,fman-v2-port-oh 21 - fsl,fman-v2-port-oh
22 - fsl,fman-v2-port-rx 22 - fsl,fman-v2-port-rx
23 - fsl,fman-v2-port-tx 23 - fsl,fman-v2-port-tx
24 - fsl,fman-v3-port-oh 24 - fsl,fman-v3-port-oh
25 - fsl,fman-v3-port-rx 25 - fsl,fman-v3-port-rx
26 - fsl,fman-v3-port-tx 26 - fsl,fman-v3-port-tx
27 27
28 cell-index: 28 cell-index:
29 $ref: /schemas/types.yaml#/definitions/uin 29 $ref: /schemas/types.yaml#/definitions/uint32
30 description: 30 description:
31 Specifies the hardware port id. 31 Specifies the hardware port id.
32 Each hardware port on the FMan has its o 32 Each hardware port on the FMan has its own hardware PortID.
33 Super set of all hardware Port IDs avail 33 Super set of all hardware Port IDs available at FMan Reference
34 Manual under "FMan Hardware Ports in Fre 34 Manual under "FMan Hardware Ports in Freescale Devices" table.
35 35
36 Each hardware port is assigned a 4KB, po 36 Each hardware port is assigned a 4KB, port-specific page in
37 the FMan hardware port memory region (wh 37 the FMan hardware port memory region (which is part of the
38 FMan memory map). The first 4 KB in the 38 FMan memory map). The first 4 KB in the FMan hardware ports
39 memory region is used for what are calle 39 memory region is used for what are called common registers.
40 The subsequent 63 4KB pages are allocate 40 The subsequent 63 4KB pages are allocated to the hardware
41 ports. 41 ports.
42 The page of a specific port is determine 42 The page of a specific port is determined by the cell-index.
43 43
44 reg: 44 reg:
45 items: 45 items:
46 - description: There is one reg region d 46 - description: There is one reg region describing the port
47 configuration registers. 47 configuration registers.
48 48
49 fsl,fman-10g-port: 49 fsl,fman-10g-port:
50 $ref: /schemas/types.yaml#/definitions/fla 50 $ref: /schemas/types.yaml#/definitions/flag
51 description: The default port rate is 1G. 51 description: The default port rate is 1G.
52 If this property exists, the port is s 1 52 If this property exists, the port is s 10G port.
53 53
54 fsl,fman-best-effort-port: 54 fsl,fman-best-effort-port:
55 $ref: /schemas/types.yaml#/definitions/fla 55 $ref: /schemas/types.yaml#/definitions/flag
56 description: The default port rate is 1G. 56 description: The default port rate is 1G.
57 Can be defined only if 10G-support is se 57 Can be defined only if 10G-support is set.
58 This property marks a best-effort 10G po 58 This property marks a best-effort 10G port (10G port that
59 may not be capable of line rate). 59 may not be capable of line rate).
60 60
61 required: 61 required:
62 - compatible 62 - compatible
63 - reg 63 - reg
64 - cell-index 64 - cell-index
65 65
66 additionalProperties: false 66 additionalProperties: false
67 67
68 examples: 68 examples:
69 - | 69 - |
70 port@a8000 { 70 port@a8000 {
71 compatible = "fsl,fman-v2-port-tx"; 71 compatible = "fsl,fman-v2-port-tx";
72 reg = <0xa8000 0x1000>; 72 reg = <0xa8000 0x1000>;
73 cell-index = <0x28>; 73 cell-index = <0x28>;
74 }; 74 };
75 75
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.