IsaIo.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
The implementation for EFI_ISA_IO_PROTOCOL.
Copyright (c) 2006 - 2011, 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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "InternalIsaIo.h"
//
// Module Variables
//
{
},
{
},
NULL,
0,
};
{
0x00,
0x87,
0x01
},
{
0x02,
0x83,
0x03
},
{
0x04,
0x81,
0x05
},
{
0x06,
0x82,
0x07
},
{
0x00,
0x00,
0x00
}, // Channel 4 is invalid
{
0xC4,
0x8B,
0xC6
},
{
0xC8,
0x89,
0xCA
},
{
0xCC,
0x8A,
0xCE
},
};
/**
Initializes an ISA I/O Instance
@param[in] IsaIoDevice The iso device to be initialized.
@param[in] IsaDeviceResourceList The resource list.
**/
)
{
//
// Use the ISA IO Protocol structure template to initialize the ISA IO instance
//
CopyMem (
&IsaIoDevice->IsaIo,
sizeof (EFI_ISA_IO_PROTOCOL)
);
}
/**
Performs an ISA I/O Read Cycle
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Width Specifies the width of the I/O operation.
@param[in] Offset The offset in ISA I/O space to start the I/O operation.
@param[in] Count The number of I/O operations to perform.
@param[out] Buffer The destination buffer to store the results
@retval EFI_SUCCESS The data was read from the device sucessfully.
@retval EFI_UNSUPPORTED The Offset is not valid for this device.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
//
// Verify Isa IO Access
//
);
return Status;
}
);
);
}
return Status;
}
/**
Performs an ISA I/O Write Cycle
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Width Specifies the width of the I/O operation.
@param[in] Offset The offset in ISA I/O space to start the I/O operation.
@param[in] Count The number of I/O operations to perform.
@param[in] Buffer The source buffer to write data from
@retval EFI_SUCCESS The data was writen to the device sucessfully.
@retval EFI_UNSUPPORTED The Offset is not valid for this device.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
//
// Verify Isa IO Access
//
);
return Status;
}
);
);
}
return Status;
}
/**
Writes an 8-bit I/O Port
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Offset The offset in ISA IO space to start the IO operation.
@param[in] Value The data to write port.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Parameter is invalid.
@retval EFI_UNSUPPORTED The address range specified by Offset is not valid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
1,
);
);
return Status;
}
return EFI_SUCCESS;
}
/**
Writes I/O operation base address and count number to a 8 bit I/O Port.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] AddrOffset The address' offset.
@param[in] PageOffset The page's offest.
@param[in] CountOffset The count's offset.
@param[in] BaseAddress The base address.
@param[in] Count The number of I/O operations to perform.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Parameter is invalid.
@retval EFI_UNSUPPORTED The address range specified by these Offsets and Count is not valid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
return Status;
}
return Status;
}
return Status;
}
return Status;
}
return Status;
}
/**
Unmaps a memory region for DMA
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Mapping The mapping value returned from EFI_ISA_IO.Map().
@retval EFI_SUCCESS The range was unmapped.
@retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
**/
)
{
//
// Check if DMA is supported.
//
return EFI_UNSUPPORTED;
}
//
// See if the Map() operation associated with this Unmap() required a mapping
// buffer.If a mapping buffer was not required, then this function simply
// returns EFI_SUCCESS.
//
//
// Get the MAP_INFO structure from Mapping
//
//
// If this is a write operation from the Agent's point of view,
// then copy the contents of the mapped buffer into the real buffer
// so the processor can read the contents of the real buffer.
//
CopyMem (
);
}
//
// Free the mapped buffer and the MAP_INFO structure.
//
}
return EFI_SUCCESS;
}
/**
Flushes any posted write data to the system memory.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@retval EFI_SUCCESS The buffers were flushed.
@retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error.
**/
)
{
);
}
return Status;
}
/**
Verifies access to an ISA device
@param[in] IsaIoDevice The ISA device to be verified.
@param[in] Type The Access type. The input must be either IsaAccessTypeMem or IsaAccessTypeIo.
@param[in] Width The width of the memory operation.
@param[in] Count The number of memory operations to perform.
@param[in] Offset The offset in ISA memory space to start the memory operation.
@retval EFI_SUCCESS Verify success.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
@retval EFI_UNSUPPORTED The device ont support the access type.
**/
)
{
if (Width < EfiIsaIoWidthUint8 ||
Width >= EfiIsaIoWidthMaximum ||
Width == EfiIsaIoWidthReserved ||
) {
return EFI_INVALID_PARAMETER;
}
//
// If Width is EfiIsaIoWidthFifoUintX then convert to EfiIsaIoWidthUintX
// If Width is EfiIsaIoWidthFillUintX then convert to EfiIsaIoWidthUintX
//
Count = 1;
}
return EFI_SUCCESS;
}
}
}
Item++;
}
return Status;
}
/**
Performs an ISA Memory Read Cycle
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Width Specifies the width of the memory operation.
@param[in] Offset The offset in ISA memory space to start the memory operation.
@param[in] Count The number of memory operations to perform.
@param[out] Buffer The destination buffer to store the results
@retval EFI_SUCCESS The data was read from the device successfully.
@retval EFI_UNSUPPORTED The Offset is not valid for this device.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
//
// Check if ISA memory is supported.
//
return EFI_UNSUPPORTED;
}
//
// Verify the Isa Io Access
//
);
return Status;
}
);
);
}
return Status;
}
/**
Performs an ISA Memory Write Cycle
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Width Specifies the width of the memory operation.
@param[in] Offset The offset in ISA memory space to start the memory operation.
@param[in] Count The number of memory operations to perform.
@param[in] Buffer The source buffer to write data from
@retval EFI_SUCCESS The data was written to the device sucessfully.
@retval EFI_UNSUPPORTED The Offset is not valid for this device.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
//
// Check if ISA memory is supported.
//
return EFI_UNSUPPORTED;
}
//
// Verify Isa IO Access
//
);
return Status;
}
);
);
}
return Status;
}
/**
Copy one region of ISA memory space to another region of ISA memory space on the ISA controller.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Width Specifies the width of the memory copy operation.
@param[in] DestOffset The offset of the destination
@param[in] SrcOffset The offset of the source
@param[in] Count The number of memory copy operations to perform
@retval EFI_SUCCESS The data was copied sucessfully.
@retval EFI_UNSUPPORTED The DestOffset or SrcOffset is not valid for this device.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
//
// Check if ISA memory is supported.
//
return EFI_UNSUPPORTED;
}
//
// Verify Isa IO Access for destination and source
//
);
return Status;
}
);
return Status;
}
);
);
}
return Status;
}
/**
Maps a memory region for DMA, note this implementation
@param This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param Operation Indicates the type of DMA (slave or bus master), and if
the DMA operation is going to read or write to system memory.
@param ChannelNumber The slave channel number to use for this DMA operation.
If Operation and ChannelAttributes shows that this device
performs bus mastering DMA, then this field is ignored.
The legal range for this field is 0..7.
@param ChannelAttributes The attributes of the DMA channel to use for this DMA operation
@param HostAddress The system memory address to map to the device.
@param NumberOfBytes On input the number of bytes to map. On output the number
of bytes that were mapped.
@param DeviceAddress The resulting map address for the bus master device to use
to access the hosts HostAddress.
@param Mapping A resulting value to pass to EFI_ISA_IO.Unmap().
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_INVALID_PARAMETER The Operation or HostAddress is undefined.
@retval EFI_UNSUPPORTED The HostAddress can not be mapped as a common buffer.
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
**/
)
{
(NULL == HostAddress) ||
(NULL == NumberOfBytes) ||
(NULL == DeviceAddress) ||
) {
return EFI_INVALID_PARAMETER;
}
//
// Initialize the return values to their defaults
//
//
// Make sure the Operation parameter is valid.
// Light IsaIo only supports two operations.
//
if (!(Operation == EfiIsaIoOperationSlaveRead ||
return EFI_INVALID_PARAMETER;
}
if (ChannelNumber >= 4) {
//
// The Light IsaIo doesn't support channelNumber larger than 4.
//
return EFI_INVALID_PARAMETER;
}
//
// Map the HostAddress to a DeviceAddress.
//
//
// Common Buffer operations can not be remapped. If the common buffer
// is above 16MB, then it is not possible to generate a mapping, so return
// an error.
//
return EFI_UNSUPPORTED;
}
//
// Allocate an ISA_MAP_INFO structure to remember the mapping when Unmap()
// is called later.
//
if (IsaMapInfo == NULL) {
*NumberOfBytes = 0;
return EFI_OUT_OF_RESOURCES;
}
//
// Return a pointer to the MAP_INFO structure in Mapping
//
*Mapping = IsaMapInfo;
//
// Initialize the MAP_INFO structure
//
//
// Allocate a buffer below 16MB to map the transfer to.
//
);
*NumberOfBytes = 0;
return Status;
}
//
// If this is a read operation from the DMA agents's point of view,
// then copy the contents of the real buffer into the mapped buffer
// so the DMA agent can read the contents of the real buffer.
//
if (Operation == EfiIsaIoOperationSlaveRead) {
CopyMem (
);
}
//
// The DeviceAddress is the address of the maped buffer below 16 MB
//
} else {
//
// The transfer is below 16 MB, so the DeviceAddress is simply the
// HostAddress
//
}
//
// Figure out what to program into the DMA Channel Mode Register
//
if (Operation == EfiIsaIoOperationSlaveRead) {
} else {
}
//
// We only support EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE in simplified IsaIo
//
//
// A Slave DMA transfer can not cross a 64K boundary.
// Compute *NumberOfBytes based on this restriction.
//
if (*NumberOfBytes > MaxNumberOfBytes) {
}
//
// Compute the values to program into the BaseAddress and Count registers
// of the Slave DMA controller
//
//
// Program the DMA Write Single Mask Register for ChannelNumber
// Clear the DMA Byte Pointer Register
//
This,
);
return Status;
}
This,
);
return Status;
}
return Status;
}
Status = WriteDmaPort (
This,
);
return Status;
}
This,
);
return Status;
}
return EFI_SUCCESS;
}
/**
Maps a memory region for DMA. This implementation implement the
the full mapping support.
@param This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param Operation Indicates the type of DMA (slave or bus master), and if
the DMA operation is going to read or write to system memory.
@param ChannelNumber The slave channel number to use for this DMA operation.
If Operation and ChannelAttributes shows that this device
performs bus mastering DMA, then this field is ignored.
The legal range for this field is 0..7.
@param ChannelAttributes The attributes of the DMA channel to use for this DMA operation
@param HostAddress The system memory address to map to the device.
@param NumberOfBytes On input the number of bytes to map. On output the number
of bytes that were mapped.
@param DeviceAddress The resulting map address for the bus master device to use
to access the hosts HostAddress.
@param Mapping A resulting value to pass to EFI_ISA_IO.Unmap().
@retval EFI_SUCCESS - The range was mapped for the returned NumberOfBytes.
@retval EFI_INVALID_PARAMETER - The Operation or HostAddress is undefined.
@retval EFI_UNSUPPORTED - The HostAddress can not be mapped as a common buffer.
@retval EFI_DEVICE_ERROR - The system hardware could not map the requested address.
@retval EFI_OUT_OF_RESOURCES - The memory pages could not be allocated.
**/
)
{
(NULL == HostAddress) ||
(NULL == NumberOfBytes) ||
(NULL == DeviceAddress) ||
) {
return EFI_INVALID_PARAMETER;
}
//
// Initialize the return values to their defaults
//
//
// Make sure the Operation parameter is valid
//
return EFI_INVALID_PARAMETER;
}
if (ChannelNumber >= 8) {
return EFI_INVALID_PARAMETER;
}
//
// See if this is a Slave DMA Operation
//
if (Operation == EfiIsaIoOperationSlaveRead) {
}
if (Operation == EfiIsaIoOperationSlaveWrite) {
}
if (!Master) {
//
// Make sure that ChannelNumber is a valid channel number
// Channel 4 is used to cascade, so it is illegal.
//
return EFI_INVALID_PARAMETER;
}
//
// This implementation only support COMPATIBLE DMA Transfers
//
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_COMPATIBLE) == 0) {
return EFI_INVALID_PARAMETER;
}
if ((ChannelAttributes &
EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_C)) != 0) {
return EFI_INVALID_PARAMETER;
}
if (ChannelNumber < 4) {
//
// If this is Channel 0..3, then the width must be 8 bit
//
if (((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8) == 0) ||
) {
return EFI_INVALID_PARAMETER;
}
} else {
//
// If this is Channel 4..7, then the width must be 16 bit
//
if (((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8) != 0) ||
((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_16) == 0)) {
return EFI_INVALID_PARAMETER;
}
}
//
// Either Demand Mode or Single Mode must be selected, but not both
//
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE) != 0) {
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE) != 0) {
return EFI_INVALID_PARAMETER;
}
} else {
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE) == 0) {
return EFI_INVALID_PARAMETER;
}
}
}
//
// Map the HostAddress to a DeviceAddress.
//
//
// Common Buffer operations can not be remapped. If the common buffer
// is above 16MB, then it is not possible to generate a mapping, so return
// an error.
//
return EFI_UNSUPPORTED;
}
//
// Allocate an ISA_MAP_INFO structure to remember the mapping when Unmap()
// is called later.
//
if (IsaMapInfo == NULL) {
*NumberOfBytes = 0;
return EFI_OUT_OF_RESOURCES;
}
//
// Return a pointer to the MAP_INFO structure in Mapping
//
*Mapping = IsaMapInfo;
//
// Initialize the MAP_INFO structure
//
//
// Allocate a buffer below 16MB to map the transfer to.
//
);
*NumberOfBytes = 0;
return Status;
}
//
// If this is a read operation from the DMA agents's point of view,
// then copy the contents of the real buffer into the mapped buffer
// so the DMA agent can read the contents of the real buffer.
//
if (Operation == EfiIsaIoOperationBusMasterRead) {
CopyMem (
);
}
//
// The DeviceAddress is the address of the maped buffer below 16 MB
//
} else {
//
// The transfer is below 16 MB, so the DeviceAddress is simply the
// HostAddress
//
}
//
// If this is a Bus Master operation then return
//
if (Master) {
return EFI_SUCCESS;
}
//
// Figure out what to program into the DMA Channel Mode Register
//
if (Read) {
} else {
}
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_AUTO_INITIALIZE) != 0) {
}
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE) != 0) {
}
if ((ChannelAttributes & EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE) != 0) {
}
//
// A Slave DMA transfer can not cross a 64K boundary.
// Compute *NumberOfBytes based on this restriction.
//
if (*NumberOfBytes > MaxNumberOfBytes) {
}
//
// Compute the values to program into the BaseAddress and Count registers
// of the Slave DMA controller
//
if (ChannelNumber < 4) {
} else {
BaseAddress = (UINT32) (((UINT32) (*DeviceAddress) & 0xff0000) | (((UINT32) (*DeviceAddress) & 0xffff) >> 1));
}
//
// Program the DMA Write Single Mask Register for ChannelNumber
// Clear the DMA Byte Pointer Register
//
if (ChannelNumber < 4) {
} else {
}
This,
);
return Status;
}
This,
);
return Status;
}
return Status;
}
Status = WriteDmaPort (
This,
);
return Status;
}
This,
);
return Status;
}
return EFI_SUCCESS;
}
/**
Maps a memory region for DMA
@param This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param Operation Indicates the type of DMA (slave or bus master), and if
the DMA operation is going to read or write to system memory.
@param ChannelNumber The slave channel number to use for this DMA operation.
If Operation and ChannelAttributes shows that this device
performs bus mastering DMA, then this field is ignored.
The legal range for this field is 0..7.
@param ChannelAttributes The attributes of the DMA channel to use for this DMA operation
@param HostAddress The system memory address to map to the device.
@param NumberOfBytes On input the number of bytes to map. On output the number
of bytes that were mapped.
@param DeviceAddress The resulting map address for the bus master device to use
to access the hosts HostAddress.
@param Mapping A resulting value to pass to EFI_ISA_IO.Unmap().
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_INVALID_PARAMETER The Operation or HostAddress is undefined.
@retval EFI_UNSUPPORTED The HostAddress can not be mapped as a common buffer.
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
**/
IsaIoMap (
)
{
//
// Check if DMA is supported.
//
return EFI_UNSUPPORTED;
}
//
// Set Feature Flag PcdIsaBusSupportBusMaster to FALSE to disable support for
// ISA Bus Master.
//
// So we just return EFI_UNSUPPORTED for these functions.
//
return IsaIoMapOnlySupportSlaveReadWrite (
This,
);
} else {
return IsaIoMapFullSupport (
This,
);
}
}
/**
Allocates pages that are suitable for an EfiIsaIoOperationBusMasterCommonBuffer mapping.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Type The type allocation to perform.
@param[in] MemoryType The type of memory to allocate.
@param[in] Pages The number of pages to allocate.
@param[out] HostAddress A pointer to store the base address of the allocated range.
@param[in] Attributes The requested bit mask of attributes for the allocated range.
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_INVALID_PARAMETER Type is invalid or MemoryType is invalid or HostAddress is NULL
@retval EFI_UNSUPPORTED Attributes is unsupported or the memory range specified
by HostAddress, Pages, and Type is not available for common buffer use.
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
**/
)
{
//
// Set Feature Flag PcdIsaBusOnlySupportSlaveDma to FALSE to disable support for
// ISA Bus Master.
// Or unset Feature Flag PcdIsaBusSupportDma to disable support for ISA DMA.
//
return EFI_UNSUPPORTED;
}
if (HostAddress == NULL) {
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
//
// The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
//
return EFI_INVALID_PARAMETER;
}
if ((Attributes & ~(EFI_ISA_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE | EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED)) != 0) {
return EFI_UNSUPPORTED;
}
if (Type == AllocateAddress) {
return EFI_UNSUPPORTED;
} else {
}
}
if (Type == AllocateAnyPages) {
}
);
return Status;
}
return Status;
}
/**
Frees memory that was allocated with EFI_ISA_IO.AllocateBuffer().
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Pages The number of pages to free.
@param[in] HostAddress The base address of the allocated range.
@retval EFI_SUCCESS The requested memory pages were freed.
@retval EFI_INVALID_PARAMETER The memory was not allocated with EFI_ISA_IO.AllocateBufer().
**/
)
{
//
// Set Feature Flag PcdIsaBusOnlySupportSlaveDma to FALSE to disable support for
// ISA Bus Master.
// Or unset Feature Flag PcdIsaBusSupportDma to disable support for ISA DMA.
//
return EFI_UNSUPPORTED;
}
);
);
}
return Status;
}