dhcpv4.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_DHCPV4_H_
#define ZEPHYR_INCLUDE_NET_DHCPV4_H_
 
#include <zephyr/sys/slist.h>
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif



enum net_dhcpv4_state {
        NET_DHCPV4_DISABLED,
        NET_DHCPV4_INIT,
        NET_DHCPV4_INIT_REBOOT,
        NET_DHCPV4_SELECTING,
        NET_DHCPV4_REQUESTING,
        NET_DHCPV4_RENEWING,
        NET_DHCPV4_REBINDING,
        NET_DHCPV4_BOUND,
        NET_DHCPV4_DECLINE,
} __packed;


enum net_dhcpv4_msg_type {
        NET_DHCPV4_MSG_TYPE_DISCOVER    = 1, 
        NET_DHCPV4_MSG_TYPE_OFFER       = 2, 
        NET_DHCPV4_MSG_TYPE_REQUEST     = 3, 
        NET_DHCPV4_MSG_TYPE_DECLINE     = 4, 
        NET_DHCPV4_MSG_TYPE_ACK         = 5, 
        NET_DHCPV4_MSG_TYPE_NAK         = 6, 
        NET_DHCPV4_MSG_TYPE_RELEASE     = 7, 
        NET_DHCPV4_MSG_TYPE_INFORM      = 8, 
};
 
struct net_dhcpv4_option_callback;
struct net_in_addr;

typedef void (*net_dhcpv4_option_callback_handler_t)(struct net_dhcpv4_option_callback *cb,
                                                     size_t length,
                                                     enum net_dhcpv4_msg_type msg_type,
                                                     struct net_if *iface);


struct net_dhcpv4_option_callback {
        sys_snode_t node;

        net_dhcpv4_option_callback_handler_t handler;

        uint8_t option;

        size_t max_length;

        void *data;
};


static inline void net_dhcpv4_init_option_callback(struct net_dhcpv4_option_callback *callback,
                                                   net_dhcpv4_option_callback_handler_t handler,
                                                   uint8_t option,
                                                   void *data,
                                                   size_t max_length)
{
        __ASSERT(callback, "Callback pointer should not be NULL");
        __ASSERT(handler, "Callback handler pointer should not be NULL");
        __ASSERT(data, "Data pointer should not be NULL");
 
        callback->handler = handler;
        callback->option = option;
        callback->data = data;
        callback->max_length = max_length;
}

int net_dhcpv4_add_option_callback(struct net_dhcpv4_option_callback *cb);

int net_dhcpv4_remove_option_callback(struct net_dhcpv4_option_callback *cb);

static inline void
net_dhcpv4_init_option_vendor_callback(struct net_dhcpv4_option_callback *callback,
                                       net_dhcpv4_option_callback_handler_t handler, uint8_t option,
                                       void *data, size_t max_length)
{
        __ASSERT(callback, "Callback pointer should not be NULL");
        __ASSERT(handler, "Callback handler pointer should not be NULL");
        __ASSERT(data, "Data pointer should not be NULL");
 
        callback->handler = handler;
        callback->option = option;
        callback->data = data;
        callback->max_length = max_length;
}

int net_dhcpv4_add_option_vendor_callback(struct net_dhcpv4_option_callback *cb);

int net_dhcpv4_remove_option_vendor_callback(struct net_dhcpv4_option_callback *cb);

void net_dhcpv4_start(struct net_if *iface);

void net_dhcpv4_stop(struct net_if *iface);

void net_dhcpv4_restart(struct net_if *iface);

int net_dhcpv4_set_reboot_hint(struct net_if *iface,
                               const struct net_in_addr *requested_ip);


const char *net_dhcpv4_state_name(enum net_dhcpv4_state state);


const char *net_dhcpv4_msg_type_name(enum net_dhcpv4_msg_type msg_type);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_DHCPV4_H_ */