sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

code scrub fix

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7290 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jgong5
2009-01-16 00:09:52 +00:00
parent be973ff7f3
commit 3e8c18da04
46 changed files with 1544 additions and 2021 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c
View File

@@ -1,11 +1,11 @@
/** @file
UEFI Component Name(2) protocol implementation for MnpDxe driver.
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
http://opensource.org/licenses/bsd-license.php
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
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.
@@ -28,10 +28,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
@param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -40,7 +40,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
to the driver writer. Language is specified
in RFC 3066 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
@param[out] DriverName A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@@ -79,15 +79,15 @@ MnpComponentNameGetDriverName (
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] The handle of a controller that the driver
@param[in] ControllerHandle The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
@param ChildHandle[in] The handle of the child controller to retrieve
@param[in] ChildHandle The handle of the child controller to retrieve
the name of. This is an optional parameter that
may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers
@@ -96,7 +96,7 @@ MnpComponentNameGetDriverName (
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
@param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -105,7 +105,7 @@ MnpComponentNameGetDriverName (
to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
@param ControllerName[out] A pointer to the Unicode string to return.
@param[out] ControllerName A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by
@@ -185,10 +185,10 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = {
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
@param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -197,7 +197,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = {
to the driver writer. Language is specified
in RFC 3066 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
@param[out] DriverName A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@@ -244,15 +244,15 @@ MnpComponentNameGetDriverName (
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] The handle of a controller that the driver
@param[in] ControllerHandle The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
@param ChildHandle[in] The handle of the child controller to retrieve
@param[in] ChildHandle The handle of the child controller to retrieve
the name of. This is an optional parameter that
may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers
@@ -261,7 +261,7 @@ MnpComponentNameGetDriverName (
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
@param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -270,7 +270,7 @@ MnpComponentNameGetDriverName (
to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
@param ControllerName[out] A pointer to the Unicode string to return.
@param[out] ControllerName A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by

86
MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
View File

@@ -1,11 +1,11 @@
/** @file
Implementation of Managed Network Protocol private services.
Copyright (c) 2005 - 2008, 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
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2005 - 2008, 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
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.
@@ -48,7 +48,7 @@ EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = {
Configure the Snp receive filters according to the instances' receive filter
settings.
@param MnpServiceData Pointer to the mnp service context data.
@param[in] MnpServiceData Pointer to the mnp service context data.
@retval EFI_SUCCESS The receive filters is configured.
@retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due to
@@ -205,8 +205,8 @@ MnpConfigReceiveFilters (
Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net
buffer is specified by MnpServiceData->BufferLength.
@param MnpServiceData Pointer to the MNP_SERVICE_DATA.
@param Count Number of NET_BUFFERs to add.
@param[in] MnpServiceData Pointer to the MNP_SERVICE_DATA.
@param[in] Count Number of NET_BUFFERs to add.
@retval EFI_SUCCESS The specified amount of NET_BUFs are allocated
and added to MnpServiceData->FreeNbufQue.
@@ -260,7 +260,7 @@ MnpAddFreeNbuf (
in the queue, first try to allocate some and add them into the queue, then
fetch the NET_BUF from the updated FreeNbufQue.
@param MnpServiceData Pointer to the MNP_SERVICE_DATA.
@param[in] MnpServiceData Pointer to the MNP_SERVICE_DATA.
@return Pointer to the allocated free NET_BUF structure, if NULL the
operation is failed.
@@ -335,7 +335,7 @@ ON_EXIT:
@param MnpServiceData Pointer to the mnp service context data.
@param Nbuf Pointer to the NET_BUF to free.
**/
VOID
MnpFreeNbuf (
@@ -367,9 +367,9 @@ MnpFreeNbuf (
/**
Initialize the mnp service context data.
@param MnpServiceData Pointer to the mnp service context data.
@param ImageHandle The driver image handle.
@param ControllerHandle Handle of device to bind driver to.
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] ImageHandle The driver image handle.
@param[in] ControllerHandle Handle of device to bind driver to.
@retval EFI_SUCCESS The mnp service context is initialized.
@retval Other Some error occurs.
@@ -555,7 +555,7 @@ ERROR:
@param MnpServiceData Pointer to the mnp service context data.
@param ImageHandle The driver image handle.
**/
VOID
MnpFlushServiceData (
@@ -616,8 +616,8 @@ MnpFlushServiceData (
/**
Initialize the mnp instance context data.
@param MnpServiceData Pointer to the mnp service context data.
@param Instance Pointer to the mnp instance context data to
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] Instance Pointer to the mnp instance context data to
initialize.
**/
@@ -667,9 +667,9 @@ MnpInitializeInstanceData (
/**
Check whether the token specified by Arg maches the token in Item.
@param Map Pointer to the NET_MAP.
@param Item Pointer to the NET_MAP_ITEM
@param Arg Pointer to the Arg, it's a pointer to the token to
@param[in] Map Pointer to the NET_MAP.
@param[in] Item Pointer to the NET_MAP_ITEM
@param[in] Arg Pointer to the Arg, it's a pointer to the token to
check.
@retval EFI_SUCCESS The token specified by Arg is different from the
@@ -705,10 +705,10 @@ MnpTokenExist (
/**
Cancel the token specified by Arg if it matches the token in Item.
@param Map Pointer to the NET_MAP.
@param Item Pointer to the NET_MAP_ITEM
@param Arg Pointer to the Arg, it's a pointer to the token to
cancel.
@param[in, out] Map Pointer to the NET_MAP.
@param[in] Item Pointer to the NET_MAP_ITEM
@param[in] Arg Pointer to the Arg, it's a pointer to the token to
cancel.
@retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled,
or the Arg isn't NULL, and the token in Item is
@@ -760,7 +760,7 @@ MnpCancelTokens (
/**
Start and initialize the simple network.
@param Snp Pointer to the simple network protocol.
@param[in] Snp Pointer to the simple network protocol.
@retval EFI_SUCCESS The simple network protocol is started.
@retval Other Some error occurs.
@@ -794,7 +794,7 @@ MnpStartSnp (
/**
Stop the simple network.
@param Snp Pointer to the simple network protocol.
@param[in] Snp Pointer to the simple network protocol.
@retval EFI_SUCCESS The simple network is stopped.
@retval Other Some error occurs.
@@ -829,10 +829,10 @@ MnpStopSnp (
Start the managed network, this function is called when one instance is configured
or reconfigured.
@param MnpServiceData Pointer to the mnp service context data.
@param IsConfigUpdate The instance is reconfigured or it's the first time
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] IsConfigUpdate The instance is reconfigured or it's the first time
the instanced is configured.
@param EnableSystemPoll Enable the system polling or not.
@param[in] EnableSystemPoll Enable the system polling or not.
@retval EFI_SUCCESS The managed network is started and some
configuration is updated.
@@ -921,7 +921,7 @@ ErrorExit:
/**
Stop the managed network.
@param MnpServiceData Pointer to the mnp service context data.
@param[in] MnpServiceData Pointer to the mnp service context data.
@retval EFI_SUCCESS The managed network is stopped.
@retval Other Some error occurs.
@@ -1021,8 +1021,8 @@ MnpFlushRcvdDataQueue (
/**
Configure the Instance using ConfigData.
@param Instance Pointer to the mnp instance context data.
@param ConfigData Pointer to the configuration data used to configure
@param[in] Instance Pointer to the mnp instance context data.
@param[in] ConfigData Pointer to the configuration data used to configure
the isntance.
@retval EFI_SUCCESS The Instance is configured.
@@ -1162,11 +1162,11 @@ MnpConfigureInstance (
Add a group address control block which controls the MacAddress for
this instance.
@param Instance Pointer to the mnp instance context data.
@param CtrlBlk Pointer to the group address control block.
@param GroupAddress Pointer to the group adress.
@param MacAddress Pointer to the mac address.
@param HwAddressSize The hardware address size.
@param[in] Instance Pointer to the mnp instance context data.
@param[in] CtrlBlk Pointer to the group address control block.
@param[in] GroupAddress Pointer to the group adress.
@param[in] MacAddress Pointer to the mac address.
@param[in] HwAddressSize The hardware address size.
@retval EFI_SUCCESS The group address control block is added.
@retval EFI_OUT_OF_RESOURCE Failed due to lack of memory resources.
@@ -1231,8 +1231,8 @@ MnpGroupOpAddCtrlBlk (
Delete a group control block from the instance. If the controlled group address's
reference count reaches zero, the group address is removed too.
@param Instance Pointer to the instance context data.
@param CtrlBlk Pointer to the group control block to delete.
@param[in] Instance Pointer to the instance context data.
@param[in] CtrlBlk Pointer to the group control block to delete.
@return The group address controlled by the control block is no longer used or not.
@@ -1283,11 +1283,11 @@ MnpGroupOpDelCtrlBlk (
/**
Do the group operations for this instance.
@param Instance Pointer to the instance context data.
@param JoinFlag Set to TRUE to join a group. Set to TRUE to leave a
@param[in] Instance Pointer to the instance context data.
@param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to leave a
group/groups.
@param MacAddress Pointer to the group address to join or leave.
@param CtrlBlk Pointer to the group control block if JoinFlag if
@param[in] MacAddress Pointer to the group address to join or leave.
@param[in] CtrlBlk Pointer to the group control block if JoinFlag if
FALSE.
@retval EFI_SUCCESS The group operation finished.

96
MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c
View File

@@ -1,11 +1,11 @@
/** @file
Implementation of driver entry point and driver binding protocol.
Copyright (c) 2005 - 2008, 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
http://opensource.org/licenses/bsd-license.php
Copyright (c) 2005 - 2008, 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
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.
@@ -33,10 +33,10 @@ EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding = {
follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to test
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@@ -107,10 +107,10 @@ MnpDriverBindingSupported (
calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle 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
@@ -185,11 +185,11 @@ ErrorExit:
must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle 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 other This driver was not removed from this device
@@ -270,19 +270,22 @@ MnpDriverBindingStop (
/**
Creates a child handle with a set of I/O services.
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle.
If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
@param This Protocol instance pointer.
@param ChildHandle Pointer to the handle of the child to create. If
it is NULL, then a new handle is created. If it is
not NULL, then the I/O services are added to the
existing child handle.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Pointer to the handle of the child to create. If it is NULL,
then a new handle is created. If it is a pointer to an existing UEFI handle,
then the protocol is added to the existing UEFI handle.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to
create the child.
@retval other The child handle was not created.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child
@retval other The child handle was not created
**/
EFI_STATUS
@@ -384,24 +387,21 @@ ErrorExit:
/**
Destroys a child handle with a set of I/O services.
The DestroyChild() function does the opposite of CreateChild(). It removes a
protocol that was installed by CreateChild() from ChildHandle. If the removed
protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL
instance.
@param ChildHandle Handle of the child to destroy.
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
that was installed by CreateChild() from ChildHandle. If the removed protocol is the
last protocol on ChildHandle, then ChildHandle is destroyed.
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that
is being removed.
@retval EFI_INVALID_PARAMETER ChildHandle is not a valid UEFI handle.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the
ChildHandle because its services are being
used.
@retval other The child handle was not destroyed.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used.
@retval other The child handle was not destroyed
**/
EFI_STATUS
@@ -520,8 +520,8 @@ MnpServiceBindingDestroyChild (
The entry point for Mnp driver which installs the driver binding and component
name protocol on its ImageHandle.
@param ImageHandle The image handle of the driver.
@param SystemTable The system table.
@param[in] ImageHandle The image handle of the driver.
@param[in] SystemTable The system table.
@retval EFI_SUCCES The driver binding and component name protocols are
successfully installed.

85
MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h
View File

@@ -1,11 +1,11 @@
/** @file
Declaration of strctures and functions for MnpDxe driver.
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
http://opensource.org/licenses/bsd-license.php
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
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.
@@ -96,10 +96,10 @@ typedef struct _MNP_SERVICE_DATA {
follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to test
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@@ -122,10 +122,10 @@ MnpDriverBindingSupported (
calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle 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
@@ -149,11 +149,11 @@ MnpDriverBindingStart (
must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle 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 other This driver was not removed from this device
@@ -169,19 +169,22 @@ MnpDriverBindingStop (
);
/**
Creates a child handle with a set of I/O services.
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle.
If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
@param This Protocol instance pointer.
@param ChildHandle Pointer to the handle of the child to create. If
it is NULL, then a new handle is created. If it is
not NULL, then the I/O services are added to the
existing child handle.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Pointer to the handle of the child to create. If it is NULL,
then a new handle is created. If it is a pointer to an existing UEFI handle,
then the protocol is added to the existing UEFI handle.
@retval EFI_SUCCES The child handle was created with the I/O
services.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child.
@retval other The child handle was not created.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child
@retval other The child handle was not created
**/
EFI_STATUS
@@ -192,19 +195,21 @@ MnpServiceBindingCreateChild (
);
/**
Destroys a child handle with a set of I/O services.
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
that was installed by CreateChild() from ChildHandle. If the removed protocol is the
last protocol on ChildHandle, then ChildHandle is destroyed.
@param This Protocol instance pointer.
@param ChildHandle Handle of the child to destroy.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The I/O services were removed from the child
handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because
its I/O services are being used.
@retval other The child handle was not destroyed.
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used.
@retval other The child handle was not destroyed
**/
EFI_STATUS

176
MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h
View File

@@ -1,7 +1,7 @@
/** @file
Declaration of structures and functions of MnpDxe driver.
Copyright (c) 2005 - 2008, Intel Corporation. <BR>
Copyright (c) 2005 - 2008, 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
@@ -93,9 +93,9 @@ typedef struct _MNP_RXDATA_WRAP {
/**
Initialize the mnp service context data.
@param MnpServiceData Pointer to the mnp service context data.
@param ImageHandle The driver image handle.
@param ControllerHandle Handle of device to bind driver to.
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] ImageHandle The driver image handle.
@param[in] ControllerHandle Handle of device to bind driver to.
@retval EFI_SUCCESS The mnp service context is initialized.
@retval Other Some error occurs.
@@ -113,7 +113,7 @@ MnpInitializeServiceData (
@param MnpServiceData Pointer to the mnp service context data.
@param ImageHandle The driver image handle.
**/
VOID
MnpFlushServiceData (
@@ -124,8 +124,8 @@ MnpFlushServiceData (
/**
Initialize the mnp instance context data.
@param MnpServiceData Pointer to the mnp service context data.
@param Instance Pointer to the mnp instance context data to
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] Instance Pointer to the mnp instance context data to
initialize.
**/
@@ -138,9 +138,9 @@ MnpInitializeInstanceData (
/**
Check whether the token specified by Arg maches the token in Item.
@param Map Pointer to the NET_MAP.
@param Item Pointer to the NET_MAP_ITEM
@param Arg Pointer to the Arg, it's a pointer to the token to
@param[in] Map Pointer to the NET_MAP.
@param[in] Item Pointer to the NET_MAP_ITEM
@param[in] Arg Pointer to the Arg, it's a pointer to the token to
check.
@retval EFI_SUCCESS The token specified by Arg is different from the
@@ -159,16 +159,16 @@ MnpTokenExist (
/**
Cancel the token specified by Arg if it matches the token in Item.
@param Map Pointer to the NET_MAP.
@param Item Pointer to the NET_MAP_ITEM
@param Arg Pointer to the Arg, it's a pointer to the token to
@param[in, out] Map Pointer to the NET_MAP.
@param[in] Item Pointer to the NET_MAP_ITEM
@param[in] Arg Pointer to the Arg, it's a pointer to the token to
cancel.
@retval EFI_SUCCESS The Arg is NULL, and the token in Item is
cancelled, or the Arg isn't NULL, and the token in
Item is different from the Arg.
@retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the
Arg, and the token is cancelled.
@retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled,
or the Arg isn't NULL, and the token in Item is
different from the Arg.
@retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the
Arg, and the token is cancelled.
**/
EFI_STATUS
@@ -192,8 +192,8 @@ MnpFlushRcvdDataQueue (
/**
Configure the Instance using ConfigData.
@param Instance Pointer to the mnp instance context data.
@param ConfigData Pointer to the configuration data used to configure
@param[in] Instance Pointer to the mnp instance context data.
@param[in] ConfigData Pointer to the configuration data used to configure
the isntance.
@retval EFI_SUCCESS The Instance is configured.
@@ -211,11 +211,11 @@ MnpConfigureInstance (
/**
Do the group operations for this instance.
@param Instance Pointer to the instance context data.
@param JoinFlag Set to TRUE to join a group. Set to TRUE to leave a
@param[in] Instance Pointer to the instance context data.
@param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to leave a
group/groups.
@param MacAddress Pointer to the group address to join or leave.
@param CtrlBlk Pointer to the group control block if JoinFlag if
@param[in] MacAddress Pointer to the group address to join or leave.
@param[in] CtrlBlk Pointer to the group control block if JoinFlag if
FALSE.
@retval EFI_SUCCESS The group operation finished.
@@ -226,15 +226,15 @@ EFI_STATUS
MnpGroupOp (
IN MNP_INSTANCE_DATA *Instance,
IN BOOLEAN JoinFlag,
IN EFI_MAC_ADDRESS *MacAddr OPTIONAL,
IN EFI_MAC_ADDRESS *MacAddress OPTIONAL,
IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL
);
/**
Validates the Mnp transmit token.
@param Instance Pointer to the Mnp instance context data.
@param Token Pointer to the transmit token to check.
@param[in] Instance Pointer to the Mnp instance context data.
@param[in] Token Pointer to the transmit token to check.
@return The Token is valid or not.
@@ -254,7 +254,7 @@ MnpIsValidTxToken (
@param PktBuf Pointer to record the address of the packet.
@param PktLen Pointer to a UINT32 variable used to record the
packet's length.
**/
VOID
MnpBuildTxPacket (
@@ -267,10 +267,10 @@ MnpBuildTxPacket (
/**
Synchronously send out the packet.
@param MnpServiceData Pointer to the mnp service context data.
@param Packet Pointer to the pakcet buffer.
@param Length The length of the packet.
@param Token Pointer to the token the packet generated from.
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] Packet Pointer to the pakcet buffer.
@param[in] Length The length of the packet.
@param[in] Token Pointer to the token the packet generated from.
@retval EFI_SUCCESS The packet is sent out.
@retval EFI_TIMEOUT Time out occurs, the packet isn't sent.
@@ -288,7 +288,7 @@ MnpSyncSendPacket (
/**
Try to deliver the received packet to the instance.
@param Instance Pointer to the mnp instance context data.
@param[in] Instance Pointer to the mnp instance context data.
@retval EFI_SUCCESS The received packet is delivered, or there is no
packet to deliver, or there is no available receive
@@ -305,9 +305,9 @@ MnpInstanceDeliverPacket (
Recycle the RxData and other resources used to hold and deliver the received
packet.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registerd to the Event.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registerd to the Event.
**/
VOID
EFIAPI
@@ -319,7 +319,7 @@ MnpRecycleRxData (
/**
Try to receive a packet and deliver it.
@param MnpServiceData Pointer to the mnp service context data.
@param[in] MnpServiceData Pointer to the mnp service context data.
@retval EFI_SUCCESS add return value to function comment
@retval EFI_NOT_STARTED The simple network protocol is not started.
@@ -337,9 +337,10 @@ MnpReceivePacket (
in the queue, first try to allocate some and add them into the queue, then
fetch the NET_BUF from the updated FreeNbufQue.
@param MnpServiceData Pointer to the MNP_SERVICE_DATA.
@param[in] MnpServiceData Pointer to the MNP_SERVICE_DATA.
@return Pointer to the allocated free NET_BUF structure, if NULL the operation is failed.
@return Pointer to the allocated free NET_BUF structure, if NULL the
operation is failed.
**/
NET_BUF *
@@ -352,7 +353,7 @@ MnpAllocNbuf (
@param MnpServiceData Pointer to the mnp service context data.
@param Nbuf Pointer to the NET_BUF to free.
**/
VOID
MnpFreeNbuf (
@@ -363,10 +364,10 @@ MnpFreeNbuf (
/**
Remove the received packets if timeout occurs.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
**/
VOID
EFIAPI
@@ -379,9 +380,9 @@ MnpCheckPacketTimeout (
Poll to receive the packets from Snp. This function is either called by upperlayer
protocols/applications or the system poll timer notify mechanism.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
**/
VOID
@@ -398,13 +399,13 @@ MnpSystemPoll (
The GetModeData() function is used to read the current mode data (operational
parameters) from the MNP or the underlying SNP.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData Pointer to storage for MNP operational parameters. Type
EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related
Definitions" below.
@param SnpModeData Pointer to storage for SNP operational parameters. This
feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE
is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type
EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related
Definitions" below.
@param[out] SnpModeData Pointer to storage for SNP operational parameters. This
feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE
is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -446,14 +447,13 @@ MnpGetModeData (
Note: Warning: Receive filter settings that overlap will consume extra
processor and/or DMA resources and degrade system and network performance.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData Pointer to configuration data that will be assigned
to the MNP child driver instance. If NULL, the MNP
child driver instance is reset to startup defaults
and all pending transmit and receive requests are
flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is
defined in
EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] MnpConfigData Pointer to configuration data that will be assigned
to the MNP child driver instance. If NULL, the MNP
child driver instance is reset to startup defaults
and all pending transmit and receive requests are
flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is
defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is
@@ -493,12 +493,12 @@ MnpConfigure (
underlying EFI_SIMPLE_NETWORK.MCastIpToMac() function, which may also be
unsupported in some MNP implementations.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.
Set to FALSE if IpAddress is an IPv4 multicast address.
@param IpAddress Pointer to the multicast IP address (in network byte order)
to convert.
@param MacAddress Pointer to the resulting multicast MAC address.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.
Set to FALSE if IpAddress is an IPv4 multicast address.
@param[in] IpAddress Pointer to the multicast IP address (in network byte order)
to convert.
@param[out] MacAddress Pointer to the resulting multicast MAC address.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:
@@ -532,11 +532,11 @@ MnpMcastIpToMac (
Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is
NULL, then all joined groups are left.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param JoinFlag Set to TRUE to join this multicast group.
Set to FALSE to leave this multicast group.
@param MacAddress Pointer to the multicast MAC group (address) to join or
leave.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] JoinFlag Set to TRUE to join this multicast group.
Set to FALSE to leave this multicast group.
@param[in] MacAddress Pointer to the multicast MAC group (address) to join or
leave.
@retval EFI_SUCCESS The requested operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
@@ -582,10 +582,10 @@ MnpGroups (
the underlying communications device and drivers.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token associated with the transmit data
descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is
defined in "Related Definitions" below.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Token Pointer to a token associated with the transmit data
descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is
defined in "Related Definitions" below.
@retval EFI_SUCCESS The transmit completion token was cached.
@retval EFI_NOT_STARTED This MNP child driver instance has not been
@@ -639,11 +639,11 @@ MnpTransmit (
the asynchronous operation has completed, this function will not signal the
token and EFI_NOT_FOUND is returned.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token that has been issued by
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending
tokens are aborted.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Token Pointer to a token that has been issued by
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending
tokens are aborted.
@retval EFI_SUCCESS The asynchronous I/O request was aborted and
Token.Event was signaled. When Token is NULL,
@@ -675,11 +675,11 @@ MnpCancel (
updates the Token.Status and Token.RxData fields and the Token.Event is
signaled.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token associated with the receive
data descriptor. Type
EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in
EFI_MANAGED_NETWORK_PROTOCOL.Transmit().
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Token Pointer to a token associated with the receive
data descriptor. Type
EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in
EFI_MANAGED_NETWORK_PROTOCOL.Transmit().
@retval EFI_SUCCESS The receive completion token was cached.
@retval EFI_NOT_STARTED This MNP child driver instance has not been
@@ -719,7 +719,7 @@ MnpReceive (
applications that are experiencing packet loss should try calling the Poll()
function more often.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This MNP child driver instance has not been

95
MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c
View File

@@ -1,7 +1,8 @@
/** @file
Implementation of Managed Network Protocol I/O functions.
Copyright (c) 2005 - 2007, Intel Corporation. <BR>
Implementation of Managed Network Protocol I/O functions.
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
@@ -22,8 +23,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Validates the Mnp transmit token.
@param Instance Pointer to the Mnp instance context data.
@param Token Pointer to the transmit token to check.
@param[in] Instance Pointer to the Mnp instance context data.
@param[in] Token Pointer to the transmit token to check.
@return The Token is valid or not.
@@ -115,7 +116,7 @@ MnpIsValidTxToken (
@param PktBuf Pointer to record the address of the packet.
@param PktLen Pointer to a UINT32 variable used to record the
packet's length.
**/
VOID
MnpBuildTxPacket (
@@ -179,10 +180,10 @@ MnpBuildTxPacket (
/**
Synchronously send out the packet.
@param MnpServiceData Pointer to the mnp service context data.
@param Packet Pointer to the pakcet buffer.
@param Length The length of the packet.
@param Token Pointer to the token the packet generated from.
@param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] Packet Pointer to the pakcet buffer.
@param[in] Length The length of the packet.
@param[in] Token Pointer to the token the packet generated from.
@retval EFI_SUCCESS The packet is sent out.
@retval EFI_TIMEOUT Time out occurs, the packet isn't sent.
@@ -296,7 +297,7 @@ SIGNAL_TOKEN:
/**
Try to deliver the received packet to the instance.
@param Instance Pointer to the mnp instance context data.
@param[in] Instance Pointer to the mnp instance context data.
@retval EFI_SUCCESS The received packet is delivered, or there is no
packet to deliver, or there is no available receive
@@ -392,8 +393,6 @@ MnpInstanceDeliverPacket (
@param MnpServiceData Pointer to the mnp service context data.
@return None.
**/
VOID
MnpDeliverPacket (
@@ -421,9 +420,9 @@ MnpDeliverPacket (
Recycle the RxData and other resources used to hold and deliver the received
packet.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registerd to the Event.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registerd to the Event.
**/
VOID
EFIAPI
@@ -468,12 +467,10 @@ MnpRecycleRxData (
/**
Queue the received packet into instance's receive queue.
@param Instance Pointer to the mnp instance context data.
@param RxDataWrap Pointer to the Wrap structure containing the
@param Instance Pointer to the mnp instance context data.
@param RxDataWrap Pointer to the Wrap structure containing the
received data and other information.
@return None.
**/
VOID
MnpQueueRcvdPacket (
@@ -525,13 +522,13 @@ MnpQueueRcvdPacket (
/**
Match the received packet with the instance receive filters.
@param Instance Pointer to the mnp instance context data.
@param RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.
@param GroupAddress Pointer to the GroupAddress, the GroupAddress is
@param[in] Instance Pointer to the mnp instance context data.
@param[in] RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.
@param[in] GroupAddress Pointer to the GroupAddress, the GroupAddress is
non-NULL and it contains the destination multicast
mac address of the received packet if the packet
destinated to a multicast mac address.
@param PktAttr The received packets attribute.
@param[in] PktAttr The received packets attribute.
@return The received packet matches the instance's receive filters or not.
@@ -603,18 +600,16 @@ MnpMatchPacket (
/**
Analyse the received packets.
@param MnpServiceData Pointer to the mnp service context data.
@param Nbuf Pointer to the net buffer holding the received
packet.
@param RxData Pointer to the buffer used to save the analysed
result in EFI_MANAGED_NETWORK_RECEIVE_DATA.
@param GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to
pass out the address of the multicast address the
received packet destinated to.
@param PktAttr Pointer to the buffer used to save the analysed
packet attribute.
@return None.
@param MnpServiceData Pointer to the mnp service context data.
@param Nbuf Pointer to the net buffer holding the received
packet.
@param RxData Pointer to the buffer used to save the analysed
result in EFI_MANAGED_NETWORK_RECEIVE_DATA.
@param GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to
pass out the address of the multicast address the
received packet destinated to.
@param PktAttr Pointer to the buffer used to save the analysed
packet attribute.
**/
VOID
@@ -707,8 +702,8 @@ MnpAnalysePacket (
/**
Wrap the RxData.
@param Instance Pointer to the mnp instance context data.
@param RxData Pointer to the receive data to wrap.
@param[in] Instance Pointer to the mnp instance context data.
@param[in] RxData Pointer to the receive data to wrap.
@return Pointer to a MNP_RXDATA_WRAP which wraps the RxData.
@@ -763,11 +758,9 @@ MnpWrapRxData (
Enqueue the received the packets to the instances belonging to the
MnpServiceData.
@param MnpServiceData Pointer to the mnp service context data.
@param Nbuf Pointer to the net buffer representing the received
packet.
@return None.
@param MnpServiceData Pointer to the mnp service context data.
@param Nbuf Pointer to the net buffer representing the received
packet.
**/
VOID
@@ -840,7 +833,7 @@ MnpEnqueuePacket (
/**
Try to receive a packet and deliver it.
@param MnpServiceData Pointer to the mnp service context data.
@param[in] MnpServiceData Pointer to the mnp service context data.
@retval EFI_SUCCESS add return value to function comment
@retval EFI_NOT_STARTED The simple network protocol is not started.
@@ -992,10 +985,10 @@ EXIT:
/**
Remove the received packets if timeout occurs.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
**/
VOID
EFIAPI
@@ -1059,9 +1052,9 @@ MnpCheckPacketTimeout (
Poll to receive the packets from Snp. This function is either called by upperlayer
protocols/applications or the system poll timer notify mechanism.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
@param Event The event this notify function registered to.
@param Context Pointer to the context data registered to the
event.
**/
VOID

86
MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c
View File

@@ -1,7 +1,8 @@
/** @file
Implementation of Managed Network Protocol public services.
Implementation of Managed Network Protocol public services.
Copyright (c) 2005 - 2007, Intel Corporation.<BR>
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
@@ -24,13 +25,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
The GetModeData() function is used to read the current mode data (operational
parameters) from the MNP or the underlying SNP.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData Pointer to storage for MNP operational parameters. Type
EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related
Definitions" below.
@param SnpModeData Pointer to storage for SNP operational parameters. This
feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE
is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type
EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related
Definitions" below.
@param[out] SnpModeData Pointer to storage for SNP operational parameters. This
feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE
is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -113,14 +114,13 @@ MnpGetModeData (
Note: Warning: Receive filter settings that overlap will consume extra
processor and/or DMA resources and degrade system and network performance.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param MnpConfigData Pointer to configuration data that will be assigned
to the MNP child driver instance. If NULL, the MNP
child driver instance is reset to startup defaults
and all pending transmit and receive requests are
flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is
defined in
EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] MnpConfigData Pointer to configuration data that will be assigned
to the MNP child driver instance. If NULL, the MNP
child driver instance is reset to startup defaults
and all pending transmit and receive requests are
flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is
defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is
@@ -196,12 +196,12 @@ ON_EXIT:
underlying EFI_SIMPLE_NETWORK.MCastIpToMac() function, which may also be
unsupported in some MNP implementations.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.
Set to FALSE if IpAddress is an IPv4 multicast address.
@param IpAddress Pointer to the multicast IP address (in network byte order)
to convert.
@param MacAddress Pointer to the resulting multicast MAC address.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.
Set to FALSE if IpAddress is an IPv4 multicast address.
@param[in] IpAddress Pointer to the multicast IP address (in network byte order)
to convert.
@param[out] MacAddress Pointer to the resulting multicast MAC address.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:
@@ -303,11 +303,11 @@ ON_EXIT:
Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is
NULL, then all joined groups are left.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param JoinFlag Set to TRUE to join this multicast group.
Set to FALSE to leave this multicast group.
@param MacAddress Pointer to the multicast MAC group (address) to join or
leave.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] JoinFlag Set to TRUE to join this multicast group.
Set to FALSE to leave this multicast group.
@param[in] MacAddress Pointer to the multicast MAC group (address) to join or
leave.
@retval EFI_SUCCESS The requested operation completed successfully.
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
@@ -455,10 +455,10 @@ ON_EXIT:
the underlying communications device and drivers.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token associated with the transmit data
descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is
defined in "Related Definitions" below.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Token Pointer to a token associated with the transmit data
descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is
defined in "Related Definitions" below.
@retval EFI_SUCCESS The transmit completion token was cached.
@retval EFI_NOT_STARTED This MNP child driver instance has not been
@@ -562,11 +562,11 @@ ON_EXIT:
updates the Token.Status and Token.RxData fields and the Token.Event is
signaled.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token associated with the receive
data descriptor. Type
EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in
EFI_MANAGED_NETWORK_PROTOCOL.Transmit().
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Token Pointer to a token associated with the receive
data descriptor. Type
EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in
EFI_MANAGED_NETWORK_PROTOCOL.Transmit().
@retval EFI_SUCCESS The receive completion token was cached.
@retval EFI_NOT_STARTED This MNP child driver instance has not been
@@ -655,11 +655,11 @@ ON_EXIT:
the asynchronous operation has completed, this function will not signal the
token and EFI_NOT_FOUND is returned.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param Token Pointer to a token that has been issued by
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending
tokens are aborted.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] Token Pointer to a token that has been issued by
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending
tokens are aborted.
@retval EFI_SUCCESS The asynchronous I/O request was aborted and
Token.Event was signaled. When Token is NULL,
@@ -733,7 +733,7 @@ ON_EXIT:
applications that are experiencing packet loss should try calling the Poll()
function more often.
@param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_NOT_STARTED This MNP child driver instance has not been