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