2 EFI PCAT ISA ACPI Driver for a Generic PC Platform
4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "PcatIsaAcpi.h"
18 // PcatIsaAcpi Driver Binding Protocol
20 EFI_DRIVER_BINDING_PROTOCOL gPcatIsaAcpiDriverBinding
= {
21 PcatIsaAcpiDriverBindingSupported
,
22 PcatIsaAcpiDriverBindingStart
,
23 PcatIsaAcpiDriverBindingStop
,
30 the entry point of the PcatIsaAcpi driver.
32 @param ImageHandle Handle for driver image
33 @param SystemTable Point to EFI_SYSTEM_TABLE
35 @return Success or not for installing driver binding protocol
39 PcatIsaAcpiDriverEntryPoint (
40 IN EFI_HANDLE ImageHandle
,
41 IN EFI_SYSTEM_TABLE
*SystemTable
44 return EfiLibInstallDriverBindingComponentName2 (
47 &gPcatIsaAcpiDriverBinding
,
49 &gPcatIsaAcpiComponentName
,
50 &gPcatIsaAcpiComponentName2
55 ControllerDriver Protocol Method
57 @param This Driver Binding protocol instance pointer.
58 @param Controller Handle of device to test.
59 @param RemainingDevicePath Optional parameter use to pick a specific child
61 @retval EFI_SUCCESS This driver supports this device.
62 @retval other This driver does not support this device.
67 PcatIsaAcpiDriverBindingSupported (
68 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
69 IN EFI_HANDLE Controller
,
70 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
74 EFI_PCI_IO_PROTOCOL
*PciIo
;
82 // Get PciIo protocol instance
84 Status
= gBS
->OpenProtocol (
86 &gEfiPciIoProtocolGuid
,
88 This
->DriverBindingHandle
,
90 EFI_OPEN_PROTOCOL_BY_DRIVER
92 if (EFI_ERROR(Status
)) {
96 Status
= PciIo
->Pci
.Read (
100 sizeof(Pci
) / sizeof(UINT32
),
103 if (!EFI_ERROR (Status
)) {
104 Status
= EFI_UNSUPPORTED
;
105 if ((Pci
.Hdr
.Command
& 0x03) == 0x03) {
106 if (Pci
.Hdr
.ClassCode
[2] == PCI_CLASS_BRIDGE
) {
108 // See if this is a standard PCI to ISA Bridge from the Base Code and Class Code
110 if (Pci
.Hdr
.ClassCode
[1] == PCI_CLASS_BRIDGE_ISA
) {
111 Status
= EFI_SUCCESS
;
115 // See if this is an Intel PCI to ISA bridge in Positive Decode Mode
117 if (Pci
.Hdr
.ClassCode
[1] == PCI_CLASS_BRIDGE_ISA_PDECODE
&&
118 Pci
.Hdr
.VendorId
== 0x8086 ) {
120 // See if this is on Function #0 to avoid false positives on
121 // PCI_CLASS_BRIDGE_OTHER that has the same value as
122 // PCI_CLASS_BRIDGE_ISA_PDECODE
124 Status
= PciIo
->GetLocation (
131 if (!EFI_ERROR (Status
) && FunctionNumber
== 0) {
132 Status
= EFI_SUCCESS
;
134 Status
= EFI_UNSUPPORTED
;
143 &gEfiPciIoProtocolGuid
,
144 This
->DriverBindingHandle
,
152 Install EFI_ISA_ACPI_PROTOCOL.
154 @param This Driver Binding protocol instance pointer.
155 @param ControllerHandle Handle of device to bind driver to.
156 @param RemainingDevicePath Optional parameter use to pick a specific child
159 @retval EFI_SUCCESS This driver is added to ControllerHandle
160 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
161 @retval other This driver does not support this device
165 PcatIsaAcpiDriverBindingStart (
166 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
167 IN EFI_HANDLE Controller
,
168 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
172 EFI_PCI_IO_PROTOCOL
*PciIo
;
173 PCAT_ISA_ACPI_DEV
*PcatIsaAcpiDev
;
175 UINT64 OriginalAttributes
;
180 PcatIsaAcpiDev
= NULL
;
181 OriginalAttributes
= 0;
183 // Open the PCI I/O Protocol Interface
186 Status
= gBS
->OpenProtocol (
188 &gEfiPciIoProtocolGuid
,
190 This
->DriverBindingHandle
,
192 EFI_OPEN_PROTOCOL_BY_DRIVER
194 if (EFI_ERROR (Status
)) {
199 // Get supported PCI attributes
201 Status
= PciIo
->Attributes (
203 EfiPciIoAttributeOperationSupported
,
207 if (EFI_ERROR (Status
)) {
211 Supports
&= (UINT64
) (EFI_PCI_IO_ATTRIBUTE_ISA_IO
| EFI_PCI_IO_ATTRIBUTE_ISA_IO_16
);
212 if (Supports
== 0 || Supports
== (EFI_PCI_IO_ATTRIBUTE_ISA_IO
| EFI_PCI_IO_ATTRIBUTE_ISA_IO_16
)) {
213 Status
= EFI_UNSUPPORTED
;
217 Status
= PciIo
->Attributes (
219 EfiPciIoAttributeOperationGet
,
223 if (EFI_ERROR (Status
)) {
227 Status
= PciIo
->Attributes (
229 EfiPciIoAttributeOperationEnable
,
230 EFI_PCI_DEVICE_ENABLE
| Supports
| EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO
,
233 if (EFI_ERROR (Status
)) {
239 // Allocate memory for the PCAT ISA ACPI Device structure
241 PcatIsaAcpiDev
= NULL
;
242 Status
= gBS
->AllocatePool (
244 sizeof(PCAT_ISA_ACPI_DEV
),
245 (VOID
**)&PcatIsaAcpiDev
247 if (EFI_ERROR (Status
)) {
252 // Initialize the PCAT ISA ACPI Device structure
254 PcatIsaAcpiDev
->Signature
= PCAT_ISA_ACPI_DEV_SIGNATURE
;
255 PcatIsaAcpiDev
->Handle
= Controller
;
256 PcatIsaAcpiDev
->PciIo
= PciIo
;
257 PcatIsaAcpiDev
->OriginalAttributes
= OriginalAttributes
;
260 // Initialize PcatIsaAcpiDeviceList
262 InitializePcatIsaAcpiDeviceList ();
267 (PcatIsaAcpiDev
->IsaAcpi
).DeviceEnumerate
= IsaDeviceEnumerate
;
268 (PcatIsaAcpiDev
->IsaAcpi
).SetPower
= IsaDeviceSetPower
;
269 (PcatIsaAcpiDev
->IsaAcpi
).GetCurResource
= IsaGetCurrentResource
;
270 (PcatIsaAcpiDev
->IsaAcpi
).GetPosResource
= IsaGetPossibleResource
;
271 (PcatIsaAcpiDev
->IsaAcpi
).SetResource
= IsaSetResource
;
272 (PcatIsaAcpiDev
->IsaAcpi
).EnableDevice
= IsaEnableDevice
;
273 (PcatIsaAcpiDev
->IsaAcpi
).InitDevice
= IsaInitDevice
;
274 (PcatIsaAcpiDev
->IsaAcpi
).InterfaceInit
= IsaInterfaceInit
;
277 // Install the ISA ACPI Protocol interface
279 Status
= gBS
->InstallMultipleProtocolInterfaces (
281 &gEfiIsaAcpiProtocolGuid
, &PcatIsaAcpiDev
->IsaAcpi
,
286 if (EFI_ERROR (Status
)) {
287 if (PciIo
!= NULL
&& Enabled
) {
290 EfiPciIoAttributeOperationSet
,
297 &gEfiPciIoProtocolGuid
,
298 This
->DriverBindingHandle
,
301 if (PcatIsaAcpiDev
!= NULL
) {
302 gBS
->FreePool (PcatIsaAcpiDev
);
312 Stop this driver on ControllerHandle. Support stopping any child handles
313 created by this driver.
315 @param This Protocol instance pointer.
316 @param ControllerHandle Handle of device to stop driver on
317 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
318 children is zero stop the entire bus driver.
319 @param ChildHandleBuffer List of Child Handles to Stop.
321 @retval EFI_SUCCESS This driver is removed ControllerHandle
322 @retval other This driver was not removed from this device
327 PcatIsaAcpiDriverBindingStop (
328 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
329 IN EFI_HANDLE Controller
,
330 IN UINTN NumberOfChildren
,
331 IN EFI_HANDLE
*ChildHandleBuffer
335 EFI_ISA_ACPI_PROTOCOL
*IsaAcpi
;
336 PCAT_ISA_ACPI_DEV
*PcatIsaAcpiDev
;
339 // Get the ISA ACPI Protocol Interface
341 Status
= gBS
->OpenProtocol (
343 &gEfiIsaAcpiProtocolGuid
,
345 This
->DriverBindingHandle
,
347 EFI_OPEN_PROTOCOL_GET_PROTOCOL
349 if (EFI_ERROR (Status
)) {
354 // Get the PCAT ISA ACPI Device structure from the ISA ACPI Protocol
356 PcatIsaAcpiDev
= PCAT_ISA_ACPI_DEV_FROM_THIS (IsaAcpi
);
359 // Restore PCI attributes
361 Status
= PcatIsaAcpiDev
->PciIo
->Attributes (
362 PcatIsaAcpiDev
->PciIo
,
363 EfiPciIoAttributeOperationSet
,
364 PcatIsaAcpiDev
->OriginalAttributes
,
367 if (EFI_ERROR (Status
)) {
372 // Uninstall protocol interface: EFI_ISA_ACPI_PROTOCOL
374 Status
= gBS
->UninstallProtocolInterface (
376 &gEfiIsaAcpiProtocolGuid
, &PcatIsaAcpiDev
->IsaAcpi
378 if (EFI_ERROR (Status
)) {
384 &gEfiPciIoProtocolGuid
,
385 This
->DriverBindingHandle
,
389 gBS
->FreePool (PcatIsaAcpiDev
);