tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ISA Bus driver code scrub. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8505 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
rsun3 2009-06-10 06:35:16 +00:00
parent 966877cbd3
commit 6fcb2d910a
7 changed files with 624 additions and 738 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/ComponentName.c
View File

@ -1,6 +1,7 @@
/**@file
UEFI Component Name(2) protocol implementation for IsaBus driver.
Copyright (c) 2006 - 2007, Intel Corporation. <BR>
Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. 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
@ -170,11 +171,11 @@ IsaBusComponentNameGetDriverName (
EFI_STATUS
EFIAPI
IsaBusComponentNameGetControllerName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
)
{
return EFI_UNSUPPORTED;

22
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/ComponentName.h
View File

@ -1,6 +1,7 @@
/**@file
Header file for implementation of UEFI Component Name(2) protocol.
Copyright (c) 2006 - 2007, Intel Corporation<BR>
Copyright (c) 2006 - 2009, Intel Corporation<BR>
All rights reserved. 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
@ -11,17 +12,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _EFI_ISA_BUS_COMPONENT_NAME_H
#define _EFI_ISA_BUS_COMPONENT_NAME_H
#ifndef _COMPONENT_NAME_H_
#define _COMPONENT_NAME_H_
#include "InternalIsaBus.h"
extern EFI_COMPONENT_NAME_PROTOCOL gIsaBusComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gIsaBusComponentName2;
//
// EFI Component Name Functions
//
/**
Retrieves a Unicode string that is the user readable name of the driver.
@ -141,12 +139,12 @@ IsaBusComponentNameGetDriverName (
EFI_STATUS
EFIAPI
IsaBusComponentNameGetControllerName (
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
IN EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName
);
#endif

217
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/InternalIsaBus.h
View File

@ -1,7 +1,7 @@
/**@file
The header file for ISA bus driver
Copyright (c) 2006 - 2007, Intel Corporation. <BR>
Copyright (c) 2006 - 2009, Intel Corporation. <BR>
All rights reserved. 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
@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _EFI_ISA_BUS_H
#define _EFI_ISA_BUS_H
#ifndef _INTERNAL_ISA_BUS_H_
#define _INTERNAL_ISA_BUS_H_
#include <PiDxe.h>
@ -40,13 +40,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include "ComponentName.h"
//
// Global Variables
//
extern EFI_DRIVER_BINDING_PROTOCOL gIsaBusControllerDriver;
extern EFI_ISA_IO_PROTOCOL IsaIoInterface;
//
// 8237 DMA registers
//
@ -165,70 +158,92 @@ typedef struct {
// EFI Driver Binding Protocol Interface Functions
//
/**
Tests to see if a controller can be managed by the ISA Bus Driver. If a child device is provided,
it further tests to see if this driver supports creating a handle for the specified child device.
Note that the ISA Bus driver always creates all of its child handles on the first call to Start().
How the Start() function of a driver is implemented can affect how the Supported() function is implemented.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] Controller The handle of the controller to test.
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
@retval EFI_SUCCESS The device is supported by this driver.
@retval EFI_ALREADY_STARTED The device is already being managed by this driver.
@retval EFI_ACCESS_DENIED The device is already being managed by a different driver
or an application that requires exclusive access.
@retval EFI_UNSUPPORTED The device is is not supported by this driver.
**/
EFI_STATUS
EFIAPI
IsaBusControllerDriverSupported (
IN EFI_DRIVER_BINDING_PROTOCOL * This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL
)
);
/**
Start this driver on ControllerHandle.
Note that the ISA Bus driver always creates all of its child handles on the first call to Start().
The Start() function is designed to be invoked from the EFI boot service ConnectController().
As a result, much of the error checking on the parameters to Start() has been moved into this
common boot service. It is legal to call Start() from other locations, but the following calling
restrictions must be followed or the system behavior will not be deterministic.
1. ControllerHandle must be a valid EFI_HANDLE.
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
EFI_DEVICE_PATH_PROTOCOL.
3. Prior to calling Start(), the Supported() function for the driver specified by This must
have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
Routine Description:
This function checks to see if a controller can be managed by the ISA Bus
Driver. This is done by checking to see if the controller supports the
EFI_PCI_IO_PROTOCOL protocol, and then looking at the PCI Configuration
Header to see if the device is a PCI to ISA bridge. The class code of
PCI to ISA bridge: Base class 06h, Sub class 01h Interface 00h
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - The handle of the device to check.
RemainingDevicePath - A pointer to the remaining portion of a device path.
Returns:
EFI_SUCCESS - The device is supported by this driver.
EFI_UNSUPPORTED - The device is not supported by this driver.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] ControllerHandle The handle of the controller to start. This handle
must support a protocol interface that supplies
an I/O abstraction to the driver.
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
This parameter is ignored by device drivers, and is optional for bus drivers.
@retval EFI_SUCCESS The device was started.
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.
Currently not implemented.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval Others The driver failded to start the device.
**/
;
EFI_STATUS
EFIAPI
IsaBusControllerDriverStart (
IN EFI_DRIVER_BINDING_PROTOCOL * This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL
)
);
/**
Stop this driver on ControllerHandle.
The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
As a result, much of the error checking on the parameters to Stop() has been moved
into this common boot service. It is legal to call Stop() from other locations,
but the following calling restrictions must be followed or the system behavior will not be deterministic.
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
same driver's Start() function.
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
EFI_HANDLE. In addition, all of these handles must have been created in this driver's
Start() function, and the Start() function must have called OpenProtocol() on
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] ControllerHandle A handle to the device being stopped. The handle must
support a bus specific I/O protocol for the driver
to use to stop the device.
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
if NumberOfChildren is 0.
Routine Description:
This function tells the ISA Bus Driver to start managing a PCI to ISA
Bridge controller.
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - A handle to the device being started.
RemainingDevicePath - A pointer to the remaining portion of a device path.
Returns:
EFI_SUCCESS - The device was started.
EFI_UNSUPPORTED - The device is not supported.
EFI_DEVICE_ERROR - The device could not be started due to a device error.
EFI_ALREADY_STARTED - The device has already been started.
EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of
resources.
@retval EFI_SUCCESS The device was stopped.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
**/
;
EFI_STATUS
EFIAPI
IsaBusControllerDriverStop (
@ -236,38 +251,26 @@ IsaBusControllerDriverStop (
IN EFI_HANDLE Controller,
IN UINTN NumberOfChildren,
IN EFI_HANDLE * ChildHandleBuffer OPTIONAL
)
/**
Routine Description:
This function tells the ISA Bus Driver to stop managing a PCI to ISA
Bridge controller.
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - A handle to the device being stopped.
NumberOfChindren - The number of child device handles in ChildHandleBuffer.
ChildHandleBuffer - An array of child handles to be freed.
Returns:
EFI_SUCCESS - The device was stopped.
EFI_DEVICE_ERROR - The device could not be stopped due to a device error.
EFI_NOT_STARTED - The device has not been started.
EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of
resources.
**/
;
);
//
// Function Prototypes
//
/**
Create EFI Handle for a ISA device found via ISA ACPI Protocol
@param[in] This The EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] Controller The handle of ISA bus controller(PCI to ISA bridge)
@param[in] PciIo The Pointer to the PCI protocol
@param[in] ParentDevicePath Device path of the ISA bus controller
@param[in] IsaDeviceResourceList The resource list of the ISA device
@param[in] ChildDevicePath The pointer to the child device.
@retval EFI_SUCCESS The handle for the child device was created.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_DEVICE_ERROR The handle for the child device can not be created.
**/
EFI_STATUS
IsaCreateDevice (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
@ -276,53 +279,21 @@ IsaCreateDevice (
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDeviceResourceList,
OUT EFI_DEVICE_PATH_PROTOCOL **ChildDevicePath
)
);
/**
Initializes an ISA I/O Instance
Routine Description:
@param[in] IsaIoDevice The iso device to be initialized.
@param[in] IsaDeviceResourceList The resource list.
Create ISA device found by IsaPnpProtocol
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - The handle of ISA bus controller(PCI to ISA bridge)
PciIo - The Pointer to the PCI protocol
ParentDevicePath - Device path of the ISA bus controller
IsaDeviceResourceList - The resource list of the ISA device
ChildDevicePath - The pointer to the child device.
Returns:
EFI_SUCCESS - Create the child device.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of
resources.
EFI_DEVICE_ERROR - Can not create child device.
@retval None
**/
;
EFI_STATUS
VOID
InitializeIsaIoInstance (
IN ISA_IO_DEVICE *IsaIoDevice,
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDevice
)
/**
Routine Description:
Initializes an ISA I/O Instance
Arguments:
IsaIoDevice - The iso device to be initialized.
IsaDevice - The resource list.
Returns:
EFI_SUCCESS - Initial success.
**/
;
);
#endif

125
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/InternalIsaIo.h
View File

@ -1,7 +1,7 @@
/**@file
The header file for EFI_ISA_IO protocol implementation.
Copyright (c) 2006 - 2007, Intel Corporation.<BR>
Copyright (c) 2006 - 2009, Intel Corporation.<BR>
All rights reserved. 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
@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _EFI_ISA_IO_LOCAL_H
#define _EFI_ISA_IO_LOCAL_H
#ifndef _INTERNAL_ISA_IO_H_
#define _INTERNAL_ISA_IO_H_
#include "InternalIsaBus.h"
@ -23,57 +23,57 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
EFI_STATUS
IsaIoVerifyAccess (
IN ISA_IO_DEVICE *IsaIoDevice,
IN ISA_ACCESS_TYPE Type,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINTN Count,
IN OUT UINT32 *Offset
IN ISA_IO_DEVICE *IsaIoDevice,
IN ISA_ACCESS_TYPE Type,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINTN Count,
IN UINT32 Offset
);
EFI_STATUS
EFIAPI
IsaIoIoRead (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
IN OUT VOID *Buffer
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
OUT VOID *Buffer
);
EFI_STATUS
EFIAPI
IsaIoIoWrite (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
IN OUT VOID *Buffer
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
IN VOID *Buffer
);
EFI_STATUS
EFIAPI
IsaIoMap (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_OPERATION Operation,
IN UINT8 ChannelNumber OPTIONAL,
IN UINT32 ChannelAttributes,
IN VOID *HostAddress,
IN OUT UINTN *NumberOfBytes,
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,
OUT VOID **Mapping
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_OPERATION Operation,
IN UINT8 ChannelNumber OPTIONAL,
IN UINT32 ChannelAttributes,
IN VOID *HostAddress,
IN OUT UINTN *NumberOfBytes,
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,
OUT VOID **Mapping
);
EFI_STATUS
EFIAPI
IsaIoUnmap (
IN EFI_ISA_IO_PROTOCOL *This,
IN VOID *Mapping
IN EFI_ISA_IO_PROTOCOL *This,
IN VOID *Mapping
);
EFI_STATUS
EFIAPI
IsaIoFlush (
IN EFI_ISA_IO_PROTOCOL *This
IN EFI_ISA_IO_PROTOCOL *This
);
EFI_STATUS
@ -83,69 +83,70 @@ ReportErrorStatusCode (
EFI_STATUS
WriteDmaPort (
IN EFI_ISA_IO_PROTOCOL *This,
IN UINT32 AddrOffset,
IN UINT32 PageOffset,
IN UINT32 CountOffset,
IN UINT32 BaseAddress,
IN UINT16 Count
IN EFI_ISA_IO_PROTOCOL *This,
IN UINT32 AddrOffset,
IN UINT32 PageOffset,
IN UINT32 CountOffset,
IN UINT32 BaseAddress,
IN UINT16 Count
);
EFI_STATUS
WritePort (
IN EFI_ISA_IO_PROTOCOL *This,
IN UINT32 Offset,
IN UINT8 Value
IN EFI_ISA_IO_PROTOCOL *This,
IN UINT32 Offset,
IN UINT8 Value
);
EFI_STATUS
EFIAPI
IsaIoMemRead (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
IN OUT VOID *Buffer
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
OUT VOID *Buffer
);
EFI_STATUS
EFIAPI
IsaIoMemWrite (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
IN OUT VOID *Buffer
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 Offset,
IN UINTN Count,
IN VOID *Buffer
);
EFI_STATUS
EFIAPI
IsaIoCopyMem (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 DestOffset,
IN UINT32 SrcOffset,
IN UINTN Count
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ISA_IO_PROTOCOL_WIDTH Width,
IN UINT32 DestOffset,
IN UINT32 SrcOffset,
IN UINTN Count
);
EFI_STATUS
EFIAPI
IsaIoAllocateBuffer (
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ALLOCATE_TYPE Type,
IN EFI_MEMORY_TYPE MemoryType,
IN UINTN Pages,
OUT VOID **HostAddress,
IN UINT64 Attributes
IN EFI_ISA_IO_PROTOCOL *This,
IN EFI_ALLOCATE_TYPE Type,
IN EFI_MEMORY_TYPE MemoryType,
IN UINTN Pages,
OUT VOID **HostAddress,
IN UINT64 Attributes
);
EFI_STATUS
EFIAPI
IsaIoFreeBuffer (
IN EFI_ISA_IO_PROTOCOL *This,
IN UINTN Pages,
IN VOID *HostAddress
IN EFI_ISA_IO_PROTOCOL *This,
IN UINTN Pages,
IN VOID *HostAddress
);
#endif

332
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaBus.c
View File

@ -1,13 +1,12 @@
/**@file
ISA Bus UEFI driver.
Discovers all the ISA Controllers and their resources by using the ISA PnP
Discovers all the ISA Controllers and their resources by using the ISA ACPI
Protocol, produces an instance of the ISA I/O Protocol for every ISA
Controller found, loads and initializes all ISA Device Drivers, matches ISA
Device Drivers with their respective ISA Controllers in a deterministic
manner, and informs a ISA Device Driver when it is to start managing an ISA
Controller.
Controller found. This driver is designed to manage a PCI-to-ISA bridge Device
such as LPC bridge.
Copyright (c) 2006 - 2007, Intel Corporation.<BR>
Copyright (c) 2006 - 2009, Intel Corporation.<BR>
All rights reserved. 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
@ -18,7 +17,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "InternalIsaBus.h"
//
@ -34,14 +32,13 @@ EFI_DRIVER_BINDING_PROTOCOL gIsaBusControllerDriver = {
};
/**
The user Entry Point for module IsaBus. The user code starts with this function.
The main entry point for the ISA Bus driver.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval other Some error occurs when executing this entry point.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
EFI_STATUS
EFIAPI
@ -65,47 +62,44 @@ InitializeIsaBus(
);
ASSERT_EFI_ERROR (Status);
return Status;
}
/**
Tests to see if a controller can be managed by the ISA Bus Driver. If a child device is provided,
it further tests to see if this driver supports creating a handle for the specified child device.
Note that the ISA Bus driver always creates all of its child handles on the first call to Start().
How the Start() function of a driver is implemented can affect how the Supported() function is implemented.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] Controller The handle of the controller to test.
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
@retval EFI_SUCCESS The device is supported by this driver.
@retval EFI_ALREADY_STARTED The device is already being managed by this driver.
@retval EFI_ACCESS_DENIED The device is already being managed by a different driver
or an application that requires exclusive access.
@retval EFI_UNSUPPORTED The device is is not supported by this driver.
**/
EFI_STATUS
EFIAPI
IsaBusControllerDriverSupported (
IN EFI_DRIVER_BINDING_PROTOCOL * This,
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
)
/**
Routine Description:
This function checks to see if a controller can be managed by the ISA Bus
Driver. This is done by checking to see if the controller supports the
EFI_PCI_IO_PROTOCOL protocol, and then looking at the PCI Configuration
Header to see if the device is a PCI to ISA bridge. The class code of
PCI to ISA bridge: Base class 06h, Sub class 01h Interface 00h
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - The handle of the device to check.
RemainingDevicePath - A pointer to the remaining portion of a device path.
Returns:
EFI_SUCCESS - The device is supported by this driver.
EFI_UNSUPPORTED - The device is not supported by this driver.
**/
{
EFI_STATUS Status;
EFI_ISA_ACPI_PROTOCOL *IsaAcpi;
EFI_STATUS Status;
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;
EFI_PCI_IO_PROTOCOL *PciIo;
EFI_ISA_ACPI_PROTOCOL *IsaAcpi;
//
// If RemainingDevicePath is not NULL, it should verify that the first device
// path node in RemainingDevicePath is an ACPI Device path node
// path node in RemainingDevicePath is an ACPI Device path node which is a
// legal Device Path Node for this bus driver's children.
//
if (RemainingDevicePath != NULL) {
if (RemainingDevicePath->Type != ACPI_DEVICE_PATH) {
@ -123,21 +117,45 @@ IsaBusControllerDriverSupported (
}
}
//
// Test the existence of DEVICE_PATH protocol
// Try to open EFI DEVICE PATH protocol on the controller
//
Status = gBS->OpenProtocol (
Controller,
&gEfiDevicePathProtocolGuid,
NULL,
(VOID **) &ParentDevicePath,
This->DriverBindingHandle,
Controller,
EFI_OPEN_PROTOCOL_TEST_PROTOCOL
EFI_OPEN_PROTOCOL_BY_DRIVER
);
if (EFI_ERROR (Status)) {
return Status;
}
gBS->CloseProtocol (
Controller,
&gEfiDevicePathProtocolGuid,
This->DriverBindingHandle,
Controller
);
//
// Get the Isa Acpi protocol
// Try to get Pci IO Protocol because it is assumed
// to have been opened by ISA ACPI driver
//
Status = gBS->OpenProtocol (
Controller,
&gEfiPciIoProtocolGuid,
(VOID **) &PciIo,
This->DriverBindingHandle,
Controller,
EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Try to open the Isa Acpi protocol on the controller
//
Status = gBS->OpenProtocol (
Controller,
@ -147,14 +165,14 @@ IsaBusControllerDriverSupported (
Controller,
EFI_OPEN_PROTOCOL_BY_DRIVER
);
if (Status == EFI_ALREADY_STARTED) {
return EFI_SUCCESS;
}
if (EFI_ERROR (Status)) {
return Status;
}
//
// Add more check to see if the child device is valid by calling IsaAcpi->DeviceEnumerate?
//
gBS->CloseProtocol (
Controller,
&gEfiIsaAcpiProtocolGuid,
@ -165,37 +183,40 @@ IsaBusControllerDriverSupported (
return Status;
}
/**
Start this driver on ControllerHandle.
Note that the ISA Bus driver always creates all of its child handles on the first call to Start().
The Start() function is designed to be invoked from the EFI boot service ConnectController().
As a result, much of the error checking on the parameters to Start() has been moved into this
common boot service. It is legal to call Start() from other locations, but the following calling
restrictions must be followed or the system behavior will not be deterministic.
1. ControllerHandle must be a valid EFI_HANDLE.
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
EFI_DEVICE_PATH_PROTOCOL.
3. Prior to calling Start(), the Supported() function for the driver specified by This must
have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] ControllerHandle The handle of the controller to start. This handle
must support a protocol interface that supplies
an I/O abstraction to the driver.
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
This parameter is ignored by device drivers, and is optional for bus drivers.
@retval EFI_SUCCESS The device was started.
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.
Currently not implemented.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval Others The driver failded to start the device.
**/
EFI_STATUS
EFIAPI
IsaBusControllerDriverStart (
IN EFI_DRIVER_BINDING_PROTOCOL * This,
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
)
/**
Routine Description:
This function tells the ISA Bus Driver to start managing a PCI to ISA
Bridge controller.
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - A handle to the device being started.
RemainingDevicePath - A pointer to the remaining portion of a device path.
Returns:
EFI_SUCCESS - The device was started.
EFI_UNSUPPORTED - The device is not supported.
EFI_DEVICE_ERROR - The device could not be started due to a device error.
EFI_ALREADY_STARTED - The device has already been started.
EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of
resources.
**/
{
EFI_STATUS Status;
EFI_PCI_IO_PROTOCOL *PciIo;
@ -211,21 +232,7 @@ IsaBusControllerDriverStart (
EFI_DEVICE_PATH_PROTOCOL *DevicePathData;
//
// Open Device Path Protocol
//
Status = gBS->OpenProtocol (
Controller,
&gEfiDevicePathProtocolGuid,
(VOID **) &ParentDevicePath,
This->DriverBindingHandle,
Controller,
EFI_OPEN_PROTOCOL_BY_DRIVER
);
if (EFI_ERROR (Status) && Status != EFI_ALREADY_STARTED) {
return Status;
}
//
// Open Pci IO Protocol
// Get Pci IO Protocol
//
Status = gBS->OpenProtocol (
Controller,
@ -236,17 +243,24 @@ IsaBusControllerDriverStart (
EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
if (EFI_ERROR (Status)) {
//
// Close opened protocol
//
gBS->CloseProtocol (
Controller,
&gEfiDevicePathProtocolGuid,
This->DriverBindingHandle,
Controller
);
return Status;
}
//
// Open Device Path Protocol
//
Status = gBS->OpenProtocol (
Controller,
&gEfiDevicePathProtocolGuid,
(VOID **) &ParentDevicePath,
This->DriverBindingHandle,
Controller,
EFI_OPEN_PROTOCOL_BY_DRIVER
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Open ISA Acpi Protocol
//
@ -258,7 +272,7 @@ IsaBusControllerDriverStart (
Controller,
EFI_OPEN_PROTOCOL_BY_DRIVER
);
if (EFI_ERROR (Status) && Status != EFI_ALREADY_STARTED) {
if (EFI_ERROR (Status)) {
//
// Close opened protocol
//
@ -268,12 +282,6 @@ IsaBusControllerDriverStart (
This->DriverBindingHandle,
Controller
);
gBS->CloseProtocol (
Controller,
&gEfiPciIoProtocolGuid,
This->DriverBindingHandle,
Controller
);
return Status;
}
//
@ -390,6 +398,31 @@ IsaBusControllerDriverStart (
return EFI_SUCCESS;
}
/**
Stop this driver on ControllerHandle.
The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
As a result, much of the error checking on the parameters to Stop() has been moved
into this common boot service. It is legal to call Stop() from other locations,
but the following calling restrictions must be followed or the system behavior will not be deterministic.
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
same driver's Start() function.
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
EFI_HANDLE. In addition, all of these handles must have been created in this driver's
Start() function, and the Start() function must have called OpenProtocol() on
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] ControllerHandle A handle to the device being stopped. The handle must
support a bus specific I/O protocol for the driver
to use to stop the device.
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
if NumberOfChildren is 0.
@retval EFI_SUCCESS The device was stopped.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
**/
EFI_STATUS
EFIAPI
IsaBusControllerDriverStop (
@ -398,31 +431,6 @@ IsaBusControllerDriverStop (
IN UINTN NumberOfChildren,
IN EFI_HANDLE * ChildHandleBuffer OPTIONAL
)
/**
Routine Description:
This function tells the ISA Bus Driver to stop managing a PCI to ISA
Bridge controller.
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - A handle to the device being stopped.
NumberOfChindren - The number of child device handles in ChildHandleBuffer.
ChildHandleBuffer - An array of child handles to be freed.
Returns:
EFI_SUCCESS - The device was stopped.
EFI_DEVICE_ERROR - The device could not be stopped due to a device error.
EFI_NOT_STARTED - The device has not been started.
EFI_INVALID_PARAMETER - One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of
resources.
**/
{
EFI_STATUS Status;
UINTN Index;
@ -434,16 +442,6 @@ IsaBusControllerDriverStop (
//
// Close the bus driver
//
Status = gBS->CloseProtocol (
Controller,
&gEfiPciIoProtocolGuid,
This->DriverBindingHandle,
Controller
);
if (EFI_ERROR (Status)) {
return Status;
}
Status = gBS->CloseProtocol (
Controller,
&gEfiDevicePathProtocolGuid,
@ -527,9 +525,25 @@ IsaBusControllerDriverStop (
return EFI_SUCCESS;
}
//
// Internal Function
//
/**
Create EFI Handle for a ISA device found via ISA ACPI Protocol
@param[in] This The EFI_DRIVER_BINDING_PROTOCOL instance.
@param[in] Controller The handle of ISA bus controller(PCI to ISA bridge)
@param[in] PciIo The Pointer to the PCI protocol
@param[in] ParentDevicePath Device path of the ISA bus controller
@param[in] IsaDeviceResourceList The resource list of the ISA device
@param[in] ChildDevicePath The pointer to the child device.
@retval EFI_SUCCESS The handle for the child device was created.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_DEVICE_ERROR The handle for the child device can not be created.
**/
EFI_STATUS
IsaCreateDevice (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
@ -539,29 +553,6 @@ IsaCreateDevice (
IN EFI_ISA_ACPI_RESOURCE_LIST *IsaDeviceResourceList,
OUT EFI_DEVICE_PATH_PROTOCOL **ChildDevicePath
)
/**
Routine Description:
Create ISA device found by IsaPnpProtocol
Arguments:
This - The EFI_DRIVER_BINDING_PROTOCOL instance.
Controller - The handle of ISA bus controller(PCI to ISA bridge)
PciIo - The Pointer to the PCI protocol
ParentDevicePath - Device path of the ISA bus controller
IsaDeviceResourceList - The resource list of the ISA device
ChildDevicePath - The pointer to the child device.
Returns:
EFI_SUCCESS - Create the child device.
EFI_OUT_OF_RESOURCES - The request could not be completed due to a lack of
resources.
EFI_DEVICE_ERROR - Can not create child device.
**/
{
EFI_STATUS Status;
ISA_IO_DEVICE *IsaIoDevice;
@ -582,11 +573,8 @@ IsaCreateDevice (
//
// Initialize the ISA I/O instance structure
//
Status = InitializeIsaIoInstance (IsaIoDevice, IsaDeviceResourceList);
if (EFI_ERROR (Status)) {
gBS->FreePool (IsaIoDevice);
return Status;
}
InitializeIsaIoInstance (IsaIoDevice, IsaDeviceResourceList);
//
// Build the child device path
//
@ -602,15 +590,14 @@ IsaCreateDevice (
);
if (IsaIoDevice->DevicePath == NULL) {
Status = EFI_DEVICE_ERROR;
Status = EFI_OUT_OF_RESOURCES;
goto Done;
}
*ChildDevicePath = IsaIoDevice->DevicePath;
//
// Create a child handle and attach the DevicePath,
// PCI I/O, and Controller State
// Create a child handle and install Device Path and ISA I/O protocols
//
Status = gBS->InstallMultipleProtocolInterfaces (
&IsaIoDevice->Handle,
@ -655,3 +642,4 @@ Done:
return Status;
}

10
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaBusDxe.inf
View File

@ -1,12 +1,10 @@
#/** @file
# Component description file for IsaBus module.
#
# Discovers all the ISA Controllers and their resources by using the ISA PnP
# Protocol, produces an instance of the ISA I/O Protocol for every ISA
# Controller found, loads and initializes all ISA Device Drivers, matches ISA
# Device Drivers with their respective ISA Controllers in a deterministic
# manner, and informs a ISA Device Driver when it is to start managing an ISA
# Controller.
# Discovers all the ISA Controllers and their resources by using the ISA ACPI
# Protocol, produces an instance of the ISA I/O Protocol for every ISA
# Controller found. This driver is designed to manage a PCI-to-ISA bridge Device
# such as LPC bridge.
#
# Copyright (c) 2007 - 2009, Intel Corporation
#

643
IntelFrameworkModulePkg/Bus/Isa/IsaBusDxe/IsaIo.c
View File

File diff suppressed because it is too large Load Diff