xref: /netbsd-src/sys/net/if_ether.h (revision 4d7e773266e3c3f48566c86c0ad52d51c6454fd1)
1 /*	$NetBSD: if_ether.h,v 1.3 1997/11/02 14:26:15 lukem Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 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. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)if_ether.h	8.1 (Berkeley) 6/10/93
36  */
37 
38 /*
39  * Ethernet address - 6 octets
40  * this is only used by the ethers(3) functions.
41  */
42 struct ether_addr {
43 	u_int8_t ether_addr_octet[6];
44 };
45 
46 /*
47  * Structure of a 10Mb/s Ethernet header.
48  */
49 #define	ETHER_ADDR_LEN	6
50 
51 struct	ether_header {
52 	u_int8_t  ether_dhost[ETHER_ADDR_LEN];
53 	u_int8_t  ether_shost[ETHER_ADDR_LEN];
54 	u_int16_t ether_type;
55 };
56 
57 #include <net/ethertypes.h>
58 
59 #define	ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
60 
61 #define	ETHERMTU	1500
62 #define	ETHERMIN	(60-14)
63 
64 #ifdef _KERNEL
65 /*
66  * Macro to map an IP multicast address to an Ethernet multicast address.
67  * The high-order 25 bits of the Ethernet address are statically assigned,
68  * and the low-order 23 bits are taken from the low end of the IP address.
69  */
70 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr)				\
71 	/* struct in_addr *ipaddr; */					\
72 	/* u_int8_t enaddr[ETHER_ADDR_LEN]; */				\
73 {									\
74 	(enaddr)[0] = 0x01;						\
75 	(enaddr)[1] = 0x00;						\
76 	(enaddr)[2] = 0x5e;						\
77 	(enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f;			\
78 	(enaddr)[4] = ((u_int8_t *)ipaddr)[2];				\
79 	(enaddr)[5] = ((u_int8_t *)ipaddr)[3];				\
80 }
81 #endif
82 
83 /*
84  * Structure shared between the ethernet driver modules and
85  * the multicast list code.  For example, each ec_softc or il_softc
86  * begins with this structure.
87  */
88 struct	ethercom {
89 	struct	 ifnet ec_if;			/* network-visible interface */
90 	LIST_HEAD(, ether_multi) ec_multiaddrs;	/* list of ether multicast addrs */
91 	int	 ec_multicnt;			/* length of ac_multiaddrs list */
92 };
93 
94 #ifdef	_KERNEL
95 u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN];
96 u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN];
97 u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN];
98 
99 int	ether_addmulti __P((struct ifreq *, struct ethercom *));
100 int	ether_delmulti __P((struct ifreq *, struct ethercom *));
101 #endif /* _KERNEL */
102 
103 /*
104  * Ethernet multicast address structure.  There is one of these for each
105  * multicast address or range of multicast addresses that we are supposed
106  * to listen to on a particular interface.  They are kept in a linked list,
107  * rooted in the interface's ethercom structure.  (This really has nothing to
108  * do with ARP, or with the Internet address family, but this appears to be
109  * the minimally-disrupting place to put it.)
110  */
111 struct ether_multi {
112 	u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low  or only address of range */
113 	u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */
114 	struct	 ethercom *enm_ec;	/* back pointer to ethercom */
115 	u_int	 enm_refcount;		/* no. claims to this addr/range */
116 	LIST_ENTRY(ether_multi) enm_list;
117 };
118 
119 /*
120  * Structure used by macros below to remember position when stepping through
121  * all of the ether_multi records.
122  */
123 struct ether_multistep {
124 	struct ether_multi  *e_enm;
125 };
126 
127 /*
128  * Macro for looking up the ether_multi record for a given range of Ethernet
129  * multicast addresses connected to a given ethercom structure.  If no matching
130  * record is found, "enm" returns NULL.
131  */
132 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ec, enm)			\
133 	/* u_int8_t addrlo[ETHER_ADDR_LEN]; */				\
134 	/* u_int8_t addrhi[ETHER_ADDR_LEN]; */				\
135 	/* struct ethercom *ec; */					\
136 	/* struct ether_multi *enm; */					\
137 {									\
138 	for ((enm) = (ec)->ec_multiaddrs.lh_first;			\
139 	    (enm) != NULL &&						\
140 	    (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 ||	\
141 	     bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0);	\
142 		(enm) = (enm)->enm_list.le_next);			\
143 }
144 
145 /*
146  * Macro to step through all of the ether_multi records, one at a time.
147  * The current position is remembered in "step", which the caller must
148  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
149  * and get the first record.  Both macros return a NULL "enm" when there
150  * are no remaining records.
151  */
152 #define ETHER_NEXT_MULTI(step, enm) \
153 	/* struct ether_multistep step; */  \
154 	/* struct ether_multi *enm; */  \
155 { \
156 	if (((enm) = (step).e_enm) != NULL) \
157 		(step).e_enm = (enm)->enm_list.le_next; \
158 }
159 
160 #define ETHER_FIRST_MULTI(step, ec, enm) \
161 	/* struct ether_multistep step; */ \
162 	/* struct ethercom *ec; */ \
163 	/* struct ether_multi *enm; */ \
164 { \
165 	(step).e_enm = (ec)->ec_multiaddrs.lh_first; \
166 	ETHER_NEXT_MULTI((step), (enm)); \
167 }
168 
169 /*
170  * Prototype ethers(3) functions.
171  */
172 #ifndef _KERNEL
173 #include <sys/cdefs.h>
174 __BEGIN_DECLS
175 char *	ether_ntoa __P((struct ether_addr *));
176 struct ether_addr *
177 	ether_aton __P((const char *));
178 int	ether_ntohost __P((char *, struct ether_addr *));
179 int	ether_hostton __P((const char *, struct ether_addr *));
180 int	ether_line __P((const char *, struct ether_addr *, char *));
181 __END_DECLS
182 #endif
183