]>
Commit | Line | Data |
---|---|---|
97b38d4e | 1 | /** @file\r |
1204fe83 | 2 | This library is only intended to be used by UEFI network stack modules.\r |
e9b67286 | 3 | It provides basic functions for the UEFI network stack.\r |
97b38d4e | 4 | \r |
a57cdf33 | 5 | Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r |
cd5ebaa0 | 6 | This program and the accompanying materials\r |
97b38d4e | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
64a80549 | 8 | which accompanies this distribution. The full text of the license may be found at<BR>\r |
97b38d4e | 9 | http://opensource.org/licenses/bsd-license.php\r |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef _NET_LIB_H_\r | |
17 | #define _NET_LIB_H_\r | |
18 | \r | |
fb115c61 | 19 | #include <Protocol/Ip6.h>\r |
20 | \r | |
1204fe83 | 21 | #include <Library/BaseLib.h>\r |
7b126c2e | 22 | #include <Library/BaseMemoryLib.h>\r |
1204fe83 | 23 | \r |
97b38d4e | 24 | typedef UINT32 IP4_ADDR;\r |
25 | typedef UINT32 TCP_SEQNO;\r | |
26 | typedef UINT16 TCP_PORTNO;\r | |
27 | \r | |
b45b45b2 | 28 | \r |
29 | #define NET_ETHER_ADDR_LEN 6\r | |
30 | #define NET_IFTYPE_ETHERNET 0x01\r | |
31 | \r | |
779ae357 | 32 | #define NET_VLAN_TAG_LEN 4\r |
33 | #define ETHER_TYPE_VLAN 0x8100\r | |
34 | \r | |
b45b45b2 | 35 | #define EFI_IP_PROTO_UDP 0x11\r |
36 | #define EFI_IP_PROTO_TCP 0x06\r | |
37 | #define EFI_IP_PROTO_ICMP 0x01\r | |
f6b7393c | 38 | #define IP4_PROTO_IGMP 0x02\r |
39 | #define IP6_ICMP 58\r | |
dba6e9a9 JW |
40 | #define DNS_MAX_NAME_SIZE 255\r |
41 | #define DNS_MAX_MESSAGE_SIZE 512\r | |
b45b45b2 | 42 | \r |
43 | //\r | |
44 | // The address classification\r | |
45 | //\r | |
46 | #define IP4_ADDR_CLASSA 1\r | |
47 | #define IP4_ADDR_CLASSB 2\r | |
48 | #define IP4_ADDR_CLASSC 3\r | |
49 | #define IP4_ADDR_CLASSD 4\r | |
50 | #define IP4_ADDR_CLASSE 5\r | |
51 | \r | |
52 | #define IP4_MASK_NUM 33\r | |
f6b7393c | 53 | #define IP6_PREFIX_NUM 129\r |
b45b45b2 | 54 | \r |
55 | #define IP6_HOP_BY_HOP 0\r | |
56 | #define IP6_DESTINATION 60\r | |
25400c63 | 57 | #define IP6_ROUTING 43\r |
b45b45b2 | 58 | #define IP6_FRAGMENT 44\r |
59 | #define IP6_AH 51\r | |
60 | #define IP6_ESP 50\r | |
61 | #define IP6_NO_NEXT_HEADER 59\r | |
62 | \r | |
a1503a32 | 63 | #define IP_VERSION_4 4\r |
64 | #define IP_VERSION_6 6\r | |
fb115c61 | 65 | \r |
501793fa RN |
66 | #define IP6_PREFIX_LENGTH 64\r |
67 | \r | |
a57cdf33 JW |
68 | //\r |
69 | // DNS QTYPE values\r | |
70 | //\r | |
71 | #define DNS_TYPE_A 1\r | |
72 | #define DNS_TYPE_NS 2\r | |
73 | #define DNS_TYPE_CNAME 5\r | |
74 | #define DNS_TYPE_SOA 6\r | |
75 | #define DNS_TYPE_WKS 11\r | |
76 | #define DNS_TYPE_PTR 12\r | |
77 | #define DNS_TYPE_HINFO 13\r | |
78 | #define DNS_TYPE_MINFO 14\r | |
79 | #define DNS_TYPE_MX 15\r | |
80 | #define DNS_TYPE_TXT 16\r | |
81 | #define DNS_TYPE_AAAA 28\r | |
82 | #define DNS_TYPE_SRV_RR 33\r | |
83 | #define DNS_TYPE_AXFR 252\r | |
84 | #define DNS_TYPE_MAILB 253\r | |
85 | #define DNS_TYPE_ANY 255\r | |
86 | \r | |
87 | //\r | |
88 | // DNS QCLASS values\r | |
89 | //\r | |
90 | #define DNS_CLASS_INET 1\r | |
91 | #define DNS_CLASS_CH 3\r | |
92 | #define DNS_CLASS_HS 4\r | |
93 | #define DNS_CLASS_ANY 255\r | |
94 | \r | |
97b38d4e | 95 | #pragma pack(1)\r |
96 | \r | |
97 | //\r | |
98 | // Ethernet head definition\r | |
99 | //\r | |
100 | typedef struct {\r | |
101 | UINT8 DstMac [NET_ETHER_ADDR_LEN];\r | |
102 | UINT8 SrcMac [NET_ETHER_ADDR_LEN];\r | |
103 | UINT16 EtherType;\r | |
104 | } ETHER_HEAD;\r | |
105 | \r | |
779ae357 | 106 | //\r |
107 | // 802.1Q VLAN Tag Control Information\r | |
108 | //\r | |
109 | typedef union {\r | |
110 | struct {\r | |
111 | UINT16 Vid : 12; // Unique VLAN identifier (0 to 4094)\r | |
112 | UINT16 Cfi : 1; // Canonical Format Indicator\r | |
113 | UINT16 Priority : 3; // 802.1Q priority level (0 to 7)\r | |
114 | } Bits;\r | |
115 | UINT16 Uint16;\r | |
116 | } VLAN_TCI;\r | |
117 | \r | |
118 | #define VLAN_TCI_CFI_CANONICAL_MAC 0\r | |
119 | #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1\r | |
97b38d4e | 120 | \r |
121 | //\r | |
122 | // The EFI_IP4_HEADER is hard to use because the source and\r | |
123 | // destination address are defined as EFI_IPv4_ADDRESS, which\r | |
124 | // is a structure. Two structures can't be compared or masked\r | |
125 | // directly. This is why there is an internal representation.\r | |
126 | //\r | |
127 | typedef struct {\r | |
128 | UINT8 HeadLen : 4;\r | |
129 | UINT8 Ver : 4;\r | |
130 | UINT8 Tos;\r | |
131 | UINT16 TotalLen;\r | |
132 | UINT16 Id;\r | |
133 | UINT16 Fragment;\r | |
134 | UINT8 Ttl;\r | |
135 | UINT8 Protocol;\r | |
136 | UINT16 Checksum;\r | |
137 | IP4_ADDR Src;\r | |
138 | IP4_ADDR Dst;\r | |
139 | } IP4_HEAD;\r | |
140 | \r | |
141 | \r | |
142 | //\r | |
e9b67286 | 143 | // ICMP head definition. Each ICMP message is categorized as either an error\r |
97b38d4e | 144 | // message or query message. Two message types have their own head format.\r |
145 | //\r | |
146 | typedef struct {\r | |
147 | UINT8 Type;\r | |
148 | UINT8 Code;\r | |
149 | UINT16 Checksum;\r | |
150 | } IP4_ICMP_HEAD;\r | |
151 | \r | |
152 | typedef struct {\r | |
153 | IP4_ICMP_HEAD Head;\r | |
154 | UINT32 Fourth; // 4th filed of the head, it depends on Type.\r | |
155 | IP4_HEAD IpHead;\r | |
156 | } IP4_ICMP_ERROR_HEAD;\r | |
157 | \r | |
158 | typedef struct {\r | |
159 | IP4_ICMP_HEAD Head;\r | |
160 | UINT16 Id;\r | |
161 | UINT16 Seq;\r | |
162 | } IP4_ICMP_QUERY_HEAD;\r | |
163 | \r | |
fb115c61 | 164 | typedef struct {\r |
165 | UINT8 Type;\r | |
166 | UINT8 Code;\r | |
167 | UINT16 Checksum;\r | |
168 | } IP6_ICMP_HEAD;\r | |
169 | \r | |
170 | typedef struct {\r | |
171 | IP6_ICMP_HEAD Head;\r | |
172 | UINT32 Fourth;\r | |
173 | EFI_IP6_HEADER IpHead;\r | |
174 | } IP6_ICMP_ERROR_HEAD;\r | |
175 | \r | |
176 | typedef struct {\r | |
177 | IP6_ICMP_HEAD Head;\r | |
178 | UINT32 Fourth;\r | |
179 | } IP6_ICMP_INFORMATION_HEAD;\r | |
97b38d4e | 180 | \r |
181 | //\r | |
182 | // UDP header definition\r | |
183 | //\r | |
184 | typedef struct {\r | |
185 | UINT16 SrcPort;\r | |
186 | UINT16 DstPort;\r | |
187 | UINT16 Length;\r | |
188 | UINT16 Checksum;\r | |
fb115c61 | 189 | } EFI_UDP_HEADER;\r |
97b38d4e | 190 | \r |
191 | //\r | |
192 | // TCP header definition\r | |
193 | //\r | |
194 | typedef struct {\r | |
195 | TCP_PORTNO SrcPort;\r | |
196 | TCP_PORTNO DstPort;\r | |
197 | TCP_SEQNO Seq;\r | |
198 | TCP_SEQNO Ack;\r | |
199 | UINT8 Res : 4;\r | |
200 | UINT8 HeadLen : 4;\r | |
201 | UINT8 Flag;\r | |
202 | UINT16 Wnd;\r | |
203 | UINT16 Checksum;\r | |
204 | UINT16 Urg;\r | |
205 | } TCP_HEAD;\r | |
206 | \r | |
207 | #pragma pack()\r | |
208 | \r | |
209 | #define NET_MAC_EQUAL(pMac1, pMac2, Len) \\r | |
210 | (CompareMem ((pMac1), (pMac2), Len) == 0)\r | |
211 | \r | |
212 | #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \\r | |
213 | (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))\r | |
214 | \r | |
1204fe83 | 215 | #define NTOHL(x) SwapBytes32 (x)\r |
97b38d4e | 216 | \r |
217 | #define HTONL(x) NTOHL(x)\r | |
218 | \r | |
1204fe83 | 219 | #define NTOHS(x) SwapBytes16 (x)\r |
97b38d4e | 220 | \r |
f6b7393c | 221 | #define HTONS(x) NTOHS(x)\r |
222 | #define NTOHLL(x) SwapBytes64 (x)\r | |
223 | #define HTONLL(x) NTOHLL(x)\r | |
224 | #define NTOHLLL(x) Ip6Swap128 (x)\r | |
225 | #define HTONLLL(x) NTOHLLL(x)\r | |
97b38d4e | 226 | \r |
227 | //\r | |
228 | // Test the IP's attribute, All the IPs are in host byte order.\r | |
229 | //\r | |
230 | #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)\r | |
231 | #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)\r | |
232 | #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))\r | |
233 | #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)\r | |
234 | \r | |
3a15fd52 | 235 | #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)\r |
236 | \r | |
97b38d4e | 237 | //\r |
238 | // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.\r | |
239 | //\r | |
240 | #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))\r | |
241 | #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))\r | |
242 | #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)\r | |
243 | \r | |
fb115c61 | 244 | #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)\r |
245 | \r | |
42372879 | 246 | #define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))\r |
f6b7393c | 247 | #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))\r |
248 | #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))\r | |
249 | \r | |
250 | //\r | |
1204fe83 | 251 | // The debug level definition. This value is also used as the\r |
252 | // syslog's servity level. Don't change it.\r | |
f6b7393c | 253 | //\r |
254 | #define NETDEBUG_LEVEL_TRACE 5\r | |
255 | #define NETDEBUG_LEVEL_WARNING 4\r | |
256 | #define NETDEBUG_LEVEL_ERROR 3\r | |
257 | \r | |
258 | //\r | |
1204fe83 | 259 | // Network debug message is sent out as syslog packet.\r |
f6b7393c | 260 | //\r |
1204fe83 | 261 | #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use\r |
262 | #define NET_SYSLOG_PACKET_LEN 512\r | |
263 | #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms\r | |
264 | #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)\r | |
f6b7393c | 265 | \r |
266 | //\r | |
1204fe83 | 267 | // The debug output expects the ASCII format string, Use %a to print ASCII\r |
268 | // string, and %s to print UNICODE string. PrintArg must be enclosed in ().\r | |
f6b7393c | 269 | // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));\r |
270 | //\r | |
271 | #define NET_DEBUG_TRACE(Module, PrintArg) \\r | |
272 | NetDebugOutput ( \\r | |
273 | NETDEBUG_LEVEL_TRACE, \\r | |
274 | Module, \\r | |
275 | __FILE__, \\r | |
276 | __LINE__, \\r | |
277 | NetDebugASPrint PrintArg \\r | |
278 | )\r | |
279 | \r | |
280 | #define NET_DEBUG_WARNING(Module, PrintArg) \\r | |
281 | NetDebugOutput ( \\r | |
282 | NETDEBUG_LEVEL_WARNING, \\r | |
283 | Module, \\r | |
284 | __FILE__, \\r | |
285 | __LINE__, \\r | |
286 | NetDebugASPrint PrintArg \\r | |
287 | )\r | |
288 | \r | |
289 | #define NET_DEBUG_ERROR(Module, PrintArg) \\r | |
290 | NetDebugOutput ( \\r | |
291 | NETDEBUG_LEVEL_ERROR, \\r | |
292 | Module, \\r | |
293 | __FILE__, \\r | |
294 | __LINE__, \\r | |
295 | NetDebugASPrint PrintArg \\r | |
296 | )\r | |
297 | \r | |
298 | /**\r | |
1204fe83 | 299 | Allocate a buffer, then format the message to it. This is a\r |
300 | help function for the NET_DEBUG_XXX macros. The PrintArg of\r | |
301 | these macros treats the variable length print parameters as a\r | |
f6b7393c | 302 | single parameter, and pass it to the NetDebugASPrint. For\r |
303 | example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))\r | |
1204fe83 | 304 | if extracted to:\r |
305 | \r | |
f6b7393c | 306 | NetDebugOutput (\r |
1204fe83 | 307 | NETDEBUG_LEVEL_TRACE,\r |
308 | "Tcp",\r | |
f6b7393c | 309 | __FILE__,\r |
310 | __LINE__,\r | |
1204fe83 | 311 | NetDebugASPrint ("State transit to %a\n", Name)\r |
312 | )\r | |
313 | \r | |
f6b7393c | 314 | @param Format The ASCII format string.\r |
1204fe83 | 315 | @param ... The variable length parameter whose format is determined\r |
f6b7393c | 316 | by the Format string.\r |
317 | \r | |
318 | @return The buffer containing the formatted message,\r | |
64a80549 | 319 | or NULL if memory allocation failed.\r |
f6b7393c | 320 | \r |
321 | **/\r | |
322 | CHAR8 *\r | |
e798cd87 | 323 | EFIAPI\r |
f6b7393c | 324 | NetDebugASPrint (\r |
325 | IN CHAR8 *Format,\r | |
326 | ...\r | |
327 | );\r | |
328 | \r | |
329 | /**\r | |
330 | Builds an UDP4 syslog packet and send it using SNP.\r | |
331 | \r | |
332 | This function will locate a instance of SNP then send the message through it.\r | |
333 | Because it isn't open the SNP BY_DRIVER, apply caution when using it.\r | |
334 | \r | |
335 | @param Level The servity level of the message.\r | |
336 | @param Module The Moudle that generates the log.\r | |
337 | @param File The file that contains the log.\r | |
338 | @param Line The exact line that contains the log.\r | |
339 | @param Message The user message to log.\r | |
340 | \r | |
341 | @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r | |
342 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet\r | |
1204fe83 | 343 | @retval EFI_SUCCESS The log is discard because that it is more verbose\r |
f6b7393c | 344 | than the mNetDebugLevelMax. Or, it has been sent out.\r |
1204fe83 | 345 | **/\r |
f6b7393c | 346 | EFI_STATUS\r |
e798cd87 | 347 | EFIAPI\r |
f6b7393c | 348 | NetDebugOutput (\r |
1204fe83 | 349 | IN UINT32 Level,\r |
f6b7393c | 350 | IN UINT8 *Module,\r |
351 | IN UINT8 *File,\r | |
352 | IN UINT32 Line,\r | |
353 | IN UINT8 *Message\r | |
354 | );\r | |
355 | \r | |
fb115c61 | 356 | \r |
97b38d4e | 357 | /**\r |
1204fe83 | 358 | Return the length of the mask.\r |
359 | \r | |
e9b67286 | 360 | Return the length of the mask. Valid values are 0 to 32.\r |
3a1ab4bc | 361 | If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.\r |
97b38d4e | 362 | NetMask is in the host byte order.\r |
363 | \r | |
ae213b7d | 364 | @param[in] NetMask The netmask to get the length from.\r |
97b38d4e | 365 | \r |
e9b67286 | 366 | @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.\r |
1204fe83 | 367 | \r |
97b38d4e | 368 | **/\r |
369 | INTN\r | |
370 | EFIAPI\r | |
371 | NetGetMaskLength (\r | |
ae213b7d | 372 | IN IP4_ADDR NetMask\r |
97b38d4e | 373 | );\r |
374 | \r | |
375 | /**\r | |
3a1ab4bc | 376 | Return the class of the IP address, such as class A, B, C.\r |
97b38d4e | 377 | Addr is in host byte order.\r |
1204fe83 | 378 | \r |
3a1ab4bc | 379 | The address of class A starts with 0.\r |
380 | If the address belong to class A, return IP4_ADDR_CLASSA.\r | |
1204fe83 | 381 | The address of class B starts with 10.\r |
3a1ab4bc | 382 | If the address belong to class B, return IP4_ADDR_CLASSB.\r |
1204fe83 | 383 | The address of class C starts with 110.\r |
3a1ab4bc | 384 | If the address belong to class C, return IP4_ADDR_CLASSC.\r |
1204fe83 | 385 | The address of class D starts with 1110.\r |
3a1ab4bc | 386 | If the address belong to class D, return IP4_ADDR_CLASSD.\r |
387 | The address of class E starts with 1111.\r | |
388 | If the address belong to class E, return IP4_ADDR_CLASSE.\r | |
97b38d4e | 389 | \r |
1204fe83 | 390 | \r |
ae213b7d | 391 | @param[in] Addr The address to get the class from.\r |
97b38d4e | 392 | \r |
ae213b7d | 393 | @return IP address class, such as IP4_ADDR_CLASSA.\r |
97b38d4e | 394 | \r |
395 | **/\r | |
396 | INTN\r | |
397 | EFIAPI\r | |
398 | NetGetIpClass (\r | |
399 | IN IP4_ADDR Addr\r | |
400 | );\r | |
401 | \r | |
402 | /**\r | |
403 | Check whether the IP is a valid unicast address according to\r | |
3a1ab4bc | 404 | the netmask. If NetMask is zero, use the IP address's class to get the default mask.\r |
1204fe83 | 405 | \r |
3a1ab4bc | 406 | If Ip is 0, IP is not a valid unicast address.\r |
407 | Class D address is used for multicasting and class E address is reserved for future. If Ip\r | |
1204fe83 | 408 | belongs to class D or class E, Ip is not a valid unicast address.\r |
e9b67286 | 409 | If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.\r |
97b38d4e | 410 | \r |
ae213b7d | 411 | @param[in] Ip The IP to check against.\r |
412 | @param[in] NetMask The mask of the IP.\r | |
97b38d4e | 413 | \r |
e9b67286 | 414 | @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.\r |
97b38d4e | 415 | \r |
416 | **/\r | |
417 | BOOLEAN\r | |
ae213b7d | 418 | EFIAPI\r |
f6b7393c | 419 | NetIp4IsUnicast (\r |
97b38d4e | 420 | IN IP4_ADDR Ip,\r |
421 | IN IP4_ADDR NetMask\r | |
422 | );\r | |
423 | \r | |
fb115c61 | 424 | /**\r |
425 | Check whether the incoming IPv6 address is a valid unicast address.\r | |
426 | \r | |
427 | If the address is a multicast address has binary 0xFF at the start, it is not\r | |
428 | a valid unicast address. If the address is unspecified ::, it is not a valid\r | |
429 | unicast address to be assigned to any node. If the address is loopback address\r | |
430 | ::1, it is also not a valid unicast address to be assigned to any physical\r | |
1204fe83 | 431 | interface.\r |
fb115c61 | 432 | \r |
433 | @param[in] Ip6 The IPv6 address to check against.\r | |
434 | \r | |
435 | @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.\r | |
436 | \r | |
1204fe83 | 437 | **/\r |
fb115c61 | 438 | BOOLEAN\r |
e798cd87 | 439 | EFIAPI\r |
f6b7393c | 440 | NetIp6IsValidUnicast (\r |
441 | IN EFI_IPv6_ADDRESS *Ip6\r | |
442 | );\r | |
443 | \r | |
444 | \r | |
445 | /**\r | |
446 | Check whether the incoming Ipv6 address is the unspecified address or not.\r | |
447 | \r | |
448 | @param[in] Ip6 - Ip6 address, in network order.\r | |
449 | \r | |
64a80549 | 450 | @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.\r |
451 | @retval FALSE - The incoming Ipv6 address is not the unspecified address\r | |
1204fe83 | 452 | \r |
f6b7393c | 453 | **/\r |
454 | BOOLEAN\r | |
e798cd87 | 455 | EFIAPI\r |
f6b7393c | 456 | NetIp6IsUnspecifiedAddr (\r |
fb115c61 | 457 | IN EFI_IPv6_ADDRESS *Ip6\r |
458 | );\r | |
459 | \r | |
f6b7393c | 460 | /**\r |
461 | Check whether the incoming Ipv6 address is a link-local address.\r | |
462 | \r | |
463 | @param[in] Ip6 - Ip6 address, in network order.\r | |
464 | \r | |
64a80549 | 465 | @retval TRUE - The incoming Ipv6 address is a link-local address.\r |
466 | @retval FALSE - The incoming Ipv6 address is not a link-local address.\r | |
1204fe83 | 467 | \r |
f6b7393c | 468 | **/\r |
469 | BOOLEAN\r | |
e798cd87 | 470 | EFIAPI\r |
f6b7393c | 471 | NetIp6IsLinkLocalAddr (\r |
472 | IN EFI_IPv6_ADDRESS *Ip6\r | |
473 | );\r | |
474 | \r | |
475 | /**\r | |
476 | Check whether the Ipv6 address1 and address2 are on the connected network.\r | |
477 | \r | |
478 | @param[in] Ip1 - Ip6 address1, in network order.\r | |
479 | @param[in] Ip2 - Ip6 address2, in network order.\r | |
480 | @param[in] PrefixLength - The prefix length of the checking net.\r | |
481 | \r | |
64a80549 | 482 | @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.\r |
483 | @retval FALSE - No the Ipv6 address1 and address2 are not connected.\r | |
1204fe83 | 484 | \r |
f6b7393c | 485 | **/\r |
486 | BOOLEAN\r | |
e798cd87 | 487 | EFIAPI\r |
f6b7393c | 488 | NetIp6IsNetEqual (\r |
489 | EFI_IPv6_ADDRESS *Ip1,\r | |
490 | EFI_IPv6_ADDRESS *Ip2,\r | |
491 | UINT8 PrefixLength\r | |
492 | );\r | |
493 | \r | |
b45b45b2 | 494 | /**\r |
64a80549 | 495 | Switches the endianess of an IPv6 address.\r |
b45b45b2 | 496 | \r |
497 | This function swaps the bytes in a 128-bit IPv6 address to switch the value\r | |
498 | from little endian to big endian or vice versa. The byte swapped value is\r | |
499 | returned.\r | |
500 | \r | |
64a80549 | 501 | @param Ip6 Points to an IPv6 address.\r |
b45b45b2 | 502 | \r |
503 | @return The byte swapped IPv6 address.\r | |
504 | \r | |
505 | **/\r | |
506 | EFI_IPv6_ADDRESS *\r | |
e798cd87 | 507 | EFIAPI\r |
b45b45b2 | 508 | Ip6Swap128 (\r |
509 | EFI_IPv6_ADDRESS *Ip6\r | |
510 | );\r | |
511 | \r | |
8d7e5af1 | 512 | extern IP4_ADDR gIp4AllMasks[IP4_MASK_NUM];\r |
97b38d4e | 513 | \r |
514 | \r | |
515 | extern EFI_IPv4_ADDRESS mZeroIp4Addr;\r | |
516 | \r | |
517 | #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))\r | |
518 | #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))\r | |
519 | #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))\r | |
520 | #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))\r | |
521 | \r | |
522 | #define TICKS_PER_MS 10000U\r | |
523 | #define TICKS_PER_SECOND 10000000U\r | |
524 | \r | |
525 | #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)\r | |
526 | \r | |
527 | /**\r | |
3a1ab4bc | 528 | Extract a UINT32 from a byte stream.\r |
1204fe83 | 529 | \r |
530 | This function copies a UINT32 from a byte stream, and then converts it from Network\r | |
3a1ab4bc | 531 | byte order to host byte order. Use this function to avoid alignment error.\r |
97b38d4e | 532 | \r |
ae213b7d | 533 | @param[in] Buf The buffer to extract the UINT32.\r |
97b38d4e | 534 | \r |
535 | @return The UINT32 extracted.\r | |
536 | \r | |
537 | **/\r | |
538 | UINT32\r | |
539 | EFIAPI\r | |
540 | NetGetUint32 (\r | |
541 | IN UINT8 *Buf\r | |
542 | );\r | |
543 | \r | |
544 | /**\r | |
1204fe83 | 545 | Puts a UINT32 into the byte stream in network byte order.\r |
546 | \r | |
64a80549 | 547 | Converts a UINT32 from host byte order to network byte order, then copies it to the\r |
3a1ab4bc | 548 | byte stream.\r |
97b38d4e | 549 | \r |
64a80549 | 550 | @param[in, out] Buf The buffer in which to put the UINT32.\r |
3b1464d5 | 551 | @param[in] Data The data to be converted and put into the byte stream.\r |
1204fe83 | 552 | \r |
97b38d4e | 553 | **/\r |
554 | VOID\r | |
555 | EFIAPI\r | |
556 | NetPutUint32 (\r | |
ae213b7d | 557 | IN OUT UINT8 *Buf,\r |
558 | IN UINT32 Data\r | |
97b38d4e | 559 | );\r |
560 | \r | |
561 | /**\r | |
2bd25290 | 562 | Initialize a random seed using current time and monotonic count.\r |
1204fe83 | 563 | \r |
2bd25290 FS |
564 | Get current time and monotonic count first. Then initialize a random seed \r |
565 | based on some basic mathematics operation on the hour, day, minute, second,\r | |
566 | nanosecond and year of the current time and the monotonic count value.\r | |
1204fe83 | 567 | \r |
2bd25290 | 568 | @return The random seed initialized with current time.\r |
97b38d4e | 569 | \r |
570 | **/\r | |
571 | UINT32\r | |
572 | EFIAPI\r | |
573 | NetRandomInitSeed (\r | |
574 | VOID\r | |
575 | );\r | |
576 | \r | |
577 | \r | |
578 | #define NET_LIST_USER_STRUCT(Entry, Type, Field) \\r | |
50d7ebad | 579 | BASE_CR(Entry, Type, Field)\r |
97b38d4e | 580 | \r |
581 | #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \\r | |
582 | CR(Entry, Type, Field, Sig)\r | |
583 | \r | |
584 | //\r | |
e9b67286 | 585 | // Iterate through the double linked list. It is NOT delete safe\r |
97b38d4e | 586 | //\r |
587 | #define NET_LIST_FOR_EACH(Entry, ListHead) \\r | |
588 | for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)\r | |
589 | \r | |
590 | //\r | |
e9b67286 | 591 | // Iterate through the double linked list. This is delete-safe.\r |
97b38d4e | 592 | // Don't touch NextEntry. Also, don't use this macro if list\r |
593 | // entries other than the Entry may be deleted when processing\r | |
594 | // the current Entry.\r | |
595 | //\r | |
596 | #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \\r | |
597 | for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \\r | |
598 | Entry != (ListHead); \\r | |
599 | Entry = NextEntry, NextEntry = Entry->ForwardLink \\r | |
600 | )\r | |
601 | \r | |
602 | //\r | |
e9b67286 | 603 | // Make sure the list isn't empty before getting the first/last record.\r |
97b38d4e | 604 | //\r |
605 | #define NET_LIST_HEAD(ListHead, Type, Field) \\r | |
606 | NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)\r | |
607 | \r | |
608 | #define NET_LIST_TAIL(ListHead, Type, Field) \\r | |
609 | NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)\r | |
610 | \r | |
611 | \r | |
612 | /**\r | |
3a1ab4bc | 613 | Remove the first node entry on the list, and return the removed node entry.\r |
1204fe83 | 614 | \r |
e9b67286 | 615 | Removes the first node entry from a doubly linked list. It is up to the caller of\r |
616 | this function to release the memory used by the first node, if that is required. On\r | |
1204fe83 | 617 | exit, the removed node is returned.\r |
3a1ab4bc | 618 | \r |
619 | If Head is NULL, then ASSERT().\r | |
620 | If Head was not initialized, then ASSERT().\r | |
621 | If PcdMaximumLinkedListLength is not zero, and the number of nodes in the\r | |
622 | linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,\r | |
1204fe83 | 623 | then ASSERT().\r |
97b38d4e | 624 | \r |
ae213b7d | 625 | @param[in, out] Head The list header.\r |
97b38d4e | 626 | \r |
3a1ab4bc | 627 | @return The first node entry that is removed from the list, NULL if the list is empty.\r |
97b38d4e | 628 | \r |
629 | **/\r | |
630 | LIST_ENTRY *\r | |
631 | EFIAPI\r | |
632 | NetListRemoveHead (\r | |
ae213b7d | 633 | IN OUT LIST_ENTRY *Head\r |
97b38d4e | 634 | );\r |
635 | \r | |
636 | /**\r | |
e9b67286 | 637 | Remove the last node entry on the list and return the removed node entry.\r |
3a1ab4bc | 638 | \r |
639 | Removes the last node entry from a doubly linked list. It is up to the caller of\r | |
e9b67286 | 640 | this function to release the memory used by the first node, if that is required. On\r |
1204fe83 | 641 | exit, the removed node is returned.\r |
97b38d4e | 642 | \r |
3a1ab4bc | 643 | If Head is NULL, then ASSERT().\r |
644 | If Head was not initialized, then ASSERT().\r | |
645 | If PcdMaximumLinkedListLength is not zero, and the number of nodes in the\r | |
646 | linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,\r | |
1204fe83 | 647 | then ASSERT().\r |
648 | \r | |
ae213b7d | 649 | @param[in, out] Head The list head.\r |
97b38d4e | 650 | \r |
3a1ab4bc | 651 | @return The last node entry that is removed from the list, NULL if the list is empty.\r |
97b38d4e | 652 | \r |
653 | **/\r | |
654 | LIST_ENTRY *\r | |
655 | EFIAPI\r | |
656 | NetListRemoveTail (\r | |
ae213b7d | 657 | IN OUT LIST_ENTRY *Head\r |
97b38d4e | 658 | );\r |
659 | \r | |
660 | /**\r | |
3a1ab4bc | 661 | Insert a new node entry after a designated node entry of a doubly linked list.\r |
1204fe83 | 662 | \r |
e9b67286 | 663 | Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry\r |
3a1ab4bc | 664 | of the doubly linked list.\r |
1204fe83 | 665 | \r |
666 | @param[in, out] PrevEntry The entry after which to insert.\r | |
ae213b7d | 667 | @param[in, out] NewEntry The new entry to insert.\r |
97b38d4e | 668 | \r |
669 | **/\r | |
670 | VOID\r | |
671 | EFIAPI\r | |
672 | NetListInsertAfter (\r | |
ae213b7d | 673 | IN OUT LIST_ENTRY *PrevEntry,\r |
674 | IN OUT LIST_ENTRY *NewEntry\r | |
97b38d4e | 675 | );\r |
676 | \r | |
677 | /**\r | |
3a1ab4bc | 678 | Insert a new node entry before a designated node entry of a doubly linked list.\r |
1204fe83 | 679 | \r |
e9b67286 | 680 | Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry\r |
3a1ab4bc | 681 | of the doubly linked list.\r |
1204fe83 | 682 | \r |
ae213b7d | 683 | @param[in, out] PostEntry The entry to insert before.\r |
684 | @param[in, out] NewEntry The new entry to insert.\r | |
97b38d4e | 685 | \r |
686 | **/\r | |
687 | VOID\r | |
688 | EFIAPI\r | |
689 | NetListInsertBefore (\r | |
ae213b7d | 690 | IN OUT LIST_ENTRY *PostEntry,\r |
691 | IN OUT LIST_ENTRY *NewEntry\r | |
97b38d4e | 692 | );\r |
693 | \r | |
216f7970 | 694 | /**\r |
695 | Callback function which provided by user to remove one node in NetDestroyLinkList process.\r | |
696 | \r | |
697 | @param[in] Entry The entry to be removed.\r | |
698 | @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r | |
699 | \r | |
700 | @retval EFI_SUCCESS The entry has been removed successfully.\r | |
701 | @retval Others Fail to remove the entry.\r | |
702 | \r | |
703 | **/\r | |
704 | typedef\r | |
705 | EFI_STATUS\r | |
706 | (EFIAPI *NET_DESTROY_LINK_LIST_CALLBACK) (\r | |
707 | IN LIST_ENTRY *Entry,\r | |
708 | IN VOID *Context OPTIONAL\r | |
1f7eb561 | 709 | );\r |
216f7970 | 710 | \r |
711 | /**\r | |
712 | Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.\r | |
713 | \r | |
714 | Destroy network children list by list traversals is not safe due to graph dependencies between nodes.\r | |
715 | This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed\r | |
716 | has been removed from the list or not.\r | |
717 | If it has been removed, then restart the traversal from the head.\r | |
718 | If it hasn't been removed, then continue with the next node directly.\r | |
719 | This function will end the iterate and return the CallBack's last return value if error happens,\r | |
720 | or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list. \r | |
721 | \r | |
722 | @param[in] List The head of the list.\r | |
723 | @param[in] CallBack Pointer to the callback function to destroy one node in the list.\r | |
724 | @param[in] Context Pointer to the callback function's context: corresponds to the\r | |
725 | parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.\r | |
726 | @param[out] ListLength The length of the link list if the function returns successfully.\r | |
727 | \r | |
728 | @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.\r | |
729 | @retval EFI_INVALID_PARAMETER The input parameter is invalid.\r | |
730 | @retval Others Return the CallBack's last return value.\r | |
731 | \r | |
732 | **/\r | |
733 | EFI_STATUS\r | |
734 | EFIAPI\r | |
735 | NetDestroyLinkList (\r | |
736 | IN LIST_ENTRY *List,\r | |
737 | IN NET_DESTROY_LINK_LIST_CALLBACK CallBack,\r | |
738 | IN VOID *Context, OPTIONAL\r | |
739 | OUT UINTN *ListLength OPTIONAL\r | |
1f7eb561 | 740 | );\r |
216f7970 | 741 | \r |
742 | /**\r | |
743 | This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.\r | |
744 | \r | |
745 | @param[in] Handle Handle to be checked.\r | |
746 | @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.\r | |
747 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r | |
748 | if NumberOfChildren is 0.\r | |
749 | \r | |
750 | @retval TURE Found the input Handle in ChildHandleBuffer.\r | |
751 | @retval FALSE Can't find the input Handle in ChildHandleBuffer.\r | |
752 | \r | |
753 | **/\r | |
754 | BOOLEAN\r | |
1f7eb561 | 755 | EFIAPI\r |
216f7970 | 756 | NetIsInHandleBuffer (\r |
757 | IN EFI_HANDLE Handle,\r | |
758 | IN UINTN NumberOfChildren,\r | |
759 | IN EFI_HANDLE *ChildHandleBuffer OPTIONAL\r | |
1f7eb561 | 760 | );\r |
97b38d4e | 761 | \r |
762 | //\r | |
763 | // Object container: EFI network stack spec defines various kinds of\r | |
764 | // tokens. The drivers can share code to manage those objects.\r | |
765 | //\r | |
766 | typedef struct {\r | |
767 | LIST_ENTRY Link;\r | |
768 | VOID *Key;\r | |
769 | VOID *Value;\r | |
770 | } NET_MAP_ITEM;\r | |
771 | \r | |
772 | typedef struct {\r | |
773 | LIST_ENTRY Used;\r | |
774 | LIST_ENTRY Recycled;\r | |
775 | UINTN Count;\r | |
776 | } NET_MAP;\r | |
777 | \r | |
778 | #define NET_MAP_INCREAMENT 64\r | |
779 | \r | |
780 | /**\r | |
781 | Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.\r | |
1204fe83 | 782 | \r |
783 | Initialize the forward and backward links of two head nodes donated by Map->Used\r | |
3a1ab4bc | 784 | and Map->Recycled of two doubly linked lists.\r |
785 | Initializes the count of the <Key, Value> pairs in the netmap to zero.\r | |
1204fe83 | 786 | \r |
3a1ab4bc | 787 | If Map is NULL, then ASSERT().\r |
788 | If the address of Map->Used is NULL, then ASSERT().\r | |
789 | If the address of Map->Recycled is NULl, then ASSERT().\r | |
1204fe83 | 790 | \r |
ae213b7d | 791 | @param[in, out] Map The netmap to initialize.\r |
97b38d4e | 792 | \r |
793 | **/\r | |
794 | VOID\r | |
795 | EFIAPI\r | |
796 | NetMapInit (\r | |
ae213b7d | 797 | IN OUT NET_MAP *Map\r |
97b38d4e | 798 | );\r |
799 | \r | |
800 | /**\r | |
801 | To clean up the netmap, that is, release allocated memories.\r | |
1204fe83 | 802 | \r |
e9b67286 | 803 | Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.\r |
3a1ab4bc | 804 | Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.\r |
e9b67286 | 805 | The number of the <Key, Value> pairs in the netmap is set to zero.\r |
1204fe83 | 806 | \r |
3a1ab4bc | 807 | If Map is NULL, then ASSERT().\r |
1204fe83 | 808 | \r |
ae213b7d | 809 | @param[in, out] Map The netmap to clean up.\r |
97b38d4e | 810 | \r |
811 | **/\r | |
812 | VOID\r | |
813 | EFIAPI\r | |
814 | NetMapClean (\r | |
ae213b7d | 815 | IN OUT NET_MAP *Map\r |
97b38d4e | 816 | );\r |
817 | \r | |
818 | /**\r | |
3a1ab4bc | 819 | Test whether the netmap is empty and return true if it is.\r |
1204fe83 | 820 | \r |
3a1ab4bc | 821 | If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.\r |
1204fe83 | 822 | \r |
3a1ab4bc | 823 | If Map is NULL, then ASSERT().\r |
1204fe83 | 824 | \r |
825 | \r | |
ae213b7d | 826 | @param[in] Map The net map to test.\r |
97b38d4e | 827 | \r |
828 | @return TRUE if the netmap is empty, otherwise FALSE.\r | |
829 | \r | |
830 | **/\r | |
831 | BOOLEAN\r | |
832 | EFIAPI\r | |
833 | NetMapIsEmpty (\r | |
834 | IN NET_MAP *Map\r | |
835 | );\r | |
836 | \r | |
837 | /**\r | |
838 | Return the number of the <Key, Value> pairs in the netmap.\r | |
839 | \r | |
ae213b7d | 840 | @param[in] Map The netmap to get the entry number.\r |
97b38d4e | 841 | \r |
842 | @return The entry number in the netmap.\r | |
843 | \r | |
844 | **/\r | |
845 | UINTN\r | |
846 | EFIAPI\r | |
847 | NetMapGetCount (\r | |
848 | IN NET_MAP *Map\r | |
849 | );\r | |
850 | \r | |
851 | /**\r | |
852 | Allocate an item to save the <Key, Value> pair to the head of the netmap.\r | |
1204fe83 | 853 | \r |
3a1ab4bc | 854 | Allocate an item to save the <Key, Value> pair and add corresponding node entry\r |
1204fe83 | 855 | to the beginning of the Used doubly linked list. The number of the <Key, Value>\r |
3a1ab4bc | 856 | pairs in the netmap increase by 1.\r |
97b38d4e | 857 | \r |
3a1ab4bc | 858 | If Map is NULL, then ASSERT().\r |
1204fe83 | 859 | \r |
ae213b7d | 860 | @param[in, out] Map The netmap to insert into.\r |
861 | @param[in] Key The user's key.\r | |
862 | @param[in] Value The user's value for the key.\r | |
97b38d4e | 863 | \r |
ae213b7d | 864 | @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.\r |
865 | @retval EFI_SUCCESS The item is inserted to the head.\r | |
97b38d4e | 866 | \r |
867 | **/\r | |
868 | EFI_STATUS\r | |
869 | EFIAPI\r | |
870 | NetMapInsertHead (\r | |
ae213b7d | 871 | IN OUT NET_MAP *Map,\r |
97b38d4e | 872 | IN VOID *Key,\r |
873 | IN VOID *Value OPTIONAL\r | |
874 | );\r | |
875 | \r | |
876 | /**\r | |
877 | Allocate an item to save the <Key, Value> pair to the tail of the netmap.\r | |
878 | \r | |
3a1ab4bc | 879 | Allocate an item to save the <Key, Value> pair and add corresponding node entry\r |
1204fe83 | 880 | to the tail of the Used doubly linked list. The number of the <Key, Value>\r |
3a1ab4bc | 881 | pairs in the netmap increase by 1.\r |
882 | \r | |
883 | If Map is NULL, then ASSERT().\r | |
1204fe83 | 884 | \r |
ae213b7d | 885 | @param[in, out] Map The netmap to insert into.\r |
886 | @param[in] Key The user's key.\r | |
887 | @param[in] Value The user's value for the key.\r | |
97b38d4e | 888 | \r |
ae213b7d | 889 | @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.\r |
890 | @retval EFI_SUCCESS The item is inserted to the tail.\r | |
97b38d4e | 891 | \r |
892 | **/\r | |
893 | EFI_STATUS\r | |
894 | EFIAPI\r | |
895 | NetMapInsertTail (\r | |
ae213b7d | 896 | IN OUT NET_MAP *Map,\r |
97b38d4e | 897 | IN VOID *Key,\r |
898 | IN VOID *Value OPTIONAL\r | |
899 | );\r | |
900 | \r | |
901 | /**\r | |
e9b67286 | 902 | Finds the key in the netmap and returns the point to the item containing the Key.\r |
1204fe83 | 903 | \r |
904 | Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every\r | |
3a1ab4bc | 905 | item with the key to search. It returns the point to the item contains the Key if found.\r |
97b38d4e | 906 | \r |
3a1ab4bc | 907 | If Map is NULL, then ASSERT().\r |
1204fe83 | 908 | \r |
ae213b7d | 909 | @param[in] Map The netmap to search within.\r |
910 | @param[in] Key The key to search.\r | |
97b38d4e | 911 | \r |
912 | @return The point to the item contains the Key, or NULL if Key isn't in the map.\r | |
913 | \r | |
914 | **/\r | |
ae213b7d | 915 | NET_MAP_ITEM *\r |
97b38d4e | 916 | EFIAPI\r |
917 | NetMapFindKey (\r | |
918 | IN NET_MAP *Map,\r | |
919 | IN VOID *Key\r | |
920 | );\r | |
921 | \r | |
922 | /**\r | |
3a1ab4bc | 923 | Remove the node entry of the item from the netmap and return the key of the removed item.\r |
1204fe83 | 924 | \r |
925 | Remove the node entry of the item from the Used doubly linked list of the netmap.\r | |
926 | The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r | |
3a1ab4bc | 927 | entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,\r |
928 | Value will point to the value of the item. It returns the key of the removed item.\r | |
1204fe83 | 929 | \r |
3a1ab4bc | 930 | If Map is NULL, then ASSERT().\r |
931 | If Item is NULL, then ASSERT().\r | |
932 | if item in not in the netmap, then ASSERT().\r | |
1204fe83 | 933 | \r |
ae213b7d | 934 | @param[in, out] Map The netmap to remove the item from.\r |
935 | @param[in, out] Item The item to remove.\r | |
936 | @param[out] Value The variable to receive the value if not NULL.\r | |
97b38d4e | 937 | \r |
ae213b7d | 938 | @return The key of the removed item.\r |
97b38d4e | 939 | \r |
940 | **/\r | |
941 | VOID *\r | |
942 | EFIAPI\r | |
943 | NetMapRemoveItem (\r | |
ae213b7d | 944 | IN OUT NET_MAP *Map,\r |
945 | IN OUT NET_MAP_ITEM *Item,\r | |
946 | OUT VOID **Value OPTIONAL\r | |
97b38d4e | 947 | );\r |
948 | \r | |
949 | /**\r | |
3a1ab4bc | 950 | Remove the first node entry on the netmap and return the key of the removed item.\r |
97b38d4e | 951 | \r |
1204fe83 | 952 | Remove the first node entry from the Used doubly linked list of the netmap.\r |
953 | The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r | |
3a1ab4bc | 954 | entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,\r |
955 | parameter Value will point to the value of the item. It returns the key of the removed item.\r | |
1204fe83 | 956 | \r |
3a1ab4bc | 957 | If Map is NULL, then ASSERT().\r |
958 | If the Used doubly linked list is empty, then ASSERT().\r | |
1204fe83 | 959 | \r |
ae213b7d | 960 | @param[in, out] Map The netmap to remove the head from.\r |
961 | @param[out] Value The variable to receive the value if not NULL.\r | |
97b38d4e | 962 | \r |
ae213b7d | 963 | @return The key of the item removed.\r |
97b38d4e | 964 | \r |
965 | **/\r | |
966 | VOID *\r | |
967 | EFIAPI\r | |
968 | NetMapRemoveHead (\r | |
ae213b7d | 969 | IN OUT NET_MAP *Map,\r |
970 | OUT VOID **Value OPTIONAL\r | |
97b38d4e | 971 | );\r |
972 | \r | |
973 | /**\r | |
3a1ab4bc | 974 | Remove the last node entry on the netmap and return the key of the removed item.\r |
97b38d4e | 975 | \r |
1204fe83 | 976 | Remove the last node entry from the Used doubly linked list of the netmap.\r |
977 | The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node\r | |
3a1ab4bc | 978 | entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,\r |
979 | parameter Value will point to the value of the item. It returns the key of the removed item.\r | |
1204fe83 | 980 | \r |
3a1ab4bc | 981 | If Map is NULL, then ASSERT().\r |
982 | If the Used doubly linked list is empty, then ASSERT().\r | |
1204fe83 | 983 | \r |
ae213b7d | 984 | @param[in, out] Map The netmap to remove the tail from.\r |
985 | @param[out] Value The variable to receive the value if not NULL.\r | |
97b38d4e | 986 | \r |
ae213b7d | 987 | @return The key of the item removed.\r |
97b38d4e | 988 | \r |
989 | **/\r | |
990 | VOID *\r | |
991 | EFIAPI\r | |
992 | NetMapRemoveTail (\r | |
ae213b7d | 993 | IN OUT NET_MAP *Map,\r |
994 | OUT VOID **Value OPTIONAL\r | |
97b38d4e | 995 | );\r |
996 | \r | |
997 | typedef\r | |
998 | EFI_STATUS\r | |
e798cd87 | 999 | (EFIAPI *NET_MAP_CALLBACK) (\r |
97b38d4e | 1000 | IN NET_MAP *Map,\r |
1001 | IN NET_MAP_ITEM *Item,\r | |
1002 | IN VOID *Arg\r | |
1003 | );\r | |
1004 | \r | |
1005 | /**\r | |
3a1ab4bc | 1006 | Iterate through the netmap and call CallBack for each item.\r |
1204fe83 | 1007 | \r |
3a1ab4bc | 1008 | It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break\r |
1204fe83 | 1009 | from the loop. It returns the CallBack's last return value. This function is\r |
3a1ab4bc | 1010 | delete safe for the current item.\r |
97b38d4e | 1011 | \r |
3a1ab4bc | 1012 | If Map is NULL, then ASSERT().\r |
1013 | If CallBack is NULL, then ASSERT().\r | |
1204fe83 | 1014 | \r |
ae213b7d | 1015 | @param[in] Map The Map to iterate through.\r |
1016 | @param[in] CallBack The callback function to call for each item.\r | |
1017 | @param[in] Arg The opaque parameter to the callback.\r | |
97b38d4e | 1018 | \r |
64a80549 | 1019 | @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item\r |
1020 | returns EFI_SUCCESS.\r | |
ae213b7d | 1021 | @retval Others It returns the CallBack's last return value.\r |
97b38d4e | 1022 | \r |
1023 | **/\r | |
1024 | EFI_STATUS\r | |
1025 | EFIAPI\r | |
1026 | NetMapIterate (\r | |
1027 | IN NET_MAP *Map,\r | |
1028 | IN NET_MAP_CALLBACK CallBack,\r | |
f6b7393c | 1029 | IN VOID *Arg OPTIONAL\r |
97b38d4e | 1030 | );\r |
1031 | \r | |
1032 | \r | |
1033 | //\r | |
1034 | // Helper functions to implement driver binding and service binding protocols.\r | |
1035 | //\r | |
1036 | /**\r | |
1037 | Create a child of the service that is identified by ServiceBindingGuid.\r | |
1204fe83 | 1038 | \r |
3a1ab4bc | 1039 | Get the ServiceBinding Protocol first, then use it to create a child.\r |
97b38d4e | 1040 | \r |
3a1ab4bc | 1041 | If ServiceBindingGuid is NULL, then ASSERT().\r |
1042 | If ChildHandle is NULL, then ASSERT().\r | |
1204fe83 | 1043 | \r |
ae213b7d | 1044 | @param[in] Controller The controller which has the service installed.\r |
1045 | @param[in] Image The image handle used to open service.\r | |
1046 | @param[in] ServiceBindingGuid The service's Guid.\r | |
e9b67286 | 1047 | @param[in, out] ChildHandle The handle to receive the created child.\r |
97b38d4e | 1048 | \r |
e9b67286 | 1049 | @retval EFI_SUCCESS The child was successfully created.\r |
97b38d4e | 1050 | @retval Others Failed to create the child.\r |
1051 | \r | |
1052 | **/\r | |
1053 | EFI_STATUS\r | |
1054 | EFIAPI\r | |
1055 | NetLibCreateServiceChild (\r | |
ae213b7d | 1056 | IN EFI_HANDLE Controller,\r |
1057 | IN EFI_HANDLE Image,\r | |
97b38d4e | 1058 | IN EFI_GUID *ServiceBindingGuid,\r |
ae213b7d | 1059 | IN OUT EFI_HANDLE *ChildHandle\r |
97b38d4e | 1060 | );\r |
1061 | \r | |
1062 | /**\r | |
e9b67286 | 1063 | Destroy a child of the service that is identified by ServiceBindingGuid.\r |
1204fe83 | 1064 | \r |
3a1ab4bc | 1065 | Get the ServiceBinding Protocol first, then use it to destroy a child.\r |
1204fe83 | 1066 | \r |
3a1ab4bc | 1067 | If ServiceBindingGuid is NULL, then ASSERT().\r |
1204fe83 | 1068 | \r |
ae213b7d | 1069 | @param[in] Controller The controller which has the service installed.\r |
1070 | @param[in] Image The image handle used to open service.\r | |
1071 | @param[in] ServiceBindingGuid The service's Guid.\r | |
e9b67286 | 1072 | @param[in] ChildHandle The child to destroy.\r |
97b38d4e | 1073 | \r |
64a80549 | 1074 | @retval EFI_SUCCESS The child was destroyed.\r |
e9b67286 | 1075 | @retval Others Failed to destroy the child.\r |
97b38d4e | 1076 | \r |
1077 | **/\r | |
1078 | EFI_STATUS\r | |
1079 | EFIAPI\r | |
1080 | NetLibDestroyServiceChild (\r | |
ae213b7d | 1081 | IN EFI_HANDLE Controller,\r |
1082 | IN EFI_HANDLE Image,\r | |
97b38d4e | 1083 | IN EFI_GUID *ServiceBindingGuid,\r |
1084 | IN EFI_HANDLE ChildHandle\r | |
1085 | );\r | |
1086 | \r | |
1087 | /**\r | |
779ae357 | 1088 | Get handle with Simple Network Protocol installed on it.\r |
1089 | \r | |
1090 | There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r | |
1091 | If Simple Network Protocol is already installed on the ServiceHandle, the\r | |
1092 | ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,\r | |
1093 | try to find its parent handle with SNP installed.\r | |
1094 | \r | |
1095 | @param[in] ServiceHandle The handle where network service binding protocols are\r | |
1096 | installed on.\r | |
1097 | @param[out] Snp The pointer to store the address of the SNP instance.\r | |
1098 | This is an optional parameter that may be NULL.\r | |
1099 | \r | |
1100 | @return The SNP handle, or NULL if not found.\r | |
1101 | \r | |
1102 | **/\r | |
1103 | EFI_HANDLE\r | |
1104 | EFIAPI\r | |
1105 | NetLibGetSnpHandle (\r | |
1106 | IN EFI_HANDLE ServiceHandle,\r | |
1107 | OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL\r | |
1108 | );\r | |
1109 | \r | |
1110 | /**\r | |
1111 | Retrieve VLAN ID of a VLAN device handle.\r | |
1112 | \r | |
1113 | Search VLAN device path node in Device Path of specified ServiceHandle and\r | |
1114 | return its VLAN ID. If no VLAN device path node found, then this ServiceHandle\r | |
1115 | is not a VLAN device handle, and 0 will be returned.\r | |
1116 | \r | |
1117 | @param[in] ServiceHandle The handle where network service binding protocols are\r | |
1118 | installed on.\r | |
1119 | \r | |
1120 | @return VLAN ID of the device handle, or 0 if not a VLAN device.\r | |
97b38d4e | 1121 | \r |
779ae357 | 1122 | **/\r |
1123 | UINT16\r | |
1124 | EFIAPI\r | |
1125 | NetLibGetVlanId (\r | |
1126 | IN EFI_HANDLE ServiceHandle\r | |
1127 | );\r | |
1128 | \r | |
1129 | /**\r | |
1130 | Find VLAN device handle with specified VLAN ID.\r | |
1131 | \r | |
1132 | The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.\r | |
1133 | This function will append VLAN device path node to the parent device path,\r | |
1134 | and then use LocateDevicePath() to find the correct VLAN device handle.\r | |
1135 | \r | |
e2851998 | 1136 | @param[in] ControllerHandle The handle where network service binding protocols are\r |
779ae357 | 1137 | installed on.\r |
e2851998 | 1138 | @param[in] VlanId The configured VLAN ID for the VLAN device.\r |
779ae357 | 1139 | \r |
1140 | @return The VLAN device handle, or NULL if not found.\r | |
1141 | \r | |
1142 | **/\r | |
1143 | EFI_HANDLE\r | |
1144 | EFIAPI\r | |
1145 | NetLibGetVlanHandle (\r | |
1146 | IN EFI_HANDLE ControllerHandle,\r | |
1147 | IN UINT16 VlanId\r | |
1148 | );\r | |
1149 | \r | |
1150 | /**\r | |
1151 | Get MAC address associated with the network service handle.\r | |
1152 | \r | |
1153 | There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r | |
1154 | If SNP is installed on the ServiceHandle or its parent handle, MAC address will\r | |
1155 | be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.\r | |
1156 | \r | |
1157 | @param[in] ServiceHandle The handle where network service binding protocols are\r | |
1158 | installed on.\r | |
1159 | @param[out] MacAddress The pointer to store the returned MAC address.\r | |
1160 | @param[out] AddressSize The length of returned MAC address.\r | |
1161 | \r | |
64a80549 | 1162 | @retval EFI_SUCCESS MAC address was returned successfully.\r |
779ae357 | 1163 | @retval Others Failed to get SNP mode data.\r |
1164 | \r | |
1165 | **/\r | |
1166 | EFI_STATUS\r | |
1167 | EFIAPI\r | |
1168 | NetLibGetMacAddress (\r | |
1169 | IN EFI_HANDLE ServiceHandle,\r | |
1170 | OUT EFI_MAC_ADDRESS *MacAddress,\r | |
1171 | OUT UINTN *AddressSize\r | |
1172 | );\r | |
1173 | \r | |
1174 | /**\r | |
1175 | Convert MAC address of the NIC associated with specified Service Binding Handle\r | |
1176 | to a unicode string. Callers are responsible for freeing the string storage.\r | |
3a1ab4bc | 1177 | \r |
779ae357 | 1178 | Locate simple network protocol associated with the Service Binding Handle and\r |
1179 | get the mac address from SNP. Then convert the mac address into a unicode\r | |
1180 | string. It takes 2 unicode characters to represent a 1 byte binary buffer.\r | |
1181 | Plus one unicode character for the null-terminator.\r | |
3a1ab4bc | 1182 | \r |
779ae357 | 1183 | @param[in] ServiceHandle The handle where network service binding protocol is\r |
64a80549 | 1184 | installed.\r |
779ae357 | 1185 | @param[in] ImageHandle The image handle used to act as the agent handle to\r |
b00ed21a | 1186 | get the simple network protocol. This parameter is\r |
1187 | optional and may be NULL.\r | |
ae213b7d | 1188 | @param[out] MacString The pointer to store the address of the string\r |
1189 | representation of the mac address.\r | |
1204fe83 | 1190 | \r |
64a80549 | 1191 | @retval EFI_SUCCESS Converted the mac address a unicode string successfully.\r |
1192 | @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.\r | |
ae213b7d | 1193 | @retval Others Failed to open the simple network protocol.\r |
97b38d4e | 1194 | \r |
1195 | **/\r | |
1196 | EFI_STATUS\r | |
1197 | EFIAPI\r | |
1198 | NetLibGetMacString (\r | |
779ae357 | 1199 | IN EFI_HANDLE ServiceHandle,\r |
b00ed21a | 1200 | IN EFI_HANDLE ImageHandle, OPTIONAL\r |
ae213b7d | 1201 | OUT CHAR16 **MacString\r |
97b38d4e | 1202 | );\r |
1203 | \r | |
dd29f3ed | 1204 | /**\r |
1205 | Detect media status for specified network device.\r | |
1206 | \r | |
1207 | The underlying UNDI driver may or may not support reporting media status from\r | |
1208 | GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine\r | |
3b1464d5 | 1209 | will try to invoke Snp->GetStatus() to get the media status. If media is already\r |
1210 | present, it returns directly. If media is not present, it will stop SNP and then\r | |
1211 | restart SNP to get the latest media status. This provides an opportunity to get \r | |
64a80549 | 1212 | the correct media status for old UNDI driver, which doesn't support reporting \r |
1213 | media status from GET_STATUS command.\r | |
1214 | Note: there are two limitations for the current algorithm:\r | |
1215 | 1) For UNDI with this capability, when the cable is not attached, there will\r | |
1216 | be an redundant Stop/Start() process.\r | |
3b1464d5 | 1217 | 2) for UNDI without this capability, in case that network cable is attached when\r |
1218 | Snp->Initialize() is invoked while network cable is unattached later,\r | |
1219 | NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer\r | |
1220 | apps to wait for timeout time.\r | |
dd29f3ed | 1221 | \r |
1222 | @param[in] ServiceHandle The handle where network service binding protocols are\r | |
64a80549 | 1223 | installed.\r |
dd29f3ed | 1224 | @param[out] MediaPresent The pointer to store the media status.\r |
1225 | \r | |
1226 | @retval EFI_SUCCESS Media detection success.\r | |
64a80549 | 1227 | @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.\r |
1228 | @retval EFI_UNSUPPORTED The network device does not support media detection.\r | |
1229 | @retval EFI_DEVICE_ERROR SNP is in an unknown state.\r | |
dd29f3ed | 1230 | \r |
1231 | **/\r | |
1232 | EFI_STATUS\r | |
1233 | EFIAPI\r | |
1234 | NetLibDetectMedia (\r | |
1235 | IN EFI_HANDLE ServiceHandle,\r | |
1236 | OUT BOOLEAN *MediaPresent\r | |
1237 | );\r | |
1238 | \r | |
97b38d4e | 1239 | /**\r |
1240 | Create an IPv4 device path node.\r | |
1204fe83 | 1241 | \r |
3a1ab4bc | 1242 | The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.\r |
1243 | The header subtype of IPv4 device path node is MSG_IPv4_DP.\r | |
1244 | The length of the IPv4 device path node in bytes is 19.\r | |
64a80549 | 1245 | Get other information from parameters to make up the whole IPv4 device path node.\r |
97b38d4e | 1246 | \r |
64a80549 | 1247 | @param[in, out] Node The pointer to the IPv4 device path node.\r |
f6b7393c | 1248 | @param[in] Controller The controller handle.\r |
ae213b7d | 1249 | @param[in] LocalIp The local IPv4 address.\r |
1250 | @param[in] LocalPort The local port.\r | |
1251 | @param[in] RemoteIp The remote IPv4 address.\r | |
1252 | @param[in] RemotePort The remote port.\r | |
1253 | @param[in] Protocol The protocol type in the IP header.\r | |
1254 | @param[in] UseDefaultAddress Whether this instance is using default address or not.\r | |
97b38d4e | 1255 | \r |
97b38d4e | 1256 | **/\r |
1257 | VOID\r | |
1258 | EFIAPI\r | |
1259 | NetLibCreateIPv4DPathNode (\r | |
1260 | IN OUT IPv4_DEVICE_PATH *Node,\r | |
1261 | IN EFI_HANDLE Controller,\r | |
1262 | IN IP4_ADDR LocalIp,\r | |
1263 | IN UINT16 LocalPort,\r | |
1264 | IN IP4_ADDR RemoteIp,\r | |
1265 | IN UINT16 RemotePort,\r | |
1266 | IN UINT16 Protocol,\r | |
1267 | IN BOOLEAN UseDefaultAddress\r | |
1268 | );\r | |
1269 | \r | |
f6b7393c | 1270 | /**\r |
1271 | Create an IPv6 device path node.\r | |
1204fe83 | 1272 | \r |
f6b7393c | 1273 | The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.\r |
1274 | The header subtype of IPv6 device path node is MSG_IPv6_DP.\r | |
1275 | The length of the IPv6 device path node in bytes is 43.\r | |
64a80549 | 1276 | Get other information from parameters to make up the whole IPv6 device path node.\r |
f6b7393c | 1277 | \r |
64a80549 | 1278 | @param[in, out] Node The pointer to the IPv6 device path node.\r |
f6b7393c | 1279 | @param[in] Controller The controller handle.\r |
1280 | @param[in] LocalIp The local IPv6 address.\r | |
1281 | @param[in] LocalPort The local port.\r | |
1282 | @param[in] RemoteIp The remote IPv6 address.\r | |
1283 | @param[in] RemotePort The remote port.\r | |
1284 | @param[in] Protocol The protocol type in the IP header.\r | |
1285 | \r | |
1286 | **/\r | |
1287 | VOID\r | |
1288 | EFIAPI\r | |
1289 | NetLibCreateIPv6DPathNode (\r | |
1290 | IN OUT IPv6_DEVICE_PATH *Node,\r | |
1291 | IN EFI_HANDLE Controller,\r | |
1292 | IN EFI_IPv6_ADDRESS *LocalIp,\r | |
1293 | IN UINT16 LocalPort,\r | |
1294 | IN EFI_IPv6_ADDRESS *RemoteIp,\r | |
1295 | IN UINT16 RemotePort,\r | |
1296 | IN UINT16 Protocol\r | |
1297 | );\r | |
1298 | \r | |
1299 | \r | |
97b38d4e | 1300 | /**\r |
1301 | Find the UNDI/SNP handle from controller and protocol GUID.\r | |
1204fe83 | 1302 | \r |
e9b67286 | 1303 | For example, IP will open an MNP child to transmit/receive\r |
1304 | packets. When MNP is stopped, IP should also be stopped. IP\r | |
64a80549 | 1305 | needs to find its own private data that is related the IP's\r |
1306 | service binding instance that is installed on the UNDI/SNP handle.\r | |
1307 | The controller is then either an MNP or an ARP child handle. Note that\r | |
1308 | IP opens these handles using BY_DRIVER. Use that infomation to get the\r | |
97b38d4e | 1309 | UNDI/SNP handle.\r |
1310 | \r | |
64a80549 | 1311 | @param[in] Controller The protocol handle to check.\r |
ae213b7d | 1312 | @param[in] ProtocolGuid The protocol that is related with the handle.\r |
97b38d4e | 1313 | \r |
ae213b7d | 1314 | @return The UNDI/SNP handle or NULL for errors.\r |
97b38d4e | 1315 | \r |
1316 | **/\r | |
1317 | EFI_HANDLE\r | |
1318 | EFIAPI\r | |
1319 | NetLibGetNicHandle (\r | |
1320 | IN EFI_HANDLE Controller,\r | |
1321 | IN EFI_GUID *ProtocolGuid\r | |
1322 | );\r | |
1323 | \r | |
97b38d4e | 1324 | /**\r |
1325 | This is the default unload handle for all the network drivers.\r | |
1326 | \r | |
3a1ab4bc | 1327 | Disconnect the driver specified by ImageHandle from all the devices in the handle database.\r |
1328 | Uninstall all the protocols installed in the driver entry point.\r | |
1204fe83 | 1329 | \r |
ae213b7d | 1330 | @param[in] ImageHandle The drivers' driver image.\r |
97b38d4e | 1331 | \r |
1332 | @retval EFI_SUCCESS The image is unloaded.\r | |
1333 | @retval Others Failed to unload the image.\r | |
1334 | \r | |
1335 | **/\r | |
1336 | EFI_STATUS\r | |
1337 | EFIAPI\r | |
1338 | NetLibDefaultUnload (\r | |
1339 | IN EFI_HANDLE ImageHandle\r | |
1340 | );\r | |
1341 | \r | |
e4ef0031 | 1342 | /**\r |
1343 | Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.\r | |
1344 | \r | |
1345 | @param[in] String The pointer to the Ascii string.\r | |
1346 | @param[out] Ip4Address The pointer to the converted IPv4 address.\r | |
1347 | \r | |
64a80549 | 1348 | @retval EFI_SUCCESS Converted to an IPv4 address successfully.\r |
1349 | @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.\r | |
e4ef0031 | 1350 | \r |
1351 | **/\r | |
1352 | EFI_STATUS\r | |
e798cd87 | 1353 | EFIAPI\r |
e4ef0031 | 1354 | NetLibAsciiStrToIp4 (\r |
1355 | IN CONST CHAR8 *String,\r | |
1356 | OUT EFI_IPv4_ADDRESS *Ip4Address\r | |
1357 | );\r | |
1358 | \r | |
1359 | /**\r | |
1360 | Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the\r | |
1361 | string is defined in RFC 4291 - Text Pepresentation of Addresses.\r | |
1362 | \r | |
1363 | @param[in] String The pointer to the Ascii string.\r | |
1364 | @param[out] Ip6Address The pointer to the converted IPv6 address.\r | |
1365 | \r | |
64a80549 | 1366 | @retval EFI_SUCCESS Converted to an IPv6 address successfully.\r |
1367 | @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.\r | |
e4ef0031 | 1368 | \r |
1369 | **/\r | |
1370 | EFI_STATUS\r | |
e798cd87 | 1371 | EFIAPI\r |
e4ef0031 | 1372 | NetLibAsciiStrToIp6 (\r |
1373 | IN CONST CHAR8 *String,\r | |
1374 | OUT EFI_IPv6_ADDRESS *Ip6Address\r | |
1375 | );\r | |
1376 | \r | |
1377 | /**\r | |
1378 | Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.\r | |
1379 | \r | |
1380 | @param[in] String The pointer to the Ascii string.\r | |
1381 | @param[out] Ip4Address The pointer to the converted IPv4 address.\r | |
1382 | \r | |
64a80549 | 1383 | @retval EFI_SUCCESS Converted to an IPv4 address successfully.\r |
e4ef0031 | 1384 | @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.\r |
64a80549 | 1385 | @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.\r |
e4ef0031 | 1386 | \r |
1387 | **/\r | |
1388 | EFI_STATUS\r | |
e798cd87 | 1389 | EFIAPI\r |
e4ef0031 | 1390 | NetLibStrToIp4 (\r |
1391 | IN CONST CHAR16 *String,\r | |
1392 | OUT EFI_IPv4_ADDRESS *Ip4Address\r | |
1393 | );\r | |
1394 | \r | |
1395 | /**\r | |
1396 | Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of\r | |
1397 | the string is defined in RFC 4291 - Text Pepresentation of Addresses.\r | |
1398 | \r | |
1399 | @param[in] String The pointer to the Ascii string.\r | |
1400 | @param[out] Ip6Address The pointer to the converted IPv6 address.\r | |
1401 | \r | |
64a80549 | 1402 | @retval EFI_SUCCESS Converted to an IPv6 address successfully.\r |
1403 | @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.\r | |
1404 | @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.\r | |
e4ef0031 | 1405 | \r |
1406 | **/\r | |
1407 | EFI_STATUS\r | |
e798cd87 | 1408 | EFIAPI\r |
e4ef0031 | 1409 | NetLibStrToIp6 (\r |
1410 | IN CONST CHAR16 *String,\r | |
1411 | OUT EFI_IPv6_ADDRESS *Ip6Address\r | |
1412 | );\r | |
1413 | \r | |
1414 | /**\r | |
1415 | Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.\r | |
1416 | The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses\r | |
1417 | Prefixes: ipv6-address/prefix-length.\r | |
1418 | \r | |
1419 | @param[in] String The pointer to the Ascii string.\r | |
1420 | @param[out] Ip6Address The pointer to the converted IPv6 address.\r | |
1421 | @param[out] PrefixLength The pointer to the converted prefix length.\r | |
1422 | \r | |
64a80549 | 1423 | @retval EFI_SUCCESS Converted to an IPv6 address successfully.\r |
1424 | @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.\r | |
1425 | @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.\r | |
e4ef0031 | 1426 | \r |
1427 | **/\r | |
1428 | EFI_STATUS\r | |
e798cd87 | 1429 | EFIAPI\r |
e4ef0031 | 1430 | NetLibStrToIp6andPrefix (\r |
1431 | IN CONST CHAR16 *String,\r | |
1432 | OUT EFI_IPv6_ADDRESS *Ip6Address,\r | |
1433 | OUT UINT8 *PrefixLength\r | |
1434 | );\r | |
b45b45b2 | 1435 | \r |
216f7970 | 1436 | /**\r |
1437 | \r | |
1438 | Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.\r | |
1439 | The text representation of address is defined in RFC 4291.\r | |
1440 | \r | |
1441 | @param[in] Ip6Address The pointer to the IPv6 address.\r | |
1442 | @param[out] String The buffer to return the converted string.\r | |
1443 | @param[in] StringSize The length in bytes of the input String.\r | |
1444 | \r | |
1445 | @retval EFI_SUCCESS Convert to string successfully.\r | |
1446 | @retval EFI_INVALID_PARAMETER The input parameter is invalid.\r | |
1447 | @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been \r | |
1448 | updated with the size needed to complete the request.\r | |
1449 | **/\r | |
1450 | EFI_STATUS\r | |
1451 | EFIAPI\r | |
1452 | NetLibIp6ToStr (\r | |
1453 | IN EFI_IPv6_ADDRESS *Ip6Address,\r | |
1454 | OUT CHAR16 *String,\r | |
1455 | IN UINTN StringSize\r | |
1456 | );\r | |
1457 | \r | |
b45b45b2 | 1458 | //\r |
e4ef0031 | 1459 | // Various signatures\r |
b45b45b2 | 1460 | //\r |
1461 | #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')\r | |
1462 | #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')\r | |
1463 | #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')\r | |
97b38d4e | 1464 | \r |
1465 | \r | |
b45b45b2 | 1466 | #define NET_PROTO_DATA 64 // Opaque buffer for protocols\r |
1467 | #define NET_BUF_HEAD 1 // Trim or allocate space from head\r | |
1468 | #define NET_BUF_TAIL 0 // Trim or allocate space from tail\r | |
1469 | #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector\r | |
97b38d4e | 1470 | \r |
1471 | #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \\r | |
1472 | ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))\r | |
1473 | \r | |
97b38d4e | 1474 | //\r |
1475 | // Single memory block in the vector.\r | |
1476 | //\r | |
1477 | typedef struct {\r | |
1478 | UINT32 Len; // The block's length\r | |
1479 | UINT8 *Bulk; // The block's Data\r | |
1480 | } NET_BLOCK;\r | |
1481 | \r | |
e798cd87 | 1482 | typedef VOID (EFIAPI *NET_VECTOR_EXT_FREE) (VOID *Arg);\r |
97b38d4e | 1483 | \r |
1484 | //\r | |
1485 | //NET_VECTOR contains several blocks to hold all packet's\r | |
1486 | //fragments and other house-keeping stuff for sharing. It\r | |
1487 | //doesn't specify the where actual packet fragment begins.\r | |
1488 | //\r | |
1489 | typedef struct {\r | |
1490 | UINT32 Signature;\r | |
1491 | INTN RefCnt; // Reference count to share NET_VECTOR.\r | |
1492 | NET_VECTOR_EXT_FREE Free; // external function to free NET_VECTOR\r | |
1493 | VOID *Arg; // opeque argument to Free\r | |
1494 | UINT32 Flag; // Flags, NET_VECTOR_OWN_FIRST\r | |
1495 | UINT32 Len; // Total length of the assocated BLOCKs\r | |
1496 | \r | |
1497 | UINT32 BlockNum;\r | |
1498 | NET_BLOCK Block[1];\r | |
1499 | } NET_VECTOR;\r | |
1500 | \r | |
1501 | //\r | |
e9b67286 | 1502 | //NET_BLOCK_OP operates on the NET_BLOCK. It specifies\r |
1503 | //where the actual fragment begins and ends\r | |
97b38d4e | 1504 | //\r |
1505 | typedef struct {\r | |
1506 | UINT8 *BlockHead; // Block's head, or the smallest valid Head\r | |
1507 | UINT8 *BlockTail; // Block's tail. BlockTail-BlockHead=block length\r | |
1508 | UINT8 *Head; // 1st byte of the data in the block\r | |
1509 | UINT8 *Tail; // Tail of the data in the block, Tail-Head=Size\r | |
1510 | UINT32 Size; // The size of the data\r | |
1511 | } NET_BLOCK_OP;\r | |
1512 | \r | |
f6b7393c | 1513 | typedef union {\r |
1514 | IP4_HEAD *Ip4;\r | |
1515 | EFI_IP6_HEADER *Ip6;\r | |
1516 | } NET_IP_HEAD;\r | |
97b38d4e | 1517 | \r |
1518 | //\r | |
1519 | //NET_BUF is the buffer manage structure used by the\r | |
e9b67286 | 1520 | //network stack. Every network packet may be fragmented. The Vector points to\r |
1521 | //memory blocks used by each fragment, and BlockOp\r | |
97b38d4e | 1522 | //specifies where each fragment begins and ends.\r |
1523 | //\r | |
e9b67286 | 1524 | //It also contains an opaque area for the protocol to store\r |
1525 | //per-packet information. Protocol must be careful not\r | |
97b38d4e | 1526 | //to overwrite the members after that.\r |
1527 | //\r | |
1528 | typedef struct {\r | |
f6b7393c | 1529 | UINT32 Signature;\r |
1530 | INTN RefCnt;\r | |
1531 | LIST_ENTRY List; // The List this NET_BUF is on\r | |
97b38d4e | 1532 | \r |
f6b7393c | 1533 | NET_IP_HEAD Ip; // Network layer header, for fast access\r |
1534 | TCP_HEAD *Tcp; // Transport layer header, for fast access\r | |
1535 | EFI_UDP_HEADER *Udp; // User Datagram Protocol header\r | |
1536 | UINT8 ProtoData [NET_PROTO_DATA]; //Protocol specific data\r | |
97b38d4e | 1537 | \r |
f6b7393c | 1538 | NET_VECTOR *Vector; // The vector containing the packet\r |
97b38d4e | 1539 | \r |
f6b7393c | 1540 | UINT32 BlockOpNum; // Total number of BlockOp in the buffer\r |
1541 | UINT32 TotalSize; // Total size of the actual packet\r | |
1542 | NET_BLOCK_OP BlockOp[1]; // Specify the position of actual packet\r | |
97b38d4e | 1543 | } NET_BUF;\r |
1544 | \r | |
97b38d4e | 1545 | //\r |
e9b67286 | 1546 | //A queue of NET_BUFs. It is a thin extension of\r |
97b38d4e | 1547 | //NET_BUF functions.\r |
1548 | //\r | |
1549 | typedef struct {\r | |
1550 | UINT32 Signature;\r | |
1551 | INTN RefCnt;\r | |
1552 | LIST_ENTRY List; // The List this buffer queue is on\r | |
1553 | \r | |
1554 | LIST_ENTRY BufList; // list of queued buffers\r | |
1555 | UINT32 BufSize; // total length of DATA in the buffers\r | |
1556 | UINT32 BufNum; // total number of buffers on the chain\r | |
1557 | } NET_BUF_QUEUE;\r | |
1558 | \r | |
1559 | //\r | |
1560 | // Pseudo header for TCP and UDP checksum\r | |
1561 | //\r | |
1562 | #pragma pack(1)\r | |
1563 | typedef struct {\r | |
1564 | IP4_ADDR SrcIp;\r | |
1565 | IP4_ADDR DstIp;\r | |
1566 | UINT8 Reserved;\r | |
1567 | UINT8 Protocol;\r | |
1568 | UINT16 Len;\r | |
1569 | } NET_PSEUDO_HDR;\r | |
f6b7393c | 1570 | \r |
1571 | typedef struct {\r | |
1572 | EFI_IPv6_ADDRESS SrcIp;\r | |
1573 | EFI_IPv6_ADDRESS DstIp;\r | |
1574 | UINT32 Len;\r | |
1575 | UINT32 Reserved:24;\r | |
1576 | UINT32 NextHeader:8;\r | |
1577 | } NET_IP6_PSEUDO_HDR;\r | |
97b38d4e | 1578 | #pragma pack()\r |
1579 | \r | |
1580 | //\r | |
1581 | // The fragment entry table used in network interfaces. This is\r | |
1582 | // the same as NET_BLOCK now. Use two different to distinguish\r | |
1583 | // the two in case that NET_BLOCK be enhanced later.\r | |
1584 | //\r | |
1585 | typedef struct {\r | |
1586 | UINT32 Len;\r | |
1587 | UINT8 *Bulk;\r | |
1588 | } NET_FRAGMENT;\r | |
1589 | \r | |
1590 | #define NET_GET_REF(PData) ((PData)->RefCnt++)\r | |
1591 | #define NET_PUT_REF(PData) ((PData)->RefCnt--)\r | |
50d7ebad | 1592 | #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)\r |
97b38d4e | 1593 | \r |
1594 | #define NET_BUF_SHARED(Buf) \\r | |
1595 | (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))\r | |
1596 | \r | |
1597 | #define NET_VECTOR_SIZE(BlockNum) \\r | |
1598 | (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))\r | |
1599 | \r | |
1600 | #define NET_BUF_SIZE(BlockOpNum) \\r | |
1601 | (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))\r | |
1602 | \r | |
1603 | #define NET_HEADSPACE(BlockOp) \\r | |
1604 | (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)\r | |
1605 | \r | |
1606 | #define NET_TAILSPACE(BlockOp) \\r | |
1607 | (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)\r | |
1608 | \r | |
1609 | /**\r | |
1610 | Allocate a single block NET_BUF. Upon allocation, all the\r | |
1611 | free space is in the tail room.\r | |
1612 | \r | |
ae213b7d | 1613 | @param[in] Len The length of the block.\r |
97b38d4e | 1614 | \r |
64a80549 | 1615 | @return The pointer to the allocated NET_BUF, or NULL if the\r |
1616 | allocation failed due to resource limitations.\r | |
97b38d4e | 1617 | \r |
1618 | **/\r | |
1619 | NET_BUF *\r | |
1620 | EFIAPI\r | |
1621 | NetbufAlloc (\r | |
1622 | IN UINT32 Len\r | |
1623 | );\r | |
1624 | \r | |
1625 | /**\r | |
7557df4d | 1626 | Free the net buffer and its associated NET_VECTOR.\r |
1204fe83 | 1627 | \r |
7557df4d | 1628 | Decrease the reference count of the net buffer by one. Free the associated net\r |
1204fe83 | 1629 | vector and itself if the reference count of the net buffer is decreased to 0.\r |
1630 | The net vector free operation decreases the reference count of the net\r | |
e9b67286 | 1631 | vector by one, and performs the resource free operation when the reference count\r |
1204fe83 | 1632 | of the net vector is 0.\r |
1633 | \r | |
64a80549 | 1634 | @param[in] Nbuf The pointer to the NET_BUF to be freed.\r |
97b38d4e | 1635 | \r |
1636 | **/\r | |
1637 | VOID\r | |
1638 | EFIAPI\r | |
1639 | NetbufFree (\r | |
1640 | IN NET_BUF *Nbuf\r | |
1641 | );\r | |
1642 | \r | |
1643 | /**\r | |
1204fe83 | 1644 | Get the index of NET_BLOCK_OP that contains the byte at Offset in the net\r |
1645 | buffer.\r | |
1646 | \r | |
1647 | For example, this function can be used to retrieve the IP header in the packet. It\r | |
1648 | also can be used to get the fragment that contains the byte used\r | |
1649 | mainly by the library implementation itself.\r | |
97b38d4e | 1650 | \r |
64a80549 | 1651 | @param[in] Nbuf The pointer to the net buffer.\r |
7557df4d | 1652 | @param[in] Offset The offset of the byte.\r |
1204fe83 | 1653 | @param[out] Index Index of the NET_BLOCK_OP that contains the byte at\r |
7557df4d | 1654 | Offset.\r |
97b38d4e | 1655 | \r |
64a80549 | 1656 | @return The pointer to the Offset'th byte of data in the net buffer, or NULL\r |
7557df4d | 1657 | if there is no such data in the net buffer.\r |
97b38d4e | 1658 | \r |
1659 | **/\r | |
1660 | UINT8 *\r | |
1661 | EFIAPI\r | |
1662 | NetbufGetByte (\r | |
1663 | IN NET_BUF *Nbuf,\r | |
1664 | IN UINT32 Offset,\r | |
ae213b7d | 1665 | OUT UINT32 *Index OPTIONAL\r |
97b38d4e | 1666 | );\r |
1667 | \r | |
1668 | /**\r | |
1204fe83 | 1669 | Create a copy of the net buffer that shares the associated net vector.\r |
1670 | \r | |
1671 | The reference count of the newly created net buffer is set to 1. The reference\r | |
1672 | count of the associated net vector is increased by one.\r | |
97b38d4e | 1673 | \r |
64a80549 | 1674 | @param[in] Nbuf The pointer to the net buffer to be cloned.\r |
97b38d4e | 1675 | \r |
64a80549 | 1676 | @return The pointer to the cloned net buffer, or NULL if the\r |
1677 | allocation failed due to resource limitations.\r | |
97b38d4e | 1678 | \r |
1679 | **/\r | |
7557df4d | 1680 | NET_BUF *\r |
97b38d4e | 1681 | EFIAPI\r |
1682 | NetbufClone (\r | |
1683 | IN NET_BUF *Nbuf\r | |
1684 | );\r | |
1685 | \r | |
1686 | /**\r | |
7557df4d | 1687 | Create a duplicated copy of the net buffer with data copied and HeadSpace\r |
1688 | bytes of head space reserved.\r | |
1204fe83 | 1689 | \r |
7557df4d | 1690 | The duplicated net buffer will allocate its own memory to hold the data of the\r |
1691 | source net buffer.\r | |
1204fe83 | 1692 | \r |
64a80549 | 1693 | @param[in] Nbuf The pointer to the net buffer to be duplicated from.\r |
1694 | @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If\r | |
1695 | NULL, a new net buffer is allocated.\r | |
1696 | @param[in] HeadSpace The length of the head space to reserve.\r | |
7557df4d | 1697 | \r |
64a80549 | 1698 | @return The pointer to the duplicated net buffer, or NULL if\r |
1699 | the allocation failed due to resource limitations.\r | |
97b38d4e | 1700 | \r |
1701 | **/\r | |
1702 | NET_BUF *\r | |
1703 | EFIAPI\r | |
1704 | NetbufDuplicate (\r | |
1705 | IN NET_BUF *Nbuf,\r | |
ae213b7d | 1706 | IN OUT NET_BUF *Duplicate OPTIONAL,\r |
97b38d4e | 1707 | IN UINT32 HeadSpace\r |
1708 | );\r | |
1709 | \r | |
1710 | /**\r | |
1204fe83 | 1711 | Create a NET_BUF structure which contains Len byte data of Nbuf starting from\r |
1712 | Offset.\r | |
1713 | \r | |
1714 | A new NET_BUF structure will be created but the associated data in NET_VECTOR\r | |
64a80549 | 1715 | is shared. This function exists to perform IP packet fragmentation.\r |
7557df4d | 1716 | \r |
64a80549 | 1717 | @param[in] Nbuf The pointer to the net buffer to be extracted.\r |
1204fe83 | 1718 | @param[in] Offset Starting point of the data to be included in the new\r |
7557df4d | 1719 | net buffer.\r |
64a80549 | 1720 | @param[in] Len The bytes of data to be included in the new net buffer.\r |
1721 | @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.\r | |
7557df4d | 1722 | \r |
64a80549 | 1723 | @return The pointer to the cloned net buffer, or NULL if the\r |
1724 | allocation failed due to resource limitations.\r | |
97b38d4e | 1725 | \r |
1726 | **/\r | |
1727 | NET_BUF *\r | |
1728 | EFIAPI\r | |
1729 | NetbufGetFragment (\r | |
1730 | IN NET_BUF *Nbuf,\r | |
1731 | IN UINT32 Offset,\r | |
1732 | IN UINT32 Len,\r | |
1733 | IN UINT32 HeadSpace\r | |
1734 | );\r | |
1735 | \r | |
1736 | /**\r | |
7557df4d | 1737 | Reserve some space in the header room of the net buffer.\r |
1738 | \r | |
1204fe83 | 1739 | Upon allocation, all the space is in the tail room of the buffer. Call this\r |
64a80549 | 1740 | function to move space to the header room. This function is quite limited\r |
1204fe83 | 1741 | in that it can only reserve space from the first block of an empty NET_BUF not\r |
64a80549 | 1742 | built from the external. However, it should be enough for the network stack.\r |
97b38d4e | 1743 | \r |
64a80549 | 1744 | @param[in, out] Nbuf The pointer to the net buffer.\r |
7557df4d | 1745 | @param[in] Len The length of buffer to be reserved from the header.\r |
97b38d4e | 1746 | \r |
1747 | **/\r | |
1748 | VOID\r | |
1749 | EFIAPI\r | |
1750 | NetbufReserve (\r | |
ae213b7d | 1751 | IN OUT NET_BUF *Nbuf,\r |
97b38d4e | 1752 | IN UINT32 Len\r |
1753 | );\r | |
1754 | \r | |
1755 | /**\r | |
1204fe83 | 1756 | Allocate Len bytes of space from the header or tail of the buffer.\r |
97b38d4e | 1757 | \r |
64a80549 | 1758 | @param[in, out] Nbuf The pointer to the net buffer.\r |
7557df4d | 1759 | @param[in] Len The length of the buffer to be allocated.\r |
64a80549 | 1760 | @param[in] FromHead The flag to indicate whether to reserve the data\r |
7557df4d | 1761 | from head (TRUE) or tail (FALSE).\r |
97b38d4e | 1762 | \r |
64a80549 | 1763 | @return The pointer to the first byte of the allocated buffer,\r |
1764 | or NULL, if there is no sufficient space.\r | |
97b38d4e | 1765 | \r |
1766 | **/\r | |
7557df4d | 1767 | UINT8*\r |
97b38d4e | 1768 | EFIAPI\r |
1769 | NetbufAllocSpace (\r | |
ae213b7d | 1770 | IN OUT NET_BUF *Nbuf,\r |
97b38d4e | 1771 | IN UINT32 Len,\r |
1772 | IN BOOLEAN FromHead\r | |
1773 | );\r | |
1774 | \r | |
1775 | /**\r | |
64a80549 | 1776 | Trim Len bytes from the header or the tail of the net buffer.\r |
97b38d4e | 1777 | \r |
64a80549 | 1778 | @param[in, out] Nbuf The pointer to the net buffer.\r |
7557df4d | 1779 | @param[in] Len The length of the data to be trimmed.\r |
64a80549 | 1780 | @param[in] FromHead The flag to indicate whether trim data is from the \r |
1781 | head (TRUE) or the tail (FALSE).\r | |
97b38d4e | 1782 | \r |
64a80549 | 1783 | @return The length of the actual trimmed data, which may be less\r |
e9b67286 | 1784 | than Len if the TotalSize of Nbuf is less than Len.\r |
97b38d4e | 1785 | \r |
1786 | **/\r | |
1787 | UINT32\r | |
1788 | EFIAPI\r | |
1789 | NetbufTrim (\r | |
ae213b7d | 1790 | IN OUT NET_BUF *Nbuf,\r |
97b38d4e | 1791 | IN UINT32 Len,\r |
1792 | IN BOOLEAN FromHead\r | |
1793 | );\r | |
1794 | \r | |
1795 | /**\r | |
1204fe83 | 1796 | Copy Len bytes of data from the specific offset of the net buffer to the\r |
7557df4d | 1797 | destination memory.\r |
1204fe83 | 1798 | \r |
e9b67286 | 1799 | The Len bytes of data may cross several fragments of the net buffer.\r |
1204fe83 | 1800 | \r |
64a80549 | 1801 | @param[in] Nbuf The pointer to the net buffer.\r |
7557df4d | 1802 | @param[in] Offset The sequence number of the first byte to copy.\r |
64a80549 | 1803 | @param[in] Len The length of the data to copy.\r |
7557df4d | 1804 | @param[in] Dest The destination of the data to copy to.\r |
1805 | \r | |
1806 | @return The length of the actual copied data, or 0 if the offset\r | |
361468ed | 1807 | specified exceeds the total size of net buffer.\r |
97b38d4e | 1808 | \r |
1809 | **/\r | |
1810 | UINT32\r | |
1811 | EFIAPI\r | |
1812 | NetbufCopy (\r | |
1813 | IN NET_BUF *Nbuf,\r | |
1814 | IN UINT32 Offset,\r | |
1815 | IN UINT32 Len,\r | |
1816 | IN UINT8 *Dest\r | |
1817 | );\r | |
1818 | \r | |
1819 | /**\r | |
1204fe83 | 1820 | Build a NET_BUF from external blocks.\r |
1821 | \r | |
e9b67286 | 1822 | A new NET_BUF structure will be created from external blocks. An additional block\r |
7557df4d | 1823 | of memory will be allocated to hold reserved HeadSpace bytes of header room\r |
e9b67286 | 1824 | and existing HeadLen bytes of header, but the external blocks are shared by the\r |
7557df4d | 1825 | net buffer to avoid data copying.\r |
97b38d4e | 1826 | \r |
64a80549 | 1827 | @param[in] ExtFragment The pointer to the data block.\r |
7557df4d | 1828 | @param[in] ExtNum The number of the data blocks.\r |
ae213b7d | 1829 | @param[in] HeadSpace The head space to be reserved.\r |
e9b67286 | 1830 | @param[in] HeadLen The length of the protocol header. The function\r |
1831 | pulls this amount of data into a linear block.\r | |
64a80549 | 1832 | @param[in] ExtFree The pointer to the caller-provided free function.\r |
ae213b7d | 1833 | @param[in] Arg The argument passed to ExtFree when ExtFree is\r |
1834 | called.\r | |
97b38d4e | 1835 | \r |
64a80549 | 1836 | @return The pointer to the net buffer built from the data blocks,\r |
7557df4d | 1837 | or NULL if the allocation failed due to resource\r |
1838 | limit.\r | |
97b38d4e | 1839 | \r |
1840 | **/\r | |
1841 | NET_BUF *\r | |
1842 | EFIAPI\r | |
1843 | NetbufFromExt (\r | |
1844 | IN NET_FRAGMENT *ExtFragment,\r | |
1845 | IN UINT32 ExtNum,\r | |
1846 | IN UINT32 HeadSpace,\r | |
1847 | IN UINT32 HeadLen,\r | |
1848 | IN NET_VECTOR_EXT_FREE ExtFree,\r | |
1849 | IN VOID *Arg OPTIONAL\r | |
1850 | );\r | |
1851 | \r | |
1852 | /**\r | |
7557df4d | 1853 | Build a fragment table to contain the fragments in the net buffer. This is the\r |
1204fe83 | 1854 | opposite operation of the NetbufFromExt.\r |
1855 | \r | |
64a80549 | 1856 | @param[in] Nbuf Points to the net buffer.\r |
1857 | @param[in, out] ExtFragment The pointer to the data block.\r | |
7557df4d | 1858 | @param[in, out] ExtNum The number of the data blocks.\r |
97b38d4e | 1859 | \r |
1204fe83 | 1860 | @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than\r |
7557df4d | 1861 | ExtNum.\r |
64a80549 | 1862 | @retval EFI_SUCCESS The fragment table was built successfully.\r |
97b38d4e | 1863 | \r |
1864 | **/\r | |
1865 | EFI_STATUS\r | |
1866 | EFIAPI\r | |
1867 | NetbufBuildExt (\r | |
1868 | IN NET_BUF *Nbuf,\r | |
ae213b7d | 1869 | IN OUT NET_FRAGMENT *ExtFragment,\r |
1870 | IN OUT UINT32 *ExtNum\r | |
97b38d4e | 1871 | );\r |
1872 | \r | |
1873 | /**\r | |
7557df4d | 1874 | Build a net buffer from a list of net buffers.\r |
1204fe83 | 1875 | \r |
64a80549 | 1876 | All the fragments will be collected from the list of NEW_BUF, and then a new\r |
1204fe83 | 1877 | net buffer will be created through NetbufFromExt.\r |
1878 | \r | |
7557df4d | 1879 | @param[in] BufList A List of the net buffer.\r |
1880 | @param[in] HeadSpace The head space to be reserved.\r | |
e9b67286 | 1881 | @param[in] HeaderLen The length of the protocol header. The function\r |
1882 | pulls this amount of data into a linear block.\r | |
64a80549 | 1883 | @param[in] ExtFree The pointer to the caller provided free function.\r |
7557df4d | 1884 | @param[in] Arg The argument passed to ExtFree when ExtFree is called.\r |
1885 | \r | |
64a80549 | 1886 | @return The pointer to the net buffer built from the list of net\r |
7557df4d | 1887 | buffers.\r |
97b38d4e | 1888 | \r |
1889 | **/\r | |
1890 | NET_BUF *\r | |
1891 | EFIAPI\r | |
1892 | NetbufFromBufList (\r | |
1893 | IN LIST_ENTRY *BufList,\r | |
1894 | IN UINT32 HeadSpace,\r | |
1895 | IN UINT32 HeaderLen,\r | |
1896 | IN NET_VECTOR_EXT_FREE ExtFree,\r | |
ae213b7d | 1897 | IN VOID *Arg OPTIONAL\r |
97b38d4e | 1898 | );\r |
1899 | \r | |
1900 | /**\r | |
1901 | Free a list of net buffers.\r | |
1902 | \r | |
64a80549 | 1903 | @param[in, out] Head The pointer to the head of linked net buffers.\r |
97b38d4e | 1904 | \r |
1905 | **/\r | |
1906 | VOID\r | |
1907 | EFIAPI\r | |
1908 | NetbufFreeList (\r | |
ae213b7d | 1909 | IN OUT LIST_ENTRY *Head\r |
97b38d4e | 1910 | );\r |
1911 | \r | |
1912 | /**\r | |
1913 | Initiate the net buffer queue.\r | |
1914 | \r | |
64a80549 | 1915 | @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.\r |
97b38d4e | 1916 | \r |
1917 | **/\r | |
1918 | VOID\r | |
1919 | EFIAPI\r | |
1920 | NetbufQueInit (\r | |
ae213b7d | 1921 | IN OUT NET_BUF_QUEUE *NbufQue\r |
97b38d4e | 1922 | );\r |
1923 | \r | |
1924 | /**\r | |
7557df4d | 1925 | Allocate and initialize a net buffer queue.\r |
97b38d4e | 1926 | \r |
64a80549 | 1927 | @return The pointer to the allocated net buffer queue, or NULL if the\r |
7557df4d | 1928 | allocation failed due to resource limit.\r |
97b38d4e | 1929 | \r |
1930 | **/\r | |
1931 | NET_BUF_QUEUE *\r | |
1932 | EFIAPI\r | |
1933 | NetbufQueAlloc (\r | |
1934 | VOID\r | |
1935 | );\r | |
1936 | \r | |
1937 | /**\r | |
1204fe83 | 1938 | Free a net buffer queue.\r |
1939 | \r | |
7557df4d | 1940 | Decrease the reference count of the net buffer queue by one. The real resource\r |
1204fe83 | 1941 | free operation isn't performed until the reference count of the net buffer\r |
7557df4d | 1942 | queue is decreased to 0.\r |
97b38d4e | 1943 | \r |
64a80549 | 1944 | @param[in] NbufQue The pointer to the net buffer queue to be freed.\r |
97b38d4e | 1945 | \r |
1946 | **/\r | |
1947 | VOID\r | |
1948 | EFIAPI\r | |
1949 | NetbufQueFree (\r | |
1950 | IN NET_BUF_QUEUE *NbufQue\r | |
1951 | );\r | |
1952 | \r | |
1953 | /**\r | |
7557df4d | 1954 | Remove a net buffer from the head in the specific queue and return it.\r |
97b38d4e | 1955 | \r |
64a80549 | 1956 | @param[in, out] NbufQue The pointer to the net buffer queue.\r |
97b38d4e | 1957 | \r |
64a80549 | 1958 | @return The pointer to the net buffer removed from the specific queue,\r |
7557df4d | 1959 | or NULL if there is no net buffer in the specific queue.\r |
97b38d4e | 1960 | \r |
1961 | **/\r | |
1962 | NET_BUF *\r | |
1963 | EFIAPI\r | |
1964 | NetbufQueRemove (\r | |
ae213b7d | 1965 | IN OUT NET_BUF_QUEUE *NbufQue\r |
97b38d4e | 1966 | );\r |
1967 | \r | |
1968 | /**\r | |
7557df4d | 1969 | Append a net buffer to the net buffer queue.\r |
97b38d4e | 1970 | \r |
64a80549 | 1971 | @param[in, out] NbufQue The pointer to the net buffer queue.\r |
1972 | @param[in, out] Nbuf The pointer to the net buffer to be appended.\r | |
97b38d4e | 1973 | \r |
1974 | **/\r | |
1975 | VOID\r | |
1976 | EFIAPI\r | |
1977 | NetbufQueAppend (\r | |
ae213b7d | 1978 | IN OUT NET_BUF_QUEUE *NbufQue,\r |
1979 | IN OUT NET_BUF *Nbuf\r | |
97b38d4e | 1980 | );\r |
1981 | \r | |
1982 | /**\r | |
7557df4d | 1983 | Copy Len bytes of data from the net buffer queue at the specific offset to the\r |
1984 | destination memory.\r | |
1204fe83 | 1985 | \r |
64a80549 | 1986 | The copying operation is the same as NetbufCopy, but applies to the net buffer\r |
7557df4d | 1987 | queue instead of the net buffer.\r |
1204fe83 | 1988 | \r |
64a80549 | 1989 | @param[in] NbufQue The pointer to the net buffer queue.\r |
7557df4d | 1990 | @param[in] Offset The sequence number of the first byte to copy.\r |
64a80549 | 1991 | @param[in] Len The length of the data to copy.\r |
7557df4d | 1992 | @param[out] Dest The destination of the data to copy to.\r |
1993 | \r | |
1204fe83 | 1994 | @return The length of the actual copied data, or 0 if the offset\r |
7557df4d | 1995 | specified exceeds the total size of net buffer queue.\r |
97b38d4e | 1996 | \r |
1997 | **/\r | |
1998 | UINT32\r | |
1999 | EFIAPI\r | |
2000 | NetbufQueCopy (\r | |
2001 | IN NET_BUF_QUEUE *NbufQue,\r | |
2002 | IN UINT32 Offset,\r | |
2003 | IN UINT32 Len,\r | |
ae213b7d | 2004 | OUT UINT8 *Dest\r |
97b38d4e | 2005 | );\r |
2006 | \r | |
2007 | /**\r | |
3b1464d5 | 2008 | Trim Len bytes of data from the buffer queue and free any net buffer\r |
2009 | that is completely trimmed.\r | |
1204fe83 | 2010 | \r |
7557df4d | 2011 | The trimming operation is the same as NetbufTrim but applies to the net buffer\r |
2012 | queue instead of the net buffer.\r | |
97b38d4e | 2013 | \r |
64a80549 | 2014 | @param[in, out] NbufQue The pointer to the net buffer queue.\r |
2015 | @param[in] Len The length of the data to trim.\r | |
97b38d4e | 2016 | \r |
7557df4d | 2017 | @return The actual length of the data trimmed.\r |
97b38d4e | 2018 | \r |
2019 | **/\r | |
2020 | UINT32\r | |
2021 | EFIAPI\r | |
2022 | NetbufQueTrim (\r | |
ae213b7d | 2023 | IN OUT NET_BUF_QUEUE *NbufQue,\r |
97b38d4e | 2024 | IN UINT32 Len\r |
2025 | );\r | |
2026 | \r | |
2027 | \r | |
2028 | /**\r | |
2029 | Flush the net buffer queue.\r | |
2030 | \r | |
64a80549 | 2031 | @param[in, out] NbufQue The pointer to the queue to be flushed.\r |
97b38d4e | 2032 | \r |
2033 | **/\r | |
2034 | VOID\r | |
2035 | EFIAPI\r | |
2036 | NetbufQueFlush (\r | |
ae213b7d | 2037 | IN OUT NET_BUF_QUEUE *NbufQue\r |
97b38d4e | 2038 | );\r |
2039 | \r | |
2040 | /**\r | |
7557df4d | 2041 | Compute the checksum for a bulk of data.\r |
97b38d4e | 2042 | \r |
64a80549 | 2043 | @param[in] Bulk The pointer to the data.\r |
2044 | @param[in] Len The length of the data, in bytes.\r | |
97b38d4e | 2045 | \r |
ae213b7d | 2046 | @return The computed checksum.\r |
97b38d4e | 2047 | \r |
2048 | **/\r | |
2049 | UINT16\r | |
2050 | EFIAPI\r | |
2051 | NetblockChecksum (\r | |
2052 | IN UINT8 *Bulk,\r | |
2053 | IN UINT32 Len\r | |
2054 | );\r | |
2055 | \r | |
2056 | /**\r | |
2057 | Add two checksums.\r | |
2058 | \r | |
ae213b7d | 2059 | @param[in] Checksum1 The first checksum to be added.\r |
2060 | @param[in] Checksum2 The second checksum to be added.\r | |
97b38d4e | 2061 | \r |
ae213b7d | 2062 | @return The new checksum.\r |
97b38d4e | 2063 | \r |
2064 | **/\r | |
2065 | UINT16\r | |
2066 | EFIAPI\r | |
2067 | NetAddChecksum (\r | |
2068 | IN UINT16 Checksum1,\r | |
2069 | IN UINT16 Checksum2\r | |
2070 | );\r | |
2071 | \r | |
2072 | /**\r | |
2073 | Compute the checksum for a NET_BUF.\r | |
2074 | \r | |
64a80549 | 2075 | @param[in] Nbuf The pointer to the net buffer.\r |
97b38d4e | 2076 | \r |
ae213b7d | 2077 | @return The computed checksum.\r |
97b38d4e | 2078 | \r |
2079 | **/\r | |
2080 | UINT16\r | |
2081 | EFIAPI\r | |
2082 | NetbufChecksum (\r | |
2083 | IN NET_BUF *Nbuf\r | |
2084 | );\r | |
2085 | \r | |
2086 | /**\r | |
1204fe83 | 2087 | Compute the checksum for TCP/UDP pseudo header.\r |
2088 | \r | |
7557df4d | 2089 | Src and Dst are in network byte order, and Len is in host byte order.\r |
97b38d4e | 2090 | \r |
ae213b7d | 2091 | @param[in] Src The source address of the packet.\r |
2092 | @param[in] Dst The destination address of the packet.\r | |
2093 | @param[in] Proto The protocol type of the packet.\r | |
2094 | @param[in] Len The length of the packet.\r | |
97b38d4e | 2095 | \r |
ae213b7d | 2096 | @return The computed checksum.\r |
97b38d4e | 2097 | \r |
2098 | **/\r | |
2099 | UINT16\r | |
2100 | EFIAPI\r | |
2101 | NetPseudoHeadChecksum (\r | |
2102 | IN IP4_ADDR Src,\r | |
2103 | IN IP4_ADDR Dst,\r | |
2104 | IN UINT8 Proto,\r | |
2105 | IN UINT16 Len\r | |
2106 | );\r | |
2107 | \r | |
f6b7393c | 2108 | /**\r |
64a80549 | 2109 | Compute the checksum for the TCP6/UDP6 pseudo header.\r |
1204fe83 | 2110 | \r |
f6b7393c | 2111 | Src and Dst are in network byte order, and Len is in host byte order.\r |
2112 | \r | |
2113 | @param[in] Src The source address of the packet.\r | |
2114 | @param[in] Dst The destination address of the packet.\r | |
2115 | @param[in] NextHeader The protocol type of the packet.\r | |
2116 | @param[in] Len The length of the packet.\r | |
2117 | \r | |
2118 | @return The computed checksum.\r | |
2119 | \r | |
2120 | **/\r | |
2121 | UINT16\r | |
e798cd87 | 2122 | EFIAPI\r |
f6b7393c | 2123 | NetIp6PseudoHeadChecksum (\r |
2124 | IN EFI_IPv6_ADDRESS *Src,\r | |
2125 | IN EFI_IPv6_ADDRESS *Dst,\r | |
2126 | IN UINT8 NextHeader,\r | |
2127 | IN UINT32 Len\r | |
2128 | );\r | |
705f53a9 | 2129 | \r |
2130 | /**\r | |
2131 | The function frees the net buffer which allocated by the IP protocol. It releases \r | |
2132 | only the net buffer and doesn't call the external free function. \r | |
2133 | \r | |
2134 | This function should be called after finishing the process of mIpSec->ProcessExt() \r | |
2135 | for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new \r | |
2136 | buffer for the ESP, so there needs a function to free the old net buffer.\r | |
2137 | \r | |
2138 | @param[in] Nbuf The network buffer to be freed.\r | |
2139 | \r | |
2140 | **/\r | |
2141 | VOID\r | |
2142 | NetIpSecNetbufFree (\r | |
2143 | NET_BUF *Nbuf\r | |
2144 | );\r | |
57b301b5 | 2145 | \r |
2146 | /**\r | |
2147 | This function obtains the system guid from the smbios table.\r | |
2148 | \r | |
2149 | @param[out] SystemGuid The pointer of the returned system guid.\r | |
2150 | \r | |
2151 | @retval EFI_SUCCESS Successfully obtained the system guid.\r | |
2152 | @retval EFI_NOT_FOUND Did not find the SMBIOS table.\r | |
2153 | \r | |
2154 | **/\r | |
2155 | EFI_STATUS\r | |
2156 | EFIAPI\r | |
2157 | NetLibGetSystemGuid (\r | |
2158 | OUT EFI_GUID *SystemGuid\r | |
2159 | );\r | |
2160 | \r | |
dba6e9a9 JW |
2161 | /**\r |
2162 | Create Dns QName according the queried domain name. \r | |
2163 | QName is a domain name represented as a sequence of labels, \r | |
2164 | where each label consists of a length octet followed by that \r | |
2165 | number of octets. The QName terminates with the zero \r | |
2166 | length octet for the null label of the root. Caller should \r | |
2167 | take responsibility to free the buffer in returned pointer.\r | |
2168 | \r | |
2169 | @param DomainName The pointer to the queried domain name string. \r | |
2170 | \r | |
2171 | @retval NULL Failed to fill QName.\r | |
2172 | @return QName filled successfully.\r | |
2173 | \r | |
2174 | **/ \r | |
2175 | CHAR8 *\r | |
2176 | EFIAPI\r | |
2177 | NetLibCreateDnsQName (\r | |
2178 | IN CHAR16 *DomainName\r | |
2179 | );\r | |
2180 | \r | |
97b38d4e | 2181 | #endif\r |