]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / PxeBaseCodeCallBack.h
index 210f962ed003eb467de9fcfe340b79df89b8e655..ebfe8e1c06d3dbd5d1efd905d72fad2f83ae6a37 100644 (file)
@@ -1,17 +1,17 @@
 /** @file\r
-  It is invoked when the PXE Base Code Protocol is about to transmit, has received, \r
+  It is invoked when the PXE Base Code Protocol is about to transmit, has received,\r
   or is waiting to receive a packet.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
 The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.                                          \r
-    \r
-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
+http://opensource.org/licenses/bsd-license.php.\r
 \r
-  @par Revision Reference:          \r
+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
   This Protocol is introduced in EFI Specification 1.10\r
 \r
 **/\r
@@ -45,7 +45,7 @@ typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  EFI_PXE_BASE_CODE_CALLBACK_
 \r
 ///\r
 /// EFI1.1 Protocol name.\r
-/// \r
+///\r
 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;\r
 \r
 ///\r
@@ -73,10 +73,10 @@ typedef enum {
   EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST\r
 } EFI_PXE_BASE_CODE_CALLBACK_STATUS;\r
 \r
-/**                                                                 \r
+/**\r
   Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r
-  received, or is waiting to receive a packet.                                                 \r
-  \r
+  received, or is waiting to receive a packet.\r
+\r
   This function is invoked when the PXE Base Code Protocol is about to transmit, has received,\r
   or is waiting to receive a packet. Parameters Function and Received specify the type of event.\r
   Parameters PacketLen and Packet specify the packet that generated the event. If these fields\r
@@ -86,22 +86,22 @@ typedef enum {
   the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.\r
   The SetParameters() function must be called after a Callback Protocol is installed to enable the\r
   use of callbacks.\r
-  \r
+\r
   @param  This                  The pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
-  @param  Function              The PXE Base Code Protocol function that is waiting for an event.                                                              \r
+  @param  Function              The PXE Base Code Protocol function that is waiting for an event.\r
   @param  Received              TRUE if the callback is being invoked due to a receive event. FALSE if\r
-                                the callback is being invoked due to a transmit event.                \r
+                                the callback is being invoked due to a transmit event.\r
   @param  PacketLen             The length, in bytes, of Packet. This field will have a value of zero if\r
-                                this is a wait for receive event.                                       \r
+                                this is a wait for receive event.\r
   @param  Packet                If Received is TRUE, a pointer to the packet that was just received;\r
-                                otherwise a pointer to the packet that is about to be transmitted.  \r
-                                  \r
-  @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation    \r
+                                otherwise a pointer to the packet that is about to be transmitted.\r
+\r
+  @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation\r
   @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT    if Function specifies an abort operation\r
-                                   \r
+\r
 **/\r
-typedef \r
-EFI_PXE_BASE_CODE_CALLBACK_STATUS \r
+typedef\r
+EFI_PXE_BASE_CODE_CALLBACK_STATUS\r
 (EFIAPI *EFI_PXE_CALLBACK)(\r
   IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  *This,\r
   IN EFI_PXE_BASE_CODE_FUNCTION           Function,\r
@@ -111,13 +111,13 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS
   );\r
 \r
 ///\r
-/// Protocol that is invoked when the PXE Base Code Protocol is about \r
+/// Protocol that is invoked when the PXE Base Code Protocol is about\r
 /// to transmit, has received, or is waiting to receive a packet.\r
 ///\r
 struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {\r
   ///\r
-  ///  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
-  ///  be backwards compatible. If a future version is not backwards compatible \r
+  ///  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must\r
+  ///  be backwards compatible. If a future version is not backwards compatible\r
   ///  it is not the same GUID.\r
   ///\r
   UINT64            Revision;\r
@@ -126,5 +126,5 @@ struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {
 \r
 extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid;\r
 \r
-#endif \r
+#endif\r
 \r