:orphan:
.. raw:: html
.. dtcompatible:: microchip,ksz8794
.. _dtbinding_microchip_ksz8794:
microchip,ksz8794 (on spi bus)
##############################
Vendor: :ref:`Microchip Technology Inc. `
Description
***********
.. code-block:: none
KSZ8794 ethernet switch with SPI interface
Properties
**********
Top level properties
====================
These property descriptions apply to "microchip,ksz8794"
nodes themselves. This page also describes child node
properties in the following sections.
.. 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
* - ``workaround``
- ``int``
- .. code-block:: none
Define the applied workaround for the switch used for
short connections. Use bitmask to select the workaround or more
0x01: Short Cable Problems with the KSZ8795 Family
0x02: 1) CAT-5E/6 Short Cable with a Link Issue for the KSZ8795 Family
0x04: 2) CAT-5E/6 Short Cable with a Link Issue for the KSZ8795 Family
* - ``mii-lowspeed-drivestrength``
- ``int``
- .. code-block:: none
Define the Low-Speed Interface Drive Strength for MII and RMMI
Supported values 2,4,8,12,16,20,24,28mA
see Register 163 (0xA3): Global Control 20 for more details
Legal values: ``2``, ``4``, ``8``, ``12``, ``16``, ``20``, ``24``, ``28``
* - ``dsa-master-port``
- ``phandle``
- .. code-block:: none
Phandle to master port.
* - ``dsa-slave-ports``
- ``int``
- .. code-block:: none
Number of slave ports on the switch
* - ``spi-cpha``
- ``boolean``
- .. code-block:: none
Set to indicate phase starts with asserted half-phase (CPHA=1).
For this driver using this property requires also using cpol.
* - ``spi-cpol``
- ``boolean``
- .. code-block:: none
Set to indicate clock leading edge is falling (CPOL=1).
For this driver using this property requires also using cpha.
* - ``reset-gpios``
- ``phandle-array``
- .. code-block:: none
The pin is asserted for 10ms during boot to reset the KSZ8794.
* - ``spi-max-frequency``
- ``int``
- .. code-block:: none
Maximum clock frequency of device's SPI interface in Hz
This property is **required**.
* - ``duplex``
- ``int``
- .. code-block:: none
Duplex mode, full or half. By default it's always full duplex thus 0
as this is, by far, the most common mode.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
0 SPI_FULL_DUPLEX
2048 SPI_HALF_DUPLEX
Legal values: ``0``, ``2048``
* - ``frame-format``
- ``int``
- .. code-block:: none
Motorola or TI frame format. By default it's always Motorola's,
thus 0 as this is, by far, the most common format.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
0 SPI_FRAME_FORMAT_MOTOROLA
32768 SPI_FRAME_FORMAT_TI
Legal values: ``0``, ``32768``
* - ``supply-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO specifier that controls power to the device.
This property should be provided when the device has a dedicated
switch that controls power to the device. The supply state is
entirely the responsibility of the device driver.
Contrast with vin-supply.
* - ``vin-supply``
- ``phandle``
- .. code-block:: none
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.
This property should be provided when device power is supplied
by a shared regulator. The supply state is dependent on the
request status of all devices fed by the regulator.
Contrast with supply-gpios. If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.
.. 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 "microchip,ksz8794" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
register space
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``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.
* - ``power-domain``
- ``phandle``
- .. code-block:: none
Power domain the device belongs to.
The device will be notified when the power domain it belongs to is either
suspended or resumed.
Child node properties
=====================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``label``
- ``string``
- This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``local-mac-address``
- ``uint8-array``
- .. code-block:: none
Specifies the MAC address that was assigned to the port