Fix comments format error.Fsp1.1 update.
[mirror_edk2.git] / IntelFspPkg / Include / Library / FspPlatformLib.h
1 /** @file
2
3 Copyright (c) 2014 - 2015, 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
14 #ifndef _FSP_PLATFORM_LIB_H_
15 #define _FSP_PLATFORM_LIB_H_
16
17 /**
18 Get system memory from HOB.
19
20 @param[in,out] LowMemoryLength less than 4G memory length
21 @param[in,out] HighMemoryLength greater than 4G memory length
22 **/
23 VOID
24 EFIAPI
25 FspGetSystemMemorySize (
26 IN OUT UINT64 *LowMemoryLength,
27 IN OUT UINT64 *HighMemoryLength
28 );
29
30 /**
31 Migrate bootloader data before destroying CAR.
32
33 **/
34 VOID
35 EFIAPI
36 FspMigrateTemporaryMemory (
37 VOID
38 );
39
40 /**
41 Set a new stack frame for the continuation function.
42
43 **/
44 VOID
45 EFIAPI
46 FspSetNewStackFrame (
47 VOID
48 );
49
50 /**
51 This function transfer control to the ContinuationFunc passed in by the
52 bootloader.
53
54 **/
55 VOID
56 EFIAPI
57 FspInitDone (
58 VOID
59 );
60
61 /**
62 This function handle NotifyPhase API call from the bootloader.
63 It gives control back to the bootloader after it is handled. If the
64 Notification code is a ReadyToBoot event, this function will return
65 and FSP continues the remaining execution until it reaches the DxeIpl.
66
67 **/
68 VOID
69 EFIAPI
70 FspWaitForNotify (
71 VOID
72 );
73
74 #endif