auto_ip_misc.h
Go to the documentation of this file.
1 /**
2  * @file auto_ip_misc.h
3  * @brief Helper functions for Auto-IP
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _AUTO_IP_MISC_H
32 #define _AUTO_IP_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "ipv4/auto_ip.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //Tick counter to handle periodic operations
45 
46 //Auto-IP related functions
47 void autoIpTick(AutoIpContext *context);
49 
50 void autoIpChangeState(AutoIpContext *context, AutoIpState newState,
51  systime_t delay);
52 
54 
55 void autoIpResetConfig(AutoIpContext *context);
56 void autoIpDumpConfig(AutoIpContext *context);
57 
58 //C++ guard
59 #ifdef __cplusplus
60 }
61 #endif
62 
63 #endif
#define AutoIpContext
Definition: auto_ip.h:139
uint32_t Ipv4Addr
IPv4 network address.
Definition: ipv4.h:297
void autoIpTick(AutoIpContext *context)
Auto-IP timer handler.
Definition: auto_ip_misc.c:59
systime_t autoIpTickCounter
Definition: auto_ip_misc.c:47
void autoIpChangeState(AutoIpContext *context, AutoIpState newState, systime_t delay)
Update Auto-IP FSM state.
Definition: auto_ip_misc.c:318
void autoIpResetConfig(AutoIpContext *context)
Reset Auto-IP configuration.
Definition: auto_ip_misc.c:371
uint32_t systime_t
System time.
void autoIpLinkChangeEvent(AutoIpContext *context)
Callback function for link change event.
Definition: auto_ip_misc.c:270
void autoIpGenerateAddr(Ipv4Addr *ipAddr)
Generate a random link-local address.
Definition: auto_ip_misc.c:353
Ipv4Addr ipAddr
Definition: ipcp.h:105
TCP/IP stack core.
AutoIpState
Auto-IP FSM states.
Definition: auto_ip.h:152
void autoIpDumpConfig(AutoIpContext *context)
Dump Auto-IP configuration for debugging purpose.
Definition: auto_ip_misc.c:399
Auto-IP (Dynamic Configuration of IPv4 Link-Local Addresses)