Minor code refinement.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9920 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c
index 802b4fef2b01b679b4a3bbad02ec9133aca0205f..0202fc57bf05cd4eb0f504494da4d6662ca358f7 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c
+++ b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c
@@ -12,59 +12,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#include <PiDxe.h>\r
-\r
-#include <Protocol/CpuIo.h>\r
-\r
-#include <Library/BaseLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/IoLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-\r
-#define MAX_IO_PORT_ADDRESS   0xFFFF\r
-\r
-//\r
-// Function Prototypes\r
-//\r
-EFI_STATUS\r
-EFIAPI\r
-CpuMemoryServiceRead (\r
-  IN  EFI_CPU_IO_PROTOCOL        *This,\r
-  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
-  IN  UINT64                     Address,\r
-  IN  UINTN                      Count,\r
-  OUT VOID                       *Buffer\r
-  );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-CpuMemoryServiceWrite (\r
-  IN EFI_CPU_IO_PROTOCOL        *This,\r
-  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
-  IN UINT64                     Address,\r
-  IN UINTN                      Count,\r
-  IN VOID                       *Buffer\r
-  );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-CpuIoServiceRead (\r
-  IN  EFI_CPU_IO_PROTOCOL        *This,\r
-  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
-  IN  UINT64                     Address,\r
-  IN  UINTN                      Count,\r
-  OUT VOID                       *Buffer\r
-  );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-CpuIoServiceWrite (\r
-  IN EFI_CPU_IO_PROTOCOL        *This,\r
-  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
-  IN UINT64                     Address,\r
-  IN UINTN                      Count,\r
-  IN VOID                       *Buffer\r
-  );\r
+#include "CpuIo.h"\r
 \r
 //\r
 // Handle for the CPU I/O Protocol\r

diff --git a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.h b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.h
new file mode 100644 (file)
index 0000000..d23054b
--- /dev/null
+++ b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.h
@@ -0,0 +1,226 @@
+/** @file\r
+  Internal include file of CPU I/O DXE Driver.\r
+\r
+  Copyright (c) 2004 - 2010, Intel Corporation\r
+  All rights reserved. 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
+#ifndef __CPU_IO_DXE_H__\r
+#define __CPU_IO_DXE_H__\r
+\r
+\r
+#include <PiDxe.h>\r
+\r
+#include <Protocol/CpuIo.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/IoLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+\r
+#define MAX_IO_PORT_ADDRESS   0xFFFF\r
+\r
+/**\r
+  Reads memory-mapped registers.\r
+\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 \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 \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 \r
+  write operation is performed Count times from the first element of Buffer.\r
+  \r
+  @param[in]  This     A pointer to the EFI_CPU_IO_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 of \r
+                       bytes moved is Width size * Count, starting at Address.\r
+  @param[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
+EFI_STATUS\r
+EFIAPI\r
+CpuMemoryServiceRead (\r
+  IN  EFI_CPU_IO_PROTOCOL        *This,\r
+  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
+  IN  UINT64                     Address,\r
+  IN  UINTN                      Count,\r
+  OUT VOID                       *Buffer\r
+  );\r
+\r
+/**\r
+  Writes memory-mapped registers.\r
+\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 \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 \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 \r
+  write operation is performed Count times from the first element of Buffer.\r
+  \r
+  @param[in]  This     A pointer to the EFI_CPU_IO_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 of \r
+                       bytes moved is Width size * Count, starting at Address.\r
+  @param[in]  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
+EFI_STATUS\r
+EFIAPI\r
+CpuMemoryServiceWrite (\r
+  IN EFI_CPU_IO_PROTOCOL        *This,\r
+  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
+  IN UINT64                     Address,\r
+  IN UINTN                      Count,\r
+  IN VOID                       *Buffer\r
+  );\r
+\r
+/**\r
+  Reads I/O registers.\r
+\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 \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 \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 \r
+  write operation is performed Count times from the first element of Buffer.\r
+  \r
+  @param[in]  This     A pointer to the EFI_CPU_IO_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 of \r
+                       bytes moved is Width size * Count, starting at Address.\r
+  @param[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
+EFI_STATUS\r
+EFIAPI\r
+CpuIoServiceRead (\r
+  IN  EFI_CPU_IO_PROTOCOL        *This,\r
+  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
+  IN  UINT64                     Address,\r
+  IN  UINTN                      Count,\r
+  OUT VOID                       *Buffer\r
+  );\r
+\r
+/**\r
+  Write I/O registers.\r
+\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 \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 \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 \r
+  write operation is performed Count times from the first element of Buffer.\r
+  \r
+  @param[in]  This     A pointer to the EFI_CPU_IO_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 of \r
+                       bytes moved is Width size * Count, starting at Address.\r
+  @param[in]  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
+EFI_STATUS\r
+EFIAPI\r
+CpuIoServiceWrite (\r
+  IN EFI_CPU_IO_PROTOCOL        *This,\r
+  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,\r
+  IN UINT64                     Address,\r
+  IN UINTN                      Count,\r
+  IN VOID                       *Buffer\r
+  );\r
+\r
+#endif\r

diff --git a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf
index 93d63ca755d54833c91081931aa30f16b7a28b20..feb0579067644f87820392e02ce150895f91164b 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf
+++ b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf
@@ -27,6 +27,7 @@
 \r
 [Sources]\r
   CpuIo.c\r
+  CpuIo.h\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r
@@ -40,7 +41,7 @@
   UefiBootServicesTableLib\r
 \r
 [Protocols]\r
-  gEfiCpuIoProtocolGuid                         # PROTOCOL SOMETIMES_PRODUCED\r
+  gEfiCpuIoProtocolGuid                         ## PRODUCES\r
 \r
 [Depex]\r
   TRUE\r