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 #ifdef _KERNEL 38 #ifdef _KERNEL_OPT 39 #include "opt_mbuftrace.h" 40 #endif 41 #include <sys/mbuf.h> 42 #endif 43 44 /* 45 * Some basic Ethernet constants. 46 */ 47 #define ETHER_ADDR_LEN 6 /* length of an Ethernet address */ 48 #define ETHER_TYPE_LEN 2 /* length of the Ethernet type field */ 49 #define ETHER_CRC_LEN 4 /* length of the Ethernet CRC */ 50 #define ETHER_HDR_LEN ((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN) 51 #define ETHER_MIN_LEN 64 /* minimum frame length, including CRC */ 52 #define ETHER_MAX_LEN 1518 /* maximum frame length, including CRC */ 53 #define ETHER_MAX_LEN_JUMBO 9018 /* maximum jumbo frame len, including CRC */ 54 55 /* 56 * Some Ethernet extensions. 57 */ 58 #define ETHER_VLAN_ENCAP_LEN 4 /* length of 802.1Q VLAN encapsulation */ 59 60 /* 61 * Ethernet address - 6 octets 62 * this is only used by the ethers(3) functions. 63 */ 64 struct ether_addr { 65 u_int8_t ether_addr_octet[ETHER_ADDR_LEN]; 66 } __attribute__((__packed__)); 67 68 /* 69 * Structure of a 10Mb/s Ethernet header. 70 */ 71 struct ether_header { 72 u_int8_t ether_dhost[ETHER_ADDR_LEN]; 73 u_int8_t ether_shost[ETHER_ADDR_LEN]; 74 u_int16_t ether_type; 75 } __attribute__((__packed__)); 76 77 #include <net/ethertypes.h> 78 79 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ 80 81 #define ETHERMTU_JUMBO (ETHER_MAX_LEN_JUMBO - ETHER_HDR_LEN - ETHER_CRC_LEN) 82 #define ETHERMTU (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 83 #define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 84 85 /* 86 * Compute the maximum frame size based on ethertype (i.e. possible 87 * encapsulation) and whether or not an FCS is present. 88 */ 89 #define ETHER_MAX_FRAME(ifp, etype, hasfcs) \ 90 ((ifp)->if_mtu + ETHER_HDR_LEN + \ 91 ((hasfcs) ? ETHER_CRC_LEN : 0) + \ 92 (((etype) == ETHERTYPE_VLAN) ? ETHER_VLAN_ENCAP_LEN : 0)) 93 94 /* 95 * Ethernet CRC32 polynomials (big- and little-endian verions). 96 */ 97 #define ETHER_CRC_POLY_LE 0xedb88320 98 #define ETHER_CRC_POLY_BE 0x04c11db6 99 100 #ifndef _STANDALONE 101 102 /* 103 * Ethernet-specific mbuf flags. 104 */ 105 #define M_HASFCS M_LINK0 /* FCS included at end of frame */ 106 #define M_PROMISC M_LINK1 /* this packet is not for us */ 107 108 #ifdef _KERNEL 109 /* 110 * Macro to map an IP multicast address to an Ethernet multicast address. 111 * The high-order 25 bits of the Ethernet address are statically assigned, 112 * and the low-order 23 bits are taken from the low end of the IP address. 113 */ 114 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ 115 /* struct in_addr *ipaddr; */ \ 116 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 117 { \ 118 (enaddr)[0] = 0x01; \ 119 (enaddr)[1] = 0x00; \ 120 (enaddr)[2] = 0x5e; \ 121 (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ 122 (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ 123 (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ 124 } 125 /* 126 * Macro to map an IP6 multicast address to an Ethernet multicast address. 127 * The high-order 16 bits of the Ethernet address are statically assigned, 128 * and the low-order 32 bits are taken from the low end of the IP6 address. 129 */ 130 #define ETHER_MAP_IPV6_MULTICAST(ip6addr, enaddr) \ 131 /* struct in6_addr *ip6addr; */ \ 132 /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ 133 { \ 134 (enaddr)[0] = 0x33; \ 135 (enaddr)[1] = 0x33; \ 136 (enaddr)[2] = ((u_int8_t *)ip6addr)[12]; \ 137 (enaddr)[3] = ((u_int8_t *)ip6addr)[13]; \ 138 (enaddr)[4] = ((u_int8_t *)ip6addr)[14]; \ 139 (enaddr)[5] = ((u_int8_t *)ip6addr)[15]; \ 140 } 141 #endif 142 143 #define ETHERCAP_VLAN_MTU 0x00000001 /* VLAN-compatible MTU */ 144 #define ETHERCAP_VLAN_HWTAGGING 0x00000002 /* hardware VLAN tag support */ 145 #define ETHERCAP_JUMBO_MTU 0x00000004 /* 9000 byte MTU supported */ 146 147 #ifdef _KERNEL 148 extern const uint8_t etherbroadcastaddr[ETHER_ADDR_LEN]; 149 extern const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN]; 150 extern const uint8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; 151 extern const uint8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; 152 153 int ether_ioctl(struct ifnet *, u_long, caddr_t); 154 int ether_addmulti (struct ifreq *, struct ethercom *); 155 int ether_delmulti (struct ifreq *, struct ethercom *); 156 int ether_changeaddr (struct ifreq *, struct ethercom *); 157 int ether_multiaddr(struct sockaddr *, u_int8_t[], u_int8_t[]); 158 159 /* 160 * Ethernet 802.1Q VLAN structures. 161 */ 162 163 /* add VLAN tag to input/received packet */ 164 #define VLAN_INPUT_TAG(ifp, m, vlanid, _errcase) \ 165 do { \ 166 struct m_tag *mtag = \ 167 m_tag_get(PACKET_TAG_VLAN, sizeof(u_int), M_NOWAIT);\ 168 if (mtag == NULL) { \ 169 ifp->if_ierrors++; \ 170 printf("%s: unable to allocate VLAN tag\n", \ 171 ifp->if_xname); \ 172 m_freem(m); \ 173 _errcase; \ 174 } \ 175 *(u_int *)(mtag + 1) = vlanid; \ 176 m_tag_prepend(m, mtag); \ 177 } while(0) 178 179 /* extract VLAN tag from output/trasmit packet */ 180 #define VLAN_OUTPUT_TAG(ec, m0) \ 181 VLAN_ATTACHED(ec) ? m_tag_find((m0), PACKET_TAG_VLAN, NULL) : NULL 182 183 /* extract VLAN ID value from a VLAN tag */ 184 #define VLAN_TAG_VALUE(mtag) \ 185 ((*(u_int *)(mtag + 1)) & 4095) 186 187 /* test if any VLAN is configured for this interface */ 188 #define VLAN_ATTACHED(ec) ((ec)->ec_nvlans > 0) 189 190 void ether_ifattach(struct ifnet *, const u_int8_t *); 191 void ether_ifdetach(struct ifnet *); 192 193 char *ether_sprintf(const u_int8_t *); 194 char *ether_snprintf(char *, size_t, const u_int8_t *); 195 196 u_int32_t ether_crc32_le(const u_int8_t *, size_t); 197 u_int32_t ether_crc32_be(const u_int8_t *, size_t); 198 199 int ether_nonstatic_aton(u_char *, char *); 200 #else 201 /* 202 * Prototype ethers(3) functions. 203 */ 204 #include <sys/cdefs.h> 205 __BEGIN_DECLS 206 char * ether_ntoa __P((const struct ether_addr *)); 207 struct ether_addr * 208 ether_aton __P((const char *)); 209 int ether_ntohost __P((char *, const struct ether_addr *)); 210 int ether_hostton __P((const char *, struct ether_addr *)); 211 int ether_line __P((const char *, struct ether_addr *, char *)); 212 __END_DECLS 213 #endif 214 215 #endif /* _STANDALONE */ 216 217 #endif /* !_NET_IF_ETHER_H_ */ 218
