]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
IntelFrameworkModulePkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / IsaAcpi.h
index 7de35044179aa094bf84f8a3762c2cf37f402c48..4ac2bea127d23e8863a66e90fdafc0190ee1587d 100644 (file)
@@ -2,13 +2,13 @@
   EFI ISA ACPI Protocol is used to enumerate and manage all the ISA controllers on\r
   the platform's ISA Bus.\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
+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
 \r
 **/\r
@@ -71,13 +71,13 @@ typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;
 #define EFI_ISA_ACPI_IO_DECODE_16_BITS                   0x02    ///< ISA controllers uses a 16-bit address decoder for I/O cycles.\r
 \r
 ///\r
-/// EFI ISA ACPI resource type \r
+/// EFI ISA ACPI resource type\r
 ///\r
 typedef enum {\r
   EfiIsaAcpiResourceEndOfList,    ///< Marks the end if a resource list.\r
   EfiIsaAcpiResourceIo,           ///< ISA I/O port resource range.\r
   EfiIsaAcpiResourceMemory,       ///< ISA MMIO resource range.\r
-  EfiIsaAcpiResourceDma,          ///< ISA DMA resource. \r
+  EfiIsaAcpiResourceDma,          ///< ISA DMA resource.\r
   EfiIsaAcpiResourceInterrupt     ///< ISA interrupt resource.\r
 } EFI_ISA_ACPI_RESOURCE_TYPE;\r
 \r
@@ -112,10 +112,10 @@ typedef struct {
 \r
   This service allows all the ISA controllers on an ISA bus to be enumerated.  If\r
   Device is a pointer to a NULL value, then the first ISA controller on the ISA\r
-  bus is returned in Device and EFI_SUCCESS is returned.  If Device is a pointer \r
-  to a value that was returned on a prior call to DeviceEnumerate(), then the next \r
+  bus is returned in Device and EFI_SUCCESS is returned.  If Device is a pointer\r
+  to a value that was returned on a prior call to DeviceEnumerate(), then the next\r
   ISA controller on the ISA bus is returned in Device and EFI_SUCCESS is returned.\r
-  If Device is a pointer to the last ISA controller on the ISA bus, then \r
+  If Device is a pointer to the last ISA controller on the ISA bus, then\r
   EFI_NOT_FOUND is returned.\r
 \r
   @param[in]  This     The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
@@ -135,8 +135,8 @@ EFI_STATUS
 /**\r
   Sets the power state of an ISA controller.\r
 \r
-  This services sets the power state of the ISA controller specified by Device to \r
-  the power state specified by OnOff.  TRUE denotes on, FALSE denotes off. \r
+  This services sets the power state of the ISA controller specified by Device to\r
+  the power state specified by OnOff.  TRUE denotes on, FALSE denotes off.\r
   If the power state is sucessfully set on the ISA Controller, then\r
   EFI_SUCCESS is returned.\r
 \r
@@ -155,11 +155,11 @@ EFI_STATUS
   IN EFI_ISA_ACPI_DEVICE_ID  *Device,\r
   IN BOOLEAN                 OnOff\r
   );\r
-  \r
+\r
 /**\r
   Retrieves the current set of resources associated with an ISA controller.\r
 \r
-  Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently \r
+  Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently\r
   assigned to the ISA controller specified by Device.  These resources\r
   are returned in ResourceList.\r
 \r
@@ -209,7 +209,7 @@ EFI_STATUS
 \r
   @param[in] This           The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
   @param[in] Device         The pointer to an ISA controller named by ACPI HID/UID.\r
-  @param[in] ResourceList   The pointer to a resources list that must be one of the \r
+  @param[in] ResourceList   The pointer to a resources list that must be one of the\r
                             resource lists returned by GetPosResource() for the\r
                             ISA controller specified by Device.\r
 \r
@@ -223,7 +223,7 @@ EFI_STATUS
   IN EFI_ISA_ACPI_PROTOCOL       *This,\r
   IN EFI_ISA_ACPI_DEVICE_ID      *Device,\r
   IN EFI_ISA_ACPI_RESOURCE_LIST  *ResourceList\r
-  );    \r
+  );\r
 \r
 /**\r
   Enables or disables an ISA controller.\r
@@ -243,7 +243,7 @@ EFI_STATUS
   IN EFI_ISA_ACPI_PROTOCOL   *This,\r
   IN EFI_ISA_ACPI_DEVICE_ID  *Device,\r
   IN BOOLEAN                 Enable\r
-  );    \r
+  );\r
 \r
 /**\r
   Initializes an ISA controller, so that it can be used.  This service must be called\r
@@ -261,14 +261,14 @@ EFI_STATUS
 (EFIAPI *EFI_ISA_ACPI_INIT_DEVICE)(\r
   IN EFI_ISA_ACPI_PROTOCOL   *This,\r
   IN EFI_ISA_ACPI_DEVICE_ID  *Device\r
-  );  \r
+  );\r
 \r
 /**\r
-  Initializes all the HW states required for the ISA controllers on the ISA bus \r
+  Initializes all the HW states required for the ISA controllers on the ISA bus\r
   to be enumerated and managed by the rest of the services in this prorotol.\r
   This service must be called before any of the other services in this\r
   protocol will function as expected.\r
\r
+\r
   @param[in] This  The pointer to the EFI_ISA_ACPI_PROTOCOL instance.\r
 \r
   @retval EFI_SUCCESS   Successfully initialized all required hardware states.\r
@@ -283,9 +283,9 @@ EFI_STATUS
 \r
 ///\r
 /// The EFI_ISA_ACPI_PROTOCOL provides the services to enumerate and manage\r
-/// ISA controllers on an ISA bus.  These services include the ability to initialize, \r
-/// enable, disable, and manage the power state of ISA controllers.  It also \r
-/// includes services to query current resources, query possible resources, \r
+/// ISA controllers on an ISA bus.  These services include the ability to initialize,\r
+/// enable, disable, and manage the power state of ISA controllers.  It also\r
+/// includes services to query current resources, query possible resources,\r
 /// and assign resources to an ISA controller.\r
 ///\r
 struct _EFI_ISA_ACPI_PROTOCOL {\r
@@ -300,5 +300,5 @@ struct _EFI_ISA_ACPI_PROTOCOL {
 };\r
 \r
 extern EFI_GUID gEfiIsaAcpiProtocolGuid;\r
-  \r
+\r
 #endif\r