MdeModulePkg/Core/Dxe/DebugImageInfo.h

   1 /** @file
   2
   3   Support functions for managing debug image info table when loading and unloading
   4   images.
   5
   6 Copyright (c) 2006 - 2008, Intel Corporation
   7 All rights reserved. This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __DEBUG_IMAGE_INFO_H__
  18 #define __DEBUG_IMAGE_INFO_H__
  19
  20 #define FOUR_MEG_PAGES  0x400
  21 #define FOUR_MEG_MASK   ((FOUR_MEG_PAGES * EFI_PAGE_SIZE) - 1)
  22
  23 #define EFI_DEBUG_TABLE_ENTRY_SIZE       (sizeof (VOID *))
  24
  25
  26 /**
  27   Creates and initializes the DebugImageInfo Table.  Also creates the configuration
  28   table and registers it into the system table.
  29
  30   Note:
  31     This function allocates memory, frees it, and then allocates memory at an
  32     address within the initial allocation. Since this function is called early
  33     in DXE core initialization (before drivers are dispatched), this should not
  34     be a problem.
  35
  36 **/
  37 VOID
  38 CoreInitializeDebugImageInfoTable (
  39   VOID
  40   )
  41 ;
  42
  43
  44 /**
  45   Update the CRC32 in the Debug Table.
  46   Since the CRC32 service is made available by the Runtime driver, we have to
  47   wait for the Runtime Driver to be installed before the CRC32 can be computed.
  48   This function is called elsewhere by the core when the runtime architectural
  49   protocol is produced.
  50
  51 **/
  52 VOID
  53 CoreUpdateDebugTableCrc32 (
  54   VOID
  55   )
  56 ;
  57
  58
  59 /**
  60   Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates
  61   the table if it's not large enough to accomidate another entry.
  62
  63   @param  ImageInfoType  type of debug image information
  64   @param  LoadedImage    pointer to the loaded image protocol for the image being
  65                          loaded
  66   @param  ImageHandle    image handle for the image being loaded
  67
  68 **/
  69 VOID
  70 CoreNewDebugImageInfoEntry (
  71   UINT32                    ImageInfoType,
  72   EFI_LOADED_IMAGE_PROTOCOL *LoadedImage,
  73   EFI_HANDLE                ImageHandle
  74   )
  75 ;
  76
  77
  78 /**
  79   Removes and frees an entry from the DebugImageInfo Table.
  80
  81   @param  ImageHandle    image handle for the image being unloaded
  82
  83 **/
  84 VOID
  85 CoreRemoveDebugImageInfoEntry (
  86   EFI_HANDLE ImageHandle
  87   )
  88 ;
  89
  90 #endif