Add comments and DoxyGen format for these files.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / DebugImageInfo.h

/** @file \r
\r
  Support functions for managing debug image info table when loading and unloading\r
  images.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation                                                         \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
\r
**/\r
\r
#ifndef __DEBUG_IMAGE_INFO_H__\r
#define __DEBUG_IMAGE_INFO_H__\r
\r
#define FOUR_MEG_PAGES  0x400  \r
#define FOUR_MEG_MASK   ((FOUR_MEG_PAGES * EFI_PAGE_SIZE) - 1)\r
\r
#define EFI_DEBUG_TABLE_ENTRY_SIZE       (sizeof (VOID *))\r
\r
VOID\r
CoreInitializeDebugImageInfoTable (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Creates and initializes the DebugImageInfo Table.  Also creates the configuration\r
  table and registers it into the system table.\r
\r
Arguments:\r
  None\r
\r
Returns:\r
  NA\r
\r
Notes:\r
  This function allocates memory, frees it, and then allocates memory at an\r
  address within the initial allocation. Since this function is called early\r
  in DXE core initialization (before drivers are dispatched), this should not\r
  be a problem.\r
\r
--*/\r
;\r
\r
VOID\r
CoreUpdateDebugTableCrc32 (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Update the CRC32 in the Debug Table.\r
  Since the CRC32 service is made available by the Runtime driver, we have to\r
  wait for the Runtime Driver to be installed before the CRC32 can be computed.\r
  This function is called elsewhere by the core when the runtime architectural\r
  protocol is produced.\r
\r
Arguments:\r
  None\r
\r
Returns:\r
  NA\r
\r
--*/\r
;\r
\r
VOID\r
CoreNewDebugImageInfoEntry (\r
  UINT32                    ImageInfoType,\r
  EFI_LOADED_IMAGE_PROTOCOL *LoadedImage,\r
  EFI_HANDLE                ImageHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates\r
  the table if it's not large enough to accomidate another entry.\r
\r
Arguments:\r
\r
  ImageInfoType     - type of debug image information\r
  LoadedImage       - pointer to the loaded image protocol for the image being loaded\r
  ImageHandle       - image handle for the image being loaded\r
\r
Returns:\r
  NA\r
\r
--*/\r
;\r
\r
VOID\r
CoreRemoveDebugImageInfoEntry (\r
  EFI_HANDLE ImageHandle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Removes and frees an entry from the DebugImageInfo Table.\r
\r
Arguments:\r
\r
  ImageHandle       - image handle for the image being unloaded\r
\r
Returns:\r
\r
  NA\r
\r
--*/\r
;\r
\r
#endif\r