bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: net: Enhance Ethernet management documentation

Browse Source 
The Ethernet management documentation was missing Overview
chapter.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-26 15:09:35 +02:00 committed by Anas Nashif
parent f6208622fb
commit cd100899ed
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/reference/networking/ethernet_mgmt.rst
View File

@ -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
*************