Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / PeiIoLibCpuIo / IoLib.c

diff --git a/MdePkg/Library/PeiIoLibCpuIo/IoLib.c b/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
index 2156f6b480f27de6dbc599c129785d8f70fd5ce9..6255d491afb4ead561d8bf0b54954f6207bec10a 100644 (file)
--- a/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
+++ b/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
@@ -1,8 +1,8 @@
 /** @file\r
-  I/O Library.\r
+  I/O Library. The implementations are based on EFI_PEI_SERVICE->CpuIo interface.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, 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
@@ -10,10 +10,16 @@
   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:  IoLib.c\r
-\r
 **/\r
 \r
+\r
+#include <PiPei.h>\r
+\r
+#include <Library/IoLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/PeiServicesTablePointerLib.h>\r
+\r
 /**\r
   Reads an 8-bit I/O port.\r
 \r
@@ -34,12 +40,11 @@ IoRead8 (
   IN      UINTN                     Port\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
 \r
   return CpuIo->IoRead8 (PeiServices, CpuIo, (UINT64) Port);\r
@@ -67,12 +72,11 @@ IoWrite8 (
   IN      UINT8                     Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
 \r
   CpuIo->IoWrite8 (PeiServices, CpuIo, (UINT64) Port, Value);\r
@@ -87,6 +91,7 @@ IoWrite8 (
   serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
@@ -99,14 +104,16 @@ IoRead16 (
   IN      UINTN                     Port\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Port is aligned on a 16-bit boundary.\r
+  //\r
+  ASSERT ((Port & 1) == 0);\r
   return CpuIo->IoRead16 (PeiServices, CpuIo, (UINT64) Port);\r
 }\r
 \r
@@ -118,7 +125,8 @@ IoRead16 (
   operations are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
@@ -132,14 +140,16 @@ IoWrite16 (
   IN      UINT16                    Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Port is aligned on a 16-bit boundary.\r
+  //\r
+  ASSERT ((Port & 1) == 0);\r
   CpuIo->IoWrite16 (PeiServices, CpuIo, (UINT64) Port, Value);\r
   return Value;\r
 }\r
@@ -152,7 +162,8 @@ IoWrite16 (
   serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to read.\r
 \r
   @return The value read.\r
@@ -164,14 +175,16 @@ IoRead32 (
   IN      UINTN                     Port\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Port is aligned on a 32-bit boundary.\r
+  //\r
+  ASSERT ((Port & 3) == 0);\r
   return CpuIo->IoRead32 (PeiServices, CpuIo, (UINT64) Port);\r
 }\r
 \r
@@ -183,7 +196,8 @@ IoRead32 (
   operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
@@ -197,14 +211,16 @@ IoWrite32 (
   IN      UINT32                    Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Port is aligned on a 32-bit boundary.\r
+  //\r
+  ASSERT ((Port & 3) == 0);\r
   CpuIo->IoWrite32 (PeiServices, CpuIo, (UINT64) Port, Value);\r
   return Value;\r
 }\r
@@ -217,6 +233,7 @@ IoWrite32 (
   serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
@@ -229,14 +246,16 @@ IoRead64 (
   IN      UINTN                     Port\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Port is aligned on a 64-bit boundary.\r
+  //\r
+  ASSERT ((Port & 7) == 0);\r
   return CpuIo->IoRead64 (PeiServices, CpuIo, (UINT64) Port);\r
 }\r
 \r
@@ -248,6 +267,7 @@ IoRead64 (
   operations are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
@@ -262,14 +282,16 @@ IoWrite64 (
   IN      UINT64                    Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Port is aligned on a 64-bit boundary.\r
+  //\r
+  ASSERT ((Port & 7) == 0);\r
   CpuIo->IoWrite64 (PeiServices, CpuIo, (UINT64) Port, Value);\r
   return Value;;\r
 }\r
@@ -294,12 +316,11 @@ MmioRead8 (
   IN      UINTN                     Address\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
 \r
   return CpuIo->MemRead8 (PeiServices, CpuIo, (UINT64) Address);\r
@@ -316,6 +337,8 @@ MmioRead8 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT8\r
@@ -325,12 +348,11 @@ MmioWrite8 (
   IN      UINT8                     Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
 \r
   CpuIo->MemWrite8 (PeiServices, CpuIo, (UINT64) Address, Value);\r
@@ -345,6 +367,7 @@ MmioWrite8 (
   operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
@@ -357,14 +380,16 @@ MmioRead16 (
   IN      UINTN                     Address\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Address is aligned on a 16-bit boundary.\r
+  //\r
+  ASSERT ((Address & 1) == 0);\r
   return CpuIo->MemRead16 (PeiServices, CpuIo, (UINT64) Address);\r
 \r
 }\r
@@ -377,9 +402,12 @@ MmioRead16 (
   and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
@@ -389,14 +417,16 @@ MmioWrite16 (
   IN      UINT16                    Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Address is aligned on a 16-bit boundary.\r
+  //\r
+  ASSERT ((Address & 1) == 0);\r
   CpuIo->MemWrite16 (PeiServices, CpuIo, (UINT64) Address, Value);\r
   return Value;\r
 }\r
@@ -409,6 +439,7 @@ MmioWrite16 (
   operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
@@ -421,14 +452,16 @@ MmioRead32 (
   IN      UINTN                     Address\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Address is aligned on a 32-bit boundary.\r
+  //\r
+  ASSERT ((Address & 3) == 0);\r
   return CpuIo->MemRead32 (PeiServices, CpuIo, (UINT64) Address);\r
 \r
 }\r
@@ -441,9 +474,12 @@ MmioRead32 (
   and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
@@ -453,14 +489,16 @@ MmioWrite32 (
   IN      UINT32                    Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Address is aligned on a 32-bit boundary.\r
+  //\r
+  ASSERT ((Address & 3) == 0);\r
   CpuIo->MemWrite32 (PeiServices, CpuIo, (UINT64) Address, Value);\r
   return Value;\r
 }\r
@@ -473,6 +511,7 @@ MmioWrite32 (
   operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
@@ -485,14 +524,16 @@ MmioRead64 (
   IN      UINTN                     Address\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Address is aligned on a 64-bit boundary.\r
+  //\r
+  ASSERT ((Address & (sizeof (UINT64) - 1)) == 0);\r
   return CpuIo->MemRead64 (PeiServices, CpuIo, (UINT64) Address);\r
 \r
 }\r
@@ -505,6 +546,7 @@ MmioRead64 (
   and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
@@ -517,14 +559,16 @@ MmioWrite64 (
   IN      UINT64                    Value\r
   )\r
 {\r
-  EFI_PEI_SERVICES                  **PeiServices;\r
+  CONST EFI_PEI_SERVICES            **PeiServices;\r
   EFI_PEI_CPU_IO_PPI                *CpuIo;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
   CpuIo       = (*PeiServices)->CpuIo;\r
-\r
   ASSERT (CpuIo != NULL);\r
-\r
+  //\r
+  // Make sure Address is aligned on a 64-bit boundary.\r
+  //\r
+  ASSERT ((Address & 7) == 0);\r
   CpuIo->MemWrite64 (PeiServices, CpuIo, (UINT64) Address, Value);\r
   return Value;\r
 }\r