]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/CpuIo2.h
Update the copyright notice format
[mirror_edk2.git] / MdePkg / Include / Protocol / CpuIo2.h
index 78b3eb6998bac0e35f4dd882da728ef4079305a3..7dea37136f5339e24db0c22bbf7e585f6a4f2de6 100644 (file)
@@ -12,8 +12,8 @@
   ExitBootServices(). It is different from the Framework CPU I/O Protocol, which is a runtime\r
   protocol and can be used by runtime drivers after ExitBootServices().\r
 \r
-  Copyright (c) 2007 - 2010, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2007 - 2010, 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
   http://opensource.org/licenses/bsd-license.php\r
@@ -59,41 +59,43 @@ typedef enum {
 /**\r
   Enables a driver to access registers in the PI CPU I/O space. \r
 \r
-  The Io.Read() and Io.Write() functions enable a driver to access PCI controller registers in \r
-  the PI CPU I/O space. \r
+  The Io.Read() and Io.Write() functions enable a driver to access PCI controller \r
+  registers in the PI CPU I/O space. \r
 \r
-  The I/O operations are carried out exactly as requested. The caller is responsible for satisfying any \r
-  alignment and I/O width restrictions that a PI System on a platform might require. For example on \r
-  some platforms, width requests of EfiCpuIoWidthUint64 do not work. Misaligned buffers, on \r
-  the other hand, will be handled by the driver.\r
+  The I/O operations are carried out exactly as requested. The caller is responsible \r
+  for satisfying any alignment and I/O width restrictions that a PI System on a \r
+  platform might require. For example on some platforms, width requests of \r
+  EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will \r
+  be handled by the driver.\r
   \r
   If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, \r
-  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for each of the \r
-  Count operations that is performed.\r
+  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for \r
+  each of the Count operations that is performed.\r
   \r
   If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, \r
   EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is \r
-  incremented for each of the Count operations that is performed. The read or write operation is \r
-  performed Count times on the same Address.\r
+  incremented for each of the Count operations that is performed. The read or \r
+  write operation is performed Count times on the same Address.\r
   \r
   If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, \r
   EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is \r
-  incremented for each of the Count operations that is performed. The read or write operation is \r
-  performed Count times from the first element of Buffer.\r
-\r
-  @param[in]       This         A pointer to the EFI_CPU_IO2_PROTOCOL instance.\r
-  @param[in]       Width        Signifies the width of the I/O or Memory operation.\r
-  @param[in]       Address      The base address of the I/O operation. The caller is responsible\r
-                                for aligning the Address if required. \r
-  @param[in]       Count        The number of I/O operations to perform. The number of bytes moved\r
-                                is Width size * Count, starting at Address.\r
-  @param[in, out]  Buffer       For read operations, the destination buffer to store the results.\r
-                                For write operations, the source buffer from which to write data.\r
-\r
-  @retval EFI_SUCCESS           The data was read from or written to the EFI system.\r
-  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system. Or Buffer is NULL.\r
-  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.\r
-                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.\r
+  incremented for each of the Count operations that is performed. The read or \r
+  write operation is performed Count times from the first element of Buffer.\r
+\r
+  @param[in]       This     A pointer to the EFI_CPU_IO2_PROTOCOL instance.\r
+  @param[in]       Width    Signifies the width of the I/O or Memory operation.\r
+  @param[in]       Address  The base address of the I/O operation. \r
+  @param[in]       Count    The number of I/O operations to perform. The number \r
+                            of bytes moved is Width size * Count, starting at Address.\r
+  @param[in, out]  Buffer   For read operations, the destination buffer to store the results.\r
+                            For write operations, the source buffer from which to write data.\r
+\r
+  @retval EFI_SUCCESS            The data was read from or written to the PI system.\r
+  @retval EFI_INVALID_PARAMETER  Width is invalid for this PI system.\r
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.\r
+  @retval EFI_UNSUPPORTED        The Buffer is not aligned for the given Width.\r
+  @retval EFI_UNSUPPORTED        The address range specified by Address, Width, \r
+                                 and Count is not valid for this PI system.\r
 \r
 **/\r
 typedef\r