From cd100899edda3a832cbe643dca5d83da232a4d5e Mon Sep 17 00:00:00 2001 From: Jukka Rissanen Date: Tue, 26 Feb 2019 15:09:35 +0200 Subject: [PATCH] doc: net: Enhance Ethernet management documentation The Ethernet management documentation was missing Overview chapter. Signed-off-by: Jukka Rissanen --- doc/reference/networking/ethernet_mgmt.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/reference/networking/ethernet_mgmt.rst b/doc/reference/networking/ethernet_mgmt.rst index d36aeb4b172..c06d6de95ba 100644 --- a/doc/reference/networking/ethernet_mgmt.rst +++ b/doc/reference/networking/ethernet_mgmt.rst @@ -6,6 +6,22 @@ Ethernet Management Overview ******** +Ethernet management API provides functions to manage the Ethernet +network interface low level status. The caller of these functions can: + +* raise ``carrier ON`` or ``carrier OFF`` management events +* raise ``VLAN enabled`` or ``VLAN disabled`` management events + +Typically the ``carrier OFF`` event would be generated by the Ethernet +device driver when it notices that the Ethernet cable is disconnected. +The ``carrier ON`` event would be generated if the Ethernet device driver +notices that the Ethernet cable is re-connected. + +Currently the VLAN events are generated by the Ethernet L2 layer when a +specific VLAN tag is either enabled or disabled. + +The user application can monitor these events if it needs to act +when the corresponding status changes. API Reference *************