tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-04-07 19:45:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

NetworkPkg: comments clean up.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11263 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xdu2 2011-01-21 08:00:22 +00:00
parent 686d4d4a86
commit 76389e18c0
19 changed files with 63 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
NetworkPkg/Application/IfConfig6/IfConfig6.c
View File

@ -1,7 +1,7 @@
/** @file
The implementation for Shell application IfConfig6.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -236,8 +236,8 @@ IfConfig6RetriveCheckListByName(
/**
The notify function of create event when performing a manual config.
@param[in] CheckList The pointer of Event.
@param[in] Context The pointer of Context.
@param[in] Event The event this notify function registered to.
@param[in] Context Pointer to the context data registered to the event.
**/
VOID
@ -346,7 +346,7 @@ IfConfig6PrintIpAddr (
@param[in, out] Arg The pointer of the address of ARG_LIST which save Args with the "-s" option.
@param[out] Buf The pointer of the address of EFI_IP6_CONFIG_MANUAL_ADDRESS.
@param[out] Address The pointer of BufSize that describes the size of Buf in bytes.
@param[out] BufSize The pointer of BufSize that describes the size of Buf in bytes.
@retval EFI_SUCCESS The convertion is successful.
@retval Others Does't find the host address, or it is an invalid IPv6 address in string format.
@ -448,7 +448,7 @@ ON_ERROR:
@param[in, out] Arg The pointer of the address of ARG_LIST that save Args with the "-s" option.
@param[out] Buf The pointer of the address of EFI_IPv6_ADDRESS.
@param[out] Address The pointer of BufSize that describes the size of Buf in bytes.
@param[out] BufSize The pointer of BufSize that describes the size of Buf in bytes.
@retval EFI_SUCCESS The conversion is successful.
@retval Others Doesn't find the host address, or it is an invalid IPv6 address in string format.

2
NetworkPkg/Application/IpsecConfig/PolicyEntryOperation.c
View File

@ -25,7 +25,7 @@
@param[out] Selector The pointer to the EFI_IPSEC_SPD_SELECTOR structure.
@param[in] ParamPackage The pointer to the ParamPackage list.
@param[in, out] ParamPackage The pointer to the Mask.
@param[in, out] Mask The pointer to the Mask.
@retval EFI_SUCCESS Fill in EFI_IPSEC_SPD_SELECTOR successfully.
@retval EFI_INVALID_PARAMETER Invalid user input parameter.

4
NetworkPkg/Dhcp6Dxe/Dhcp6Utility.c
View File

@ -1,7 +1,7 @@
/** @file
Dhcp6 support functions implementation.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -540,7 +540,7 @@ Dhcp6DummyExtFree (
/**
The callback routine once message transmitted.
@param[in] Udp6Wrap The pointer to the received net buffer.
@param[in] Wrap The pointer to the received net buffer.
@param[in] EndPoint The pointer to the udp end point.
@param[in] IoStatus The return status from udp io.
@param[in] Context The opaque parameter to the function.

4
NetworkPkg/Dhcp6Dxe/Dhcp6Utility.h
View File

@ -1,7 +1,7 @@
/** @file
Dhcp6 support functions declaration.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -150,7 +150,7 @@ Dhcp6DummyExtFree (
/**
The callback routine once message transmitted.
@param[in] Udp6Wrap The pointer to the received net buffer.
@param[in] Wrap The pointer to the received net buffer.
@param[in] EndPoint The pointer to the udp end point.
@param[in] IoStatus The return status from udp io.
@param[in] Context The opaque parameter to the function.

4
NetworkPkg/Ip6Dxe/Ip6ConfigImpl.c
View File

@ -1,7 +1,7 @@
/** @file
The implementation of EFI IPv6 Configuration Protocol.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -710,7 +710,7 @@ Ip6ConfigSetPolicy (
on a tentative address. A value of ZERO indicates that Duplicate Address Detection
will not be performed on a tentative address.
@param[in] The Instance Pointer to the IP6 config instance data.
@param[in] Instance The Instance Pointer to the IP6 config instance data.
@param[in] DataSize Size of the buffer pointed to by Data in bytes.
@param[in] Data The data buffer to set.

3
NetworkPkg/Ip6Dxe/Ip6Nd.c
View File

@ -1,7 +1,7 @@
/** @file
Implementation of Neighbor Discovery support routines.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -753,7 +753,6 @@ Ip6DestroyDefaultRouter (
Clean an IP6 default router list.
@param[in] IpSb The pointer to the IP6_SERVICE instance.
@param[in] DefaultRouter The to be destroyed IP6_DEFAULT_ROUTER.
**/
VOID

3
NetworkPkg/Ip6Dxe/Ip6Nd.h
View File

@ -1,7 +1,7 @@
/** @file
Definition of Neighbor Discovery support routines.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -225,7 +225,6 @@ Ip6DestroyDefaultRouter (
Clean an IP6 default router list.
@param[in] IpSb The pointer to the IP6_SERVICE instance.
@param[in] DefaultRouter The to be destroyed IP6_DEFAULT_ROUTER.
**/
VOID

4
NetworkPkg/IpSecDxe/IkeService.c
View File

@ -1,7 +1,7 @@
/** @file
Provide IPsec Key Exchange (IKE) service general interfaces.
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -65,7 +65,7 @@ EFI_UDP6_CONFIG_DATA mUdp6Conf = {
Check if the NIC handle is binded to a Udp service.
@param[in] Private Pointer of IPSEC_PRIVATE_DATA.
@param[in] NicHandle The Handle of the NIC card.
@param[in] Handle The Handle of the NIC card.
@param[in] IpVersion The version of the IP stack.
@return a pointer of IKE_UDP_SERVICE.

4
NetworkPkg/IpSecDxe/IkeService.h
View File

@ -1,7 +1,7 @@
/** @file
Prototypes definitions of IKE service.
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -219,7 +219,7 @@ IkeDispatch (
Check if the NIC handle is binded to a Udp service.
@param[in] Private Pointer of IPSEC_PRIVATE_DATA
@param[in] NicHandle The Handle of the NIC card
@param[in] Handle The Handle of the NIC card
@param[in] IpVersion The version of the IP stack.
@return a pointer of IKE_UDP_SERVICE.

8
NetworkPkg/IpSecDxe/IpSecConfigImpl.h
View File

@ -1,7 +1,7 @@
/** @file
Definitions related to IPSEC_CONFIG_PROTOCOL implementations.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -75,11 +75,11 @@ typedef struct {
/**
The prototype of Copy Source Selector to the Destination Selector.
@param[in out] DstSel Pointer of Destination Selector. It would be
@param[in, out] DstSel Pointer of Destination Selector. It would be
SPD Selector, or SAD Selector or PAD Selector.
@param[in] SrcSel Pointer of Source Selector. It would be
SPD Selector, or SAD Selector or PAD Selector.
@param[in out] Size The size of the Destination Selector. If it
@param[in, out] Size The size of the Destination Selector. If it
is not NULL and its value is less than the size of
Source Selector, the value of Source Selector's
size will be passed to the caller by this parameter.
@ -155,7 +155,7 @@ VOID
Data type is related to the Type.
@param[in] SelectorSize The size of the Selector.
@param[in] DataSize The size of the Data.
@param[in out] Buffer The buffer to store the Selector and Data.
@param[in, out] Buffer The buffer to store the Selector and Data.
@retval EFI_SUCCESS Copied the Selector and Data to a buffer successfully.
@retval EFI_OUT_OF_RESOURCES The required system resource could not be allocated.

10
NetworkPkg/IpSecDxe/IpSecCryptIo.c
View File

@ -1,7 +1,7 @@
/** @file
Common interfaces to call Security library.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -251,7 +251,7 @@ IpSecGetIndexFromAuthList (
@param[in] AlgorithmId The Alogrithem identification defined in RFC.
@param[in] Key Pointer to the buffer containing encrypting key.
@param[in} KeyBits The length of the key in bits.
@param[in] KeyBits The length of the key in bits.
@param[in] Ivec Point to the buffer containning the Initializeion
Vector (IV) data.
@param[in] InData Point to the buffer containing the data to be
@ -337,11 +337,11 @@ IpSecCryptoIoEncrypt (
@param[in] AlgorithmId The Alogrithem identification defined in RFC.
@param[in] Key Pointer to the buffer containing encrypting key.
@param[in} KeyBits The length of the key in bits.
@param[in] KeyBits The length of the key in bits.
@param[in] Ivec Point to the buffer containning the Initializeion
Vector (IV) data.
@param[in] InData Point to the buffer containing the data to be
Decrypted.
decrypted.
@param[in] InDataLength The length of InData in Bytes.
@param[out] OutData Pointer to the buffer that receives the decryption
output.
@ -864,7 +864,7 @@ IpSecCryptoIoAuthDataWithCertificate (
@param[in] InCert Pointer to the Certificate which contains the
public key.
@param[in] InCertLen The size of Certificate in bytes.
@param[in] CertLen The size of Certificate in bytes.
@param[in] InCa Pointer to the CA certificate
@param[in] CaLen The size of CA certificate in bytes.
@param[in] InData Pointer to octect message hash to be checked.

8
NetworkPkg/IpSecDxe/IpSecCryptIo.h
View File

@ -511,7 +511,7 @@ IpSecGenerateIv (
@param[in] AlgorithmId The Alogrithem identification defined in RFC.
@param[in] Key Pointer to the buffer containing encrypting key.
@param[in} KeyBits The length of the key in bits.
@param[in] KeyBits The length of the key in bits.
@param[in] Ivec Point to the buffer containning the Initializeion
Vector (IV) data.
@param[in] InData Point to the buffer containing the data to be
@ -546,11 +546,11 @@ IpSecCryptoIoEncrypt (
@param[in] AlgorithmId The Alogrithem identification defined in RFC.
@param[in] Key Pointer to the buffer containing encrypting key.
@param[in} KeyBits The length of the key in bits.
@param[in] KeyBits The length of the key in bits.
@param[in] Ivec Point to the buffer containning the Initializeion
Vector (IV) data.
@param[in] InData Point to the buffer containing the data to be
Decrypted.
decrypted.
@param[in] InDataLength The length of InData in Bytes.
@param[out] OutData Pointer to the buffer that receives the decryption
output.
@ -759,7 +759,7 @@ IpSecCryptoIoAuthDataWithCertificate (
@param[in] InCert Pointer to the Certificate which contains the
public key.
@param[in] InCertLen The size of Certificate in bytes.
@param[in] CertLen The size of Certificate in bytes.
@param[in] InCa Pointer to the CA certificate
@param[in] CaLen The size of CA certificate in bytes.
@param[in] InData Pointer to octect message hash to be checked.

24
NetworkPkg/Mtftp6Dxe/Mtftp6Driver.c
View File

@ -2,7 +2,7 @@
Driver Binding functions and Service Binding functions
implementation for Mtftp6 Driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -270,7 +270,7 @@ Mtftp6DriverEntryPoint (
/**
Test to see if this driver supports ControllerHandle. This service
Test to see if this driver supports Controller. This service
is called by the EFI boot service ConnectController(). In
order to make drivers as small as possible, there are calling
restrictions for this service. ConnectController() must
@ -278,7 +278,7 @@ Mtftp6DriverEntryPoint (
Supported(), it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test
@param[in] Controller Handle of device to test
@param[in] RemainingDevicePath Optional parameter use to pick a specific child.
device to start.
@ -306,7 +306,7 @@ Mtftp6DriverBindingSupported (
/**
Start this driver on ControllerHandle. This service is called by the
Start this driver on Controller. This service is called by the
EFI boot service ConnectController(). In order to make
drivers as small as possible, there are calling restrictions for
this service. ConnectController() must follow these
@ -314,12 +314,12 @@ Mtftp6DriverBindingSupported (
must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to.
@param[in] Controller Handle of device to bind driver to.
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle.
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.
@retval EFI_SUCCESS This driver is added to Controller.
@retval EFI_ALREADY_STARTED This driver is already running on Controller.
@retval Others This driver does not support this device.
**/
@ -402,20 +402,20 @@ ON_ERROR:
/**
Stop this driver on ControllerHandle. This service is called by the
Stop this driver on Controller. This service is called by the
EFI boot service DisconnectController(). In order to
make drivers as small as possible, there are a few calling
make drivers as small as possible, there are calling
restrictions for this service. DisconnectController()
must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
to call Stop(), it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to stop driver on
@param[in] Controller Handle of device to stop driver on
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero, stop the entire bus driver.
@param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle.
@retval EFI_SUCCESS This driver is removed Controller.
@retval EFI_DEVICE_ERROR An unexpected error.
@retval Others This driver was not removed from this device.

20
NetworkPkg/Mtftp6Dxe/Mtftp6Driver.h
View File

@ -2,7 +2,7 @@
Driver Binding functions and Service Binding functions
declaration for Mtftp6 Driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -23,7 +23,7 @@ extern EFI_COMPONENT_NAME_PROTOCOL gMtftp6ComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2;
/**
Test to see if this driver supports ControllerHandle. This service
Test to see if this driver supports Controller. This service
is called by the EFI boot service ConnectController(). In
order to make drivers as small as possible, there are a few calling
restrictions for this service. ConnectController() must
@ -31,7 +31,7 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2;
Supported(), it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test.
@param[in] Controller Handle of device to test.
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@ -48,7 +48,7 @@ Mtftp6DriverBindingSupported (
);
/**
Start this driver on ControllerHandle. This service is called by the
Start this driver on Controller. This service is called by the
EFI boot service ConnectController(). In order to make
drivers as small as possible, there are calling restrictions for
this service. ConnectController() must follow these
@ -56,12 +56,12 @@ Mtftp6DriverBindingSupported (
must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to.
@param[in] Controller Handle of device to bind driver to.
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle.
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.
@retval EFI_SUCCESS This driver is added to Controller.
@retval EFI_ALREADY_STARTED This driver is already running on Controller.
@retval Others This driver does not support this device.
**/
@ -74,7 +74,7 @@ Mtftp6DriverBindingStart (
);
/**
Stop this driver on ControllerHandle. This service is called by the
Stop this driver on Controller. This service is called by the
EFI boot service DisconnectController(). In order to
make drivers as small as possible, there are calling
restrictions for this service. DisconnectController()
@ -82,12 +82,12 @@ Mtftp6DriverBindingStart (
to call Stop(), it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to stop driver on
@param[in] Controller Handle of device to stop driver on
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero, stop the entire bus driver.
@param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle.
@retval EFI_SUCCESS This driver is removed Controller.
@retval EFI_DEVICE_ERROR An unexpected error.
@retval Others This driver was not removed from this device.

4
NetworkPkg/Mtftp6Dxe/Mtftp6Rrq.c
View File

@ -1,7 +1,7 @@
/** @file
Mtftp6 Rrq process functions implementation.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -105,7 +105,7 @@ Mtftp6RrqSaveBlock (
// This is the last block, save the block num
//
if (DataLen < Instance->BlkSize) {
Completed = TRUE;
Completed = TRUE;
Instance->LastBlk = Block;
Mtftp6SetLastBlockNum (&Instance->BlkList, Block);
}

3
NetworkPkg/NetworkPkg.dec
View File

@ -19,11 +19,12 @@
PACKAGE_NAME = NetworkPkg
PACKAGE_GUID = 947988BE-8D5C-471a-893D-AD181C46BEBB
PACKAGE_VERSION = 0.92
[Guids]
## Network package token space guid.
# Include/Guid/NetworkPkgTokenSpace.h
gEfiNetworkPkgTokenSpaceGuid = { 0x40e064b2, 0x0ae0, 0x48b1, { 0xa0, 0x7d, 0xf8, 0xcf, 0x1e, 0x1a, 0x23, 0x10}}
[PcdsFeatureFlag]
## If true, the IKEv2 Certificate Authentication feature is enabled.
gEfiNetworkPkgTokenSpaceGuid.PcdIpsecCertificateEnabled|TRUE|BOOLEAN|0x00000007

4
NetworkPkg/TcpDxe/TcpDriver.c
View File

@ -1,7 +1,7 @@
/** @file
The driver binding and service binding protocol for the TCP driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -196,7 +196,7 @@ TcpDriverEntryPoint (
Create a new TCP4 or TCP6 driver service binding protocol
@param[in] Controller Controller handle of device to bind driver to.
@param[in] ImageHandle The TCP driver's image handle.
@param[in] Image The TCP driver's image handle.
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.

4
NetworkPkg/UefiPxeBcDxe/PxeBcSupport.c
View File

@ -1,7 +1,7 @@
/** @file
Support functions implementation for UefiPxeBc Driver.
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -1081,7 +1081,7 @@ PxeBcCheckByDestIp (
/**
Check the received packet using the destination port.
@param[in] PxeBcMode The pointer to the mode data of PxeBc.
@param[in] Mode The pointer to the mode data of PxeBc.
@param[in] Session The pointer to the current UDPv4 session.
@param[in, out] DestPort The pointer to the destination port.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.

4
NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
View File

@ -1,7 +1,7 @@
/** @file
Support functions declaration for UefiPxeBc Driver.
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -286,7 +286,7 @@ PxeBcCheckByDestIp (
/**
Check the received packet with the destination port.
@param[in] PxeBcMode Pointer to mode data of PxeBc.
@param[in] Mode Pointer to mode data of PxeBc.
@param[in] Session Pointer to the current UDPv4 session.
@param[in, out] DestPort Pointer to the destination port.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.