:orphan:
.. raw:: html
.. dtcompatible:: rockchip,rk3588-gmac
.. _dtbinding_rockchip_rk3588_gmac:
rockchip,rk3588-gmac
####################
.. sidebar:: Overview
:Name: ``rockchip,rk3588-gmac``
:Vendor: :ref:`Fuzhou Rockchip Electronics Co., Ltd `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=rockchip,rk3588-gmac>` using
this compatible
:Driver: :zephyr_file:`drivers/ethernet/dwc_mac/eth_rockchip_dwc_ether_qos.c`
Description
***********
.. code-block:: none
Rockchip RK3588 GMAC
Rockchip RK3588 Gigabit Ethernet MAC based on Synopsys DesignWare MAC.
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``resets``
- ``phandle-array``
- .. code-block:: none
Reset information
This property is **required**.
* - ``clock-in-out``
- ``string``
- .. code-block:: none
RGMII clock direction. "input" means the 125 MHz RGMII reference
clock comes from the PHY. "output" means the SoC provides the
reference clock. RMII uses the same values for the 50 MHz clock.
Default value: ``input``
Legal values: ``input``, ``output``
* - ``rockchip,grf``
- ``phandle``
- .. code-block:: none
Phandle to the system GRF syscon, which holds the RGMII clock delay
configuration.
This property is **required**.
* - ``rockchip,php-grf``
- ``phandle``
- .. code-block:: none
Phandle to the PHP GRF syscon, which holds the RGMII interface select
and the transmit clock divider.
This property is **required**.
* - ``tx-delay``
- ``int``
- .. code-block:: none
TX RGMII delay value programmed in sys-GRF.
Default value: ``0x30``
Value range: ``0`` to ``0x7f``
* - ``rx-delay``
- ``int``
- .. code-block:: none
RX RGMII delay value programmed in sys-GRF.
Default value: ``0x10``
Value range: ``0`` to ``0x7f``
* - ``snps,clk-csr``
- ``int``
- .. code-block:: none
Value programmed into the MAC MDIO Address CR field.
When present, this fixed value is used directly instead of deriving
the MDIO clock range from the MAC clock rate.
* - ``snps,multicast-filter-bins``
- ``int``
- .. code-block:: none
Number of multicast hash filter bins the hardware was configured
with. The absence of this property means the hardware cannot hash
multicast addresses.
Legal values: ``64``, ``128``, ``256``
* - ``snps,perfect-filter-entries``
- ``int``
- .. code-block:: none
Number of MAC address (perfect) filter entries the hardware was
configured with, including entry 0 which holds the station address.
The default corresponds to the minimal hardware configuration.
Default value: ``1``
Minimum value: ``1``
* - ``phy-handle``
- ``phandle``
- .. code-block:: none
Specifies a reference to a node representing a PHY device.
* - ``phy-connection-type``
- ``string``
- .. code-block:: none
Specifies the interface connection type between ethernet MAC and PHY.
Legal values: ``mii``, ``rmii``, ``gmii``, ``rgmii``, ``rgmii-id``, ``rgmii-txid``, ``rgmii-rxid``, ``tbi``, ``rtbi``, ``smii``, ``sgmii``, ``rev-mii``, ``xgmii``, ``moca``, ``qsgmii``, ``trgmii``, ``internal``
* - ``ptp-clock``
- ``phandle``
- .. code-block:: none
Corresponding ptp clock device.
* - ``local-mac-address``
- ``uint8-array``
- .. code-block:: none
Specifies the MAC address that was assigned to the network device
* - ``zephyr,random-mac-address``
- ``boolean``
- .. code-block:: none
Use a random MAC address generated when the driver is initialized.
Note that using this choice and rebooting a board may leave stale
MAC address in peers' ARP caches and lead to issues and delays in
communication. (Use "ip neigh flush all" on Linux peers to clear
ARP cache.)
It is driver specific how the OUI octets are handled.
If set we ignore any setting of the local-mac-address property.
* - ``zephyr,mac-address-prefix``
- ``uint8-array``
- .. code-block:: none
A statically assigned MAC address prefix.
Can be combined with zephyr,random-mac-address or an NVMEM cell, for
example to set the OUI.
* - ``nvmem-cell-names``
- ``string-array``
- .. code-block:: none
Names for each nvmem-cells specified.
* - ``nvmem-cells``
- ``phandle-array``
- .. code-block:: none
List of phandles to the nvmem data cells.
* - ``reset-names``
- ``string-array``
- .. code-block:: none
Name of each reset
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
Properties inherited from the base binding file, which defines
common properties that may be set on many nodes. Not all of these
may apply to the "rockchip,rk3588-gmac" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
CRU clock phandles. See include/zephyr/dt-bindings/clock/rk3588-cru.h
for clock IDs. Typical clocks are CLK_GMAC_125M, CLK_GMAC_50M,
PCLK_GMACn, ACLK_GMACn, and CLK_GMACn_PTP_REF.
This property is **required**.
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Names for clocks listed in the clocks property. Typical names are
"stmmaceth", "clk_mac_ref", "pclk_mac", "aclk_mac", and "ptp_ref".
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``okay``, ``disabled``, ``reserved``, ``fail``, ``fail-sss``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``ranges``
- ``compound``
- .. code-block:: none
Information used to define a mapping (or translation) between the address
space of a bus (the "child address space") and the address space of the
bus node's parent (the "parent address space").
The "ranges" property is typically empty, or a sequence of triplets
(child bus address, parent bus address, length).
If the "ranges" property is empty, it specifies that the parent and child
address spaces are identical and no address translation is required.
If the "ranges" property is not present in a bus node, it is assumed that
no mapping exists between children of the node and the parent address space.
For details, see "2.3.8 ranges" in Devicetree Specification v0.4.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dma-coherent``
- ``boolean``
- .. code-block:: none
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``dma-ranges``
- ``compound``
- .. code-block:: none
The dma-ranges provides a means of defining a mapping or translation between the
physical address space of the bus and the physical address space of the parent of the bus.
For details, see "2.3.9 dma-ranges" in Devicetree Specification v0.4.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" property.
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.