Updated headers to follow coding standard

[mirror_edk2.git] / MdePkg / Include / Protocol / DeviceIo.h

diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h
index 0d70632fd9188095d0be89e9afbdc1623a701266..0138b7a24735da97f532613f53e9f93c490a8077 100644 (file)
--- a/MdePkg/Include/Protocol/DeviceIo.h
+++ b/MdePkg/Include/Protocol/DeviceIo.h
@@ -13,8 +13,6 @@
   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
-  Module Name:  DeviceIo.h\r
-\r
 **/\r
 \r
 #ifndef __DEVICE_IO_H__\r
@@ -27,6 +25,16 @@
 \r
 typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;\r
 \r
+//\r
+// Protocol GUID name defined in EFI1.1.\r
+// \r
+#define DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_PROTOCOL_GUID\r
+\r
+//\r
+// Protocol defined in EFI1.1.\r
+// \r
+typedef EFI_DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_INTERFACE;\r
+\r
 typedef enum {\r
   IO_UINT8,\r
   IO_UINT16,\r
@@ -47,7 +55,7 @@ typedef enum {
   @param  Count                 The number of I/O operations to perform.\r
   @param  Buffer                For read operations, the destination buffer to store the results. For write\r
                                 operations, the source buffer to write data from.                \r
-  \r
+\r
   @retval EFI_SUCCESS           The data was read from or written to the device.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
   @retval EFI_INVALID_PARAMETER Width is invalid.\r
@@ -76,7 +84,7 @@ typedef struct {
                                 is going to be returned.  \r
   @param  PciDevicePath         A pointer to the pointer for the EFI Device Path for PciAddress.\r
                                 Memory for the Device Path is allocated from the pool.          \r
-  \r
+\r
   @retval EFI_SUCCESS           The PciDevicePath returns a pointer to a valid EFI Device Path.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
   @retval EFI_UNSUPPORTED       The PciAddress does not map to a valid EFI Device Path.\r
@@ -106,7 +114,7 @@ typedef enum {
   @param  DeviceAddress         The resulting map address for the bus master device to use to access the\r
                                 hosts HostAddress.\r
   @param  Mapping               A resulting value to pass to Unmap().\r
-  \r
+\r
   @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.\r
   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.      \r
   @retval EFI_UNSUPPORTED       The HostAddress cannot be mapped as a common buffer.\r
@@ -130,7 +138,7 @@ EFI_STATUS
     \r
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
   @param  Mapping               A resulting value to pass to Unmap().\r
-  \r
+\r
   @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.\r
   @retval EFI_DEVICE_ERROR      The system hardware could not map the requested address.\r
                                    \r
@@ -151,7 +159,7 @@ EFI_STATUS
                                 EfiRuntimeServicesData.\r
   @param  Pages                 The number of pages to allocate.\r
   @param  HostAddress           A pointer to store the base address of the allocated range.                                \r
-  \r
+\r
   @retval EFI_SUCCESS           The requested memory pages were allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The memory pages could not be allocated.\r
   @retval EFI_INVALID_PARAMETER The requested memory type is invalid.\r
@@ -173,7 +181,7 @@ EFI_STATUS
   Flushes any posted write data to the device.\r
     \r
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.\r
-  \r
+\r
   @retval EFI_SUCCESS           The buffers were flushed.\r
   @retval EFI_DEVICE_ERROR      The buffers were not flushed due to a hardware error.                                 \r
   \r
@@ -190,7 +198,7 @@ EFI_STATUS
   @param  This                  A pointer to the EFI_DEVICE_IO_INTERFACE instance.  \r
   @param  Pages                 The number of pages to free.\r
   @param  HostAddress           The base address of the range to free.\r
-  \r
+\r
   @retval EFI_SUCCESS           The requested memory pages were allocated.\r
   @retval EFI_NOT_FOUND         The requested memory pages were not allocated with\r
                                 AllocateBuffer().  \r