-/*++\r
+/** @file\r
+ ISA ACPI Protocol Implementation\r
\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
+Copyright (c) 2006 - 2010, 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
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
-Module Name:\r
-\r
- IsaAcpi.c\r
- \r
-Abstract: \r
- \r
- ISA ACPI Protocol Implementation\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include "PcatIsaAcpi.h"\r
\r
//\r
// ISA ACPI Protocol Functions\r
//\r
+/**\r
+ Enumerate the ISA devices on the ISA bus.\r
+\r
+ @param Device Point to device ID instance \r
+ @param IsaAcpiDevice On return, point to resource data for Isa device\r
+ @param NextIsaAcpiDevice On return, point to resource data for next Isa device\r
+**/\r
VOID\r
IsaDeviceLookup (\r
IN EFI_ISA_ACPI_DEVICE_ID *Device,\r
OUT EFI_ISA_ACPI_RESOURCE_LIST **IsaAcpiDevice,\r
OUT EFI_ISA_ACPI_RESOURCE_LIST **NextIsaAcpiDevice\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Enumerate the ISA devices on the ISA bus\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
UINTN Index;\r
\r
}\r
}\r
\r
+/**\r
+ Enumerate the ISA devices on the ISA bus\r
+\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+\r
+ @retval EFI_NOT_FOUND Can not found the next Isa device.\r
+ @retval EFI_SUCESS Success retrieve the next Isa device for enumration.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaDeviceEnumerate (\r
IN EFI_ISA_ACPI_PROTOCOL *This,\r
OUT EFI_ISA_ACPI_DEVICE_ID **Device\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Enumerate the ISA devices on the ISA bus\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
EFI_ISA_ACPI_RESOURCE_LIST *IsaAcpiDevice;\r
EFI_ISA_ACPI_RESOURCE_LIST *NextIsaAcpiDevice;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set ISA device power\r
+\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+ @param OnOff TRUE for setting isa device power on,\r
+ FALSE for setting isa device power off\r
+\r
+ @return EFI_SUCCESS Sucess to change power status for isa device.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaDeviceSetPower (\r
IN EFI_ISA_ACPI_DEVICE_ID *Device,\r
IN BOOLEAN OnOff\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Set ISA device power \r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
return EFI_SUCCESS;\r
} \r
\r
+/**\r
+ Get current resource for the specific ISA device.\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+ @param ResourceList On return, point to resources instances for given isa device\r
+\r
+ @retval EFI_NOT_FOUND Can not found the resource instance for given isa device\r
+ @retval EFI_SUCCESS Success to get resource instance for given isa device.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaGetCurrentResource (\r
IN EFI_ISA_ACPI_DEVICE_ID *Device, \r
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Get current Resource of the specific ISA device\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
IsaDeviceLookup (Device, ResourceList, NULL);\r
if (*ResourceList == NULL) {\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Get possible resource for the specific ISA device.\r
+ \r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+ @param ResourceList On return, point to resources instances for given isa device\r
+\r
+ @retval EFI_SUCCESS Success to get resource instance for given isa device.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaGetPossibleResource (\r
IN EFI_ISA_ACPI_DEVICE_ID *Device, \r
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/ \r
{\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Set resource for the specific ISA device.\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+ @param ResourceList Point to resources instances for given isa device\r
+\r
+ @return EFI_SUCESS Success to set resource.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaSetResource (\r
IN EFI_ISA_ACPI_DEVICE_ID *Device, \r
IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Enable/Disable the specific ISA device.\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+ @param Enable Enable/Disable\r
+\r
+ @return EFI_SUCESS Success to enable/disable.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaEnableDevice (\r
IN EFI_ISA_ACPI_DEVICE_ID *Device,\r
IN BOOLEAN Enable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
return EFI_SUCCESS; \r
}\r
\r
+/**\r
+ Initialize the specific ISA device.\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+ @param Device Point to device ID instance \r
+\r
+ @return EFI_SUCESS Success to initialize.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaInitDevice (\r
IN EFI_ISA_ACPI_PROTOCOL *This,\r
IN EFI_ISA_ACPI_DEVICE_ID *Device\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
return EFI_SUCCESS;\r
}\r
\r
\r
+/**\r
+ Initialize the ISA interface.\r
+\r
+ @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r
+\r
+ @return EFI_SUCESS Success to initialize ISA interface.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IsaInterfaceInit (\r
IN EFI_ISA_ACPI_PROTOCOL *This\r
) \r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
{\r
return EFI_SUCCESS;\r
} \r
projects / mirror_edk2.git / blobdiff