]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Ftp4.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / Ftp4.h
index 536b3f36352598f07cb3b0288873c3e58a6ee663..860353de2cbb65a5f0e2c2f917806fceaf254b17 100644 (file)
@@ -1,13 +1,13 @@
 /** @file\r
   EFI FTPv4 (File Transfer Protocol version 4) Protocol Definition\r
-  The EFI FTPv4 Protocol is used to locate communication devices that are \r
+  The EFI FTPv4 Protocol is used to locate communication devices that are\r
   supported by an EFI FTPv4 Protocol driver and to create and destroy instances\r
   of the EFI FTPv4 Protocol child protocol driver that can use the underlying\r
   communication device.\r
   The definitions in this file are defined in UEFI Specification 2.3, which have\r
   not been verified by one implementation yet.\r
 \r
-  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -16,7 +16,7 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  @par Revision Reference:          \r
+  @par Revision Reference:\r
   This Protocol is introduced in UEFI Specification 2.2\r
 \r
 **/\r
@@ -41,103 +41,103 @@ typedef struct _EFI_FTP4_PROTOCOL EFI_FTP4_PROTOCOL;
 /// EFI_FTP4_CONNECTION_TOKEN\r
 ///\r
 typedef struct {\r
-  /// \r
-  /// The Event to signal after the connection is established and Status field is updated \r
-  /// by the EFI FTP v4 Protocol driver. The type of Event must be \r
-  /// EVENT_NOTIFY_SIGNAL, and its Task Priority Level (TPL) must be lower than or \r
-  /// equal to TPL_CALLBACK. If it is set to NULL, this function will not return  until the \r
+  ///\r
+  /// The Event to signal after the connection is established and Status field is updated\r
+  /// by the EFI FTP v4 Protocol driver. The type of Event must be\r
+  /// EVENT_NOTIFY_SIGNAL, and its Task Priority Level (TPL) must be lower than or\r
+  /// equal to TPL_CALLBACK. If it is set to NULL, this function will not return  until the\r
   /// function completes.\r
-  /// \r
-  EFI_EVENT                            Event; \r
+  ///\r
+  EFI_EVENT                            Event;\r
   ///\r
   /// The variable to receive the result of the completed operation.\r
   /// EFI_SUCCESS:              The FTP connection is established successfully\r
-  /// EFI_ACCESS_DENIED:        The FTP server denied the access the user's request to access it. \r
-  /// EFI_CONNECTION_RESET:     The connect fails because the connection is reset either by instance \r
+  /// EFI_ACCESS_DENIED:        The FTP server denied the access the user's request to access it.\r
+  /// EFI_CONNECTION_RESET:     The connect fails because the connection is reset either by instance\r
   ///                           itself or communication peer.\r
-  /// EFI_TIMEOUT:              The connection establishment timer expired and no more specific \r
+  /// EFI_TIMEOUT:              The connection establishment timer expired and no more specific\r
   ///                           information is available.\r
-  /// EFI_NETWORK_UNREACHABLE:  The active open fails because an ICMP network unreachable error is \r
-  ///                           received. \r
-  /// EFI_HOST_UNREACHABLE:     The active open fails because an ICMP host unreachable error is \r
-  ///                           received. \r
-  /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable error is \r
+  /// EFI_NETWORK_UNREACHABLE:  The active open fails because an ICMP network unreachable error is\r
+  ///                           received.\r
+  /// EFI_HOST_UNREACHABLE:     The active open fails because an ICMP host unreachable error is\r
+  ///                           received.\r
+  /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable error is\r
   ///                           received.\r
-  /// EFI_PORT_UNREACHABLE:     The connection establishment timer times out and an ICMP port \r
+  /// EFI_PORT_UNREACHABLE:     The connection establishment timer times out and an ICMP port\r
   ///                           unreachable error is received.\r
-  /// EFI_ICMP_ERROR:           The connection establishment timer timeout and some other ICMP \r
+  /// EFI_ICMP_ERROR:           The connection establishment timer timeout and some other ICMP\r
   ///                           error is received.\r
   /// EFI_DEVICE_ERROR:         An unexpected system or network error occurred.\r
-  /// \r
+  ///\r
   EFI_STATUS                           Status;\r
 } EFI_FTP4_CONNECTION_TOKEN;\r
 \r
 ///\r
-/// EFI_FTP4_CONFIG_DATA \r
+/// EFI_FTP4_CONFIG_DATA\r
 ///\r
 typedef struct {\r
-  /// \r
-  /// Pointer to a ASCII string that contains user name. The caller is \r
+  ///\r
+  /// Pointer to a ASCII string that contains user name. The caller is\r
   /// responsible for freeing Username after GetModeData() is called.\r
-  /// \r
+  ///\r
   UINT8                                *Username;\r
-  /// \r
-  /// Pointer to a ASCII string that contains password. The caller is \r
+  ///\r
+  /// Pointer to a ASCII string that contains password. The caller is\r
   /// responsible for freeing Password after GetModeData() is called.\r
-  /// \r
+  ///\r
   UINT8                                *Password;\r
-  /// \r
-  /// Set it to TRUE to initiate an active data connection. Set it to \r
+  ///\r
+  /// Set it to TRUE to initiate an active data connection. Set it to\r
   /// FALSE to initiate a passive data connection.\r
-  /// \r
+  ///\r
   BOOLEAN                              Active;\r
-  /// \r
+  ///\r
   /// Boolean value indicating if default network settting used.\r
-  /// \r
+  ///\r
   BOOLEAN                              UseDefaultSetting;\r
-  /// \r
+  ///\r
   /// IP address of station if UseDefaultSetting is FALSE.\r
-  /// \r
+  ///\r
   EFI_IPv4_ADDRESS                     StationIp;\r
-  /// \r
+  ///\r
   /// Subnet mask of station if UseDefaultSetting is FALSE.\r
-  /// \r
+  ///\r
   EFI_IPv4_ADDRESS                     SubnetMask;\r
-  /// \r
+  ///\r
   /// IP address of gateway if UseDefaultSetting is FALSE.\r
-  /// \r
+  ///\r
   EFI_IPv4_ADDRESS                     GatewayIp;\r
-  /// \r
+  ///\r
   /// IP address of FTPv4 server.\r
-  /// \r
+  ///\r
   EFI_IPv4_ADDRESS                     ServerIp;\r
-  /// \r
-  /// FTPv4 server port number of control connection, and the default \r
+  ///\r
+  /// FTPv4 server port number of control connection, and the default\r
   /// value is 21 as convention.\r
-  /// \r
+  ///\r
   UINT16                               ServerPort;\r
-  /// \r
-  /// FTPv4 server port number of data connection. If it is zero, use \r
-  /// (ServerPort - 1) by convention. \r
-  /// \r
+  ///\r
+  /// FTPv4 server port number of data connection. If it is zero, use\r
+  /// (ServerPort - 1) by convention.\r
+  ///\r
   UINT16                               AltDataPort;\r
-  /// \r
-  /// A byte indicate the representation type. The right 4 bit is used for \r
+  ///\r
+  /// A byte indicate the representation type. The right 4 bit is used for\r
   /// first parameter, the left 4 bit is use for second parameter\r
   /// - For the first parameter, 0x0 = image, 0x1 = EBCDIC, 0x2 = ASCII, 0x3 = local\r
-  /// - For the second parameter, 0x0 = Non-print, 0x1 = Telnet format effectors, 0x2 = \r
+  /// - For the second parameter, 0x0 = Non-print, 0x1 = Telnet format effectors, 0x2 =\r
   ///   Carriage Control.\r
   /// - If it is a local type, the second parameter is the local byte byte size.\r
   /// - If it is a image type, the second parameter is undefined.\r
-  /// \r
+  ///\r
   UINT8                                RepType;\r
-  /// \r
+  ///\r
   /// Defines the file structure in FTP used. 0x00 = file, 0x01 = record, 0x02 = page.\r
-  /// \r
+  ///\r
   UINT8                                FileStruct;\r
-  /// \r
+  ///\r
   /// Defines the transifer mode used in FTP. 0x00 = stream, 0x01 = Block, 0x02 = Compressed.\r
-  /// \r
+  ///\r
   UINT8                                TransMode;\r
 } EFI_FTP4_CONFIG_DATA;\r
 \r
@@ -149,9 +149,9 @@ typedef struct _EFI_FTP4_COMMAND_TOKEN EFI_FTP4_COMMAND_TOKEN;
   If it is receiving function that leads to inbound data, the callback function\r
   is called when data buffer is full. Then, old data in the data buffer should be\r
   flushed and new data is stored from the beginning of data buffer.\r
-  If it is a transmit function that lead to outbound data and the size of \r
-  Data in daata buffer has been transmitted, this callback function is called to \r
-  supply additional data to be transmitted. \r
+  If it is a transmit function that lead to outbound data and the size of\r
+  Data in daata buffer has been transmitted, this callback function is called to\r
+  supply additional data to be transmitted.\r
 \r
   @param[in] This                Pointer to the EFI_FTP4_PROTOCOL instance.\r
   @param[in] Token               Pointer to the token structure to provide the parameters that\r
@@ -160,8 +160,8 @@ typedef struct _EFI_FTP4_COMMAND_TOKEN EFI_FTP4_COMMAND_TOKEN;
 \r
 **/\r
 typedef\r
-EFI_STATUS \r
-(EFIAPI *EFI_FTP4_DATA_CALLBACK)( \r
+EFI_STATUS\r
+(EFIAPI *EFI_FTP4_DATA_CALLBACK)(\r
   IN EFI_FTP4_PROTOCOL           *This,\r
   IN EFI_FTP4_COMMAND_TOKEN      *Token\r
   );\r
@@ -170,57 +170,57 @@ EFI_STATUS
 /// EFI_FTP4_COMMAND_TOKEN\r
 ///\r
 struct _EFI_FTP4_COMMAND_TOKEN {\r
-  /// \r
-  /// The Event to signal after request is finished and Status field \r
-  /// is updated by the EFI FTP v4 Protocol driver. The type of Event \r
-  /// must be EVT_NOTIFY_SIGNAL, and its Task Priority Level \r
-  /// (TPL) must be lower than or equal to TPL_CALLBACK. If it is \r
-  /// set to NULL, related function must wait until the function \r
+  ///\r
+  /// The Event to signal after request is finished and Status field\r
+  /// is updated by the EFI FTP v4 Protocol driver. The type of Event\r
+  /// must be EVT_NOTIFY_SIGNAL, and its Task Priority Level\r
+  /// (TPL) must be lower than or equal to TPL_CALLBACK. If it is\r
+  /// set to NULL, related function must wait until the function\r
   /// completes.\r
-  /// \r
-  EFI_EVENT                             Event; \r
-  /// \r
-  /// Pointer to a null-terminated ASCII name string. \r
-  /// \r
+  ///\r
+  EFI_EVENT                             Event;\r
+  ///\r
+  /// Pointer to a null-terminated ASCII name string.\r
+  ///\r
   UINT8                                 *Pathname;\r
-  /// \r
+  ///\r
   /// The size of data buffer in bytes.\r
-  /// \r
-  UINT64                                DataBufferSize;        \r
-  /// \r
-  /// Pointer to the data buffer. Data downloaded from FTP server \r
+  ///\r
+  UINT64                                DataBufferSize;\r
+  ///\r
+  /// Pointer to the data buffer. Data downloaded from FTP server\r
   /// through connection is downloaded here.\r
-  /// \r
+  ///\r
   VOID                                  *DataBuffer;\r
-  /// \r
-  /// Pointer to a callback function. If it is receiving function that leads \r
-  /// to inbound data, the callback function is called when databuffer is \r
-  /// full. Then, old data in the data buffer should be flushed and new \r
-  /// data is stored from the beginning of data buffer. If it is a transmit \r
-  /// function that lead to outbound data and DataBufferSize of \r
-  /// Data in DataBuffer has been transmitted, this callback \r
-  /// function is called to supply additional data to be transmitted. The \r
-  /// size of additional data to be transmitted is indicated in \r
-  /// DataBufferSize, again. If there is no data remained, \r
+  ///\r
+  /// Pointer to a callback function. If it is receiving function that leads\r
+  /// to inbound data, the callback function is called when databuffer is\r
+  /// full. Then, old data in the data buffer should be flushed and new\r
+  /// data is stored from the beginning of data buffer. If it is a transmit\r
+  /// function that lead to outbound data and DataBufferSize of\r
+  /// Data in DataBuffer has been transmitted, this callback\r
+  /// function is called to supply additional data to be transmitted. The\r
+  /// size of additional data to be transmitted is indicated in\r
+  /// DataBufferSize, again. If there is no data remained,\r
   /// DataBufferSize should be set to 0.\r
-  /// \r
+  ///\r
   EFI_FTP4_DATA_CALLBACK                DataCallback;\r
-  /// \r
+  ///\r
   /// Pointer to the parameter for DataCallback.\r
-  /// \r
+  ///\r
   VOID                                  *Context;\r
-  /// \r
+  ///\r
   /// The variable to receive the result of the completed operation.\r
   /// EFI_SUCCESS:              The FTP command is completed successfully.\r
   /// EFI_ACCESS_DENIED:        The FTP server denied the access to the requested file.\r
   /// EFI_CONNECTION_RESET:     The connect fails because the connection is reset either\r
   ///                           by instance itself or communication peer.\r
-  /// EFI_TIMEOUT:              The connection establishment timer expired and no more \r
+  /// EFI_TIMEOUT:              The connection establishment timer expired and no more\r
   ///                           specific information is available.\r
   /// EFI_NETWORK_UNREACHABLE:  The active open fails because an ICMP network unreachable\r
-  ///                           error is received. \r
+  ///                           error is received.\r
   /// EFI_HOST_UNREACHABLE:     The active open fails because an ICMP host unreachable\r
-  ///                           error is received. \r
+  ///                           error is received.\r
   /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable\r
   ///                           error is received.\r
   /// EFI_PORT_UNREACHABLE:     The connection establishment timer times out and an ICMP port\r
@@ -236,14 +236,14 @@ struct _EFI_FTP4_COMMAND_TOKEN {
   Gets the current operational settings.\r
 \r
   The GetModeData() function reads the current operational settings of this\r
-  EFI FTPv4 Protocol driver instance. EFI_FTP4_CONFIG_DATA  is defined in the \r
+  EFI FTPv4 Protocol driver instance. EFI_FTP4_CONFIG_DATA  is defined in the\r
   EFI_FTP4_PROTOCOL.Configure.\r
 \r
   @param[in]  This               Pointer to the EFI_FTP4_PROTOCOL instance.\r
-  @param[out] ModeData           Pointer to storage for the EFI FTPv4 Protocol driver \r
+  @param[out] ModeData           Pointer to storage for the EFI FTPv4 Protocol driver\r
                                  mode data. The string buffers for Username and Password\r
                                  in EFI_FTP4_CONFIG_DATA are allocated by the function,\r
-                                 and the caller should take the responsibility to free the \r
+                                 and the caller should take the responsibility to free the\r
                                  buffer later.\r
 \r
   @retval EFI_SUCCESS            This function is called successfully.\r
@@ -255,8 +255,8 @@ struct _EFI_FTP4_COMMAND_TOKEN {
   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.\r
 \r
 **/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
 (EFIAPI *EFI_FTP4_GET_MODE_DATA)(\r
   IN EFI_FTP4_PROTOCOL        *This,\r
   OUT EFI_FTP4_CONFIG_DATA    *ModeData\r
@@ -266,7 +266,7 @@ EFI_STATUS
   Disconnecting a FTP connection gracefully.\r
 \r
   The Connect() function will initiate a connection request to the remote FTP server\r
-  with the corresponding connection token. If this function returns EFI_SUCCESS, the \r
+  with the corresponding connection token. If this function returns EFI_SUCCESS, the\r
   connection sequence is initiated successfully.  If the connection succeeds or faild\r
   due to any error, the Token->Event will be signaled and Token->Status will be updated\r
   accordingly.\r
@@ -280,7 +280,7 @@ EFI_STATUS
                                  - Token is NULL.\r
                                  - Token->Event is NULL.\r
   @retval EFI_NOT_STARTED        The EFI FTPv4 Protocol driver has not been started.\r
-  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP, \r
+  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
   @retval EFI_OUT_OF_RESOURCES   Could not allocate enough resource to finish the operation.\r
   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.\r
@@ -297,7 +297,7 @@ EFI_STATUS
   Disconnecting a FTP connection gracefully.\r
 \r
   The Close() function will initiate a close request to the remote FTP server with the\r
-  corresponding connection token. If this function returns EFI_SUCCESS, the control \r
+  corresponding connection token. If this function returns EFI_SUCCESS, the control\r
   connection with the remote FTP server is closed.\r
 \r
   @param[in] This                Pointer to the EFI_FTP4_PROTOCOL instance.\r
@@ -309,7 +309,7 @@ EFI_STATUS
                                  - Token is NULL.\r
                                  - Token->Event is NULL.\r
   @retval EFI_NOT_STARTED        The EFI FTPv4 Protocol driver has not been started.\r
-  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP, \r
+  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
   @retval EFI_OUT_OF_RESOURCES   Could not allocate enough resource to finish the operation.\r
   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.\r
@@ -325,14 +325,14 @@ EFI_STATUS
 /**\r
   Sets or clears the operational parameters for the FTP child driver.\r
 \r
-  The Configure() function will configure the connected FTP session with the \r
+  The Configure() function will configure the connected FTP session with the\r
   configuration setting specified in  FtpConfigData. The configuration data can\r
   be reset by calling Configure() with FtpConfigData set to NULL.\r
 \r
   @param[in] This                Pointer to the EFI_FTP4_PROTOCOL instance.\r
-  @param[in] FtpConfigData       Pointer to configuration data that will be assigned to \r
+  @param[in] FtpConfigData       Pointer to configuration data that will be assigned to\r
                                  the FTP child driver instance. If NULL, the FTP child\r
-                                 driver instance is reset to startup defaults and all \r
+                                 driver instance is reset to startup defaults and all\r
                                  pending transmit and receive requests are flushed.\r
 \r
   @retval EFI_SUCCESS            The FTPv4 driver was configured successfully.\r
@@ -342,13 +342,13 @@ EFI_STATUS
                                  - FtpConfigData.FileStruct is invalid.\r
                                  - FtpConfigData.TransMode is invalid.\r
                                  - IP address in FtpConfigData is invalid.\r
-  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP, \r
+  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
   @retval EFI_UNSUPPORTED        One or more of the configuration parameters are not supported\r
-                                 by this implementation. \r
-  @retval EFI_OUT_OF_RESOURCES   The EFI FTPv4 Protocol driver instance data could not be \r
+                                 by this implementation.\r
+  @retval EFI_OUT_OF_RESOURCES   The EFI FTPv4 Protocol driver instance data could not be\r
                                  allocated.\r
-  @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred. The EFI FTPv4 \r
+  @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred. The EFI FTPv4\r
                                  Protocol driver instance is not configured.\r
 \r
 **/\r
@@ -361,15 +361,15 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Downloads a file from an FTPv4 server. \r
+  Downloads a file from an FTPv4 server.\r
 \r
   The ReadFile() function is used to initialize and start an FTPv4 download process\r
   and optionally wait for completion. When the download operation completes, whether\r
-  successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol \r
+  successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol\r
   driver and then Token.Event is signaled (if it is not NULL).\r
 \r
   Data will be downloaded from the FTPv4 server into Token.DataBuffer. If the file size\r
-  is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for \r
+  is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for\r
   processing data and then new data will be placed at the beginning of Token.DataBuffer.\r
 \r
   @param[in] This                Pointer to the EFI_FTP4_PROTOCOL instance.\r
@@ -384,29 +384,29 @@ EFI_STATUS
                                  - Token. DataBuffer is NULL.\r
                                  - Token. DataBufferSize is 0.\r
   @retval EFI_NOT_STARTED        The EFI FTPv4 Protocol driver has not been started.\r
-  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP, \r
+  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
   @retval EFI_OUT_OF_RESOURCES   Required system resources could not be allocated.\r
   @retval EFI_DEVICE_ERROR       An unexpected network error or system error occurred.\r
 \r
 **/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
 (EFIAPI *EFI_FTP4_READ_FILE)(\r
   IN EFI_FTP4_PROTOCOL         *This,\r
   IN EFI_FTP4_COMMAND_TOKEN    *Token\r
   );\r
 \r
 /**\r
-  Uploads a file from an FTPv4 server. \r
+  Uploads a file from an FTPv4 server.\r
 \r
   The WriteFile() function is used to initialize and start an FTPv4 upload process and\r
   optionally wait for completion. When the upload operation completes, whether successfully\r
   or not, the Token.Status field is updated by the EFI FTPv4 Protocol driver and then\r
   Token.Event is signaled (if it is not NULL). Data to be  uploaded to server is stored\r
-  into Token.DataBuffer. Token.DataBufferSize is the number bytes to be transferred. \r
+  into Token.DataBuffer. Token.DataBufferSize is the number bytes to be transferred.\r
   If the file size is larger than Token.DataBufferSize, Token.DataCallback will be called\r
-  to allow for processing data and then new data will be placed at the beginning of \r
+  to allow for processing data and then new data will be placed at the beginning of\r
   Token.DataBuffer. Token.DataBufferSize is updated to reflect the actual number of bytes\r
   to be transferred. Token.DataBufferSize is set to 0 by the call back to indicate the\r
   completion of data transfer.\r
@@ -424,30 +424,30 @@ EFI_STATUS
                                  - Token. DataBuffer is NULL.\r
                                  - Token. DataBufferSize is 0.\r
   @retval EFI_NOT_STARTED        The EFI FTPv4 Protocol driver has not been started.\r
-  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP, \r
+  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
   @retval EFI_OUT_OF_RESOURCES   Required system resources could not be allocated.\r
   @retval EFI_DEVICE_ERROR       An unexpected network error or system error occurred.\r
 \r
 **/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
 (EFIAPI *EFI_FTP4_WRITE_FILE)(\r
   IN EFI_FTP4_PROTOCOL         *This,\r
   IN EFI_FTP4_COMMAND_TOKEN    *Token\r
   );\r
 \r
 /**\r
-  Download a data file "directory" from a FTPv4 server. May be unsupported in some EFI \r
+  Download a data file "directory" from a FTPv4 server. May be unsupported in some EFI\r
   implementations.\r
 \r
   The ReadDirectory() function is used to return a list of files on the FTPv4 server that\r
   logically (or operationally) related to Token.Pathname, and optionally wait for completion.\r
-  When the download operation completes, whether successfully or not, the Token.Status field \r
+  When the download operation completes, whether successfully or not, the Token.Status field\r
   is updated by the EFI FTPv4 Protocol driver and then Token.Event is signaled (if it is not\r
   NULL). Data will be downloaded from the FTPv4 server into Token.DataBuffer. If the file size\r
   is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for processing\r
-  data and then new data will be placed at the beginning of Token.DataBuffer. \r
+  data and then new data will be placed at the beginning of Token.DataBuffer.\r
 \r
   @param[in] This                Pointer to the EFI_FTP4_PROTOCOL instance.\r
   @param[in] Token               Pointer to the token structure to provide the parameters that\r
@@ -461,7 +461,7 @@ EFI_STATUS
                                  - Token. DataBuffer is NULL.\r
                                  - Token. DataBufferSize is 0.\r
   @retval EFI_NOT_STARTED        The EFI FTPv4 Protocol driver has not been started.\r
-  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP, \r
+  @retval EFI_NO_MAPPING         When using a default address, configuration (DHCP, BOOTP,\r
                                  RARP, etc.) is not finished yet.\r
   @retval EFI_OUT_OF_RESOURCES   Required system resources could not be allocated.\r
   @retval EFI_DEVICE_ERROR       An unexpected network error or system error occurred.\r
@@ -475,15 +475,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Polls for incoming data packets and processes outgoing data packets. \r
+  Polls for incoming data packets and processes outgoing data packets.\r
 \r
   The Poll() function can be used by network drivers and applications to increase the\r
   rate that data packets are moved between the communications device and the transmit\r
   and receive queues. In some systems, the periodic timer event in the managed network\r
-  driver may not poll the underlying communications device fast enough to transmit \r
+  driver may not poll the underlying communications device fast enough to transmit\r
   and/or receive all data packets without missing incoming packets or dropping outgoing\r
   packets. Drivers and applications that are experiencing packet loss should try calling\r
-  the Poll() function more often. \r
+  the Poll() function more often.\r
 \r
   @param[in] This                Pointer to the EFI_FTP4_PROTOCOL instance.\r
 \r
@@ -502,8 +502,8 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// EFI_FTP4_PROTOCOL \r
-/// provides basic services for client-side FTP (File Transfer Protocol) \r
+/// EFI_FTP4_PROTOCOL\r
+/// provides basic services for client-side FTP (File Transfer Protocol)\r
 /// operations.\r
 ///\r
 struct _EFI_FTP4_PROTOCOL {\r