mirror of https://github.com/acidanthera/audk.git
NetworkPkg/Mtftp6Dxe: Fix various typos
Fix various typos in documentation, comments and 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-46-philmd@redhat.com>
This commit is contained in:
Antoine Coeur
mergify[bot]
parent
68ddad3f60
commit
f6c8bbbe92
|
|
@ -538,7 +538,7 @@ Mtftp6DriverBindingStop (
|
|||
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_SUCCESS The protocol was added to ChildHandle.
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
|
||||
@retval Others The child handle was not created.
|
||||
|
||||
|
|
@ -637,7 +637,7 @@ ON_ERROR:
|
|||
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL 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 Child handle is NULL.
|
||||
@retval Others The child handle was not destroyed
|
||||
|
|
|
|||
|
|
@ -108,7 +108,7 @@ Mtftp6DriverBindingStop (
|
|||
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_SUCCESS The protocol was added to ChildHandle.
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
|
||||
@retval Others The child handle was not created.
|
||||
|
||||
|
|
@ -130,7 +130,7 @@ Mtftp6ServiceBindingCreateChild (
|
|||
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL 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 Child handle is NULL.
|
||||
@retval Others The child handle was not destroyed
|
||||
|
|
|
|||
|
|
@ -109,11 +109,11 @@ EfiMtftp6GetModeData (
|
|||
- This is NULL.
|
||||
- MtftpConfigData.StationIp is neither zero nor one
|
||||
of the configured IP addresses in the underlying IPv6 driver.
|
||||
- MtftpCofigData.ServerIp is not a valid IPv6 unicast address.
|
||||
- MtftpConfigData.ServerIp is not a valid IPv6 unicast address.
|
||||
Note: It does not match the UEFI 2.3 Specification.
|
||||
@retval EFI_ACCESS_DENIED - The configuration could not be changed at this time because there
|
||||
is some MTFTP background operation in progress.
|
||||
- MtftpCofigData.LocalPort is already in use.
|
||||
- MtftpConfigData.LocalPort is already in use.
|
||||
Note: It does not match the UEFI 2.3 Specification.
|
||||
@retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
|
||||
address for this instance, but no source address was available for use.
|
||||
|
|
|
|||
|
|
@ -179,11 +179,11 @@ EfiMtftp6GetModeData (
|
|||
- This is NULL.
|
||||
- MtftpConfigData.StationIp is neither zero nor one
|
||||
of the configured IP addresses in the underlying IPv6 driver.
|
||||
- MtftpCofigData.ServerIp is not a valid IPv6 unicast address.
|
||||
- MtftpConfigData.ServerIp is not a valid IPv6 unicast address.
|
||||
Note: It does not match the UEFI 2.3 Specification.
|
||||
@retval EFI_ACCESS_DENIED - The configuration could not be changed at this time because there
|
||||
is some MTFTP background operation in progress.
|
||||
- MtftpCofigData.LocalPort is already in use.
|
||||
- MtftpConfigData.LocalPort is already in use.
|
||||
Note: It does not match the UEFI 2.3 Specification.
|
||||
@retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
|
||||
address for this instance, but no source address was available for use.
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Mtftp6ParseMcastOption (
|
|||
CHAR8 *TempStr;
|
||||
|
||||
//
|
||||
// The multicast option is formated like "addr,port,mc"
|
||||
// The multicast option is formatted like "addr,port,mc"
|
||||
// The server can also omit the ip and port, use ",,1"
|
||||
//
|
||||
if (*Str == ',') {
|
||||
|
|
@ -135,7 +135,7 @@ Mtftp6ParseMcastOption (
|
|||
|
||||
|
||||
/**
|
||||
Parse the MTFTP6 extesion options.
|
||||
Parse the MTFTP6 extension options.
|
||||
|
||||
@param[in] Options The pointer to the extension options list.
|
||||
@param[in] Count The num of the extension options.
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ Mtftp6ParseMcastOption (
|
|||
|
||||
|
||||
/**
|
||||
Parse the MTFTP6 extesion options.
|
||||
Parse the MTFTP6 extension options.
|
||||
|
||||
@param[in] Options The pointer to the extension options list.
|
||||
@param[in] Count The num of the extension options.
|
||||
|
|
|
|||
|
|
@ -742,7 +742,7 @@ Mtftp6RrqInput (
|
|||
//
|
||||
// For the subsequent exchange of requests, reconfigure the udpio as
|
||||
// (serverip, serverport, localip, localport).
|
||||
// Ususally, the client set serverport as 0 to receive and reset it
|
||||
// Usually, the client set serverport as 0 to receive and reset it
|
||||
// once the first packet arrives to send ack.
|
||||
//
|
||||
Instance->ServerDataPort = UdpEpt->RemotePort;
|
||||
|
|
@ -851,7 +851,7 @@ Mtftp6RrqInput (
|
|||
|
||||
default:
|
||||
//
|
||||
// Drop and return eror if received error message.
|
||||
// Drop and return error if received error message.
|
||||
//
|
||||
Status = EFI_TFTP_ERROR;
|
||||
break;
|
||||
|
|
@ -896,7 +896,7 @@ ON_EXIT:
|
|||
|
||||
/**
|
||||
Start the Mtftp6 instance to download. It first initializes some
|
||||
of the internal states, then builds and sends an RRQ reqeuest packet.
|
||||
of the internal states, then builds and sends an RRQ request packet.
|
||||
Finally, it starts receive for the downloading.
|
||||
|
||||
@param[in] Instance The pointer to the Mtftp6 instance.
|
||||
|
|
@ -917,7 +917,7 @@ Mtftp6RrqStart (
|
|||
//
|
||||
// The valid block number range are [1, 0xffff]. For example:
|
||||
// the client sends an RRQ request to the server, the server
|
||||
// transfers the DATA1 block. If option negoitation is ongoing,
|
||||
// transfers the DATA1 block. If option negotiation is ongoing,
|
||||
// the server will send back an OACK, then client will send ACK0.
|
||||
//
|
||||
Status = Mtftp6InitBlockRange (&Instance->BlkList, 1, 0xffff);
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ Mtftp6AllocateRange (
|
|||
Initialize the block range for either RRQ or WRQ. RRQ and WRQ have
|
||||
different requirements for Start and End. For example, during startup,
|
||||
WRQ initializes its whole valid block range to [0, 0xffff]. This
|
||||
is bacause the server will send an ACK0 to inform the user to start the
|
||||
is because the server will send an ACK0 to inform the user to start the
|
||||
upload. When the client receives an ACK0, it will remove 0 from the range,
|
||||
get the next block number, which is 1, then upload the BLOCK1. For RRQ
|
||||
without option negotiation, the server will directly send the BLOCK1
|
||||
|
|
@ -197,7 +197,7 @@ Mtftp6RemoveBlockNum (
|
|||
// 3. (Start < Num) && (End >= Num):
|
||||
// if End == Num, only need to decrease the End by one because
|
||||
// we have (Start < Num) && (Num == End), so (Start <= End - 1).
|
||||
// if (End > Num), the hold is splited into two holes, with
|
||||
// if (End > Num), the hold is split into two holes, with
|
||||
// [Start, Num - 1] and [Num + 1, End].
|
||||
//
|
||||
if (Range->Start > Num) {
|
||||
|
|
@ -991,7 +991,7 @@ Mtftp6OperationClean (
|
|||
write file, and read directory.
|
||||
|
||||
@param[in] This The MTFTP session.
|
||||
@param[in] Token The token than encapsues the user's request.
|
||||
@param[in] Token The token than encapsules the user's request.
|
||||
@param[in] OpCode The operation to perform.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Some of the parameters are invalid.
|
||||
|
|
@ -1227,7 +1227,7 @@ Mtftp6OnTimerTick (
|
|||
}
|
||||
|
||||
//
|
||||
// Retransmit the packet if haven't reach the maxmium retry count,
|
||||
// Retransmit the packet if haven't reach the maximum retry count,
|
||||
// otherwise exit the transfer.
|
||||
//
|
||||
if (Instance->CurRetry < Instance->MaxRetry) {
|
||||
|
|
|
|||
|
|
@ -334,7 +334,7 @@ Mtftp6RrqInput (
|
|||
|
||||
/**
|
||||
Start the Mtftp6 instance to download. It first initializes some
|
||||
of the internal states then builds and sends an RRQ reqeuest packet.
|
||||
of the internal states then builds and sends an RRQ request packet.
|
||||
Finally, it starts receive for the downloading.
|
||||
|
||||
@param[in] Instance The pointer to the Mtftp6 instance.
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ Mtftp6WrqHandleAck (
|
|||
|
||||
if (Expected < 0) {
|
||||
//
|
||||
// The block range is empty. It may either because the the last
|
||||
// The block range is empty. It may either because the last
|
||||
// block has been ACKed, or the sequence number just looped back,
|
||||
// that is, there is more than 0xffff blocks.
|
||||
//
|
||||
|
|
|
|||
Loading…
Reference in New Issue