Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
dhcpv4.h
Go to the documentation of this file.
1
5/*
6 * Copyright (c) 2016 Intel Corporation
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10
11#ifndef ZEPHYR_INCLUDE_NET_DHCPV4_H_
12#define ZEPHYR_INCLUDE_NET_DHCPV4_H_
13
14#include <zephyr/sys/slist.h>
15#include <zephyr/types.h>
16
17#ifdef __cplusplus
18extern "C" {
19#endif
20
37enum net_dhcpv4_state {
38 NET_DHCPV4_DISABLED,
39 NET_DHCPV4_INIT,
40 NET_DHCPV4_SELECTING,
41 NET_DHCPV4_REQUESTING,
42 NET_DHCPV4_RENEWING,
43 NET_DHCPV4_REBINDING,
44 NET_DHCPV4_BOUND,
45 NET_DHCPV4_DECLINE,
46} __packed;
47
69
70struct net_dhcpv4_option_callback;
71
87typedef void (*net_dhcpv4_option_callback_handler_t)(struct net_dhcpv4_option_callback *cb,
88 size_t length,
89 enum net_dhcpv4_msg_type msg_type,
90 struct net_if *iface);
91
104struct net_dhcpv4_option_callback {
108 sys_snode_t node;
109
112
114 uint8_t option;
115
117 size_t max_length;
118
122 void *data;
123};
124
135static inline void net_dhcpv4_init_option_callback(struct net_dhcpv4_option_callback *callback,
137 uint8_t option,
138 void *data,
139 size_t max_length)
140{
141 __ASSERT(callback, "Callback pointer should not be NULL");
142 __ASSERT(handler, "Callback handler pointer should not be NULL");
143 __ASSERT(data, "Data pointer should not be NULL");
144
145 callback->handler = handler;
146 callback->option = option;
147 callback->data = data;
148 callback->max_length = max_length;
149}
150
156int net_dhcpv4_add_option_callback(struct net_dhcpv4_option_callback *cb);
157
163int net_dhcpv4_remove_option_callback(struct net_dhcpv4_option_callback *cb);
164
174static inline void
175net_dhcpv4_init_option_vendor_callback(struct net_dhcpv4_option_callback *callback,
177 void *data, size_t max_length)
178{
179 __ASSERT(callback, "Callback pointer should not be NULL");
180 __ASSERT(handler, "Callback handler pointer should not be NULL");
181 __ASSERT(data, "Data pointer should not be NULL");
182
183 callback->handler = handler;
184 callback->option = option;
185 callback->data = data;
186 callback->max_length = max_length;
187}
188
194int net_dhcpv4_add_option_vendor_callback(struct net_dhcpv4_option_callback *cb);
195
201int net_dhcpv4_remove_option_vendor_callback(struct net_dhcpv4_option_callback *cb);
202
212void net_dhcpv4_start(struct net_if *iface);
213
223void net_dhcpv4_stop(struct net_if *iface);
224
234void net_dhcpv4_restart(struct net_if *iface);
235
243const char *net_dhcpv4_state_name(enum net_dhcpv4_state state);
244
254
259#ifdef __cplusplus
260}
261#endif
262
263#endif /* ZEPHYR_INCLUDE_NET_DHCPV4_H_ */
int net_dhcpv4_remove_option_vendor_callback(struct net_dhcpv4_option_callback *cb)
Remove an application callback for encapsulated vendor-specific options.
const char * net_dhcpv4_msg_type_name(enum net_dhcpv4_msg_type msg_type)
Return a text representation of the msg_type.
void net_dhcpv4_restart(struct net_if *iface)
Restart DHCPv4 client on an iface.
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)
Define the application callback handler function signature.
Definition dhcpv4.h:87
static 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)
Helper to initialize a struct net_dhcpv4_option_callback properly.
Definition dhcpv4.h:135
void net_dhcpv4_stop(struct net_if *iface)
Stop DHCPv4 client on an iface.
int net_dhcpv4_remove_option_callback(struct net_dhcpv4_option_callback *cb)
Remove an application callback.
int net_dhcpv4_add_option_vendor_callback(struct net_dhcpv4_option_callback *cb)
Add an application callback for encapsulated vendor-specific options.
net_dhcpv4_msg_type
DHCPv4 message types.
Definition dhcpv4.h:59
static 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)
Helper to initialize a struct net_dhcpv4_option_callback for encapsulated vendor-specific options pro...
Definition dhcpv4.h:175
int net_dhcpv4_add_option_callback(struct net_dhcpv4_option_callback *cb)
Add an application callback.
void net_dhcpv4_start(struct net_if *iface)
Start DHCPv4 client on an iface.
@ NET_DHCPV4_MSG_TYPE_REQUEST
Request message.
Definition dhcpv4.h:62
@ NET_DHCPV4_MSG_TYPE_ACK
Acknowledge message.
Definition dhcpv4.h:64
@ NET_DHCPV4_MSG_TYPE_OFFER
Offer message.
Definition dhcpv4.h:61
@ NET_DHCPV4_MSG_TYPE_RELEASE
Release message.
Definition dhcpv4.h:66
@ NET_DHCPV4_MSG_TYPE_NAK
Negative acknowledge message.
Definition dhcpv4.h:65
@ NET_DHCPV4_MSG_TYPE_DISCOVER
Discover message.
Definition dhcpv4.h:60
@ NET_DHCPV4_MSG_TYPE_INFORM
Inform message.
Definition dhcpv4.h:67
@ NET_DHCPV4_MSG_TYPE_DECLINE
Decline message.
Definition dhcpv4.h:63
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
state
Definition parser_state.h:29
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Network Interface structure.
Definition net_if.h:680