EdkCompatibilityPkg/Foundation/Framework/Protocol/LegacyRegion/LegacyRegion.h

   1 /*++
   2
   3 Copyright (c) 1999 - 2006, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this 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   LegacyRegion.h
  16
  17 Abstract:
  18
  19   This protocol manages the legacy memory regions between 0xc0000 - 0xfffff
  20
  21 Revision History
  22
  23   The EFI Legacy Region Protocol is compliant with CSM spec 0.96.
  24
  25 --*/
  26
  27 #ifndef _EFI_LEGACY_REGION_H_
  28 #define _EFI_LEGACY_REGION_H_
  29
  30 #define EFI_LEGACY_REGION_PROTOCOL_GUID \
  31   { \
  32     0xfc9013a, 0x568, 0x4ba9, {0x9b, 0x7e, 0xc9, 0xc3, 0x90, 0xa6, 0x60, 0x9b} \
  33   }
  34
  35 EFI_FORWARD_DECLARATION (EFI_LEGACY_REGION_PROTOCOL);
  36
  37 typedef
  38 EFI_STATUS
  39 (EFIAPI *EFI_LEGACY_REGION_DECODE) (
  40   IN EFI_LEGACY_REGION_PROTOCOL           * This,
  41   IN  UINT32                              Start,
  42   IN  UINT32                              Length,
  43   IN  BOOLEAN                             *On
  44   );
  45
  46 typedef
  47 EFI_STATUS
  48 (EFIAPI *EFI_LEGACY_REGION_LOCK) (
  49   IN EFI_LEGACY_REGION_PROTOCOL           * This,
  50   IN  UINT32                              Start,
  51   IN  UINT32                              Length,
  52   OUT UINT32                              *Granularity OPTIONAL
  53   );
  54
  55 typedef
  56 EFI_STATUS
  57 (EFIAPI *EFI_LEGACY_REGION_BOOT_LOCK) (
  58   IN EFI_LEGACY_REGION_PROTOCOL           * This,
  59   IN  UINT32                              Start,
  60   IN  UINT32                              Length,
  61   OUT UINT32                              *Granularity OPTIONAL
  62   );
  63
  64 typedef
  65 EFI_STATUS
  66 (EFIAPI *EFI_LEGACY_REGION_UNLOCK) (
  67   IN EFI_LEGACY_REGION_PROTOCOL           * This,
  68   IN  UINT32                              Start,
  69   IN  UINT32                              Length,
  70   OUT UINT32                              *Granularity OPTIONAL
  71   );
  72
  73 struct _EFI_LEGACY_REGION_PROTOCOL {
  74   EFI_LEGACY_REGION_DECODE    Decode;
  75   EFI_LEGACY_REGION_LOCK      Lock;
  76   EFI_LEGACY_REGION_BOOT_LOCK BootLock;
  77   EFI_LEGACY_REGION_UNLOCK    UnLock;
  78 };
  79
  80 extern EFI_GUID gEfiLegacyRegionProtocolGuid;
  81
  82 #endif