Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Dxe / EfiDriverLib / EfiLibAllocate.c

/*++\r
\r
Copyright (c) 2004 - 2007, 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
                                                                                          \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
\r
Module Name:\r
\r
  EfiLibAllocate.c\r
\r
Abstract:\r
\r
  Support routines for memory allocation routines for use with drivers.\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiDriverLib.h"\r
\r
VOID *\r
EfiLibAllocatePool (\r
  IN  UINTN   AllocationSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate BootServicesData pool.\r
\r
Arguments:\r
\r
  AllocationSize  - The size to allocate\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  VOID  *Memory;\r
\r
  Memory = NULL;\r
  gBS->AllocatePool (EfiBootServicesData, AllocationSize, &Memory);\r
  return Memory;\r
}\r
\r
VOID *\r
EfiLibAllocateRuntimePool (\r
  IN  UINTN   AllocationSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate RuntimeServicesData pool.\r
\r
Arguments:\r
\r
  AllocationSize  - The size to allocate\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  VOID  *Memory;\r
\r
  Memory = NULL;\r
  gBS->AllocatePool (EfiRuntimeServicesData, AllocationSize, &Memory);\r
  return Memory;\r
}\r
\r
VOID *\r
EfiLibAllocateZeroPool (\r
  IN  UINTN   AllocationSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate BootServicesData pool and zero it.\r
\r
Arguments:\r
\r
  AllocationSize  - The size to allocate\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  VOID  *Memory;\r
\r
  Memory = EfiLibAllocatePool (AllocationSize);\r
  if (Memory != NULL) {\r
    gBS->SetMem (Memory, AllocationSize, 0);\r
  }\r
\r
  return Memory;\r
}\r
\r
VOID *\r
EfiLibAllocateRuntimeZeroPool (\r
  IN  UINTN   AllocationSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate RuntimeServicesData pool and zero it.\r
\r
Arguments:\r
\r
  AllocationSize  - The size to allocate\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  VOID  *Memory;\r
\r
  Memory = EfiLibAllocateRuntimePool (AllocationSize);\r
  if (Memory != NULL) {\r
    gBS->SetMem (Memory, AllocationSize, 0);\r
  }\r
\r
  return Memory;\r
}\r
\r
VOID *\r
EfiLibAllocateCopyPool (\r
  IN  UINTN   AllocationSize,\r
  IN  VOID    *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate BootServicesData pool and use a buffer provided by \r
  caller to fill it.\r
\r
Arguments:\r
\r
  AllocationSize  - The size to allocate\r
  \r
  Buffer          - Buffer that will be filled into the buffer allocated\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  VOID  *Memory;\r
\r
  Memory = NULL;\r
  gBS->AllocatePool (EfiBootServicesData, AllocationSize, &Memory);\r
  if (Memory != NULL) {\r
    gBS->CopyMem (Memory, Buffer, AllocationSize);\r
  }\r
\r
  return Memory;\r
}\r
\r
VOID *\r
EfiLibAllocateRuntimeCopyPool (\r
  IN  UINTN            AllocationSize,\r
  IN  VOID             *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Allocate RuntimeServicesData pool and use a buffer provided by \r
  caller to fill it.\r
\r
Arguments:\r
\r
  AllocationSize  - The size to allocate\r
  \r
  Buffer          - Buffer that will be filled into the buffer allocated\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  VOID  *Memory;\r
\r
  Memory = NULL;\r
  gBS->AllocatePool (EfiRuntimeServicesData, AllocationSize, &Memory);\r
  if (Memory != NULL) {\r
    gBS->CopyMem (Memory, Buffer, AllocationSize);\r
  }\r
\r
  return Memory;\r
}\r
\r
\r
VOID\r
EfiLibSafeFreePool (\r
  IN  VOID             *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Free pool safely (without setting back Buffer to NULL).\r
\r
Arguments:\r
  \r
  Buffer          - The allocated pool entry to free\r
\r
Returns:\r
\r
  Pointer of the buffer allocated.\r
\r
--*/\r
{\r
  if (Buffer != NULL) {\r
    gBS->FreePool (Buffer);\r
  }\r
}\r