Adding Additional Tools that are needed for Platform Image creation.

[mirror_edk2.git] / Tools / Source / TianoTools / PeiRebase / PeiRebaseExe.h

/*++\r
\r
Copyright (c)  1999 - 2002 Intel Corporation. All rights reserved\r
This software and associated documentation (if any) is furnished\r
under a license and may only be used or copied in accordance\r
with the terms of the license. Except as permitted by such\r
license, no part of this software or documentation may be\r
reproduced, stored in a retrieval system, or transmitted in any\r
form or by any means without the express written consent of\r
Intel Corporation.\r
\r
\r
Module Name:\r
  \r
  PeiRebaseExe.h\r
\r
Abstract:\r
\r
  Definitions for the PeiRebase exe utility.\r
\r
--*/\r
\r
#ifndef _EFI_PEIM_FIXUP_EXE_H\r
#define _EFI_PEIM_FIXUP_EXE_H\r
\r
#include "Efi2WinNt.h"\r
#include "EfiFirmwareFileSystem.h"\r
#include "EfiFirmwareVolumeHeader.h"\r
\r
//\r
// Utility Name\r
//\r
#define UTILITY_NAME  "PeiRebase"\r
\r
//\r
// Utility version information\r
//\r
#define UTILITY_MAJOR_VERSION 0\r
#define UTILITY_MINOR_VERSION 1\r
#define UTILITY_DATE          __DATE__\r
\r
//\r
// The maximum number of arguments accepted from the command line.\r
//\r
#define MAX_ARGS  7\r
\r
//\r
// The file copy buffer size\r
//\r
#define FILE_COPY_BUFFER_SIZE 512\r
\r
//\r
// The function that displays general utility information\r
//\r
VOID\r
PrintUtilityInfo (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// The function that displays the utility usage message.\r
//\r
VOID\r
PrintUsage (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// Internal function declarations\r
//\r
EFI_STATUS\r
FfsRebaseImageRead (\r
  IN     VOID    *FileHandle,\r
  IN     UINTN   FileOffset,\r
  IN OUT UINT32  *ReadSize,\r
  OUT    VOID    *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FileHandle  - GC_TODO: add argument description\r
  FileOffset  - GC_TODO: add argument description\r
  ReadSize    - GC_TODO: add argument description\r
  Buffer      - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
FfsRebase (\r
  IN OUT EFI_FFS_FILE_HEADER    *FfsFile,\r
  IN EFI_PHYSICAL_ADDRESS       BaseAddress\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FfsFile     - GC_TODO: add argument description\r
  BaseAddress - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r