diff options
| author | vanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-11 03:36:07 +0000 |
|---|---|---|
| committer | vanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-11 03:36:07 +0000 |
| commit | 7b414b4ed6ccdefce8e167ecc7d67ad64118eb94 (patch) | |
| tree | 8ac9f25a508ec3f38ee50c3d43a1282c06605330 /MdeModulePkg/Include | |
| parent | 987da598355ba96e9eb8b78fc4bdca4c3faedfe5 (diff) | |
| download | edk2-7b414b4ed6ccdefce8e167ecc7d67ad64118eb94.zip edk2-7b414b4ed6ccdefce8e167ecc7d67ad64118eb94.tar.gz edk2-7b414b4ed6ccdefce8e167ecc7d67ad64118eb94.tar.bz2 | |
1. add public functions header.
2. apply for doxgen format for file header.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5043 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
| -rw-r--r-- | MdeModulePkg/Include/Library/DpcLib.h | 2 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Library/IpIoLib.h | 144 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Library/NetLib.h | 653 | ||||
| -rw-r--r-- | MdeModulePkg/Include/Library/UdpIoLib.h | 93 |
4 files changed, 857 insertions, 35 deletions
diff --git a/MdeModulePkg/Include/Library/DpcLib.h b/MdeModulePkg/Include/Library/DpcLib.h index 7771afb..dce2ec2 100644 --- a/MdeModulePkg/Include/Library/DpcLib.h +++ b/MdeModulePkg/Include/Library/DpcLib.h @@ -41,6 +41,7 @@ Abstract: **/
EFI_STATUS
+EFIAPI
QueueDpc (
IN EFI_TPL DpcTpl,
IN EFI_DPC_PROCEDURE DpcProcedure,
@@ -58,6 +59,7 @@ QueueDpc ( **/
EFI_STATUS
+EFIAPI
DispatchDpc (
VOID
);
diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h index 3e9bde9..acee69f 100644 --- a/MdeModulePkg/Include/Library/IpIoLib.h +++ b/MdeModulePkg/Include/Library/IpIoLib.h @@ -1,6 +1,7 @@ /** @file + This library provides IpIo layer upon EFI IP4 Protocol.
-Copyright (c) 2005 - 2007, Intel Corporation +Copyright (c) 2005 - 2008, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -9,13 +10,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - IpIo.h - -Abstract: - - **/ #ifndef _IP_IO_H_ @@ -176,29 +170,90 @@ typedef struct _IP_IO_IP_INFO { INTN RefCnt; } IP_IO_IP_INFO; +/**
+ Create a new IP_IO instance.
+
+ @param Image The image handle of an IP_IO consumer protocol.
+ @param Controller The controller handle of an IP_IO consumer protocol
+ installed on.
+
+ @return Pointer to a newly created IP_IO instance.
+
+**/ IP_IO * +EFIAPI IpIoCreate ( IN EFI_HANDLE Image, IN EFI_HANDLE Controller ); +/**
+ Destroy an IP_IO instance.
+
+ @param IpIo Pointer to the IP_IO instance that needs to
+ destroy.
+
+ @retval EFI_SUCCESS The IP_IO instance destroyed successfully.
+ @retval other Error condition occurred.
+
+**/ EFI_STATUS +EFIAPI IpIoDestroy ( IN IP_IO *IpIo ); +/**
+ Stop an IP_IO instance.
+
+ @param IpIo Pointer to the IP_IO instance that needs to stop.
+
+ @retval EFI_SUCCESS The IP_IO instance stopped successfully.
+ @retval other Error condition occurred.
+
+**/ EFI_STATUS +EFIAPI IpIoStop ( IN IP_IO *IpIo ); +/**
+ Open an IP_IO instance for use.
+
+ @param IpIo Pointer to an IP_IO instance that needs to open.
+ @param OpenData The configuration data for the IP_IO instance.
+
+ @retval EFI_SUCCESS The IP_IO instance opened with OpenData
+ successfully.
+ @retval other Error condition occurred.
+
+**/ EFI_STATUS IpIoOpen ( IN IP_IO *IpIo, IN IP_IO_OPEN_DATA *OpenData ); +/**
+ Send out an IP packet.
+
+ @param IpIo Pointer to an IP_IO instance used for sending IP
+ packet.
+ @param Pkt Pointer to the IP packet to be sent.
+ @param Sender The IP protocol instance used for sending.
+ @param NotifyData
+ @param Dest The destination IP address to send this packet to.
+ @param OverrideData The data to override some configuration of the IP
+ instance used for sending.
+
+ @retval EFI_SUCCESS The operation is completed successfully.
+ @retval EFI_NOT_STARTED The IpIo is not configured.
+ @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
+
+**/ EFI_STATUS +EFIAPI IpIoSend ( IN IP_IO *IpIo, IN NET_BUF *Pkt, @@ -209,36 +264,109 @@ IpIoSend ( IN IP_IO_OVERRIDE *OverrideData ); +/**
+ Add a new IP instance for sending data.
+
+ @param IpIo Pointer to a IP_IO instance to add a new IP
+ instance for sending purpose.
+
+ @return Pointer to the created IP_IO_IP_INFO structure, NULL is failed.
+
+**/ VOID +EFIAPI IpIoCancelTxToken ( IN IP_IO *IpIo, IN VOID *Packet ); +/**
+ Add a new IP instance for sending data.
+
+ @param IpIo Pointer to a IP_IO instance to add a new IP
+ instance for sending purpose.
+
+ @return Pointer to the created IP_IO_IP_INFO structure, NULL is failed.
+
+**/ IP_IO_IP_INFO * +EFIAPI IpIoAddIp ( IN IP_IO *IpIo ); +/**
+ Configure the IP instance of this IpInfo and start the receiving if Ip4ConfigData
+ is not NULL.
+
+ @param IpInfo Pointer to the IP_IO_IP_INFO instance.
+ @param Ip4ConfigData The IP4 configure data used to configure the ip
+ instance, if NULL the ip instance is reseted. If
+ UseDefaultAddress is set to TRUE, and the configure
+ operation succeeds, the default address information
+ is written back in this Ip4ConfigData.
+
+ @retval EFI_STATUS The status returned by IP4->Configure or
+ IP4->Receive.
+
+**/ EFI_STATUS +EFIAPI IpIoConfigIp ( IN IP_IO_IP_INFO *IpInfo, IN OUT EFI_IP4_CONFIG_DATA *Ip4ConfigData OPTIONAL ); +/**
+ Destroy an IP instance maintained in IpIo->IpList for
+ sending purpose.
+
+ @param IpIo Pointer to the IP_IO instance.
+ @param IpInfo Pointer to the IpInfo to be removed.
+
+ @return None.
+
+**/ VOID +EFIAPI IpIoRemoveIp ( IN IP_IO *IpIo, IN IP_IO_IP_INFO *IpInfo ); +/**
+ Find the first IP protocol maintained in IpIo whose local
+ address is the same with Src.
+
+ @param IpIo Pointer to the pointer of the IP_IO instance.
+ @param Src The local IP address.
+
+ @return Pointer to the IP protocol can be used for sending purpose and its local
+ @return address is the same with Src.
+
+**/ IP_IO_IP_INFO * +EFIAPI IpIoFindSender ( IN OUT IP_IO **IpIo, IN IP4_ADDR Src ); +/**
+ Get the ICMP error map information, the ErrorStatus will be returned.
+ The IsHard and Notify are optional. If they are not NULL, this rouine will
+ fill them.
+ We move IcmpErrMap[] to local variable to enable EBC build.
+
+ @param IcmpError IcmpError Type
+ @param IsHard Whether it is a hard error
+ @param Notify Whether it need to notify SockError
+
+ @return ICMP Error Status
+
+**/
EFI_STATUS +EFIAPI IpIoGetIcmpErrStatus ( IN ICMP_ERROR IcmpError, OUT BOOLEAN *IsHard, OPTIONAL diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h index 4578d87..cb7b65c 100644 --- a/MdeModulePkg/Include/Library/NetLib.h +++ b/MdeModulePkg/Include/Library/NetLib.h @@ -1,6 +1,7 @@ /** @file + This library provides basic functiosn for UEFI network stack. -Copyright (c) 2005 - 2007, Intel Corporation +Copyright (c) 2005 - 2008, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -9,15 +10,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - NetLib.h - -Abstract: - - Library for the UEFI network stack. - - **/ #ifndef _NET_LIB_H_ @@ -174,16 +166,49 @@ typedef struct { #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp)))) #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0) +/**
+ Return the length of the mask. If the mask is invalid,
+ return the invalid length 33, which is IP4_MASK_NUM.
+ NetMask is in the host byte order.
+
+ @param NetMask The netmask to get the length from
+
+ @return The length of the netmask, IP4_MASK_NUM if the mask isn't
+ @return supported.
+
+**/ INTN +EFIAPI NetGetMaskLength ( IN IP4_ADDR Mask ); +/**
+ Return the class of the address, such as class a, b, c.
+ Addr is in host byte order.
+
+ @param Addr The address to get the class from
+
+ @return IP address class, such as IP4_ADDR_CLASSA
+
+**/ INTN +EFIAPI NetGetIpClass ( IN IP4_ADDR Addr ); +/**
+ Check whether the IP is a valid unicast address according to
+ the netmask. If NetMask is zero, use the IP address's class to
+ get the default mask.
+
+ @param Ip The IP to check againist
+ @param NetMask The mask of the IP
+
+ @return TRUE if IP is a valid unicast address on the network, otherwise FALSE
+
+**/ BOOLEAN Ip4IsUnicast ( IN IP4_ADDR Ip, @@ -205,19 +230,48 @@ extern EFI_IPv4_ADDRESS mZeroIp4Addr; #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL) - +/**
+ Extract a UINT32 from a byte stream, then convert it to host
+ byte order. Use this function to avoid alignment error.
+
+ @param Buf The buffer to extract the UINT32.
+
+ @return The UINT32 extracted.
+
+**/ UINT32 +EFIAPI NetGetUint32 ( IN UINT8 *Buf ); +/**
+ Put a UINT32 to the byte stream. Convert it from host byte order
+ to network byte order before putting.
+
+ @param Buf The buffer to put the UINT32
+ @param Data The data to put
+
+ @return None
+
+**/ VOID +EFIAPI NetPutUint32 ( IN UINT8 *Buf, IN UINT32 Data ); +/**
+ Initialize a random seed using current time.
+
+ None
+
+ @return The random seed initialized with current time.
+
+**/ UINT32 +EFIAPI NetRandomInitSeed ( VOID ); @@ -257,23 +311,61 @@ NetRandomInitSeed ( NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field) +/**
+ Remove the first entry on the list
+
+ @param Head The list header
+
+ @return The entry that is removed from the list, NULL if the list is empty.
+
+**/ LIST_ENTRY * +EFIAPI NetListRemoveHead ( LIST_ENTRY *Head ); +/**
+ Remove the last entry on the list
+
+ @param Head The list head
+
+ @return The entry that is removed from the list, NULL if the list is empty.
+
+**/ LIST_ENTRY * +EFIAPI NetListRemoveTail ( LIST_ENTRY *Head ); +/**
+ Insert the NewEntry after the PrevEntry
+
+ @param PrevEntry The previous entry to insert after
+ @param NewEntry The new entry to insert
+
+ @return None
+
+**/ VOID +EFIAPI NetListInsertAfter ( IN LIST_ENTRY *PrevEntry, IN LIST_ENTRY *NewEntry ); +/**
+ Insert the NewEntry before the PostEntry
+
+ @param PostEntry The entry to insert before
+ @param NewEntry The new entry to insert
+
+ @return None
+
+**/ VOID +EFIAPI NetListInsertBefore ( IN LIST_ENTRY *PostEntry, IN LIST_ENTRY *NewEntry @@ -298,60 +390,161 @@ typedef struct { #define NET_MAP_INCREAMENT 64 +/**
+ Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
+
+ @param Map The netmap to initialize
+
+ @return None
+
+**/ VOID +EFIAPI NetMapInit ( IN NET_MAP *Map ); +/**
+ To clean up the netmap, that is, release allocated memories.
+
+ @param Map The netmap to clean up.
+
+ @return None
+
+**/ VOID +EFIAPI NetMapClean ( IN NET_MAP *Map ); +/**
+ Test whether the netmap is empty
+
+ @param Map The net map to test
+
+ @return TRUE if the netmap is empty, otherwise FALSE.
+
+**/ BOOLEAN +EFIAPI NetMapIsEmpty ( IN NET_MAP *Map ); +/**
+ Return the number of the <Key, Value> pairs in the netmap.
+
+ @param Map The netmap to get the entry number
+
+ @return The entry number in the netmap.
+
+**/ UINTN +EFIAPI NetMapGetCount ( IN NET_MAP *Map ); +/**
+ Allocate an item to save the <Key, Value> pair to the head of the netmap.
+
+ @param Map The netmap to insert into
+ @param Key The user's key
+ @param Value The user's value for the key
+
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item
+ @retval EFI_SUCCESS The item is inserted to the head
+
+**/ EFI_STATUS +EFIAPI NetMapInsertHead ( IN NET_MAP *Map, IN VOID *Key, IN VOID *Value OPTIONAL ); +/**
+ Allocate an item to save the <Key, Value> pair to the tail of the netmap.
+
+ @param Map The netmap to insert into
+ @param Key The user's key
+ @param Value The user's value for the key
+
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item
+ @retval EFI_SUCCESS The item is inserted to the tail
+
+**/ EFI_STATUS +EFIAPI NetMapInsertTail ( IN NET_MAP *Map, IN VOID *Key, IN VOID *Value OPTIONAL ); +/**
+ Find the key in the netmap
+
+ @param Map The netmap to search within
+ @param Key The key to search
+
+ @return The point to the item contains the Key, or NULL if Key isn't in the map.
+
+**/ NET_MAP_ITEM * +EFIAPI NetMapFindKey ( IN NET_MAP *Map, IN VOID *Key ); +/**
+ Remove the item from the netmap
+
+ @param Map The netmap to remove the item from
+ @param Item The item to remove
+ @param Value The variable to receive the value if not NULL
+
+ @return The key of the removed item.
+
+**/ VOID * +EFIAPI NetMapRemoveItem ( IN NET_MAP *Map, IN NET_MAP_ITEM *Item, OUT VOID **Value OPTIONAL ); +/**
+ Remove the first entry on the netmap
+
+ @param Map The netmap to remove the head from
+ @param Value The variable to receive the value if not NULL
+
+ @return The key of the item removed
+
+**/ VOID * +EFIAPI NetMapRemoveHead ( IN NET_MAP *Map, OUT VOID **Value OPTIONAL ); +/**
+ Remove the last entry on the netmap
+
+ @param Map The netmap to remove the tail from
+ @param Value The variable to receive the value if not NULL
+
+ @return The key of the item removed
+
+**/ VOID * +EFIAPI NetMapRemoveTail ( IN NET_MAP *Map, OUT VOID **Value OPTIONAL @@ -365,7 +558,21 @@ EFI_STATUS IN VOID *Arg ); +/**
+ Iterate through the netmap and call CallBack for each item. It will
+ contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
+ from the loop. It returns the CallBack's last return value. This
+ function is delete safe for the current item.
+
+ @param Map The Map to iterate through
+ @param CallBack The callback function to call for each item.
+ @param Arg The opaque parameter to the callback
+
+ @return It returns the CallBack's last return value.
+
+**/ EFI_STATUS +EFIAPI NetMapIterate ( IN NET_MAP *Map, IN NET_MAP_CALLBACK CallBack, @@ -376,7 +583,20 @@ NetMapIterate ( // // Helper functions to implement driver binding and service binding protocols. // +/**
+ Create a child of the service that is identified by ServiceBindingGuid.
+
+ @param Controller The controller which has the service installed.
+ @param Image The image handle used to open service.
+ @param ServiceBindingGuid The service's Guid.
+ @param ChildHandle The handle to receive the create child
+
+ @retval EFI_SUCCESS The child is successfully created.
+ @retval Others Failed to create the child.
+
+**/ EFI_STATUS +EFIAPI NetLibCreateServiceChild ( IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ImageHandle, @@ -384,7 +604,20 @@ NetLibCreateServiceChild ( OUT EFI_HANDLE *ChildHandle ); +/**
+ Destory a child of the service that is identified by ServiceBindingGuid.
+
+ @param Controller The controller which has the service installed.
+ @param Image The image handle used to open service.
+ @param ServiceBindingGuid The service's Guid.
+ @param ChildHandle The child to destory
+
+ @retval EFI_SUCCESS The child is successfully destoried.
+ @retval Others Failed to destory the child.
+
+**/ EFI_STATUS +EFIAPI NetLibDestroyServiceChild ( IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ImageHandle, @@ -392,14 +625,46 @@ NetLibDestroyServiceChild ( IN EFI_HANDLE ChildHandle ); +/**
+ Convert the mac address of the simple network protocol installed on
+ SnpHandle to a unicode string. Callers are responsible for freeing the
+ string storage.
+
+ @param SnpHandle The handle where the simple network protocol is
+ installed on.
+ @param ImageHandle The image handle used to act as the agent handle to
+ get the simple network protocol.
+ @param MacString The pointer to store the address of the string
+ representation of the mac address.
+
+ @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
+ @retval other Failed to open the simple network protocol.
+
+**/ EFI_STATUS +EFIAPI NetLibGetMacString ( IN EFI_HANDLE SnpHandle, IN EFI_HANDLE ImageHandle, IN OUT CHAR16 **MacString ); +/**
+ Create an IPv4 device path node.
+
+ @param Node Pointer to the IPv4 device path node.
+ @param Controller The handle where the NIC IP4 config protocol resides.
+ @param LocalIp The local IPv4 address.
+ @param LocalPort The local port.
+ @param RemoteIp The remote IPv4 address.
+ @param RemotePort The remote port.
+ @param Protocol The protocol type in the IP header.
+ @param UseDefaultAddress Whether this instance is using default address or not.
+
+ @retval None
+**/ VOID +EFIAPI NetLibCreateIPv4DPathNode ( IN OUT IPv4_DEVICE_PATH *Node, IN EFI_HANDLE Controller, @@ -411,24 +676,77 @@ NetLibCreateIPv4DPathNode ( IN BOOLEAN UseDefaultAddress ); +/**
+ Find the UNDI/SNP handle from controller and protocol GUID.
+ For example, IP will open a MNP child to transmit/receive
+ packets, when MNP is stopped, IP should also be stopped. IP
+ needs to find its own private data which is related the IP's
+ service binding instance that is install on UNDI/SNP handle.
+ Now, the controller is either a MNP or ARP child handle. But
+ IP opens these handle BY_DRIVER, use that info, we can get the
+ UNDI/SNP handle.
+
+ @param Controller Then protocol handle to check
+ @param ProtocolGuid The protocol that is related with the handle.
+
+ @return The UNDI/SNP handle or NULL.
+
+**/ EFI_HANDLE +EFIAPI NetLibGetNicHandle ( IN EFI_HANDLE Controller, IN EFI_GUID *ProtocolGuid ); +/**
+ Add a Deferred Procedure Call to the end of the DPC queue.
+
+ @DpcTpl The EFI_TPL that the DPC should be invoked.
+ @DpcProcedure Pointer to the DPC's function.
+ @DpcContext Pointer to the DPC's context. Passed to DpcProcedure
+ when DpcProcedure is invoked.
+
+ @retval EFI_SUCCESS The DPC was queued.
+ @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL.
+ DpcProcedure is NULL.
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to
+ add the DPC to the queue.
+
+**/ EFI_STATUS +EFIAPI NetLibQueueDpc ( IN EFI_TPL DpcTpl, IN EFI_DPC_PROCEDURE DpcProcedure, IN VOID *DpcContext OPTIONAL ); +/**
+ Add a Deferred Procedure Call to the end of the DPC queue.
+
+ @retval EFI_SUCCESS One or more DPCs were invoked.
+ @retval EFI_NOT_FOUND No DPCs were invoked.
+
+**/ EFI_STATUS +EFIAPI NetLibDispatchDpc ( VOID ); +/**
+ The constructor function caches the pointer to DPC protocol.
+
+ The constructor function locates DPC protocol from protocol database.
+ It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
+
+ @param ImageHandle The firmware allocated handle for the EFI image.
+ @param SystemTable A pointer to the EFI System Table.
+
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
+
+**/ EFI_STATUS EFIAPI NetLibDefaultUnload ( @@ -580,37 +898,110 @@ typedef struct { #define NET_TAILSPACE(BlockOp) \ (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail) +/**
+ Allocate a single block NET_BUF. Upon allocation, all the
+ free space is in the tail room.
+
+ @param Len The length of the block.
+
+ @retval * Pointer to the allocated NET_BUF. If NULL the
+ allocation failed due to resource limit.
+
+**/ NET_BUF * +EFIAPI NetbufAlloc ( IN UINT32 Len ); +/**
+ Free the buffer and its associated NET_VECTOR.
+
+ @param Nbuf Pointer to the NET_BUF to be freed.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufFree ( IN NET_BUF *Nbuf ); - +/**
+ Get the position of some byte in the net buffer. This can be used
+ to, for example, retrieve the IP header in the packet. It also
+ returns the fragment that contains the byte which is used mainly by
+ the buffer implementation itself.
+
+ @param Nbuf Pointer to the net buffer.
+ @param Offset The index or offset of the byte
+ @param Index Index of the fragment that contains the block
+
+ @retval * Pointer to the nth byte of data in the net buffer.
+ If NULL, there is no such data in the net buffer.
+
+**/ UINT8 * +EFIAPI NetbufGetByte ( IN NET_BUF *Nbuf, IN UINT32 Offset, OUT UINT32 *Index OPTIONAL ); +/**
+ Create a copy of NET_BUF that share the associated NET_DATA.
+
+ @param Nbuf Pointer to the net buffer to be cloned.
+
+ @retval * Pointer to the cloned net buffer.
+
+**/ NET_BUF * +EFIAPI NetbufClone ( IN NET_BUF *Nbuf ); +/**
+ Create a duplicated copy of Nbuf, data is copied. Also leave some
+ head space before the data.
+
+ @param Nbuf Pointer to the net buffer to be cloned.
+ @param Duplicate Pointer to the net buffer to duplicate to, if NULL
+ a new net buffer is allocated.
+ @param HeadSpace Length of the head space to reserve
+
+ @retval * Pointer to the duplicated net buffer.
+
+**/ NET_BUF * +EFIAPI NetbufDuplicate ( IN NET_BUF *Nbuf, IN NET_BUF *Duplicate OPTIONAL, IN UINT32 HeadSpace ); +/**
+ Create a NET_BUF structure which contains Len byte data of
+ Nbuf starting from Offset. A new NET_BUF structure will be
+ created but the associated data in NET_VECTOR is shared.
+ This function exists to do IP packet fragmentation.
+
+ @param Nbuf Pointer to the net buffer to be cloned.
+ @param Offset Starting point of the data to be included in new
+ buffer.
+ @param Len How many data to include in new data
+ @param HeadSpace How many bytes of head space to reserve for
+ protocol header
+
+ @retval * Pointer to the cloned net buffer.
+
+**/ NET_BUF * +EFIAPI NetbufGetFragment ( IN NET_BUF *Nbuf, IN UINT32 Offset, @@ -618,27 +1009,80 @@ NetbufGetFragment ( IN UINT32 HeadSpace ); +/**
+ Reserve some space in the header room of the buffer.
+ Upon allocation, all the space are in the tail room
+ of the buffer. Call this function to move some space
+ to the header room. This function is quite limited in
+ that it can only reserver space from the first block
+ of an empty NET_BUF not built from the external. But
+ it should be enough for the network stack.
+
+ @param Nbuf Pointer to the net buffer.
+ @param Len The length of buffer to be reserverd.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufReserve ( IN NET_BUF *Nbuf, IN UINT32 Len ); +/**
+ Allocate some space from the header or tail of the buffer.
+
+ @param Nbuf Pointer to the net buffer.
+ @param Len The length of the buffer to be allocated.
+ @param FromHead The flag to indicate whether reserve the data from
+ head or tail. TRUE for from head, and FALSE for
+ from tail.
+
+ @retval * Pointer to the first byte of the allocated buffer.
+
+**/ UINT8 * +EFIAPI NetbufAllocSpace ( IN NET_BUF *Nbuf, IN UINT32 Len, IN BOOLEAN FromHead ); +/**
+ Trim some data from the header or tail of the buffer.
+
+ @param Nbuf Pointer to the net buffer.
+ @param Len The length of the data to be trimmed.
+ @param FromHead The flag to indicate whether trim data from head or
+ tail. TRUE for from head, and FALSE for from tail.
+
+ @retval UINTN Length of the actually trimmed data.
+
+**/ UINT32 +EFIAPI NetbufTrim ( IN NET_BUF *Nbuf, IN UINT32 Len, IN BOOLEAN FromHead ); +/**
+ Copy the data from the specific offset to the destination.
+
+ @param Nbuf Pointer to the net buffer.
+ @param Offset The sequence number of the first byte to copy.
+ @param Len Length of the data to copy.
+ @param Dest The destination of the data to copy to.
+
+ @retval UINTN The length of the copied data.
+
+**/ UINT32 +EFIAPI NetbufCopy ( IN NET_BUF *Nbuf, IN UINT32 Offset, @@ -646,7 +1090,24 @@ NetbufCopy ( IN UINT8 *Dest ); +/**
+ Build a NET_BUF from external blocks.
+
+ @param ExtFragment Pointer to the data block.
+ @param ExtNum The number of the data block.
+ @param HeadSpace The head space to be reserved.
+ @param HeadLen The length of the protocol header, This function
+ will pull that number of data into a linear block.
+ @param ExtFree Pointer to the caller provided free function.
+ @param Arg The argument passed to ExtFree when ExtFree is
+ called.
+
+ @retval * Pointer to the net buffer built from the data
+ blocks.
+
+**/ NET_BUF * +EFIAPI NetbufFromExt ( IN NET_FRAGMENT *ExtFragment, IN UINT32 ExtNum, @@ -656,14 +1117,43 @@ NetbufFromExt ( IN VOID *Arg OPTIONAL ); +/**
+ Build a fragment table to contain the fragments in the
+ buffer. This is the opposite of the NetbufFromExt.
+
+ @param Nbuf Point to the net buffer
+ @param ExtFragment Pointer to the data block.
+ @param ExtNum The number of the data block.
+
+ @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than ExtNum
+ @retval EFI_SUCCESS Fragment table built.
+
+**/ EFI_STATUS +EFIAPI NetbufBuildExt ( IN NET_BUF *Nbuf, IN NET_FRAGMENT *ExtFragment, IN UINT32 *ExtNum ); +/**
+ Build a NET_BUF from a list of NET_BUF.
+
+ @param BufList A List of NET_BUF.
+ @param HeadSpace The head space to be reserved.
+ @param HeaderLen The length of the protocol header, This function
+ will pull that number of data into a linear block.
+ @param ExtFree Pointer to the caller provided free function.
+ @param Arg The argument passed to ExtFree when ExtFree is
+ called.
+
+ @retval * Pointer to the net buffer built from the data
+ blocks.
+
+**/ NET_BUF * +EFIAPI NetbufFromBufList ( IN LIST_ENTRY *BufList, IN UINT32 HeadSpace, @@ -672,74 +1162,207 @@ NetbufFromBufList ( IN VOID *Arg OPTIONAL ); +/**
+ Free a list of net buffers.
+
+ @param Head Pointer to the head of linked net buffers.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufFreeList ( IN LIST_ENTRY *Head ); +/**
+ Initiate the net buffer queue.
+
+ @param NbufQue Pointer to the net buffer queue to be initiated.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufQueInit ( IN NET_BUF_QUEUE *NbufQue ); +/**
+ Allocate an initialized net buffer queue.
+
+ None.
+
+ @retval * Pointer to the allocated net buffer queue.
+
+**/ NET_BUF_QUEUE * +EFIAPI NetbufQueAlloc ( VOID ); +/**
+ Free a net buffer queue.
+
+ @param NbufQue Poitner to the net buffer queue to be freed.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufQueFree ( IN NET_BUF_QUEUE *NbufQue ); +/**
+ Remove a net buffer from head in the specific queue.
+
+ @param NbufQue Pointer to the net buffer queue.
+
+ @retval * Pointer to the net buffer removed from the specific
+ queue.
+
+**/ NET_BUF * +EFIAPI NetbufQueRemove ( IN NET_BUF_QUEUE *NbufQue ); +/**
+ Append a buffer to the end of the queue.
+
+ @param NbufQue Pointer to the net buffer queue.
+ @param Nbuf Pointer to the net buffer to be appended.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufQueAppend ( IN NET_BUF_QUEUE *NbufQue, IN NET_BUF *Nbuf ); - +
+/**
+ Copy some data from the buffer queue to the destination.
+
+ @param NbufQue Pointer to the net buffer queue.
+ @param Offset The sequence number of the first byte to copy.
+ @param Len Length of the data to copy.
+ @param Dest The destination of the data to copy to.
+
+ @retval UINTN The length of the copied data.
+
+**/ UINT32 +EFIAPI NetbufQueCopy ( IN NET_BUF_QUEUE *NbufQue, IN UINT32 Offset, IN UINT32 Len, IN UINT8 *Dest ); - +
+/**
+ Copy some data from the buffer queue to the destination.
+
+ @param NbufQue Pointer to the net buffer queue.
+ @param Offset The sequence number of the first byte to copy.
+ @param Len Length of the data to copy.
+ @param Dest The destination of the data to copy to.
+
+ @retval UINTN The length of the copied data.
+
+**/ UINT32 +EFIAPI NetbufQueTrim ( IN NET_BUF_QUEUE *NbufQue, IN UINT32 Len ); +
+/**
+ Flush the net buffer queue.
+
+ @param NbufQue Pointer to the queue to be flushed.
+
+ @return None.
+
+**/ VOID +EFIAPI NetbufQueFlush ( IN NET_BUF_QUEUE *NbufQue ); - +
+/**
+ Compute checksum for a bulk of data.
+
+ @param Bulk Pointer to the data.
+ @param Len Length of the data, in bytes.
+
+ @retval UINT16 The computed checksum.
+
+**/ UINT16 +EFIAPI NetblockChecksum ( IN UINT8 *Bulk, IN UINT32 Len ); +/**
+ Add two checksums.
+
+ @param Checksum1 The first checksum to be added.
+ @param Checksum2 The second checksum to be added.
+
+ @retval UINT16 The new checksum.
+
+**/
UINT16 +EFIAPI NetAddChecksum ( IN UINT16 Checksum1, IN UINT16 Checksum2 ); +/**
+ Compute the checksum for a NET_BUF.
+
+ @param Nbuf Pointer to the net buffer.
+
+ @retval UINT16 The computed checksum.
+
+**/ UINT16 +EFIAPI NetbufChecksum ( IN NET_BUF *Nbuf ); +/**
+ Compute the checksum for TCP/UDP pseudo header.
+ Src, Dst are in network byte order. and Len is
+ in host byte order.
+
+ @param Src The source address of the packet.
+ @param Dst The destination address of the packet.
+ @param Proto The protocol type of the packet.
+ @param Len The length of the packet.
+
+ @retval UINT16 The computed checksum.
+
+**/ UINT16 +EFIAPI NetPseudoHeadChecksum ( IN IP4_ADDR Src, IN IP4_ADDR Dst, diff --git a/MdeModulePkg/Include/Library/UdpIoLib.h b/MdeModulePkg/Include/Library/UdpIoLib.h index 1b4a759..bf9f7de 100644 --- a/MdeModulePkg/Include/Library/UdpIoLib.h +++ b/MdeModulePkg/Include/Library/UdpIoLib.h @@ -1,6 +1,8 @@ /** @file + The helper routines to access UDP service. It is used by both + DHCP and MTFTP. -Copyright (c) 2006, Intel Corporation +Copyright (c) 2006 - 2008, Intel Corporation All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -9,17 +11,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -Module Name: - - Udp4Io.h - -Abstract: - - The helper routines to access UDP service. It is used by both - DHCP and MTFTP. - - **/ #ifndef _UDP4IO_H_ @@ -133,7 +124,21 @@ BOOLEAN IN VOID *Context ); +/**
+ Create a UDP IO port to access the UDP service. It will
+ create and configure a UDP child.
+
+ @param Controller The controller that has the UDP service binding
+ protocol installed.
+ @param Image The image handle for the driver.
+ @param Configure The function to configure the created UDP child
+ @param Context The opaque parameter for the Configure funtion.
+
+ @return A point to just created UDP IO port or NULL if failed.
+
+**/ UDP_IO_PORT * +EFIAPI UdpIoCreatePort ( IN EFI_HANDLE Controller, IN EFI_HANDLE ImageHandle, @@ -141,17 +146,55 @@ UdpIoCreatePort ( IN VOID *Context ); +/**
+ Free the UDP IO port and all its related resources including
+ all the transmitted packet.
+
+ @param UdpIo The UDP IO port to free.
+
+ @retval EFI_SUCCESS The UDP IO port is freed.
+
+**/ EFI_STATUS +EFIAPI UdpIoFreePort ( IN UDP_IO_PORT *UdpIo ); +/**
+ Clean up the UDP IO port. It will release all the transmitted
+ datagrams and receive request. It will also configure NULL the
+ UDP child.
+
+ @param UdpIo UDP IO port to clean up.
+
+ @return None
+
+**/ VOID +EFIAPI UdpIoCleanPort ( IN UDP_IO_PORT *UdpIo ); +/**
+ Send a packet through the UDP IO port.
+
+ @param UdpIo The UDP IO Port to send the packet through
+ @param Packet The packet to send
+ @param EndPoint The local and remote access point
+ @param Gateway The gateway to use
+ @param CallBack The call back function to call when packet is
+ transmitted or failed.
+ @param Context The opque parameter to the CallBack
+
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet
+ @retval EFI_SUCCESS The packet is successfully delivered to UDP for
+ transmission.
+
+**/ EFI_STATUS +EFIAPI UdpIoSendDatagram ( IN UDP_IO_PORT *UdpIo, IN NET_BUF *Packet, @@ -161,13 +204,39 @@ UdpIoSendDatagram ( IN VOID *Context ); +/**
+ The selection function to cancel a single sent datagram.
+
+ @param Token The UDP TX token to test againist.
+ @param Context The context
+
+ @return TRUE if the packet is to be cancelled, otherwise FALSE.
+
+**/ VOID +EFIAPI UdpIoCancelSentDatagram ( IN UDP_IO_PORT *UdpIo, IN NET_BUF *Packet ); +/**
+ Issue a receive request to the UDP IO port.
+
+ @param UdpIo The UDP IO port to recieve the packet from.
+ @param CallBack The call back function to execute when receive
+ finished.
+ @param Context The opque context to the call back
+ @param HeadLen The lenght of the application's header
+
+ @retval EFI_ALREADY_STARTED There is already a pending receive request. Only
+ one receive request is supported.
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource.
+ @retval EFI_SUCCESS The receive request is issued successfully.
+
+**/ EFI_STATUS +EFIAPI UdpIoRecvDatagram ( IN UDP_IO_PORT *UdpIo, IN UDP_IO_CALLBACK CallBack, |