client.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include "byteorder.h"
#include "event.h"
#include "net/ipv6/addr.h"
#include "thread.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef DHCPV6_CLIENT_STACK_SIZE
#define DHCPV6_CLIENT_STACK_SIZE    (THREAD_STACKSIZE_DEFAULT)  
#endif
 
#ifndef DHCPV6_CLIENT_PRIORITY
#define DHCPV6_CLIENT_PRIORITY      (THREAD_PRIORITY_MAIN - 2)  
#endif
#define DHCPV6_CLIENT_DUID_LEN      (sizeof(dhcpv6_duid_l2_t) + 8U)
#define DHCPV6_CLIENT_BUFLEN        (256)   
#ifndef CONFIG_DHCPV6_CLIENT_PFX_LEASE_MAX
#define CONFIG_DHCPV6_CLIENT_PFX_LEASE_MAX (1U)
#endif
 
#ifndef CONFIG_DHCPV6_CLIENT_ADDR_LEASE_MAX
#define CONFIG_DHCPV6_CLIENT_ADDR_LEASE_MAX (1U)
#endif
 
#if defined(MODULE_DHCPV6_CLIENT_IA_NA) || defined(DOXYGEN)
#define DHCPV6_CLIENT_ADDRS_NUMOF ((int)(CONFIG_DHCPV6_CLIENT_ADDR_LEASE_MAX))
#else
#define DHCPV6_CLIENT_ADDRS_NUMOF (0)
#endif
 
#ifndef CONFIG_DHCPV6_CLIENT_MUD_URL
#define CONFIG_DHCPV6_CLIENT_MUD_URL "https://example.org"
#endif
 
typedef struct __attribute__((packed)) {
    network_uint16_t type;      
    network_uint16_t l2type;    
    /* link-layer address follows this header */
} dhcpv6_duid_l2_t;
 
#if defined(MODULE_AUTO_INIT_DHCPV6_CLIENT) || defined(DOXYGEN)
void dhcpv6_client_auto_init(void);
#endif /* MODULE_DHCPV6_CLIENT_AUTO_INIT */
 
void dhcpv6_client_init(event_queue_t *event_queue, uint16_t netif);
 
void dhcpv6_client_start(void);
 
int dhcpv6_client_req_ia_pd(unsigned netif, unsigned pfx_len);
int dhcpv6_client_req_ia_na(unsigned netif);
unsigned dhcpv6_client_get_duid_l2(unsigned netif, dhcpv6_duid_l2_t *duid);
 
void dhcpv6_client_conf_prefix(unsigned netif, const ipv6_addr_t *pfx,
                               unsigned pfx_len, uint32_t valid,
                               uint32_t pref);
 
static inline void dhcpv6_client_conf_addr(unsigned netif, const ipv6_addr_t *addr,
                                           uint32_t valid, uint32_t pref)
{
    dhcpv6_client_conf_prefix(netif, addr, IPV6_ADDR_BIT_LEN, valid, pref);
}
 
bool dhcpv6_client_check_ia_na(unsigned netif);
 
uint32_t dhcpv6_client_prefix_valid_until(unsigned netif,
                                          const ipv6_addr_t *pfx,
                                          unsigned pfx_len);
 
static inline uint32_t dhcpv6_client_addr_valid_until(unsigned netif,
                                                      const ipv6_addr_t *addr)
{
    return dhcpv6_client_prefix_valid_until(netif, addr, IPV6_ADDR_BIT_LEN);
}
 
#if defined(MODULE_DHCPV6_CLIENT_MUD_URL) || defined(DOXYGEN)
#define DHCPV6_CLIENT_SEND_BUFLEN        (DHCPV6_CLIENT_BUFLEN + 256)
#else
#define DHCPV6_CLIENT_SEND_BUFLEN        (DHCPV6_CLIENT_BUFLEN)
#endif
 
#define MAX_MUD_URL_LENGTH (0xFF - sizeof(dhcpv6_opt_mud_url_t))
 
enum {
    DHCPV6_CLIENT_CONF_MODE_INACTIVE,
    DHCPV6_CLIENT_CONF_MODE_STATEFUL,
    DHCPV6_CLIENT_CONF_MODE_STATELESS,
};
 
void dhcpv6_client_set_conf_mode(uint8_t configuration_mode);
 
uint8_t dhcpv6_client_get_conf_mode(void);
 
#ifdef __cplusplus
}
#endif