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

NetworkPkg/UefiPxeBcDxe: Fix various typos 

Fix various typos in comments and documentation.
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-53-philmd@redhat.com>
This commit is contained in:
Antoine Coeur 2020-02-07 02:08:05 +01:00 committed by mergify[bot]
parent ff82167537
commit 5add2c5577
11 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
NetworkPkg/UefiPxeBcDxe/PxeBcBoot.c
View File

@ -257,7 +257,7 @@ ON_EXIT:
@retval EFI_ABORTED User cancel operation.
@retval EFI_SUCCESS Select the boot menu success.
@retval EFI_NOT_READY Read the input key from the keybroad has not finish.
@retval EFI_NOT_READY Read the input key from the keyboard has not finish.
**/
EFI_STATUS
@ -970,7 +970,7 @@ PxeBcDiscoverBootFile (
@param[in, out] Private Pointer to PxeBc private data.
@param[out] NewMakeCallback If TRUE, it is a new callback.
Otherwise, it is not new callback.
@retval EFI_SUCCESS PxeBaseCodeCallbackProtocol installed succesfully.
@retval EFI_SUCCESS PxeBaseCodeCallbackProtocol installed successfully.
@retval Others Failed to install PxeBaseCodeCallbackProtocol.
**/

10
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp4.c
View File

@ -78,7 +78,7 @@ PxeBcParseDhcp4Options (
/**
Parse the PXE vender options and extract the information from them.
Parse the PXE vendor options and extract the information from them.
@param[in] Dhcp4Option Pointer to vendor options in buffer.
@param[in] VendorOption Pointer to structure to store information in vendor options.
@ -312,7 +312,7 @@ PxeBcBuildDhcp4Options (
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) OptEnt.Uuid->Guid))) {
//
// Zero the Guid to indicate NOT programable if failed to get system Guid.
// Zero the Guid to indicate NOT programmable if failed to get system Guid.
//
DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));
ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));
@ -1125,7 +1125,7 @@ PxeBcHandleDhcp4Offer (
}
} else {
//
// Othewise, the bootfile name must be included in DhcpOnly offer.
// Otherwise, the bootfile name must be included in DhcpOnly offer.
//
if (Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL) {
Status = EFI_NOT_FOUND;
@ -1275,7 +1275,7 @@ PxeBcDhcp4CallBack (
//
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) Packet->Dhcp4.Header.ClientHwAddr))) {
//
// Zero the Guid to indicate NOT programable if failed to get system Guid.
// Zero the Guid to indicate NOT programmable if failed to get system Guid.
//
DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));
ZeroMem (Packet->Dhcp4.Header.ClientHwAddr, sizeof (EFI_GUID));
@ -1464,7 +1464,7 @@ PxeBcDhcp4Discover (
if (Mode->SendGUID) {
if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID *) Token.Packet->Dhcp4.Header.ClientHwAddr))) {
//
// Zero the Guid to indicate NOT programable if failed to get system Guid.
// Zero the Guid to indicate NOT programmable if failed to get system Guid.
//
DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));
ZeroMem (Token.Packet->Dhcp4.Header.ClientHwAddr, sizeof (EFI_GUID));

2
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp4.h
View File

@ -60,7 +60,7 @@
//
// Dhcp4 and Dhcp6 share this definition, and corresponding
// relatioinship is as follows:
// relationship is as follows:
//
// Dhcp4Discover <> Dhcp6Solicit
// Dhcp4Offer <> Dhcp6Advertise

18
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp6.c
View File

@ -25,7 +25,7 @@ EFI_IPv6_ADDRESS mAllDhcpRelayAndServersAddress = {{0xFF, 2, 0, 0, 0, 0, 0, 0,
@param[in] OptTag The required option tag.
@retval NULL Failed to parse the required option.
@retval Others The postion of the required option in buffer.
@retval Others The position of the required option in buffer.
**/
EFI_DHCP6_PACKET_OPTION *
@ -370,7 +370,7 @@ Exit:
@retval EFI_ABORTED User cancel operation.
@retval EFI_SUCCESS Selected the boot menu successfully.
@retval EFI_NOT_READY Read the input key from the keybroad has not finish.
@retval EFI_NOT_READY Read the input key from the keyboard has not finish.
**/
EFI_STATUS
@ -674,7 +674,7 @@ PxeBcParseDhcp6Packet (
//
// The offer with assigned client address is NOT a proxy offer.
// An ia_na option, embeded with valid ia_addr option and a status_code of success.
// An ia_na option, embedded with valid ia_addr option and a status_code of success.
//
Option = Options[PXEBC_DHCP6_IDX_IA_NA];
if (Option != NULL) {
@ -1431,7 +1431,7 @@ PxeBcHandleDhcp6Offer (
}
} else {
//
// Othewise, the bootfilename must be included in DhcpOnly offer.
// Otherwise, the bootfilename must be included in DhcpOnly offer.
//
ASSERT (Cache6->OptList[PXEBC_DHCP6_IDX_BOOT_FILE_URL] != NULL);
}
@ -1480,7 +1480,7 @@ PxeBcUnregisterIp6Address (
@retval EFI_SUCCESS Found a valid gateway address successfully.
@retval EFI_TIMEOUT The operation is time out.
@retval Other Unexpect error happened.
@retval Other Unexpected error happened.
**/
EFI_STATUS
@ -1594,7 +1594,7 @@ ON_EXIT:
@param[in] Private The pointer to PXEBC_PRIVATE_DATA.
@param[in] Address The pointer to the ready address.
@retval EFI_SUCCESS Registered the address succesfully.
@retval EFI_SUCCESS Registered the address successfully.
@retval Others Failed to register the address.
**/
@ -1774,8 +1774,8 @@ ON_EXIT:
@param[in] Private The pointer to PXEBC_PRIVATE_DATA.
@retval EFI_SUCCESS Switch the IP policy succesfully.
@retval Others Unexpect error happened.
@retval EFI_SUCCESS Switch the IP policy successfully.
@retval Others Unexpected error happened.
**/
EFI_STATUS
@ -1915,7 +1915,7 @@ PxeBcDhcp6CallBack (
Callback = Private->PxeBcCallback;
//
// Callback to user when any traffic ocurred if has.
// Callback to user when any traffic occurred if has.
//
if (Dhcp6Event != Dhcp6SelectAdvertise && Callback != NULL) {
Received = (BOOLEAN) (Dhcp6Event == Dhcp6RcvdAdvertise || Dhcp6Event == Dhcp6RcvdReply);

8
NetworkPkg/UefiPxeBcDxe/PxeBcDhcp6.h
View File

@ -123,7 +123,7 @@ typedef struct {
@retval EFI_ABORTED User canceled the operation.
@retval EFI_SUCCESS Selected the boot menu successfully.
@retval EFI_NOT_READY Read the input key from the keybroad has not finish.
@retval EFI_NOT_READY Read the input key from the keyboard has not finish.
**/
EFI_STATUS
@ -174,7 +174,7 @@ PxeBcParseDhcp6Packet (
@param[in] Private The pointer to the PxeBc private data.
@param[in] Address The pointer to the ready address.
@retval EFI_SUCCESS Registered the address succesfully.
@retval EFI_SUCCESS Registered the address successfully.
@retval Others Failed to register the address.
**/
@ -226,8 +226,8 @@ PxeBcDhcp6Discover (
@param[in] Private The pointer to PXEBC_PRIVATE_DATA.
@retval EFI_SUCCESS Switch the IP policy succesfully.
@retval Others Unexpect error happened.
@retval EFI_SUCCESS Switch the IP policy successfully.
@retval Others Unexpected error happened.
**/
EFI_STATUS

4
NetworkPkg/UefiPxeBcDxe/PxeBcDriver.c
View File

@ -1,5 +1,5 @@
/** @file
Driver Binding functions implementationfor for UefiPxeBc Driver.
Driver Binding functions implementation for UefiPxeBc Driver.
(C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>
@ -1184,7 +1184,7 @@ PxeBcCreateIp6Children (
}
//
// Set IPv6 avaiable flag and set default configure data for
// Set IPv6 available flag and set default configure data for
// Udp6Read and Ip6 instance.
//
Status = PxeBcCheckIpv6Support (ControllerHandle, Private, &Private->Mode.Ipv6Available);

10
NetworkPkg/UefiPxeBcDxe/PxeBcImpl.c
View File

@ -204,7 +204,7 @@ EfiPxeBcStart (
//the active state, If the DHCP4 D.O.R.A started by IP4 auto
//configuration and has not been completed, the Dhcp4 state machine
//will not be in the right state for the PXE to start a new round D.O.R.A.
//so we need to switch it's policy to static.
//so we need to switch its policy to static.
//
Status = PxeBcSetIp4Policy (Private);
if (EFI_ERROR (Status)) {
@ -631,7 +631,7 @@ EfiPxeBcDiscover (
}
if (Index != Info->IpCnt) {
//
// It's invalid if the first server doesn't accecpt any response
// It's invalid if the first server doesn't accept any response
// but any of the other servers does accept any response.
//
Status = EFI_INVALID_PARAMETER;
@ -1410,7 +1410,7 @@ EfiPxeBcUdpRead (
if (IsMatched) {
//
// Copy the rececived packet to user if matched by filter.
// Copy the received packet to user if matched by filter.
//
if (Mode->UsingIpv6) {
Udp6Rx = Udp6Token.Packet.RxData;
@ -1685,7 +1685,7 @@ EfiPxeBcSetIpFilter (
for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {
//
// Join the mutilcast group.
// Join the multicast group.
//
Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);
if (EFI_ERROR (Status)) {
@ -1723,7 +1723,7 @@ EfiPxeBcSetIpFilter (
for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
if (IP6_IS_MULTICAST (&NewFilter->IpList[Index].v6)) {
//
// Join the mutilcast group.
// Join the multicast group.
//
Status = Private->Udp6Read->Groups (Private->Udp6Read, TRUE, &NewFilter->IpList[Index].v6);
if (EFI_ERROR (Status)) {

12
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
View File

@ -106,8 +106,8 @@ PxeBcMtftp6CheckPacket (
@param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Sucessfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp ptions failed.
@retval EFI_SUCCESS Successfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp options failed.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval Others Has not obtained the size of the file.
@ -512,7 +512,7 @@ PxeBcMtftp6ReadDirectory (
@param[in] PacketLen Length of EFI_MTFTP4_PACKET.
@param[in] Packet Pointer to EFI_MTFTP4_PACKET to be checked.
@retval EFI_SUCCESS The current operation succeeeded.
@retval EFI_SUCCESS The current operation succeeded.
@retval EFI_ABORTED Abort the current transfer process.
**/
@ -896,7 +896,7 @@ PxeBcMtftp4WriteFile (
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCES Successfully obtained the data from the file included in the directory.
@retval EFI_SUCCESS Successfully obtained the data from the file included in the directory.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval Others Operation failed.
@ -1037,7 +1037,7 @@ PxeBcTftpGetFileSize (
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer.
@retval EFI_SUCCESS Sucessfully read the data from the special file.
@retval EFI_SUCCESS Successfully read the data from the special file.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval Others Read data from file failed.
@ -1143,7 +1143,7 @@ PxeBcTftpWriteFile (
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicatse whether to use a receive buffer.
@retval EFI_SUCCES Successfully obtained the data from the file included in the directory.
@retval EFI_SUCCESS Successfully obtained the data from the file included in the directory.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval Others Operation failed.

4
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
View File

@ -33,7 +33,7 @@
@param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file.
@retval EFI_NOT_FOUND Parse the tftp ptions failed.
@retval EFI_NOT_FOUND Parse the tftp options failed.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval Others Did not obtain the size of the file.
@ -119,7 +119,7 @@ PxeBcTftpWriteFile (
@param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether with a receive buffer.
@retval EFI_SUCCES Successfully obtained the data from the file included in directory.
@retval EFI_SUCCESS Successfully obtained the data from the file included in directory.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval Others Operation failed.

8
NetworkPkg/UefiPxeBcDxe/PxeBcSupport.c
View File

@ -11,7 +11,7 @@
/**
Flush the previous configration using the new station Ip address.
Flush the previous configuration using the new station Ip address.
@param[in] Private The pointer to the PxeBc private data.
@param[in] StationIp The pointer to the station Ip address.
@ -136,7 +136,7 @@ PxeBcCommonNotify (
@param Mode The pointer to EFI_PXE_BASE_CODE_MODE.
@param Ip4Addr The Ip4 address for resolution.
@param MacAddress The resoluted MAC address if the resolution is successful.
@param MacAddress The resolved MAC address if the resolution is successful.
The value is undefined if the resolution fails.
@retval TRUE Found an matched entry.
@ -1176,7 +1176,7 @@ PxeBcUdp4Read (
Token->Status == EFI_NOT_READY &&
EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) {
//
// Poll the token utill reply/ICMPv6 error message received or timeout.
// Poll the token until reply/ICMPv6 error message received or timeout.
//
Udp4->Poll (Udp4);
if (Token->Status == EFI_ICMP_ERROR ||
@ -1280,7 +1280,7 @@ PxeBcUdp6Read (
Token->Status == EFI_NOT_READY &&
EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) {
//
// Poll the token utill reply/ICMPv6 error message received or timeout.
// Poll the token until reply/ICMPv6 error message received or timeout.
//
Udp6->Poll (Udp6);
if (Token->Status == EFI_ICMP_ERROR ||

16
NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
View File

@ -21,7 +21,7 @@
/**
Flush the previous configration using the new station Ip address.
Flush the previous configuration using the new station Ip address.
@param[in] Private Pointer to PxeBc private data.
@param[in] StationIp Pointer to the station Ip address.
@ -59,7 +59,7 @@ PxeBcCommonNotify (
@param Mode Pointer to EFI_PXE_BASE_CODE_MODE.
@param Ip4Addr The Ip4 address for resolution.
@param MacAddress The resoluted MAC address if the resolution is successful.
@param MacAddress The resolved MAC address if the resolution is successful.
The value is undefined if resolution fails.
@retval TRUE Found a matched entry.
@ -156,7 +156,7 @@ PxeBcConfigUdp4Write (
@param[in] StationIp Pointer to the station address.
@param[in, out] SrcPort Pointer to the source port.
@retval EFI_SUCCESS Successfuly configured this instance.
@retval EFI_SUCCESS Successfully configured this instance.
@retval Others Failed to configure this instance.
**/
@ -234,7 +234,7 @@ PxeBcUdp6Write (
@param[in] Session Pointer to the current UDPv4 session.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.
@retval TRUE Succesfully passed the Ip filter.
@retval TRUE Successfully passed the Ip filter.
@retval FALSE Failed to pass the Ip filter.
**/
@ -254,7 +254,7 @@ PxeBcCheckByIpFilter (
@param[in, out] DestIp Pointer to the dest Ip address.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.
@retval TRUE Succesfully passed the IPv4 filter.
@retval TRUE Successfully passed the IPv4 filter.
@retval FALSE Failed to pass the IPv4 filter.
**/
@ -275,7 +275,7 @@ PxeBcCheckByDestIp (
@param[in, out] DestPort Pointer to the destination port.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.
@retval TRUE Succesfully passed the IPv4 filter.
@retval TRUE Successfully passed the IPv4 filter.
@retval FALSE Failed to pass the IPv4 filter.
**/
@ -296,7 +296,7 @@ PxeBcCheckByDestPort (
@param[in, out] SrcIp Pointer to the source Ip address.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.
@retval TRUE Succesfully passed the IPv4 filter.
@retval TRUE Successfully passed the IPv4 filter.
@retval FALSE Failed to pass the IPv4 filter.
**/
@ -317,7 +317,7 @@ PxeBcFilterBySrcIp (
@param[in, out] SrcPort Pointer to the source port.
@param[in] OpFlags Operation flag for UdpRead/UdpWrite.
@retval TRUE Succesfully passed the IPv4 filter.
@retval TRUE Successfully passed the IPv4 filter.
@retval FALSE Failed to pass the IPv4 filter.
**/