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