MdeModulePkg PeiCore: Correct the comments of PeiResetSystem2
[mirror_edk2.git] / MdeModulePkg / Core / Pei / Reset / Reset.c
1 /** @file
2 Pei Core Reset System Support
3
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
5 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 #include "PeiMain.h"
16
17 /**
18
19 Core version of the Reset System
20
21
22 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
23
24 @retval EFI_NOT_AVAILABLE_YET PPI not available yet.
25 @retval EFI_DEVICE_ERROR Did not reset system.
26 Otherwise, resets the system.
27
28 **/
29 EFI_STATUS
30 EFIAPI
31 PeiResetSystem (
32 IN CONST EFI_PEI_SERVICES **PeiServices
33 )
34 {
35 EFI_STATUS Status;
36 EFI_PEI_RESET_PPI *ResetPpi;
37
38 Status = PeiServicesLocatePpi (
39 &gEfiPeiResetPpiGuid,
40 0,
41 NULL,
42 (VOID **)&ResetPpi
43 );
44
45 //
46 // LocatePpi returns EFI_NOT_FOUND on error
47 //
48 if (!EFI_ERROR (Status)) {
49 return ResetPpi->ResetSystem (PeiServices);
50 }
51 //
52 // Report Status Code that Reset PPI is not available
53 //
54 REPORT_STATUS_CODE (
55 EFI_ERROR_CODE | EFI_ERROR_MINOR,
56 (EFI_SOFTWARE_PEI_CORE | EFI_SW_PS_EC_RESET_NOT_AVAILABLE)
57 );
58 return EFI_NOT_AVAILABLE_YET;
59 }
60
61 /**
62 Resets the entire platform.
63
64 @param[in] ResetType The type of reset to perform.
65 @param[in] ResetStatus The status code for the reset.
66 @param[in] DataSize The size, in bytes, of ResetData.
67 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
68 the data buffer starts with a Null-terminated string, optionally
69 followed by additional binary data. The string is a description
70 that the caller may use to further indicate the reason for the
71 system reset. ResetData is only valid if ResetStatus is something
72 other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific
73 where a minimum amount of ResetData is always required.
74
75 **/
76 VOID
77 EFIAPI
78 PeiResetSystem2 (
79 IN EFI_RESET_TYPE ResetType,
80 IN EFI_STATUS ResetStatus,
81 IN UINTN DataSize,
82 IN VOID *ResetData OPTIONAL
83 )
84 {
85 EFI_STATUS Status;
86 EFI_PEI_RESET2_PPI *Reset2Ppi;
87
88 Status = PeiServicesLocatePpi (
89 &gEfiPeiReset2PpiGuid,
90 0,
91 NULL,
92 (VOID **)&Reset2Ppi
93 );
94
95 if (!EFI_ERROR (Status)) {
96 Reset2Ppi->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);
97 return;
98 }
99
100 //
101 // Report Status Code that Reset2 PPI is not available.
102 //
103 REPORT_STATUS_CODE (
104 EFI_ERROR_CODE | EFI_ERROR_MINOR,
105 (EFI_SOFTWARE_PEI_CORE | EFI_SW_PS_EC_RESET_NOT_AVAILABLE)
106 );
107 }
108