Refine the file/function comments to follow doxygen format
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10359 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
@@ -1,7 +1,8 @@
|
||||
/*++
|
||||
/** @file
|
||||
EFI PCAT ISA ACPI Driver for a Generic PC Platform
|
||||
|
||||
Copyright (c) 2006 - 2007, Intel Corporation
|
||||
All rights reserved. This program and the accompanying materials
|
||||
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php
|
||||
@@ -9,18 +10,7 @@ http://opensource.org/licenses/bsd-license.php
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
|
||||
Module Name:
|
||||
|
||||
PcatIsaAcpi.h
|
||||
|
||||
Abstract:
|
||||
|
||||
EFI PCAT ISA ACPI Driver for a Generic PC Platform
|
||||
|
||||
Revision History
|
||||
|
||||
--*/
|
||||
**/
|
||||
|
||||
#ifndef _PCAT_ISA_ACPI_H_
|
||||
#define _PCAT_ISA_ACPI_H_
|
||||
@@ -68,6 +58,17 @@ extern EFI_COMPONENT_NAME_PROTOCOL gPcatIsaAcpiComponentName;
|
||||
//
|
||||
// Prototypes for Driver model protocol interface
|
||||
//
|
||||
/**
|
||||
ControllerDriver Protocol Method
|
||||
|
||||
@param This Driver Binding protocol instance pointer.
|
||||
@param Controller Handle of device to test.
|
||||
@param RemainingDevicePath Optional parameter use to pick a specific child
|
||||
device to start.
|
||||
@retval EFI_SUCCESS This driver supports this device.
|
||||
@retval other This driver does not support this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
PcatIsaAcpiDriverBindingSupported (
|
||||
@@ -76,6 +77,18 @@ PcatIsaAcpiDriverBindingSupported (
|
||||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
|
||||
);
|
||||
|
||||
/**
|
||||
Install EFI_ISA_ACPI_PROTOCOL.
|
||||
|
||||
@param This Driver Binding protocol instance pointer.
|
||||
@param ControllerHandle Handle of device to bind driver to.
|
||||
@param RemainingDevicePath Optional parameter use to pick a specific child
|
||||
device to start.
|
||||
|
||||
@retval EFI_SUCCESS This driver is added to ControllerHandle
|
||||
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
|
||||
@retval other This driver does not support this device
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
PcatIsaAcpiDriverBindingStart (
|
||||
@@ -84,6 +97,20 @@ PcatIsaAcpiDriverBindingStart (
|
||||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
|
||||
);
|
||||
|
||||
/**
|
||||
Stop this driver on ControllerHandle. Support stopping any child handles
|
||||
created by this driver.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param ControllerHandle Handle of device to stop driver on
|
||||
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
|
||||
children is zero stop the entire bus driver.
|
||||
@param ChildHandleBuffer List of Child Handles to Stop.
|
||||
|
||||
@retval EFI_SUCCESS This driver is removed ControllerHandle
|
||||
@retval other This driver was not removed from this device
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
PcatIsaAcpiDriverBindingStop (
|
||||
@@ -96,6 +123,17 @@ PcatIsaAcpiDriverBindingStop (
|
||||
//
|
||||
// Prototypes for the ISA ACPI protocol interface
|
||||
//
|
||||
/**
|
||||
Enumerate the ISA devices on the ISA bus
|
||||
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
|
||||
@retval EFI_NOT_FOUND Can not found the next Isa device.
|
||||
@retval EFI_SUCESS Success retrieve the next Isa device for enumration.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaDeviceEnumerate (
|
||||
@@ -103,6 +141,17 @@ IsaDeviceEnumerate (
|
||||
OUT EFI_ISA_ACPI_DEVICE_ID **Device
|
||||
);
|
||||
|
||||
/**
|
||||
Set ISA device power
|
||||
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
@param OnOff TRUE for setting isa device power on,
|
||||
FALSE for setting isa device power off
|
||||
|
||||
@return EFI_SUCCESS Sucess to change power status for isa device.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaDeviceSetPower (
|
||||
@@ -111,6 +160,16 @@ IsaDeviceSetPower (
|
||||
IN BOOLEAN OnOff
|
||||
);
|
||||
|
||||
/**
|
||||
Get current resource for the specific ISA device.
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
@param ResourceList On return, point to resources instances for given isa device
|
||||
|
||||
@retval EFI_NOT_FOUND Can not found the resource instance for given isa device
|
||||
@retval EFI_SUCCESS Success to get resource instance for given isa device.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaGetCurrentResource (
|
||||
@@ -119,6 +178,15 @@ IsaGetCurrentResource (
|
||||
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList
|
||||
);
|
||||
|
||||
/**
|
||||
Get possible resource for the specific ISA device.
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
@param ResourceList On return, point to resources instances for given isa device
|
||||
|
||||
@retval EFI_SUCCESS Success to get resource instance for given isa device.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaGetPossibleResource (
|
||||
@@ -127,6 +195,16 @@ IsaGetPossibleResource (
|
||||
OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList
|
||||
);
|
||||
|
||||
/**
|
||||
Set resource for the specific ISA device.
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
@param ResourceList Point to resources instances for given isa device
|
||||
|
||||
@return EFI_SUCESS Success to set resource.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaSetResource (
|
||||
@@ -135,6 +213,16 @@ IsaSetResource (
|
||||
IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList
|
||||
);
|
||||
|
||||
/**
|
||||
Enable/Disable the specific ISA device.
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
@param Enable Enable/Disable
|
||||
|
||||
@return EFI_SUCESS Success to enable/disable.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaEnableDevice (
|
||||
@@ -143,6 +231,15 @@ IsaEnableDevice (
|
||||
IN BOOLEAN Enable
|
||||
);
|
||||
|
||||
/**
|
||||
Initialize the specific ISA device.
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
@param Device Point to device ID instance
|
||||
|
||||
@return EFI_SUCESS Success to initialize.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaInitDevice (
|
||||
@@ -150,6 +247,14 @@ IsaInitDevice (
|
||||
IN EFI_ISA_ACPI_DEVICE_ID *Device
|
||||
);
|
||||
|
||||
/**
|
||||
Initialize the ISA interface.
|
||||
|
||||
@param This Point to instance of EFI_ISA_ACPI_PROTOCOL
|
||||
|
||||
@return EFI_SUCESS Success to initialize ISA interface.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IsaInterfaceInit (
|
||||
|
||||
Reference in New Issue
Block a user