RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

gnrc_rpl: doc: add note about auto-initialization

Browse Source
This commit is contained in:
Cenk Gündoğan 2016-05-14 12:47:12 +02:00
parent 1b4607ab43
commit e33011248f
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sys/include/net/gnrc/rpl.h
View File

@ -24,6 +24,25 @@
* USEMODULE += gnrc_rpl
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* - RPL auto-initialization on interface
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.mk}
* USEMODULE += auto_init_gnrc_rpl
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Auto-Initialization
* -------------------
*
* If the application defines only one interface (`GNRC_NETIF_NUMOF == 1`),
* then RPL will be initialized on this interface.
*
* If the application defines several interfaces (`GNRC_NETIF_NUMOF > 1`),
* then RPL will be initialized on the interface `GNRC_RPL_DEFAULT_NETIF`.
* Your application is responsible for setting `GNRC_RPL_DEFAULT_NETIF` to a
* valid interface PID, e.g. via `CFLAGS`.
*
* Initializing RPL on multiple interfaces automatically is currently not supported.
* Call `gnrc_rpl_init()` manually from your application for the desired interfaces in this case.
*
* CFLAGS
* ------
*
@ -49,6 +68,12 @@
* CFLAGS += -DGNRC_RPL_DODAG_CONF_OPTIONAL_ON_JOIN
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* - Set interface for auto-initialization if more than one
* interface exists (`GNRC_NETIF_NUMOF > 1`)
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.mk}
* CFLAGS += -DGNRC_RPL_DEFAULT_NETIF=6
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* @{
*
* @file