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 VOID
  26 CoreInitializeDebugImageInfoTable (
  27   VOID
  28   )
  29 /*++
  30
  31 Routine Description:
  32
  33   Creates and initializes the DebugImageInfo Table.  Also creates the configuration
  34   table and registers it into the system table.
  35
  36 Arguments:
  37   None
  38
  39 Returns:
  40   NA
  41
  42 Notes:
  43   This function allocates memory, frees it, and then allocates memory at an
  44   address within the initial allocation. Since this function is called early
  45   in DXE core initialization (before drivers are dispatched), this should not
  46   be a problem.
  47
  48 --*/
  49 ;
  50
  51 VOID
  52 CoreUpdateDebugTableCrc32 (
  53   VOID
  54   )
  55 /*++
  56
  57 Routine Description:
  58
  59   Update the CRC32 in the Debug Table.
  60   Since the CRC32 service is made available by the Runtime driver, we have to
  61   wait for the Runtime Driver to be installed before the CRC32 can be computed.
  62   This function is called elsewhere by the core when the runtime architectural
  63   protocol is produced.
  64
  65 Arguments:
  66   None
  67
  68 Returns:
  69   NA
  70
  71 --*/
  72 ;
  73
  74 VOID
  75 CoreNewDebugImageInfoEntry (
  76   UINT32                    ImageInfoType,
  77   EFI_LOADED_IMAGE_PROTOCOL *LoadedImage,
  78   EFI_HANDLE                ImageHandle
  79   )
  80 /*++
  81
  82 Routine Description:
  83
  84   Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates
  85   the table if it's not large enough to accomidate another entry.
  86
  87 Arguments:
  88
  89   ImageInfoType     - type of debug image information
  90   LoadedImage       - pointer to the loaded image protocol for the image being loaded
  91   ImageHandle       - image handle for the image being loaded
  92
  93 Returns:
  94   NA
  95
  96 --*/
  97 ;
  98
  99 VOID
 100 CoreRemoveDebugImageInfoEntry (
 101   EFI_HANDLE ImageHandle
 102   )
 103 /*++
 104
 105 Routine Description:
 106
 107   Removes and frees an entry from the DebugImageInfo Table.
 108
 109 Arguments:
 110
 111   ImageHandle       - image handle for the image being unloaded
 112
 113 Returns:
 114
 115   NA
 116
 117 --*/
 118 ;
 119
 120 #endif