]> git.proxmox.com Git - mirror_edk2.git/blobdiff - UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.h
UefiCpuPkg: Clean up source files
[mirror_edk2.git] / UefiCpuPkg / CpuIo2Smm / CpuIo2Smm.h
index 5a092594d75fe50aadcbb122bee86781c2be67ab..535bf5c83bc632b59d74f917a7d691f8d550fcaf 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   Internal include file for the SMM CPU I/O Protocol.\r
 \r
-Copyright (c) 2009 - 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
-                                                                                          \r
-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
+Copyright (c) 2009 - 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+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
 **/\r
 \r
@@ -30,23 +30,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Reads memory-mapped registers.\r
 \r
-  The I/O operations are carried out exactly as requested.  The caller is \r
-  responsible for any alignment and I/O width issues that the bus, device, \r
+  The I/O operations are carried out exactly as requested.  The caller is\r
+  responsible for any alignment and I/O width issues that the bus, device,\r
   platform, or type of I/O might require.\r
 \r
   @param[in]  This     The EFI_SMM_CPU_IO2_PROTOCOL instance.\r
   @param[in]  Width    Signifies the width of the I/O operations.\r
-  @param[in]  Address  The base address of the I/O operations.  The caller is \r
-                       responsible for aligning the Address if required. \r
+  @param[in]  Address  The base address of the I/O operations.  The caller is\r
+                       responsible for aligning the Address if required.\r
   @param[in]  Count    The number of I/O operations to perform.\r
-  @param[out] Buffer   For read operations, the destination buffer to store \r
-                       the results.  For write operations, the source buffer \r
+  @param[out] Buffer   For read operations, the destination buffer to store\r
+                       the results.  For write operations, the source buffer\r
                        from which to write data.\r
 \r
   @retval EFI_SUCCESS            The data was read from or written to the device.\r
   @retval EFI_UNSUPPORTED        The Address is not valid for this system.\r
   @retval EFI_INVALID_PARAMETER  Width or Count, or both, were invalid.\r
-  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a \r
+  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a\r
                                  lack of resources\r
 \r
 **/\r
@@ -63,23 +63,23 @@ CpuMemoryServiceRead (
 /**\r
   Writes memory-mapped registers.\r
 \r
-  The I/O operations are carried out exactly as requested.  The caller is \r
-  responsible for any alignment and I/O width issues that the bus, device, \r
+  The I/O operations are carried out exactly as requested.  The caller is\r
+  responsible for any alignment and I/O width issues that the bus, device,\r
   platform, or type of I/O might require.\r
 \r
   @param[in]  This     The EFI_SMM_CPU_IO2_PROTOCOL instance.\r
   @param[in]  Width    Signifies the width of the I/O operations.\r
-  @param[in]  Address  The base address of the I/O operations.  The caller is \r
-                       responsible for aligning the Address if required. \r
+  @param[in]  Address  The base address of the I/O operations.  The caller is\r
+                       responsible for aligning the Address if required.\r
   @param[in]  Count    The number of I/O operations to perform.\r
-  @param[in]  Buffer   For read operations, the destination buffer to store \r
-                       the results.  For write operations, the source buffer \r
+  @param[in]  Buffer   For read operations, the destination buffer to store\r
+                       the results.  For write operations, the source buffer\r
                        from which to write data.\r
 \r
   @retval EFI_SUCCESS            The data was read from or written to the device.\r
   @retval EFI_UNSUPPORTED        The Address is not valid for this system.\r
   @retval EFI_INVALID_PARAMETER  Width or Count, or both, were invalid.\r
-  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a \r
+  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a\r
                                  lack of resources\r
 \r
 **/\r
@@ -96,23 +96,23 @@ CpuMemoryServiceWrite (
 /**\r
   Reads I/O registers.\r
 \r
-  The I/O operations are carried out exactly as requested.  The caller is \r
-  responsible for any alignment and I/O width issues that the bus, device, \r
+  The I/O operations are carried out exactly as requested.  The caller is\r
+  responsible for any alignment and I/O width issues that the bus, device,\r
   platform, or type of I/O might require.\r
 \r
   @param[in]  This     The EFI_SMM_CPU_IO2_PROTOCOL instance.\r
   @param[in]  Width    Signifies the width of the I/O operations.\r
-  @param[in]  Address  The base address of the I/O operations.  The caller is \r
-                       responsible for aligning the Address if required. \r
+  @param[in]  Address  The base address of the I/O operations.  The caller is\r
+                       responsible for aligning the Address if required.\r
   @param[in]  Count    The number of I/O operations to perform.\r
-  @param[out] Buffer   For read operations, the destination buffer to store \r
-                       the results.  For write operations, the source buffer \r
+  @param[out] Buffer   For read operations, the destination buffer to store\r
+                       the results.  For write operations, the source buffer\r
                        from which to write data.\r
 \r
   @retval EFI_SUCCESS            The data was read from or written to the device.\r
   @retval EFI_UNSUPPORTED        The Address is not valid for this system.\r
   @retval EFI_INVALID_PARAMETER  Width or Count, or both, were invalid.\r
-  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a \r
+  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a\r
                                  lack of resources\r
 \r
 **/\r
@@ -129,23 +129,23 @@ CpuIoServiceRead (
 /**\r
   Write I/O registers.\r
 \r
-  The I/O operations are carried out exactly as requested.  The caller is \r
-  responsible for any alignment and I/O width issues that the bus, device, \r
+  The I/O operations are carried out exactly as requested.  The caller is\r
+  responsible for any alignment and I/O width issues that the bus, device,\r
   platform, or type of I/O might require.\r
 \r
   @param[in]  This     The EFI_SMM_CPU_IO2_PROTOCOL instance.\r
   @param[in]  Width    Signifies the width of the I/O operations.\r
-  @param[in]  Address  The base address of the I/O operations.  The caller is \r
-                       responsible for aligning the Address if required. \r
+  @param[in]  Address  The base address of the I/O operations.  The caller is\r
+                       responsible for aligning the Address if required.\r
   @param[in]  Count    The number of I/O operations to perform.\r
-  @param[in]  Buffer   For read operations, the destination buffer to store \r
-                       the results.  For write operations, the source buffer \r
+  @param[in]  Buffer   For read operations, the destination buffer to store\r
+                       the results.  For write operations, the source buffer\r
                        from which to write data.\r
 \r
   @retval EFI_SUCCESS            The data was read from or written to the device.\r
   @retval EFI_UNSUPPORTED        The Address is not valid for this system.\r
   @retval EFI_INVALID_PARAMETER  Width or Count, or both, were invalid.\r
-  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a \r
+  @retval EFI_OUT_OF_RESOURCES   The request could not be completed due to a\r
                                  lack of resources\r
 \r
 **/\r