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