EdkCompatibilityPkg/Foundation/Framework/Protocol/AcpiS3Save/AcpiS3Save.h

   1 /*++
   2
   3 Copyright (c) 2004, Intel Corporation
   4 All rights reserved. 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 Module Name:
  13
  14   AcpiS3Save.h
  15
  16 Abstract:
  17
  18
  19 --*/
  20
  21 #ifndef _ACPI_S3_SAVE_PROTOCOL_H
  22 #define _ACPI_S3_SAVE_PROTOCOL_H
  23
  24 //
  25 // Includes
  26 //
  27 #include "Tiano.h"
  28
  29 //
  30 // Forward reference for pure ANSI compatability
  31 //
  32 EFI_FORWARD_DECLARATION (EFI_ACPI_S3_SAVE_PROTOCOL);
  33
  34 //
  35 // S3 Save Protocol GUID
  36 //
  37 #define EFI_ACPI_S3_SAVE_GUID \
  38   { \
  39     0x125f2de1, 0xfb85, 0x440c, 0xa5, 0x4c, 0x4d, 0x99, 0x35, 0x8a, 0x8d, 0x38 \
  40   }
  41
  42 //
  43 // Protocol Data Structures
  44 //
  45 typedef
  46 EFI_STATUS
  47 EFI_BOOTSERVICE
  48 (EFIAPI *EFI_ACPI_S3_SAVE) (
  49   IN EFI_ACPI_S3_SAVE_PROTOCOL      * This,
  50   IN VOID                           * LegacyMemoryAddress
  51   );
  52
  53 typedef
  54 EFI_STATUS
  55 EFI_BOOTSERVICE
  56 (EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE) (
  57   IN  EFI_ACPI_S3_SAVE_PROTOCOL     * This,
  58   OUT UINTN                         * Size
  59 );
  60
  61 typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL {
  62   EFI_ACPI_GET_LEGACY_MEMORY_SIZE   GetLegacyMemorySize;
  63   EFI_ACPI_S3_SAVE                  S3Save;
  64 } EFI_ACPI_S3_SAVE_PROTOCOL;
  65
  66 extern EFI_GUID gEfiAcpiS3SaveGuid;
  67
  68 #endif