Skip to content

Commit

Permalink
[ethernet] Adds documentation for setting PHY register values (#3886)
Browse files Browse the repository at this point in the history
  • Loading branch information
heythisisnate authored Jun 5, 2024
1 parent dce2e09 commit ebb27d6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions components/ethernet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ RMII configuration variables:
- ``GPIO17_OUT`` - Internal clock

- **phy_addr** (*Optional*, int): The PHY addr type of the Ethernet controller. Defaults to 0.
- **phy_registers** (*Optional*, mapping): Arbitrary PHY register values to set after Ethernet initialization.

- **address** (**Required**, hex): The register address as a hex number (e.g. ``0x10`` for address 16)
- **value** (**Required**, hex): The value of the register to set as a hex number (e.g. ``0x1FFA``)
- **page_id** (*Optional*, hex): (RTL8201 only) Register page number to select before writing (e.g. ``0x07`` for page 7)

- **power_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin controlling the
power/reset status of the Ethernet controller. Leave unspecified for no power pin (default).

Expand Down Expand Up @@ -230,6 +236,11 @@ Configuration examples
mdio_pin: GPIO17
clk_mode: GPIO0_IN
phy_addr: 0
phy_registers:
- address: 0x10
value: 0x1FFA
page_id: 0x07
.. note::

Expand Down

0 comments on commit ebb27d6

Please sign in to comment.