Add comments for Include header files

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / IsaAcpi.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
index 573d5a4a60ba4c8b0e4c0c238264a38f3469a8fa..e3ad06f60f923e1ec14e9750827ddb3590020c88 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
@@ -1,7 +1,7 @@
 /** @file\r
-  EFI ISA Acpi Protocol\r
+  ISA Acpi Protocol is used to operate and communicate with ISA device.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2006 - 2009, 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
@@ -56,11 +56,7 @@ typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL;
 \r
 //\r
 // Resource List definition: \r
-// at first, the resource was defined as below\r
-// but in the future, it will be defined again that follow ACPI spec: ACPI resource type\r
-// so that, in this driver, we can interpret the ACPI table and get the ISA device information. \r
 //\r
- \r
 typedef enum {\r
   EfiIsaAcpiResourceEndOfList,\r
   EfiIsaAcpiResourceIo,\r
@@ -86,16 +82,33 @@ typedef struct {
   EFI_ISA_ACPI_RESOURCE       *ResourceItem;\r
 } EFI_ISA_ACPI_RESOURCE_LIST;\r
 \r
-//\r
-// Prototypes for the ISA ACPI Protocol\r
-//\r
+/**\r
+  Enumerate the ISA devices on the ISA bus.\r
+\r
+  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             Found next ISA device.\r
+\r
+  @retval EFI_NOT_FOUND      No device found.\r
+  @retval EFI_SUCCESS        Success get the next ISA device.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_DEVICE_ENUMERATE) (\r
   IN EFI_ISA_ACPI_PROTOCOL           *This,\r
   OUT EFI_ISA_ACPI_DEVICE_ID         **Device\r
   );\r
-  \r
+\r
+/**\r
+  Set ISA device power.\r
+\r
+  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             ISA device.\r
+  @param  OnOff              Whether to set power on or off.\r
+\r
+  @retval EFI_SUCCESS        Successfully set ISA device.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_SET_DEVICE_POWER) (\r
@@ -104,6 +117,17 @@ EFI_STATUS
   IN BOOLEAN                         OnOff\r
   );\r
   \r
+/**\r
+  Get current Resource of the specific ISA device.\r
+\r
+  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             ISA device.\r
+  @param  ResourceList       Returned resource list.\r
+\r
+  @retval EFI_SUCCESS        Successfully get current resource.\r
+  @retval EFI_NOT_FOUND      No resource found.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_GET_CUR_RESOURCE) (\r
@@ -112,6 +136,16 @@ EFI_STATUS
   OUT EFI_ISA_ACPI_RESOURCE_LIST     **ResourceList\r
   );\r
 \r
+/**\r
+  Get possible resource for the specific ISA device.\r
+\r
+  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             ISA device.\r
+  @param  ResourceList       Returned resource list.\r
+\r
+  @retval EFI_SUCCESS        Successfully get possible resource.\r
+  @retval EFI_NOT_FOUND      No resource found.\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_GET_POS_RESOURCE) (\r
@@ -119,7 +153,17 @@ EFI_STATUS
   IN EFI_ISA_ACPI_DEVICE_ID          *Device,\r
   OUT EFI_ISA_ACPI_RESOURCE_LIST     **ResourceList\r
   );\r
-  \r
+\r
+/**\r
+  Set resources for the specific ISA device.\r
+\r
+  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             ISA device.\r
+  @param  ResourceList       Resource list will be set.\r
+\r
+  @retval EFI_SUCCESS        Successfully set resource.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_SET_RESOURCE) (\r
@@ -128,6 +172,16 @@ EFI_STATUS
   IN EFI_ISA_ACPI_RESOURCE_LIST      *ResourceList\r
   );    \r
 \r
+/**\r
+  Enable or disable ISA device.\r
+\r
+  @param  This               Pointer of EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             ISA device.\r
+  @param  Enable             Enable/Disable.\r
+\r
+  @retval EFI_SUCCESS        Successfully perform this action.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_ENABLE_DEVICE) (\r
@@ -136,6 +190,15 @@ EFI_STATUS
   IN BOOLEAN                         Enable\r
   );    \r
 \r
+/**\r
+  Init ISA device.\r
+\r
+  @param  This               Pointer to EFI_ISA_ACPI_PROTOCOL.\r
+  @param  Device             ISA device.\r
+\r
+  @retval EFI_SUCCESS        Successfully initialize ISA device.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_INIT_DEVICE) (\r
@@ -143,6 +206,14 @@ EFI_STATUS
   IN EFI_ISA_ACPI_DEVICE_ID          *Device\r
   );  \r
 \r
+/**\r
+  ISA Interface Init.\r
+\r
+  @param  This               Pointer of EFI_ISA_ACPI_PROTOCOL.\r
+\r
+  @retval EFI_SUCCESS        Successfully initialize ISA interface.\r
+\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISA_ACPI_INTERFACE_INIT) (\r