1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/cpu/stm32/periph/doc.txt
Marian Buschsieweke 5f9b55a182
cpu/stm32: Add stm32_eth_auto for auto-negotiation
Expose the auto-negotiation feature of the Ethernet device via the
pseudo-module stm32_eth_auto. With this enabled, the static speed configuration
set in the boards periph_conf.h will only be used if the PHY lacks
auto-negotiation capabilities - which is unlikely to ever happen.
2020-10-22 12:37:23 +02:00

33 lines
1.2 KiB
Plaintext

/**
* @defgroup stm32_eth STM32 Peripheral Ethernet Driver
* @ingroup drivers_netdev
* @brief Driver for the Peripheral STM32 Ethernet block used across
* all families of STM32 MCUs
*
* Link Auto Negotiation
* =====================
*
* To enable Link Auto Negotiation, use the (pseudo) module `stm32_eth_auto`
* by amending your applications `Makefile` as follows:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* # Add the following line to your Makefile
* USEMODULE += stm32_eth_auto
*
* # Note: Any addition of modules to USEMODULE must be done prior to the
* # following line:
* include $(RIOTBASE)/Makefile.include
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* In general, it is highly recommended to use auto-negotiation, as this can
* avoid various communication issues on the PHY layer due to configuration
* mismatch of the link partners. Note that this feature depends on the link
* state events feature.
*
* Link State Events
* =================
*
* To enable Link Events, use the (pseudo) module `stm32_eth_link_up` (as
* described above).
*/