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