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