BaseMemoryLib: Add missing ASSERT()s for some interfaces.

BaseTimerLibLocalApic: Add missing EBC architecture support. Note that this instance is a dummy one since EBC does not support local APIC timer. 
IoLibDxeCpuIo: Add alignment checking & unsupported width checking by using ASSERT()s.


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

MdePkg/Library/BaseMemoryLib/MemLibGuid.c

@@ -119,6 +119,14 @@ ScanGuid (
 {
   CONST GUID                        *GuidPtr;
 
+  ASSERT (Buffer != NULL);
+  //
+  // Make sure Buffer is aligned on a 64-bit boundary.
+  //
+  ASSERT (((UINTN) Buffer & 7) == 0);
+
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+
   GuidPtr = (GUID*)Buffer;
   Buffer = GuidPtr + Length / sizeof (*GuidPtr);
   while (GuidPtr < (CONST GUID*)Buffer) {

MdePkg/Library/BaseMemoryLib/ZeroMemWrapper.c

@@ -43,9 +43,10 @@ VOID *
 EFIAPI
 ZeroMem (
   IN      VOID                      *Buffer,
-  IN      UINTN                     Size
+  IN      UINTN                     Length
   )
 {
-  ASSERT (Buffer != NULL);
+  ASSERT (!(Buffer == NULL && Length > 0));
-  return InternalMemSetMem (Buffer, Size, 0);
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+  return InternalMemSetMem (Buffer, Length, 0);
 }

MdePkg/Library/BaseMemoryLibMmx/MemLibGuid.c

@@ -119,6 +119,14 @@ ScanGuid (
 {
   CONST GUID                        *GuidPtr;
 
+  ASSERT (Buffer != NULL);
+  //
+  // Make sure Buffer is aligned on a 64-bit boundary.
+  //
+  ASSERT (((UINTN) Buffer & 7) == 0);
+
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+
   GuidPtr = (GUID*)Buffer;
   Buffer = GuidPtr + Length / sizeof (*GuidPtr);
   while (GuidPtr < (CONST GUID*)Buffer) {

MdePkg/Library/BaseMemoryLibMmx/ZeroMemWrapper.c

@@ -43,9 +43,10 @@ VOID *
 EFIAPI
 ZeroMem (
   IN      VOID                      *Buffer,
-  IN      UINTN                     Size
+  IN      UINTN                     Length
   )
 {
-  ASSERT (Buffer != NULL);
+  ASSERT (!(Buffer == NULL && Length > 0));
-  return InternalMemSetMem (Buffer, Size, 0);
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+  return InternalMemSetMem (Buffer, Length, 0);
 }

MdePkg/Library/BaseMemoryLibRepStr/MemLibGuid.c

@@ -119,6 +119,14 @@ ScanGuid (
 {
   CONST GUID                        *GuidPtr;
 
+  ASSERT (Buffer != NULL);
+  //
+  // Make sure Buffer is aligned on a 64-bit boundary.
+  //
+  ASSERT (((UINTN) Buffer & 7) == 0);
+
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+
   GuidPtr = (GUID*)Buffer;
   Buffer = GuidPtr + Length / sizeof (*GuidPtr);
   while (GuidPtr < (CONST GUID*)Buffer) {

MdePkg/Library/BaseMemoryLibRepStr/ZeroMemWrapper.c

@@ -43,9 +43,10 @@ VOID *
 EFIAPI
 ZeroMem (
   IN      VOID                      *Buffer,
-  IN      UINTN                     Size
+  IN      UINTN                     Length
   )
 {
-  ASSERT (Buffer != NULL);
+  ASSERT (!(Buffer == NULL && Length > 0));
-  return InternalMemSetMem (Buffer, Size, 0);
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+  return InternalMemSetMem (Buffer, Length, 0);
 }

MdePkg/Library/BaseMemoryLibSse2/MemLibGuid.c

@@ -119,6 +119,14 @@ ScanGuid (
 {
   CONST GUID                        *GuidPtr;
 
+  ASSERT (Buffer != NULL);
+  //
+  // Make sure Buffer is aligned on a 64-bit boundary.
+  //
+  ASSERT (((UINTN) Buffer & 7) == 0);
+
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+
   GuidPtr = (GUID*)Buffer;
   Buffer = GuidPtr + Length / sizeof (*GuidPtr);
   while (GuidPtr < (CONST GUID*)Buffer) {

MdePkg/Library/BaseMemoryLibSse2/ZeroMemWrapper.c

@@ -43,9 +43,10 @@ VOID *
 EFIAPI
 ZeroMem (
   IN      VOID                      *Buffer,
-  IN      UINTN                     Size
+  IN      UINTN                     Length
   )
 {
-  ASSERT (Buffer != NULL);
+  ASSERT (!(Buffer == NULL && Length > 0));
-  return InternalMemSetMem (Buffer, Size, 0);
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+  return InternalMemSetMem (Buffer, Length, 0);
 }

MdePkg/Library/BaseTimerLibLocalApic/BaseTimerLibLocalApic.msa

@@ -49,6 +49,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
       <Filename>Ipf/ReadItc.s</Filename>
       <Filename>Ipf/IpfTimerLib.c</Filename>
     </Arch>
+    <Arch ArchType="EBC">
+      <Filename>Ebc/EbcTimerLib.c</Filename>
+    </Arch>
   </SourceFiles>
   <Includes>
     <PackageName>MdePkg</PackageName>

MdePkg/Library/BaseTimerLibLocalApic/Ebc/EbcTimerLib.c

@@ -0,0 +1,123 @@
+/** @file
+  Timer Library functions for EBC.
+
+  Copyright (c) 2006, Intel Corporation<BR>
+  All rights reserved. This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+  Module Name:  EbcTimerLib.c
+
+**/
+
+/**
+  Stalls the CPU for at least the given number of microseconds.
+
+  Stalls the CPU for the number of microseconds specified by MicroSeconds.
+
+  @param  MicroSeconds  The minimum number of microseconds to delay.
+
+  @return Return value depends on implementation.
+
+**/
+UINTN
+EFIAPI
+MicroSecondDelay (
+  IN      UINTN                     MicroSeconds
+  )
+{
+  //
+  // EBC architecture does not support local APIC timer.
+  //
+  ASSERT (FALSE);
+  return 0;
+}
+
+/**
+  Stalls the CPU for at least the given number of nanoseconds.
+
+  Stalls the CPU for the number of nanoseconds specified by NanoSeconds.
+
+  @param  NanoSeconds The minimum number of nanoseconds to delay.
+
+  @return Return value depends on implementation.
+
+**/
+UINTN
+EFIAPI
+NanoSecondDelay (
+  IN      UINTN                     NanoSeconds
+  )
+{
+  //
+  // EBC architecture does not support local APIC timer.
+  //
+  ASSERT (FALSE);
+  return 0;
+}
+
+/**
+  Retrieves the current value of a 64-bit free running performance counter.
+
+  Retrieves the current value of a 64-bit free running performance counter. The
+  counter can either count up by 1 or count down by 1. If the physical
+  performance counter counts by a larger increment, then the counter values
+  must be translated. The properties of the counter can be retrieved from
+  GetPerformanceCounterProperties().
+
+  @return The current value of the free running performance counter.
+
+**/
+UINT64
+EFIAPI
+GetPerformanceCounter (
+  VOID
+  )
+{
+  //
+  // EBC architecture does not support local APIC timer.
+  //
+  ASSERT (FALSE);
+  return 0;
+}
+
+/**
+  Retrieves the 64-bit frequency in Hz and the range of performance counter
+  values.
+
+  If StartValue is not NULL, then the value that the performance counter starts
+  with immediately after is it rolls over is returned in StartValue. If
+  EndValue is not NULL, then the value that the performance counter end with
+  immediately before it rolls over is returned in EndValue. The 64-bit
+  frequency of the performance counter in Hz is always returned. If StartValue
+  is less than EndValue, then the performance counter counts up. If StartValue
+  is greater than EndValue, then the performance counter counts down. For
+  example, a 64-bit free running counter that counts up would have a StartValue
+  of 0 and an EndValue of 0xFFFFFFFFFFFFFFFF. A 24-bit free running counter
+  that counts down would have a StartValue of 0xFFFFFF and an EndValue of 0.
+
+  @param  StartValue  The value the performance counter starts with when it
+                      rolls over.
+  @param  EndValue    The value that the performance counter ends with before
+                      it rolls over.
+
+  @return The frequency in Hz.
+
+**/
+UINT64
+EFIAPI
+GetPerformanceCounterProperties (
+  IN      UINT64                    *StartValue,
+  IN      UINT64                    *EndValue
+  )
+{
+  //
+  // EBC architecture does not support local APIC timer.
+  //
+  ASSERT (FALSE);
+  return 0;  
+}

MdePkg/Library/DxeIoLibCpuIo/DxeIoLibCpuIo.msa

@@ -32,6 +32,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   </MsaLibHeader>
   <LibraryClassDefinitions>
     <LibraryClass Usage="ALWAYS_PRODUCED">IoLib</LibraryClass>
+    <LibraryClass Usage="ALWAYS_CONSUMED">UefiBootServicesTableLib</LibraryClass>
     <LibraryClass Usage="ALWAYS_CONSUMED">DebugLib</LibraryClass>
     <LibraryClass Usage="ALWAYS_CONSUMED">BaseLib</LibraryClass>
   </LibraryClassDefinitions>

MdePkg/Library/DxeIoLibCpuIo/IoLib.c

@@ -14,8 +14,23 @@
 
 **/
 
-static EFI_CPU_IO_PROTOCOL          *gCpuIo;
+//
+// Globle varible to cache pointer to CpuIo protocol.
+//
+STATIC EFI_CPU_IO_PROTOCOL          *mCpuIo = NULL;
 
+/**
+  The constructor function caches the pointer to CpuIo protocol.
+  
+  The constructor function locates CpuIo protocol from protocol database.
+  It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. 
+
+  @param  ImageHandle   The firmware allocated handle for the EFI image.
+  @param  SystemTable   A pointer to the EFI System Table.
+  
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
+
+**/
 EFI_STATUS
 IoLibConstructor (
   IN      EFI_HANDLE                ImageHandle,
@@ -24,15 +39,26 @@ IoLibConstructor (
 {
   EFI_STATUS                        Status;
 
-  Status = SystemTable->BootServices->LocateProtocol (
+  Status = gBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, (VOID**) &mCpuIo);
-                                        &gEfiCpuIoProtocolGuid,
-                                        NULL,
-                                        (VOID**)&gCpuIo
-                                        );
   ASSERT_EFI_ERROR (Status);
+
   return Status;
 }
 
+/**
+  Reads registers in the EFI CPU I/O space.
+
+  Reads the I/O port specified by Port with registers width specified by Width.
+  The read value is returned. If such operations are not supported, then ASSERT().
+  This function must guarantee that all I/O read and write operations are serialized.
+
+  @param  Port          The base address of the I/O operation.
+                        The caller is responsible for aligning the Address if required. 
+  @param  Width         The width of the I/O operation.
+  
+  @return Data read from registers in the EFI CPU I/O space.
+
+**/
 UINT64
 EFIAPI
 IoReadWorker (
@@ -40,12 +66,30 @@ IoReadWorker (
   IN      EFI_CPU_IO_PROTOCOL_WIDTH Width
   )
 {
+  EFI_STATUS                        Status;
   UINT64                            Data;
 
-  gCpuIo->Io.Read (gCpuIo, Width, Port, 1, &Data);
+  Status = mCpuIo->Io.Read (mCpuIo, Width, Port, 1, &Data);
+  ASSERT_EFI_ERROR (Status);
+
   return Data;
 }
 
+/**
+  Writes registers in the EFI CPU I/O space.
+
+  Writes the I/O port specified by Port with registers width and value specified by Width
+  and Data respectively.  Data is returned. If such operations are not supported, then ASSERT().
+  This function must guarantee that all I/O read and write operations are serialized.
+
+  @param  Port          The base address of the I/O operation.
+                        The caller is responsible for aligning the Address if required. 
+  @param  Width         The width of the I/O operation.
+  @param  Data          The value to write to the I/O port.
+  
+  @return The paramter of Data.
+
+**/
 UINT64
 EFIAPI
 IoWriteWorker (
@@ -54,10 +98,28 @@ IoWriteWorker (
   IN      UINT64                    Data
   )
 {
-  gCpuIo->Io.Write (gCpuIo, Width, Port, 1, &Data);
+  EFI_STATUS                        Status;
+
+  Status = mCpuIo->Io.Write (mCpuIo, Width, Port, 1, &Data);
+  ASSERT_EFI_ERROR (Status);
+
   return Data;
 }
 
+/**
+  Reads memory-mapped registers in the EFI system memory space. 
+
+  Reads the MMIO registers specified by Address with registers width specified by Width.
+  The read value is returned. If such operations are not supported, then ASSERT().
+  This function must guarantee that all MMIO read and write operations are serialized.
+
+  @param  Address       The MMIO register to read.
+                        The caller is responsible for aligning the Address if required. 
+  @param  Width         The width of the I/O operation.
+  
+  @return Data read from registers in the EFI system memory space.
+
+**/
 UINT64
 EFIAPI
 MmioReadWorker (
@@ -65,12 +127,29 @@ MmioReadWorker (
   IN      EFI_CPU_IO_PROTOCOL_WIDTH Width
   )
 {
+  EFI_STATUS                        Status;
   UINT64                            Data;
 
-  gCpuIo->Mem.Read (gCpuIo, Width, Address, 1, &Data);
+  Status = mCpuIo->Mem.Read (mCpuIo, Width, Address, 1, &Data);
+  ASSERT_EFI_ERROR (Status);
+
   return Data;
 }
 
+/**
+  Writes memory-mapped registers in the EFI system memory space. 
+
+  Writes the MMIO registers specified by Address with registers width and value specified by Width
+  and Data respectively. Data is returned. If such operations are not supported, then ASSERT().
+  This function must guarantee that all MMIO read and write operations are serialized.
+
+  @param  Address       The MMIO register to read.
+                        The caller is responsible for aligning the Address if required. 
+  @param  Width         The width of the I/O operation.
+  
+  @return Data read from registers in the EFI system memory space.
+
+**/
 UINT64
 EFIAPI
 MmioWriteWorker (
@@ -79,7 +158,11 @@ MmioWriteWorker (
   IN      UINT64                    Data
   )
 {
-  gCpuIo->Mem.Write (gCpuIo, Width, Address, 1, &Data);
+  EFI_STATUS                        Status;
+
+  Status = mCpuIo->Mem.Write (mCpuIo, Width, Address, 1, &Data);
+  ASSERT_EFI_ERROR (Status);
+
   return Data;
 }
 
@@ -151,6 +234,10 @@ IoRead16 (
   IN      UINTN                     Port
   )
 {
+  //
+  // Make sure Port is aligned on a 16-bit boundary.
+  //
+  ASSERT ((Port & 1) == 0);
   return (UINT16)IoReadWorker (Port, EfiCpuIoWidthUint16);
 }
 
@@ -176,6 +263,10 @@ IoWrite16 (
   IN      UINT16                    Value
   )
 {
+  //
+  // Make sure Port is aligned on a 16-bit boundary.
+  //
+  ASSERT ((Port & 1) == 0);
   return (UINT16)IoWriteWorker (Port, EfiCpuIoWidthUint16, Value);
 }
 
@@ -199,6 +290,10 @@ IoRead32 (
   IN      UINTN                     Port
   )
 {
+  //
+  // Make sure Port is aligned on a 32-bit boundary.
+  //
+  ASSERT ((Port & 3) == 0);
   return (UINT32)IoReadWorker (Port, EfiCpuIoWidthUint32);
 }
 
@@ -224,6 +319,10 @@ IoWrite32 (
   IN      UINT32                    Value
   )
 {
+  //
+  // Make sure Port is aligned on a 32-bit boundary.
+  //
+  ASSERT ((Port & 3) == 0);
   return (UINT32)IoWriteWorker (Port, EfiCpuIoWidthUint32, Value);
 }
 
@@ -247,6 +346,10 @@ IoRead64 (
   IN      UINTN                     Port
   )
 {
+  //
+  // Make sure Port is aligned on a 64-bit boundary.
+  //
+  ASSERT ((Port & 7) == 0);
   return IoReadWorker (Port, EfiCpuIoWidthUint64);
 }
 
@@ -272,6 +375,10 @@ IoWrite64 (
   IN      UINT64                    Value
   )
 {
+  //
+  // Make sure Port is aligned on a 64-bit boundary.
+  //
+  ASSERT ((Port & 7) == 0);
   return IoWriteWorker (Port, EfiCpuIoWidthUint64, Value);
 }
 
@@ -341,6 +448,10 @@ MmioRead16 (
   IN      UINTN                     Address
   )
 {
+  //
+  // Make sure Address is aligned on a 16-bit boundary.
+  //
+  ASSERT ((Address & 1) == 0);
   return (UINT16)MmioReadWorker (Address, EfiCpuIoWidthUint16);
 }
 
@@ -364,6 +475,10 @@ MmioWrite16 (
   IN      UINT16                    Value
   )
 {
+  //
+  // Make sure Address is aligned on a 16-bit boundary.
+  //
+  ASSERT ((Address & 1) == 0);
   return (UINT16)MmioWriteWorker (Address, EfiCpuIoWidthUint16, Value);
 }
 
@@ -387,6 +502,10 @@ MmioRead32 (
   IN      UINTN                     Address
   )
 {
+  //
+  // Make sure Address is aligned on a 32-bit boundary.
+  //
+  ASSERT ((Address & 3) == 0);
   return (UINT32)MmioReadWorker (Address, EfiCpuIoWidthUint32);
 }
 
@@ -410,6 +529,10 @@ MmioWrite32 (
   IN      UINT32                    Value
   )
 {
+  //
+  // Make sure Address is aligned on a 32-bit boundary.
+  //
+  ASSERT ((Address & 3) == 0);
   return (UINT32)MmioWriteWorker (Address, EfiCpuIoWidthUint32, Value);
 }
 
@@ -433,6 +556,10 @@ MmioRead64 (
   IN      UINTN                     Address
   )
 {
+  //
+  // Make sure Address is aligned on a 64-bit boundary.
+  //
+  ASSERT ((Address & 7) == 0);
   return (UINT64)MmioReadWorker (Address, EfiCpuIoWidthUint64);
 }
 
@@ -456,5 +583,9 @@ MmioWrite64 (
   IN      UINT64                    Value
   )
 {
+  //
+  // Make sure Address is aligned on a 64-bit boundary.
+  //
+  ASSERT ((Address & 7) == 0);
   return (UINT64)MmioWriteWorker (Address, EfiCpuIoWidthUint64, Value);
 }

MdePkg/Library/PeiMemoryLib/MemLibGuid.c

@@ -119,6 +119,14 @@ ScanGuid (
 {
   CONST GUID                        *GuidPtr;
 
+  ASSERT (Buffer != NULL);
+  //
+  // Make sure Buffer is aligned on a 64-bit boundary.
+  //
+  ASSERT (((UINTN) Buffer & 7) == 0);
+
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+
   GuidPtr = (GUID*)Buffer;
   Buffer = GuidPtr + Length / sizeof (*GuidPtr);
   while (GuidPtr < (CONST GUID*)Buffer) {

MdePkg/Library/PeiMemoryLib/ZeroMemWrapper.c

@@ -43,9 +43,10 @@ VOID *
 EFIAPI
 ZeroMem (
   IN      VOID                      *Buffer,
-  IN      UINTN                     Size
+  IN      UINTN                     Length
   )
 {
-  ASSERT (Buffer != NULL);
+  ASSERT (!(Buffer == NULL && Length > 0));
-  return InternalMemSetMem (Buffer, Size, 0);
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+  return InternalMemSetMem (Buffer, Length, 0);
 }

MdePkg/Library/UefiMemoryLib/MemLibGuid.c

@@ -119,6 +119,14 @@ ScanGuid (
 {
   CONST GUID                        *GuidPtr;
 
+  ASSERT (Buffer != NULL);
+  //
+  // Make sure Buffer is aligned on a 64-bit boundary.
+  //
+  ASSERT (((UINTN) Buffer & 7) == 0);
+
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+
   GuidPtr = (GUID*)Buffer;
   Buffer = GuidPtr + Length / sizeof (*GuidPtr);
   while (GuidPtr < (CONST GUID*)Buffer) {

MdePkg/Library/UefiMemoryLib/ZeroMemWrapper.c

@@ -43,9 +43,10 @@ VOID *
 EFIAPI
 ZeroMem (
   IN      VOID                      *Buffer,
-  IN      UINTN                     Size
+  IN      UINTN                     Length
   )
 {
-  ASSERT (Buffer != NULL);
+  ASSERT (!(Buffer == NULL && Length > 0));
-  return InternalMemSetMem (Buffer, Size, 0);
+  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));
+  return InternalMemSetMem (Buffer, Length, 0);
 }