Tools/CCode/Source/FlashMap/FlashDefFile.h

   1 /*++
   2
   3 Copyright (c)  2004-2006 Intel Corporation. All rights reserved
   4 This program and the accompanying materials are licensed and made available
   5 under the terms and conditions of the BSD License which accompanies this
   6 distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   FlashDefFile.h
  16
  17 Abstract:
  18
  19   Header file for flash management utility in the Intel Platform
  20   Innovation Framework for EFI build environment.
  21
  22 --*/
  23
  24 #ifndef _FLASH_DEF_FILE_H_
  25 #define _FLASH_DEF_FILE_H_
  26
  27 #ifdef __cplusplus
  28 extern "C"
  29 {
  30 #endif
  31
  32 void
  33 FDFConstructor (
  34   VOID
  35   )
  36 /*++
  37
  38 Routine Description:
  39
  40   GC_TODO: Add function description
  41
  42 Arguments:
  43
  44   None
  45
  46 Returns:
  47
  48   GC_TODO: add return values
  49
  50 --*/
  51 ;
  52
  53 void
  54 FDFDestructor (
  55   VOID
  56   )
  57 /*++
  58
  59 Routine Description:
  60
  61   GC_TODO: Add function description
  62
  63 Arguments:
  64
  65   None
  66
  67 Returns:
  68
  69   GC_TODO: add return values
  70
  71 --*/
  72 ;
  73
  74 STATUS
  75 FDFParseFile (
  76   char    *FileName
  77   )
  78 /*++
  79
  80 Routine Description:
  81
  82   GC_TODO: Add function description
  83
  84 Arguments:
  85
  86   FileName  - GC_TODO: add argument description
  87
  88 Returns:
  89
  90   GC_TODO: add return values
  91
  92 --*/
  93 ;
  94
  95 STATUS
  96 FDFCreateCIncludeFile (
  97   char      *FlashDeviceName,
  98   char      *FileName
  99   )
 100 /*++
 101
 102 Routine Description:
 103
 104   GC_TODO: Add function description
 105
 106 Arguments:
 107
 108   FlashDeviceName - GC_TODO: add argument description
 109   FileName        - GC_TODO: add argument description
 110
 111 Returns:
 112
 113   GC_TODO: add return values
 114
 115 --*/
 116 ;
 117
 118 STATUS
 119 FDFCreateCFlashMapDataFile (
 120   char      *FlashDeviceName,
 121   char      *FileName
 122   )
 123 /*++
 124
 125 Routine Description:
 126
 127   GC_TODO: Add function description
 128
 129 Arguments:
 130
 131   FlashDeviceName - GC_TODO: add argument description
 132   FileName        - GC_TODO: add argument description
 133
 134 Returns:
 135
 136   GC_TODO: add return values
 137
 138 --*/
 139 ;
 140
 141 STATUS
 142 FDFCreateAsmIncludeFile (
 143   char      *FlashDeviceName,
 144   char      *FileName
 145   )
 146 /*++
 147
 148 Routine Description:
 149
 150   GC_TODO: Add function description
 151
 152 Arguments:
 153
 154   FlashDeviceName - GC_TODO: add argument description
 155   FileName        - GC_TODO: add argument description
 156
 157 Returns:
 158
 159   GC_TODO: add return values
 160
 161 --*/
 162 ;
 163
 164 STATUS
 165 FDFParseFile (
 166   char      *FileName
 167   )
 168 /*++
 169
 170 Routine Description:
 171
 172   GC_TODO: Add function description
 173
 174 Arguments:
 175
 176   FileName  - GC_TODO: add argument description
 177
 178 Returns:
 179
 180   GC_TODO: add return values
 181
 182 --*/
 183 ;
 184
 185 STATUS
 186 FDFCreateImage (
 187   char      *FlashDeviceName,
 188   char      *ImageName,
 189   char      *FileName
 190   )
 191 /*++
 192
 193 Routine Description:
 194
 195   GC_TODO: Add function description
 196
 197 Arguments:
 198
 199   FlashDeviceName - GC_TODO: add argument description
 200   ImageName       - GC_TODO: add argument description
 201   FileName        - GC_TODO: add argument description
 202
 203 Returns:
 204
 205   GC_TODO: add return values
 206
 207 --*/
 208 ;
 209
 210 STATUS
 211 FDFCreateDscFile (
 212   char      *FlashDeviceName,
 213   char      *FileName
 214   )
 215 /*++
 216
 217 Routine Description:
 218
 219   GC_TODO: Add function description
 220
 221 Arguments:
 222
 223   FlashDeviceName - GC_TODO: add argument description
 224   FileName        - GC_TODO: add argument description
 225
 226 Returns:
 227
 228   GC_TODO: add return values
 229
 230 --*/
 231 ;
 232
 233 STATUS
 234 FDFCreateSymbols (
 235   char      *FlashDeviceName
 236   )
 237 /*++
 238
 239 Routine Description:
 240
 241   GC_TODO: Add function description
 242
 243 Arguments:
 244
 245   FlashDeviceName - GC_TODO: add argument description
 246
 247 Returns:
 248
 249   GC_TODO: add return values
 250
 251 --*/
 252 ;
 253
 254 STATUS
 255 FDDiscover (
 256   char          *FDFileName,
 257   unsigned int  BaseAddr
 258   )
 259 /*++
 260
 261 Routine Description:
 262
 263   GC_TODO: Add function description
 264
 265 Arguments:
 266
 267   FDFileName  - GC_TODO: add argument description
 268   BaseAddr    - GC_TODO: add argument description
 269
 270 Returns:
 271
 272   GC_TODO: add return values
 273
 274 --*/
 275 ;
 276
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif // #ifndef _FLASH_DEF_FILE_H_