Tools/Source/TianoTools/GenFdImage/GenFdImage.h

   1 /*++
   2
   3 Copyright (c)  1999 - 2002 Intel Corporation. All rights reserved
   4 This software and associated documentation (if any) is furnished
   5 under a license and may only be used or copied in accordance
   6 with the terms of the license. Except as permitted by such
   7 license, no part of this software or documentation may be
   8 reproduced, stored in a retrieval system, or transmitted in any
   9 form or by any means without the express written consent of
  10 Intel Corporation.
  11
  12
  13 Module Name:
  14
  15   GenFdImage.h
  16
  17 Abstract:
  18
  19   This file contains the relevant declarations required
  20   to generate the Firmware Device
  21
  22 --*/
  23
  24 //
  25 // Coded to EFI 2.0 Coding Standard
  26 //
  27 #ifndef _EFI_GEN_FD_IMAGE_H
  28 #define _EFI_GEN_FD_IMAGE_H
  29
  30 //
  31 // Included Header files
  32 //
  33 #include <stdio.h>
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #include <assert.h>
  37
  38 #include "ParseInf.h"
  39
  40 //
  41 // Defines
  42 //
  43 #define FILE_NAME_SIZE  256
  44
  45 //
  46 // Type Definition
  47 //
  48 typedef struct {
  49   UINT64  FdSize;
  50   UINT64  FdBaseAddress;
  51   UINT8   PadValue;
  52   CHAR8   OutFileName[FILE_NAME_SIZE];
  53 } FDINFO;
  54
  55 //
  56 // Exported Function Prototype
  57 //
  58 EFI_STATUS
  59 GenerateFdImage (
  60   IN UINT64  BaseAddress,
  61   IN UINT64  Size,
  62   IN UINT8   PadByte,
  63   IN CHAR8   *OutFile,
  64   IN CHAR8   **FileList
  65   )
  66 /*++
  67
  68 Routine Description:
  69
  70   GC_TODO: Add function description
  71
  72 Arguments:
  73
  74   BaseAddress - GC_TODO: add argument description
  75   Size        - GC_TODO: add argument description
  76   PadByte     - GC_TODO: add argument description
  77   OutFile     - GC_TODO: add argument description
  78   FileList    - GC_TODO: add argument description
  79
  80 Returns:
  81
  82   GC_TODO: add return values
  83
  84 --*/
  85 ;
  86
  87 #endif