/** @file\r
- ISA I/O Protocol is used by ISA device drivers to perform I/O, MMIO and DMA \r
+ ISA I/O Protocol is used by ISA device drivers to perform I/O, MMIO and DMA\r
operations on the ISA controllers they manage.\r
- \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
EfiIsaIoOperationBusMasterWrite,\r
///\r
/// Provides both read and write access to system memory by both the processor\r
- /// and a bus master. The buffer is coherent from both the processor's and the \r
+ /// and a bus master. The buffer is coherent from both the processor's and the\r
/// bus master's point of view.\r
///\r
EfiIsaIoOperationBusMasterCommonBuffer,\r
/**\r
Performs ISA I/O and MMIO Read/Write Cycles\r
\r
- @param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance. \r
+ @param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
@param[in] Width Specifies the width of the I/O or MMIO operation.\r
- @param[in] Offset The offset into the ISA I/O or MMIO space to start the \r
- operation. \r
+ @param[in] Offset The offset into the ISA I/O or MMIO space to start the\r
+ operation.\r
@param[in] Count The number of I/O or MMIO operations to perform.\r
- @param[in, out] Buffer For read operations, the destination buffer to store \r
- the results. For write operations, the source buffer to \r
- write data from. \r
- \r
+ @param[in, out] Buffer For read operations, the destination buffer to store\r
+ the results. For write operations, the source buffer to\r
+ write data from.\r
+\r
@retval EFI_SUCCESS The data was successfully read from or written to the device.\r
@retval EFI_UNSUPPORTED The Offset is not valid for this device.\r
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.\r
Maps a memory region for DMA.\r
\r
This function returns the device-specific addresses required to access system memory.\r
- This function is used to map system memory for ISA DMA operations. All ISA DMA \r
- operations must be performed through their mapped addresses, and such mappings must \r
+ This function is used to map system memory for ISA DMA operations. All ISA DMA\r
+ operations must be performed through their mapped addresses, and such mappings must\r
be freed with EFI_ISA_IO_PROTOCOL.Unmap() after the DMA operation is completed.\r
- \r
- If the DMA operation is a single read or write data transfer through an ISA bus \r
- master, then EfiIsaIoOperationBusMasterRead or EfiIsaIoOperationBusMasterWrite \r
+\r
+ If the DMA operation is a single read or write data transfer through an ISA bus\r
+ master, then EfiIsaIoOperationBusMasterRead or EfiIsaIoOperationBusMasterWrite\r
is used and the range is unmapped to complete the operation. If the DMA operation\r
- is a single read or write data transfer through an ISA slave controller, then \r
- EfiIsaIoOperationSlaveRead or EfiIsaIoOperationSlaveWrite is used and the range \r
- is unmapped to complete the operation. \r
- \r
- If performing a DMA read operation, all the data must be present in system memory before the Map() is performed. Similarly, \r
- if performing a DMA write operation, the data must not be accessed in system \r
- memory until EFI_ISA_IO_PROTOCOL.Unmap() is performed. Bus master operations that \r
- require both read and write access or require multiple host device interactions \r
- within the same mapped region must use EfiIsaIoOperationBusMasterCommonBuffer. \r
- However, only memory allocated via the EFI_ISA_IO_PROTOCOL.AllocateBuffer() interface \r
- is guaranteed to be able to be mapped for this operation type. In all mapping \r
+ is a single read or write data transfer through an ISA slave controller, then\r
+ EfiIsaIoOperationSlaveRead or EfiIsaIoOperationSlaveWrite is used and the range\r
+ is unmapped to complete the operation.\r
+\r
+ If performing a DMA read operation, all the data must be present in system memory before the Map() is performed. Similarly,\r
+ if performing a DMA write operation, the data must not be accessed in system\r
+ memory until EFI_ISA_IO_PROTOCOL.Unmap() is performed. Bus master operations that\r
+ require both read and write access or require multiple host device interactions\r
+ within the same mapped region must use EfiIsaIoOperationBusMasterCommonBuffer.\r
+ However, only memory allocated via the EFI_ISA_IO_PROTOCOL.AllocateBuffer() interface\r
+ is guaranteed to be able to be mapped for this operation type. In all mapping\r
requests the NumberOfBytes returned may be less than originally requested. It is\r
the caller's responsibility to make additional requests to complete the entire\r
transfer.\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- @param[in] Operation Indicates the type of DMA (slave or bus master), \r
- and if the DMA operation is going to read or \r
- write to system memory. \r
- @param[in] ChannelNumber The slave channel number to use for this DMA \r
- operation. If Operation and ChannelAttributes \r
- shows that this device performs bus mastering \r
- DMA, then this field is ignored. The legal \r
+ @param[in] Operation Indicates the type of DMA (slave or bus master),\r
+ and if the DMA operation is going to read or\r
+ write to system memory.\r
+ @param[in] ChannelNumber The slave channel number to use for this DMA\r
+ operation. If Operation and ChannelAttributes\r
+ shows that this device performs bus mastering\r
+ DMA, then this field is ignored. The legal\r
range for this field is 0..7.\r
@param[in] ChannelAttributes A bitmask of the attributes used to configure\r
- the slave DMA channel for this DMA operation. \r
+ the slave DMA channel for this DMA operation.\r
See EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_* for the\r
legal bit combinations.\r
@param[in] HostAddress The system memory address to map to the device.\r
- @param[in, out] NumberOfBytes On input the number of bytes to map. On \r
+ @param[in, out] NumberOfBytes On input the number of bytes to map. On\r
output the number of bytes that were mapped.\r
- @param[out] DeviceAddress The resulting map address for the bus master \r
- device to use to access the hosts HostAddress. \r
+ @param[out] DeviceAddress The resulting map address for the bus master\r
+ device to use to access the hosts HostAddress.\r
@param[out] Mapping A returned value that must be passed to into\r
- EFI_ISA_IO_PROTOCOL.Unmap() to free all the the \r
+ EFI_ISA_IO_PROTOCOL.Unmap() to free all the the\r
resources associated with this map request.\r
\r
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r
/**\r
Unmaps a memory region that was previously mapped with EFI_ISA_IO_PROTOCOL.Map().\r
\r
- The EFI_ISA_IO_PROTOCOL.Map() operation is completed and any corresponding \r
- resources are released. If the operation was EfiIsaIoOperationSlaveWrite \r
- or EfiIsaIoOperationBusMasterWrite, the data is committed to system memory. \r
+ The EFI_ISA_IO_PROTOCOL.Map() operation is completed and any corresponding\r
+ resources are released. If the operation was EfiIsaIoOperationSlaveWrite\r
+ or EfiIsaIoOperationBusMasterWrite, the data is committed to system memory.\r
Any resources used for the mapping are freed.\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
\r
/**\r
Allocates pages that are suitable for an EfiIsaIoOperationBusMasterCommonBuffer\r
- mapping. \r
+ mapping.\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- @param[in] Type The type allocation to perform. \r
+ @param[in] Type The type allocation to perform.\r
@param[in] MemoryType The type of memory to allocate.\r
@param[in] Pages The number of pages to allocate.\r
@param[out] HostAddress A pointer to store the base address of the allocated range.\r
);\r
\r
///\r
-/// The EFI_ISA_IO_PROTOCOL provides the basic Memory, I/O, and DMA interfaces \r
-/// used to abstract accesses to ISA controllers. There is one EFI_ISA_IO_PROTOCOL \r
-/// instance for each ISA controller on a ISA bus. A device driver that wishes \r
-/// to manage an ISA controller in a system will have to retrieve the \r
+/// The EFI_ISA_IO_PROTOCOL provides the basic Memory, I/O, and DMA interfaces\r
+/// used to abstract accesses to ISA controllers. There is one EFI_ISA_IO_PROTOCOL\r
+/// instance for each ISA controller on a ISA bus. A device driver that wishes\r
+/// to manage an ISA controller in a system will have to retrieve the\r
/// ISA_PCI_IO_PROTOCOL instance associated with the ISA controller.\r
///\r
struct _EFI_ISA_IO_PROTOCOL {\r
///\r
UINT32 RomSize;\r
///\r
- /// A pointer to the in memory copy of the ROM image. The ISA Bus Driver is responsible \r
+ /// A pointer to the in memory copy of the ROM image. The ISA Bus Driver is responsible\r
/// for allocating memory for the ROM image, and copying the contents of the ROM to memory\r
/// during ISA Bus initialization.\r
- /// \r
+ ///\r
VOID *RomImage;\r
};\r
\r
projects / mirror_edk2.git / blobdiff