1 | /* |
2 | * Copyright (c) 2000-2017 Apple Inc. All rights reserved. |
3 | * |
4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ |
5 | * |
6 | * This file contains Original Code and/or Modifications of Original Code |
7 | * as defined in and that are subject to the Apple Public Source License |
8 | * Version 2.0 (the 'License'). You may not use this file except in |
9 | * compliance with the License. The rights granted to you under the License |
10 | * may not be used to create, or enable the creation or redistribution of, |
11 | * unlawful or unlicensed copies of an Apple operating system, or to |
12 | * circumvent, violate, or enable the circumvention or violation of, any |
13 | * terms of an Apple operating system software license agreement. |
14 | * |
15 | * Please obtain a copy of the License at |
16 | * http://www.opensource.apple.com/apsl/ and read it before using this file. |
17 | * |
18 | * The Original Code and all software distributed under the License are |
19 | * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER |
20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, |
21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, |
22 | * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. |
23 | * Please see the License for the specific language governing rights and |
24 | * limitations under the License. |
25 | * |
26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ |
27 | */ |
28 | /* |
29 | * Fundamental constants relating to ethernet. |
30 | * |
31 | */ |
32 | |
33 | #ifndef _NET_ETHERNET_H_ |
34 | #define _NET_ETHERNET_H_ |
35 | #ifndef DRIVERKIT |
36 | #include <sys/appleapiopts.h> |
37 | #include <sys/types.h> /* u_ types */ |
38 | #else |
39 | #include <sys/_types.h> |
40 | #include <sys/_types/_u_char.h> |
41 | #include <sys/_types/_u_short.h> |
42 | #endif /* DRIVERKIT */ |
43 | |
44 | /* |
45 | * The number of bytes in an ethernet (MAC) address. |
46 | */ |
47 | #define ETHER_ADDR_LEN 6 |
48 | |
49 | /* |
50 | * The number of bytes in the type field. |
51 | */ |
52 | #define ETHER_TYPE_LEN 2 |
53 | |
54 | /* |
55 | * The number of bytes in the trailing CRC field. |
56 | */ |
57 | #define ETHER_CRC_LEN 4 |
58 | |
59 | /* |
60 | * The length of the combined header. |
61 | */ |
62 | #define ETHER_HDR_LEN (ETHER_ADDR_LEN*2+ETHER_TYPE_LEN) |
63 | |
64 | /* |
65 | * The minimum packet length. |
66 | */ |
67 | #define ETHER_MIN_LEN 64 |
68 | |
69 | /* |
70 | * The maximum packet length. |
71 | */ |
72 | #define ETHER_MAX_LEN 1518 |
73 | |
74 | /* |
75 | * Mbuf adjust factor to force 32-bit alignment of IP header. |
76 | * Drivers should do m_adj(m, ETHER_ALIGN) when setting up a |
77 | * receive so the upper layers get the IP header properly aligned |
78 | * past the 14-byte Ethernet header. |
79 | */ |
80 | #define ETHER_ALIGN 2 /* driver adjust for IP hdr alignment */ |
81 | |
82 | /* |
83 | * A macro to validate a length with |
84 | */ |
85 | #define ETHER_IS_VALID_LEN(foo) \ |
86 | ((foo) >= ETHER_MIN_LEN && (foo) <= ETHER_MAX_LEN) |
87 | |
88 | /* |
89 | * Structure of a 10Mb/s Ethernet header. |
90 | */ |
91 | typedef struct { |
92 | u_char [ETHER_ADDR_LEN]; |
93 | u_char [ETHER_ADDR_LEN]; |
94 | u_short ; |
95 | } ; |
96 | |
97 | /* |
98 | * Structure of a 48-bit Ethernet address. |
99 | */ |
100 | typedef struct ether_addr { |
101 | u_char octet[ETHER_ADDR_LEN]; |
102 | } ether_addr_t; |
103 | |
104 | #define ether_addr_octet octet |
105 | |
106 | #define ETHERTYPE_PUP 0x0200 /* PUP protocol */ |
107 | #define ETHERTYPE_IP 0x0800 /* IP protocol */ |
108 | #define ETHERTYPE_ARP 0x0806 /* Addr. resolution protocol */ |
109 | #define ETHERTYPE_REVARP 0x8035 /* reverse Addr. resolution protocol */ |
110 | #define ETHERTYPE_VLAN 0x8100 /* IEEE 802.1Q VLAN tagging */ |
111 | #define ETHERTYPE_IPV6 0x86dd /* IPv6 */ |
112 | #define ETHERTYPE_PAE 0x888e /* EAPOL PAE/802.1x */ |
113 | #define ETHERTYPE_RSN_PREAUTH 0x88c7 /* 802.11i / RSN Pre-Authentication */ |
114 | #define ETHERTYPE_PTP 0x88f7 /* IEEE 1588 Precision Time Protocol */ |
115 | #define ETHERTYPE_LOOPBACK 0x9000 /* used to test interfaces */ |
116 | /* XXX - add more useful types here */ |
117 | |
118 | /* |
119 | * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have |
120 | * (type-ETHERTYPE_TRAIL)*512 bytes of data followed |
121 | * by an ETHER type (as given above) and then the (variable-length) header. |
122 | */ |
123 | #define ETHERTYPE_TRAIL 0x1000 /* Trailer packet */ |
124 | #define ETHERTYPE_NTRAILER 16 |
125 | |
126 | #define ETHERMTU (ETHER_MAX_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN) |
127 | #define ETHERMIN (ETHER_MIN_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN) |
128 | |
129 | #ifndef DRIVERKIT |
130 | #ifdef KERNEL_PRIVATE |
131 | /* |
132 | * The following are used by ethernet interfaces. |
133 | */ |
134 | |
135 | struct ether_addr *ether_aton(const char *); |
136 | |
137 | #ifdef BSD_KERNEL_PRIVATE |
138 | extern u_char etherbroadcastaddr[ETHER_ADDR_LEN]; |
139 | |
140 | #if defined (__arm__) |
141 | |
142 | #include <string.h> |
143 | |
144 | static __inline__ int |
145 | _ether_cmp(const void * a, const void * b) |
146 | { |
147 | return memcmp(a, b, ETHER_ADDR_LEN); |
148 | } |
149 | |
150 | #else /* __arm__ */ |
151 | |
152 | static __inline__ int |
153 | _ether_cmp(const void * a, const void * b) |
154 | { |
155 | const u_int16_t * a_s = (const u_int16_t *)a; |
156 | const u_int16_t * b_s = (const u_int16_t *)b; |
157 | |
158 | if (a_s[0] != b_s[0] |
159 | || a_s[1] != b_s[1] |
160 | || a_s[2] != b_s[2]) { |
161 | return 1; |
162 | } |
163 | return 0; |
164 | } |
165 | |
166 | #endif /* __arm__ */ |
167 | #endif /* BSD_KERNEL_PRIVATE */ |
168 | |
169 | #define ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */ |
170 | |
171 | #endif /* KERNEL_PRIVATE */ |
172 | |
173 | #ifndef KERNEL |
174 | #include <sys/cdefs.h> |
175 | |
176 | /* |
177 | * Ethernet address conversion/parsing routines. |
178 | */ |
179 | __BEGIN_DECLS |
180 | |
181 | int ether_hostton(const char *, struct ether_addr *); |
182 | int ether_line(const char *, struct ether_addr *, char *); |
183 | char *ether_ntoa(const struct ether_addr *); |
184 | struct ether_addr *ether_aton(const char *); |
185 | int ether_ntohost(char *, const struct ether_addr *); |
186 | __END_DECLS |
187 | #endif /* !KERNEL */ |
188 | #endif /* DRIVERKIT */ |
189 | |
190 | #endif /* !_NET_ETHERNET_H_ */ |
191 | |