xref: /freebsd-src/sys/contrib/device-tree/Bindings/net/socionext-netsec.txt (revision 6be3386466ab79a84b48429ae66244f21526d3df)
1c66ec88fSEmmanuel Vadot* Socionext NetSec Ethernet Controller IP
2c66ec88fSEmmanuel Vadot
3c66ec88fSEmmanuel VadotRequired properties:
4c66ec88fSEmmanuel Vadot- compatible: Should be "socionext,synquacer-netsec"
5c66ec88fSEmmanuel Vadot- reg: Address and length of the control register area, followed by the
6c66ec88fSEmmanuel Vadot       address and length of the EEPROM holding the MAC address and
7c66ec88fSEmmanuel Vadot       microengine firmware
8c66ec88fSEmmanuel Vadot- interrupts: Should contain ethernet controller interrupt
9c66ec88fSEmmanuel Vadot- clocks: phandle to the PHY reference clock
10c66ec88fSEmmanuel Vadot- clock-names: Should be "phy_ref_clk"
11c66ec88fSEmmanuel Vadot- phy-mode: See ethernet.txt file in the same directory
12c66ec88fSEmmanuel Vadot- phy-handle: See ethernet.txt in the same directory.
13c66ec88fSEmmanuel Vadot
14c66ec88fSEmmanuel Vadot- mdio device tree subnode: When the Netsec has a phy connected to its local
15c66ec88fSEmmanuel Vadot		mdio, there must be device tree subnode with the following
16c66ec88fSEmmanuel Vadot		required properties:
17c66ec88fSEmmanuel Vadot
18c66ec88fSEmmanuel Vadot	- #address-cells: Must be <1>.
19c66ec88fSEmmanuel Vadot	- #size-cells: Must be <0>.
20c66ec88fSEmmanuel Vadot
21c66ec88fSEmmanuel Vadot	For each phy on the mdio bus, there must be a node with the following
22c66ec88fSEmmanuel Vadot	fields:
23c66ec88fSEmmanuel Vadot	- compatible: Refer to phy.txt
24c66ec88fSEmmanuel Vadot	- reg: phy id used to communicate to phy.
25c66ec88fSEmmanuel Vadot
26c66ec88fSEmmanuel VadotOptional properties: (See ethernet.txt file in the same directory)
27c66ec88fSEmmanuel Vadot- dma-coherent: Boolean property, must only be present if memory
28c66ec88fSEmmanuel Vadot	accesses performed by the device are cache coherent.
29c66ec88fSEmmanuel Vadot- max-speed: See ethernet.txt in the same directory.
30c66ec88fSEmmanuel Vadot- max-frame-size: See ethernet.txt in the same directory.
31c66ec88fSEmmanuel Vadot
32c66ec88fSEmmanuel VadotThe MAC address will be determined using the optional properties
33*6be33864SEmmanuel Vadotdefined in ethernet.txt. The 'phy-mode' property is required, but may
34*6be33864SEmmanuel Vadotbe set to the empty string if the PHY configuration is programmed by
35*6be33864SEmmanuel Vadotthe firmware or set by hardware straps, and needs to be preserved.
36c66ec88fSEmmanuel Vadot
37c66ec88fSEmmanuel VadotExample:
38c66ec88fSEmmanuel Vadot	eth0: ethernet@522d0000 {
39c66ec88fSEmmanuel Vadot		compatible = "socionext,synquacer-netsec";
40c66ec88fSEmmanuel Vadot		reg = <0 0x522d0000 0x0 0x10000>, <0 0x10000000 0x0 0x10000>;
41c66ec88fSEmmanuel Vadot		interrupts = <GIC_SPI 176 IRQ_TYPE_LEVEL_HIGH>;
42c66ec88fSEmmanuel Vadot		clocks = <&clk_netsec>;
43c66ec88fSEmmanuel Vadot		clock-names = "phy_ref_clk";
44c66ec88fSEmmanuel Vadot		phy-mode = "rgmii";
45c66ec88fSEmmanuel Vadot		max-speed = <1000>;
46c66ec88fSEmmanuel Vadot		max-frame-size = <9000>;
47c66ec88fSEmmanuel Vadot		phy-handle = <&phy1>;
48c66ec88fSEmmanuel Vadot
49c66ec88fSEmmanuel Vadot		mdio {
50c66ec88fSEmmanuel Vadot			#address-cells = <1>;
51c66ec88fSEmmanuel Vadot			#size-cells = <0>;
52c66ec88fSEmmanuel Vadot			phy1: ethernet-phy@1 {
53c66ec88fSEmmanuel Vadot				compatible = "ethernet-phy-ieee802.3-c22";
54c66ec88fSEmmanuel Vadot				reg = <1>;
55c66ec88fSEmmanuel Vadot			};
56c66ec88fSEmmanuel Vadot		};
57