diff options
author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-06-04 09:55:00 +0000 |
---|---|---|
committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-06-04 09:55:00 +0000 |
commit | 552b252326c1110f8835fe5a43a1a3441ab3df0e (patch) | |
tree | f17ca5b69a1a48cf907f4bf942c6325a8f6e2998 /MdeModulePkg/Include | |
parent | d389c6f3fca793ec1239beb5df42a944b3abdc49 (diff) | |
download | edk2-552b252326c1110f8835fe5a43a1a3441ab3df0e.zip edk2-552b252326c1110f8835fe5a43a1a3441ab3df0e.tar.gz edk2-552b252326c1110f8835fe5a43a1a3441ab3df0e.tar.bz2 |
Remove the tailing ',' to ensure the code pass EBC's -Za option (Enforces strict conformance to the ANSI standard for C).
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5324 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
-rw-r--r-- | MdeModulePkg/Include/Library/NetLib.h | 1062 | ||||
-rw-r--r-- | MdeModulePkg/Include/Library/UdpIoLib.h | 142 | ||||
-rw-r--r-- | MdeModulePkg/Include/Protocol/NicIp4Config.h | 2 |
3 files changed, 603 insertions, 603 deletions
diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h index cb7b65c..c3695b5 100644 --- a/MdeModulePkg/Include/Library/NetLib.h +++ b/MdeModulePkg/Include/Library/NetLib.h @@ -45,7 +45,7 @@ enum { IP4_ADDR_CLASSD, IP4_ADDR_CLASSE, - IP4_MASK_NUM = 33, + IP4_MASK_NUM = 33 }; #pragma pack(1) @@ -166,16 +166,16 @@ 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.
-
+/** + 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 @@ -183,14 +183,14 @@ 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
-
+/** + 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 @@ -198,16 +198,16 @@ 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
-
+/** + 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 ( @@ -230,14 +230,14 @@ 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.
-
+/** + 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 @@ -245,15 +245,15 @@ 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
-
+/** + 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 @@ -262,13 +262,13 @@ NetPutUint32 ( IN UINT32 Data ); -/**
- Initialize a random seed using current time.
-
- None
-
- @return The random seed initialized with current time.
-
+/** + Initialize a random seed using current time. + + None + + @return The random seed initialized with current time. + **/ UINT32 EFIAPI @@ -311,13 +311,13 @@ 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.
-
+/** + 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 @@ -325,13 +325,13 @@ 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.
-
+/** + 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 @@ -339,14 +339,14 @@ 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
-
+/** + 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 @@ -355,14 +355,14 @@ NetListInsertAfter ( 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
-
+/** + Insert the NewEntry before the PostEntry + + @param PostEntry The entry to insert before + @param NewEntry The new entry to insert + + @return None + **/ VOID EFIAPI @@ -390,13 +390,13 @@ 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
-
+/** + Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs. + + @param Map The netmap to initialize + + @return None + **/ VOID EFIAPI @@ -404,13 +404,13 @@ NetMapInit ( IN NET_MAP *Map ); -/**
- To clean up the netmap, that is, release allocated memories.
-
- @param Map The netmap to clean up.
-
- @return None
-
+/** + To clean up the netmap, that is, release allocated memories. + + @param Map The netmap to clean up. + + @return None + **/ VOID EFIAPI @@ -418,13 +418,13 @@ 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.
-
+/** + Test whether the netmap is empty + + @param Map The net map to test + + @return TRUE if the netmap is empty, otherwise FALSE. + **/ BOOLEAN EFIAPI @@ -432,13 +432,13 @@ 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.
-
+/** + 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 @@ -446,16 +446,16 @@ 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
-
+/** + 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 @@ -465,16 +465,16 @@ NetMapInsertHead ( 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
-
+/** + 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 @@ -484,14 +484,14 @@ NetMapInsertTail ( 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.
-
+/** + 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 @@ -500,15 +500,15 @@ NetMapFindKey ( 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.
-
+/** + 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 @@ -518,14 +518,14 @@ NetMapRemoveItem ( 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
-
+/** + 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 @@ -534,14 +534,14 @@ NetMapRemoveHead ( 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
-
+/** + 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 @@ -558,18 +558,18 @@ 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.
-
+/** + 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 @@ -583,17 +583,17 @@ 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.
-
+/** + 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 @@ -604,17 +604,17 @@ 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.
-
+/** + 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 @@ -625,21 +625,21 @@ 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.
-
+/** + 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 @@ -649,19 +649,19 @@ NetLibGetMacString ( 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
+/** + 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 @@ -676,21 +676,21 @@ 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.
-
+/** + 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 @@ -699,20 +699,20 @@ NetLibGetNicHandle ( 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.
-
+/** + 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 @@ -722,12 +722,12 @@ NetLibQueueDpc ( 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.
-
+/** + 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 @@ -735,17 +735,17 @@ 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.
-
+/** + 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 @@ -765,7 +765,7 @@ enum { NET_PROTO_DATA = 64, // Opaque buffer for protocols NET_BUF_HEAD = 1, // Trim or allocate space from head NET_BUF_TAIL = 0, // Trim or allocate space from tail - NET_VECTOR_OWN_FIRST = 0x01, // We allocated the 1st block in the vector + NET_VECTOR_OWN_FIRST = 0x01 // We allocated the 1st block in the vector }; #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \ @@ -898,15 +898,15 @@ 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.
-
+/** + 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 @@ -914,13 +914,13 @@ NetbufAlloc ( IN UINT32 Len ); -/**
- Free the buffer and its associated NET_VECTOR.
-
- @param Nbuf Pointer to the NET_BUF to be freed.
-
- @return None.
-
+/** + Free the buffer and its associated NET_VECTOR. + + @param Nbuf Pointer to the NET_BUF to be freed. + + @return None. + **/ VOID EFIAPI @@ -928,19 +928,19 @@ 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.
-
+/** + 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 @@ -950,13 +950,13 @@ NetbufGetByte ( 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.
-
+/** + 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 @@ -964,17 +964,17 @@ 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.
-
+/** + 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 @@ -984,21 +984,21 @@ NetbufDuplicate ( 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.
-
+/** + 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 @@ -1009,20 +1009,20 @@ 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.
-
+/** + 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 @@ -1031,17 +1031,17 @@ NetbufReserve ( 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.
-
+/** + 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 @@ -1051,16 +1051,16 @@ NetbufAllocSpace ( 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.
-
+/** + 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 @@ -1070,16 +1070,16 @@ NetbufTrim ( 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.
-
+/** + 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 @@ -1090,21 +1090,21 @@ 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.
-
+/** + 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 @@ -1117,17 +1117,17 @@ 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.
-
+/** + 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 @@ -1137,20 +1137,20 @@ NetbufBuildExt ( 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.
-
+/** + 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 @@ -1162,13 +1162,13 @@ NetbufFromBufList ( IN VOID *Arg OPTIONAL ); -/**
- Free a list of net buffers.
-
- @param Head Pointer to the head of linked net buffers.
-
- @return None.
-
+/** + Free a list of net buffers. + + @param Head Pointer to the head of linked net buffers. + + @return None. + **/ VOID EFIAPI @@ -1176,13 +1176,13 @@ NetbufFreeList ( IN LIST_ENTRY *Head ); -/**
- Initiate the net buffer queue.
-
- @param NbufQue Pointer to the net buffer queue to be initiated.
-
- @return None.
-
+/** + Initiate the net buffer queue. + + @param NbufQue Pointer to the net buffer queue to be initiated. + + @return None. + **/ VOID EFIAPI @@ -1190,13 +1190,13 @@ NetbufQueInit ( IN NET_BUF_QUEUE *NbufQue ); -/**
- Allocate an initialized net buffer queue.
-
- None.
-
- @retval * Pointer to the allocated net buffer queue.
-
+/** + Allocate an initialized net buffer queue. + + None. + + @retval * Pointer to the allocated net buffer queue. + **/ NET_BUF_QUEUE * EFIAPI @@ -1204,13 +1204,13 @@ NetbufQueAlloc ( VOID ); -/**
- Free a net buffer queue.
-
- @param NbufQue Poitner to the net buffer queue to be freed.
-
- @return None.
-
+/** + Free a net buffer queue. + + @param NbufQue Poitner to the net buffer queue to be freed. + + @return None. + **/ VOID EFIAPI @@ -1218,14 +1218,14 @@ 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.
-
+/** + 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 @@ -1233,14 +1233,14 @@ 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.
-
+/** + 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 @@ -1248,17 +1248,17 @@ 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.
-
+ +/** + 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 @@ -1268,17 +1268,17 @@ NetbufQueCopy ( 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.
-
+ +/** + 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 @@ -1287,29 +1287,29 @@ NetbufQueTrim ( IN UINT32 Len ); -
-/**
- Flush the net buffer queue.
-
- @param NbufQue Pointer to the queue to be flushed.
-
- @return None.
-
+ +/** + 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.
-
+ +/** + 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 @@ -1318,15 +1318,15 @@ NetblockChecksum ( 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.
-
-**/
+/** + 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 ( @@ -1334,13 +1334,13 @@ NetAddChecksum ( IN UINT16 Checksum2 ); -/**
- Compute the checksum for a NET_BUF.
-
- @param Nbuf Pointer to the net buffer.
-
- @retval UINT16 The computed checksum.
-
+/** + Compute the checksum for a NET_BUF. + + @param Nbuf Pointer to the net buffer. + + @retval UINT16 The computed checksum. + **/ UINT16 EFIAPI @@ -1348,18 +1348,18 @@ 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.
-
+/** + 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 diff --git a/MdeModulePkg/Include/Library/UdpIoLib.h b/MdeModulePkg/Include/Library/UdpIoLib.h index bf9f7de..05c1217 100644 --- a/MdeModulePkg/Include/Library/UdpIoLib.h +++ b/MdeModulePkg/Include/Library/UdpIoLib.h @@ -16,10 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #ifndef _UDP4IO_H_ #define _UDP4IO_H_ -#include <PiDxe.h>
-
-#include <Protocol/Udp4.h>
-
+#include <PiDxe.h> + +#include <Protocol/Udp4.h> + #include <Library/UdpIoLib.h> #include <Library/NetLib.h> @@ -28,7 +28,7 @@ typedef struct _UDP_IO_PORT UDP_IO_PORT; enum { UDP_IO_RX_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'R'), UDP_IO_TX_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'T'), - UDP_IO_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'I'), + UDP_IO_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'I') }; typedef struct { @@ -124,18 +124,18 @@ 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.
-
+/** + 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 @@ -146,14 +146,14 @@ 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.
-
+/** + 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 @@ -161,15 +161,15 @@ 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
-
+/** + 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 @@ -177,21 +177,21 @@ 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.
-
+/** + 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 @@ -204,14 +204,14 @@ 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.
-
+/** + 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 @@ -220,20 +220,20 @@ UdpIoCancelSentDatagram ( 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.
-
+/** + 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 diff --git a/MdeModulePkg/Include/Protocol/NicIp4Config.h b/MdeModulePkg/Include/Protocol/NicIp4Config.h index da38888..2272d98 100644 --- a/MdeModulePkg/Include/Protocol/NicIp4Config.h +++ b/MdeModulePkg/Include/Protocol/NicIp4Config.h @@ -47,7 +47,7 @@ enum { IP4_CONFIG_SOURCE_MAX,
IP4_NIC_NAME_LENGTH = 64,
- MAX_IP4_CONFIG_IN_VARIABLE = 16,
+ MAX_IP4_CONFIG_IN_VARIABLE = 16
};
//
|