Add alignment checking for IoLib functions to conform to MdeLib spec.

[mirror_edk2.git] / MdePkg / Library / BaseIoLibIntrinsic / IoLibIpf.c

diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c
index 1de7f93e298ef015affad44b81f7b4f5bc1870ca..23ca5c68ed3d83c44a5ab74f6e61c355f318ae9d 100644 (file)
--- a/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c
+++ b/MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c
@@ -1,7 +1,7 @@
 /** @file\r
   Common I/O Library routines.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\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
@@ -10,15 +10,48 @@
   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:  IoLibIpf.c\r
-\r
 **/\r
 \r
-#define BIT63                0x8000000000000000ULL\r
+//\r
+// Include common header file for this module.\r
+//\r
+#include "BaseIoLibIntrinsicInternal.h"\r
 \r
 #define MAP_PORT_BASE_TO_MEM(_Port) \\r
     ((((_Port) & 0xfffc) << 10) | ((_Port) & 0x0fff))\r
 \r
+/**\r
+  Translates I/O port address to memory address.\r
+\r
+  This function translates I/O port address to memory address by adding the 64MB\r
+  aligned I/O Port space to the I/O address.\r
+  If I/O Port space base is not 64MB aligned, then ASSERT ().  \r
+\r
+  @param  Port  The I/O port to read.\r
+\r
+  @return The memory address.\r
+\r
+**/\r
+UINTN\r
+InternalGetMemoryMapAddress (\r
+  IN UINTN                  Port\r
+  )\r
+{\r
+  UINTN                     Address;\r
+  UINTN                     IoBlockBaseAddress;\r
+\r
+  Address            = MAP_PORT_BASE_TO_MEM (Port);\r
+  IoBlockBaseAddress = PcdGet64(PcdIoBlockBaseAddressForIpf);\r
+\r
+  //\r
+  // Make sure that the I/O Port space base is 64MB aligned.\r
+  // \r
+  ASSERT ((IoBlockBaseAddress & 0x3ffffff) == 0);\r
+  Address += IoBlockBaseAddress;\r
+\r
+  return Address;\r
+}\r
+\r
 /**\r
   Reads a 8-bit I/O port.\r
 \r
@@ -37,15 +70,7 @@ IoRead8 (
   IN  UINT64                 Port\r
   )\r
 {\r
-  UINT64           Address;\r
-\r
-  //\r
-  // Add the 64MB aligned IO Port space to the IO address\r
-  //\r
-  Address = MAP_PORT_BASE_TO_MEM (Port);\r
-  Address += PcdGet64(PcdIoBlockBaseAddressForIpf);\r
-\r
-  return MmioRead8 (Address);\r
+  return MmioRead8 (InternalGetMemoryMapAddress (Port));\r
 }\r
 \r
 /**\r
@@ -66,15 +91,7 @@ IoRead16 (
   IN  UINT64                 Port\r
   )\r
 {\r
-  UINT64           Address;\r
-\r
-  //\r
-  // Add the 64MB aligned IO Port space to the IO address\r
-  //\r
-  Address = MAP_PORT_BASE_TO_MEM (Port);\r
-  Address += PcdGet64(PcdIoBlockBaseAddressForIpf);\r
-\r
-  return MmioRead16 (Address);\r
+  return MmioRead16 (InternalGetMemoryMapAddress (Port));\r
 }\r
 \r
 /**\r
@@ -95,15 +112,7 @@ IoRead32 (
   IN  UINT64                 Port\r
   )\r
 {\r
-  UINT64           Address;\r
-\r
-  //\r
-  // Add the 64MB aligned IO Port space to the IO address\r
-  //\r
-  Address = MAP_PORT_BASE_TO_MEM (Port);\r
-  Address += PcdGet64(PcdIoBlockBaseAddressForIpf);\r
-\r
-  return MmioRead32 (Address);\r
+  return MmioRead32 (InternalGetMemoryMapAddress (Port));\r
 }\r
 \r
 /**\r
@@ -150,15 +159,7 @@ IoWrite8 (
   IN  UINT8                  Data\r
   )\r
 {\r
-  UINT64           Address;\r
-\r
-  //\r
-  // Add the 64MB aligned IO Port space to the IO address\r
-  //\r
-  Address = MAP_PORT_BASE_TO_MEM (Port);\r
-  Address += PcdGet64(PcdIoBlockBaseAddressForIpf);\r
-\r
-  return MmioWrite8 (Address, Data);\r
+  return MmioWrite8 (InternalGetMemoryMapAddress (Port), Data);\r
 }\r
 \r
 /**\r
@@ -181,15 +182,7 @@ IoWrite16 (
   IN  UINT16                 Data\r
   )\r
 {\r
-  UINT64           Address;\r
-\r
-  //\r
-  // Add the 64MB aligned IO Port space to the IO address\r
-  //\r
-  Address = MAP_PORT_BASE_TO_MEM (Port);\r
-  Address += PcdGet64(PcdIoBlockBaseAddressForIpf);\r
-\r
-  return MmioWrite16 (Address, Data);\r
+  return MmioWrite16 (InternalGetMemoryMapAddress (Port), Data);\r
 }\r
 \r
 /**\r
@@ -212,15 +205,7 @@ IoWrite32 (
   IN  UINT32                 Data\r
   )\r
 {\r
-  UINT64           Address;\r
-\r
-  //\r
-  // Add the 64MB aligned IO Port space to the IO address\r
-  //\r
-  Address = MAP_PORT_BASE_TO_MEM (Port);\r
-  Address += PcdGet64(PcdIoBlockBaseAddressForIpf);\r
-\r
-  return MmioWrite32 (Address, Data);\r
+  return MmioWrite32 (InternalGetMemoryMapAddress (Port), Data);\r
 }\r
 \r
 /**\r
@@ -298,6 +283,11 @@ MmioRead16 (
 {\r
   UINT16           Data;\r
 \r
+  //\r
+  // Make sure that Address is 16-bit aligned.\r
+  // \r
+  ASSERT ((Address & 1) == 0);\r
+\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
@@ -327,6 +317,11 @@ MmioRead32 (
 {\r
   UINT32           Data;\r
 \r
+  //\r
+  // Make sure that Address is 32-bit aligned.\r
+  // \r
+  ASSERT ((Address & 3) == 0);\r
+\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
@@ -356,6 +351,11 @@ MmioRead64 (
 {\r
   UINT64           Data;\r
 \r
+  //\r
+  // Make sure that Address is 64-bit aligned.\r
+  // \r
+  ASSERT ((Address & 7) == 0);\r
+\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
@@ -415,6 +415,11 @@ MmioWrite16 (
   IN  UINT16                 Data\r
   )\r
 {\r
+  //\r
+  // Make sure that Address is 16-bit aligned.\r
+  // \r
+  ASSERT ((Address & 1) == 0);\r
+\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
@@ -444,6 +449,11 @@ MmioWrite32 (
   IN  UINT32                 Data\r
   )\r
 {\r
+  //\r
+  // Make sure that Address is 32-bit aligned.\r
+  // \r
+  ASSERT ((Address & 3) == 0);\r
+\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
@@ -473,6 +483,11 @@ MmioWrite64 (
   IN  UINT64                 Data\r
   )\r
 {\r
+  //\r
+  // Make sure that Address is 64-bit aligned.\r
+  // \r
+  ASSERT ((Address & 7) == 0);\r
+\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r