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