cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/** @file
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync EFI PCAT ISA ACPI Driver for a Generic PC Platform
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncThis program and the accompanying materials
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncare licensed and made available under the terms and conditions of the BSD License
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncwhich accompanies this distribution. The full text of the license may be found at
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsynchttp://opensource.org/licenses/bsd-license.php
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync**/
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#ifndef _PCAT_ISA_ACPI_H_
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#define _PCAT_ISA_ACPI_H_
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <PiDxe.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <IndustryStandard/Pci.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/DevicePath.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/PciIo.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/IsaIo.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/DriverBinding.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/ComponentName.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/ComponentName2.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Library/UefiLib.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Library/UefiBootServicesTableLib.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Library/BaseMemoryLib.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Library/PcdLib.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#include <Protocol/IsaAcpi.h>
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync// PCAT ISA ACPI device private data structure
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#define PCAT_ISA_ACPI_DEV_SIGNATURE SIGNATURE_32('L','P','C','D')
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsynctypedef struct {
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync UINTN Signature;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync EFI_HANDLE Handle;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync EFI_ISA_ACPI_PROTOCOL IsaAcpi;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync EFI_PCI_IO_PROTOCOL *PciIo;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync} PCAT_ISA_ACPI_DEV;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#define PCAT_ISA_ACPI_DEV_FROM_THIS(a) BASE_CR(a, PCAT_ISA_ACPI_DEV, IsaAcpi)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync// Global Variables
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern EFI_DRIVER_BINDING_PROTOCOL gPcatIsaAcpiDriverBinding;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern EFI_COMPONENT_NAME2_PROTOCOL gPcatIsaAcpiComponentName2;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern EFI_COMPONENT_NAME_PROTOCOL gPcatIsaAcpiComponentName;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync// Prototypes for Driver model protocol interface
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/**
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync ControllerDriver Protocol Method
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param This Driver Binding protocol instance pointer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param Controller Handle of device to test.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param RemainingDevicePath Optional parameter use to pick a specific child
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync device to start.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval EFI_SUCCESS This driver supports this device.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval other This driver does not support this device.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync**/
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFI_STATUS
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFIAPI
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncPcatIsaAcpiDriverBindingSupported (
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_DRIVER_BINDING_PROTOCOL *This,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_HANDLE Controller,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync );
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/**
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync Install EFI_ISA_ACPI_PROTOCOL.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param This Driver Binding protocol instance pointer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param ControllerHandle Handle of device to bind driver to.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param RemainingDevicePath Optional parameter use to pick a specific child
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync device to start.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval EFI_SUCCESS This driver is added to ControllerHandle
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval other This driver does not support this device
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync**/
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFI_STATUS
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFIAPI
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncPcatIsaAcpiDriverBindingStart (
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_DRIVER_BINDING_PROTOCOL *This,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_HANDLE Controller,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync );
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/**
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync Stop this driver on ControllerHandle. Support stopping any child handles
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync created by this driver.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param This Protocol instance pointer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param ControllerHandle Handle of device to stop driver on
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync children is zero stop the entire bus driver.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param ChildHandleBuffer List of Child Handles to Stop.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval EFI_SUCCESS This driver is removed ControllerHandle
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval other This driver was not removed from this device
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync**/
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFI_STATUS
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFIAPI
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncPcatIsaAcpiDriverBindingStop (
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_DRIVER_BINDING_PROTOCOL *This,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_HANDLE Controller,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN UINTN NumberOfChildren,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_HANDLE *ChildHandleBuffer
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync );
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync// Prototypes for the ISA ACPI protocol interface
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync//
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/**
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync Enumerate the ISA devices on the ISA bus
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param This Point to instance of EFI_ISA_ACPI_PROTOCOL
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param Device Point to device ID instance
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval EFI_NOT_FOUND Can not found the next Isa device.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @retval EFI_SUCESS Success retrieve the next Isa device for enumration.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync**/
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFI_STATUS
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncEFIAPI
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncIsaDeviceEnumerate (
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync IN EFI_ISA_ACPI_PROTOCOL *This,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync OUT EFI_ISA_ACPI_DEVICE_ID **Device
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync );
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/**
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync Set ISA device power
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @param This Point to instance of EFI_ISA_ACPI_PROTOCOL
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync @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 (
IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
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 (
IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
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 (
IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
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 (
IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
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 (
IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
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 (
IN EFI_ISA_ACPI_PROTOCOL *This,
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 (
IN EFI_ISA_ACPI_PROTOCOL *This
);
/**
Initialize the ISA device list.
**/
VOID
InitializePcatIsaAcpiDeviceList (
VOID
);
#endif