Documentation: LEDs: Describe good names for network LEDs
authorAndrew Lunn <andrew@lunn.ch>
Mon, 17 Apr 2023 15:17:38 +0000 (17:17 +0200)
committerDavid S. Miller <davem@davemloft.net>
Wed, 19 Apr 2023 11:59:16 +0000 (12:59 +0100)
commitc693ea2fd6e3b43f6caaf618f864236c36a71f70
tree48039656e5911bc28ac97dd1a0dbfd3ad66470eb
parent380a8fe1b2f49f262673485d1c7f1c0da170a926
Documentation: LEDs: Describe good names for network LEDs

Network LEDs can exist in both the MAC and the PHY. Naming is
difficult because the netdev name is neither stable or unique, do to
commands like ip link set name eth42 dev eth0, and network
namesspaces.

Give some example names where the MAC and the PHY have unique names
based on device tree nodes, or PCI bus addresses.

Since the LED can be used for anything which Linux supports for LEDs,
avoid using names like activity or link, rather describe the location
on the RJ-45, of what the RJ-45 is expected to be used for, WAN/LAN
etc.

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/leds/well-known-leds.txt