1 /* $NetBSD: if_ether.h,v 1.43 2006/11/24 01:04:30 rpaulo 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. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)if_ether.h 8.1 (Berkeley) 6/10/93 32 */ 33 34 #ifndef _NET_IF_ETHER_H_ 35 #define _NET_IF_ETHER_H_ 36 37 #include <sys/types.h> 38 39 #ifdef _KERNEL 40 #ifdef _KERNEL_OPT 41 #include "opt_mbuftrace.h" 42 #endif 43 #include <sys/mbuf.h> 44 #endif 45 46 /* 47 * Some basic Ethernet constants. 48 */ 49 #define ETHER_ADDR_LEN 6 /* length of an Ethernet address */ 50 #define ETHER_TYPE_LEN 2 /* length of the Ethernet type field */ 51 #define ETHER_CRC_LEN 4 /* length of the Ethernet CRC */ 52 #define ETHER_HDR_LEN ((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN) 53 #define ETHER_MIN_LEN 64 /* minimum frame length, including CRC */ 54 #define ETHER_MAX_LEN 1518 /* maximum frame length, including CRC */ 55 #define ETHER_MAX_LEN_JUMBO 9018 /* maximum jumbo frame len, including CRC */ 56 57 /* 58 * Some Ethernet extensions. 59 */ 60 #define ETHER_VLAN_ENCAP_LEN 4 /* length of 802.1Q VLAN encapsulation */ 61 62 /* 63 * Ethernet address - 6 octets 64 * this is only used by the ethers(3) functions. 65 */ 66 struct ether_addr { 67 u_int8_t ether_addr_octet[ETHER_ADDR_LEN]; 68 } __attribute__((__packed__)); 69 70 /* 71 * Structure of a 10Mb/s Ethernet header. 72 */ 73 struct ether_header { 74 u_int8_t ether_dhost[ETHER_ADDR_LEN]; 75 u_int8_t ether_shost[ETHER_ADDR_LEN]; 76 u_int16_t ether_type; 77 } __attribute__((__packed__)); 78 79 #include <net/ethertypes.h> 80 81 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ 82 83 #define ETHERMTU_JUMBO (ETHER_MAX_LEN_JUMBO - ETHER_HDR_LEN - ETHER_CRC_LEN) 84 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 85 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 86 87 /* 88 * Compute the maximum frame size based on ethertype (i.e. possible 89 * encapsulation) and whether or not an FCS is present. 90 */ 91 #define ETHER_MAX_FRAME(ifp, etype, hasfcs) \ 92 ((ifp)->if_mtu + ETHER_HDR_LEN + \ 93 ((hasfcs) ? ETHER_CRC_LEN : 0) + \ 94 (((etype) == ETHERTYPE_VLAN) ? ETHER_VLAN_ENCAP_LEN : 0)) 95 96 /* 97 * Ethernet CRC32 polynomials (big- and little-endian verions). 98 */ 99 #define ETHER_CRC_POLY_LE 0xedb88320 100 #define ETHER_CRC_POLY_BE 0x04c11db6 101 102 #ifndef _STANDALONE 103 104 /* 105 * Ethernet-specific mbuf flags. 106 */ 107 #define M_HASFCS M_LINK0 /* FCS included at end of frame */ 108 #define M_PROMISC M_LINK1 /* this packet is not for us */ 109 110 #ifdef _KERNEL 111 /* 112 * Macro to map an IP multicast address to an Ethernet multicast address. 113 * The high-order 25 bits of the Ethernet address are statically assigned, 114 * and the low-order 23 bits are taken from the low end of the IP address. 115 */ 116 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 117 /* struct in_addr *ipaddr; */ \ 118 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 119 { \ 120 (enaddr)[0] = 0x01; \ 121 (enaddr)[1] = 0x00; \ 122 (enaddr)[2] = 0x5e; \ 123 (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ 124 (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ 125 (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ 126 } 127 /* 128 * Macro to map an IP6 multicast address to an Ethernet multicast address. 129 * The high-order 16 bits of the Ethernet address are statically assigned, 130 * and the low-order 32 bits are taken from the low end of the IP6 address. 131 */ 132 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 133 /* struct in6_addr *ip6addr; */ \ 134 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 135 { \ 136 (enaddr)[0] = 0x33; \ 137 (enaddr)[1] = 0x33; \ 138 (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \ 139 (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \ 140 (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \ 141 (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \ 142 } 143 #endif 144 145 #define ETHERCAP_VLAN_MTU 0x00000001 /* VLAN-compatible MTU */ 146 #define ETHERCAP_VLAN_HWTAGGING 0x00000002 /* hardware VLAN tag support */ 147 #define ETHERCAP_JUMBO_MTU 0x00000004 /* 9000 byte MTU supported */ 148 149 #ifdef _KERNEL 150 extern const uint8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 151 extern const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN]; 152 extern const uint8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 153 extern const uint8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 154 155 int ether_ioctl(struct ifnet *, u_long, caddr_t); 156 int ether_addmulti (struct ifreq *, struct ethercom *); 157 int ether_delmulti (struct ifreq *, struct ethercom *); 158 int ether_changeaddr (struct ifreq *, struct ethercom *); 159 int ether_multiaddr(struct sockaddr *, u_int8_t[], u_int8_t[]); 160 161 /* 162 * Ethernet 802.1Q VLAN structures. 163 */ 164 165 /* add VLAN tag to input/received packet */ 166 #define VLAN_INPUT_TAG(ifp, m, vlanid, _errcase) \ 167 do { \ 168 struct m_tag *mtag = \ 169 m_tag_get(PACKET_TAG_VLAN, sizeof(u_int), M_NOWAIT);\ 170 if (mtag == NULL) { \ 171 ifp->if_ierrors++; \ 172 printf("%s: unable to allocate VLAN tag\n", \ 173 ifp->if_xname); \ 174 m_freem(m); \ 175 _errcase; \ 176 } \ 177 *(u_int *)(mtag + 1) = vlanid; \ 178 m_tag_prepend(m, mtag); \ 179 } while(0) 180 181 /* extract VLAN tag from output/trasmit packet */ 182 #define VLAN_OUTPUT_TAG(ec, m0) \ 183 VLAN_ATTACHED(ec) ? m_tag_find((m0), PACKET_TAG_VLAN, NULL) : NULL 184 185 /* extract VLAN ID value from a VLAN tag */ 186 #define VLAN_TAG_VALUE(mtag) \ 187 ((*(u_int *)(mtag + 1)) & 4095) 188 189 /* test if any VLAN is configured for this interface */ 190 #define VLAN_ATTACHED(ec) ((ec)->ec_nvlans > 0) 191 192 void ether_ifattach(struct ifnet *, const u_int8_t *); 193 void ether_ifdetach(struct ifnet *); 194 195 char *ether_sprintf(const u_int8_t *); 196 char *ether_snprintf(char *, size_t, const u_int8_t *); 197 198 u_int32_t ether_crc32_le(const u_int8_t *, size_t); 199 u_int32_t ether_crc32_be(const u_int8_t *, size_t); 200 201 int ether_nonstatic_aton(u_char *, char *); 202 #else 203 /* 204 * Prototype ethers(3) functions. 205 */ 206 #include <sys/cdefs.h> 207 __BEGIN_DECLS 208 char * ether_ntoa __P((const struct ether_addr *)); 209 struct ether_addr * 210 ether_aton __P((const char *)); 211 int ether_ntohost __P((char *, const struct ether_addr *)); 212 int ether_hostton __P((const char *, struct ether_addr *)); 213 int ether_line __P((const char *, struct ether_addr *, char *)); 214 __END_DECLS 215 #endif 216 217 #endif /* _STANDALONE */ 218 219 #endif /* !_NET_IF_ETHER_H_ */ 220