mirror of
https://github.com/acidanthera/audk.git
synced 2025-10-25 17:23:53 +02:00
bcd7041487
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5058 6f19259b-4bc3-4df7-8a09-765794883524
330 lines
10 KiB
C
330 lines
10 KiB
C
/**@file
|
|
The header file for ISA bus driver
|
|
|
|
Copyright (c) 2006 - 2007, 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
|
|
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.
|
|
|
|
**/
|
|
|
|
#ifndef _EFI_ISA_BUS_H
|
|
#define _EFI_ISA_BUS_H
|
|
|
|
|
|
#include <PiDxe.h>
|
|
#include <FrameworkDxe.h>
|
|
|
|
#include <Protocol/PciIo.h>
|
|
#include <Protocol/ComponentName.h>
|
|
#include <Protocol/IsaIo.h>
|
|
#include <Protocol/DevicePath.h>
|
|
#include <Protocol/IsaAcpi.h>
|
|
#include <Protocol/DriverBinding.h>
|
|
#include <Protocol/GenericMemoryTest.h>
|
|
#include <Guid/StatusCodeDataTypeId.h>
|
|
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/UefiDriverEntryPoint.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/DevicePathLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/ReportStatusCodeLib.h>
|
|
#include <Library/PcdLib.h>
|
|
|
|
#include "ComponentName.h"
|
|
|
|
//
|
|
// 8237 DMA registers
|
|
//
|
|
#define R_8237_DMA_BASE_CA_CH0 0x00
|
|
#define R_8237_DMA_BASE_CA_CH1 0x02
|
|
#define R_8237_DMA_BASE_CA_CH2 0x04
|
|
#define R_8237_DMA_BASE_CA_CH3 0xd6
|
|
#define R_8237_DMA_BASE_CA_CH5 0xc4
|
|
#define R_8237_DMA_BASE_CA_CH6 0xc8
|
|
#define R_8237_DMA_BASE_CA_CH7 0xcc
|
|
|
|
#define R_8237_DMA_BASE_CC_CH0 0x01
|
|
#define R_8237_DMA_BASE_CC_CH1 0x03
|
|
#define R_8237_DMA_BASE_CC_CH2 0x05
|
|
#define R_8237_DMA_BASE_CC_CH3 0xd7
|
|
#define R_8237_DMA_BASE_CC_CH5 0xc6
|
|
#define R_8237_DMA_BASE_CC_CH6 0xca
|
|
#define R_8237_DMA_BASE_CC_CH7 0xce
|
|
|
|
#define R_8237_DMA_MEM_LP_CH0 0x87
|
|
#define R_8237_DMA_MEM_LP_CH1 0x83
|
|
#define R_8237_DMA_MEM_LP_CH2 0x81
|
|
#define R_8237_DMA_MEM_LP_CH3 0x82
|
|
#define R_8237_DMA_MEM_LP_CH5 0x8B
|
|
#define R_8237_DMA_MEM_LP_CH6 0x89
|
|
#define R_8237_DMA_MEM_LP_CH7 0x8A
|
|
|
|
|
|
#define R_8237_DMA_COMMAND_CH0_3 0x08
|
|
#define R_8237_DMA_COMMAND_CH4_7 0xd0
|
|
#define B_8237_DMA_COMMAND_GAP 0x10
|
|
#define B_8237_DMA_COMMAND_CGE 0x04
|
|
|
|
|
|
#define R_8237_DMA_STA_CH0_3 0xd8
|
|
#define R_8237_DMA_STA_CH4_7 0xd0
|
|
|
|
#define R_8237_DMA_WRSMSK_CH0_3 0x0a
|
|
#define R_8237_DMA_WRSMSK_CH4_7 0xd4
|
|
#define B_8237_DMA_WRSMSK_CMS 0x04
|
|
|
|
|
|
#define R_8237_DMA_CHMODE_CH0_3 0x0b
|
|
#define R_8237_DMA_CHMODE_CH4_7 0xd6
|
|
#define V_8237_DMA_CHMODE_DEMAND 0x00
|
|
#define V_8237_DMA_CHMODE_SINGLE 0x40
|
|
#define V_8237_DMA_CHMODE_CASCADE 0xc0
|
|
#define B_8237_DMA_CHMODE_DECREMENT 0x20
|
|
#define B_8237_DMA_CHMODE_INCREMENT 0x00
|
|
#define B_8237_DMA_CHMODE_AE 0x10
|
|
#define V_8237_DMA_CHMODE_VERIFY 0
|
|
#define V_8237_DMA_CHMODE_IO2MEM 0x04
|
|
#define V_8237_DMA_CHMODE_MEM2IO 0x08
|
|
|
|
#define R_8237_DMA_CBPR_CH0_3 0x0c
|
|
#define R_8237_DMA_CBPR_CH4_7 0xd8
|
|
|
|
#define R_8237_DMA_MCR_CH0_3 0x0d
|
|
#define R_8237_DMA_MCR_CH4_7 0xda
|
|
|
|
#define R_8237_DMA_CLMSK_CH0_3 0x0e
|
|
#define R_8237_DMA_CLMSK_CH4_7 0xdc
|
|
|
|
#define R_8237_DMA_WRMSK_CH0_3 0x0f
|
|
#define R_8237_DMA_WRMSK_CH4_7 0xde
|
|
|
|
|
|
extern EFI_ISA_IO_PROTOCOL IsaIoInterface;
|
|
|
|
typedef enum {
|
|
IsaAccessTypeUnknown,
|
|
IsaAccessTypeIo,
|
|
IsaAccessTypeMem,
|
|
IsaAccessTypeMaxType
|
|
} ISA_ACCESS_TYPE;
|
|
|
|
//
|
|
// 16 MB Memory Range
|
|
//
|
|
#define ISA_MAX_MEMORY_ADDRESS 0x1000000
|
|
//
|
|
// 64K I/O Range
|
|
//
|
|
#define ISA_MAX_IO_ADDRESS 0x10000
|
|
|
|
typedef struct {
|
|
UINT8 Address;
|
|
UINT8 Page;
|
|
UINT8 Count;
|
|
} EFI_ISA_DMA_REGISTERS;
|
|
|
|
//
|
|
// ISA I/O Device Structure
|
|
//
|
|
#define ISA_IO_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('i', 's', 'a', 'i')
|
|
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
EFI_HANDLE Handle;
|
|
EFI_ISA_IO_PROTOCOL IsaIo;
|
|
EFI_DEVICE_PATH_PROTOCOL *DevicePath;
|
|
EFI_PCI_IO_PROTOCOL *PciIo;
|
|
} ISA_IO_DEVICE;
|
|
|
|
#define ISA_IO_DEVICE_FROM_ISA_IO_THIS(a) CR (a, ISA_IO_DEVICE, IsaIo, ISA_IO_DEVICE_SIGNATURE)
|
|
|
|
//
|
|
// Global Variables
|
|
//
|
|
extern EFI_DRIVER_BINDING_PROTOCOL gIsaBusControllerDriver;
|
|
|
|
//
|
|
// Mapping structure for performing ISA DMA to a buffer above 16 MB
|
|
//
|
|
typedef struct {
|
|
EFI_ISA_IO_PROTOCOL_OPERATION Operation;
|
|
UINTN NumberOfBytes;
|
|
UINTN NumberOfPages;
|
|
EFI_PHYSICAL_ADDRESS HostAddress;
|
|
EFI_PHYSICAL_ADDRESS MappedHostAddress;
|
|
} ISA_MAP_INFO;
|
|
|
|
//
|
|
// EFI Driver Binding Protocol Interface Functions
|
|
//
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
IsaBusControllerDriverSupported (
|
|
IN EFI_DRIVER_BINDING_PROTOCOL * This,
|
|
IN EFI_HANDLE Controller,
|
|
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
|
|
EFIAPI
|
|
IsaBusControllerDriverStart (
|
|
IN EFI_DRIVER_BINDING_PROTOCOL * This,
|
|
IN EFI_HANDLE Controller,
|
|
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
|
|
EFIAPI
|
|
IsaBusControllerDriverStop (
|
|
IN EFI_DRIVER_BINDING_PROTOCOL * This,
|
|
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
|
|
//
|
|
|
|
EFI_STATUS
|
|
IsaCreateDevice (
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
IN EFI_HANDLE Controller,
|
|
IN EFI_PCI_IO_PROTOCOL *PciIo,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,
|
|
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
|
|
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
|