xref: /netbsd-src/sys/net/if_ether.h (revision dc306354b0b29af51801a7632f1e95265a68cd81)
1 /*	$NetBSD: if_ether.h,v 1.5 1998/07/28 12:25:53 is 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 #ifndef _NET_IF_ETHER_H_
39 #define _NET_IF_ETHER_H_
40 
41 /*
42  * Ethernet address - 6 octets
43  * this is only used by the ethers(3) functions.
44  */
45 struct ether_addr {
46 	u_int8_t ether_addr_octet[6];
47 };
48 
49 /*
50  * Structure of a 10Mb/s Ethernet header.
51  */
52 #define	ETHER_ADDR_LEN	6
53 
54 struct	ether_header {
55 	u_int8_t  ether_dhost[ETHER_ADDR_LEN];
56 	u_int8_t  ether_shost[ETHER_ADDR_LEN];
57 	u_int16_t ether_type;
58 };
59 
60 #include <net/ethertypes.h>
61 
62 #define	ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
63 
64 #define	ETHERMTU	1500
65 #define	ETHERMIN	(60-14)
66 
67 #ifdef _KERNEL
68 /*
69  * Macro to map an IP multicast address to an Ethernet multicast address.
70  * The high-order 25 bits of the Ethernet address are statically assigned,
71  * and the low-order 23 bits are taken from the low end of the IP address.
72  */
73 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr)				\
74 	/* struct in_addr *ipaddr; */					\
75 	/* u_int8_t enaddr[ETHER_ADDR_LEN]; */				\
76 {									\
77 	(enaddr)[0] = 0x01;						\
78 	(enaddr)[1] = 0x00;						\
79 	(enaddr)[2] = 0x5e;						\
80 	(enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f;			\
81 	(enaddr)[4] = ((u_int8_t *)ipaddr)[2];				\
82 	(enaddr)[5] = ((u_int8_t *)ipaddr)[3];				\
83 }
84 #endif
85 
86 /*
87  * Structure shared between the ethernet driver modules and
88  * the multicast list code.  For example, each ec_softc or il_softc
89  * begins with this structure.
90  */
91 struct	ethercom {
92 	struct	 ifnet ec_if;			/* network-visible interface */
93 	LIST_HEAD(, ether_multi) ec_multiaddrs;	/* list of ether multicast addrs */
94 	int	 ec_multicnt;			/* length of ac_multiaddrs list */
95 };
96 
97 #ifdef	_KERNEL
98 u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN];
99 u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN];
100 u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN];
101 
102 int	ether_addmulti __P((struct ifreq *, struct ethercom *));
103 int	ether_delmulti __P((struct ifreq *, struct ethercom *));
104 #endif /* _KERNEL */
105 
106 /*
107  * Ethernet multicast address structure.  There is one of these for each
108  * multicast address or range of multicast addresses that we are supposed
109  * to listen to on a particular interface.  They are kept in a linked list,
110  * rooted in the interface's ethercom structure.
111  */
112 struct ether_multi {
113 	u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low  or only address of range */
114 	u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */
115 	struct	 ethercom *enm_ec;	/* back pointer to ethercom */
116 	u_int	 enm_refcount;		/* no. claims to this addr/range */
117 	LIST_ENTRY(ether_multi) enm_list;
118 };
119 
120 /*
121  * Structure used by macros below to remember position when stepping through
122  * all of the ether_multi records.
123  */
124 struct ether_multistep {
125 	struct ether_multi  *e_enm;
126 };
127 
128 /*
129  * Macro for looking up the ether_multi record for a given range of Ethernet
130  * multicast addresses connected to a given ethercom structure.  If no matching
131  * record is found, "enm" returns NULL.
132  */
133 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ec, enm)			\
134 	/* u_int8_t addrlo[ETHER_ADDR_LEN]; */				\
135 	/* u_int8_t addrhi[ETHER_ADDR_LEN]; */				\
136 	/* struct ethercom *ec; */					\
137 	/* struct ether_multi *enm; */					\
138 {									\
139 	for ((enm) = (ec)->ec_multiaddrs.lh_first;			\
140 	    (enm) != NULL &&						\
141 	    (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 ||	\
142 	     bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0);	\
143 		(enm) = (enm)->enm_list.le_next);			\
144 }
145 
146 /*
147  * Macro to step through all of the ether_multi records, one at a time.
148  * The current position is remembered in "step", which the caller must
149  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
150  * and get the first record.  Both macros return a NULL "enm" when there
151  * are no remaining records.
152  */
153 #define ETHER_NEXT_MULTI(step, enm) \
154 	/* struct ether_multistep step; */  \
155 	/* struct ether_multi *enm; */  \
156 { \
157 	if (((enm) = (step).e_enm) != NULL) \
158 		(step).e_enm = (enm)->enm_list.le_next; \
159 }
160 
161 #define ETHER_FIRST_MULTI(step, ec, enm) \
162 	/* struct ether_multistep step; */ \
163 	/* struct ethercom *ec; */ \
164 	/* struct ether_multi *enm; */ \
165 { \
166 	(step).e_enm = (ec)->ec_multiaddrs.lh_first; \
167 	ETHER_NEXT_MULTI((step), (enm)); \
168 }
169 
170 /*
171  * Prototype ethers(3) functions.
172  */
173 #ifndef _KERNEL
174 #include <sys/cdefs.h>
175 __BEGIN_DECLS
176 char *	ether_ntoa __P((struct ether_addr *));
177 struct ether_addr *
178 	ether_aton __P((const char *));
179 int	ether_ntohost __P((char *, struct ether_addr *));
180 int	ether_hostton __P((const char *, struct ether_addr *));
181 int	ether_line __P((const char *, struct ether_addr *, char *));
182 __END_DECLS
183 #endif
184 
185 #endif /* _NET_IF_ETHER_H_ */
186