if_arp.h revision 112469 
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. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)if_arp.h	8.1 (Berkeley) 6/10/93
34 * $FreeBSD: head/sys/net/if_arp.h 112469 2003-03-21 17:53:16Z mdodd $
35 */
36
37#ifndef _NET_IF_ARP_H_
38#define	_NET_IF_ARP_H_
39
40/*
41 * Address Resolution Protocol.
42 *
43 * See RFC 826 for protocol description.  ARP packets are variable
44 * in size; the arphdr structure defines the fixed-length portion.
45 * Protocol type values are the same as those for 10 Mb/s Ethernet.
46 * It is followed by the variable-sized fields ar_sha, arp_spa,
47 * arp_tha and arp_tpa in that order, according to the lengths
48 * specified.  Field names used correspond to RFC 826.
49 */
50struct	arphdr {
51	u_short	ar_hrd;		/* format of hardware address */
52#define ARPHRD_ETHER 	1	/* ethernet hardware format */
53#define ARPHRD_IEEE802	6	/* token-ring hardware format */
54#define ARPHRD_ARCNET	7	/* arcnet hardware format */
55#define ARPHRD_FRELAY 	15	/* frame relay hardware format */
56	u_short	ar_pro;		/* format of protocol address */
57	u_char	ar_hln;		/* length of hardware address */
58	u_char	ar_pln;		/* length of protocol address */
59	u_short	ar_op;		/* one of: */
60#define	ARPOP_REQUEST	1	/* request to resolve address */
61#define	ARPOP_REPLY	2	/* response to previous request */
62#define	ARPOP_REVREQUEST 3	/* request protocol address given hardware */
63#define	ARPOP_REVREPLY	4	/* response giving protocol address */
64#define ARPOP_INVREQUEST 8 	/* request to identify peer */
65#define ARPOP_INVREPLY	9	/* response identifying peer */
66/*
67 * The remaining fields are variable in size,
68 * according to the sizes above.
69 */
70#ifdef COMMENT_ONLY
71	u_char	ar_sha[];	/* sender hardware address */
72	u_char	ar_spa[];	/* sender protocol address */
73	u_char	ar_tha[];	/* target hardware address */
74	u_char	ar_tpa[];	/* target protocol address */
75#endif
76};
77
78#define ar_sha(ap)	(((caddr_t)((ap)+1)) +   0)
79#define ar_spa(ap)	(((caddr_t)((ap)+1)) +   (ap)->ar_hln)
80#define ar_tha(ap)	(((caddr_t)((ap)+1)) +   (ap)->ar_hln + (ap)->ar_pln)
81#define ar_tpa(ap)	(((caddr_t)((ap)+1)) + 2*(ap)->ar_hln + (ap)->ar_pln)
82
83#define arphdr_len2(ar_hln, ar_pln)					\
84	(sizeof(struct arphdr) + 2*(ar_hln) + 2*(ar_pln))
85#define arphdr_len(ap)	(arphdr_len2((ap)->ar_hln, (ap)->ar_pln))
86
87/*
88 * ARP ioctl request
89 */
90struct arpreq {
91	struct	sockaddr arp_pa;		/* protocol address */
92	struct	sockaddr arp_ha;		/* hardware address */
93	int	arp_flags;			/* flags */
94};
95/*  arp_flags and at_flags field values */
96#define	ATF_INUSE	0x01	/* entry in use */
97#define ATF_COM		0x02	/* completed entry (enaddr valid) */
98#define	ATF_PERM	0x04	/* permanent entry */
99#define	ATF_PUBL	0x08	/* publish entry (respond for other host) */
100#define	ATF_USETRAILERS	0x10	/* has requested trailers */
101
102#ifdef _KERNEL
103/*
104 * Structure shared between the ethernet driver modules and
105 * the address resolution code.  For example, each ec_softc or il_softc
106 * begins with this structure.
107 */
108struct	arpcom {
109	/*
110	 * The ifnet struct _must_ be at the head of this structure.
111	 */
112	struct 	ifnet ac_if;		/* network-visible interface */
113	u_char	ac_enaddr[6];		/* ethernet hardware address */
114	int	ac_multicnt;		/* length of ac_multiaddrs list */
115	void	*ac_netgraph;		/* ng_ether(4) netgraph node info */
116};
117#endif
118
119#endif /* !_NET_IF_ARP_H_ */
120