dhcpv4_server.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_DHCPV4_SERVER_H_
#define ZEPHYR_INCLUDE_NET_DHCPV4_SERVER_H_
 
#include <zephyr/net/net_ip.h>
#include <zephyr/sys/clock.h>
 
#ifdef __cplusplus
extern "C" {
#endif


 
struct net_if;
 
#define DHCPV4_CLIENT_ID_MAX_SIZE 20

#define DHCPV4_HARDWARE_ADDRESS_MAX_SIZE 16
 
enum dhcpv4_server_addr_state {
        DHCPV4_SERVER_ADDR_FREE,
        DHCPV4_SERVER_ADDR_RESERVED,
        DHCPV4_SERVER_ADDR_ALLOCATED,
        DHCPV4_SERVER_ADDR_DECLINED,
};
 
struct dhcpv4_client_id {
        uint8_t hw_addr_type;
        uint8_t hw_addr_buf[DHCPV4_HARDWARE_ADDRESS_MAX_SIZE];
        uint8_t hw_addr_len;
 
        uint8_t buf[DHCPV4_CLIENT_ID_MAX_SIZE];
        uint8_t len;
};
 
struct dhcpv4_addr_slot {
        enum dhcpv4_server_addr_state state;
        struct dhcpv4_client_id client_id;
        struct net_in_addr addr;
        uint32_t lease_time;
        k_timepoint_t expiry;
};


int net_dhcpv4_server_start(struct net_if *iface, struct net_in_addr *base_addr);

int net_dhcpv4_server_stop(struct net_if *iface);

typedef void (*net_dhcpv4_lease_cb_t)(struct net_if *iface,
                                      struct dhcpv4_addr_slot *lease,
                                      void *user_data);

int net_dhcpv4_server_foreach_lease(struct net_if *iface,
                                    net_dhcpv4_lease_cb_t cb,
                                    void *user_data);

typedef int (*net_dhcpv4_server_provider_cb_t)(struct net_if *iface,
                                               const struct dhcpv4_client_id *client_id,
                                               struct net_in_addr *addr,
                                               void *user_data);
void net_dhcpv4_server_set_provider_cb(net_dhcpv4_server_provider_cb_t cb,
                                       void *user_data);

typedef bool (*net_dhcpv4_server_address_validator_cb_t)(struct net_if *iface,
                                                        const struct dhcpv4_client_id *client_id,
                                                        const struct net_in_addr *addr,
                                                        void *user_data);
void net_dhcpv4_server_set_address_validator_cb(net_dhcpv4_server_address_validator_cb_t cb,
                                                void *user_data);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_DHCPV4_SERVER_H_ */