]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Include/Library/S3Lib.h
Committing changes to the comments, to improve code documentation.
[mirror_edk2.git] / MdeModulePkg / Include / Library / S3Lib.h
1 /** @file
2 S3 library class defines a set of methods related to S3 boot mode.
3
4 Copyright (c) 2005 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef __S3_LIB_H__
16 #define __S3_LIB_H__
17
18 /**
19 This function is responsible for calling the S3 resume vector in the ACPI Tables.
20
21 @retval EFI_SUCESS Successfully restored config from S3.
22 @retval Others Failed to restore config from S3.
23
24 **/
25 EFI_STATUS
26 EFIAPI
27 AcpiS3ResumeOs (
28 VOID
29 );
30
31 #endif
32