tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NetworkPkg/ArpDxe: Fix various typos 

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@linux.intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-31-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:43 +01:00 committed by mergify[bot]
parent 8d774c745c
commit 8f628f7820
5 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
NetworkPkg/ArpDxe/ArpDriver.c
View File

@ -195,7 +195,7 @@ ArpCleanService (
if (ArpService->PeriodicTimer != NULL) { if (ArpService->PeriodicTimer != NULL) {
// //
// Cancle and close the PeriodicTimer. // Cancel and close the PeriodicTimer.
// //
gBS->SetTimer (ArpService->PeriodicTimer, TimerCancel, 0); gBS->SetTimer (ArpService->PeriodicTimer, TimerCancel, 0);
gBS->CloseEvent (ArpService->PeriodicTimer); gBS->CloseEvent (ArpService->PeriodicTimer);
@ -203,7 +203,7 @@ ArpCleanService (
if (ArpService->RxToken.Event != NULL) { if (ArpService->RxToken.Event != NULL) {
// //
// Cancle the RxToken and close the event in the RxToken. // Cancel the RxToken and close the event in the RxToken.
// //
ArpService->Mnp->Cancel (ArpService->Mnp, NULL); ArpService->Mnp->Cancel (ArpService->Mnp, NULL);
gBS->CloseEvent (ArpService->RxToken.Event); gBS->CloseEvent (ArpService->RxToken.Event);
@ -288,7 +288,7 @@ ArpDestroyChildEntryInHandleBuffer (
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
RemainingDevicePath is already being managed by RemainingDevicePath is already being managed by
a different driver or an application that a different driver or an application that
requires exclusive acces. Currently not implemented. requires exclusive access. Currently not implemented.
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
RemainingDevicePath is not supported by the RemainingDevicePath is not supported by the
driver specified by This. driver specified by This.
@ -363,7 +363,7 @@ ArpDriverBindingSupported (
Currently not implemented. Currently not implemented.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of
resources. resources.
@retval Others The driver failded to start the device. @retval Others The driver failed to start the device.
**/ **/
EFI_STATUS EFI_STATUS
@ -547,7 +547,7 @@ ArpDriverBindingStop (
then a new handle is created. If it is a pointer to an existing 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. UEFI handle, then the protocol is added to the existing UEFI 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 create @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
the child the child
@ -598,7 +598,7 @@ ArpServiceBindingCreateChild (
NULL NULL
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status)); DEBUG ((DEBUG_ERROR, "ArpSBCreateChild: failed to install ARP protocol, %r.\n", Status));
FreePool (Instance); FreePool (Instance);
return Status; return Status;
@ -672,7 +672,7 @@ ERROR:
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy @param 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 @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is
being removed. being removed.
@retval EFI_INVALID_PARAMETER Child handle is NULL. @retval EFI_INVALID_PARAMETER Child handle is NULL.

10
NetworkPkg/ArpDxe/ArpDriver.h
View File

@ -30,7 +30,7 @@ extern EFI_COMPONENT_NAME_PROTOCOL gArpComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2; extern EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2;
// //
// Function prototypes for the Drivr Binding Protocol // Function prototypes for the Driver Binding Protocol
// //
/** /**
Tests to see if this driver supports a given controller. Tests to see if this driver supports a given controller.
@ -55,7 +55,7 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2;
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
RemainingDevicePath is already being managed by RemainingDevicePath is already being managed by
a different driver or an application that a different driver or an application that
requires exclusive acces. Currently not implemented. requires exclusive access. Currently not implemented.
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
RemainingDevicePath is not supported by the RemainingDevicePath is not supported by the
driver specified by This. driver specified by This.
@ -97,7 +97,7 @@ ArpDriverBindingSupported (
Currently not implemented. Currently not implemented.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of
resources. resources.
@retval Others The driver failded to start the device. @retval Others The driver failed to start the device.
**/ **/
EFI_STATUS EFI_STATUS
@ -159,7 +159,7 @@ ArpDriverBindingStop (
then a new handle is created. If it is a pointer to an existing 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. UEFI handle, then the protocol is added to the existing UEFI 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 create @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
the child the child
@ -183,7 +183,7 @@ ArpServiceBindingCreateChild (
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy @param 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 @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is
being removed. being removed.
@retval EFI_INVALID_PARAMETER Child handle is NULL. @retval EFI_INVALID_PARAMETER Child handle is NULL.

16
NetworkPkg/ArpDxe/ArpImpl.c
View File

@ -55,7 +55,7 @@ ArpInitInstance (
/** /**
Process the Arp packets received from Mnp, the procedure conforms to RFC826. Process the Arp packets received from Mnp, the procedure conforms to RFC826.
@param[in] Context Pointer to the context data registerd to the @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -316,7 +316,7 @@ RESTART_RECEIVE:
Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK. Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK.
@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 @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -338,7 +338,7 @@ ArpOnFrameRcvd (
/** /**
Process the already sent arp packets. Process the already sent arp packets.
@param[in] Context Pointer to the context data registerd to the @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -377,7 +377,7 @@ ArpOnFrameSentDpc (
Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK. Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK.
@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 @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -401,7 +401,7 @@ ArpOnFrameSent (
Process the arp cache olding and drive the retrying arp requests. Process the arp cache olding and drive the retrying arp requests.
@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 @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -1008,7 +1008,7 @@ ArpConfigureInstance (
/** /**
Send out an arp frame using the CachEntry and the ArpOpCode. Send out an arp frame using the CacheEntry and the ArpOpCode.
@param[in] Instance Pointer to the instance context data. @param[in] Instance Pointer to the instance context data.
@param[in] CacheEntry Pointer to the configuration data used to @param[in] CacheEntry Pointer to the configuration data used to
@ -1344,7 +1344,7 @@ ArpDeleteCacheEntry (
); );
// //
// Delete the cache entries inthe ResolvedCacheTable. // Delete the cache entries in the ResolvedCacheTable.
// //
Count += ArpDeleteCacheEntryInTable ( Count += ArpDeleteCacheEntryInTable (
&ArpService->ResolvedCacheTable, &ArpService->ResolvedCacheTable,
@ -1466,7 +1466,7 @@ ArpFindCacheEntry (
ArpService = Instance->ArpService; ArpService = Instance->ArpService;
// //
// Init the FounEntries used to hold the found cache entries. // Init the FoundEntries used to hold the found cache entries.
// //
NetMapInit (&FoundEntries); NetMapInit (&FoundEntries);

14
NetworkPkg/ArpDxe/ArpImpl.h
View File

@ -436,7 +436,7 @@ ArpRequest (
If the request is in the internal ARP request queue, the request is aborted If the request is in the internal ARP request queue, the request is aborted
immediately and its ResolvedEvent is signaled. Only an asynchronous address immediately and its ResolvedEvent is signaled. Only an asynchronous address
request needs to be canceled. If TargeSwAddress and ResolveEvent are both request needs to be canceled. If TargetSwAddress and ResolvedEvent are both
NULL, all the pending asynchronous requests that have been issued by This NULL, all the pending asynchronous requests that have been issued by This
instance will be cancelled and their corresponding events will be signaled. instance will be cancelled and their corresponding events will be signaled.
@ -599,7 +599,7 @@ ArpDeleteCacheEntry (
); );
/** /**
Send out an arp frame using the CachEntry and the ArpOpCode. Send out an arp frame using the CacheEntry and the ArpOpCode.
@param[in] Instance Pointer to the instance context data. @param[in] Instance Pointer to the instance context data.
@param[in] CacheEntry Pointer to the configuration data used to @param[in] CacheEntry Pointer to the configuration data used to
@ -636,7 +636,7 @@ ArpInitInstance (
/** /**
Process the Arp packets received from Mnp, the procedure conforms to RFC826. Process the Arp packets received from Mnp, the procedure conforms to RFC826.
@param[in] Context Pointer to the context data registerd to the @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -652,7 +652,7 @@ ArpOnFrameRcvdDpc (
Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK. Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK.
@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 @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -668,7 +668,7 @@ ArpOnFrameRcvd (
/** /**
Process the already sent arp packets. Process the already sent arp packets.
@param[in] Context Pointer to the context data registerd to the @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -684,7 +684,7 @@ ArpOnFrameSentDpc (
Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK. Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK.
@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 @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.
@ -701,7 +701,7 @@ ArpOnFrameSent (
Process the arp cache olding and drive the retrying arp requests. Process the arp cache olding and drive the retrying arp requests.
@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 @param[in] Context Pointer to the context data registered to the
Event. Event.
@return None. @return None.

10
NetworkPkg/ArpDxe/ArpMain.c
View File

@ -175,7 +175,7 @@ ArpAdd (
OldTpl = gBS->RaiseTPL (TPL_CALLBACK); OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
// //
// See whether the entry to add exists. Check the DeinedCacheTable first. // See whether the entry to add exists. Check the DeniedCacheTable first.
// //
CacheEntry = ArpFindDeniedCacheEntry ( CacheEntry = ArpFindDeniedCacheEntry (
ArpService, ArpService,
@ -198,7 +198,7 @@ ArpAdd (
if ((CacheEntry != NULL) && !Overwrite) { if ((CacheEntry != NULL) && !Overwrite) {
// //
// The entry to add exists, if not Overwirte, deny this add request. // The entry to add exists, if not Overwrite, deny this add request.
// //
Status = EFI_ACCESS_DENIED; Status = EFI_ACCESS_DENIED;
goto UNLOCK_EXIT; goto UNLOCK_EXIT;
@ -542,7 +542,7 @@ ArpRequest (
ProtocolAddress.AddressPtr = TargetSwAddress; ProtocolAddress.AddressPtr = TargetSwAddress;
// //
// Initialize the TargetHwAddrss to a zero address. // Initialize the TargetHwAddress to a zero address.
// //
ZeroMem (TargetHwAddress, SnpMode->HwAddressSize); ZeroMem (TargetHwAddress, SnpMode->HwAddressSize);
@ -675,7 +675,7 @@ SIGNAL_USER:
If the request is in the internal ARP request queue, the request is aborted If the request is in the internal ARP request queue, the request is aborted
immediately and its ResolvedEvent is signaled. Only an asynchronous address immediately and its ResolvedEvent is signaled. Only an asynchronous address
request needs to be canceled. If TargeSwAddress and ResolveEvent are both request needs to be canceled. If TargetSwAddress and ResolvedEvent are both
NULL, all the pending asynchronous requests that have been issued by This NULL, all the pending asynchronous requests that have been issued by This
instance will be cancelled and their corresponding events will be signaled. instance will be cancelled and their corresponding events will be signaled.
@ -729,7 +729,7 @@ ArpCancel (
// //
// Dispatch the DPCs queued by the NotifyFunction of the events signaled // Dispatch the DPCs queued by the NotifyFunction of the events signaled
// by ArpCancleRequest. // by ArpCancelRequest.
// //
DispatchDpc (); DispatchDpc ();