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

NetworkPkg/MnpDxe: Fix various typos

Browse Source 
Fix various typos in documentation, comments and debug strings.

Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-44-philmd@redhat.com>
[lersek@redhat.com: replace EFI_D_xxx w/ DEBUG_xxx to shut up PatchCheck]
This commit is contained in:
Antoine Coeur 2020-02-07 02:07:56 +01:00 committed by mergify[bot]
parent 6deb4baa1f
commit 5feb1fbd44
8 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
NetworkPkg/MnpDxe/MnpConfig.c
View File

@ -707,7 +707,7 @@ MnpCreateServiceData (
// //
MnpServiceData = AllocateZeroPool (sizeof (MNP_SERVICE_DATA)); MnpServiceData = AllocateZeroPool (sizeof (MNP_SERVICE_DATA));
if (MnpServiceData == NULL) { if (MnpServiceData == NULL) {
DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to allocate memory for the new Mnp Service Data.\n")); DEBUG ((DEBUG_ERROR, "MnpCreateServiceData: Failed to allocate memory for the new Mnp Service Data.\n"));
return NULL; return NULL;
} }
@ -742,7 +742,7 @@ MnpCreateServiceData (
&MnpServiceData->DevicePath &MnpServiceData->DevicePath
); );
if (MnpServiceHandle == NULL) { if (MnpServiceHandle == NULL) {
DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to create child handle.\n")); DEBUG ((DEBUG_ERROR, "MnpCreateServiceData: Failed to create child handle.\n"));
return NULL; return NULL;
} }
@ -1325,7 +1325,7 @@ MnpStop (
if (MnpDeviceData->ConfiguredChildrenNumber > 0) { if (MnpDeviceData->ConfiguredChildrenNumber > 0) {
// //
// If there are other configured chilren, return and keep the timers and // If there are other configured children, return and keep the timers and
// simple network unchanged. // simple network unchanged.
// //
return EFI_SUCCESS; return EFI_SUCCESS;
@ -1402,7 +1402,7 @@ MnpFlushRcvdDataQueue (
@param[in, out] Instance Pointer to the mnp instance context data. @param[in, out] Instance Pointer to the mnp instance context data.
@param[in] ConfigData Pointer to the configuration data used to configure @param[in] ConfigData Pointer to the configuration data used to configure
the isntance. the instance.
@retval EFI_SUCCESS The Instance is configured. @retval EFI_SUCCESS The Instance is configured.
@retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the
@ -1605,7 +1605,7 @@ MnpConfigReceiveFilters (
EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST;
// //
// Allocate pool for the mulicast addresses. // Allocate pool for the multicast addresses.
// //
MCastFilterCnt = MnpDeviceData->GroupAddressCount; MCastFilterCnt = MnpDeviceData->GroupAddressCount;
MCastFilter = AllocatePool (sizeof (EFI_MAC_ADDRESS) * MCastFilterCnt); MCastFilter = AllocatePool (sizeof (EFI_MAC_ADDRESS) * MCastFilterCnt);
@ -1696,7 +1696,7 @@ MnpConfigReceiveFilters (
@param[in, out] Instance Pointer to the mnp instance context data. @param[in, out] Instance Pointer to the mnp instance context data.
@param[in, out] CtrlBlk Pointer to the group address control block. @param[in, out] CtrlBlk Pointer to the group address control block.
@param[in, out] GroupAddress Pointer to the group adress. @param[in, out] GroupAddress Pointer to the group address.
@param[in] MacAddress Pointer to the mac address. @param[in] MacAddress Pointer to the mac address.
@param[in] HwAddressSize The hardware address size. @param[in] HwAddressSize The hardware address size.
@ -1851,7 +1851,7 @@ MnpGroupOp (
if (JoinFlag) { if (JoinFlag) {
// //
// A new gropu address is to be added. // A new group address is to be added.
// //
GroupAddress = NULL; GroupAddress = NULL;
AddressExist = FALSE; AddressExist = FALSE;

10
NetworkPkg/MnpDxe/MnpDriver.c
View File

@ -110,7 +110,7 @@ MnpDriverBindingSupported (
} }
// //
// Close the openned SNP protocol. // Close the opened SNP protocol.
// //
gBS->CloseProtocol ( gBS->CloseProtocol (
ControllerHandle, ControllerHandle,
@ -419,7 +419,7 @@ MnpDriverBindingStop (
it is not NULL, then the I/O services are added it is not NULL, then the I/O services are added
to the existing child handle. to the existing child handle.
@retval EFI_SUCCES The protocol was added to ChildHandle. @retval EFI_SUCCESS The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to @retval EFI_OUT_OF_RESOURCES There are not enough resources available to
create the child. create the child.
@ -450,7 +450,7 @@ MnpServiceBindingCreateChild (
// //
Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA)); Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA));
if (Instance == NULL) { if (Instance == NULL) {
DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n")); DEBUG ((DEBUG_ERROR, "MnpServiceBindingCreateChild: Failed to allocate memory for the new instance.\n"));
return EFI_OUT_OF_RESOURCES; return EFI_OUT_OF_RESOURCES;
} }
@ -535,7 +535,7 @@ ErrorExit:
instance. instance.
@param[in] ChildHandle Handle of the child to destroy. @param[in] ChildHandle Handle of the child to destroy.
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCESS The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that
is being removed. is being removed.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@ -660,7 +660,7 @@ MnpServiceBindingDestroyChild (
@param[in] ImageHandle The image handle of the driver. @param[in] ImageHandle The image handle of the driver.
@param[in] SystemTable The system table. @param[in] SystemTable The system table.
@retval EFI_SUCCES The driver binding and component name protocols are @retval EFI_SUCCESS The driver binding and component name protocols are
successfully installed. successfully installed.
@retval Others Other errors as indicated. @retval Others Other errors as indicated.

6
NetworkPkg/MnpDxe/MnpDriver.h
View File

@ -1,5 +1,5 @@
/** @file /** @file
Declaration of strctures and functions for MnpDxe driver. Declaration of structures and functions for MnpDxe driver.
Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR> Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent SPDX-License-Identifier: BSD-2-Clause-Patent
@ -223,7 +223,7 @@ MnpDriverBindingStop (
it is not NULL, then the I/O services are added it is not NULL, then the I/O services are added
to the existing child handle. to the existing child handle.
@retval EFI_SUCCES The protocol was added to ChildHandle. @retval EFI_SUCCESS The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to @retval EFI_OUT_OF_RESOURCES There are not enough resources available to
create the child. create the child.
@ -248,7 +248,7 @@ MnpServiceBindingCreateChild (
instance. instance.
@param[in] ChildHandle Handle of the child to destroy. @param[in] ChildHandle Handle of the child to destroy.
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCESS The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that
is being removed. is being removed.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is NULL.

2
NetworkPkg/MnpDxe/MnpDxe.inf
View File

@ -1,5 +1,5 @@
## @file ## @file
# This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol. # This module produces EFI MNP Protocol, EFI MNP Service Binding Protocol and EFI VLAN Protocol.
# #
# This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol, # This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol,
# to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol # to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol

4
NetworkPkg/MnpDxe/MnpDxe.uni
View File

@ -1,5 +1,5 @@
// /** @file // /** @file
// This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol. // This module produces EFI MNP Protocol, EFI MNP Service Binding Protocol and EFI VLAN Protocol.
// //
// This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol, // This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol,
// to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol // to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol
@ -12,7 +12,7 @@
// **/ // **/
#string STR_MODULE_ABSTRACT #language en-US "Produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol" #string STR_MODULE_ABSTRACT #language en-US "Produces EFI MNP Protocol, EFI MNP Service Binding Protocol and EFI VLAN Protocol"
#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol to provide manageability interface for VLAN configuration." #string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol to provide manageability interface for VLAN configuration."

14
NetworkPkg/MnpDxe/MnpImpl.h
View File

@ -284,7 +284,7 @@ MnpFlushRcvdDataQueue (
@param[in, out] Instance Pointer to the mnp instance context data. @param[in, out] Instance Pointer to the mnp instance context data.
@param[in] ConfigData Pointer to the configuration data used to configure @param[in] ConfigData Pointer to the configuration data used to configure
the isntance. the instance.
@retval EFI_SUCCESS The Instance is configured. @retval EFI_SUCCESS The Instance is configured.
@retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the
@ -361,12 +361,12 @@ MnpBuildTxPacket (
/** /**
Synchronously send out the packet. Synchronously send out the packet.
This functon places the packet buffer to SNP driver's tansmit queue. The packet This function places the packet buffer to SNP driver's tansmit queue. The packet
can be considered successfully sent out once SNP acccetp the packet, while the can be considered successfully sent out once SNP accept the packet, while the
packet buffer recycle is deferred for better performance. packet buffer recycle is deferred for better performance.
@param[in] MnpServiceData Pointer to the mnp service context data. @param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] Packet Pointer to the pakcet buffer. @param[in] Packet Pointer to the packet buffer.
@param[in] Length The length of the packet. @param[in] Length The length of the packet.
@param[in, out] Token Pointer to the token the packet generated from. @param[in, out] Token Pointer to the token the packet generated from.
@ -404,7 +404,7 @@ MnpInstanceDeliverPacket (
packet. packet.
@param[in] Event The event this notify function registered to. @param[in] Event The event this notify function registered to.
@param[in] Context Pointer to the context data registerd to the Event. @param[in] Context Pointer to the context data registered to the Event.
**/ **/
VOID VOID
@ -480,8 +480,8 @@ MnpAllocTxBuf (
@param[in, out] MnpDeviceData Pointer to the mnp device context data. @param[in, out] MnpDeviceData Pointer to the mnp device context data.
@retval EFI_SUCCESS Successed to recyclethe transmitted buffer address. @retval EFI_SUCCESS Successed to recycle the transmitted buffer address.
@retval Others Failed to recyclethe transmitted buffer address. @retval Others Failed to recycle the transmitted buffer address.
**/ **/
EFI_STATUS EFI_STATUS

8
NetworkPkg/MnpDxe/MnpIo.c
View File

@ -190,12 +190,12 @@ MnpBuildTxPacket (
/** /**
Synchronously send out the packet. Synchronously send out the packet.
This functon places the packet buffer to SNP driver's tansmit queue. The packet This function places the packet buffer to SNP driver's tansmit queue. The packet
can be considered successfully sent out once SNP acccetp the packet, while the can be considered successfully sent out once SNP accept the packet, while the
packet buffer recycle is deferred for better performance. packet buffer recycle is deferred for better performance.
@param[in] MnpServiceData Pointer to the mnp service context data. @param[in] MnpServiceData Pointer to the mnp service context data.
@param[in] Packet Pointer to the pakcet buffer. @param[in] Packet Pointer to the packet buffer.
@param[in] Length The length of the packet. @param[in] Length The length of the packet.
@param[in, out] Token Pointer to the token the packet generated from. @param[in, out] Token Pointer to the token the packet generated from.
@ -422,7 +422,7 @@ MnpDeliverPacket (
packet. packet.
@param[in] Event The event this notify function registered to. @param[in] Event The event this notify function registered to.
@param[in] Context Pointer to the context data registerd to the Event. @param[in] Context Pointer to the context data registered to the Event.
**/ **/
VOID VOID

6
NetworkPkg/MnpDxe/MnpMain.c
View File

@ -376,8 +376,8 @@ MnpGroups (
if ((!Instance->ConfigData.EnableMulticastReceive) || if ((!Instance->ConfigData.EnableMulticastReceive) ||
((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) { ((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) {
// //
// The instance isn't configured to do mulitcast receive. OR // The instance isn't configured to do multicast receive. OR
// the passed in MacAddress is not a mutlticast mac address. // the passed in MacAddress is not a multicast mac address.
// //
Status = EFI_INVALID_PARAMETER; Status = EFI_INVALID_PARAMETER;
goto ON_EXIT; goto ON_EXIT;
@ -713,7 +713,7 @@ MnpCancel (
} }
// //
// Dispatch the DPC queued by the NotifyFunction of the cancled token's events. // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
// //
DispatchDpc (); DispatchDpc ();