summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-23 11:25:08 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-23 16:26:30 +0200
commita3172c7f26d20bcaf30c460b8bb0b64334962765 (patch)
tree8ce2fe5e6919f0e7406026818cdcf32a04ac93e7 /CONTRIBUTING.rst
parentlibbsd.txt: Move features (diff)
downloadrtems-libbsd-a3172c7f26d20bcaf30c460b8bb0b64334962765.tar.bz2
libbsd.txt: Move network interface driver hints
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 1d45f0ef..1113136c 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -416,3 +416,17 @@ within interrupt context is not allowed, so the Board Support Package (BSP)
should support the
`Interrupt Manager <https://docs.rtems.org/branches/master/c-user/interrupt/directives.html#rtems-interrupt-server-handler-install>`_
in general.
+
+Network Interface Drivers Hints
+===============================
+
+Link Up/Down Events
+-------------------
+
+You can notifiy the application space of link up/down events in your network
+interface driver via the
+``if_link_state_change(LINK_STATE_UP/LINK_STATE_DOWN)`` function. The
+DHCPCD(8) client is a consumer of these events for example. Make sure that the
+interface flag ``IFF_UP`` and the interface driver flag ``IFF_DRV_RUNNING`` is
+set in case the link is up, otherwise ``ether_output()`` will return the error
+status ``ENETDOWN``.