Applied BSD license to the source files

[mirror_edk2.git] / Tools / Source / TianoTools / FlashMap / FlashDefFile.h

/*++\r
\r
Copyright (c)  2004-2006 Intel Corporation. All rights reserved\r
This program and the accompanying materials are licensed and made available \r
under the terms and conditions of the BSD License which accompanies this \r
distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
Module Name:\r
\r
  FlashDefFile.h\r
\r
Abstract:\r
\r
  Header file for flash management utility in the Intel Platform \r
  Innovation Framework for EFI build environment.\r
\r
--*/\r
\r
#ifndef _FLASH_DEF_FILE_H_\r
#define _FLASH_DEF_FILE_H_\r
\r
#ifdef __cplusplus\r
extern "C"\r
{\r
#endif\r
\r
void\r
FDFConstructor (\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
void\r
FDFDestructor (\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
STATUS\r
FDFParseFile (\r
  char    *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FileName  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFCreateCIncludeFile (\r
  char      *FlashDeviceName,\r
  char      *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FlashDeviceName - GC_TODO: add argument description\r
  FileName        - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFCreateCFlashMapDataFile (\r
  char      *FlashDeviceName,\r
  char      *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FlashDeviceName - GC_TODO: add argument description\r
  FileName        - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFCreateAsmIncludeFile (\r
  char      *FlashDeviceName,\r
  char      *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FlashDeviceName - GC_TODO: add argument description\r
  FileName        - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFParseFile (\r
  char      *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FileName  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFCreateImage (\r
  char      *FlashDeviceName,\r
  char      *ImageName,\r
  char      *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FlashDeviceName - GC_TODO: add argument description\r
  ImageName       - GC_TODO: add argument description\r
  FileName        - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFCreateDscFile (\r
  char      *FlashDeviceName,\r
  char      *FileName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FlashDeviceName - GC_TODO: add argument description\r
  FileName        - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDFCreateSymbols (\r
  char      *FlashDeviceName\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FlashDeviceName - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
STATUS\r
FDDiscover (\r
  char          *FDFileName,\r
  unsigned int  BaseAddr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  FDFileName  - GC_TODO: add argument description\r
  BaseAddr    - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
#ifdef __cplusplus\r
}\r
#endif\r
\r
#endif // #ifndef _FLASH_DEF_FILE_H_\r