xref: /dragonfly/sys/net/if_arp.h (revision c37c9ab3)
1 /*
2  * Copyright (c) 1986, 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  * 3. 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_arp.h	8.1 (Berkeley) 6/10/93
30  * $FreeBSD: src/sys/net/if_arp.h,v 1.14.2.3 2002/02/20 23:34:09 fjoe Exp $
31  * $DragonFly: src/sys/net/if_arp.h,v 1.9 2008/11/24 12:19:14 hasso Exp $
32  */
33 
34 #ifndef _NET_IF_ARP_H_
35 #define	_NET_IF_ARP_H_
36 
37 #ifndef _SYS_TYPES_H_
38 #include <sys/types.h>
39 #endif
40 #ifndef _SYS_SOCKET_H_
41 #include <sys/socket.h>
42 #endif
43 
44 /*
45  * Address Resolution Protocol.
46  *
47  * See RFC 826 for protocol description.  ARP packets are variable
48  * in size; the arphdr structure defines the fixed-length portion.
49  * Protocol type values are the same as those for 10 Mb/s Ethernet.
50  * It is followed by the variable-sized fields ar_sha, arp_spa,
51  * arp_tha and arp_tpa in that order, according to the lengths
52  * specified.  Field names used correspond to RFC 826.
53  */
54 struct	arphdr {
55 	u_short	ar_hrd;		/* format of hardware address */
56 #define ARPHRD_ETHER	1	/* ethernet hardware format */
57 #define ARPHRD_IEEE802	6	/* token-ring hardware format */
58 #define ARPHRD_ARCNET	7	/* arcnet hardware format */
59 #define ARPHRD_FRELAY	15	/* frame relay hardware format */
60 #define ARPHRD_IEEE1394	24	/* firewire hardware format */
61 	u_short	ar_pro;		/* format of protocol address */
62 	u_char	ar_hln;		/* length of hardware address */
63 	u_char	ar_pln;		/* length of protocol address */
64 	u_short	ar_op;		/* one of: */
65 #define	ARPOP_REQUEST	1	/* request to resolve address */
66 #define	ARPOP_REPLY	2	/* response to previous request */
67 #define	ARPOP_REVREQUEST 3	/* request protocol address given hardware */
68 #define	ARPOP_REVREPLY	4	/* response giving protocol address */
69 #define ARPOP_INVREQUEST 8	/* request to identify peer */
70 #define ARPOP_INVREPLY	9	/* response identifying peer */
71 /*
72  * The remaining fields are variable in size,
73  * according to the sizes above.
74  */
75 #ifdef COMMENT_ONLY
76 	u_char	ar_sha[];	/* sender hardware address */
77 	u_char	ar_spa[];	/* sender protocol address */
78 	u_char	ar_tha[];	/* target hardware address */
79 	u_char	ar_tpa[];	/* target protocol address */
80 #endif
81 };
82 
83 #define ar_sha(ap)	(((caddr_t)((ap)+1)) +   0)
84 #define ar_spa(ap)	(((caddr_t)((ap)+1)) +   (ap)->ar_hln)
85 #define ar_tha(ap)	(((caddr_t)((ap)+1)) +   (ap)->ar_hln + (ap)->ar_pln)
86 #define ar_tpa(ap)	(((caddr_t)((ap)+1)) + 2*(ap)->ar_hln + (ap)->ar_pln)
87 
88 #define arphdr_len2(ar_hln, ar_pln)					\
89 	(sizeof(struct arphdr) + 2*(ar_hln) + 2*(ar_pln))
90 #define arphdr_len(ap)	(arphdr_len2((ap)->ar_hln, (ap)->ar_pln))
91 
92 /*
93  * ARP ioctl request
94  */
95 struct arpreq {
96 	struct	sockaddr arp_pa;		/* protocol address */
97 	struct	sockaddr arp_ha;		/* hardware address */
98 	int	arp_flags;			/* flags */
99 };
100 /*  arp_flags and at_flags field values */
101 #define	ATF_INUSE	0x01	/* entry in use */
102 #define ATF_COM		0x02	/* completed entry (enaddr valid) */
103 #define	ATF_PERM	0x04	/* permanent entry */
104 #define	ATF_PUBL	0x08	/* publish entry (respond for other host) */
105 #define	ATF_USETRAILERS	0x10	/* has requested trailers */
106 
107 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
108 #ifndef _NET_IF_VAR_H_
109 #include <net/if_var.h>
110 #endif
111 
112 /*
113  * Structure shared between the ethernet driver modules and
114  * the address resolution code.  For example, each ec_softc or il_softc
115  * begins with this structure.
116  */
117 struct	arpcom {
118 	/*
119 	 * The ifnet struct _must_ be at the head of this structure.
120 	 */
121 	struct	ifnet ac_if;		/* network-visible interface */
122 	u_char	ac_enaddr[6];		/* ethernet hardware address */
123 	int	ac_multicnt;		/* length of ac_multiaddrs list */
124 	void	*ac_netgraph;		/* ng_ether(4) netgraph node info */
125 };
126 
127 #endif
128 
129 #endif /* !_NET_IF_ARP_H_ */
130