tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-27 07:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clean up comments

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9759 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
mdkinney 2010-01-14 21:45:28 +00:00
parent 9e926b693d
commit 0b70a697a6
1 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
MdePkg/Include/Protocol/CpuIo2.h
View File

@ -59,41 +59,43 @@ typedef enum {
/** /**
Enables a driver to access registers in the PI CPU I/O space. Enables a driver to access registers in the PI CPU I/O space.
The Io.Read() and Io.Write() functions enable a driver to access PCI controller registers in The Io.Read() and Io.Write() functions enable a driver to access PCI controller
the PI CPU I/O space. registers in the PI CPU I/O space.
The I/O operations are carried out exactly as requested. The caller is responsible for satisfying any The I/O operations are carried out exactly as requested. The caller is responsible
alignment and I/O width restrictions that a PI System on a platform might require. For example on for satisfying any alignment and I/O width restrictions that a PI System on a
some platforms, width requests of EfiCpuIoWidthUint64 do not work. Misaligned buffers, on platform might require. For example on some platforms, width requests of
the other hand, will be handled by the driver. EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will
be handled by the driver.
If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32,
or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for each of the or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for
Count operations that is performed. each of the Count operations that is performed.
If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16,
EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is
incremented for each of the Count operations that is performed. The read or write operation is incremented for each of the Count operations that is performed. The read or
performed Count times on the same Address. write operation is performed Count times on the same Address.
If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16,
EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is
incremented for each of the Count operations that is performed. The read or write operation is incremented for each of the Count operations that is performed. The read or
performed Count times from the first element of Buffer. write operation is performed Count times from the first element of Buffer.
@param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance. @param[in] This A pointer to the EFI_CPU_IO2_PROTOCOL instance.
@param[in] Width Signifies the width of the I/O or Memory operation. @param[in] Width Signifies the width of the I/O or Memory operation.
@param[in] Address The base address of the I/O operation. The caller is responsible @param[in] Address The base address of the I/O operation.
for aligning the Address if required. @param[in] Count The number of I/O operations to perform. The number
@param[in] Count The number of I/O operations to perform. The number of bytes moved of bytes moved is Width size * Count, starting at Address.
is Width size * Count, starting at Address.
@param[in, out] Buffer For read operations, the destination buffer to store the results. @param[in, out] Buffer For read operations, the destination buffer to store the results.
For write operations, the source buffer from which to write data. For write operations, the source buffer from which to write data.
@retval EFI_SUCCESS The data was read from or written to the EFI system. @retval EFI_SUCCESS The data was read from or written to the PI system.
@retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL. @retval EFI_INVALID_PARAMETER Width is invalid for this PI system.
@retval EFI_INVALID_PARAMETER Buffer is NULL.
@retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width. @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.
Or,The address range specified by Address, Width, and Count is not valid for this EFI system. @retval EFI_UNSUPPORTED The address range specified by Address, Width,
and Count is not valid for this PI system.
**/ **/
typedef typedef