| 1 | /* $NetBSD: if_ether.h,v 1.25 1997/01/17 17:06:06 mikel 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 | * $FreeBSD: src/lib/libstand/if_ether.h,v 1.1.1.1.6.1 2000/09/20 09:49:17 jkh Exp $ |
| 38 | * $DragonFly: src/lib/libstand/if_ether.h,v 1.2 2003/06/17 04:26:51 dillon Exp $ |
| 39 | */ |
| 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 | #define ETHERTYPE_PUP 0x0200 /* PUP protocol */ |
| 61 | #define ETHERTYPE_IP 0x0800 /* IP protocol */ |
| 62 | #define ETHERTYPE_ARP 0x0806 /* address resolution protocol */ |
| 63 | #define ETHERTYPE_REVARP 0x8035 /* reverse addr resolution protocol */ |
| 64 | |
| 65 | /* |
| 66 | * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have |
| 67 | * (type-ETHERTYPE_TRAIL)*512 bytes of data followed |
| 68 | * by an ETHER type (as given above) and then the (variable-length) header. |
| 69 | */ |
| 70 | #define ETHERTYPE_TRAIL 0x1000 /* Trailer packet */ |
| 71 | #define ETHERTYPE_NTRAILER 16 |
| 72 | |
| 73 | #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ |
| 74 | |
| 75 | #define ETHERMTU 1500 |
| 76 | #define ETHERMIN (60-14) |
| 77 | |
| 78 | #ifdef _KERNEL |
| 79 | /* |
| 80 | * Macro to map an IP multicast address to an Ethernet multicast address. |
| 81 | * The high-order 25 bits of the Ethernet address are statically assigned, |
| 82 | * and the low-order 23 bits are taken from the low end of the IP address. |
| 83 | */ |
| 84 | #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \ |
| 85 | /* struct in_addr *ipaddr; */ \ |
| 86 | /* u_int8_t enaddr[ETHER_ADDR_LEN]; */ \ |
| 87 | { \ |
| 88 | (enaddr)[0] = 0x01; \ |
| 89 | (enaddr)[1] = 0x00; \ |
| 90 | (enaddr)[2] = 0x5e; \ |
| 91 | (enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f; \ |
| 92 | (enaddr)[4] = ((u_int8_t *)ipaddr)[2]; \ |
| 93 | (enaddr)[5] = ((u_int8_t *)ipaddr)[3]; \ |
| 94 | } |
| 95 | #endif |
| 96 | |
| 97 | /* |
| 98 | * Ethernet Address Resolution Protocol. |
| 99 | * |
| 100 | * See RFC 826 for protocol description. Structure below is adapted |
| 101 | * to resolving internet addresses. Field names used correspond to |
| 102 | * RFC 826. |
| 103 | */ |
| 104 | struct ether_arp { |
| 105 | struct arphdr ea_hdr; /* fixed-size header */ |
| 106 | u_int8_t arp_sha[ETHER_ADDR_LEN]; /* sender hardware address */ |
| 107 | u_int8_t arp_spa[4]; /* sender protocol address */ |
| 108 | u_int8_t arp_tha[ETHER_ADDR_LEN]; /* target hardware address */ |
| 109 | u_int8_t arp_tpa[4]; /* target protocol address */ |
| 110 | }; |
| 111 | #define arp_hrd ea_hdr.ar_hrd |
| 112 | #define arp_pro ea_hdr.ar_pro |
| 113 | #define arp_hln ea_hdr.ar_hln |
| 114 | #define arp_pln ea_hdr.ar_pln |
| 115 | #define arp_op ea_hdr.ar_op |
| 116 | |
| 117 | /* |
| 118 | * Structure shared between the ethernet driver modules and |
| 119 | * the address resolution code. For example, each ec_softc or il_softc |
| 120 | * begins with this structure. |
| 121 | */ |
| 122 | struct arpcom { |
| 123 | struct ifnet ac_if; /* network-visible interface */ |
| 124 | u_int8_t ac_enaddr[ETHER_ADDR_LEN]; /* ethernet hardware address */ |
| 125 | char ac__pad[2]; /* be nice to m68k ports */ |
| 126 | LIST_HEAD(, ether_multi) ac_multiaddrs; /* list of ether multicast addrs */ |
| 127 | int ac_multicnt; /* length of ac_multiaddrs list */ |
| 128 | }; |
| 129 | |
| 130 | struct llinfo_arp { |
| 131 | LIST_ENTRY(llinfo_arp) la_list; |
| 132 | struct rtentry *la_rt; |
| 133 | struct mbuf *la_hold; /* last packet until resolved/timeout */ |
| 134 | long la_asked; /* last time we QUERIED for this addr */ |
| 135 | #define la_timer la_rt->rt_rmx.rmx_expire /* deletion time in seconds */ |
| 136 | }; |
| 137 | |
| 138 | struct sockaddr_inarp { |
| 139 | u_int8_t sin_len; |
| 140 | u_int8_t sin_family; |
| 141 | u_int16_t sin_port; |
| 142 | struct in_addr sin_addr; |
| 143 | struct in_addr sin_srcaddr; |
| 144 | u_int16_t sin_tos; |
| 145 | u_int16_t sin_other; |
| 146 | #define SIN_PROXY 1 |
| 147 | }; |
| 148 | |
| 149 | /* |
| 150 | * IP and ethernet specific routing flags |
| 151 | */ |
| 152 | #define RTF_USETRAILERS RTF_PROTO1 /* use trailers */ |
| 153 | #define RTF_ANNOUNCE RTF_PROTO2 /* announce new arp entry */ |
| 154 | |
| 155 | #ifdef _KERNEL |
| 156 | u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN]; |
| 157 | u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN]; |
| 158 | u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN]; |
| 159 | struct ifqueue arpintrq; |
| 160 | |
| 161 | void arpwhohas(struct arpcom *, struct in_addr *); |
| 162 | void arpintr(void); |
| 163 | int arpresolve(struct arpcom *, |
| 164 | struct rtentry *, struct mbuf *, struct sockaddr *, u_char *); |
| 165 | void arp_ifinit(struct arpcom *, struct ifaddr *); |
| 166 | void arp_rtrequest(int, struct rtentry *, struct sockaddr *); |
| 167 | |
| 168 | int ether_addmulti(struct ifreq *, struct arpcom *); |
| 169 | int ether_delmulti(struct ifreq *, struct arpcom *); |
| 170 | #endif /* _KERNEL */ |
| 171 | |
| 172 | /* |
| 173 | * Ethernet multicast address structure. There is one of these for each |
| 174 | * multicast address or range of multicast addresses that we are supposed |
| 175 | * to listen to on a particular interface. They are kept in a linked list, |
| 176 | * rooted in the interface's arpcom structure. (This really has nothing to |
| 177 | * do with ARP, or with the Internet address family, but this appears to be |
| 178 | * the minimally-disrupting place to put it.) |
| 179 | */ |
| 180 | struct ether_multi { |
| 181 | u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low or only address of range */ |
| 182 | u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */ |
| 183 | struct arpcom *enm_ac; /* back pointer to arpcom */ |
| 184 | u_int enm_refcount; /* no. claims to this addr/range */ |
| 185 | LIST_ENTRY(ether_multi) enm_list; |
| 186 | }; |
| 187 | |
| 188 | /* |
| 189 | * Structure used by macros below to remember position when stepping through |
| 190 | * all of the ether_multi records. |
| 191 | */ |
| 192 | struct ether_multistep { |
| 193 | struct ether_multi *e_enm; |
| 194 | }; |
| 195 | |
| 196 | /* |
| 197 | * Macro for looking up the ether_multi record for a given range of Ethernet |
| 198 | * multicast addresses connected to a given arpcom structure. If no matching |
| 199 | * record is found, "enm" returns NULL. |
| 200 | */ |
| 201 | #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \ |
| 202 | /* u_int8_t addrlo[ETHER_ADDR_LEN]; */ \ |
| 203 | /* u_int8_t addrhi[ETHER_ADDR_LEN]; */ \ |
| 204 | /* struct arpcom *ac; */ \ |
| 205 | /* struct ether_multi *enm; */ \ |
| 206 | { \ |
| 207 | for ((enm) = (ac)->ac_multiaddrs.lh_first; \ |
| 208 | (enm) != NULL && \ |
| 209 | (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 || \ |
| 210 | bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \ |
| 211 | (enm) = (enm)->enm_list.le_next); \ |
| 212 | } |
| 213 | |
| 214 | /* |
| 215 | * Macro to step through all of the ether_multi records, one at a time. |
| 216 | * The current position is remembered in "step", which the caller must |
| 217 | * provide. ETHER_FIRST_MULTI(), below, must be called to initialize "step" |
| 218 | * and get the first record. Both macros return a NULL "enm" when there |
| 219 | * are no remaining records. |
| 220 | */ |
| 221 | #define ETHER_NEXT_MULTI(step, enm) \ |
| 222 | /* struct ether_multistep step; */ \ |
| 223 | /* struct ether_multi *enm; */ \ |
| 224 | { \ |
| 225 | if (((enm) = (step).e_enm) != NULL) \ |
| 226 | (step).e_enm = (enm)->enm_list.le_next; \ |
| 227 | } |
| 228 | |
| 229 | #define ETHER_FIRST_MULTI(step, ac, enm) \ |
| 230 | /* struct ether_multistep step; */ \ |
| 231 | /* struct arpcom *ac; */ \ |
| 232 | /* struct ether_multi *enm; */ \ |
| 233 | { \ |
| 234 | (step).e_enm = (ac)->ac_multiaddrs.lh_first; \ |
| 235 | ETHER_NEXT_MULTI((step), (enm)); \ |
| 236 | } |
| 237 | |
| 238 | #ifdef _KERNEL |
| 239 | void arp_rtrequest(int, struct rtentry *, struct sockaddr *); |
| 240 | int arpresolve(struct arpcom *, struct rtentry *, struct mbuf *, |
| 241 | struct sockaddr *, u_char *); |
| 242 | void arpintr(void); |
| 243 | int arpioctl(u_long, caddr_t); |
| 244 | void arp_ifinit(struct arpcom *, struct ifaddr *); |
| 245 | void revarpinput(struct mbuf *); |
| 246 | void in_revarpinput(struct mbuf *); |
| 247 | void revarprequest(struct ifnet *); |
| 248 | int revarpwhoarewe(struct ifnet *, struct in_addr *, struct in_addr *); |
| 249 | int revarpwhoami(struct in_addr *, struct ifnet *); |
| 250 | int db_show_arptab(void); |
| 251 | #endif |
| 252 | |
| 253 | /* |
| 254 | * Prototype ethers(3) functions. |
| 255 | */ |
| 256 | #ifndef _KERNEL |
| 257 | #include <sys/cdefs.h> |
| 258 | __BEGIN_DECLS |
| 259 | char * ether_ntoa(struct ether_addr *); |
| 260 | struct ether_addr * |
| 261 | ether_aton(char *); |
| 262 | int ether_ntohost(char *, struct ether_addr *); |
| 263 | int ether_hostton(char *, struct ether_addr *); |
| 264 | int ether_line(char *, struct ether_addr *, char *); |
| 265 | __END_DECLS |
| 266 | #endif |