]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiIoLibCpuIo/IoLib.c
Clean up formatting and some Doxygen comments.
[mirror_edk2.git] / MdePkg / Library / PeiIoLibCpuIo / IoLib.c
index 913092193787fe6e883df0cf8c9e3fd1f2546218..c9260ab9c5cb8c262bea501fbdc4dea81dc1f3d1 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   I/O Library. The implementations are based on EFI_PEI_SERVICE->CpuIo interface.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
@@ -31,7 +31,7 @@
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -40,7 +40,7 @@ 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
@@ -72,7 +72,7 @@ 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
@@ -91,10 +91,11 @@ 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
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -103,7 +104,7 @@ 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
@@ -124,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
@@ -138,7 +140,7 @@ 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
@@ -160,10 +162,11 @@ 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 from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -172,7 +175,7 @@ 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
@@ -193,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
@@ -207,7 +211,7 @@ 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
@@ -229,10 +233,11 @@ 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
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -241,7 +246,7 @@ 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
@@ -262,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
@@ -276,7 +282,7 @@ 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
@@ -301,7 +307,7 @@ IoWrite64 (
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -310,7 +316,7 @@ 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
@@ -332,7 +338,8 @@ MmioRead8 (
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The Value written back to Mmio register.\r
+  @return Value.\r
+\r
 **/\r
 UINT8\r
 EFIAPI\r
@@ -341,7 +348,7 @@ 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
@@ -360,10 +367,11 @@ 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
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -372,7 +380,7 @@ 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
@@ -394,11 +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 The Value written back to Mmio register\r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
@@ -408,7 +417,7 @@ 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
@@ -430,10 +439,11 @@ 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
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -442,7 +452,7 @@ 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
@@ -464,11 +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 The Value written back to Mmio register\r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
@@ -478,7 +489,7 @@ 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
@@ -500,10 +511,11 @@ 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
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -512,7 +524,7 @@ 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
@@ -521,7 +533,7 @@ MmioRead64 (
   //\r
   // Make sure Address is aligned on a 64-bit boundary.\r
   //\r
-  ASSERT ((Address & 7) == (sizeof (UINT64) - 1));\r
+  ASSERT ((Address & (sizeof (UINT64) - 1)) == 0);\r
   return CpuIo->MemRead64 (PeiServices, CpuIo, (UINT64) Address);\r
 \r
 }\r
@@ -534,11 +546,11 @@ 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
 \r
-  @return The Value written back to Mmio register\r
 **/\r
 UINT64\r
 EFIAPI\r
@@ -547,7 +559,7 @@ 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