2 This library provides basic functiosn for UEFI network stack.
4 Copyright (c) 2005 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Library/BaseMemoryLib.h>
20 #include <Library/MemoryAllocationLib.h>
21 #include <Protocol/DriverBinding.h>
22 #include <Protocol/ComponentName.h>
23 #include <Protocol/DriverConfiguration.h>
24 #include <Protocol/DriverDiagnostics.h>
25 #include <Protocol/Dpc.h>
27 typedef UINT32 IP4_ADDR
;
28 typedef UINT32 TCP_SEQNO
;
29 typedef UINT16 TCP_PORTNO
;
32 NET_ETHER_ADDR_LEN
= 6,
33 NET_IFTYPE_ETHERNET
= 0x01,
35 EFI_IP_PROTO_UDP
= 0x11,
36 EFI_IP_PROTO_TCP
= 0x06,
37 EFI_IP_PROTO_ICMP
= 0x01,
40 // The address classfication
54 // Ethernet head definition
57 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
58 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
64 // The EFI_IP4_HEADER is hard to use because the source and
65 // destination address are defined as EFI_IPv4_ADDRESS, which
66 // is a structure. Two structures can't be compared or masked
67 // directly. This is why there is an internal representation.
85 // ICMP head definition. ICMP message is categoried as either an error
86 // message or query message. Two message types have their own head format.
96 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
98 } IP4_ICMP_ERROR_HEAD
;
104 } IP4_ICMP_QUERY_HEAD
;
108 // UDP header definition
119 // TCP header definition
136 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
137 (CompareMem ((pMac1), (pMac2), Len) == 0)
139 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
140 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
142 #define NTOHL(x) (UINT32)((((UINT32) (x) & 0xff) << 24) | \
143 (((UINT32) (x) & 0xff00) << 8) | \
144 (((UINT32) (x) & 0xff0000) >> 8) | \
145 (((UINT32) (x) & 0xff000000) >> 24))
147 #define HTONL(x) NTOHL(x)
149 #define NTOHS(x) (UINT16)((((UINT16) (x) & 0xff) << 8) | \
150 (((UINT16) (x) & 0xff00) >> 8))
152 #define HTONS(x) NTOHS(x)
155 // Test the IP's attribute, All the IPs are in host byte order.
157 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
158 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
159 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
160 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
163 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
165 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
166 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
167 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
170 Return the length of the mask. If the mask is invalid,
171 return the invalid length 33, which is IP4_MASK_NUM.
172 NetMask is in the host byte order.
174 @param NetMask The netmask to get the length from
176 @return The length of the netmask, IP4_MASK_NUM if the mask isn't
187 Return the class of the address, such as class a, b, c.
188 Addr is in host byte order.
190 @param Addr The address to get the class from
192 @return IP address class, such as IP4_ADDR_CLASSA
202 Check whether the IP is a valid unicast address according to
203 the netmask. If NetMask is zero, use the IP address's class to
204 get the default mask.
206 @param Ip The IP to check againist
207 @param NetMask The mask of the IP
209 @return TRUE if IP is a valid unicast address on the network, otherwise FALSE
218 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
221 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
223 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
224 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
225 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
226 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
228 #define TICKS_PER_MS 10000U
229 #define TICKS_PER_SECOND 10000000U
231 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
234 Extract a UINT32 from a byte stream, then convert it to host
235 byte order. Use this function to avoid alignment error.
237 @param Buf The buffer to extract the UINT32.
239 @return The UINT32 extracted.
249 Put a UINT32 to the byte stream. Convert it from host byte order
250 to network byte order before putting.
252 @param Buf The buffer to put the UINT32
253 @param Data The data to put
266 Initialize a random seed using current time.
270 @return The random seed initialized with current time.
280 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
281 _CR(Entry, Type, Field)
283 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
284 CR(Entry, Type, Field, Sig)
287 // Iterate through the doule linked list. It is NOT delete safe
289 #define NET_LIST_FOR_EACH(Entry, ListHead) \
290 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
293 // Iterate through the doule linked list. This is delete-safe.
294 // Don't touch NextEntry. Also, don't use this macro if list
295 // entries other than the Entry may be deleted when processing
296 // the current Entry.
298 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
299 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
300 Entry != (ListHead); \
301 Entry = NextEntry, NextEntry = Entry->ForwardLink \
305 // Make sure the list isn't empty before get the frist/last record.
307 #define NET_LIST_HEAD(ListHead, Type, Field) \
308 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
310 #define NET_LIST_TAIL(ListHead, Type, Field) \
311 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
315 Remove the first entry on the list
317 @param Head The list header
319 @return The entry that is removed from the list, NULL if the list is empty.
329 Remove the last entry on the list
331 @param Head The list head
333 @return The entry that is removed from the list, NULL if the list is empty.
343 Insert the NewEntry after the PrevEntry.
345 @param PrevEntry The previous entry to insert after
346 @param NewEntry The new entry to insert
354 IN LIST_ENTRY
*PrevEntry
,
355 IN LIST_ENTRY
*NewEntry
359 Insert the NewEntry before the PostEntry.
361 @param PostEntry The entry to insert before
362 @param NewEntry The new entry to insert
369 NetListInsertBefore (
370 IN LIST_ENTRY
*PostEntry
,
371 IN LIST_ENTRY
*NewEntry
376 // Object container: EFI network stack spec defines various kinds of
377 // tokens. The drivers can share code to manage those objects.
391 #define NET_MAP_INCREAMENT 64
394 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
396 @param Map The netmap to initialize
408 To clean up the netmap, that is, release allocated memories.
410 @param Map The netmap to clean up.
422 Test whether the netmap is empty
424 @param Map The net map to test
426 @return TRUE if the netmap is empty, otherwise FALSE.
436 Return the number of the <Key, Value> pairs in the netmap.
438 @param Map The netmap to get the entry number
440 @return The entry number in the netmap.
450 Allocate an item to save the <Key, Value> pair to the head of the netmap.
452 @param Map The netmap to insert into
453 @param Key The user's key
454 @param Value The user's value for the key
456 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item
457 @retval EFI_SUCCESS The item is inserted to the head
465 IN VOID
*Value OPTIONAL
469 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
471 @param Map The netmap to insert into
472 @param Key The user's key
473 @param Value The user's value for the key
475 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item
476 @retval EFI_SUCCESS The item is inserted to the tail
484 IN VOID
*Value OPTIONAL
488 Find the key in the netmap
490 @param Map The netmap to search within
491 @param Key The key to search
493 @return The point to the item contains the Key, or NULL if Key isn't in the map.
504 Remove the item from the netmap
506 @param Map The netmap to remove the item from
507 @param Item The item to remove
508 @param Value The variable to receive the value if not NULL
510 @return The key of the removed item.
517 IN NET_MAP_ITEM
*Item
,
518 OUT VOID
**Value OPTIONAL
522 Remove the first entry on the netmap.
524 @param Map The netmap to remove the head from
525 @param Value The variable to receive the value if not NULL
527 @return The key of the item removed
534 OUT VOID
**Value OPTIONAL
538 Remove the last entry on the netmap.
540 @param Map The netmap to remove the tail from
541 @param Value The variable to receive the value if not NULL
543 @return The key of the item removed
550 OUT VOID
**Value OPTIONAL
555 (*NET_MAP_CALLBACK
) (
557 IN NET_MAP_ITEM
*Item
,
562 Iterate through the netmap and call CallBack for each item. It will
563 contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
564 from the loop. It returns the CallBack's last return value. This
565 function is delete safe for the current item.
567 @param Map The Map to iterate through
568 @param CallBack The callback function to call for each item.
569 @param Arg The opaque parameter to the callback
571 @return It returns the CallBack's last return value.
578 IN NET_MAP_CALLBACK CallBack
,
579 IN VOID
*Arg OPTIONAL
584 // Helper functions to implement driver binding and service binding protocols.
587 Create a child of the service that is identified by ServiceBindingGuid.
589 @param ControllerHandle The controller which has the service installed.
590 @param ImageHandle The image handle used to open service.
591 @param ServiceBindingGuid The service's Guid.
592 @param ChildHandle The handle to receive the create child
594 @retval EFI_SUCCESS The child is successfully created.
595 @retval Others Failed to create the child.
600 NetLibCreateServiceChild (
601 IN EFI_HANDLE ControllerHandle
,
602 IN EFI_HANDLE ImageHandle
,
603 IN EFI_GUID
*ServiceBindingGuid
,
604 OUT EFI_HANDLE
*ChildHandle
608 Destory a child of the service that is identified by ServiceBindingGuid.
610 @param ControllerHandle The controller which has the service installed.
611 @param ImageHandle The image handle used to open service.
612 @param ServiceBindingGuid The service's Guid.
613 @param ChildHandle The child to destory
615 @retval EFI_SUCCESS The child is successfully destoried.
616 @retval Others Failed to destory the child.
621 NetLibDestroyServiceChild (
622 IN EFI_HANDLE ControllerHandle
,
623 IN EFI_HANDLE ImageHandle
,
624 IN EFI_GUID
*ServiceBindingGuid
,
625 IN EFI_HANDLE ChildHandle
629 Convert the mac address of the simple network protocol installed on
630 SnpHandle to a unicode string. Callers are responsible for freeing the
633 @param SnpHandle The handle where the simple network protocol is
635 @param ImageHandle The image handle used to act as the agent handle to
636 get the simple network protocol.
637 @param MacString The pointer to store the address of the string
638 representation of the mac address.
640 @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
641 @retval other Failed to open the simple network protocol.
647 IN EFI_HANDLE SnpHandle
,
648 IN EFI_HANDLE ImageHandle
,
649 IN OUT CHAR16
**MacString
653 Create an IPv4 device path node.
655 @param Node Pointer to the IPv4 device path node.
656 @param Controller The handle where the NIC IP4 config protocol resides.
657 @param LocalIp The local IPv4 address.
658 @param LocalPort The local port.
659 @param RemoteIp The remote IPv4 address.
660 @param RemotePort The remote port.
661 @param Protocol The protocol type in the IP header.
662 @param UseDefaultAddress Whether this instance is using default address or not.
668 NetLibCreateIPv4DPathNode (
669 IN OUT IPv4_DEVICE_PATH
*Node
,
670 IN EFI_HANDLE Controller
,
673 IN IP4_ADDR RemoteIp
,
674 IN UINT16 RemotePort
,
676 IN BOOLEAN UseDefaultAddress
680 Find the UNDI/SNP handle from controller and protocol GUID.
681 For example, IP will open a MNP child to transmit/receive
682 packets, when MNP is stopped, IP should also be stopped. IP
683 needs to find its own private data which is related the IP's
684 service binding instance that is install on UNDI/SNP handle.
685 Now, the controller is either a MNP or ARP child handle. But
686 IP opens these handle BY_DRIVER, use that info, we can get the
689 @param Controller Then protocol handle to check
690 @param ProtocolGuid The protocol that is related with the handle.
692 @return The UNDI/SNP handle or NULL.
698 IN EFI_HANDLE Controller
,
699 IN EFI_GUID
*ProtocolGuid
703 Add a Deferred Procedure Call to the end of the DPC queue.
705 @param DpcTpl The EFI_TPL that the DPC should be invoked.
706 @param DpcProcedure Pointer to the DPC's function.
707 @param DpcContext Pointer to the DPC's context. Passed to DpcProcedure
708 when DpcProcedure is invoked.
710 @retval EFI_SUCCESS The DPC was queued.
711 @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL.
712 DpcProcedure is NULL.
713 @retval EFI_OUT_OF_RESOURCES There are not enough resources available to
714 add the DPC to the queue.
721 IN EFI_DPC_PROCEDURE DpcProcedure
,
722 IN VOID
*DpcContext OPTIONAL
726 Add a Deferred Procedure Call to the end of the DPC queue.
728 @retval EFI_SUCCESS One or more DPCs were invoked.
729 @retval EFI_NOT_FOUND No DPCs were invoked.
739 This is the default unload handle for all the network drivers.
741 @param ImageHandle The drivers' driver image.
743 @retval EFI_SUCCESS The image is unloaded.
744 @retval Others Failed to unload the image.
749 NetLibDefaultUnload (
750 IN EFI_HANDLE ImageHandle
757 NET_BUF_SIGNATURE
= EFI_SIGNATURE_32 ('n', 'b', 'u', 'f'),
758 NET_VECTOR_SIGNATURE
= EFI_SIGNATURE_32 ('n', 'v', 'e', 'c'),
759 NET_QUE_SIGNATURE
= EFI_SIGNATURE_32 ('n', 'b', 'q', 'u'),
762 NET_PROTO_DATA
= 64, // Opaque buffer for protocols
763 NET_BUF_HEAD
= 1, // Trim or allocate space from head
764 NET_BUF_TAIL
= 0, // Trim or allocate space from tail
765 NET_VECTOR_OWN_FIRST
= 0x01 // We allocated the 1st block in the vector
766 } NET_SIGNATURE_TYPE
;
768 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
769 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
771 #define NET_SWAP_SHORT(Value) \
772 ((((Value) & 0xff) << 8) | (((Value) >> 8) & 0xff))
775 // Single memory block in the vector.
778 UINT32 Len
; // The block's length
779 UINT8
*Bulk
; // The block's Data
782 typedef VOID (*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
785 //NET_VECTOR contains several blocks to hold all packet's
786 //fragments and other house-keeping stuff for sharing. It
787 //doesn't specify the where actual packet fragment begins.
791 INTN RefCnt
; // Reference count to share NET_VECTOR.
792 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
793 VOID
*Arg
; // opeque argument to Free
794 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
795 UINT32 Len
; // Total length of the assocated BLOCKs
802 //NET_BLOCK_OP operate on the NET_BLOCK, It specifies
803 //where the actual fragment begins and where it ends
806 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
807 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
808 UINT8
*Head
; // 1st byte of the data in the block
809 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
810 UINT32 Size
; // The size of the data
815 //NET_BUF is the buffer manage structure used by the
816 //network stack. Every network packet may be fragmented,
817 //and contains multiple fragments. The Vector points to
818 //memory blocks used by the each fragment, and BlockOp
819 //specifies where each fragment begins and ends.
821 //It also contains a opaque area for protocol to store
822 //per-packet informations. Protocol must be caution not
823 //to overwrite the members after that.
828 LIST_ENTRY List
; // The List this NET_BUF is on
830 IP4_HEAD
*Ip
; // Network layer header, for fast access
831 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
832 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
834 NET_VECTOR
*Vector
; // The vector containing the packet
836 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
837 UINT32 TotalSize
; // Total size of the actual packet
838 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
843 //A queue of NET_BUFs, It is just a thin extension of
849 LIST_ENTRY List
; // The List this buffer queue is on
851 LIST_ENTRY BufList
; // list of queued buffers
852 UINT32 BufSize
; // total length of DATA in the buffers
853 UINT32 BufNum
; // total number of buffers on the chain
857 // Pseudo header for TCP and UDP checksum
870 // The fragment entry table used in network interfaces. This is
871 // the same as NET_BLOCK now. Use two different to distinguish
872 // the two in case that NET_BLOCK be enhanced later.
879 #define NET_GET_REF(PData) ((PData)->RefCnt++)
880 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
881 #define NETBUF_FROM_PROTODATA(Info) _CR((Info), NET_BUF, ProtoData)
883 #define NET_BUF_SHARED(Buf) \
884 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
886 #define NET_VECTOR_SIZE(BlockNum) \
887 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
889 #define NET_BUF_SIZE(BlockOpNum) \
890 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
892 #define NET_HEADSPACE(BlockOp) \
893 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
895 #define NET_TAILSPACE(BlockOp) \
896 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
899 Allocate a single block NET_BUF. Upon allocation, all the
900 free space is in the tail room.
902 @param Len The length of the block.
904 @retval * Pointer to the allocated NET_BUF. If NULL the
905 allocation failed due to resource limit.
915 Free the buffer and its associated NET_VECTOR.
917 @param Nbuf Pointer to the NET_BUF to be freed.
929 Get the position of some byte in the net buffer. This can be used
930 to, for example, retrieve the IP header in the packet. It also
931 returns the fragment that contains the byte which is used mainly by
932 the buffer implementation itself.
934 @param Nbuf Pointer to the net buffer.
935 @param Offset The index or offset of the byte
936 @param Index Index of the fragment that contains the block
938 @retval * Pointer to the nth byte of data in the net buffer.
939 If NULL, there is no such data in the net buffer.
947 OUT UINT32
*Index OPTIONAL
951 Create a copy of NET_BUF that share the associated NET_DATA.
953 @param Nbuf Pointer to the net buffer to be cloned.
955 @retval * Pointer to the cloned net buffer.
965 Create a duplicated copy of Nbuf, data is copied. Also leave some
966 head space before the data.
968 @param Nbuf Pointer to the net buffer to be cloned.
969 @param Duplicate Pointer to the net buffer to duplicate to, if NULL
970 a new net buffer is allocated.
971 @param HeadSpace Length of the head space to reserve
973 @retval * Pointer to the duplicated net buffer.
980 IN NET_BUF
*Duplicate OPTIONAL
,
985 Create a NET_BUF structure which contains Len byte data of
986 Nbuf starting from Offset. A new NET_BUF structure will be
987 created but the associated data in NET_VECTOR is shared.
988 This function exists to do IP packet fragmentation.
990 @param Nbuf Pointer to the net buffer to be cloned.
991 @param Offset Starting point of the data to be included in new
993 @param Len How many data to include in new data
994 @param HeadSpace How many bytes of head space to reserve for
997 @retval * Pointer to the cloned net buffer.
1010 Reserve some space in the header room of the buffer.
1011 Upon allocation, all the space are in the tail room
1012 of the buffer. Call this function to move some space
1013 to the header room. This function is quite limited in
1014 that it can only reserver space from the first block
1015 of an empty NET_BUF not built from the external. But
1016 it should be enough for the network stack.
1018 @param Nbuf Pointer to the net buffer.
1019 @param Len The length of buffer to be reserverd.
1032 Allocate some space from the header or tail of the buffer.
1034 @param Nbuf Pointer to the net buffer.
1035 @param Len The length of the buffer to be allocated.
1036 @param FromHead The flag to indicate whether reserve the data from
1037 head or tail. TRUE for from head, and FALSE for
1040 @retval * Pointer to the first byte of the allocated buffer.
1052 Trim some data from the header or tail of the buffer.
1054 @param Nbuf Pointer to the net buffer.
1055 @param Len The length of the data to be trimmed.
1056 @param FromHead The flag to indicate whether trim data from head or
1057 tail. TRUE for from head, and FALSE for from tail.
1059 @retval UINTN Length of the actually trimmed data.
1071 Copy the data from the specific offset to the destination.
1073 @param Nbuf Pointer to the net buffer.
1074 @param Offset The sequence number of the first byte to copy.
1075 @param Len Length of the data to copy.
1076 @param Dest The destination of the data to copy to.
1078 @retval UINTN The length of the copied data.
1091 Build a NET_BUF from external blocks.
1093 @param ExtFragment Pointer to the data block.
1094 @param ExtNum The number of the data block.
1095 @param HeadSpace The head space to be reserved.
1096 @param HeadLen The length of the protocol header, This function
1097 will pull that number of data into a linear block.
1098 @param ExtFree Pointer to the caller provided free function.
1099 @param Arg The argument passed to ExtFree when ExtFree is
1102 @retval * Pointer to the net buffer built from the data
1109 IN NET_FRAGMENT
*ExtFragment
,
1111 IN UINT32 HeadSpace
,
1113 IN NET_VECTOR_EXT_FREE ExtFree
,
1114 IN VOID
*Arg OPTIONAL
1118 Build a fragment table to contain the fragments in the
1119 buffer. This is the opposite of the NetbufFromExt.
1121 @param Nbuf Point to the net buffer
1122 @param ExtFragment Pointer to the data block.
1123 @param ExtNum The number of the data block.
1125 @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than ExtNum
1126 @retval EFI_SUCCESS Fragment table built.
1133 IN NET_FRAGMENT
*ExtFragment
,
1138 Build a NET_BUF from a list of NET_BUF.
1140 @param BufList A List of NET_BUF.
1141 @param HeadSpace The head space to be reserved.
1142 @param HeaderLen The length of the protocol header, This function
1143 will pull that number of data into a linear block.
1144 @param ExtFree Pointer to the caller provided free function.
1145 @param Arg The argument passed to ExtFree when ExtFree is
1148 @retval * Pointer to the net buffer built from the data
1155 IN LIST_ENTRY
*BufList
,
1156 IN UINT32 HeadSpace
,
1157 IN UINT32 HeaderLen
,
1158 IN NET_VECTOR_EXT_FREE ExtFree
,
1159 IN VOID
*Arg OPTIONAL
1163 Free a list of net buffers.
1165 @param Head Pointer to the head of linked net buffers.
1177 Initiate the net buffer queue.
1179 @param NbufQue Pointer to the net buffer queue to be initiated.
1187 IN NET_BUF_QUEUE
*NbufQue
1191 Allocate an initialized net buffer queue.
1195 @retval * Pointer to the allocated net buffer queue.
1205 Free a net buffer queue.
1207 @param NbufQue Poitner to the net buffer queue to be freed.
1215 IN NET_BUF_QUEUE
*NbufQue
1219 Remove a net buffer from head in the specific queue.
1221 @param NbufQue Pointer to the net buffer queue.
1223 @retval * Pointer to the net buffer removed from the specific
1230 IN NET_BUF_QUEUE
*NbufQue
1234 Append a buffer to the end of the queue.
1236 @param NbufQue Pointer to the net buffer queue.
1237 @param Nbuf Pointer to the net buffer to be appended.
1245 IN NET_BUF_QUEUE
*NbufQue
,
1250 Copy some data from the buffer queue to the destination.
1252 @param NbufQue Pointer to the net buffer queue.
1253 @param Offset The sequence number of the first byte to copy.
1254 @param Len Length of the data to copy.
1255 @param Dest The destination of the data to copy to.
1257 @retval UINTN The length of the copied data.
1263 IN NET_BUF_QUEUE
*NbufQue
,
1270 Trim some data from the queue header, release the buffer if
1271 whole buffer is trimmed.
1273 @param NbufQue Pointer to the net buffer queue.
1274 @param Len Length of the data to trim.
1276 @retval UINTN The length of the data trimmed.
1282 IN NET_BUF_QUEUE
*NbufQue
,
1288 Flush the net buffer queue.
1290 @param NbufQue Pointer to the queue to be flushed.
1298 IN NET_BUF_QUEUE
*NbufQue
1302 Compute checksum for a bulk of data.
1304 @param Bulk Pointer to the data.
1305 @param Len Length of the data, in bytes.
1307 @retval UINT16 The computed checksum.
1320 @param Checksum1 The first checksum to be added.
1321 @param Checksum2 The second checksum to be added.
1323 @retval UINT16 The new checksum.
1329 IN UINT16 Checksum1
,
1334 Compute the checksum for a NET_BUF.
1336 @param Nbuf Pointer to the net buffer.
1338 @retval UINT16 The computed checksum.
1348 Compute the checksum for TCP/UDP pseudo header.
1349 Src, Dst are in network byte order. and Len is
1352 @param Src The source address of the packet.
1353 @param Dst The destination address of the packet.
1354 @param Proto The protocol type of the packet.
1355 @param Len The length of the packet.
1357 @retval UINT16 The computed checksum.
1362 NetPseudoHeadChecksum (