net.h
Go to the documentation of this file.
1 /**
2  * @file net.h
3  * @brief TCP/IP stack core
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2022 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.1.8
29  **/
30 
31 #ifndef _NET_H
32 #define _NET_H
33 
34 //Forward declaration of NetInterface structure
35 struct _NetInterface;
36 #define NetInterface struct _NetInterface
37 
38 //Dependencies
39 #include "os_port.h"
40 #include "net_config.h"
41 #include "core/net_legacy.h"
42 #include "core/net_mem.h"
43 #include "core/net_misc.h"
44 #include "core/nic.h"
45 #include "core/ethernet.h"
46 #include "ipv4/ipv4.h"
47 #include "ipv4/ipv4_frag.h"
48 #include "ipv4/auto_ip.h"
49 #include "ipv6/ipv6.h"
50 #include "ipv4/arp.h"
51 #include "igmp/igmp_host.h"
52 #include "igmp/igmp_router.h"
53 #include "igmp/igmp_snooping.h"
54 #include "ipv6/ndp.h"
55 #include "ipv6/ndp_router_adv.h"
56 #include "ipv6/slaac.h"
57 #include "ppp/ppp.h"
58 #include "dhcp/dhcp_client.h"
59 #include "dhcp/dhcp_server.h"
60 #include "dhcpv6/dhcpv6_client.h"
61 #include "dns/dns_client.h"
62 #include "mdns/mdns_responder.h"
63 #include "mdns/mdns_common.h"
64 #include "dns_sd/dns_sd.h"
65 #include "cpu_endian.h"
66 #include "error.h"
67 
68 
69 /*
70  * CycloneTCP Open is licensed under GPL version 2. In particular:
71  *
72  * - If you link your program to CycloneTCP Open, the result is a derivative
73  * work that can only be distributed under the same GPL license terms.
74  *
75  * - If additions or changes to CycloneTCP Open are made, the result is a
76  * derivative work that can only be distributed under the same license terms.
77  *
78  * - The GPL license requires that you make the source code available to
79  * whoever you make the binary available to.
80  *
81  * - If you sell or distribute a hardware product that runs CycloneTCP Open,
82  * the GPL license requires you to provide public and full access to all
83  * source code on a nondiscriminatory basis.
84  *
85  * If you fully understand and accept the terms of the GPL license, then edit
86  * the os_port_config.h header and add the following directive:
87  *
88  * #define GPL_LICENSE_TERMS_ACCEPTED
89  */
90 
91 #ifndef GPL_LICENSE_TERMS_ACCEPTED
92  #error Before compiling CycloneTCP Open, you must accept the terms of the GPL license
93 #endif
94 
95 //Version string
96 #define CYCLONE_TCP_VERSION_STRING "2.1.8"
97 //Major version
98 #define CYCLONE_TCP_MAJOR_VERSION 2
99 //Minor version
100 #define CYCLONE_TCP_MINOR_VERSION 1
101 //Revision number
102 #define CYCLONE_TCP_REV_NUMBER 8
103 
104 //RTOS support
105 #ifndef NET_RTOS_SUPPORT
106  #define NET_RTOS_SUPPORT ENABLED
107 #elif (NET_RTOS_SUPPORT != ENABLED && NET_RTOS_SUPPORT != DISABLED)
108  #error NET_RTOS_SUPPORT parameter is not valid
109 #endif
110 
111 //Number of network adapters
112 #ifndef NET_INTERFACE_COUNT
113  #define NET_INTERFACE_COUNT 1
114 #elif (NET_INTERFACE_COUNT < 1)
115  #error NET_INTERFACE_COUNT parameter is not valid
116 #endif
117 
118 //Loopback interface support
119 #ifndef NET_LOOPBACK_IF_SUPPORT
120  #define NET_LOOPBACK_IF_SUPPORT DISABLED
121 #elif (NET_LOOPBACK_IF_SUPPORT != ENABLED && NET_LOOPBACK_IF_SUPPORT != DISABLED)
122  #error NET_LOOPBACK_IF_SUPPORT parameter is not valid
123 #endif
124 
125 //Maximum number of link change callback functions that can be registered
126 #ifndef NET_MAX_LINK_CHANGE_CALLBACKS
127  #define NET_MAX_LINK_CHANGE_CALLBACKS (6 * NET_INTERFACE_COUNT)
128 #elif (NET_MAX_LINK_CHANGE_CALLBACKS < 1)
129  #error NET_MAX_LINK_CHANGE_CALLBACKS parameter is not valid
130 #endif
131 
132 //Maximum number of timer callback functions that can be registered
133 #ifndef NET_MAX_TIMER_CALLBACKS
134  #define NET_MAX_TIMER_CALLBACKS (6 * NET_INTERFACE_COUNT)
135 #elif (NET_MAX_TIMER_CALLBACKS < 1)
136  #error NET_MAX_TIMER_CALLBACKS parameter is not valid
137 #endif
138 
139 //Maximum length of interface name
140 #ifndef NET_MAX_IF_NAME_LEN
141  #define NET_MAX_IF_NAME_LEN 8
142 #elif (NET_MAX_IF_NAME_LEN < 1)
143  #error NET_MAX_IF_NAME_LEN parameter is not valid
144 #endif
145 
146 //Maximum length of host name
147 #ifndef NET_MAX_HOSTNAME_LEN
148  #define NET_MAX_HOSTNAME_LEN 24
149 #elif (NET_MAX_HOSTNAME_LEN < 1)
150  #error NET_MAX_HOSTNAME_LEN parameter is not valid
151 #endif
152 
153 //Size of the seed
154 #ifndef NET_RAND_SEED_SIZE
155  #define NET_RAND_SEED_SIZE 16
156 #elif (NET_RAND_SEED_SIZE < 10)
157  #error NET_RAND_SEED_SIZE parameter is not valid
158 #endif
159 
160 //Stack size required to run the TCP/IP task
161 #ifndef NET_TASK_STACK_SIZE
162  #define NET_TASK_STACK_SIZE 650
163 #elif (NET_TASK_STACK_SIZE < 1)
164  #error NET_TASK_STACK_SIZE parameter is not valid
165 #endif
166 
167 //Priority at which the TCP/IP task should run
168 #ifndef NET_TASK_PRIORITY
169  #define NET_TASK_PRIORITY OS_TASK_PRIORITY_HIGH
170 #endif
171 
172 //TCP/IP stack tick interval
173 #ifndef NET_TICK_INTERVAL
174  #define NET_TICK_INTERVAL 100
175 #elif (NET_TICK_INTERVAL < 10)
176  #error NET_TICK_INTERVAL parameter is not valid
177 #endif
178 
179 //Get system tick count
180 #ifndef netGetSystemTickCount
181  #define netGetSystemTickCount() osGetSystemTime()
182 #endif
183 
184 //C++ guard
185 #ifdef __cplusplus
186 extern "C" {
187 #endif
188 
189 
190 /**
191  * @brief Structure describing a network interface
192  **/
193 
195 {
196  uint_t index; ///<Zero-based index
197  uint32_t id; ///<A unique number identifying the interface
198  Eui64 eui64; ///<EUI-64 interface identifier
199  char_t name[NET_MAX_IF_NAME_LEN + 1]; ///<A unique name identifying the interface
201  const NicDriver *nicDriver; ///<NIC driver
202  const SpiDriver *spiDriver; ///<Underlying SPI driver
203  const UartDriver *uartDriver; ///<Underlying UART driver
204  const ExtIntDriver *extIntDriver; ///<External interrupt line driver
205  uint8_t nicContext[NIC_CONTEXT_SIZE]; ///<Driver specific context
206  OsEvent nicTxEvent; ///<Network controller TX event
207  bool_t nicEvent; ///<A NIC event is pending
208  NicLinkState adminLinkState; ///<Administrative link state
209  bool_t linkState; ///<Link state
210  uint32_t linkSpeed; ///<Link speed
211  NicDuplexMode duplexMode; ///<Duplex mode
212  bool_t configured; ///<Configuration done
213 
214 #if (ETH_SUPPORT == ENABLED)
215  const PhyDriver *phyDriver; ///<Ethernet PHY driver
216  uint8_t phyAddr; ///<PHY address
217  bool_t phyEvent; ///<A PHY event is pending
218  const SwitchDriver *switchDriver; ///<Ethernet switch driver
219  const SmiDriver *smiDriver; ///<SMI driver
220  MacAddr macAddr; ///<Link-layer address
222  bool_t promiscuous; ///<Promiscuous mode
223  bool_t acceptAllMulticast; ///<Accept all frames with a multicast destination address
224 #endif
225 #if (ETH_VLAN_SUPPORT == ENABLED)
226  uint16_t vlanId; ///<VLAN identifier (802.1Q)
227 #endif
228 #if (ETH_VMAN_SUPPORT == ENABLED)
229  uint16_t vmanId; ///<VMAN identifier (802.1ad)
230 #endif
231 #if (ETH_LLC_SUPPORT == ENABLED)
232  LlcRxCallback llcRxCallback; ///<LLC frame received callback (802.2)
233  void *llcRxParam; ///<Callback parameter
234 #endif
235 #if (ETH_PORT_TAGGING_SUPPORT == ENABLED)
236  uint8_t port; ///<Switch port identifier
237 #endif
238 #if (ETH_VIRTUAL_IF_SUPPORT == ENABLED || ETH_VLAN_SUPPORT == ENABLED || \
239  ETH_PORT_TAGGING_SUPPORT == ENABLED)
240  NetInterface *parent; ///<Interface on top of which the virtual interface runs
241 #endif
242 
243 #if (IPV4_SUPPORT == ENABLED)
244  Ipv4Context ipv4Context; ///<IPv4 context
245 #if (ETH_SUPPORT == ENABLED)
247 #endif
248 #if (IGMP_HOST_SUPPORT == ENABLED)
249  IgmpHostContext igmpHostContext; ///<IGMP host context
250 #endif
251 #if (IGMP_ROUTER_SUPPORT == ENABLED)
252  IgmpRouterContext *igmpRouterContext; ///<IGMP router context
253 #endif
254 #if (IGMP_SNOOPING_SUPPORT == ENABLED)
255  IgmpSnoopingContext *igmpSnoopingContext; ///<IGMP snooping switch context
256 #endif
257 #if (AUTO_IP_SUPPORT == ENABLED)
258  AutoIpContext *autoIpContext; ///<Auto-IP context
259 #endif
260 #if (DHCP_CLIENT_SUPPORT == ENABLED)
261  DhcpClientContext *dhcpClientContext; ///<DHCP client context
262 #endif
263 #if (DHCP_SERVER_SUPPORT == ENABLED)
264  DhcpServerContext *dhcpServerContext; ///<DHCP server context
265 #endif
266 #endif
267 
268 #if (IPV6_SUPPORT == ENABLED)
269  Ipv6Context ipv6Context; ///<IPv6 context
270 #if (NDP_SUPPORT == ENABLED)
271  NdpContext ndpContext; ///<NDP context
272 #endif
273 #if (NDP_ROUTER_ADV_SUPPORT == ENABLED)
274  NdpRouterAdvContext *ndpRouterAdvContext; ///<RA service context
275 #endif
276 #if (SLAAC_SUPPORT == ENABLED)
277  SlaacContext *slaacContext; ///<SLAAC context
278 #endif
279 #if (DHCPV6_CLIENT_SUPPORT == ENABLED)
280  Dhcpv6ClientContext *dhcpv6ClientContext; ///<DHCPv6 client context
281 #endif
282 #endif
283 
284 #if (MDNS_RESPONDER_SUPPORT == ENABLED)
285  MdnsResponderContext *mdnsResponderContext; ///<mDNS responder context
286 #endif
287 
288 #if (DNS_SD_SUPPORT == ENABLED)
289  DnsSdContext *dnsSdContext; ///DNS-SD context
290 #endif
291 
292 #if (PPP_SUPPORT == ENABLED)
293  PppContext *pppContext; ///<PPP context
294 #endif
295 };
296 
297 
298 /**
299  * @brief TCP/IP stack context
300  **/
301 
302 typedef struct
303 {
304  OsMutex mutex; ///<Mutex preventing simultaneous access to the TCP/IP stack
305  OsEvent event; ///<Event object to receive notifications from drivers
306  bool_t running; ///<The TCP/IP stack is currently running
307  OsTaskId taskId; ///<Task identifier
308 #if (OS_STATIC_TASK_SUPPORT == ENABLED)
309  OsTaskTcb taskTcb; ///<Task control block
310  OsStackType taskStack[NET_TASK_STACK_SIZE]; ///<Task stack
311 #endif
312  uint32_t entropy;
314  uint8_t randSeed[NET_RAND_SEED_SIZE]; ///<Random seed
315  NetRandState randState; ///<Pseudo-random number generator state
316  NetInterface interfaces[NET_INTERFACE_COUNT]; ///<Network interfaces
319 } NetContext;
320 
321 
322 //Global variables
323 extern NetContext netContext;
324 
325 //TCP/IP stack related functions
326 error_t netInit(void);
327 
328 error_t netSeedRand(const uint8_t *seed, size_t length);
329 uint32_t netGetRand(void);
330 uint32_t netGetRandRange(uint32_t min, uint32_t max);
331 void netGetRandData(uint8_t *data, size_t length);
332 
334 
335 error_t netSetMacAddr(NetInterface *interface, const MacAddr *macAddr);
336 error_t netGetMacAddr(NetInterface *interface, MacAddr *macAddr);
337 
338 error_t netSetEui64(NetInterface *interface, const Eui64 *eui64);
339 error_t netGetEui64(NetInterface *interface, Eui64 *eui64);
340 
341 error_t netSetInterfaceId(NetInterface *interface, uint32_t id);
343 error_t netSetHostname(NetInterface *interface, const char_t *name);
344 
345 error_t netSetVlanId(NetInterface *interface, uint16_t vlanId);
346 error_t netSetVmanId(NetInterface *interface, uint16_t vmanId);
347 
349  NetInterface *physicalInterface);
350 
351 error_t netSetDriver(NetInterface *interface, const NicDriver *driver);
352 
353 error_t netSetPhyDriver(NetInterface *interface, const PhyDriver *driver);
354 error_t netSetPhyAddr(NetInterface *interface, uint8_t phyAddr);
355 
356 error_t netSetSwitchDriver(NetInterface *interface, const SwitchDriver *driver);
357 error_t netSetSwitchPort(NetInterface *interface, uint8_t port);
358 
359 error_t netSetSmiDriver(NetInterface *interface, const SmiDriver *driver);
360 error_t netSetSpiDriver(NetInterface *interface, const SpiDriver *driver);
361 error_t netSetUartDriver(NetInterface *interface, const UartDriver *driver);
362 error_t netSetExtIntDriver(NetInterface *interface, const ExtIntDriver *driver);
363 
364 error_t netSetLinkState(NetInterface *interface, NicLinkState linkState);
366 
369 
371 
375 
376 void netTask(void);
377 
378 //C++ guard
379 #ifdef __cplusplus
380 }
381 #endif
382 
383 #endif
__start_packed struct @1 Eui64
EUI-64 identifier.
#define MdnsResponderContext
uint8_t length
Definition: coap_common.h:193
IPv6 (Internet Protocol Version 6)
const NicDriver * nicDriver
NIC driver.
Definition: net.h:201
error_t netSetEui64(NetInterface *interface, const Eui64 *eui64)
Set EUI-64 interface identifier.
Definition: net.c:496
uint32_t netGetRandRange(uint32_t min, uint32_t max)
Generate a random value in the specified range.
Definition: net.c:356
error_t netStartInterface(NetInterface *interface)
Start network interface.
Definition: net.c:1331
error_t netSetExtIntDriver(NetInterface *interface, const ExtIntDriver *driver)
Set external interrupt line driver.
Definition: net.c:966
error_t netSetLinkState(NetInterface *interface, NicLinkState linkState)
Set administrative link state.
Definition: net.c:991
MacAddr macAddr
Link-layer address.
Definition: net.h:220
error_t netSetInterfaceName(NetInterface *interface, const char_t *name)
Set interface name.
Definition: net.c:578
int bool_t
Definition: compiler_port.h:48
error_t netSetUartDriver(NetInterface *interface, const UartDriver *driver)
Set UART driver.
Definition: net.c:941
DhcpServerContext * dhcpServerContext
DHCP server context.
Definition: net.h:264
uint_t netGetLinkSpeed(NetInterface *interface)
Get link speed.
Definition: net.c:1054
DHCP client (Dynamic Host Configuration Protocol)
uint16_t vlanId
error_t netGetEui64(NetInterface *interface, Eui64 *eui64)
Retrieve EUI-64 interface identifier.
Definition: net.c:521
NdpContext ndpContext
NDP context.
Definition: net.h:271
Eui64 eui64
EUI-64 interface identifier.
Definition: net.h:198
uint8_t data[]
Definition: ethernet.h:220
bool_t running
The TCP/IP stack is currently running.
Definition: net.h:306
error_t netGetMacAddr(NetInterface *interface, MacAddr *macAddr)
Retrieve MAC address.
Definition: net.c:459
MdnsResponderContext * mdnsResponderContext
mDNS responder context
Definition: net.h:285
systime_t timestamp
Definition: net.h:313
error_t netSetParentInterface(NetInterface *interface, NetInterface *physicalInterface)
Attach a virtual interface to a given physical interface.
Definition: net.c:705
error_t netSetSpiDriver(NetInterface *interface, const SpiDriver *driver)
Set SPI driver.
Definition: net.c:916
Memory management.
uint16_t vlanId
VLAN identifier (802.1Q)
Definition: net.h:226
const UartDriver * uartDriver
Underlying UART driver.
Definition: net.h:203
uint8_t nicContext[NIC_CONTEXT_SIZE]
Driver specific context.
Definition: net.h:205
#define MAC_ADDR_FILTER_SIZE
Definition: ethernet.h:95
Ethernet PHY driver.
Definition: nic.h:306
UART driver.
Definition: nic.h:379
void netGetRandData(uint8_t *data, size_t length)
Get a string of random data.
Definition: net.c:386
Event object.
uint32_t entropy
Definition: net.h:312
OsMutex mutex
Mutex preventing simultaneous access to the TCP/IP stack.
Definition: net.h:304
External interrupt line driver.
Definition: nic.h:392
#define AutoIpContext
Definition: auto_ip.h:139
error_t netSetSwitchDriver(NetInterface *interface, const SwitchDriver *driver)
Set Ethernet switch driver.
Definition: net.c:826
char_t name[NET_MAX_IF_NAME_LEN+1]
A unique name identifying the interface.
Definition: net.h:199
SMI driver.
Definition: nic.h:352
error_t netStopInterface(NetInterface *interface)
Stop network interface.
Definition: net.c:1411
#define NET_INTERFACE_COUNT
Definition: net.h:113
Legacy definitions.
IGMP snooping switch.
char_t name[]
DhcpClientContext * dhcpClientContext
DHCP client context.
Definition: net.h:261
SPI driver.
Definition: nic.h:364
SlaacContext * slaacContext
SLAAC context.
Definition: net.h:277
error_t netSetInterfaceId(NetInterface *interface, uint32_t id)
Set interface identifier.
Definition: net.c:553
#define NET_TASK_STACK_SIZE
Definition: net.h:162
NetContext netContext
Definition: net.c:75
error_t netSetMacAddr(NetInterface *interface, const MacAddr *macAddr)
Set MAC address.
Definition: net.c:424
Pseudo-random number generator state.
Definition: net_misc.h:184
#define PppContext
Definition: ppp.h:38
IPv6 Stateless Address Autoconfiguration.
IPv6 context.
Definition: ipv6.h:459
IPv4 context.
Definition: ipv4.h:339
Ethernet.
#define NET_MAX_LINK_CHANGE_CALLBACKS
Definition: net.h:127
#define DhcpClientContext
Definition: dhcp_client.h:126
Router advertisement service.
Definitions common to mDNS client and mDNS responder.
IGMP router.
bool_t phyEvent
A PHY event is pending.
Definition: net.h:217
DNS-SD (DNS-Based Service Discovery)
ArpCacheEntry arpCache[ARP_CACHE_SIZE]
ARP cache.
Definition: net.h:246
error_t netSetVmanId(NetInterface *interface, uint16_t vmanId)
Specify VMAN identifier (802.1ad)
Definition: net.c:670
IgmpRouterContext * igmpRouterContext
IGMP router context.
Definition: net.h:252
IGMP host context.
Definition: igmp_host.h:68
bool_t netGetLinkState(NetInterface *interface)
Get link state.
Definition: net.c:1023
__start_packed struct @0 MacAddr
MAC address.
#define ARP_CACHE_SIZE
Definition: arp.h:46
OsTaskTcb taskTcb
Task control block.
Definition: net.h:309
error_t netSetPhyAddr(NetInterface *interface, uint8_t phyAddr)
Specify Ethernet PHY address.
Definition: net.c:792
error_t netSetHostname(NetInterface *interface, const char_t *name)
Set host name.
Definition: net.c:607
void(* LlcRxCallback)(NetInterface *interface, EthHeader *header, const uint8_t *data, size_t length, NetRxAncillary *ancillary, void *param)
LLC frame received callback.
Definition: ethernet.h:270
#define SlaacContext
Definition: slaac.h:50
error_t
Error codes.
Definition: error.h:43
bool_t promiscuous
Promiscuous mode.
Definition: net.h:222
NDP context.
Definition: ndp.h:576
Timer callback entry.
Definition: net_misc.h:92
DHCPv6 client (Dynamic Host Configuration Protocol for IPv6)
error_t netInit(void)
TCP/IP stack initialization.
Definition: net.c:83
NicLinkState
Link state.
Definition: nic.h:95
NetInterface * netGetDefaultInterface(void)
Get default network interface.
Definition: net.c:410
Task control block.
char_t hostname[NET_MAX_HOSTNAME_LEN+1]
Host name.
Definition: net.h:200
IgmpHostContext igmpHostContext
IGMP host context.
Definition: net.h:249
#define NetInterface
Definition: net.h:36
Ipv6Context ipv6Context
IPv6 context.
Definition: net.h:269
OsTaskId taskId
Task identifier.
Definition: net.h:307
uint8_t port
Switch port identifier.
Definition: net.h:236
uint32_t OsStackType
Stack data type.
#define Dhcpv6ClientContext
uint16_t vmanId
VMAN identifier (802.1ad)
Definition: net.h:229
TCP/IP stack context.
Definition: net.h:303
LlcRxCallback llcRxCallback
LLC frame received callback (802.2)
Definition: net.h:232
Error codes description.
uint_t index
Zero-based index.
Definition: net.h:196
const SwitchDriver * switchDriver
Ethernet switch driver.
Definition: net.h:218
IGMP host.
Byte order conversion.
NicLinkState adminLinkState
Administrative link state.
Definition: net.h:208
#define NIC_CONTEXT_SIZE
Definition: nic.h:53
NDP (Neighbor Discovery Protocol)
DNS client (Domain Name System)
Mutex object.
error_t netSetSmiDriver(NetInterface *interface, const SmiDriver *driver)
Set SMI driver.
Definition: net.c:886
uint32_t systime_t
System time.
uint16_t port
Definition: dns_common.h:251
NdpRouterAdvContext * ndpRouterAdvContext
RA service context.
Definition: net.h:274
#define NET_MAX_TIMER_CALLBACKS
Definition: net.h:134
error_t netSetVlanId(NetInterface *interface, uint16_t vlanId)
Specify VLAN identifier (802.1Q)
Definition: net.c:636
error_t netSetPhyDriver(NetInterface *interface, const PhyDriver *driver)
Set Ethernet PHY driver.
Definition: net.c:762
RA service context.
uint32_t netGetRand(void)
Generate a random 32-bit value.
Definition: net.c:325
char char_t
Definition: compiler_port.h:43
AutoIpContext * autoIpContext
Auto-IP context.
Definition: net.h:258
error_t netSetDriver(NetInterface *interface, const NicDriver *driver)
Set Ethernet MAC driver.
Definition: net.c:737
const ExtIntDriver * extIntDriver
External interrupt line driver.
Definition: net.h:204
bool_t linkState
Link state.
Definition: net.h:209
uint32_t linkSpeed
Link speed.
Definition: net.h:210
IPv4 fragmentation and reassembly.
Ethernet switch driver.
Definition: nic.h:320
#define NET_MAX_IF_NAME_LEN
Definition: net.h:141
MAC filter table entry.
Definition: ethernet.h:258
PppContext * pppContext
DNS-SD context.
Definition: net.h:293
Link change callback entry.
Definition: net_misc.h:73
NicDuplexMode
Duplex mode.
Definition: nic.h:120
Network interface controller abstraction layer.
const SpiDriver * spiDriver
Underlying SPI driver.
Definition: net.h:202
uint8_t phyAddr
PHY address.
Definition: net.h:216
OsEvent nicTxEvent
Network controller TX event.
Definition: net.h:206
ARP cache entry.
Definition: arp.h:185
DHCP server context.
Definition: dhcp_server.h:118
void netTask(void)
TCP/IP events handling.
Definition: net.c:1467
PPP (Point-to-Point Protocol)
bool_t acceptAllMulticast
Accept all frames with a multicast destination address.
Definition: net.h:223
#define IgmpRouterContext
Definition: igmp_router.h:47
IgmpSnoopingContext * igmpSnoopingContext
IGMP snooping switch context.
Definition: net.h:255
void * llcRxParam
Callback parameter.
Definition: net.h:233
NetRandState randState
Pseudo-random number generator state.
Definition: net.h:315
error_t netSetSwitchPort(NetInterface *interface, uint8_t port)
Specify switch port.
Definition: net.c:856
Dhcpv6ClientContext * dhcpv6ClientContext
DHCPv6 client context.
Definition: net.h:280
#define NET_RAND_SEED_SIZE
Definition: net.h:155
Ipv4Context ipv4Context
IPv4 context.
Definition: net.h:244
error_t netEnablePromiscuousMode(NetInterface *interface, bool_t enable)
Enable promiscuous mode.
Definition: net.c:1117
const PhyDriver * phyDriver
Ethernet PHY driver.
Definition: net.h:215
error_t netConfigInterface(NetInterface *interface)
Configure network interface.
Definition: net.c:1143
IPv4 (Internet Protocol Version 4)
thread_t * OsTaskId
Task identifier.
NicDuplexMode duplexMode
Duplex mode.
Definition: net.h:211
const SmiDriver * smiDriver
SMI driver.
Definition: net.h:219
IGMP snooping switch context.
unsigned int uint_t
Definition: compiler_port.h:45
uint32_t id
A unique number identifying the interface.
Definition: net.h:197
bool_t nicEvent
A NIC event is pending.
Definition: net.h:207
NicDuplexMode netGetDuplexMode(NetInterface *interface)
Get duplex mode.
Definition: net.c:1085
bool_t configured
Configuration done.
Definition: net.h:212
NIC driver.
Definition: nic.h:281
#define DnsSdContext
Definition: dns_sd.h:90
OsEvent event
Event object to receive notifications from drivers.
Definition: net.h:305
RTOS abstraction layer.
DHCP server (Dynamic Host Configuration Protocol)
ARP (Address Resolution Protocol)
DnsSdContext * dnsSdContext
Definition: net.h:289
Helper functions for TCP/IP stack.
NetInterface * parent
Interface on top of which the virtual interface runs.
Definition: net.h:240
#define NET_MAX_HOSTNAME_LEN
Definition: net.h:148
Structure describing a network interface.
Definition: net.h:195
mDNS responder (Multicast DNS)
error_t netSeedRand(const uint8_t *seed, size_t length)
Seed the pseudo-random number generator.
Definition: net.c:278
Auto-IP (Dynamic Configuration of IPv4 Link-Local Addresses)
MacFilterEntry macAddrFilter[MAC_ADDR_FILTER_SIZE]
MAC filter table.
Definition: net.h:221