summaryrefslogtreecommitdiff
path: root/Platform/Intel/MinPlatformPkg/Test/Library/TestPointCheckLib/DxeCheckGcd.c
blob: 2f40573368b82523b1ed1cda73c49c86b0934778 (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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/** @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/MemoryAllocationLib.h>
#include <Library/DxeServicesTableLib.h>

CHAR8 *mGcdMemoryTypeShortName[] = {
  " NE  ",
  " RSVD",
  " SYS ",
  " MMIO",
  " PERS",
  " RELI",
};

CHAR8 mUnknownStr[11];

CHAR8 *
ShortNameOfGcdMemoryType(
  IN UINT32 Type
  )
{
  if (Type < sizeof(mGcdMemoryTypeShortName) / sizeof(mGcdMemoryTypeShortName[0])) {
    return mGcdMemoryTypeShortName[Type];
  } else {
    return " ???? ";
  }
}

CHAR8 *mGcdIoTypeShortName[] = {
  " NE  ",
  " RSVD",
  " SYS ",
};

CHAR8 *
ShortNameOfGcdIoType(
  IN UINT32 Type
  )
{
  if (Type < sizeof(mGcdIoTypeShortName) / sizeof(mGcdIoTypeShortName[0])) {
    return mGcdIoTypeShortName[Type];
  } else {
    return " ???? ";
  }
}

VOID
PrintBitMask (
  IN UINT64 Bit,
  IN UINT64 Capabilities,
  IN UINT64 Attributes
  )
{
  if ((Capabilities & Bit) != 0) {
    if ((Attributes & Bit) != 0) {
      DEBUG ((DEBUG_INFO, "1"));
    } else {
      DEBUG ((DEBUG_INFO, "0"));
    }
  } else {
    DEBUG ((DEBUG_INFO, "-"));
  }
}

VOID
PrintMemoryDescriptorHeader (
  VOID
  )
{
  if (sizeof(UINT64) == sizeof(UINTN)) {
    DEBUG ((DEBUG_INFO, "                                              U                                      \n"));
    DEBUG ((DEBUG_INFO, "                                       RRMNXRWCWWWU                                  \n"));
    DEBUG ((DEBUG_INFO, "Base Address     End Address      Type TORVPPPEBTCC Image            Device          \n"));
    DEBUG ((DEBUG_INFO, "================ ================ ==== ============ ================ ================\n"));
  } else {
    DEBUG ((DEBUG_INFO, "                                              U                      \n"));
    DEBUG ((DEBUG_INFO, "                                       RRMNXRWCWWWU                  \n"));
    DEBUG ((DEBUG_INFO, "Base Address     End Address      Type TORVPPPEBTCC Image    Device  \n"));
    DEBUG ((DEBUG_INFO, "================ ================ ==== ============ ======== ========\n"));
  }
}

VOID
PrintMemoryDescriptor (
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR  *MemoryDescriptor
  )
{
  DEBUG ((DEBUG_INFO,
    "%016lx-%016lx",
    MemoryDescriptor->BaseAddress,
    MemoryDescriptor->BaseAddress + MemoryDescriptor->Length - 1
    ));

  DEBUG ((DEBUG_INFO, ShortNameOfGcdMemoryType(MemoryDescriptor->GcdMemoryType)));
  DEBUG ((DEBUG_INFO, " "));

  if (MemoryDescriptor->GcdMemoryType != EfiGcdMemoryTypeNonExistent) {
    PrintBitMask (EFI_MEMORY_RUNTIME, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_RO, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_MORE_RELIABLE, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_NV, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_XP, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_RP, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_WP, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_UCE, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_WB, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_WT, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_WC, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
    PrintBitMask (EFI_MEMORY_UC, MemoryDescriptor->Capabilities, MemoryDescriptor->Attributes);
  } else {
    DEBUG ((DEBUG_INFO, "            "));
  }

  if (sizeof(UINT64) == sizeof(UINTN)) {
    if (MemoryDescriptor->ImageHandle != NULL) {
      DEBUG ((DEBUG_INFO, " %016lx", (UINT64)(UINTN)MemoryDescriptor->ImageHandle));
      if (MemoryDescriptor->DeviceHandle != NULL) {
        DEBUG ((DEBUG_INFO, " %016lx", (UINT64)(UINTN)MemoryDescriptor->ImageHandle));
      }
    }
  } else {
    if (MemoryDescriptor->ImageHandle != NULL) {
      DEBUG ((DEBUG_INFO, " %08x", MemoryDescriptor->ImageHandle));
      if (MemoryDescriptor->DeviceHandle != NULL) {
        DEBUG ((DEBUG_INFO, " %08x", MemoryDescriptor->ImageHandle));
      }
    }
  }

  DEBUG ((DEBUG_INFO, "\n"));
}

VOID
PrintIoDescriptorHeader (
  VOID
  )
{
  DEBUG ((DEBUG_INFO, "Base Address     End Address      Type Image    Device  \n"));
  DEBUG ((DEBUG_INFO, "================ ================ ==== ======== ========\n"));
}

VOID
PrintIoDescriptor (
  EFI_GCD_IO_SPACE_DESCRIPTOR  *IoDescriptor
  )
{
  DEBUG ((DEBUG_INFO,
    "%016lx-%016lx",
    IoDescriptor->BaseAddress,
    IoDescriptor->BaseAddress + IoDescriptor->Length - 1
    ));

  DEBUG ((DEBUG_INFO, ShortNameOfGcdIoType (IoDescriptor->GcdIoType)));

  if (IoDescriptor->ImageHandle != NULL) {
    DEBUG ((DEBUG_INFO, " %08x", IoDescriptor->ImageHandle));
    if (IoDescriptor->DeviceHandle != NULL) {
      DEBUG ((DEBUG_INFO, " %08x", IoDescriptor->ImageHandle));
    }
  }

  DEBUG ((DEBUG_INFO, "\n"));
}

VOID
TestPointDumpGcd (
  OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **GcdMemoryMap,  OPTIONAL
  OUT UINTN                           *GcdMemoryMapNumberOfDescriptors,  OPTIONAL
  OUT EFI_GCD_IO_SPACE_DESCRIPTOR     **GcdIoMap,  OPTIONAL
  OUT UINTN                           *GcdIoMapNumberOfDescriptors  OPTIONAL
  )
{
  EFI_STATUS                      Status;
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemoryMap;
  EFI_GCD_IO_SPACE_DESCRIPTOR     *IoMap;
  UINTN                           NumberOfDescriptors;
  UINTN                           Index;

  if (GcdMemoryMap != NULL) {
    *GcdMemoryMap = NULL;
    *GcdMemoryMapNumberOfDescriptors = 0;
  }
  if (GcdIoMap != NULL) {
    *GcdIoMap = NULL;
    *GcdIoMapNumberOfDescriptors = 0;
  }
  
  DEBUG ((DEBUG_INFO, "==== TestPointDumpGcd - Enter\n"));
  DEBUG ((DEBUG_INFO, "GCD MEM:\n"));
  NumberOfDescriptors = 0;
  MemoryMap           = NULL;
  Status = gDS->GetMemorySpaceMap (
                  &NumberOfDescriptors,
                  &MemoryMap
                  );
  if (!EFI_ERROR (Status)) {
    PrintMemoryDescriptorHeader ();
    for (Index = 0; Index < NumberOfDescriptors; Index++) {
      PrintMemoryDescriptor (&MemoryMap[Index]);
    }
    if (GcdMemoryMap != NULL) {
      *GcdMemoryMap = AllocateCopyPool (NumberOfDescriptors * sizeof(EFI_GCD_MEMORY_SPACE_DESCRIPTOR), MemoryMap);
      *GcdMemoryMapNumberOfDescriptors = NumberOfDescriptors;
    }
  }

  DEBUG ((DEBUG_INFO, "GCD IO:\n"));
  NumberOfDescriptors = 0;
  IoMap               = NULL;
  Status = gDS->GetIoSpaceMap (
                  &NumberOfDescriptors,
                  &IoMap
                  );
  if (!EFI_ERROR (Status)) {
    PrintIoDescriptorHeader ();
    for (Index = 0; Index < NumberOfDescriptors; Index++) {
      PrintIoDescriptor (&IoMap[Index]);
    }
    if (GcdMemoryMap != NULL) {
      *GcdIoMap = AllocateCopyPool (NumberOfDescriptors * sizeof(EFI_GCD_IO_SPACE_DESCRIPTOR), IoMap);
      *GcdIoMapNumberOfDescriptors = NumberOfDescriptors;
    }
  }

  DEBUG ((DEBUG_INFO, "==== TestPointDumpGcd - Exit\n"));
  return ;
}