diff options
| author | ywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-23 07:22:15 +0000 |
|---|---|---|
| committer | ywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-23 07:22:15 +0000 |
| commit | 3e7104c26f426dd418b4bee2c8115470262af78f (patch) | |
| tree | 5ee93b3ce5d44ef156ddacffcaf62ef891d68fa4 | |
| parent | 257efb0ba32204ba983fd5eb4686280f8d975471 (diff) | |
| download | edk2-3e7104c26f426dd418b4bee2c8115470262af78f.zip edk2-3e7104c26f426dd418b4bee2c8115470262af78f.tar.gz edk2-3e7104c26f426dd418b4bee2c8115470262af78f.tar.bz2 | |
Remove #include <Protocol/LoadedImage.h>
Remove //#include <Protocol/Ip4.h>
Remove #include <Library/UefiLib.h>
Fix one function header description error
Fix filer header
Fix function header
Fix return status issues
Fix in out issues
Fix no Boolean expression issues
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7096 6f19259b-4bc3-4df7-8a09-765794883524
| -rw-r--r-- | MdeModulePkg/Library/DxeNetLib/DxeNetLib.c | 289 | ||||
| -rw-r--r-- | MdeModulePkg/Library/DxeNetLib/NetBuffer.c | 315 |
2 files changed, 279 insertions, 325 deletions
diff --git a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c index 1bf7e1f..bb0ac06 100644 --- a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c +++ b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c @@ -1,6 +1,7 @@ /** @file
-
-Copyright (c) 2005 - 2007, Intel Corporation
+ Network library.
+
+Copyright (c) 2005 - 2007, Intel Corporation.<BR>
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
@@ -8,26 +9,15 @@ 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.c
-
-Abstract:
-
-
-
**/
-#include <PiDxe.h>
+#include <Uefi.h>
#include <Protocol/ServiceBinding.h>
#include <Protocol/SimpleNetwork.h>
-#include <Protocol/LoadedImage.h>
#include <Protocol/NicIp4Config.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
-#include <Protocol/Ip4.h>
#include <Protocol/Dpc.h>
#include <Library/NetLib.h>
@@ -36,7 +26,6 @@ Abstract: #include <Library/BaseMemoryLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
-#include <Library/UefiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DevicePathLib.h>
@@ -93,11 +82,10 @@ EFI_IPv4_ADDRESS mZeroIp4Addr = {{0, 0, 0, 0}}; 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.
+ @param[in] NetMask The netmask to get the length from.
+ @return The length of the netmask, IP4_MASK_NUM if the mask isn't.
+
**/
INTN
EFIAPI
@@ -122,9 +110,9 @@ NetGetMaskLength ( 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
+ @param[in] Addr The address to get the class from.
- @return IP address class, such as IP4_ADDR_CLASSA
+ @return IP address class, such as IP4_ADDR_CLASSA.
**/
INTN
@@ -161,10 +149,10 @@ NetGetIpClass ( 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
+ @param[in] Ip The IP to check against.
+ @param[in] NetMask The mask of the IP.
- @return TRUE if IP is a valid unicast address on the network, otherwise FALSE
+ @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
**/
BOOLEAN
@@ -197,8 +185,6 @@ Ip4IsUnicast ( /**
Initialize a random seed using current time.
- None
-
@return The random seed initialized with current time.
**/
@@ -224,7 +210,7 @@ NetRandomInitSeed ( 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.
+ @param[in] Buf The buffer to extract the UINT32.
@return The UINT32 extracted.
@@ -246,17 +232,15 @@ NetGetUint32 ( 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
-
+ @param[in, out] Buf The buffer to put the UINT32.
+ @param[in] Data The data to put.
+
**/
VOID
EFIAPI
NetPutUint32 (
- IN UINT8 *Buf,
- IN UINT32 Data
+ IN OUT UINT8 *Buf,
+ IN UINT32 Data
)
{
Data = HTONL (Data);
@@ -265,9 +249,9 @@ NetPutUint32 ( /**
- Remove the first entry on the list
+ Remove the first entry on the list.
- @param Head The list header
+ @param[in, out] Head The list header.
@return The entry that is removed from the list, NULL if the list is empty.
@@ -275,7 +259,7 @@ NetPutUint32 ( LIST_ENTRY *
EFIAPI
NetListRemoveHead (
- LIST_ENTRY *Head
+ IN OUT LIST_ENTRY *Head
)
{
LIST_ENTRY *First;
@@ -300,9 +284,9 @@ NetListRemoveHead ( /**
- Remove the last entry on the list
+ Remove the last entry on the list.
- @param Head The list head
+ @param[in, out] Head The list head.
@return The entry that is removed from the list, NULL if the list is empty.
@@ -310,7 +294,7 @@ NetListRemoveHead ( LIST_ENTRY *
EFIAPI
NetListRemoveTail (
- LIST_ENTRY *Head
+ IN OUT LIST_ENTRY *Head
)
{
LIST_ENTRY *Last;
@@ -335,19 +319,17 @@ NetListRemoveTail ( /**
- Insert the NewEntry after the PrevEntry
-
- @param PrevEntry The previous entry to insert after
- @param NewEntry The new entry to insert
+ Insert the NewEntry after the PrevEntry.
- @return None
+ @param[in, out] PrevEntry The previous entry to insert after.
+ @param[in, out] NewEntry The new entry to insert.
**/
VOID
EFIAPI
NetListInsertAfter (
- IN LIST_ENTRY *PrevEntry,
- IN LIST_ENTRY *NewEntry
+ IN OUT LIST_ENTRY *PrevEntry,
+ IN OUT LIST_ENTRY *NewEntry
)
{
NewEntry->BackLink = PrevEntry;
@@ -358,19 +340,17 @@ NetListInsertAfter ( /**
- Insert the NewEntry before the PostEntry
-
- @param PostEntry The entry to insert before
- @param NewEntry The new entry to insert
+ Insert the NewEntry before the PostEntry.
- @return None
+ @param[in, out] PostEntry The entry to insert before.
+ @param[in, out] NewEntry The new entry to insert.
**/
VOID
EFIAPI
NetListInsertBefore (
- IN LIST_ENTRY *PostEntry,
- IN LIST_ENTRY *NewEntry
+ IN OUT LIST_ENTRY *PostEntry,
+ IN OUT LIST_ENTRY *NewEntry
)
{
NewEntry->ForwardLink = PostEntry;
@@ -383,15 +363,13 @@ NetListInsertBefore ( /**
Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
- @param Map The netmap to initialize
-
- @return None
+ @param[in, out] Map The netmap to initialize.
**/
VOID
EFIAPI
NetMapInit (
- IN NET_MAP *Map
+ IN OUT NET_MAP *Map
)
{
ASSERT (Map != NULL);
@@ -405,15 +383,13 @@ NetMapInit ( /**
To clean up the netmap, that is, release allocated memories.
- @param Map The netmap to clean up.
-
- @return None
+ @param[in, out] Map The netmap to clean up.
**/
VOID
EFIAPI
NetMapClean (
- IN NET_MAP *Map
+ IN OUT NET_MAP *Map
)
{
NET_MAP_ITEM *Item;
@@ -445,9 +421,9 @@ NetMapClean ( /**
- Test whether the netmap is empty
+ Test whether the netmap is empty.
- @param Map The net map to test
+ @param[in] Map The net map to test.
@return TRUE if the netmap is empty, otherwise FALSE.
@@ -466,7 +442,7 @@ NetMapIsEmpty ( /**
Return the number of the <Key, Value> pairs in the netmap.
- @param Map The netmap to get the entry number
+ @param[in] Map The netmap to get the entry number.
@return The entry number in the netmap.
@@ -482,17 +458,18 @@ NetMapGetCount ( /**
- Allocate an item for the netmap. It will try to allocate
+ Allocate an item for the netmap. It will try to allocate.
a batch of items and return one.
- @param Map The netmap to allocate item for
+ @param[in, out] Map The netmap to allocate item for.
- @return The allocated item or NULL
+ @return The allocated item. If NULL, the
+ allocation failed due to resource limit.
**/
NET_MAP_ITEM *
NetMapAllocItem (
- IN NET_MAP *Map
+ IN OUT NET_MAP *Map
)
{
NET_MAP_ITEM *Item;
@@ -529,18 +506,18 @@ NetMapAllocItem ( /**
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
+ @param[in, out] Map The netmap to insert into.
+ @param[in] Key The user's key.
+ @param[in] 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
+ @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 OUT NET_MAP *Map,
IN VOID *Key,
IN VOID *Value OPTIONAL
)
@@ -567,18 +544,18 @@ NetMapInsertHead ( /**
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
+ @param[in, out] Map The netmap to insert into.
+ @param[in] Key The user's key.
+ @param[in] 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
+ @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 OUT NET_MAP *Map,
IN VOID *Key,
IN VOID *Value OPTIONAL
)
@@ -604,10 +581,10 @@ NetMapInsertTail ( /**
- Check whther the item is in the Map
+ Check whther the item is in the Map.
- @param Map The netmap to search within
- @param Item The item to search
+ @param[in] Map The netmap to search within.
+ @param[in] Item The item to search.
@return TRUE if the item is in the netmap, otherwise FALSE.
@@ -631,10 +608,10 @@ NetItemInMap ( /**
- Find the key in the netmap
+ Find the key in the netmap.
- @param Map The netmap to search within
- @param Key The key to search
+ @param[in] Map The netmap to search within.
+ @param[in] Key The key to search.
@return The point to the item contains the Key, or NULL if Key isn't in the map.
@@ -664,21 +641,21 @@ NetMapFindKey ( /**
- Remove the item from the netmap
+ 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
+ @param[in, out] Map The netmap to remove the item from.
+ @param[in, out] Item The item to remove.
+ @param[out] Value The variable to receive the value if not NULL.
- @return The key of the removed item.
+ @return The key of the removed item.
**/
VOID *
EFIAPI
NetMapRemoveItem (
- IN NET_MAP *Map,
- IN NET_MAP_ITEM *Item,
- OUT VOID **Value OPTIONAL
+ IN OUT NET_MAP *Map,
+ IN OUT NET_MAP_ITEM *Item,
+ OUT VOID **Value OPTIONAL
)
{
ASSERT ((Map != NULL) && (Item != NULL));
@@ -697,18 +674,18 @@ NetMapRemoveItem ( /**
- Remove the first entry on the netmap
+ 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
+ @param[in, out] Map The netmap to remove the head from.
+ @param[out] Value The variable to receive the value if not NULL.
- @return The key of the item removed
+ @return The key of the item removed.
**/
VOID *
EFIAPI
NetMapRemoveHead (
- IN NET_MAP *Map,
+ IN OUT NET_MAP *Map,
OUT VOID **Value OPTIONAL
)
{
@@ -734,18 +711,18 @@ NetMapRemoveHead ( /**
- Remove the last entry on the netmap
+ 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
+ @param[in, out] Map The netmap to remove the tail from.
+ @param[out] Value The variable to receive the value if not NULL.
- @return The key of the item removed
+ @return The key of the item removed.
**/
VOID *
EFIAPI
NetMapRemoveTail (
- IN NET_MAP *Map,
+ IN OUT NET_MAP *Map,
OUT VOID **Value OPTIONAL
)
{
@@ -776,11 +753,13 @@ NetMapRemoveTail ( 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
+ @param[in] Map The Map to iterate through.
+ @param[in] CallBack The callback function to call for each item.
+ @param[in] Arg The opaque parameter to the callback.
- @return It returns the CallBack's last return value.
+ @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
+ return EFI_SUCCESS.
+ @retval Others It returns the CallBack's last return value.
**/
EFI_STATUS
@@ -822,7 +801,7 @@ NetMapIterate ( /**
This is the default unload handle for all the network drivers.
- @param ImageHandle The drivers' driver image.
+ @param[in] ImageHandle The drivers' driver image.
@retval EFI_SUCCESS The image is unloaded.
@retval Others Failed to unload the image.
@@ -936,10 +915,10 @@ NetLibDefaultUnload ( /**
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
+ @param[in] Controller The controller which has the service installed.
+ @param[in] Image The image handle used to open service.
+ @param[in] ServiceBindingGuid The service's Guid.
+ @param[in, out] ChildHandle The handle to receive the create child
@retval EFI_SUCCESS The child is successfully created.
@retval Others Failed to create the child.
@@ -951,7 +930,7 @@ NetLibCreateServiceChild ( IN EFI_HANDLE Controller,
IN EFI_HANDLE Image,
IN EFI_GUID *ServiceBindingGuid,
- OUT EFI_HANDLE *ChildHandle
+ IN OUT EFI_HANDLE *ChildHandle
)
{
EFI_STATUS Status;
@@ -987,10 +966,10 @@ NetLibCreateServiceChild ( /**
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
+ @param[in] Controller The controller which has the service installed.
+ @param[in] Image The image handle used to open service.
+ @param[in] ServiceBindingGuid The service's Guid.
+ @param[in] ChildHandle The child to destory
@retval EFI_SUCCESS The child is successfully destoried.
@retval Others Failed to destory the child.
@@ -1039,23 +1018,24 @@ NetLibDestroyServiceChild ( 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.
-
+ @param[in] SnpHandle The handle where the simple network protocol is
+ installed on.
+ @param[in] ImageHandle The image handle used to act as the agent handle to
+ get the simple network protocol.
+ @param[out] MacString The pointer to store the address of the string
+ representation of the mac address.
+
+ @retval EFI_SUCCESS Convert the mac address a unicode string successfully.
@retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
- @retval other Failed to open the simple network protocol.
+ @retval Others Failed to open the simple network protocol.
**/
EFI_STATUS
EFIAPI
NetLibGetMacString (
- IN EFI_HANDLE SnpHandle,
- IN EFI_HANDLE ImageHandle,
- IN OUT CHAR16 **MacString
+ IN EFI_HANDLE SnpHandle,
+ IN EFI_HANDLE ImageHandle,
+ OUT CHAR16 **MacString
)
{
EFI_STATUS Status;
@@ -1111,8 +1091,8 @@ NetLibGetMacString ( Check the default address used by the IPv4 driver is static or dynamic (acquired
from DHCP).
- @param Controller The controller handle which has the NIC Ip4 Config Protocol
- relative with the default address to judge.
+ @param[in] Controller The controller handle which has the NIC Ip4 Config Protocol
+ relative with the default address to judge.
@retval TRUE If the default address is static.
@retval FALSE If the default address is acquired from DHCP.
@@ -1167,16 +1147,15 @@ ON_EXIT: /**
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.
+ @param[in, out] Node Pointer to the IPv4 device path node.
+ @param[in] Controller The handle where the NIC IP4 config protocol resides.
+ @param[in] LocalIp The local IPv4 address.
+ @param[in] LocalPort The local port.
+ @param[in] RemoteIp The remote IPv4 address.
+ @param[in] RemotePort The remote port.
+ @param[in] Protocol The protocol type in the IP header.
+ @param[in] UseDefaultAddress Whether this instance is using default address or not.
- @retval None
**/
VOID
EFIAPI
@@ -1221,10 +1200,10 @@ NetLibCreateIPv4DPathNode ( 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.
+ @param[in] Controller Then protocol handle to check.
+ @param[in] ProtocolGuid The protocol that is related with the handle.
- @return The UNDI/SNP handle or NULL.
+ @return The UNDI/SNP handle or NULL for errors.
**/
EFI_HANDLE
@@ -1267,14 +1246,14 @@ NetLibGetNicHandle ( /**
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.
+ @param[in] DpcTpl The EFI_TPL that the DPC should be invoked.
+ @param[in] DpcProcedure Pointer to the DPC's function.
+ @param[in] 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_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL, or DpcProcedure
+ is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to
add the DPC to the queue.
@@ -1291,7 +1270,10 @@ NetLibQueueDpc ( }
/**
- Add a Deferred Procedure Call to the end of the DPC queue.
+ Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl
+ value greater than or equal to the current TPL are invoked in the order that
+ they were queued. DPCs with higher DpcTpl values are invoked before DPCs with
+ lower DpcTpl values.
@retval EFI_SUCCESS One or more DPCs were invoked.
@retval EFI_NOT_FOUND No DPCs were invoked.
@@ -1306,15 +1288,14 @@ NetLibDispatchDpc ( return mDpc->DispatchDpc(mDpc);
}
-
/**
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.
+ @param[in] ImageHandle The firmware allocated handle for the EFI image.
+ @param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
diff --git a/MdeModulePkg/Library/DxeNetLib/NetBuffer.c b/MdeModulePkg/Library/DxeNetLib/NetBuffer.c index fcc55a1..8971529 100644 --- a/MdeModulePkg/Library/DxeNetLib/NetBuffer.c +++ b/MdeModulePkg/Library/DxeNetLib/NetBuffer.c @@ -1,6 +1,7 @@ /** @file
-
-Copyright (c) 2005 - 2006, Intel Corporation
+ Network library.
+
+Copyright (c) 2005 - 2006, Intel Corporation.<BR>
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
@@ -8,18 +9,9 @@ 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:
-
- NetBuffer.c
-
-Abstract:
-
-
-
**/
-#include <PiDxe.h>
+#include <Uefi.h>
#include <Library/NetLib.h>
#include <Library/BaseLib.h>
@@ -34,10 +26,10 @@ Abstract: has the BlockOpNum's NET_BLOCK_OP, and its associated NET_VECTOR has the
BlockNum's NET_BLOCK.
- @param BlockNum The number of NET_BLOCK in the Vector of net buffer
- @param BlockOpNum The number of NET_BLOCK_OP in the net buffer
+ @param[in] BlockNum The number of NET_BLOCK in the Vector of net buffer
+ @param[in] BlockOpNum The number of NET_BLOCK_OP in the net buffer
- @retval * Pointer to the allocated NET_BUF. If NULL the
+ @return Pointer to the allocated NET_BUF. If NULL, the
allocation failed due to resource limit.
**/
@@ -92,9 +84,9 @@ FreeNbuf: Allocate a single block NET_BUF. Upon allocation, all the
free space is in the tail room.
- @param Len The length of the block.
+ @param[in] Len The length of the block.
- @retval * Pointer to the allocated NET_BUF. If NULL the
+ @return Pointer to the allocated NET_BUF. If NULL the
allocation failed due to resource limit.
**/
@@ -144,11 +136,9 @@ FreeNBuf: /**
- Free the vector
-
- @param Vector Pointer to the NET_VECTOR to be freed.
+ Free the vector.
- @return None.
+ @param[in] Vector Pointer to the NET_VECTOR to be freed.
**/
VOID
@@ -195,9 +185,7 @@ NetbufFreeVector ( /**
Free the buffer and its associated NET_VECTOR.
- @param Nbuf Pointer to the NET_BUF to be freed.
-
- @return None.
+ @param[in] Nbuf Pointer to the NET_BUF to be freed.
**/
VOID
@@ -225,9 +213,10 @@ NetbufFree ( /**
Create a copy of NET_BUF that share the associated NET_DATA.
- @param Nbuf Pointer to the net buffer to be cloned.
+ @param[in] Nbuf Pointer to the net buffer to be cloned.
- @retval * Pointer to the cloned net buffer.
+ @return Pointer to the cloned net buffer.If NULL, the
+ allocation failed due to resource limit.
**/
NET_BUF *
@@ -270,19 +259,20 @@ NetbufClone ( 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
+ @param[in] Nbuf Pointer to the net buffer to be cloned.
+ @param[in, out] Duplicate Pointer to the net buffer to duplicate to, if NULL
+ a new net buffer is allocated.
+ @param[in] HeadSpace Length of the head space to reserve.
- @retval * Pointer to the duplicated net buffer.
+ @return Pointer to the duplicated net buffer.If NULL, the
+ allocation failed due to resource limit.
**/
NET_BUF *
EFIAPI
NetbufDuplicate (
IN NET_BUF *Nbuf,
- IN NET_BUF *Duplicate OPTIONAL,
+ IN OUT NET_BUF *Duplicate OPTIONAL,
IN UINT32 HeadSpace
)
{
@@ -315,15 +305,13 @@ NetbufDuplicate ( /**
Free a list of net buffers.
- @param Head Pointer to the head of linked net buffers.
-
- @return None.
+ @param[in, out] Head Pointer to the head of linked net buffers.
**/
VOID
EFIAPI
NetbufFreeList (
- IN LIST_ENTRY *Head
+ IN OUT LIST_ENTRY *Head
)
{
LIST_ENTRY *Entry;
@@ -350,11 +338,11 @@ NetbufFreeList ( 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
+ @param[in] Nbuf Pointer to the net buffer.
+ @param[in] Offset The index or offset of the byte.
+ @param[out] Index Index of the fragment that contains the block.
- @retval * Pointer to the nth byte of data in the net buffer.
+ @return * Pointer to the nth byte of data in the net buffer.
If NULL, there is no such data in the net buffer.
**/
@@ -404,18 +392,16 @@ NetbufGetByte ( are set to the bulk's head and tail respectively. So, this
function alone can't be used by NetbufAlloc.
- @param Nbuf Pointer to the net buffer.
- @param Bulk Pointer to the data.
- @param Len Length of the bulk data.
- @param Index The data block index in the net buffer the bulk
- data should belong to.
-
- @return None.
-
+ @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in] Bulk Pointer to the data.
+ @param[in] Len Length of the bulk data.
+ @param[in] Index The data block index in the net buffer the bulk
+ data should belong to.
+
**/
VOID
NetbufSetBlock (
- IN NET_BUF *Nbuf,
+ IN OUT NET_BUF *Nbuf,
IN UINT8 *Bulk,
IN UINT32 Len,
IN UINT32 Index
@@ -446,18 +432,16 @@ NetbufSetBlock ( structure is left untouched. Some times, there is no 1:1 relationship
between NET_BLOCK and NET_BLOCK_OP. For example, that in NetbufGetFragment.
- @param Nbuf Pointer to the net buffer.
- @param Bulk Pointer to the data.
- @param Len Length of the bulk data.
- @param Index The data block index in the net buffer the bulk
- data should belong to.
-
- @return None.
+ @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in] Bulk Pointer to the data.
+ @param[in] Len Length of the bulk data.
+ @param[in] Index The data block index in the net buffer the bulk
+ data should belong to.
**/
VOID
NetbufSetBlockOp (
- IN NET_BUF *Nbuf,
+ IN OUT NET_BUF *Nbuf,
IN UINT8 *Bulk,
IN UINT32 Len,
IN UINT32 Index
@@ -483,9 +467,7 @@ NetbufSetBlockOp ( need to create a new NET_VECTOR. But, we want to avoid data copy by sharing
the old NET_VECTOR.
- @param Arg Point to the old NET_VECTOR
-
- @return NONE
+ @param[in] Arg Point to the old NET_VECTOR.
**/
VOID
@@ -507,14 +489,15 @@ NetbufGetFragmentFree ( 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
+ @param[in] Nbuf Pointer to the net buffer to be cloned.
+ @param[in] Offset Starting point of the data to be included in new
+ buffer.
+ @param[in] Len How many data to include in new data.
+ @param[in] HeadSpace How many bytes of head space to reserve for
+ protocol header.
- @retval * Pointer to the cloned net buffer.
+ @return Pointer to the cloned net buffer.If NULL, the
+ allocation failed due to resource limit.
**/
NET_BUF *
@@ -687,17 +670,17 @@ FreeChild: /**
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.
+ @param[in] ExtFragment Pointer to the data block.
+ @param[in] ExtNum The number of the data block.
+ @param[in] HeadSpace The head space to be reserved.
+ @param[in] HeadLen The length of the protocol header, This function
+ will pull that number of data into a linear block.
+ @param[in] ExtFree Pointer to the caller provided free function.
+ @param[in] Arg The argument passed to ExtFree when ExtFree is
+ called.
- @retval * Pointer to the net buffer built from the data
- blocks.
+ @return Pointer to the net buffer built from the data blocks.
+ If NULL, the allocation failed due to resource limit.
**/
NET_BUF *
@@ -822,7 +805,7 @@ NetbufFromExt ( Vector = Nbuf->Vector;
Vector->Free = ExtFree;
Vector->Arg = Arg;
- Vector->Flag = (FirstBlockLen ? NET_VECTOR_OWN_FIRST : 0);
+ Vector->Flag = ((FirstBlockLen != 0) ? NET_VECTOR_OWN_FIRST : 0);
//
// Set the first block up which may contain
@@ -847,7 +830,7 @@ NetbufFromExt ( Vector->Len = TotalLen + HeadSpace;
Nbuf->TotalSize = TotalLen;
- if (SavedIndex) {
+ if (SavedIndex != 0) {
ExtFragment[SavedIndex] = SavedFragment;
}
@@ -863,11 +846,11 @@ FreeFirstBlock: 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.
+ @param[in] Nbuf Point to the net buffer.
+ @param[in, out] ExtFragment Pointer to the data block.
+ @param[in, out] ExtNum The number of the data block.
- @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than ExtNum
+ @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than ExtNum.
@retval EFI_SUCCESS Fragment table built.
**/
@@ -875,8 +858,8 @@ EFI_STATUS EFIAPI
NetbufBuildExt (
IN NET_BUF *Nbuf,
- IN NET_FRAGMENT *ExtFragment,
- IN UINT32 *ExtNum
+ IN OUT NET_FRAGMENT *ExtFragment,
+ IN OUT UINT32 *ExtNum
)
{
UINT32 Index;
@@ -906,15 +889,15 @@ NetbufBuildExt ( /**
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.
+ @param[in] BufList A List of NET_BUF.
+ @param[in] HeadSpace The head space to be reserved.
+ @param[in] HeaderLen The length of the protocol header, This function
+ will pull that number of data into a linear block.
+ @param[in] ExtFree Pointer to the caller provided free function.
+ @param[in] Arg The argument passed to ExtFree when ExtFree is
+ called.
- @retval * Pointer to the net buffer built from the data
+ @return Pointer to the net buffer built from the data
blocks.
**/
@@ -986,16 +969,14 @@ NetbufFromBufList ( 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.
+ @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in] Len The length of buffer to be reserverd.
**/
VOID
EFIAPI
NetbufReserve (
- IN NET_BUF *Nbuf,
+ IN OUT NET_BUF *Nbuf,
IN UINT32 Len
)
{
@@ -1015,19 +996,19 @@ NetbufReserve ( /**
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.
+ @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in] Len The length of the buffer to be allocated.
+ @param [in] 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.
+ @return Pointer to the first byte of the allocated buffer.
**/
UINT8 *
EFIAPI
NetbufAllocSpace (
- IN NET_BUF *Nbuf,
+ IN OUT NET_BUF *Nbuf,
IN UINT32 Len,
IN BOOLEAN FromHead
)
@@ -1107,17 +1088,15 @@ NetbufAllocSpace ( /**
Trim a single NET_BLOCK.
- @param BlockOp Pointer to the NET_BLOCK.
- @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.
-
- @return None.
+ @param[in, out] BlockOp Pointer to the NET_BLOCK.
+ @param[in] Len The length of the data to be trimmed.
+ @param[in] FromHead The flag to indicate whether trim data from head or
+ tail. TRUE for from head, and FALSE for from tail.
**/
VOID
NetblockTrim (
- IN NET_BLOCK_OP *BlockOp,
+ IN OUT NET_BLOCK_OP *BlockOp,
IN UINT32 Len,
IN BOOLEAN FromHead
)
@@ -1137,18 +1116,18 @@ NetblockTrim ( /**
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.
+ @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in] Len The length of the data to be trimmed.
+ @param[in] 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.
+ @return Length of the actually trimmed data.
**/
UINT32
EFIAPI
NetbufTrim (
- IN NET_BUF *Nbuf,
+ IN OUT NET_BUF *Nbuf,
IN UINT32 Len,
IN BOOLEAN FromHead
)
@@ -1202,10 +1181,10 @@ NetbufTrim ( /**
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.
+ @param[in] Nbuf Pointer to the net buffer.
+ @param[in] Offset The sequence number of the first byte to copy.
+ @param[in] Len Length of the data to copy.
+ @param[in] Dest The destination of the data to copy to.
@retval UINTN The length of the copied data.
@@ -1302,15 +1281,13 @@ NetbufCopy ( /**
Initiate the net buffer queue.
- @param NbufQue Pointer to the net buffer queue to be initiated.
-
- @return None.
+ @param[in, out] NbufQue Pointer to the net buffer queue to be initiated.
**/
VOID
EFIAPI
NetbufQueInit (
- IN NET_BUF_QUEUE *NbufQue
+ IN OUT NET_BUF_QUEUE *NbufQue
)
{
NbufQue->Signature = NET_QUE_SIGNATURE;
@@ -1326,9 +1303,8 @@ NetbufQueInit ( /**
Allocate an initialized net buffer queue.
- None.
-
- @retval * Pointer to the allocated net buffer queue.
+ @return Pointer to the allocated net buffer queue.If NULL, the
+ allocation failed due to resource limit.
**/
NET_BUF_QUEUE *
@@ -1353,9 +1329,7 @@ NetbufQueAlloc ( /**
Free a net buffer queue.
- @param NbufQue Poitner to the net buffer queue to be freed.
-
- @return None.
+ @param[in] NbufQue Poitner to the net buffer queue to be freed.
**/
VOID
@@ -1378,17 +1352,15 @@ NetbufQueFree ( /**
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.
+ @param[in, out] NbufQue Pointer to the net buffer queue.
+ @param[in, out] Nbuf Pointer to the net buffer to be appended.
**/
VOID
EFIAPI
NetbufQueAppend (
- IN NET_BUF_QUEUE *NbufQue,
- IN NET_BUF *Nbuf
+ IN OUT NET_BUF_QUEUE *NbufQue,
+ IN OUT NET_BUF *Nbuf
)
{
NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE);
@@ -1404,16 +1376,17 @@ NetbufQueAppend ( /**
Remove a net buffer from head in the specific queue.
- @param NbufQue Pointer to the net buffer queue.
+ @param[in, out] NbufQue Pointer to the net buffer queue.
- @retval * Pointer to the net buffer removed from the specific
+ @return Pointer to the net buffer removed from the specific
+ queue. If NULL, there is no net buffer in the specific
queue.
**/
NET_BUF *
EFIAPI
NetbufQueRemove (
- IN NET_BUF_QUEUE *NbufQue
+ IN OUT NET_BUF_QUEUE *NbufQue
)
{
NET_BUF *First;
@@ -1437,20 +1410,22 @@ NetbufQueRemove ( /**
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.
+ @param[in] NbufQue Pointer to the net buffer queue.
+ @param[in] Offset The sequence number of the first byte to copy.
+ @param[in] Len Length of the data to copy.
+ @param[out] Dest The destination of the data to copy to.
- @retval UINTN The length of the copied data.
+ @return The length of the copied data. If 0, then the length is zero or offset
+ suppress the total size of net buffer.
**/
UINT32
+EFIAPI
NetbufQueCopy (
IN NET_BUF_QUEUE *NbufQue,
IN UINT32 Offset,
IN UINT32 Len,
- IN UINT8 *Dest
+ OUT UINT8 *Dest
)
{
LIST_ENTRY *Entry;
@@ -1534,16 +1509,16 @@ NetbufQueCopy ( Trim some data from the queue header, release the buffer if
whole buffer is trimmed.
- @param NbufQue Pointer to the net buffer queue.
- @param Len Length of the data to trim.
+ @param[in, out] NbufQue Pointer to the net buffer queue.
+ @param[in] Len Length of the data to trim.
- @retval UINTN The length of the data trimmed.
+ @return The length of the data trimmed, or 0 if length of the data to trim is zero.
**/
UINT32
EFIAPI
NetbufQueTrim (
- IN NET_BUF_QUEUE *NbufQue,
+ IN OUT NET_BUF_QUEUE *NbufQue,
IN UINT32 Len
)
{
@@ -1594,15 +1569,13 @@ NetbufQueTrim ( /**
Flush the net buffer queue.
- @param NbufQue Pointer to the queue to be flushed.
-
- @return None.
+ @param[in, out] NbufQue Pointer to the queue to be flushed.
**/
VOID
EFIAPI
NetbufQueFlush (
- IN NET_BUF_QUEUE *NbufQue
+ IN OUT NET_BUF_QUEUE *NbufQue
)
{
NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE);
@@ -1617,10 +1590,10 @@ NetbufQueFlush ( /**
Compute checksum for a bulk of data.
- @param Bulk Pointer to the data.
- @param Len Length of the data, in bytes.
+ @param[in] Bulk Pointer to the data.
+ @param[in] Len Length of the data, in bytes.
- @retval UINT16 The computed checksum.
+ @return The computed checksum.
**/
UINT16
@@ -1650,7 +1623,7 @@ NetblockChecksum ( //
// Fold 32-bit sum to 16 bits
//
- while (Sum >> 16) {
+ while ((Sum >> 16) != 0) {
Sum = (Sum & 0xffff) + (Sum >> 16);
}
@@ -1662,10 +1635,10 @@ NetblockChecksum ( /**
Add two checksums.
- @param Checksum1 The first checksum to be added.
- @param Checksum2 The second checksum to be added.
+ @param[in] Checksum1 The first checksum to be added.
+ @param[in] Checksum2 The second checksum to be added.
- @retval UINT16 The new checksum.
+ @return The new checksum.
**/
UINT16
@@ -1682,7 +1655,7 @@ NetAddChecksum ( //
// two UINT16 can only add up to a carry of 1.
//
- if (Sum >> 16) {
+ if ((Sum >> 16) != 0) {
Sum = (Sum & 0xffff) + 1;
}
@@ -1694,9 +1667,9 @@ NetAddChecksum ( /**
Compute the checksum for a NET_BUF.
- @param Nbuf Pointer to the net buffer.
+ @param[in] Nbuf Pointer to the net buffer.
- @retval UINT16 The computed checksum.
+ @return The computed checksum.
**/
UINT16
@@ -1724,7 +1697,7 @@ NetbufChecksum ( BlockSum = NetblockChecksum (BlockOp[Index].Head, BlockOp[Index].Size);
- if (Offset & 0x01) {
+ if ((Offset & 0x01) != 0) {
//
// The checksum starts with an odd byte, swap
// the checksum before added to total checksum
@@ -1745,12 +1718,12 @@ NetbufChecksum ( 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.
+ @param[in] Src The source address of the packet.
+ @param[in] Dst The destination address of the packet.
+ @param[in] Proto The protocol type of the packet.
+ @param[in] Len The length of the packet.
- @retval UINT16 The computed checksum.
+ @return The computed checksum.
**/
UINT16
|