]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/net/ethernet.h
net: add ETHER_IS_ZERO macro similar to ETHER_IS_BROADCAST
[FreeBSD/FreeBSD.git] / sys / net / ethernet.h
1 /*
2  * Fundamental constants relating to ethernet.
3  *
4  * $FreeBSD$
5  *
6  */
7
8 #ifndef _NET_ETHERNET_H_
9 #define _NET_ETHERNET_H_
10
11 /*
12  * Some basic Ethernet constants.
13  */
14 #define ETHER_ADDR_LEN          6       /* length of an Ethernet address */
15 #define ETHER_TYPE_LEN          2       /* length of the Ethernet type field */
16 #define ETHER_CRC_LEN           4       /* length of the Ethernet CRC */
17 #define ETHER_HDR_LEN           (ETHER_ADDR_LEN*2+ETHER_TYPE_LEN)
18 #define ETHER_MIN_LEN           64      /* minimum frame len, including CRC */
19 #define ETHER_MAX_LEN           1518    /* maximum frame len, including CRC */
20 #define ETHER_MAX_LEN_JUMBO     9018    /* max jumbo frame len, including CRC */
21
22 #define ETHER_VLAN_ENCAP_LEN    4       /* len of 802.1Q VLAN encapsulation */
23 /*
24  * Mbuf adjust factor to force 32-bit alignment of IP header.
25  * Drivers should do m_adj(m, ETHER_ALIGN) when setting up a
26  * receive so the upper layers get the IP header properly aligned
27  * past the 14-byte Ethernet header.
28  */
29 #define ETHER_ALIGN             2       /* driver adjust for IP hdr alignment */
30
31 /*
32  * Compute the maximum frame size based on ethertype (i.e. possible
33  * encapsulation) and whether or not an FCS is present.
34  */
35 #define ETHER_MAX_FRAME(ifp, etype, hasfcs)                             \
36         ((ifp)->if_mtu + ETHER_HDR_LEN +                                \
37          ((hasfcs) ? ETHER_CRC_LEN : 0) +                               \
38          (((etype) == ETHERTYPE_VLAN) ? ETHER_VLAN_ENCAP_LEN : 0))
39
40 /*
41  * Ethernet-specific mbuf flags.
42  */
43 #define M_HASFCS        M_PROTO5        /* FCS included at end of frame */
44
45 /*
46  * Ethernet CRC32 polynomials (big- and little-endian verions).
47  */
48 #define ETHER_CRC_POLY_LE       0xedb88320
49 #define ETHER_CRC_POLY_BE       0x04c11db6
50
51 /*
52  * A macro to validate a length with
53  */
54 #define ETHER_IS_VALID_LEN(foo) \
55         ((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN)
56
57 /*
58  * Structure of a 10Mb/s Ethernet header.
59  */
60 struct ether_header {
61         u_char  ether_dhost[ETHER_ADDR_LEN];
62         u_char  ether_shost[ETHER_ADDR_LEN];
63         u_short ether_type;
64 } __packed;
65
66 /*
67  * Structure of a 48-bit Ethernet address.
68  */
69 struct ether_addr {
70         u_char octet[ETHER_ADDR_LEN];
71 } __packed;
72
73 #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
74 #define ETHER_IS_BROADCAST(addr) \
75         (((addr)[0] & (addr)[1] & (addr)[2] & \
76           (addr)[3] & (addr)[4] & (addr)[5]) == 0xff)
77 #define ETHER_IS_ZERO(addr) \
78         (((addr)[0] | (addr)[1] | (addr)[2] | \
79           (addr)[3] | (addr)[4] | (addr)[5]) == 0x00)
80
81 /*
82  * 802.1q Virtual LAN header.
83  */
84 struct ether_vlan_header {
85         uint8_t evl_dhost[ETHER_ADDR_LEN];
86         uint8_t evl_shost[ETHER_ADDR_LEN];
87         uint16_t evl_encap_proto;
88         uint16_t evl_tag;
89         uint16_t evl_proto;
90 } __packed;
91
92 #define EVL_VLID_MASK           0x0FFF
93 #define EVL_PRI_MASK            0xE000
94 #define EVL_VLANOFTAG(tag)      ((tag) & EVL_VLID_MASK)
95 #define EVL_PRIOFTAG(tag)       (((tag) >> 13) & 7)
96 #define EVL_CFIOFTAG(tag)       (((tag) >> 12) & 1)
97 #define EVL_MAKETAG(vlid, pri, cfi)                                     \
98         ((((((pri) & 7) << 1) | ((cfi) & 1)) << 12) | ((vlid) & EVL_VLID_MASK))
99
100 /*
101  *  NOTE: 0x0000-0x05DC (0..1500) are generally IEEE 802.3 length fields.
102  *  However, there are some conflicts.
103  */
104
105 #define ETHERTYPE_8023          0x0004  /* IEEE 802.3 packet */
106                    /* 0x0101 .. 0x1FF      Experimental */
107 #define ETHERTYPE_PUP           0x0200  /* Xerox PUP protocol - see 0A00 */
108 #define ETHERTYPE_PUPAT         0x0200  /* PUP Address Translation - see 0A01 */
109 #define ETHERTYPE_SPRITE        0x0500  /* ??? */
110                              /* 0x0400     Nixdorf */
111 #define ETHERTYPE_NS            0x0600  /* XNS */
112 #define ETHERTYPE_NSAT          0x0601  /* XNS Address Translation (3Mb only) */
113 #define ETHERTYPE_DLOG1         0x0660  /* DLOG (?) */
114 #define ETHERTYPE_DLOG2         0x0661  /* DLOG (?) */
115 #define ETHERTYPE_IP            0x0800  /* IP protocol */
116 #define ETHERTYPE_X75           0x0801  /* X.75 Internet */
117 #define ETHERTYPE_NBS           0x0802  /* NBS Internet */
118 #define ETHERTYPE_ECMA          0x0803  /* ECMA Internet */
119 #define ETHERTYPE_CHAOS         0x0804  /* CHAOSnet */
120 #define ETHERTYPE_X25           0x0805  /* X.25 Level 3 */
121 #define ETHERTYPE_ARP           0x0806  /* Address resolution protocol */
122 #define ETHERTYPE_NSCOMPAT      0x0807  /* XNS Compatibility */
123 #define ETHERTYPE_FRARP         0x0808  /* Frame Relay ARP (RFC1701) */
124                              /* 0x081C     Symbolics Private */
125                     /* 0x0888 - 0x088A     Xyplex */
126 #define ETHERTYPE_UBDEBUG       0x0900  /* Ungermann-Bass network debugger */
127 #define ETHERTYPE_IEEEPUP       0x0A00  /* Xerox IEEE802.3 PUP */
128 #define ETHERTYPE_IEEEPUPAT     0x0A01  /* Xerox IEEE802.3 PUP Address Translation */
129 #define ETHERTYPE_VINES         0x0BAD  /* Banyan VINES */
130 #define ETHERTYPE_VINESLOOP     0x0BAE  /* Banyan VINES Loopback */
131 #define ETHERTYPE_VINESECHO     0x0BAF  /* Banyan VINES Echo */
132
133 /*                     0x1000 - 0x100F     Berkeley Trailer */
134 /*
135  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
136  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
137  * by an ETHER type (as given above) and then the (variable-length) header.
138  */
139 #define ETHERTYPE_TRAIL         0x1000  /* Trailer packet */
140 #define ETHERTYPE_NTRAILER      16
141
142 #define ETHERTYPE_DCA           0x1234  /* DCA - Multicast */
143 #define ETHERTYPE_VALID         0x1600  /* VALID system protocol */
144 #define ETHERTYPE_DOGFIGHT      0x1989  /* Artificial Horizons ("Aviator" dogfight simulator [on Sun]) */
145 #define ETHERTYPE_RCL           0x1995  /* Datapoint Corporation (RCL lan protocol) */
146
147                                         /* The following 3C0x types
148                                            are unregistered: */
149 #define ETHERTYPE_NBPVCD        0x3C00  /* 3Com NBP virtual circuit datagram (like XNS SPP) not registered */
150 #define ETHERTYPE_NBPSCD        0x3C01  /* 3Com NBP System control datagram not registered */
151 #define ETHERTYPE_NBPCREQ       0x3C02  /* 3Com NBP Connect request (virtual cct) not registered */
152 #define ETHERTYPE_NBPCRSP       0x3C03  /* 3Com NBP Connect response not registered */
153 #define ETHERTYPE_NBPCC         0x3C04  /* 3Com NBP Connect complete not registered */
154 #define ETHERTYPE_NBPCLREQ      0x3C05  /* 3Com NBP Close request (virtual cct) not registered */
155 #define ETHERTYPE_NBPCLRSP      0x3C06  /* 3Com NBP Close response not registered */
156 #define ETHERTYPE_NBPDG         0x3C07  /* 3Com NBP Datagram (like XNS IDP) not registered */
157 #define ETHERTYPE_NBPDGB        0x3C08  /* 3Com NBP Datagram broadcast not registered */
158 #define ETHERTYPE_NBPCLAIM      0x3C09  /* 3Com NBP Claim NetBIOS name not registered */
159 #define ETHERTYPE_NBPDLTE       0x3C0A  /* 3Com NBP Delete NetBIOS name not registered */
160 #define ETHERTYPE_NBPRAS        0x3C0B  /* 3Com NBP Remote adaptor status request not registered */
161 #define ETHERTYPE_NBPRAR        0x3C0C  /* 3Com NBP Remote adaptor response not registered */
162 #define ETHERTYPE_NBPRST        0x3C0D  /* 3Com NBP Reset not registered */
163
164 #define ETHERTYPE_PCS           0x4242  /* PCS Basic Block Protocol */
165 #define ETHERTYPE_IMLBLDIAG     0x424C  /* Information Modes Little Big LAN diagnostic */
166 #define ETHERTYPE_DIDDLE        0x4321  /* THD - Diddle */
167 #define ETHERTYPE_IMLBL         0x4C42  /* Information Modes Little Big LAN */
168 #define ETHERTYPE_SIMNET        0x5208  /* BBN Simnet Private */
169 #define ETHERTYPE_DECEXPER      0x6000  /* DEC Unassigned, experimental */
170 #define ETHERTYPE_MOPDL         0x6001  /* DEC MOP dump/load */
171 #define ETHERTYPE_MOPRC         0x6002  /* DEC MOP remote console */
172 #define ETHERTYPE_DECnet        0x6003  /* DEC DECNET Phase IV route */
173 #define ETHERTYPE_DN            ETHERTYPE_DECnet        /* libpcap, tcpdump */
174 #define ETHERTYPE_LAT           0x6004  /* DEC LAT */
175 #define ETHERTYPE_DECDIAG       0x6005  /* DEC diagnostic protocol (at interface initialization?) */
176 #define ETHERTYPE_DECCUST       0x6006  /* DEC customer protocol */
177 #define ETHERTYPE_SCA           0x6007  /* DEC LAVC, SCA */
178 #define ETHERTYPE_AMBER         0x6008  /* DEC AMBER */
179 #define ETHERTYPE_DECMUMPS      0x6009  /* DEC MUMPS */
180                     /* 0x6010 - 0x6014     3Com Corporation */
181 #define ETHERTYPE_TRANSETHER    0x6558  /* Trans Ether Bridging (RFC1701)*/
182 #define ETHERTYPE_RAWFR         0x6559  /* Raw Frame Relay (RFC1701) */
183 #define ETHERTYPE_UBDL          0x7000  /* Ungermann-Bass download */
184 #define ETHERTYPE_UBNIU         0x7001  /* Ungermann-Bass NIUs */
185 #define ETHERTYPE_UBDIAGLOOP    0x7002  /* Ungermann-Bass diagnostic/loopback */
186 #define ETHERTYPE_UBNMC         0x7003  /* Ungermann-Bass ??? (NMC to/from UB Bridge) */
187 #define ETHERTYPE_UBBST         0x7005  /* Ungermann-Bass Bridge Spanning Tree */
188 #define ETHERTYPE_OS9           0x7007  /* OS/9 Microware */
189 #define ETHERTYPE_OS9NET        0x7009  /* OS/9 Net? */
190                     /* 0x7020 - 0x7029     LRT (England) (now Sintrom) */
191 #define ETHERTYPE_RACAL         0x7030  /* Racal-Interlan */
192 #define ETHERTYPE_PRIMENTS      0x7031  /* Prime NTS (Network Terminal Service) */
193 #define ETHERTYPE_CABLETRON     0x7034  /* Cabletron */
194 #define ETHERTYPE_CRONUSVLN     0x8003  /* Cronus VLN */
195 #define ETHERTYPE_CRONUS        0x8004  /* Cronus Direct */
196 #define ETHERTYPE_HP            0x8005  /* HP Probe */
197 #define ETHERTYPE_NESTAR        0x8006  /* Nestar */
198 #define ETHERTYPE_ATTSTANFORD   0x8008  /* AT&T/Stanford (local use) */
199 #define ETHERTYPE_EXCELAN       0x8010  /* Excelan */
200 #define ETHERTYPE_SG_DIAG       0x8013  /* SGI diagnostic type */
201 #define ETHERTYPE_SG_NETGAMES   0x8014  /* SGI network games */
202 #define ETHERTYPE_SG_RESV       0x8015  /* SGI reserved type */
203 #define ETHERTYPE_SG_BOUNCE     0x8016  /* SGI bounce server */
204 #define ETHERTYPE_APOLLODOMAIN  0x8019  /* Apollo DOMAIN */
205 #define ETHERTYPE_TYMSHARE      0x802E  /* Tymeshare */
206 #define ETHERTYPE_TIGAN         0x802F  /* Tigan, Inc. */
207 #define ETHERTYPE_REVARP        0x8035  /* Reverse addr resolution protocol */
208 #define ETHERTYPE_AEONIC        0x8036  /* Aeonic Systems */
209 #define ETHERTYPE_IPXNEW        0x8037  /* IPX (Novell Netware?) */
210 #define ETHERTYPE_LANBRIDGE     0x8038  /* DEC LANBridge */
211 #define ETHERTYPE_DSMD  0x8039  /* DEC DSM/DDP */
212 #define ETHERTYPE_ARGONAUT      0x803A  /* DEC Argonaut Console */
213 #define ETHERTYPE_VAXELN        0x803B  /* DEC VAXELN */
214 #define ETHERTYPE_DECDNS        0x803C  /* DEC DNS Naming Service */
215 #define ETHERTYPE_ENCRYPT       0x803D  /* DEC Ethernet Encryption */
216 #define ETHERTYPE_DECDTS        0x803E  /* DEC Distributed Time Service */
217 #define ETHERTYPE_DECLTM        0x803F  /* DEC LAN Traffic Monitor */
218 #define ETHERTYPE_DECNETBIOS    0x8040  /* DEC PATHWORKS DECnet NETBIOS Emulation */
219 #define ETHERTYPE_DECLAST       0x8041  /* DEC Local Area System Transport */
220                              /* 0x8042     DEC Unassigned */
221 #define ETHERTYPE_PLANNING      0x8044  /* Planning Research Corp. */
222                     /* 0x8046 - 0x8047     AT&T */
223 #define ETHERTYPE_DECAM         0x8048  /* DEC Availability Manager for Distributed Systems DECamds (but someone at DEC says not) */
224 #define ETHERTYPE_EXPERDATA     0x8049  /* ExperData */
225 #define ETHERTYPE_VEXP          0x805B  /* Stanford V Kernel exp. */
226 #define ETHERTYPE_VPROD         0x805C  /* Stanford V Kernel prod. */
227 #define ETHERTYPE_ES            0x805D  /* Evans & Sutherland */
228 #define ETHERTYPE_LITTLE        0x8060  /* Little Machines */
229 #define ETHERTYPE_COUNTERPOINT  0x8062  /* Counterpoint Computers */
230                     /* 0x8065 - 0x8066     Univ. of Mass @ Amherst */
231 #define ETHERTYPE_VEECO         0x8067  /* Veeco Integrated Auto. */
232 #define ETHERTYPE_GENDYN        0x8068  /* General Dynamics */
233 #define ETHERTYPE_ATT           0x8069  /* AT&T */
234 #define ETHERTYPE_AUTOPHON      0x806A  /* Autophon */
235 #define ETHERTYPE_COMDESIGN     0x806C  /* ComDesign */
236 #define ETHERTYPE_COMPUGRAPHIC  0x806D  /* Compugraphic Corporation */
237                     /* 0x806E - 0x8077     Landmark Graphics Corp. */
238 #define ETHERTYPE_MATRA         0x807A  /* Matra */
239 #define ETHERTYPE_DDE           0x807B  /* Dansk Data Elektronik */
240 #define ETHERTYPE_MERIT         0x807C  /* Merit Internodal (or Univ of Michigan?) */
241                     /* 0x807D - 0x807F     Vitalink Communications */
242 #define ETHERTYPE_VLTLMAN       0x8080  /* Vitalink TransLAN III Management */
243                     /* 0x8081 - 0x8083     Counterpoint Computers */
244                     /* 0x8088 - 0x808A     Xyplex */
245 #define ETHERTYPE_ATALK         0x809B  /* AppleTalk */
246 #define ETHERTYPE_AT            ETHERTYPE_ATALK         /* old NetBSD */
247 #define ETHERTYPE_APPLETALK     ETHERTYPE_ATALK         /* HP-UX */
248                     /* 0x809C - 0x809E     Datability */
249 #define ETHERTYPE_SPIDER        0x809F  /* Spider Systems Ltd. */
250                              /* 0x80A3     Nixdorf */
251                     /* 0x80A4 - 0x80B3     Siemens Gammasonics Inc. */
252                     /* 0x80C0 - 0x80C3     DCA (Digital Comm. Assoc.) Data Exchange Cluster */
253                     /* 0x80C4 - 0x80C5     Banyan Systems */
254 #define ETHERTYPE_PACER         0x80C6  /* Pacer Software */
255 #define ETHERTYPE_APPLITEK      0x80C7  /* Applitek Corporation */
256                     /* 0x80C8 - 0x80CC     Intergraph Corporation */
257                     /* 0x80CD - 0x80CE     Harris Corporation */
258                     /* 0x80CF - 0x80D2     Taylor Instrument */
259                     /* 0x80D3 - 0x80D4     Rosemount Corporation */
260 #define ETHERTYPE_SNA           0x80D5  /* IBM SNA Services over Ethernet */
261 #define ETHERTYPE_VARIAN        0x80DD  /* Varian Associates */
262                     /* 0x80DE - 0x80DF     TRFS (Integrated Solutions Transparent Remote File System) */
263                     /* 0x80E0 - 0x80E3     Allen-Bradley */
264                     /* 0x80E4 - 0x80F0     Datability */
265 #define ETHERTYPE_RETIX         0x80F2  /* Retix */
266 #define ETHERTYPE_AARP          0x80F3  /* AppleTalk AARP */
267                     /* 0x80F4 - 0x80F5     Kinetics */
268 #define ETHERTYPE_APOLLO        0x80F7  /* Apollo Computer */
269 #define ETHERTYPE_VLAN          0x8100  /* IEEE 802.1Q VLAN tagging (XXX conflicts) */
270                     /* 0x80FF - 0x8101     Wellfleet Communications (XXX conflicts) */
271 #define ETHERTYPE_BOFL          0x8102  /* Wellfleet; BOFL (Breath OF Life) pkts [every 5-10 secs.] */
272 #define ETHERTYPE_WELLFLEET     0x8103  /* Wellfleet Communications */
273                     /* 0x8107 - 0x8109     Symbolics Private */
274 #define ETHERTYPE_TALARIS       0x812B  /* Talaris */
275 #define ETHERTYPE_WATERLOO      0x8130  /* Waterloo Microsystems Inc. (XXX which?) */
276 #define ETHERTYPE_HAYES         0x8130  /* Hayes Microcomputers (XXX which?) */
277 #define ETHERTYPE_VGLAB         0x8131  /* VG Laboratory Systems */
278                     /* 0x8132 - 0x8137     Bridge Communications */
279 #define ETHERTYPE_IPX           0x8137  /* Novell (old) NetWare IPX (ECONFIG E option) */
280 #define ETHERTYPE_NOVELL        0x8138  /* Novell, Inc. */
281                     /* 0x8139 - 0x813D     KTI */
282 #define ETHERTYPE_MUMPS         0x813F  /* M/MUMPS data sharing */
283 #define ETHERTYPE_AMOEBA        0x8145  /* Vrije Universiteit (NL) Amoeba 4 RPC (obsolete) */
284 #define ETHERTYPE_FLIP          0x8146  /* Vrije Universiteit (NL) FLIP (Fast Local Internet Protocol) */
285 #define ETHERTYPE_VURESERVED    0x8147  /* Vrije Universiteit (NL) [reserved] */
286 #define ETHERTYPE_LOGICRAFT     0x8148  /* Logicraft */
287 #define ETHERTYPE_NCD           0x8149  /* Network Computing Devices */
288 #define ETHERTYPE_ALPHA         0x814A  /* Alpha Micro */
289 #define ETHERTYPE_SNMP          0x814C  /* SNMP over Ethernet (see RFC1089) */
290                     /* 0x814D - 0x814E     BIIN */
291 #define ETHERTYPE_TEC   0x814F  /* Technically Elite Concepts */
292 #define ETHERTYPE_RATIONAL      0x8150  /* Rational Corp */
293                     /* 0x8151 - 0x8153     Qualcomm */
294                     /* 0x815C - 0x815E     Computer Protocol Pty Ltd */
295                     /* 0x8164 - 0x8166     Charles River Data Systems */
296 #define ETHERTYPE_XTP           0x817D  /* Protocol Engines XTP */
297 #define ETHERTYPE_SGITW         0x817E  /* SGI/Time Warner prop. */
298 #define ETHERTYPE_HIPPI_FP      0x8180  /* HIPPI-FP encapsulation */
299 #define ETHERTYPE_STP           0x8181  /* Scheduled Transfer STP, HIPPI-ST */
300                     /* 0x8182 - 0x8183     Reserved for HIPPI-6400 */
301                     /* 0x8184 - 0x818C     SGI prop. */
302 #define ETHERTYPE_MOTOROLA      0x818D  /* Motorola */
303 #define ETHERTYPE_NETBEUI       0x8191  /* PowerLAN NetBIOS/NetBEUI (PC) */
304                     /* 0x819A - 0x81A3     RAD Network Devices */
305                     /* 0x81B7 - 0x81B9     Xyplex */
306                     /* 0x81CC - 0x81D5     Apricot Computers */
307                     /* 0x81D6 - 0x81DD     Artisoft Lantastic */
308                     /* 0x81E6 - 0x81EF     Polygon */
309                     /* 0x81F0 - 0x81F2     Comsat Labs */
310                     /* 0x81F3 - 0x81F5     SAIC */
311                     /* 0x81F6 - 0x81F8     VG Analytical */
312                     /* 0x8203 - 0x8205     QNX Software Systems Ltd. */
313                     /* 0x8221 - 0x8222     Ascom Banking Systems */
314                     /* 0x823E - 0x8240     Advanced Encryption Systems */
315                     /* 0x8263 - 0x826A     Charles River Data Systems */
316                     /* 0x827F - 0x8282     Athena Programming */
317                     /* 0x829A - 0x829B     Inst Ind Info Tech */
318                     /* 0x829C - 0x82AB     Taurus Controls */
319                     /* 0x82AC - 0x8693     Walker Richer & Quinn */
320 #define ETHERTYPE_ACCTON        0x8390  /* Accton Technologies (unregistered) */
321 #define ETHERTYPE_TALARISMC     0x852B  /* Talaris multicast */
322 #define ETHERTYPE_KALPANA       0x8582  /* Kalpana */
323                     /* 0x8694 - 0x869D     Idea Courier */
324                     /* 0x869E - 0x86A1     Computer Network Tech */
325                     /* 0x86A3 - 0x86AC     Gateway Communications */
326 #define ETHERTYPE_SECTRA        0x86DB  /* SECTRA */
327 #define ETHERTYPE_IPV6          0x86DD  /* IP protocol version 6 */
328 #define ETHERTYPE_DELTACON      0x86DE  /* Delta Controls */
329 #define ETHERTYPE_ATOMIC        0x86DF  /* ATOMIC */
330                     /* 0x86E0 - 0x86EF     Landis & Gyr Powers */
331                     /* 0x8700 - 0x8710     Motorola */
332 #define ETHERTYPE_RDP           0x8739  /* Control Technology Inc. RDP Without IP */
333 #define ETHERTYPE_MICP          0x873A  /* Control Technology Inc. Mcast Industrial Ctrl Proto. */
334                     /* 0x873B - 0x873C     Control Technology Inc. Proprietary */
335 #define ETHERTYPE_TCPCOMP       0x876B  /* TCP/IP Compression (RFC1701) */
336 #define ETHERTYPE_IPAS          0x876C  /* IP Autonomous Systems (RFC1701) */
337 #define ETHERTYPE_SECUREDATA    0x876D  /* Secure Data (RFC1701) */
338 #define ETHERTYPE_FLOWCONTROL   0x8808  /* 802.3x flow control packet */
339 #define ETHERTYPE_SLOW          0x8809  /* 802.3ad link aggregation (LACP) */
340 #define ETHERTYPE_PPP           0x880B  /* PPP (obsolete by PPPoE) */
341 #define ETHERTYPE_HITACHI       0x8820  /* Hitachi Cable (Optoelectronic Systems Laboratory) */
342 #define ETHERTYPE_TEST          0x8822  /* Network Conformance Testing */
343 #define ETHERTYPE_MPLS          0x8847  /* MPLS Unicast */
344 #define ETHERTYPE_MPLS_MCAST    0x8848  /* MPLS Multicast */
345 #define ETHERTYPE_AXIS          0x8856  /* Axis Communications AB proprietary bootstrap/config */
346 #define ETHERTYPE_PPPOEDISC     0x8863  /* PPP Over Ethernet Discovery Stage */
347 #define ETHERTYPE_PPPOE         0x8864  /* PPP Over Ethernet Session Stage */
348 #define ETHERTYPE_LANPROBE      0x8888  /* HP LanProbe test? */
349 #define ETHERTYPE_PAE           0x888e  /* EAPOL PAE/802.1x */
350 #define ETHERTYPE_QINQ          0x88A8  /* 802.1ad VLAN stacking */
351 #define ETHERTYPE_LOOPBACK      0x9000  /* Loopback: used to test interfaces */
352 #define ETHERTYPE_8021Q9100     0x9100  /* IEEE 802.1Q stacking (proprietary) */
353 #define ETHERTYPE_LBACK         ETHERTYPE_LOOPBACK      /* DEC MOP loopback */
354 #define ETHERTYPE_XNSSM         0x9001  /* 3Com (Formerly Bridge Communications), XNS Systems Management */
355 #define ETHERTYPE_TCPSM         0x9002  /* 3Com (Formerly Bridge Communications), TCP/IP Systems Management */
356 #define ETHERTYPE_BCLOOP        0x9003  /* 3Com (Formerly Bridge Communications), loopback detection */
357 #define ETHERTYPE_8021Q9200     0x9200  /* IEEE 802.1Q stacking (proprietary) */
358 #define ETHERTYPE_8021Q9300     0x9300  /* IEEE 802.1Q stacking (proprietary) */
359 #define ETHERTYPE_DEBNI         0xAAAA  /* DECNET? Used by VAX 6220 DEBNI */
360 #define ETHERTYPE_SONIX         0xFAF5  /* Sonix Arpeggio */
361 #define ETHERTYPE_VITAL         0xFF00  /* BBN VITAL-LanBridge cache wakeups */
362                     /* 0xFF00 - 0xFFOF     ISC Bunker Ramo */
363
364 #define ETHERTYPE_MAX           0xFFFF  /* Maximum valid ethernet type, reserved */
365
366 /*
367  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
368  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
369  * by an ETHER type (as given above) and then the (variable-length) header.
370  */
371 #define ETHERTYPE_TRAIL         0x1000          /* Trailer packet */
372 #define ETHERTYPE_NTRAILER      16
373
374 #define ETHERMTU        (ETHER_MAX_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
375 #define ETHERMIN        (ETHER_MIN_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
376 #define ETHERMTU_JUMBO  (ETHER_MAX_LEN_JUMBO - ETHER_HDR_LEN - ETHER_CRC_LEN)
377 /*
378  * The ETHER_BPF_MTAP macro should be used by drivers which support hardware
379  * offload for VLAN tag processing.  It will check the mbuf to see if it has
380  * M_VLANTAG set, and if it does, will pass the packet along to
381  * ether_vlan_mtap.  This function will re-insert VLAN tags for the duration
382  * of the tap, so they show up properly for network analyzers.
383  */
384 #define ETHER_BPF_MTAP(_ifp, _m) do {                                   \
385         if (bpf_peers_present((_ifp)->if_bpf)) {                        \
386                 M_ASSERTVALID(_m);                                      \
387                 if (((_m)->m_flags & M_VLANTAG) != 0)                   \
388                         ether_vlan_mtap((_ifp)->if_bpf, (_m), NULL, 0); \
389                 else                                                    \
390                         bpf_mtap((_ifp)->if_bpf, (_m));                 \
391         }                                                               \
392 } while (0)
393
394 /*
395  * Names for 802.1q priorities ("802.1p").  Notice that in this scheme,
396  * (0 < 1), allowing default 0-tagged traffic to take priority over background
397  * tagged traffic.
398  */
399 #define IEEE8021Q_PCP_BK        1       /* Background (lowest) */
400 #define IEEE8021Q_PCP_BE        0       /* Best effort (default) */
401 #define IEEE8021Q_PCP_EE        2       /* Excellent effort */
402 #define IEEE8021Q_PCP_CA        3       /* Critical applications */
403 #define IEEE8021Q_PCP_VI        4       /* Video, < 100ms latency */
404 #define IEEE8021Q_PCP_VO        5       /* Video, < 10ms latency */
405 #define IEEE8021Q_PCP_IC        6       /* Internetwork control */
406 #define IEEE8021Q_PCP_NC        7       /* Network control (highest) */
407
408 #ifdef _KERNEL
409
410 #include <sys/_eventhandler.h>
411
412 struct ifnet;
413 struct mbuf;
414 struct route;
415 struct sockaddr;
416 struct bpf_if;
417
418 extern  uint32_t ether_crc32_le(const uint8_t *, size_t);
419 extern  uint32_t ether_crc32_be(const uint8_t *, size_t);
420 extern  void ether_demux(struct ifnet *, struct mbuf *);
421 extern  void ether_ifattach(struct ifnet *, const u_int8_t *);
422 extern  void ether_ifdetach(struct ifnet *);
423 extern  int  ether_ioctl(struct ifnet *, u_long, caddr_t);
424 extern  int  ether_output(struct ifnet *, struct mbuf *,
425             const struct sockaddr *, struct route *);
426 extern  int  ether_output_frame(struct ifnet *, struct mbuf *);
427 extern  char *ether_sprintf(const u_int8_t *);
428 void    ether_vlan_mtap(struct bpf_if *, struct mbuf *,
429             void *, u_int);
430 struct mbuf  *ether_vlanencap(struct mbuf *, uint16_t);
431 bool    ether_8021q_frame(struct mbuf **mp, struct ifnet *ife, struct ifnet *p,
432             uint16_t vid, uint8_t pcp);
433 void    ether_gen_addr(struct ifnet *ifp, struct ether_addr *hwaddr);
434
435 /* new ethernet interface attached event */
436 typedef void (*ether_ifattach_event_handler_t)(void *, struct ifnet *);
437 EVENTHANDLER_DECLARE(ether_ifattach_event, ether_ifattach_event_handler_t);
438
439 #else /* _KERNEL */
440
441 #include <sys/cdefs.h>
442
443 /*
444  * Ethernet address conversion/parsing routines.
445  */
446 __BEGIN_DECLS
447 struct  ether_addr *ether_aton(const char *);
448 struct  ether_addr *ether_aton_r(const char *, struct ether_addr *);
449 int     ether_hostton(const char *, struct ether_addr *);
450 int     ether_line(const char *, struct ether_addr *, char *);
451 char    *ether_ntoa(const struct ether_addr *);
452 char    *ether_ntoa_r(const struct ether_addr *, char *);
453 int     ether_ntohost(char *, const struct ether_addr *);
454 __END_DECLS
455
456 #endif /* !_KERNEL */
457
458 #endif /* !_NET_ETHERNET_H_ */