summaryrefslogtreecommitdiff
path: root/Platform/Intel/MinPlatformPkg/Test/Library/TestPointCheckLib/DxeDumpBootVariable.c
blob: 763960cf5a87cfe5d437323c67b04207265f2586 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/** @file

Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/

#include <Uefi.h>
#include <PiDxe.h>
#include <Library/TestPointCheckLib.h>
#include <Library/TestPointLib.h>
#include <Library/DebugLib.h>
#include <Library/UefiLib.h>
#include <Library/PrintLib.h>
#include <Library/DevicePathLib.h>
#include <Library/MemoryAllocationLib.h>

CHAR16  *mLoadOptionVariableList[] = {
  L"Boot",
  L"Driver",
  L"SysPrep",
};

CHAR16  *mPlatformRecoveryOptionVariableList[] = {
  L"PlatformRecovery", // does not have PlatformRecoveryOrder
};

CHAR16  *mOsRecoveryOptionVariableList[] = {
  L"OsRecovery", // VariableGuid in OsRecoveryOrder
};

CHAR16  *mKeyOptionVariableList[] = {
  L"Key", // does not have KeyOrder
};

VOID
DumpLoadOption (
  IN CHAR16           *OptionName,
  IN EFI_LOAD_OPTION  *LoadOption,
  IN UINTN            Size
  )
{
  CHAR16                        *Str;
  CHAR16                        *Description;
  EFI_DEVICE_PATH_PROTOCOL      *FilePathList;

  if (LoadOption == NULL) {
    DEBUG ((DEBUG_INFO, "%s: <NULL>\n", OptionName));
    return ;
  }

  Description = (CHAR16 *)(LoadOption + 1);

  FilePathList = (EFI_DEVICE_PATH_PROTOCOL *)((UINTN)Description + StrSize (Description));

  DEBUG ((DEBUG_INFO, "%s: [0x%08x] \"%s\"", OptionName, LoadOption->Attributes, Description));
  Str = ConvertDevicePathToText(FilePathList, TRUE, TRUE);
  DEBUG ((DEBUG_INFO, " %s\n", Str));
  if (Str != NULL) {
    FreePool (Str);
  }
}

VOID
DumpKeyOption (
  IN CHAR16           *OptionName,
  IN EFI_KEY_OPTION   *KeyOption,
  IN UINTN            Size
  )
{
  UINTN               Index;
  EFI_INPUT_KEY       *Keys;

  Keys = (EFI_INPUT_KEY *)(KeyOption + 1);

  DEBUG ((DEBUG_INFO, "%s: [Boot%04x] 0x%08x", OptionName, KeyOption->BootOption, KeyOption->KeyData.PackedValue));
  for (Index = 0; Index < KeyOption->KeyData.Options.InputKeyCount; Index++) {
    DEBUG ((DEBUG_INFO, " (%04x/%04x)", Keys[Index].ScanCode, Keys[Index].UnicodeChar));
  }
  DEBUG ((DEBUG_INFO, "\n"));
}

VOID
DumpLoadOptionVariable (
  VOID
  )
{
  UINT16      *BootOrder;
  UINTN       OrderSize;
  VOID        *Variable;
  UINTN       ListIndex;
  UINTN       Size;
  UINTN       Index;
  EFI_STATUS  Status;
  CHAR16      BootOptionName[sizeof(L"PlatformRecovery####")];
  CHAR16      BootOrderName[sizeof(L"PlatformRecoveryOrder")];

  for (ListIndex = 0; ListIndex < sizeof(mLoadOptionVariableList)/sizeof(mLoadOptionVariableList[0]); ListIndex++) {
    UnicodeSPrint (BootOrderName, sizeof(BootOrderName), L"%sOrder", mLoadOptionVariableList[ListIndex]);
    Status = GetVariable2 (BootOrderName, &gEfiGlobalVariableGuid, &BootOrder, &OrderSize);
    if (EFI_ERROR(Status)) {
      continue;
    }
    for (Index = 0; Index < OrderSize/sizeof(CHAR16); Index++) {
      UnicodeSPrint (BootOptionName, sizeof(BootOptionName), L"%s%04x", mLoadOptionVariableList[ListIndex], BootOrder[Index]);
      Status = GetVariable2 (BootOptionName, &gEfiGlobalVariableGuid, &Variable, &Size);
      if (!EFI_ERROR(Status)) {
        DumpLoadOption (BootOptionName, Variable, Size);
      } else {
        DumpLoadOption (BootOptionName, NULL, 0);
      }
    }
  }
}

VOID
DumpPlatformRecoveryOptionVariable (
  VOID
  )
{
  VOID        *Variable;
  UINTN       ListIndex;
  UINTN       Size;
  UINTN       Index;
  EFI_STATUS  Status;
  CHAR16      PlatformRecoveryOptionName[sizeof(L"PlatformRecovery####")];

  for (ListIndex = 0; ListIndex < sizeof(mPlatformRecoveryOptionVariableList)/sizeof(mPlatformRecoveryOptionVariableList[0]); ListIndex++) {
    for (Index = 0; ; Index++) {
      UnicodeSPrint (PlatformRecoveryOptionName, sizeof(PlatformRecoveryOptionName), L"%s%04x", mPlatformRecoveryOptionVariableList[ListIndex], Index);
      Status = GetVariable2 (PlatformRecoveryOptionName, &gEfiGlobalVariableGuid, &Variable, &Size);
      if (!EFI_ERROR(Status)) {
        DumpLoadOption (PlatformRecoveryOptionName, Variable, Size);
      } else {
        break;
      }
    }
  }
}

VOID
DumpOsRecoveryOptionVariable (
  VOID
  )
{
}

VOID
DumpKeyOptionVariable (
  VOID
  )
{
  VOID        *Variable;
  UINTN       ListIndex;
  UINTN       Size;
  UINTN       Index;
  EFI_STATUS  Status;
  CHAR16      KeyOptionName[sizeof(L"Key####")];

  for (ListIndex = 0; ListIndex < sizeof(mKeyOptionVariableList)/sizeof(mKeyOptionVariableList[0]); ListIndex++) {
    for (Index = 0; ; Index++) {
      UnicodeSPrint (KeyOptionName, sizeof(KeyOptionName), L"%s%04x", mKeyOptionVariableList[ListIndex], Index);
      Status = GetVariable2 (KeyOptionName, &gEfiGlobalVariableGuid, &Variable, &Size);
      if (!EFI_ERROR(Status)) {
        DumpKeyOption (KeyOptionName, Variable, Size);
      } else {
        break;
      }
    }
  }
}

EFI_STATUS
TestPointDumpBootVariable (
  VOID
  )
{
  DEBUG ((DEBUG_INFO, "==== TestPointDumpBootVariable - Enter\n"));

  DumpLoadOptionVariable ();
  DumpPlatformRecoveryOptionVariable ();
  DumpOsRecoveryOptionVariable ();
  DumpKeyOptionVariable ();

  DEBUG ((DEBUG_INFO, "==== TestPointDumpBootVariable - Exit\n"));

  // Check - TBD
  return EFI_SUCCESS;
}