zephyr/doc/hardware/peripherals/mdio.rst
Henrik Brix Andersen 0ae32479b7 doc: peripherals: unify title strings
Unify the peripheral documentation title strings to the format
"<class> [(acronym)] [Bus]".

Including both the full name of the peripheral class and an acronym makes
the documentation more user friendly as some of the acronyms are less
well-known than others.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-03-29 09:48:13 +00:00

21 lines
472 B
ReStructuredText

.. _mdio_api:
Management Data Input/Output (MDIO)
###################################
Overview
********
MDIO is a bus that is commonly used to communicate with ethernet PHY devices.
Many ethernet MAC controllers also provide hardware to communicate over MDIO
bus with a peripheral device.
This API is intended to be used primarily by PHY drivers but can also be
used by user firmware.
API Reference
*************
.. doxygengroup:: mdio_interface
:project: Zephyr