1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1982, 1986, 1989, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 *	@(#)if.h	8.1 (Berkeley) 6/10/93
32 * $FreeBSD$
33 */
34
35#ifndef _NET_IF_H_
36#define	_NET_IF_H_
37
38#include <sys/cdefs.h>
39
40#if __BSD_VISIBLE
41/*
42 * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
43 * helps userland compatibility.  (struct timeval ifi_lastchange)
44 * The same holds for <sys/socket.h>.  (struct sockaddr ifru_addr)
45 */
46#ifndef _KERNEL
47#include <sys/time.h>
48#include <sys/socket.h>
49#endif
50#endif
51
52/*
53 * Length of interface external name, including terminating '\0'.
54 * Note: this is the same size as a generic device's external name.
55 */
56#define		IF_NAMESIZE	16
57#if __BSD_VISIBLE
58#define		IFNAMSIZ	IF_NAMESIZE
59#define		IF_MAXUNIT	0x7fff	/* historical value */
60#endif
61#if __BSD_VISIBLE
62
63/*
64 * Structure used to query names of interface cloners.
65 */
66
67struct if_clonereq {
68	int	ifcr_total;		/* total cloners (out) */
69	int	ifcr_count;		/* room for this many in user buffer */
70	char	*ifcr_buffer;		/* buffer for cloner names */
71};
72
73/*
74 * Structure describing information about an interface
75 * which may be of interest to management entities.
76 */
77struct if_data {
78	/* generic interface information */
79	uint8_t	ifi_type;		/* ethernet, tokenring, etc */
80	uint8_t	ifi_physical;		/* e.g., AUI, Thinnet, 10base-T, etc */
81	uint8_t	ifi_addrlen;		/* media address length */
82	uint8_t	ifi_hdrlen;		/* media header length */
83	uint8_t	ifi_link_state;		/* current link state */
84	uint8_t	ifi_vhid;		/* carp vhid */
85	uint16_t	ifi_datalen;	/* length of this data struct */
86	uint32_t	ifi_mtu;	/* maximum transmission unit */
87	uint32_t	ifi_metric;	/* routing metric (external only) */
88	uint64_t	ifi_baudrate;	/* linespeed */
89	/* volatile statistics */
90	uint64_t	ifi_ipackets;	/* packets received on interface */
91	uint64_t	ifi_ierrors;	/* input errors on interface */
92	uint64_t	ifi_opackets;	/* packets sent on interface */
93	uint64_t	ifi_oerrors;	/* output errors on interface */
94	uint64_t	ifi_collisions;	/* collisions on csma interfaces */
95	uint64_t	ifi_ibytes;	/* total number of octets received */
96	uint64_t	ifi_obytes;	/* total number of octets sent */
97	uint64_t	ifi_imcasts;	/* packets received via multicast */
98	uint64_t	ifi_omcasts;	/* packets sent via multicast */
99	uint64_t	ifi_iqdrops;	/* dropped on input */
100	uint64_t	ifi_oqdrops;	/* dropped on output */
101	uint64_t	ifi_noproto;	/* destined for unsupported protocol */
102	uint64_t	ifi_hwassist;	/* HW offload capabilities, see IFCAP */
103
104	/* Unions are here to make sizes MI. */
105	union {				/* uptime at attach or stat reset */
106		time_t		tt;
107		uint64_t	ph;
108	} __ifi_epoch;
109#define	ifi_epoch	__ifi_epoch.tt
110	union {				/* time of last administrative change */
111		struct timeval	tv;
112		struct {
113			uint64_t ph1;
114			uint64_t ph2;
115		} ph;
116	} __ifi_lastchange;
117#define	ifi_lastchange	__ifi_lastchange.tv
118};
119
120/*-
121 * Interface flags are of two types: network stack owned flags, and driver
122 * owned flags.  Historically, these values were stored in the same ifnet
123 * flags field, but with the advent of fine-grained locking, they have been
124 * broken out such that the network stack is responsible for synchronizing
125 * the stack-owned fields, and the device driver the device-owned fields.
126 * Both halves can perform lockless reads of the other half's field, subject
127 * to accepting the involved races.
128 *
129 * Both sets of flags come from the same number space, and should not be
130 * permitted to conflict, as they are exposed to user space via a single
131 * field.
132 *
133 * The following symbols identify read and write requirements for fields:
134 *
135 * (i) if_flags field set by device driver before attach, read-only there
136 *     after.
137 * (n) if_flags field written only by the network stack, read by either the
138 *     stack or driver.
139 * (d) if_drv_flags field written only by the device driver, read by either
140 *     the stack or driver.
141 */
142#define	IFF_UP		0x1		/* (n) interface is up */
143#define	IFF_BROADCAST	0x2		/* (i) broadcast address valid */
144#define	IFF_DEBUG	0x4		/* (n) turn on debugging */
145#define	IFF_LOOPBACK	0x8		/* (i) is a loopback net */
146#define	IFF_POINTOPOINT	0x10		/* (i) is a point-to-point link */
147#define	IFF_KNOWSEPOCH	0x20		/* (i) calls if_input in net epoch */
148#define	IFF_DRV_RUNNING	0x40		/* (d) resources allocated */
149#define	IFF_NOARP	0x80		/* (n) no address resolution protocol */
150#define	IFF_PROMISC	0x100		/* (n) receive all packets */
151#define	IFF_ALLMULTI	0x200		/* (n) receive all multicast packets */
152#define	IFF_DRV_OACTIVE	0x400		/* (d) tx hardware queue is full */
153#define	IFF_SIMPLEX	0x800		/* (i) can't hear own transmissions */
154#define	IFF_LINK0	0x1000		/* per link layer defined bit */
155#define	IFF_LINK1	0x2000		/* per link layer defined bit */
156#define	IFF_LINK2	0x4000		/* per link layer defined bit */
157#define	IFF_ALTPHYS	IFF_LINK2	/* use alternate physical connection */
158#define	IFF_MULTICAST	0x8000		/* (i) supports multicast */
159#define	IFF_CANTCONFIG	0x10000		/* (i) unconfigurable using ioctl(2) */
160#define	IFF_PPROMISC	0x20000		/* (n) user-requested promisc mode */
161#define	IFF_MONITOR	0x40000		/* (n) user-requested monitor mode */
162#define	IFF_STATICARP	0x80000		/* (n) static ARP */
163#define	IFF_DYING	0x200000	/* (n) interface is winding down */
164#define	IFF_RENAMING	0x400000	/* (n) interface is being renamed */
165#define	IFF_NOGROUP	0x800000	/* (n) interface is not part of any groups */
166
167/*
168 * Old names for driver flags so that user space tools can continue to use
169 * the old (portable) names.
170 */
171#ifndef _KERNEL
172#define	IFF_RUNNING	IFF_DRV_RUNNING
173#define	IFF_OACTIVE	IFF_DRV_OACTIVE
174#endif
175
176/* flags set internally only: */
177#define	IFF_CANTCHANGE \
178	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
179	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC|\
180	    IFF_DYING|IFF_CANTCONFIG|IFF_KNOWSEPOCH)
181
182/*
183 * Values for if_link_state.
184 */
185#define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
186#define	LINK_STATE_DOWN		1	/* link is down */
187#define	LINK_STATE_UP		2	/* link is up */
188
189/*
190 * Some convenience macros used for setting ifi_baudrate.
191 * XXX 1000 vs. 1024? --thorpej@netbsd.org
192 */
193#define	IF_Kbps(x)	((uintmax_t)(x) * 1000)	/* kilobits/sec. */
194#define	IF_Mbps(x)	(IF_Kbps((x) * 1000))	/* megabits/sec. */
195#define	IF_Gbps(x)	(IF_Mbps((x) * 1000))	/* gigabits/sec. */
196
197/*
198 * Capabilities that interfaces can advertise.
199 *
200 * struct ifnet.if_capabilities
201 *   contains the optional features & capabilities a particular interface
202 *   supports (not only the driver but also the detected hw revision).
203 *   Capabilities are defined by IFCAP_* below.
204 * struct ifnet.if_capenable
205 *   contains the enabled (either by default or through ifconfig) optional
206 *   features & capabilities on this interface.
207 *   Capabilities are defined by IFCAP_* below.
208 * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above
209 *   contains the enabled optional feature & capabilites that can be used
210 *   individually per packet and are specified in the mbuf pkthdr.csum_flags
211 *   field.  IFCAP_* and CSUM_* do not match one to one and CSUM_* may be
212 *   more detailed or differentiated than IFCAP_*.
213 *   Hwassist features are defined CSUM_* in sys/mbuf.h
214 *
215 * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl
216 * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE.
217 * This is not strictly necessary because the common code never
218 * changes capabilities, and it is left to the individual driver
219 * to do the right thing. However, having the filter here
220 * avoids replication of the same code in all individual drivers.
221 */
222#define	IFCAP_RXCSUM		0x00001  /* can offload checksum on RX */
223#define	IFCAP_TXCSUM		0x00002  /* can offload checksum on TX */
224#define	IFCAP_NETCONS		0x00004  /* can be a network console */
225#define	IFCAP_VLAN_MTU		0x00008	/* VLAN-compatible MTU */
226#define	IFCAP_VLAN_HWTAGGING	0x00010	/* hardware VLAN tag support */
227#define	IFCAP_JUMBO_MTU		0x00020	/* 9000 byte MTU supported */
228#define	IFCAP_POLLING		0x00040	/* driver supports polling */
229#define	IFCAP_VLAN_HWCSUM	0x00080	/* can do IFCAP_HWCSUM on VLANs */
230#define	IFCAP_TSO4		0x00100	/* can do TCP Segmentation Offload */
231#define	IFCAP_TSO6		0x00200	/* can do TCP6 Segmentation Offload */
232#define	IFCAP_LRO		0x00400	/* can do Large Receive Offload */
233#define	IFCAP_WOL_UCAST		0x00800	/* wake on any unicast frame */
234#define	IFCAP_WOL_MCAST		0x01000	/* wake on any multicast frame */
235#define	IFCAP_WOL_MAGIC		0x02000	/* wake on any Magic Packet */
236#define	IFCAP_TOE4		0x04000	/* interface can offload TCP */
237#define	IFCAP_TOE6		0x08000	/* interface can offload TCP6 */
238#define	IFCAP_VLAN_HWFILTER	0x10000 /* interface hw can filter vlan tag */
239/* 	available		0x20000 */
240#define	IFCAP_VLAN_HWTSO	0x40000 /* can do IFCAP_TSO on VLANs */
241#define	IFCAP_LINKSTATE		0x80000 /* the runtime link state is dynamic */
242#define	IFCAP_NETMAP		0x100000 /* netmap mode supported/enabled */
243#define	IFCAP_RXCSUM_IPV6	0x200000  /* can offload checksum on IPv6 RX */
244#define	IFCAP_TXCSUM_IPV6	0x400000  /* can offload checksum on IPv6 TX */
245#define	IFCAP_HWSTATS		0x800000 /* manages counters internally */
246#define	IFCAP_TXRTLMT		0x1000000 /* hardware supports TX rate limiting */
247#define	IFCAP_HWRXTSTMP		0x2000000 /* hardware rx timestamping */
248#define	IFCAP_NOMAP		0x4000000 /* can TX unmapped mbufs */
249#define	IFCAP_TXTLS4		0x8000000 /* can do TLS encryption and segmentation for TCP */
250#define	IFCAP_TXTLS6		0x10000000 /* can do TLS encryption and segmentation for TCP6 */
251#define	IFCAP_VXLAN_HWCSUM	0x20000000 /* can do IFCAN_HWCSUM on VXLANs */
252#define	IFCAP_VXLAN_HWTSO	0x40000000 /* can do IFCAP_TSO on VXLANs */
253
254#define IFCAP_HWCSUM_IPV6	(IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6)
255
256#define IFCAP_HWCSUM	(IFCAP_RXCSUM | IFCAP_TXCSUM)
257#define	IFCAP_TSO	(IFCAP_TSO4 | IFCAP_TSO6)
258#define	IFCAP_WOL	(IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
259#define	IFCAP_TOE	(IFCAP_TOE4 | IFCAP_TOE6)
260#define	IFCAP_TXTLS	(IFCAP_TXTLS4 | IFCAP_TXTLS6)
261
262#define	IFCAP_CANTCHANGE	(IFCAP_NETMAP)
263
264#define	IFQ_MAXLEN	50
265#define	IFNET_SLOWHZ	1		/* granularity is 1 second */
266
267/*
268 * Message format for use in obtaining information about interfaces
269 * from getkerninfo and the routing socket
270 * For the new, extensible interface see struct if_msghdrl below.
271 */
272struct if_msghdr {
273	u_short	ifm_msglen;	/* to skip over non-understood messages */
274	u_char	ifm_version;	/* future binary compatibility */
275	u_char	ifm_type;	/* message type */
276	int	ifm_addrs;	/* like rtm_addrs */
277	int	ifm_flags;	/* value of if_flags */
278	u_short	ifm_index;	/* index for associated ifp */
279	u_short	_ifm_spare1;
280	struct	if_data ifm_data;/* statistics and other data about if */
281};
282
283/*
284 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL.  It is
285 * extensible after ifm_data_off or within ifm_data.  Both the if_msghdr and
286 * if_data now have a member field detailing the struct length in addition to
287 * the routing message length.  Macros are provided to find the start of
288 * ifm_data and the start of the socket address strucutres immediately following
289 * struct if_msghdrl given a pointer to struct if_msghdrl.
290 */
291#define	IF_MSGHDRL_IFM_DATA(_l) \
292    (struct if_data *)((char *)(_l) + (_l)->ifm_data_off)
293#define	IF_MSGHDRL_RTA(_l) \
294    (void *)((uintptr_t)(_l) + (_l)->ifm_len)
295struct if_msghdrl {
296	u_short	ifm_msglen;	/* to skip over non-understood messages */
297	u_char	ifm_version;	/* future binary compatibility */
298	u_char	ifm_type;	/* message type */
299	int	ifm_addrs;	/* like rtm_addrs */
300	int	ifm_flags;	/* value of if_flags */
301	u_short	ifm_index;	/* index for associated ifp */
302	u_short _ifm_spare1;	/* spare space to grow if_index, see if_var.h */
303	u_short	ifm_len;	/* length of if_msghdrl incl. if_data */
304	u_short	ifm_data_off;	/* offset of if_data from beginning */
305	int	_ifm_spare2;
306	struct	if_data ifm_data;/* statistics and other data about if */
307};
308
309/*
310 * Message format for use in obtaining information about interface addresses
311 * from getkerninfo and the routing socket
312 * For the new, extensible interface see struct ifa_msghdrl below.
313 */
314struct ifa_msghdr {
315	u_short	ifam_msglen;	/* to skip over non-understood messages */
316	u_char	ifam_version;	/* future binary compatibility */
317	u_char	ifam_type;	/* message type */
318	int	ifam_addrs;	/* like rtm_addrs */
319	int	ifam_flags;	/* value of ifa_flags */
320	u_short	ifam_index;	/* index for associated ifp */
321	u_short	_ifam_spare1;
322	int	ifam_metric;	/* value of ifa_ifp->if_metric */
323};
324
325/*
326 * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL.  It is
327 * extensible after ifam_metric or within ifam_data.  Both the ifa_msghdrl and
328 * if_data now have a member field detailing the struct length in addition to
329 * the routing message length.  Macros are provided to find the start of
330 * ifm_data and the start of the socket address strucutres immediately following
331 * struct ifa_msghdrl given a pointer to struct ifa_msghdrl.
332 */
333#define	IFA_MSGHDRL_IFAM_DATA(_l) \
334    (struct if_data *)((char *)(_l) + (_l)->ifam_data_off)
335#define	IFA_MSGHDRL_RTA(_l) \
336    (void *)((uintptr_t)(_l) + (_l)->ifam_len)
337struct ifa_msghdrl {
338	u_short	ifam_msglen;	/* to skip over non-understood messages */
339	u_char	ifam_version;	/* future binary compatibility */
340	u_char	ifam_type;	/* message type */
341	int	ifam_addrs;	/* like rtm_addrs */
342	int	ifam_flags;	/* value of ifa_flags */
343	u_short	ifam_index;	/* index for associated ifp */
344	u_short _ifam_spare1;	/* spare space to grow if_index, see if_var.h */
345	u_short	ifam_len;	/* length of ifa_msghdrl incl. if_data */
346	u_short	ifam_data_off;	/* offset of if_data from beginning */
347	int	ifam_metric;	/* value of ifa_ifp->if_metric */
348	struct	if_data ifam_data;/* statistics and other data about if or
349				 * address */
350};
351
352/*
353 * Message format for use in obtaining information about multicast addresses
354 * from the routing socket
355 */
356struct ifma_msghdr {
357	u_short	ifmam_msglen;	/* to skip over non-understood messages */
358	u_char	ifmam_version;	/* future binary compatibility */
359	u_char	ifmam_type;	/* message type */
360	int	ifmam_addrs;	/* like rtm_addrs */
361	int	ifmam_flags;	/* value of ifa_flags */
362	u_short	ifmam_index;	/* index for associated ifp */
363	u_short	_ifmam_spare1;
364};
365
366/*
367 * Message format announcing the arrival or departure of a network interface.
368 */
369struct if_announcemsghdr {
370	u_short	ifan_msglen;	/* to skip over non-understood messages */
371	u_char	ifan_version;	/* future binary compatibility */
372	u_char	ifan_type;	/* message type */
373	u_short	ifan_index;	/* index for associated ifp */
374	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
375	u_short	ifan_what;	/* what type of announcement */
376};
377
378#define	IFAN_ARRIVAL	0	/* interface arrival */
379#define	IFAN_DEPARTURE	1	/* interface departure */
380
381/*
382 * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests
383 */
384struct ifreq_buffer {
385	size_t	length;
386	void	*buffer;
387};
388
389/*
390 * Interface request structure used for socket
391 * ioctl's.  All interface ioctl's must have parameter
392 * definitions which begin with ifr_name.  The
393 * remainder may be interface specific.
394 */
395struct	ifreq {
396	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
397	union {
398		struct	sockaddr ifru_addr;
399		struct	sockaddr ifru_dstaddr;
400		struct	sockaddr ifru_broadaddr;
401		struct	ifreq_buffer ifru_buffer;
402		short	ifru_flags[2];
403		short	ifru_index;
404		int	ifru_jid;
405		int	ifru_metric;
406		int	ifru_mtu;
407		int	ifru_phys;
408		int	ifru_media;
409		caddr_t	ifru_data;
410		int	ifru_cap[2];
411		u_int	ifru_fib;
412		u_char	ifru_vlan_pcp;
413	} ifr_ifru;
414#define	ifr_addr	ifr_ifru.ifru_addr	/* address */
415#define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
416#define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
417#ifndef _KERNEL
418#define	ifr_buffer	ifr_ifru.ifru_buffer	/* user supplied buffer with its length */
419#endif
420#define	ifr_flags	ifr_ifru.ifru_flags[0]	/* flags (low 16 bits) */
421#define	ifr_flagshigh	ifr_ifru.ifru_flags[1]	/* flags (high 16 bits) */
422#define	ifr_jid		ifr_ifru.ifru_jid	/* jail/vnet */
423#define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
424#define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
425#define ifr_phys	ifr_ifru.ifru_phys	/* physical wire */
426#define ifr_media	ifr_ifru.ifru_media	/* physical media */
427#ifndef _KERNEL
428#define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
429#endif
430#define	ifr_reqcap	ifr_ifru.ifru_cap[0]	/* requested capabilities */
431#define	ifr_curcap	ifr_ifru.ifru_cap[1]	/* current capabilities */
432#define	ifr_index	ifr_ifru.ifru_index	/* interface index */
433#define	ifr_fib		ifr_ifru.ifru_fib	/* interface fib */
434#define	ifr_vlan_pcp	ifr_ifru.ifru_vlan_pcp	/* VLAN priority */
435#define	ifr_lan_pcp	ifr_ifru.ifru_vlan_pcp	/* VLAN priority */
436};
437
438#define	_SIZEOF_ADDR_IFREQ(ifr) \
439	((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
440	 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
441	  (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
442
443struct ifaliasreq {
444	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
445	struct	sockaddr ifra_addr;
446	struct	sockaddr ifra_broadaddr;
447	struct	sockaddr ifra_mask;
448	int	ifra_vhid;
449};
450
451/* 9.x compat */
452struct oifaliasreq {
453	char	ifra_name[IFNAMSIZ];
454	struct	sockaddr ifra_addr;
455	struct	sockaddr ifra_broadaddr;
456	struct	sockaddr ifra_mask;
457};
458
459struct ifmediareq {
460	char	ifm_name[IFNAMSIZ];	/* if name, e.g. "en0" */
461	int	ifm_current;		/* current media options */
462	int	ifm_mask;		/* don't care mask */
463	int	ifm_status;		/* media status */
464	int	ifm_active;		/* active options */
465	int	ifm_count;		/* # entries in ifm_ulist array */
466	int	*ifm_ulist;		/* media words */
467};
468
469struct  ifdrv {
470	char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
471	unsigned long   ifd_cmd;
472	size_t          ifd_len;
473	void            *ifd_data;
474};
475
476/*
477 * Structure used to retrieve aux status data from interfaces.
478 * Kernel suppliers to this interface should respect the formatting
479 * needed by ifconfig(8): each line starts with a TAB and ends with
480 * a newline.  The canonical example to copy and paste is in if_tun.c.
481 */
482
483#define	IFSTATMAX	800		/* 10 lines of text */
484struct ifstat {
485	char	ifs_name[IFNAMSIZ];	/* if name, e.g. "en0" */
486	char	ascii[IFSTATMAX + 1];
487};
488
489/*
490 * Structure used in SIOCGIFCONF request.
491 * Used to retrieve interface configuration
492 * for machine (useful for programs which
493 * must know all networks accessible).
494 */
495struct	ifconf {
496	int	ifc_len;		/* size of associated buffer */
497	union {
498		caddr_t	ifcu_buf;
499		struct	ifreq *ifcu_req;
500	} ifc_ifcu;
501#define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
502#define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
503};
504
505/*
506 * interface groups
507 */
508
509#define	IFG_ALL		"all"		/* group contains all interfaces */
510/* XXX: will we implement this? */
511#define	IFG_EGRESS	"egress"	/* if(s) default route(s) point to */
512
513struct ifg_req {
514	union {
515		char			 ifgrqu_group[IFNAMSIZ];
516		char			 ifgrqu_member[IFNAMSIZ];
517	} ifgrq_ifgrqu;
518#define	ifgrq_group	ifgrq_ifgrqu.ifgrqu_group
519#define	ifgrq_member	ifgrq_ifgrqu.ifgrqu_member
520};
521
522/*
523 * Used to lookup groups for an interface
524 */
525struct ifgroupreq {
526	char	ifgr_name[IFNAMSIZ];
527	u_int	ifgr_len;
528	union {
529		char	ifgru_group[IFNAMSIZ];
530		struct	ifg_req *ifgru_groups;
531	} ifgr_ifgru;
532#ifndef _KERNEL
533#define ifgr_group	ifgr_ifgru.ifgru_group
534#define ifgr_groups	ifgr_ifgru.ifgru_groups
535#endif
536};
537
538/*
539 * Structure used to request i2c data
540 * from interface transceivers.
541 */
542struct ifi2creq {
543	uint8_t dev_addr;	/* i2c address (0xA0, 0xA2) */
544	uint8_t offset;		/* read offset */
545	uint8_t len;		/* read length */
546	uint8_t spare0;
547	uint32_t spare1;
548	uint8_t data[8];	/* read buffer */
549};
550
551/*
552 * RSS hash.
553 */
554
555#define	RSS_FUNC_NONE		0		/* RSS disabled */
556#define	RSS_FUNC_PRIVATE	1		/* non-standard */
557#define	RSS_FUNC_TOEPLITZ	2
558
559#define	RSS_TYPE_IPV4		0x00000001
560#define	RSS_TYPE_TCP_IPV4	0x00000002
561#define	RSS_TYPE_IPV6		0x00000004
562#define	RSS_TYPE_IPV6_EX	0x00000008
563#define	RSS_TYPE_TCP_IPV6	0x00000010
564#define	RSS_TYPE_TCP_IPV6_EX	0x00000020
565#define	RSS_TYPE_UDP_IPV4	0x00000040
566#define	RSS_TYPE_UDP_IPV6	0x00000080
567#define	RSS_TYPE_UDP_IPV6_EX	0x00000100
568
569#define	RSS_KEYLEN		128
570
571struct ifrsskey {
572	char		ifrk_name[IFNAMSIZ];	/* if name, e.g. "en0" */
573	uint8_t		ifrk_func;		/* RSS_FUNC_ */
574	uint8_t		ifrk_spare0;
575	uint16_t	ifrk_keylen;
576	uint8_t		ifrk_key[RSS_KEYLEN];
577};
578
579struct ifrsshash {
580	char		ifrh_name[IFNAMSIZ];	/* if name, e.g. "en0" */
581	uint8_t		ifrh_func;		/* RSS_FUNC_ */
582	uint8_t		ifrh_spare0;
583	uint16_t	ifrh_spare1;
584	uint32_t	ifrh_types;		/* RSS_TYPE_ */
585};
586
587#define	IFNET_PCP_NONE	0xff	/* PCP disabled */
588
589#define	IFDR_MSG_SIZE		64
590#define	IFDR_REASON_MSG		1
591#define	IFDR_REASON_VENDOR	2
592struct ifdownreason {
593	char		ifdr_name[IFNAMSIZ];
594	uint32_t	ifdr_reason;
595	uint32_t	ifdr_vendor;
596	char		ifdr_msg[IFDR_MSG_SIZE];
597};
598
599#endif /* __BSD_VISIBLE */
600
601#ifdef _KERNEL
602#ifdef MALLOC_DECLARE
603MALLOC_DECLARE(M_IFADDR);
604MALLOC_DECLARE(M_IFMADDR);
605#endif
606#endif
607
608#ifndef _KERNEL
609struct if_nameindex {
610	unsigned int	if_index;	/* 1, 2, ... */
611	char		*if_name;	/* null terminated name: "le0", ... */
612};
613
614__BEGIN_DECLS
615void			 if_freenameindex(struct if_nameindex *);
616char			*if_indextoname(unsigned int, char *);
617struct if_nameindex	*if_nameindex(void);
618unsigned int		 if_nametoindex(const char *);
619__END_DECLS
620#endif
621#endif /* !_NET_IF_H_ */
622