patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

net: config: Document the flags options

Browse source 
The documentation for NET_CONFIG_NEED_* flags was missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-20 12:17:23 +02:00 committed by Anas Nashif
parent 65208bda28
commit 567117c993
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
include/net/net_config.h
View file

@ -24,9 +24,24 @@ extern "C" {
* @{
*/
/** Flags that tell what kind of functionality is needed by the client. */
/* Flags that tell what kind of functionality is needed by the client. */
/**
* @brief Application needs routers to be set so that connectivity to remote
* network is possible. For IPv6 networks, this means that the device should
* receive IPv6 router advertisement message before continuing.
*/
#define NET_CONFIG_NEED_ROUTER 0x00000001
/**
* @brief Application needs IPv6 subsystem configured and initialized.
* Typically this means that the device has IPv6 address set.
*/
#define NET_CONFIG_NEED_IPV6 0x00000002
/**
* @brief Application needs IPv4 subsystem configured and initialized.
* Typically this means that the device has IPv4 address set.
*/
#define NET_CONFIG_NEED_IPV4 0x00000004
/**