IntelFrameworkPkg: Clean up source files

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / LegacyInterrupt.h

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h b/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
index a44c0a536e8e1df210ddb4be983e3ea7c2328c58..f67c1636fb26c9e84a11713119b3be401631be4e 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyInterrupt.h
@@ -1,25 +1,24 @@
 /** @file\r
   This protocol abstracts the PIRQ programming from the generic EFI Compatibility Support Modules (CSMs).\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
-  All rights reserved. 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
-  http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2007 - 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
+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 defined in Framework for EFI Compatibility Support Module spec\r
-  Version 0.96\r
+  This protocol is defined in Framework for the EFI Compatibility Support Module specification.\r
+  Version 0.97.\r
 \r
 **/\r
 \r
 #ifndef _EFI_LEGACY_INTERRUPT_H_\r
 #define _EFI_LEGACY_INTERRUPT_H_\r
 \r
-#include <PiDxe.h>\r
 \r
 #define EFI_LEGACY_INTERRUPT_PROTOCOL_GUID \\r
   { \\r
@@ -31,10 +30,10 @@ typedef struct _EFI_LEGACY_INTERRUPT_PROTOCOL EFI_LEGACY_INTERRUPT_PROTOCOL;
 /**\r
   Get the number of PIRQs this hardware supports.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  NumberPirsq           Number of PIRQs.\r
+  @param  This                  The protocol instance pointer.\r
+  @param  NumberPirsq           The number of PIRQs that are supported.\r
 \r
-  @retval EFI_SUCCESS           Number of PIRQs returned.\r
+  @retval EFI_SUCCESS           The number of PIRQs was returned successfully.\r
 \r
 **/\r
 typedef\r
@@ -47,12 +46,12 @@ EFI_STATUS
 /**\r
   Gets the PCI location associated with this protocol.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  Bus                   PCI Bus\r
-  @param  Device                PCI Device\r
-  @param  Function              PCI Function\r
+  @param  This                  The Protocol instance pointer.\r
+  @param  Bus                   The PCI Bus.\r
+  @param  Device                The PCI Device.\r
+  @param  Function              The PCI Function.\r
 \r
-  @retval EFI_SUCCESS           Bus/Device/Function returned\r
+  @retval EFI_SUCCESS           The Bus, Device, and Function were returned successfully.\r
 \r
 **/\r
 typedef\r
@@ -67,12 +66,12 @@ EFI_STATUS
 /**\r
   Read the PIRQ register and return the data\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  PirqNumber            PIRQ register to read\r
-  @param  PirqData              Data read\r
+  @param  This                  The protocol instance pointer.\r
+  @param  PirqNumber            The PIRQ register to read.\r
+  @param  PirqData              The data read.\r
 \r
-  @retval EFI_SUCCESS           Data was read\r
-  @retval EFI_INVALID_PARAMETER Invalid PIRQ number\r
+  @retval EFI_SUCCESS           The data was read.\r
+  @retval EFI_INVALID_PARAMETER Invalid PIRQ number.\r
 \r
 **/\r
 typedef\r
@@ -86,12 +85,12 @@ EFI_STATUS
 /**\r
   Write the specified PIRQ register with the given data.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  PirqNumber            PIRQ register to read.\r
-  @param  PirqData              Data written.\r
+  @param  This                  The protocol instance pointer.\r
+  @param  PirqNumber            A PIRQ register to read.\r
+  @param  PirqData              The data to write.\r
 \r
-  @retval EFI_SUCCESS           Table pointer returned\r
-  @retval EFI_INVALID_PARAMETER Invalid PIRQ number\r
+  @retval EFI_SUCCESS           The PIRQ was programmed.\r
+  @retval EFI_INVALID_PARAMETER Invalid PIRQ number.\r
 \r
 **/\r
 typedef\r
@@ -102,27 +101,25 @@ EFI_STATUS
   IN UINT8                                   PirqData\r
   );\r
 \r
-/**\r
-  @par Protocol Description:\r
-  Abstracts the PIRQ programming from the generic EFI Compatibility Support Modules\r
-\r
-  @param GetNumberPirqs\r
-  Gets the number of PIRQs supported.\r
-\r
-  @param GetLocation\r
-  Gets the PCI bus, device, and function that associated with this protocol.\r
-\r
-  @param ReadPirq\r
-  Reads the indicated PIRQ register.\r
-\r
-  @param WritePirq\r
-  Writes to the indicated PIRQ register.\r
-\r
-**/\r
 struct _EFI_LEGACY_INTERRUPT_PROTOCOL {\r
+  ///\r
+  ///   Gets the number of PIRQs supported.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS GetNumberPirqs;\r
+\r
+  ///\r
+  /// Gets the PCI bus, device, and function that is associated with this protocol.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_GET_LOCATION     GetLocation;\r
+\r
+  ///\r
+  /// Reads the indicated PIRQ register.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_READ_PIRQ        ReadPirq;\r
+\r
+  ///\r
+  /// Writes to the indicated PIRQ register.\r
+  ///\r
   EFI_LEGACY_INTERRUPT_WRITE_PIRQ       WritePirq;\r
 };\r
 \r