summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/DeviceIo.h
diff options
context:
space:
mode:
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2006-07-20 09:08:37 +0000
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2006-07-20 09:08:37 +0000
commit0647c9adf92c6a8712091607a73b2768327a865d (patch)
tree41c00f087dea23a35388100f5b9895753555ac3c /MdePkg/Include/Protocol/DeviceIo.h
parent151c1ccdcd6960c550fa491bd0ed467416bb2b74 (diff)
downloadedk2-platforms-0647c9adf92c6a8712091607a73b2768327a865d.tar.xz
Remove BugBug in comments and adjust function header according to code style doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/DeviceIo.h')
-rw-r--r--MdePkg/Include/Protocol/DeviceIo.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h
index 0d70632fd9..643c810a34 100644
--- a/MdePkg/Include/Protocol/DeviceIo.h
+++ b/MdePkg/Include/Protocol/DeviceIo.h
@@ -47,7 +47,7 @@ typedef enum {
@param Count The number of I/O operations to perform.
@param Buffer For read operations, the destination buffer to store the results. For write
operations, the source buffer to write data from.
-
+
@retval EFI_SUCCESS The data was read from or written to the device.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_INVALID_PARAMETER Width is invalid.
@@ -76,7 +76,7 @@ typedef struct {
is going to be returned.
@param PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress.
Memory for the Device Path is allocated from the pool.
-
+
@retval EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path.
@@ -106,7 +106,7 @@ typedef enum {
@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 Unmap().
-
+
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
@@ -130,7 +130,7 @@ EFI_STATUS
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@param Mapping A resulting value to pass to Unmap().
-
+
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
@@ -151,7 +151,7 @@ EFI_STATUS
EfiRuntimeServicesData.
@param Pages The number of pages to allocate.
@param HostAddress A pointer to store the base address of the allocated range.
-
+
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
@retval EFI_INVALID_PARAMETER The requested memory type is invalid.
@@ -173,7 +173,7 @@ EFI_STATUS
Flushes any posted write data to the device.
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
-
+
@retval EFI_SUCCESS The buffers were flushed.
@retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error.
@@ -190,7 +190,7 @@ EFI_STATUS
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@param Pages The number of pages to free.
@param HostAddress The base address of the range to free.
-
+
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_NOT_FOUND The requested memory pages were not allocated with
AllocateBuffer().