/** @file\r
The header file for EFI_ISA_IO protocol implementation.\r
- \r
-Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
+\r
+Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
@param[in] IsaIoDevice The ISA device to be verified.\r
@param[in] Type The Access type. The input must be either IsaAccessTypeMem or IsaAccessTypeIo.\r
@param[in] Width The width of the memory operation.\r
- @param[in] Count The number of memory operations to perform. \r
- @param[in] Offset The offset in ISA memory space to start the memory operation. \r
- \r
+ @param[in] Count The number of memory operations to perform.\r
+ @param[in] Offset The offset in ISA memory space to start the memory operation.\r
+\r
@retval EFI_SUCCESS Verify success.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
@retval EFI_UNSUPPORTED The device ont support the access type.\r
IN UINTN Count,\r
IN UINT32 Offset\r
);\r
- \r
+\r
/**\r
Performs an ISA I/O Read Cycle\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
@param[in] Width Specifies the width of the I/O operation.\r
- @param[in] Offset The offset in ISA I/O space to start the I/O operation. \r
- @param[in] Count The number of I/O operations to perform. \r
+ @param[in] Offset The offset in ISA I/O space to start the I/O operation.\r
+ @param[in] Count The number of I/O operations to perform.\r
@param[out] Buffer The destination buffer to store the results\r
\r
@retval EFI_SUCCESS The data was read from the device sucessfully.\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
@param[in] Width Specifies the width of the I/O operation.\r
- @param[in] Offset The offset in ISA I/O space to start the I/O operation. \r
- @param[in] Count The number of I/O operations to perform. \r
+ @param[in] Offset The offset in ISA I/O space to start the I/O operation.\r
+ @param[in] Count The number of I/O operations to perform.\r
@param[in] Buffer The source buffer to write data from\r
\r
@retval EFI_SUCCESS The data was writen to the device sucessfully.\r
Maps a memory region for DMA\r
\r
@param This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- @param Operation Indicates the type of DMA (slave or bus master), and if \r
- the DMA operation is going to read or write to system memory. \r
- @param ChannelNumber The slave channel number to use for this DMA operation. \r
- If Operation and ChannelAttributes shows that this device \r
- performs bus mastering DMA, then this field is ignored. \r
- The legal range for this field is 0..7. \r
+ @param Operation Indicates the type of DMA (slave or bus master), and if\r
+ the DMA operation is going to read or write to system memory.\r
+ @param ChannelNumber The slave channel number to use for this DMA operation.\r
+ If Operation and ChannelAttributes shows that this device\r
+ performs bus mastering DMA, then this field is ignored.\r
+ The legal range for this field is 0..7.\r
@param ChannelAttributes The attributes of the DMA channel to use for this DMA operation\r
- @param HostAddress The system memory address to map to the device. \r
- @param NumberOfBytes On input the number of bytes to map. On output the number \r
+ @param HostAddress The system memory address to map to the device.\r
+ @param NumberOfBytes On input the number of bytes to map. On output the number\r
of bytes that were mapped.\r
- @param DeviceAddress The resulting map address for the bus master device to use \r
- to access the hosts HostAddress. \r
+ @param DeviceAddress The resulting map address for the bus master device to use\r
+ to access the hosts HostAddress.\r
@param Mapping A resulting value to pass to EFI_ISA_IO.Unmap().\r
\r
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r
@param[in] PageOffset The page's offest.\r
@param[in] CountOffset The count's offset.\r
@param[in] BaseAddress The base address.\r
- @param[in] Count The number of I/O operations to perform. \r
- \r
+ @param[in] Count The number of I/O operations to perform.\r
+\r
@retval EFI_SUCCESS Success.\r
@retval EFI_INVALID_PARAMETER Parameter is invalid.\r
@retval EFI_UNSUPPORTED The address range specified by these Offsets and Count is not valid.\r
Writes an 8-bit I/O Port\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
- @param[in] Offset The offset in ISA IO space to start the IO operation. \r
+ @param[in] Offset The offset in ISA IO space to start the IO operation.\r
@param[in] Value The data to write port.\r
\r
@retval EFI_SUCCESS Success.\r
IN EFI_ISA_IO_PROTOCOL *This,\r
IN UINT32 Offset,\r
IN UINT8 Value\r
- ); \r
+ );\r
\r
/**\r
Performs an ISA Memory Read Cycle\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
@param[in] Width Specifies the width of the memory operation.\r
- @param[in] Offset The offset in ISA memory space to start the memory operation. \r
- @param[in] Count The number of memory operations to perform. \r
+ @param[in] Offset The offset in ISA memory space to start the memory operation.\r
+ @param[in] Count The number of memory operations to perform.\r
@param[out] Buffer The destination buffer to store the results\r
- \r
+\r
@retval EFI_SUCCESS The data was read from the device successfully.\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
/**\r
Performs an ISA Memory Write Cycle\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 memory operation.\r
- @param[in] Offset The offset in ISA memory space to start the memory operation. \r
- @param[in] Count The number of memory operations to perform. \r
+ @param[in] Offset The offset in ISA memory space to start the memory operation.\r
+ @param[in] Count The number of memory operations to perform.\r
@param[in] Buffer The source buffer to write data from\r
\r
@retval EFI_SUCCESS The data was written to the device sucessfully.\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
@param[in] Width Specifies the width of the memory copy operation.\r
- @param[in] DestOffset The offset of the destination \r
+ @param[in] DestOffset The offset of the destination\r
@param[in] SrcOffset The offset of the source\r
@param[in] Count The number of memory copy operations to perform\r
\r
\r
@retval EFI_SUCCESS The requested memory pages were allocated.\r
@retval EFI_INVALID_PARAMETER Type is invalid or MemoryType is invalid or HostAddress is NULL\r
- @retval EFI_UNSUPPORTED Attributes is unsupported or the memory range specified \r
+ @retval EFI_UNSUPPORTED Attributes is unsupported or the memory range specified\r
by HostAddress, Pages, and Type is not available for common buffer use.\r
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.\r
**/\r
);\r
\r
/**\r
- Frees memory that was allocated with EFI_ISA_IO.AllocateBuffer(). \r
+ Frees memory that was allocated with EFI_ISA_IO.AllocateBuffer().\r
\r
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
@param[in] Pages The number of pages to free.\r
projects / mirror_edk2.git / blobdiff