EdkModulePkg/Include/Protocol/AcpiS3Save.h

   1 /*++
   2
   3 Copyright (c) 2006, 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 // Forward reference for pure ANSI compatability
  26 //
  27 typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL EFI_ACPI_S3_SAVE_PROTOCOL;
  28
  29 //
  30 // S3 Save Protocol GUID
  31 //
  32 #define EFI_ACPI_S3_SAVE_GUID \
  33   { \
  34     0x125f2de1, 0xfb85, 0x440c, {0xa5, 0x4c, 0x4d, 0x99, 0x35, 0x8a, 0x8d, 0x38 } \
  35   }
  36
  37 //
  38 // Protocol Data Structures
  39 //
  40 typedef
  41 EFI_STATUS
  42 (EFIAPI *EFI_ACPI_S3_SAVE) (
  43   IN EFI_ACPI_S3_SAVE_PROTOCOL      * This,
  44   IN VOID                           * LegacyMemoryAddress
  45   );
  46
  47 typedef
  48 EFI_STATUS
  49 (EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE) (
  50   IN  EFI_ACPI_S3_SAVE_PROTOCOL     * This,
  51   OUT UINTN                         * Size
  52 );
  53
  54 struct _EFI_ACPI_S3_SAVE_PROTOCOL {
  55   EFI_ACPI_GET_LEGACY_MEMORY_SIZE   GetLegacyMemorySize;
  56   EFI_ACPI_S3_SAVE                  S3Save;
  57 };
  58
  59 extern EFI_GUID gEfiAcpiS3SaveProtocolGuid;
  60
  61 #endif