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