doc: net: Enhance DHCPv4 documentation

Add short overview for DHCPv4. Do not add dhcpv4 library internal
state in the documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-19 11:07:33 +02:00 committed by Anas Nashif
parent a7f1c10371
commit 5e83e919e3
2 changed files with 24 additions and 2 deletions

View file

@ -1,11 +1,25 @@
.. _dhcpv4_interface:
DHCP v4
#######
DHCPv4
######
Overview
********
The Dynamic Host Configuration Protocol (DHCP) is a network management protocol
used on IPv4 networks. A DHCPv4 server dynamically assigns an IPv4 address
and other network configuration parameters to each device on a network so they
can communicate with other IP networks.
See this
`DHCP Wikipedia article <https://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol>`_
for a detailed overview of how DHCP works.
Note that Zephyr only supports DHCP client functionality.
Sample usage
************
See :ref:`dhcpv4-client-sample` for details.
API Reference
*************

View file

@ -25,6 +25,8 @@ extern "C" {
#include <misc/slist.h>
#include <zephyr/types.h>
/** @cond INTERNAL_HIDDEN */
/** Current state of DHCPv4 client address negotiation.
*
* Additions removals and reorders in this definition must be
@ -40,6 +42,8 @@ enum net_dhcpv4_state {
NET_DHCPV4_BOUND,
} __packed;
/** @endcond */
/**
* @brief Start DHCPv4 client on an iface
*
@ -62,6 +66,8 @@ void net_dhcpv4_start(struct net_if *iface);
*/
void net_dhcpv4_stop(struct net_if *iface);
/** @cond INTERNAL_HIDDEN */
/**
* @brief DHCPv4 state name
*
@ -69,6 +75,8 @@ void net_dhcpv4_stop(struct net_if *iface);
*/
const char *net_dhcpv4_state_name(enum net_dhcpv4_state state);
/** @endcond */
/**
* @}
*/