MdePkg/Include/Uefi.h

   1 /** @file
   2
   3   Root include file for Mde Package UEFI modules.
   4
   5   UEFI modules follow the public EFI 1.10 or UEFI 2.0 specifications and
   6   also contains the infrastructure required to build modules. The build
   7   infrastructure must set EFI_SPECIFICATION_VERSION  before including  this
   8   file. To support EDK II/UEFI2.0 set EFI_SPECIFIATION_VERSION to 0x00020000. To
   9   support EDK/EFI 1.10 set EFI_SPECIFIATION_VERSION to 0x00010010.
  10   Seting EDK_RELEASE_VERSION to zero implies no Tiano extensions and a
  11   non zero value implies Tiano extensions are availible.
  12   EFI_SPECIFIATION_VERSION and EDK_RELEASE_VERSION are set automatically
  13   by the build infrastructure for every module.
  14
  15 Copyright (c) 2006, Intel Corporation
  16 All rights reserved. This program and the accompanying materials
  17 are licensed and made available under the terms and conditions of the BSD License
  18 which accompanies this distribution.  The full text of the license may be found at
  19 http://opensource.org/licenses/bsd-license.php
  20
  21 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  22 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  23
  24 **/
  25
  26
  27 #ifndef __UEFI_H__
  28 #define __UEFI_H__
  29
  30
  31 //
  32 // Check to make sure EFI_SPECIFICATION_VERSION and EDK_RELEASE_VERSION are defined.
  33 //  also check for legal combinations
  34 //
  35 #if !defined(EFI_SPECIFICATION_VERSION)
  36   #error EFI_SPECIFICATION_VERSION not defined
  37 #elif !defined(EDK_RELEASE_VERSION)
  38   #error EDK_RELEASE_VERSION not defined
  39 #elif EDK_RELEASE_VERSION == 0x00000000
  40 //
  41 // UEFI mode with no Tiano extensions is legal
  42 //
  43 #elif (EDK_RELEASE_VERSION < 0x00020000) && (EFI_SPECIFICATION_VERSION >= 0x00020000)
  44   #error Illegal combination of EFI_SPECIFICATION_VERSION and EDK_RELEASE_VERSION versions
  45 #endif
  46
  47
  48
  49 #include <Common/UefiBaseTypes.h>
  50 #include <Uefi/UefiSpec.h>
  51
  52 #endif