Reviewed-by: Maciej Rabeda <maciej.rab...@intel.com> Thanks! Maciej
-----Original Message----- From: Philippe Mathieu-Daude <phi...@redhat.com> Sent: Tuesday, December 3, 2019 17:15 To: devel@edk2.groups.io Cc: Antoine Coeur <co...@gmx.fr>; Wu, Jiaxin <jiaxin...@intel.com>; Fu, Siyuan <siyuan...@intel.com>; Rabeda, Maciej <maciej.rab...@intel.com>; Philippe Mathieu-Daude <phi...@redhat.com> Subject: [PATCH 45/79] NetworkPkg/MnpDxe: Fix various typos From: Antoine Coeur <co...@gmx.fr> Fix various typos in documentation, comments and debug strings. Cc: Jiaxin Wu <jiaxin...@intel.com> Cc: Siyuan Fu <siyuan...@intel.com> Cc: Maciej Rabeda <maciej.rab...@intel.com> Reviewed-by: Philippe Mathieu-Daude <phi...@redhat.com> Signed-off-by: Philippe Mathieu-Daude <phi...@redhat.com> --- NetworkPkg/MnpDxe/MnpDxe.inf | 2 +- NetworkPkg/MnpDxe/MnpDriver.h | 6 +++--- NetworkPkg/MnpDxe/MnpImpl.h | 14 +++++++------- NetworkPkg/MnpDxe/MnpConfig.c | 14 +++++++------- NetworkPkg/MnpDxe/MnpDriver.c | 10 +++++----- NetworkPkg/MnpDxe/MnpIo.c | 8 ++++---- NetworkPkg/MnpDxe/MnpMain.c | 6 +++--- NetworkPkg/MnpDxe/MnpDxe.uni | 4 ++-- 8 files changed, 32 insertions(+), 32 deletions(-) diff --git a/NetworkPkg/MnpDxe/MnpDxe.inf b/NetworkPkg/MnpDxe/MnpDxe.inf index 7280060dded1..608e52aa51d8 100644 --- a/NetworkPkg/MnpDxe/MnpDxe.inf +++ b/NetworkPkg/MnpDxe/MnpDxe.inf @@ -1,5 +1,5 @@ ## @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, # to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol diff --git a/NetworkPkg/MnpDxe/MnpDriver.h b/NetworkPkg/MnpDxe/MnpDriver.h index 150d21e9ec16..4837cd0534b2 100644 --- a/NetworkPkg/MnpDxe/MnpDriver.h +++ b/NetworkPkg/MnpDxe/MnpDriver.h @@ -1,5 +1,5 @@ /** @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> SPDX-License-Identifier: BSD-2-Clause-Patent @@ -223,7 +223,7 @@ MnpDriverBindingStop ( it is not NULL, then the I/O services are added 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_OUT_OF_RESOURCES There are not enough resources available to create the child. @@ -248,7 +248,7 @@ MnpServiceBindingCreateChild ( instance. @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 is being removed. @retval EFI_INVALID_PARAMETER ChildHandle is NULL. diff --git a/NetworkPkg/MnpDxe/MnpImpl.h b/NetworkPkg/MnpDxe/MnpImpl.h index 7d5424034659..e91408c6c9bd 100644 --- a/NetworkPkg/MnpDxe/MnpImpl.h +++ b/NetworkPkg/MnpDxe/MnpImpl.h @@ -284,7 +284,7 @@ MnpFlushRcvdDataQueue ( @param[in, out] Instance Pointer to the mnp instance context data. @param[in] ConfigData Pointer to the configuration data used to configure - the isntance. + the instance. @retval EFI_SUCCESS The Instance is configured. @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the @@ -361,12 +361,12 @@ MnpBuildTxPacket ( /** Synchronously send out the packet. - This functon 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 + This function places the packet buffer to SNP driver's tansmit queue. + The packet can be considered successfully sent out once SNP accept + the packet, while the packet buffer recycle is deferred for better performance. @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, out] Token Pointer to the token the packet generated from. @@ -404,7 +404,7 @@ MnpInstanceDeliverPacket ( packet. @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 @@ -480,8 +480,8 @@ MnpAllocTxBuf ( @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @retval EFI_SUCCESS Successed to recyclethe transmitted buffer address. - @retval Others Failed to recyclethe transmitted buffer address. + @retval EFI_SUCCESS Successed to recycle the transmitted buffer address. + @retval Others Failed to recycle the transmitted buffer address. **/ EFI_STATUS diff --git a/NetworkPkg/MnpDxe/MnpConfig.c b/NetworkPkg/MnpDxe/MnpConfig.c index 5906ad546fb2..416be0bbb65a 100644 --- a/NetworkPkg/MnpDxe/MnpConfig.c +++ b/NetworkPkg/MnpDxe/MnpConfig.c @@ -707,7 +707,7 @@ MnpCreateServiceData ( // MnpServiceData = AllocateZeroPool (sizeof (MNP_SERVICE_DATA)); if (MnpServiceData == NULL) { - DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to allocate memory for the new Mnp Service Data.\n")); + DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Failed to allocate + memory for the new Mnp Service Data.\n")); return NULL; } @@ -742,7 +742,7 @@ MnpCreateServiceData ( &MnpServiceData->DevicePath ); if (MnpServiceHandle == NULL) { - DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to create child handle.\n")); + DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Failed to create + child handle.\n")); return NULL; } @@ -1325,7 +1325,7 @@ MnpStop ( 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. // return EFI_SUCCESS; @@ -1402,7 +1402,7 @@ MnpFlushRcvdDataQueue ( @param[in, out] Instance Pointer to the mnp instance context data. @param[in] ConfigData Pointer to the configuration data used to configure - the isntance. + the instance. @retval EFI_SUCCESS The Instance is configured. @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the @@ -1605,7 +1605,7 @@ MnpConfigReceiveFilters ( EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; // - // Allocate pool for the mulicast addresses. + // Allocate pool for the multicast addresses. // MCastFilterCnt = MnpDeviceData->GroupAddressCount; 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] 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] HwAddressSize The hardware address size. @@ -1851,7 +1851,7 @@ MnpGroupOp ( if (JoinFlag) { // - // A new gropu address is to be added. + // A new group address is to be added. // GroupAddress = NULL; AddressExist = FALSE; diff --git a/NetworkPkg/MnpDxe/MnpDriver.c b/NetworkPkg/MnpDxe/MnpDriver.c index e99e7c5a6166..e27dcf940b7f 100644 --- a/NetworkPkg/MnpDxe/MnpDriver.c +++ b/NetworkPkg/MnpDxe/MnpDriver.c @@ -110,7 +110,7 @@ MnpDriverBindingSupported ( } // - // Close the openned SNP protocol. + // Close the opened SNP protocol. // gBS->CloseProtocol ( ControllerHandle, @@ -419,7 +419,7 @@ MnpDriverBindingStop ( it is not NULL, then the I/O services are added 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_OUT_OF_RESOURCES There are not enough resources available to create the child. @@ -450,7 +450,7 @@ MnpServiceBindingCreateChild ( // Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA)); if (Instance == NULL) { - DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n")); + DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Failed to + allocate memory for the new instance.\n")); return EFI_OUT_OF_RESOURCES; } @@ -535,7 +535,7 @@ ErrorExit: instance. @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 is being removed. @retval EFI_INVALID_PARAMETER ChildHandle is NULL. @@ -660,7 +660,7 @@ MnpServiceBindingDestroyChild ( @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 + @retval EFI_SUCCESS The driver binding and component name protocols are successfully installed. @retval Others Other errors as indicated. diff --git a/NetworkPkg/MnpDxe/MnpIo.c b/NetworkPkg/MnpDxe/MnpIo.c index 56405d62b5e0..ae4a18fd81ac 100644 --- a/NetworkPkg/MnpDxe/MnpIo.c +++ b/NetworkPkg/MnpDxe/MnpIo.c @@ -190,12 +190,12 @@ MnpBuildTxPacket ( /** Synchronously send out the packet. - This functon 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 + This function places the packet buffer to SNP driver's tansmit queue. + The packet can be considered successfully sent out once SNP accept + the packet, while the packet buffer recycle is deferred for better performance. @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, out] Token Pointer to the token the packet generated from. @@ -422,7 +422,7 @@ MnpDeliverPacket ( packet. @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 diff --git a/NetworkPkg/MnpDxe/MnpMain.c b/NetworkPkg/MnpDxe/MnpMain.c index d96178a1d994..ff7e89de103e 100644 --- a/NetworkPkg/MnpDxe/MnpMain.c +++ b/NetworkPkg/MnpDxe/MnpMain.c @@ -376,8 +376,8 @@ MnpGroups ( if ((!Instance->ConfigData.EnableMulticastReceive) || ((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) { // - // The instance isn't configured to do mulitcast receive. OR - // the passed in MacAddress is not a mutlticast mac address. + // The instance isn't configured to do multicast receive. OR + // the passed in MacAddress is not a multicast mac address. // Status = EFI_INVALID_PARAMETER; 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 (); diff --git a/NetworkPkg/MnpDxe/MnpDxe.uni b/NetworkPkg/MnpDxe/MnpDxe.uni index 04be3cd7fe5a..481e791499fe 100644 --- a/NetworkPkg/MnpDxe/MnpDxe.uni +++ b/NetworkPkg/MnpDxe/MnpDxe.uni @@ -1,5 +1,5 @@ // /** @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, // 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." -- 2.21.0 -------------------------------------------------------------------- Intel Technology Poland sp. z o.o. ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 | Kapital zakladowy 200.000 PLN. Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiekolwiek przegladanie lub rozpowszechnianie jest zabronione. This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). If you are not the intended recipient, please contact the sender and delete all copies; any review or distribution by others is strictly prohibited. -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#52004): https://edk2.groups.io/g/devel/message/52004 Mute This Topic: https://groups.io/mt/67501401/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-