]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c
MdePkg/IoLib: Filter/trace port IO/MMIO access
[mirror_edk2.git] / MdePkg / Library / BaseIoLibIntrinsic / IoLibMsc.c
index 1e903a7e254aa20aa53b95c04022b062a946ad8f..d2bc5f527cf67084de7dd373107701dba3ca12d6 100644 (file)
@@ -8,26 +8,19 @@
   We don't advocate putting compiler specifics in libraries or drivers but there\r
   is no other way to make this work.\r
 \r
-  Copyright (c) 2006 - 2007, 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
-  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) 2006 - 2021, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
+\r
 #include "BaseIoLibIntrinsicInternal.h"\r
 \r
 //\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
+// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
 //\r
+\r
 int            _inp (unsigned short port);\r
 unsigned short _inpw (unsigned short port);\r
 unsigned long  _inpd (unsigned short port);\r
@@ -63,7 +56,7 @@ void          _ReadWriteBarrier (void);
 \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
@@ -73,10 +66,16 @@ IoRead8 (
   )\r
 {\r
   UINT8                             Value;\r
+  BOOLEAN                           Flag;\r
+\r
+  Flag = FilterBeforeIoRead (FilterWidth8, Port, &Value);\r
+  if (Flag) {\r
+    _ReadWriteBarrier ();\r
+    Value = (UINT8)_inp ((UINT16)Port);\r
+    _ReadWriteBarrier ();\r
+  }\r
+  FilterAfterIoRead (FilterWidth8, Port, &Value);\r
 \r
-  _ReadWriteBarrier ();\r
-  Value = (UINT8)_inp ((UINT16)Port);\r
-  _ReadWriteBarrier ();\r
   return Value;\r
 }\r
 \r
@@ -92,7 +91,7 @@ IoRead8 (
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written the I/O port.\r
+  @return The value written to the I/O port.\r
 \r
 **/\r
 UINT8\r
@@ -102,9 +101,16 @@ IoWrite8 (
   IN      UINT8                     Value\r
   )\r
 {\r
-  _ReadWriteBarrier ();\r
-  (UINT8)_outp ((UINT16)Port, Value);\r
-  _ReadWriteBarrier ();\r
+  BOOLEAN                           Flag;\r
+\r
+  Flag = FilterBeforeIoWrite(FilterWidth8, Port, &Value);\r
+  if (Flag) {\r
+    _ReadWriteBarrier ();\r
+    (UINT8)_outp ((UINT16)Port, Value);\r
+    _ReadWriteBarrier ();\r
+  }\r
+  FilterAfterIoWrite (FilterWidth8, Port, &Value);\r
+\r
   return Value;\r
 }\r
 \r
@@ -116,10 +122,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
@@ -129,11 +136,18 @@ IoRead16 (
   )\r
 {\r
   UINT16                            Value;\r
+  BOOLEAN                           Flag;\r
 \r
   ASSERT ((Port & 1) == 0);\r
-  _ReadWriteBarrier ();\r
-  Value = _inpw ((UINT16)Port);\r
-  _ReadWriteBarrier ();\r
+\r
+  Flag = FilterBeforeIoRead (FilterWidth16, Port, &Value);\r
+  if (Flag) {\r
+    _ReadWriteBarrier ();\r
+    Value = _inpw ((UINT16)Port);\r
+    _ReadWriteBarrier ();\r
+  }\r
+  FilterBeforeIoRead (FilterWidth16, Port, &Value);\r
+\r
   return Value;\r
 }\r
 \r
@@ -145,11 +159,12 @@ IoRead16 (
   operations are 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 write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written the I/O port.\r
+  @return The value written to the I/O port.\r
 \r
 **/\r
 UINT16\r
@@ -159,10 +174,18 @@ IoWrite16 (
   IN      UINT16                    Value\r
   )\r
 {\r
+  BOOLEAN                           Flag;\r
+\r
   ASSERT ((Port & 1) == 0);\r
-  _ReadWriteBarrier ();\r
-  _outpw ((UINT16)Port, Value);\r
-  _ReadWriteBarrier ();\r
+\r
+  Flag = FilterBeforeIoWrite(FilterWidth16, Port, &Value);\r
+  if (Flag) {\r
+    _ReadWriteBarrier ();\r
+    _outpw ((UINT16)Port, Value);\r
+    _ReadWriteBarrier ();\r
+  }\r
+  FilterAfterIoWrite (FilterWidth16, Port, &Value);\r
+\r
   return Value;\r
 }\r
 \r
@@ -174,10 +197,11 @@ IoWrite16 (
   serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\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
@@ -187,11 +211,18 @@ IoRead32 (
   )\r
 {\r
   UINT32                            Value;\r
+  BOOLEAN                           Flag;\r
 \r
   ASSERT ((Port & 3) == 0);\r
-  _ReadWriteBarrier ();\r
-  Value = _inpd ((UINT16)Port);\r
-  _ReadWriteBarrier ();\r
+\r
+  Flag = FilterBeforeIoRead(FilterWidth32, Port, &Value);\r
+  if (Flag) {\r
+    _ReadWriteBarrier ();\r
+    Value = _inpd ((UINT16)Port);\r
+    _ReadWriteBarrier ();\r
+  }\r
+  FilterAfterIoRead (FilterWidth32, Port, &Value);\r
+\r
   return Value;\r
 }\r
 \r
@@ -203,11 +234,12 @@ IoRead32 (
   operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\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
-  @return The value written the I/O port.\r
+  @return The value written to the I/O port.\r
 \r
 **/\r
 UINT32\r
@@ -217,228 +249,17 @@ IoWrite32 (
   IN      UINT32                    Value\r
   )\r
 {\r
-  ASSERT ((Port & 3) == 0);\r
-  _ReadWriteBarrier ();\r
-  _outpd ((UINT16)Port, Value);\r
-  _ReadWriteBarrier ();\r
-  return Value;\r
-}\r
-\r
-\r
-/**\r
-  Reads an 8-bit MMIO register.\r
-\r
-  Reads the 8-bit MMIO register specified by Address. The 8-bit read value is\r
-  returned. This function must guarantee that all MMIO read and write\r
-  operations are serialized.\r
-\r
-  If 8-bit MMIO register operations are not supported, then ASSERT().\r
-\r
-  @param  Address The MMIO register to read.\r
-\r
-  @return The value read from Address.\r
-\r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioRead8 (\r
-  IN      UINTN                     Address\r
-  )\r
-{\r
-  UINT8                             Value;\r
-\r
-  Value = *(volatile UINT8*)Address;\r
-  return Value;\r
-}\r
-\r
-/**\r
-  Writes an 8-bit MMIO register.\r
-\r
-  Writes the 8-bit MMIO register specified by Address with the value specified\r
-  by Value and returns Value. This function must guarantee that all MMIO read\r
-  and write operations are serialized.\r
-\r
-  If 8-bit MMIO register operations are not supported, 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 to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
-  \r
-**/\r
-UINT8\r
-EFIAPI\r
-MmioWrite8 (\r
-  IN      UINTN                     Address,\r
-  IN      UINT8                     Value\r
-  )\r
-{\r
-  return *(volatile UINT8*)Address = Value;\r
-}\r
-\r
-/**\r
-  Reads a 16-bit MMIO register.\r
+  BOOLEAN                           Flag;\r
 \r
-  Reads the 16-bit MMIO register specified by Address. The 16-bit read value is\r
-  returned. This function must guarantee that all MMIO read and write\r
-  operations are serialized.\r
-\r
-  If 16-bit MMIO register operations are not supported, then ASSERT().\r
-\r
-  @param  Address The MMIO register to read.\r
-\r
-  @return The value read from Address.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioRead16 (\r
-  IN      UINTN                     Address\r
-  )\r
-{\r
-  UINT16                            Value;\r
-\r
-  ASSERT ((Address & 1) == 0);\r
-  Value = *(volatile UINT16*)Address;\r
-  return Value;\r
-}\r
-\r
-/**\r
-  Writes a 16-bit MMIO register.\r
-\r
-  Writes the 16-bit MMIO register specified by Address with the value specified\r
-  by Value and returns Value. This function must guarantee that all MMIO read\r
-  and write operations are serialized.\r
-\r
-  If 16-bit MMIO register operations are not supported, 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 read from the Mmio after wrote specified\r
-          Value.\r
-\r
-**/\r
-UINT16\r
-EFIAPI\r
-MmioWrite16 (\r
-  IN      UINTN                     Address,\r
-  IN      UINT16                    Value\r
-  )\r
-{\r
-  ASSERT ((Address & 1) == 0);\r
-  return *(volatile UINT16*)Address = Value;\r
-}\r
-\r
-/**\r
-  Reads a 32-bit MMIO register.\r
-\r
-  Reads the 32-bit MMIO register specified by Address. The 32-bit read value is\r
-  returned. This function must guarantee that all MMIO read and write\r
-  operations are serialized.\r
-\r
-  If 32-bit MMIO register operations are not supported, then ASSERT().\r
-\r
-  @param  Address The MMIO register to read.\r
-\r
-  @return The value read from Address.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioRead32 (\r
-  IN      UINTN                     Address\r
-  )\r
-{\r
-  UINT32                            Value;\r
-\r
-  ASSERT ((Address & 3) == 0);\r
-  Value = *(volatile UINT32*)Address;\r
-  return Value;\r
-}\r
-\r
-/**\r
-  Writes a 32-bit MMIO register.\r
-\r
-  Writes the 32-bit MMIO register specified by Address with the value specified\r
-  by Value and returns Value. This function must guarantee that all MMIO read\r
-  and write operations are serialized.\r
-\r
-  If 32-bit MMIO register operations are not supported, 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 to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
-\r
-**/\r
-UINT32\r
-EFIAPI\r
-MmioWrite32 (\r
-  IN      UINTN                     Address,\r
-  IN      UINT32                    Value\r
-  )\r
-{\r
-  ASSERT ((Address & 3) == 0);\r
-  return *(volatile UINT32*)Address = Value;\r
-}\r
-\r
-/**\r
-  Reads a 64-bit MMIO register.\r
-\r
-  Reads the 64-bit MMIO register specified by Address. The 64-bit read value is\r
-  returned. This function must guarantee that all MMIO read and write\r
-  operations are serialized.\r
-\r
-  If 64-bit MMIO register operations are not supported, then ASSERT().\r
-\r
-  @param  Address The MMIO register to read.\r
-\r
-  @return The value read from Address.\r
+  ASSERT ((Port & 3) == 0);\r
 \r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioRead64 (\r
-  IN      UINTN                     Address\r
-  )\r
-{\r
-  UINT64                            Value;\r
+  Flag = FilterBeforeIoWrite(FilterWidth32, Port, &Value);\r
+  if (Flag) {\r
+    _ReadWriteBarrier ();\r
+    _outpd ((UINT16)Port, Value);\r
+    _ReadWriteBarrier ();\r
+  }\r
+  FilterAfterIoWrite (FilterWidth32, Port, &Value);\r
 \r
-  ASSERT ((Address & 7) == 0);\r
-  Value = *(volatile UINT64*)Address;\r
   return Value;\r
 }\r
-\r
-/**\r
-  Writes a 64-bit MMIO register.\r
-\r
-  Writes the 64-bit MMIO register specified by Address with the value specified\r
-  by Value and returns Value. This function must guarantee that all MMIO read\r
-  and write operations are serialized.\r
-\r
-  If 64-bit MMIO register operations are not supported, 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 to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
-  \r
-**/\r
-UINT64\r
-EFIAPI\r
-MmioWrite64 (\r
-  IN      UINTN                     Address,\r
-  IN      UINT64                    Value\r
-  )\r
-{\r
-  ASSERT ((Address & 7) == 0);\r
-  return *(volatile UINT64*)Address = Value;\r
-}\r
-\r